@sp-api-sdk/orders-api-v0 1.18.8 → 2.0.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/dist/cjs/src/api-model/api/orders-v0-api.js +176 -52
- package/dist/cjs/src/api-model/base.js +1 -3
- package/dist/cjs/src/api-model/common.js +2 -0
- package/dist/cjs/src/api-model/models/approval-support-data-element.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-approvals-response.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +14 -0
- package/dist/cjs/src/api-model/models/item-approval-action-changes.js +15 -0
- package/dist/cjs/src/api-model/models/item-approval-action.js +21 -0
- package/dist/cjs/src/api-model/models/item-approval-context.js +15 -0
- package/dist/cjs/src/api-model/models/item-approval-status.js +29 -0
- package/dist/cjs/src/api-model/models/item-approval-type.js +24 -0
- package/dist/cjs/src/api-model/models/item-approval.js +25 -0
- package/dist/cjs/src/api-model/models/item-identifier.js +21 -0
- package/dist/cjs/src/api-model/models/order-approvals-response.js +15 -0
- package/dist/cjs/src/api-model/models/order-item-approval-request.js +15 -0
- package/dist/cjs/src/api-model/models/order-item-approvals.js +15 -0
- package/dist/cjs/src/api-model/models/update-items-approvals-error-response.js +15 -0
- package/dist/cjs/src/api-model/models/update-order-approvals-request.js +15 -0
- package/dist/cjs/src/client.js +14 -0
- package/dist/es/src/api-model/api/orders-v0-api.js +176 -52
- package/dist/es/src/api-model/base.js +1 -3
- package/dist/es/src/api-model/common.js +2 -0
- package/dist/es/src/api-model/models/approval-support-data-element.js +14 -0
- package/dist/es/src/api-model/models/get-order-approvals-response.js +14 -0
- package/dist/es/src/api-model/models/index.js +14 -0
- package/dist/es/src/api-model/models/item-approval-action-changes.js +14 -0
- package/dist/es/src/api-model/models/item-approval-action.js +18 -0
- package/dist/es/src/api-model/models/item-approval-context.js +14 -0
- package/dist/es/src/api-model/models/item-approval-status.js +26 -0
- package/dist/es/src/api-model/models/item-approval-type.js +21 -0
- package/dist/es/src/api-model/models/item-approval.js +22 -0
- package/dist/es/src/api-model/models/item-identifier.js +18 -0
- package/dist/es/src/api-model/models/order-approvals-response.js +14 -0
- package/dist/es/src/api-model/models/order-item-approval-request.js +14 -0
- package/dist/es/src/api-model/models/order-item-approvals.js +14 -0
- package/dist/es/src/api-model/models/update-items-approvals-error-response.js +14 -0
- package/dist/es/src/api-model/models/update-order-approvals-request.js +14 -0
- package/dist/es/src/client.js +14 -0
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +158 -43
- package/dist/types/src/api-model/base.d.ts +2 -3
- package/dist/types/src/api-model/common.d.ts +3 -3
- package/dist/types/src/api-model/models/approval-support-data-element.d.ts +30 -0
- package/dist/types/src/api-model/models/get-order-approvals-response.d.ts +31 -0
- package/dist/types/src/api-model/models/index.d.ts +14 -0
- package/dist/types/src/api-model/models/item-approval-action-changes.d.ts +38 -0
- package/dist/types/src/api-model/models/item-approval-action.d.ts +43 -0
- package/dist/types/src/api-model/models/item-approval-context.d.ts +39 -0
- package/dist/types/src/api-model/models/item-approval-status.d.ts +25 -0
- package/dist/types/src/api-model/models/item-approval-type.d.ts +20 -0
- package/dist/types/src/api-model/models/item-approval.d.ts +72 -0
- package/dist/types/src/api-model/models/item-identifier.d.ts +36 -0
- package/dist/types/src/api-model/models/order-approvals-response.d.ts +31 -0
- package/dist/types/src/api-model/models/order-item-approval-request.d.ts +31 -0
- package/dist/types/src/api-model/models/order-item-approvals.d.ts +45 -0
- package/dist/types/src/api-model/models/order-item.d.ts +13 -0
- package/dist/types/src/api-model/models/order.d.ts +14 -0
- package/dist/types/src/api-model/models/update-items-approvals-error-response.d.ts +24 -0
- package/dist/types/src/api-model/models/update-order-approvals-request.d.ts +31 -0
- package/package.json +3 -3
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Selling Partner API for Orders
|
|
6
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.ItemApprovalApprovalActionProcessStatusEnum = exports.ItemApprovalActorEnum = void 0;
|
|
17
|
+
exports.ItemApprovalActorEnum = {
|
|
18
|
+
SellingPartner: 'SELLING_PARTNER',
|
|
19
|
+
Amazon: 'AMAZON'
|
|
20
|
+
};
|
|
21
|
+
exports.ItemApprovalApprovalActionProcessStatusEnum = {
|
|
22
|
+
Processing: 'PROCESSING',
|
|
23
|
+
Success: 'SUCCESS',
|
|
24
|
+
Error: 'ERROR'
|
|
25
|
+
};
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Selling Partner API for Orders
|
|
6
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.ItemIdentifierIdentifierTypeEnum = void 0;
|
|
17
|
+
exports.ItemIdentifierIdentifierTypeEnum = {
|
|
18
|
+
Asin: 'ASIN',
|
|
19
|
+
SellerSku: 'SELLER_SKU',
|
|
20
|
+
ExternalId: 'EXTERNAL_ID'
|
|
21
|
+
};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Selling Partner API for Orders
|
|
6
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Selling Partner API for Orders
|
|
6
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Selling Partner API for Orders
|
|
6
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Selling Partner API for Orders
|
|
6
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Selling Partner API for Orders
|
|
6
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/dist/cjs/src/client.js
CHANGED
|
@@ -67,6 +67,20 @@ exports.clientRateLimits = [
|
|
|
67
67
|
rate: 0.5,
|
|
68
68
|
burst: 30,
|
|
69
69
|
},
|
|
70
|
+
{
|
|
71
|
+
method: 'get',
|
|
72
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
73
|
+
urlRegex: new RegExp('^/orders/v0/orders/[^/]*/approvals$'),
|
|
74
|
+
rate: 0.5,
|
|
75
|
+
burst: 30,
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
method: 'post',
|
|
79
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
80
|
+
urlRegex: new RegExp('^/orders/v0/orders/[^/]*/approvals$'),
|
|
81
|
+
rate: 5,
|
|
82
|
+
burst: 15,
|
|
83
|
+
},
|
|
70
84
|
];
|
|
71
85
|
class OrdersApiClient extends api_model_1.OrdersV0Api {
|
|
72
86
|
constructor(configuration) {
|
|
@@ -139,6 +139,46 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
139
139
|
options: localVarRequestOptions,
|
|
140
140
|
};
|
|
141
141
|
},
|
|
142
|
+
/**
|
|
143
|
+
* Returns detailed order items approvals information for the order specified. If NextToken is provided, it\'s used to retrieve the next page of order items approvals. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
144
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format, e.g. 933-1671587-0818628.
|
|
145
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
146
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return approvals for items which approval type is contained in the specified approval types.
|
|
147
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return approvals that contain items which approval status is contained in the specified approval status.
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
getOrderItemsApprovals: async (orderId, nextToken, itemApprovalTypes, itemApprovalStatus, options = {}) => {
|
|
152
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
153
|
+
assertParamExists('getOrderItemsApprovals', 'orderId', orderId);
|
|
154
|
+
const localVarPath = `/orders/v0/orders/{orderId}/approvals`
|
|
155
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
156
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
157
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
158
|
+
let baseOptions;
|
|
159
|
+
if (configuration) {
|
|
160
|
+
baseOptions = configuration.baseOptions;
|
|
161
|
+
}
|
|
162
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
163
|
+
const localVarHeaderParameter = {};
|
|
164
|
+
const localVarQueryParameter = {};
|
|
165
|
+
if (nextToken !== undefined) {
|
|
166
|
+
localVarQueryParameter['NextToken'] = nextToken;
|
|
167
|
+
}
|
|
168
|
+
if (itemApprovalTypes) {
|
|
169
|
+
localVarQueryParameter['ItemApprovalTypes'] = itemApprovalTypes.join(COLLECTION_FORMATS.csv);
|
|
170
|
+
}
|
|
171
|
+
if (itemApprovalStatus) {
|
|
172
|
+
localVarQueryParameter['ItemApprovalStatus'] = itemApprovalStatus.join(COLLECTION_FORMATS.csv);
|
|
173
|
+
}
|
|
174
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
175
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
176
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
177
|
+
return {
|
|
178
|
+
url: toPathString(localVarUrlObj),
|
|
179
|
+
options: localVarRequestOptions,
|
|
180
|
+
};
|
|
181
|
+
},
|
|
142
182
|
/**
|
|
143
183
|
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then 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).
|
|
144
184
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -219,10 +259,12 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
219
259
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
220
260
|
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
221
261
|
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
262
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return orders that contain items which approval type is contained in the specified approval types.
|
|
263
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return orders that contain items which approval status is contained in the specified approval status.
|
|
222
264
|
* @param {*} [options] Override http request option.
|
|
223
265
|
* @throws {RequiredError}
|
|
224
266
|
*/
|
|
225
|
-
getOrders: async (marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options = {}) => {
|
|
267
|
+
getOrders: async (marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, itemApprovalTypes, itemApprovalStatus, options = {}) => {
|
|
226
268
|
// verify required parameter 'marketplaceIds' is not null or undefined
|
|
227
269
|
assertParamExists('getOrders', 'marketplaceIds', marketplaceIds);
|
|
228
270
|
const localVarPath = `/orders/v0/orders`;
|
|
@@ -289,6 +331,12 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
289
331
|
if (storeChainStoreId !== undefined) {
|
|
290
332
|
localVarQueryParameter['StoreChainStoreId'] = storeChainStoreId;
|
|
291
333
|
}
|
|
334
|
+
if (itemApprovalTypes) {
|
|
335
|
+
localVarQueryParameter['ItemApprovalTypes'] = itemApprovalTypes.join(COLLECTION_FORMATS.csv);
|
|
336
|
+
}
|
|
337
|
+
if (itemApprovalStatus) {
|
|
338
|
+
localVarQueryParameter['ItemApprovalStatus'] = itemApprovalStatus.join(COLLECTION_FORMATS.csv);
|
|
339
|
+
}
|
|
292
340
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
293
341
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
294
342
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -297,6 +345,39 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
297
345
|
options: localVarRequestOptions,
|
|
298
346
|
};
|
|
299
347
|
},
|
|
348
|
+
/**
|
|
349
|
+
* Update the order items approvals for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 then 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).
|
|
350
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
351
|
+
* @param {UpdateOrderApprovalsRequest} payload The request body for the updateOrderItemsApprovals operation.
|
|
352
|
+
* @param {*} [options] Override http request option.
|
|
353
|
+
* @throws {RequiredError}
|
|
354
|
+
*/
|
|
355
|
+
updateOrderItemsApprovals: async (orderId, payload, options = {}) => {
|
|
356
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
357
|
+
assertParamExists('updateOrderItemsApprovals', 'orderId', orderId);
|
|
358
|
+
// verify required parameter 'payload' is not null or undefined
|
|
359
|
+
assertParamExists('updateOrderItemsApprovals', 'payload', payload);
|
|
360
|
+
const localVarPath = `/orders/v0/orders/{orderId}/approvals`
|
|
361
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
362
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
363
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
364
|
+
let baseOptions;
|
|
365
|
+
if (configuration) {
|
|
366
|
+
baseOptions = configuration.baseOptions;
|
|
367
|
+
}
|
|
368
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
369
|
+
const localVarHeaderParameter = {};
|
|
370
|
+
const localVarQueryParameter = {};
|
|
371
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
372
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
373
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
374
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
375
|
+
localVarRequestOptions.data = serializeDataIfNeeded(payload, localVarRequestOptions, configuration);
|
|
376
|
+
return {
|
|
377
|
+
url: toPathString(localVarUrlObj),
|
|
378
|
+
options: localVarRequestOptions,
|
|
379
|
+
};
|
|
380
|
+
},
|
|
300
381
|
/**
|
|
301
382
|
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 then 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).
|
|
302
383
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -413,6 +494,19 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
413
494
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderItems(orderId, nextToken, options);
|
|
414
495
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
415
496
|
},
|
|
497
|
+
/**
|
|
498
|
+
* Returns detailed order items approvals information for the order specified. If NextToken is provided, it\'s used to retrieve the next page of order items approvals. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
499
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format, e.g. 933-1671587-0818628.
|
|
500
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
501
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return approvals for items which approval type is contained in the specified approval types.
|
|
502
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return approvals that contain items which approval status is contained in the specified approval status.
|
|
503
|
+
* @param {*} [options] Override http request option.
|
|
504
|
+
* @throws {RequiredError}
|
|
505
|
+
*/
|
|
506
|
+
async getOrderItemsApprovals(orderId, nextToken, itemApprovalTypes, itemApprovalStatus, options) {
|
|
507
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderItemsApprovals(orderId, nextToken, itemApprovalTypes, itemApprovalStatus, options);
|
|
508
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
509
|
+
},
|
|
416
510
|
/**
|
|
417
511
|
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then 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).
|
|
418
512
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -454,11 +548,24 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
454
548
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
455
549
|
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
456
550
|
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
551
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return orders that contain items which approval type is contained in the specified approval types.
|
|
552
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return orders that contain items which approval status is contained in the specified approval status.
|
|
553
|
+
* @param {*} [options] Override http request option.
|
|
554
|
+
* @throws {RequiredError}
|
|
555
|
+
*/
|
|
556
|
+
async getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, itemApprovalTypes, itemApprovalStatus, options) {
|
|
557
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, itemApprovalTypes, itemApprovalStatus, options);
|
|
558
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
559
|
+
},
|
|
560
|
+
/**
|
|
561
|
+
* Update the order items approvals for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 then 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).
|
|
562
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
563
|
+
* @param {UpdateOrderApprovalsRequest} payload The request body for the updateOrderItemsApprovals operation.
|
|
457
564
|
* @param {*} [options] Override http request option.
|
|
458
565
|
* @throws {RequiredError}
|
|
459
566
|
*/
|
|
460
|
-
async
|
|
461
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
567
|
+
async updateOrderItemsApprovals(orderId, payload, options) {
|
|
568
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateOrderItemsApprovals(orderId, payload, options);
|
|
462
569
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
463
570
|
},
|
|
464
571
|
/**
|
|
@@ -494,105 +601,102 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
494
601
|
return {
|
|
495
602
|
/**
|
|
496
603
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | 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 then 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).
|
|
497
|
-
* @param {
|
|
604
|
+
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
498
605
|
* @param {*} [options] Override http request option.
|
|
499
606
|
* @throws {RequiredError}
|
|
500
607
|
*/
|
|
501
|
-
getOrder(
|
|
502
|
-
return localVarFp.getOrder(orderId, options).then((request) => request(axios, basePath));
|
|
608
|
+
getOrder(requestParameters, options) {
|
|
609
|
+
return localVarFp.getOrder(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
503
610
|
},
|
|
504
611
|
/**
|
|
505
612
|
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | 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 then 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).
|
|
506
|
-
* @param {
|
|
613
|
+
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
507
614
|
* @param {*} [options] Override http request option.
|
|
508
615
|
* @throws {RequiredError}
|
|
509
616
|
*/
|
|
510
|
-
getOrderAddress(
|
|
511
|
-
return localVarFp.getOrderAddress(orderId, options).then((request) => request(axios, basePath));
|
|
617
|
+
getOrderAddress(requestParameters, options) {
|
|
618
|
+
return localVarFp.getOrderAddress(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
512
619
|
},
|
|
513
620
|
/**
|
|
514
621
|
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | 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 then 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).
|
|
515
|
-
* @param {
|
|
622
|
+
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
516
623
|
* @param {*} [options] Override http request option.
|
|
517
624
|
* @throws {RequiredError}
|
|
518
625
|
*/
|
|
519
|
-
getOrderBuyerInfo(
|
|
520
|
-
return localVarFp.getOrderBuyerInfo(orderId, options).then((request) => request(axios, basePath));
|
|
626
|
+
getOrderBuyerInfo(requestParameters, options) {
|
|
627
|
+
return localVarFp.getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
521
628
|
},
|
|
522
629
|
/**
|
|
523
630
|
* Returns detailed order item information for the order that you specify. If NextToken is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then 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).
|
|
524
|
-
* @param {
|
|
525
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
631
|
+
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
526
632
|
* @param {*} [options] Override http request option.
|
|
527
633
|
* @throws {RequiredError}
|
|
528
634
|
*/
|
|
529
|
-
getOrderItems(
|
|
530
|
-
return localVarFp.getOrderItems(orderId, nextToken, options).then((request) => request(axios, basePath));
|
|
635
|
+
getOrderItems(requestParameters, options) {
|
|
636
|
+
return localVarFp.getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
637
|
+
},
|
|
638
|
+
/**
|
|
639
|
+
* Returns detailed order items approvals information for the order specified. If NextToken is provided, it\'s used to retrieve the next page of order items approvals. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
640
|
+
* @param {OrdersV0ApiGetOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
641
|
+
* @param {*} [options] Override http request option.
|
|
642
|
+
* @throws {RequiredError}
|
|
643
|
+
*/
|
|
644
|
+
getOrderItemsApprovals(requestParameters, options) {
|
|
645
|
+
return localVarFp.getOrderItemsApprovals(requestParameters.orderId, requestParameters.nextToken, requestParameters.itemApprovalTypes, requestParameters.itemApprovalStatus, options).then((request) => request(axios, basePath));
|
|
531
646
|
},
|
|
532
647
|
/**
|
|
533
648
|
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then 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).
|
|
534
|
-
* @param {
|
|
535
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
649
|
+
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
536
650
|
* @param {*} [options] Override http request option.
|
|
537
651
|
* @throws {RequiredError}
|
|
538
652
|
*/
|
|
539
|
-
getOrderItemsBuyerInfo(
|
|
540
|
-
return localVarFp.getOrderItemsBuyerInfo(orderId, nextToken, options).then((request) => request(axios, basePath));
|
|
653
|
+
getOrderItemsBuyerInfo(requestParameters, options) {
|
|
654
|
+
return localVarFp.getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
541
655
|
},
|
|
542
656
|
/**
|
|
543
657
|
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then 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).
|
|
544
|
-
* @param {
|
|
658
|
+
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
545
659
|
* @param {*} [options] Override http request option.
|
|
546
660
|
* @throws {RequiredError}
|
|
547
661
|
*/
|
|
548
|
-
getOrderRegulatedInfo(
|
|
549
|
-
return localVarFp.getOrderRegulatedInfo(orderId, options).then((request) => request(axios, basePath));
|
|
662
|
+
getOrderRegulatedInfo(requestParameters, options) {
|
|
663
|
+
return localVarFp.getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
550
664
|
},
|
|
551
665
|
/**
|
|
552
666
|
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | 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 then 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).
|
|
553
|
-
* @param {
|
|
554
|
-
* @param {
|
|
555
|
-
* @
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
*
|
|
562
|
-
* @param {
|
|
563
|
-
* @param {number} [maxResultsPerPage] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
|
|
564
|
-
* @param {Array<string>} [easyShipShipmentStatuses] A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.)
|
|
565
|
-
* @param {Array<string>} [electronicInvoiceStatuses] A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.)
|
|
566
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
567
|
-
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
568
|
-
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
569
|
-
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
570
|
-
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
667
|
+
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
668
|
+
* @param {*} [options] Override http request option.
|
|
669
|
+
* @throws {RequiredError}
|
|
670
|
+
*/
|
|
671
|
+
getOrders(requestParameters, options) {
|
|
672
|
+
return localVarFp.getOrders(requestParameters.marketplaceIds, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.orderStatuses, requestParameters.fulfillmentChannels, requestParameters.paymentMethods, requestParameters.buyerEmail, requestParameters.sellerOrderId, requestParameters.maxResultsPerPage, requestParameters.easyShipShipmentStatuses, requestParameters.electronicInvoiceStatuses, requestParameters.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, requestParameters.itemApprovalTypes, requestParameters.itemApprovalStatus, options).then((request) => request(axios, basePath));
|
|
673
|
+
},
|
|
674
|
+
/**
|
|
675
|
+
* Update the order items approvals for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 then 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).
|
|
676
|
+
* @param {OrdersV0ApiUpdateOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
571
677
|
* @param {*} [options] Override http request option.
|
|
572
678
|
* @throws {RequiredError}
|
|
573
679
|
*/
|
|
574
|
-
|
|
575
|
-
return localVarFp.
|
|
680
|
+
updateOrderItemsApprovals(requestParameters, options) {
|
|
681
|
+
return localVarFp.updateOrderItemsApprovals(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
|
|
576
682
|
},
|
|
577
683
|
/**
|
|
578
684
|
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 then 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).
|
|
579
|
-
* @param {
|
|
580
|
-
* @param {UpdateShipmentStatusRequest} payload The request body for the updateShipmentStatus operation.
|
|
685
|
+
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
581
686
|
* @param {*} [options] Override http request option.
|
|
582
687
|
* @throws {RequiredError}
|
|
583
688
|
*/
|
|
584
|
-
updateShipmentStatus(
|
|
585
|
-
return localVarFp.updateShipmentStatus(orderId, payload, options).then((request) => request(axios, basePath));
|
|
689
|
+
updateShipmentStatus(requestParameters, options) {
|
|
690
|
+
return localVarFp.updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
|
|
586
691
|
},
|
|
587
692
|
/**
|
|
588
693
|
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then 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).
|
|
589
|
-
* @param {
|
|
590
|
-
* @param {UpdateVerificationStatusRequest} payload The request body for the updateVerificationStatus operation.
|
|
694
|
+
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
591
695
|
* @param {*} [options] Override http request option.
|
|
592
696
|
* @throws {RequiredError}
|
|
593
697
|
*/
|
|
594
|
-
updateVerificationStatus(
|
|
595
|
-
return localVarFp.updateVerificationStatus(orderId, payload, options).then((request) => request(axios, basePath));
|
|
698
|
+
updateVerificationStatus(requestParameters, options) {
|
|
699
|
+
return localVarFp.updateVerificationStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
|
|
596
700
|
},
|
|
597
701
|
};
|
|
598
702
|
};
|
|
@@ -643,6 +747,16 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
643
747
|
getOrderItems(requestParameters, options) {
|
|
644
748
|
return OrdersV0ApiFp(this.configuration).getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
645
749
|
}
|
|
750
|
+
/**
|
|
751
|
+
* Returns detailed order items approvals information for the order specified. If NextToken is provided, it\'s used to retrieve the next page of order items approvals. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
752
|
+
* @param {OrdersV0ApiGetOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
753
|
+
* @param {*} [options] Override http request option.
|
|
754
|
+
* @throws {RequiredError}
|
|
755
|
+
* @memberof OrdersV0Api
|
|
756
|
+
*/
|
|
757
|
+
getOrderItemsApprovals(requestParameters, options) {
|
|
758
|
+
return OrdersV0ApiFp(this.configuration).getOrderItemsApprovals(requestParameters.orderId, requestParameters.nextToken, requestParameters.itemApprovalTypes, requestParameters.itemApprovalStatus, options).then((request) => request(this.axios, this.basePath));
|
|
759
|
+
}
|
|
646
760
|
/**
|
|
647
761
|
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | 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 then 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).
|
|
648
762
|
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
@@ -671,7 +785,17 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
671
785
|
* @memberof OrdersV0Api
|
|
672
786
|
*/
|
|
673
787
|
getOrders(requestParameters, options) {
|
|
674
|
-
return OrdersV0ApiFp(this.configuration).getOrders(requestParameters.marketplaceIds, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.orderStatuses, requestParameters.fulfillmentChannels, requestParameters.paymentMethods, requestParameters.buyerEmail, requestParameters.sellerOrderId, requestParameters.maxResultsPerPage, requestParameters.easyShipShipmentStatuses, requestParameters.electronicInvoiceStatuses, requestParameters.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, options).then((request) => request(this.axios, this.basePath));
|
|
788
|
+
return OrdersV0ApiFp(this.configuration).getOrders(requestParameters.marketplaceIds, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.orderStatuses, requestParameters.fulfillmentChannels, requestParameters.paymentMethods, requestParameters.buyerEmail, requestParameters.sellerOrderId, requestParameters.maxResultsPerPage, requestParameters.easyShipShipmentStatuses, requestParameters.electronicInvoiceStatuses, requestParameters.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, requestParameters.itemApprovalTypes, requestParameters.itemApprovalStatus, options).then((request) => request(this.axios, this.basePath));
|
|
789
|
+
}
|
|
790
|
+
/**
|
|
791
|
+
* Update the order items approvals for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 then 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).
|
|
792
|
+
* @param {OrdersV0ApiUpdateOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
793
|
+
* @param {*} [options] Override http request option.
|
|
794
|
+
* @throws {RequiredError}
|
|
795
|
+
* @memberof OrdersV0Api
|
|
796
|
+
*/
|
|
797
|
+
updateOrderItemsApprovals(requestParameters, options) {
|
|
798
|
+
return OrdersV0ApiFp(this.configuration).updateOrderItemsApprovals(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
675
799
|
}
|
|
676
800
|
/**
|
|
677
801
|
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | 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 then 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).
|
|
@@ -11,8 +11,6 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
-
// Some imports not used depending on template conditions
|
|
15
|
-
// @ts-ignore
|
|
16
14
|
import globalAxios from 'axios';
|
|
17
15
|
export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
|
|
18
16
|
/**
|
|
@@ -52,9 +50,9 @@ export class BaseAPI {
|
|
|
52
50
|
*/
|
|
53
51
|
export class RequiredError extends Error {
|
|
54
52
|
field;
|
|
55
|
-
name = "RequiredError";
|
|
56
53
|
constructor(field, msg) {
|
|
57
54
|
super(msg);
|
|
58
55
|
this.field = field;
|
|
56
|
+
this.name = "RequiredError";
|
|
59
57
|
}
|
|
60
58
|
}
|
|
@@ -73,6 +73,8 @@ export const setOAuthToObject = async function (object, name, scopes, configurat
|
|
|
73
73
|
}
|
|
74
74
|
};
|
|
75
75
|
function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
|
|
76
|
+
if (parameter == null)
|
|
77
|
+
return;
|
|
76
78
|
if (typeof parameter === "object") {
|
|
77
79
|
if (Array.isArray(parameter)) {
|
|
78
80
|
parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Orders
|
|
5
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Orders
|
|
5
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|