@sp-api-sdk/fba-inventory-api-v1 1.13.10 → 1.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -28,18 +28,19 @@ const base_1 = require("../base");
|
|
|
28
28
|
const FbaInventoryApiAxiosParamCreator = function (configuration) {
|
|
29
29
|
return {
|
|
30
30
|
/**
|
|
31
|
-
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime` and `
|
|
31
|
+
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
32
32
|
* @param {'Marketplace'} granularityType The granularity type for the inventory aggregation level.
|
|
33
33
|
* @param {string} granularityId The granularity ID for the inventory aggregation level.
|
|
34
34
|
* @param {Array<string>} marketplaceIds The marketplace ID for the marketplace for which to return inventory summaries.
|
|
35
35
|
* @param {boolean} [details] true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
|
|
36
36
|
* @param {string} [startDateTime] A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.
|
|
37
37
|
* @param {Array<string>} [sellerSkus] A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
|
|
38
|
-
* @param {string} [
|
|
38
|
+
* @param {string} [sellerSku] A single seller SKU used for querying the specified seller SKU inventory summaries.
|
|
39
|
+
* @param {string} [nextToken] String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
|
|
39
40
|
* @param {*} [options] Override http request option.
|
|
40
41
|
* @throws {RequiredError}
|
|
41
42
|
*/
|
|
42
|
-
getInventorySummaries: async (granularityType, granularityId, marketplaceIds, details, startDateTime, sellerSkus, nextToken, options = {}) => {
|
|
43
|
+
getInventorySummaries: async (granularityType, granularityId, marketplaceIds, details, startDateTime, sellerSkus, sellerSku, nextToken, options = {}) => {
|
|
43
44
|
// verify required parameter 'granularityType' is not null or undefined
|
|
44
45
|
(0, common_1.assertParamExists)('getInventorySummaries', 'granularityType', granularityType);
|
|
45
46
|
// verify required parameter 'granularityId' is not null or undefined
|
|
@@ -73,6 +74,9 @@ const FbaInventoryApiAxiosParamCreator = function (configuration) {
|
|
|
73
74
|
if (sellerSkus) {
|
|
74
75
|
localVarQueryParameter['sellerSkus'] = sellerSkus.join(base_1.COLLECTION_FORMATS.csv);
|
|
75
76
|
}
|
|
77
|
+
if (sellerSku !== undefined) {
|
|
78
|
+
localVarQueryParameter['sellerSku'] = sellerSku;
|
|
79
|
+
}
|
|
76
80
|
if (nextToken !== undefined) {
|
|
77
81
|
localVarQueryParameter['nextToken'] = nextToken;
|
|
78
82
|
}
|
|
@@ -98,19 +102,20 @@ const FbaInventoryApiFp = function (configuration) {
|
|
|
98
102
|
const localVarAxiosParamCreator = (0, exports.FbaInventoryApiAxiosParamCreator)(configuration);
|
|
99
103
|
return {
|
|
100
104
|
/**
|
|
101
|
-
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime` and `
|
|
105
|
+
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
102
106
|
* @param {'Marketplace'} granularityType The granularity type for the inventory aggregation level.
|
|
103
107
|
* @param {string} granularityId The granularity ID for the inventory aggregation level.
|
|
104
108
|
* @param {Array<string>} marketplaceIds The marketplace ID for the marketplace for which to return inventory summaries.
|
|
105
109
|
* @param {boolean} [details] true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
|
|
106
110
|
* @param {string} [startDateTime] A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.
|
|
107
111
|
* @param {Array<string>} [sellerSkus] A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
|
|
108
|
-
* @param {string} [
|
|
112
|
+
* @param {string} [sellerSku] A single seller SKU used for querying the specified seller SKU inventory summaries.
|
|
113
|
+
* @param {string} [nextToken] String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
|
|
109
114
|
* @param {*} [options] Override http request option.
|
|
110
115
|
* @throws {RequiredError}
|
|
111
116
|
*/
|
|
112
|
-
async getInventorySummaries(granularityType, granularityId, marketplaceIds, details, startDateTime, sellerSkus, nextToken, options) {
|
|
113
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getInventorySummaries(granularityType, granularityId, marketplaceIds, details, startDateTime, sellerSkus, nextToken, options);
|
|
117
|
+
async getInventorySummaries(granularityType, granularityId, marketplaceIds, details, startDateTime, sellerSkus, sellerSku, nextToken, options) {
|
|
118
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getInventorySummaries(granularityType, granularityId, marketplaceIds, details, startDateTime, sellerSkus, sellerSku, nextToken, options);
|
|
114
119
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
115
120
|
},
|
|
116
121
|
};
|
|
@@ -124,13 +129,13 @@ const FbaInventoryApiFactory = function (configuration, basePath, axios) {
|
|
|
124
129
|
const localVarFp = (0, exports.FbaInventoryApiFp)(configuration);
|
|
125
130
|
return {
|
|
126
131
|
/**
|
|
127
|
-
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime` and `
|
|
132
|
+
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
128
133
|
* @param {FbaInventoryApiGetInventorySummariesRequest} requestParameters Request parameters.
|
|
129
134
|
* @param {*} [options] Override http request option.
|
|
130
135
|
* @throws {RequiredError}
|
|
131
136
|
*/
|
|
132
137
|
getInventorySummaries(requestParameters, options) {
|
|
133
|
-
return localVarFp.getInventorySummaries(requestParameters.granularityType, requestParameters.granularityId, requestParameters.marketplaceIds, requestParameters.details, requestParameters.startDateTime, requestParameters.sellerSkus, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
138
|
+
return localVarFp.getInventorySummaries(requestParameters.granularityType, requestParameters.granularityId, requestParameters.marketplaceIds, requestParameters.details, requestParameters.startDateTime, requestParameters.sellerSkus, requestParameters.sellerSku, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
134
139
|
},
|
|
135
140
|
};
|
|
136
141
|
};
|
|
@@ -143,14 +148,14 @@ exports.FbaInventoryApiFactory = FbaInventoryApiFactory;
|
|
|
143
148
|
*/
|
|
144
149
|
class FbaInventoryApi extends base_1.BaseAPI {
|
|
145
150
|
/**
|
|
146
|
-
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime` and `
|
|
151
|
+
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
147
152
|
* @param {FbaInventoryApiGetInventorySummariesRequest} requestParameters Request parameters.
|
|
148
153
|
* @param {*} [options] Override http request option.
|
|
149
154
|
* @throws {RequiredError}
|
|
150
155
|
* @memberof FbaInventoryApi
|
|
151
156
|
*/
|
|
152
157
|
getInventorySummaries(requestParameters, options) {
|
|
153
|
-
return (0, exports.FbaInventoryApiFp)(this.configuration).getInventorySummaries(requestParameters.granularityType, requestParameters.granularityId, requestParameters.marketplaceIds, requestParameters.details, requestParameters.startDateTime, requestParameters.sellerSkus, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
158
|
+
return (0, exports.FbaInventoryApiFp)(this.configuration).getInventorySummaries(requestParameters.granularityType, requestParameters.granularityId, requestParameters.marketplaceIds, requestParameters.details, requestParameters.startDateTime, requestParameters.sellerSkus, requestParameters.sellerSku, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
154
159
|
}
|
|
155
160
|
}
|
|
156
161
|
exports.FbaInventoryApi = FbaInventoryApi;
|
|
@@ -24,18 +24,19 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
|
|
|
24
24
|
export const FbaInventoryApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
|
-
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime` and `
|
|
27
|
+
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
28
28
|
* @param {'Marketplace'} granularityType The granularity type for the inventory aggregation level.
|
|
29
29
|
* @param {string} granularityId The granularity ID for the inventory aggregation level.
|
|
30
30
|
* @param {Array<string>} marketplaceIds The marketplace ID for the marketplace for which to return inventory summaries.
|
|
31
31
|
* @param {boolean} [details] true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
|
|
32
32
|
* @param {string} [startDateTime] A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.
|
|
33
33
|
* @param {Array<string>} [sellerSkus] A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
|
|
34
|
-
* @param {string} [
|
|
34
|
+
* @param {string} [sellerSku] A single seller SKU used for querying the specified seller SKU inventory summaries.
|
|
35
|
+
* @param {string} [nextToken] String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
|
|
35
36
|
* @param {*} [options] Override http request option.
|
|
36
37
|
* @throws {RequiredError}
|
|
37
38
|
*/
|
|
38
|
-
getInventorySummaries: async (granularityType, granularityId, marketplaceIds, details, startDateTime, sellerSkus, nextToken, options = {}) => {
|
|
39
|
+
getInventorySummaries: async (granularityType, granularityId, marketplaceIds, details, startDateTime, sellerSkus, sellerSku, nextToken, options = {}) => {
|
|
39
40
|
// verify required parameter 'granularityType' is not null or undefined
|
|
40
41
|
assertParamExists('getInventorySummaries', 'granularityType', granularityType);
|
|
41
42
|
// verify required parameter 'granularityId' is not null or undefined
|
|
@@ -69,6 +70,9 @@ export const FbaInventoryApiAxiosParamCreator = function (configuration) {
|
|
|
69
70
|
if (sellerSkus) {
|
|
70
71
|
localVarQueryParameter['sellerSkus'] = sellerSkus.join(COLLECTION_FORMATS.csv);
|
|
71
72
|
}
|
|
73
|
+
if (sellerSku !== undefined) {
|
|
74
|
+
localVarQueryParameter['sellerSku'] = sellerSku;
|
|
75
|
+
}
|
|
72
76
|
if (nextToken !== undefined) {
|
|
73
77
|
localVarQueryParameter['nextToken'] = nextToken;
|
|
74
78
|
}
|
|
@@ -93,19 +97,20 @@ export const FbaInventoryApiFp = function (configuration) {
|
|
|
93
97
|
const localVarAxiosParamCreator = FbaInventoryApiAxiosParamCreator(configuration);
|
|
94
98
|
return {
|
|
95
99
|
/**
|
|
96
|
-
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime` and `
|
|
100
|
+
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
97
101
|
* @param {'Marketplace'} granularityType The granularity type for the inventory aggregation level.
|
|
98
102
|
* @param {string} granularityId The granularity ID for the inventory aggregation level.
|
|
99
103
|
* @param {Array<string>} marketplaceIds The marketplace ID for the marketplace for which to return inventory summaries.
|
|
100
104
|
* @param {boolean} [details] true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
|
|
101
105
|
* @param {string} [startDateTime] A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.
|
|
102
106
|
* @param {Array<string>} [sellerSkus] A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
|
|
103
|
-
* @param {string} [
|
|
107
|
+
* @param {string} [sellerSku] A single seller SKU used for querying the specified seller SKU inventory summaries.
|
|
108
|
+
* @param {string} [nextToken] String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
|
|
104
109
|
* @param {*} [options] Override http request option.
|
|
105
110
|
* @throws {RequiredError}
|
|
106
111
|
*/
|
|
107
|
-
async getInventorySummaries(granularityType, granularityId, marketplaceIds, details, startDateTime, sellerSkus, nextToken, options) {
|
|
108
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getInventorySummaries(granularityType, granularityId, marketplaceIds, details, startDateTime, sellerSkus, nextToken, options);
|
|
112
|
+
async getInventorySummaries(granularityType, granularityId, marketplaceIds, details, startDateTime, sellerSkus, sellerSku, nextToken, options) {
|
|
113
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getInventorySummaries(granularityType, granularityId, marketplaceIds, details, startDateTime, sellerSkus, sellerSku, nextToken, options);
|
|
109
114
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
110
115
|
},
|
|
111
116
|
};
|
|
@@ -118,13 +123,13 @@ export const FbaInventoryApiFactory = function (configuration, basePath, axios)
|
|
|
118
123
|
const localVarFp = FbaInventoryApiFp(configuration);
|
|
119
124
|
return {
|
|
120
125
|
/**
|
|
121
|
-
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime` and `
|
|
126
|
+
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
122
127
|
* @param {FbaInventoryApiGetInventorySummariesRequest} requestParameters Request parameters.
|
|
123
128
|
* @param {*} [options] Override http request option.
|
|
124
129
|
* @throws {RequiredError}
|
|
125
130
|
*/
|
|
126
131
|
getInventorySummaries(requestParameters, options) {
|
|
127
|
-
return localVarFp.getInventorySummaries(requestParameters.granularityType, requestParameters.granularityId, requestParameters.marketplaceIds, requestParameters.details, requestParameters.startDateTime, requestParameters.sellerSkus, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
132
|
+
return localVarFp.getInventorySummaries(requestParameters.granularityType, requestParameters.granularityId, requestParameters.marketplaceIds, requestParameters.details, requestParameters.startDateTime, requestParameters.sellerSkus, requestParameters.sellerSku, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
128
133
|
},
|
|
129
134
|
};
|
|
130
135
|
};
|
|
@@ -136,13 +141,13 @@ export const FbaInventoryApiFactory = function (configuration, basePath, axios)
|
|
|
136
141
|
*/
|
|
137
142
|
export class FbaInventoryApi extends BaseAPI {
|
|
138
143
|
/**
|
|
139
|
-
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime` and `
|
|
144
|
+
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
140
145
|
* @param {FbaInventoryApiGetInventorySummariesRequest} requestParameters Request parameters.
|
|
141
146
|
* @param {*} [options] Override http request option.
|
|
142
147
|
* @throws {RequiredError}
|
|
143
148
|
* @memberof FbaInventoryApi
|
|
144
149
|
*/
|
|
145
150
|
getInventorySummaries(requestParameters, options) {
|
|
146
|
-
return FbaInventoryApiFp(this.configuration).getInventorySummaries(requestParameters.granularityType, requestParameters.granularityId, requestParameters.marketplaceIds, requestParameters.details, requestParameters.startDateTime, requestParameters.sellerSkus, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
151
|
+
return FbaInventoryApiFp(this.configuration).getInventorySummaries(requestParameters.granularityType, requestParameters.granularityId, requestParameters.marketplaceIds, requestParameters.details, requestParameters.startDateTime, requestParameters.sellerSkus, requestParameters.sellerSku, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
147
152
|
}
|
|
148
153
|
}
|
|
@@ -19,18 +19,19 @@ import { GetInventorySummariesResponse } from '../models';
|
|
|
19
19
|
*/
|
|
20
20
|
export declare const FbaInventoryApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
21
|
/**
|
|
22
|
-
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime` and `
|
|
22
|
+
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
23
23
|
* @param {'Marketplace'} granularityType The granularity type for the inventory aggregation level.
|
|
24
24
|
* @param {string} granularityId The granularity ID for the inventory aggregation level.
|
|
25
25
|
* @param {Array<string>} marketplaceIds The marketplace ID for the marketplace for which to return inventory summaries.
|
|
26
26
|
* @param {boolean} [details] true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
|
|
27
27
|
* @param {string} [startDateTime] A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.
|
|
28
28
|
* @param {Array<string>} [sellerSkus] A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
|
|
29
|
-
* @param {string} [
|
|
29
|
+
* @param {string} [sellerSku] A single seller SKU used for querying the specified seller SKU inventory summaries.
|
|
30
|
+
* @param {string} [nextToken] String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
|
|
30
31
|
* @param {*} [options] Override http request option.
|
|
31
32
|
* @throws {RequiredError}
|
|
32
33
|
*/
|
|
33
|
-
getInventorySummaries: (granularityType: 'Marketplace', granularityId: string, marketplaceIds: Array<string>, details?: boolean, startDateTime?: string, sellerSkus?: Array<string>, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
|
+
getInventorySummaries: (granularityType: 'Marketplace', granularityId: string, marketplaceIds: Array<string>, details?: boolean, startDateTime?: string, sellerSkus?: Array<string>, sellerSku?: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
35
|
};
|
|
35
36
|
/**
|
|
36
37
|
* FbaInventoryApi - functional programming interface
|
|
@@ -38,18 +39,19 @@ export declare const FbaInventoryApiAxiosParamCreator: (configuration?: Configur
|
|
|
38
39
|
*/
|
|
39
40
|
export declare const FbaInventoryApiFp: (configuration?: Configuration) => {
|
|
40
41
|
/**
|
|
41
|
-
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime` and `
|
|
42
|
+
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
42
43
|
* @param {'Marketplace'} granularityType The granularity type for the inventory aggregation level.
|
|
43
44
|
* @param {string} granularityId The granularity ID for the inventory aggregation level.
|
|
44
45
|
* @param {Array<string>} marketplaceIds The marketplace ID for the marketplace for which to return inventory summaries.
|
|
45
46
|
* @param {boolean} [details] true to return inventory summaries with additional summarized inventory details and quantities. Otherwise, returns inventory summaries only (default value).
|
|
46
47
|
* @param {string} [startDateTime] A start date and time in ISO8601 format. If specified, all inventory summaries that have changed since then are returned. You must specify a date and time that is no earlier than 18 months prior to the date and time when you call the API. Note: Changes in inboundWorkingQuantity, inboundShippedQuantity and inboundReceivingQuantity are not detected.
|
|
47
48
|
* @param {Array<string>} [sellerSkus] A list of seller SKUs for which to return inventory summaries. You may specify up to 50 SKUs.
|
|
48
|
-
* @param {string} [
|
|
49
|
+
* @param {string} [sellerSku] A single seller SKU used for querying the specified seller SKU inventory summaries.
|
|
50
|
+
* @param {string} [nextToken] String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
|
|
49
51
|
* @param {*} [options] Override http request option.
|
|
50
52
|
* @throws {RequiredError}
|
|
51
53
|
*/
|
|
52
|
-
getInventorySummaries(granularityType: 'Marketplace', granularityId: string, marketplaceIds: Array<string>, details?: boolean, startDateTime?: string, sellerSkus?: Array<string>, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInventorySummariesResponse>>;
|
|
54
|
+
getInventorySummaries(granularityType: 'Marketplace', granularityId: string, marketplaceIds: Array<string>, details?: boolean, startDateTime?: string, sellerSkus?: Array<string>, sellerSku?: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInventorySummariesResponse>>;
|
|
53
55
|
};
|
|
54
56
|
/**
|
|
55
57
|
* FbaInventoryApi - factory interface
|
|
@@ -57,7 +59,7 @@ export declare const FbaInventoryApiFp: (configuration?: Configuration) => {
|
|
|
57
59
|
*/
|
|
58
60
|
export declare const FbaInventoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
59
61
|
/**
|
|
60
|
-
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime` and `
|
|
62
|
+
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
61
63
|
* @param {FbaInventoryApiGetInventorySummariesRequest} requestParameters Request parameters.
|
|
62
64
|
* @param {*} [options] Override http request option.
|
|
63
65
|
* @throws {RequiredError}
|
|
@@ -107,7 +109,13 @@ export interface FbaInventoryApiGetInventorySummariesRequest {
|
|
|
107
109
|
*/
|
|
108
110
|
readonly sellerSkus?: Array<string>;
|
|
109
111
|
/**
|
|
110
|
-
*
|
|
112
|
+
* A single seller SKU used for querying the specified seller SKU inventory summaries.
|
|
113
|
+
* @type {string}
|
|
114
|
+
* @memberof FbaInventoryApiGetInventorySummaries
|
|
115
|
+
*/
|
|
116
|
+
readonly sellerSku?: string;
|
|
117
|
+
/**
|
|
118
|
+
* String token returned in the response of your previous request. The string token will expire 30 seconds after being created.
|
|
111
119
|
* @type {string}
|
|
112
120
|
* @memberof FbaInventoryApiGetInventorySummaries
|
|
113
121
|
*/
|
|
@@ -121,7 +129,7 @@ export interface FbaInventoryApiGetInventorySummariesRequest {
|
|
|
121
129
|
*/
|
|
122
130
|
export declare class FbaInventoryApi extends BaseAPI {
|
|
123
131
|
/**
|
|
124
|
-
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime` and `
|
|
132
|
+
* Returns a list of inventory summaries. The summaries returned depend on the presence or absence of the `startDateTime`, `sellerSkus` and `sellerSku` parameters: - All inventory summaries with available details are returned when the `startDateTime`, `sellerSkus` and `sellerSku` parameters are omitted. - When `startDateTime` is provided, the operation returns inventory summaries that have had changes after the date and time specified. The `sellerSkus` and `sellerSku` parameters are ignored. **Important:** To avoid errors, use both `startDateTime` and `nextToken` to get the next page of inventory summaries that have changed after the date and time specified. - When the `sellerSkus` parameter is provided, the operation returns inventory summaries for only the specified `sellerSkus`. The `sellerSku` parameter is ignored. - When the `sellerSku` parameter is provided, the operation returns inventory summaries for only the specified `sellerSku`. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
125
133
|
* @param {FbaInventoryApiGetInventorySummariesRequest} requestParameters Request parameters.
|
|
126
134
|
* @param {*} [options] Override http request option.
|
|
127
135
|
* @throws {RequiredError}
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/fba-inventory-api-v1",
|
|
3
3
|
"author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
|
|
4
4
|
"description": "The Selling Partner API for FBA Inventory lets you programmatically retrieve information about inventory in Amazon's fulfillment network.",
|
|
5
|
-
"version": "1.
|
|
5
|
+
"version": "1.14.0",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"test": "jest"
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@sp-api-sdk/common": "^1.
|
|
29
|
+
"@sp-api-sdk/common": "^1.10.1",
|
|
30
30
|
"axios": "^0.27.2"
|
|
31
31
|
},
|
|
32
32
|
"repository": {
|
|
@@ -51,5 +51,5 @@
|
|
|
51
51
|
"typedoc": {
|
|
52
52
|
"entryPoint": "./index.ts"
|
|
53
53
|
},
|
|
54
|
-
"gitHead": "
|
|
54
|
+
"gitHead": "c520443059c84ce15cdb24c030b97d8bb11fb258"
|
|
55
55
|
}
|