@sp-api-sdk/orders-api-v0 1.14.0 → 1.16.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 +57 -51
- package/dist/cjs/src/api-model/models/easy-ship-shipment-status.js +39 -0
- package/dist/cjs/src/api-model/models/electronic-invoice-status.js +28 -0
- package/dist/cjs/src/api-model/models/index.js +2 -0
- package/dist/cjs/src/api-model/models/shipment-status.js +1 -1
- package/dist/es/src/api-model/api/orders-v0-api.js +57 -51
- package/dist/es/src/api-model/models/easy-ship-shipment-status.js +36 -0
- package/dist/es/src/api-model/models/electronic-invoice-status.js +25 -0
- package/dist/es/src/api-model/models/index.js +2 -0
- package/dist/es/src/api-model/models/shipment-status.js +1 -1
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +60 -51
- package/dist/types/src/api-model/common.d.ts +1 -0
- package/dist/types/src/api-model/models/automated-shipping-settings.d.ts +1 -1
- package/dist/types/src/api-model/models/buyer-info.d.ts +1 -1
- package/dist/types/src/api-model/models/easy-ship-shipment-status.d.ts +35 -0
- package/dist/types/src/api-model/models/electronic-invoice-status.d.ts +24 -0
- package/dist/types/src/api-model/models/index.d.ts +2 -0
- package/dist/types/src/api-model/models/model-error.d.ts +1 -1
- package/dist/types/src/api-model/models/order-items-inner.d.ts +2 -2
- package/dist/types/src/api-model/models/order-regulated-info.d.ts +1 -1
- package/dist/types/src/api-model/models/order.d.ts +14 -6
- package/dist/types/src/api-model/models/regulated-information-field.d.ts +3 -3
- package/dist/types/src/api-model/models/regulated-order-verification-status.d.ts +1 -1
- package/dist/types/src/api-model/models/rejection-reason.d.ts +1 -1
- package/dist/types/src/api-model/models/shipment-status.d.ts +1 -1
- package/dist/types/src/api-model/models/update-shipment-status-request.d.ts +3 -3
- package/dist/types/src/api-model/models/update-verification-status-request.d.ts +1 -1
- package/package.json +7 -5
|
@@ -28,7 +28,7 @@ const base_1 = require("../base");
|
|
|
28
28
|
const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
29
29
|
return {
|
|
30
30
|
/**
|
|
31
|
-
* Returns the order
|
|
31
|
+
* 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).
|
|
32
32
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
33
33
|
* @param {*} [options] Override http request option.
|
|
34
34
|
* @throws {RequiredError}
|
|
@@ -56,7 +56,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
56
56
|
};
|
|
57
57
|
},
|
|
58
58
|
/**
|
|
59
|
-
* Returns the shipping address for the
|
|
59
|
+
* 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).
|
|
60
60
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
61
61
|
* @param {*} [options] Override http request option.
|
|
62
62
|
* @throws {RequiredError}
|
|
@@ -84,7 +84,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
84
84
|
};
|
|
85
85
|
},
|
|
86
86
|
/**
|
|
87
|
-
* Returns buyer information for the
|
|
87
|
+
* 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).
|
|
88
88
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
89
89
|
* @param {*} [options] Override http request option.
|
|
90
90
|
* @throws {RequiredError}
|
|
@@ -112,7 +112,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
112
112
|
};
|
|
113
113
|
},
|
|
114
114
|
/**
|
|
115
|
-
* Returns detailed order item information for the order
|
|
115
|
+
* 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).
|
|
116
116
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
117
117
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
118
118
|
* @param {*} [options] Override http request option.
|
|
@@ -144,7 +144,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
144
144
|
};
|
|
145
145
|
},
|
|
146
146
|
/**
|
|
147
|
-
* Returns buyer information for the order items in the
|
|
147
|
+
* 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).
|
|
148
148
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
149
149
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
150
150
|
* @param {*} [options] Override http request option.
|
|
@@ -176,7 +176,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
176
176
|
};
|
|
177
177
|
},
|
|
178
178
|
/**
|
|
179
|
-
* Returns regulated information for the order
|
|
179
|
+
* 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).
|
|
180
180
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
181
181
|
* @param {*} [options] Override http request option.
|
|
182
182
|
* @throws {RequiredError}
|
|
@@ -204,7 +204,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
204
204
|
};
|
|
205
205
|
},
|
|
206
206
|
/**
|
|
207
|
-
* 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
|
|
207
|
+
* 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).
|
|
208
208
|
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
209
209
|
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
210
210
|
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
@@ -216,7 +216,8 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
216
216
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
217
217
|
* @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.
|
|
218
218
|
* @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.
|
|
219
|
-
* @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy
|
|
219
|
+
* @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 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).
|
|
220
|
+
* @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 (electronic invoice was not submitted for this order), Processing (electronic invoice is being processed for this order), Errored (last submitted electronic invoice was rejected for this order), Accepted (last submitted electronic invoice was submitted and accepted)
|
|
220
221
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
221
222
|
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
222
223
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
@@ -225,7 +226,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
225
226
|
* @param {*} [options] Override http request option.
|
|
226
227
|
* @throws {RequiredError}
|
|
227
228
|
*/
|
|
228
|
-
getOrders: async (marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options = {}) => {
|
|
229
|
+
getOrders: async (marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options = {}) => {
|
|
229
230
|
// verify required parameter 'marketplaceIds' is not null or undefined
|
|
230
231
|
(0, common_1.assertParamExists)('getOrders', 'marketplaceIds', marketplaceIds);
|
|
231
232
|
const localVarPath = `/orders/v0/orders`;
|
|
@@ -274,6 +275,9 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
274
275
|
if (easyShipShipmentStatuses) {
|
|
275
276
|
localVarQueryParameter['EasyShipShipmentStatuses'] = easyShipShipmentStatuses.join(base_1.COLLECTION_FORMATS.csv);
|
|
276
277
|
}
|
|
278
|
+
if (electronicInvoiceStatuses) {
|
|
279
|
+
localVarQueryParameter['ElectronicInvoiceStatuses'] = electronicInvoiceStatuses.join(base_1.COLLECTION_FORMATS.csv);
|
|
280
|
+
}
|
|
277
281
|
if (nextToken !== undefined) {
|
|
278
282
|
localVarQueryParameter['NextToken'] = nextToken;
|
|
279
283
|
}
|
|
@@ -298,9 +302,9 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
298
302
|
};
|
|
299
303
|
},
|
|
300
304
|
/**
|
|
301
|
-
* Update the shipment status. **Usage
|
|
305
|
+
* 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
306
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
303
|
-
* @param {UpdateShipmentStatusRequest} payload
|
|
307
|
+
* @param {UpdateShipmentStatusRequest} payload The request body for the updateShipmentStatus operation.
|
|
304
308
|
* @param {*} [options] Override http request option.
|
|
305
309
|
* @throws {RequiredError}
|
|
306
310
|
*/
|
|
@@ -331,9 +335,9 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
331
335
|
};
|
|
332
336
|
},
|
|
333
337
|
/**
|
|
334
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage
|
|
338
|
+
* 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).
|
|
335
339
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
336
|
-
* @param {UpdateVerificationStatusRequest} payload
|
|
340
|
+
* @param {UpdateVerificationStatusRequest} payload The request body for the updateVerificationStatus operation.
|
|
337
341
|
* @param {*} [options] Override http request option.
|
|
338
342
|
* @throws {RequiredError}
|
|
339
343
|
*/
|
|
@@ -374,7 +378,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
374
378
|
const localVarAxiosParamCreator = (0, exports.OrdersV0ApiAxiosParamCreator)(configuration);
|
|
375
379
|
return {
|
|
376
380
|
/**
|
|
377
|
-
* Returns the order
|
|
381
|
+
* 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).
|
|
378
382
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
379
383
|
* @param {*} [options] Override http request option.
|
|
380
384
|
* @throws {RequiredError}
|
|
@@ -384,7 +388,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
384
388
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
385
389
|
},
|
|
386
390
|
/**
|
|
387
|
-
* Returns the shipping address for the
|
|
391
|
+
* 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).
|
|
388
392
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
389
393
|
* @param {*} [options] Override http request option.
|
|
390
394
|
* @throws {RequiredError}
|
|
@@ -394,7 +398,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
394
398
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
395
399
|
},
|
|
396
400
|
/**
|
|
397
|
-
* Returns buyer information for the
|
|
401
|
+
* 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).
|
|
398
402
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
399
403
|
* @param {*} [options] Override http request option.
|
|
400
404
|
* @throws {RequiredError}
|
|
@@ -404,7 +408,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
404
408
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
405
409
|
},
|
|
406
410
|
/**
|
|
407
|
-
* Returns detailed order item information for the order
|
|
411
|
+
* 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).
|
|
408
412
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
409
413
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
410
414
|
* @param {*} [options] Override http request option.
|
|
@@ -415,7 +419,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
415
419
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
416
420
|
},
|
|
417
421
|
/**
|
|
418
|
-
* Returns buyer information for the order items in the
|
|
422
|
+
* 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).
|
|
419
423
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
420
424
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
421
425
|
* @param {*} [options] Override http request option.
|
|
@@ -426,7 +430,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
426
430
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
427
431
|
},
|
|
428
432
|
/**
|
|
429
|
-
* Returns regulated information for the order
|
|
433
|
+
* 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).
|
|
430
434
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
431
435
|
* @param {*} [options] Override http request option.
|
|
432
436
|
* @throws {RequiredError}
|
|
@@ -436,7 +440,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
436
440
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
437
441
|
},
|
|
438
442
|
/**
|
|
439
|
-
* 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
|
|
443
|
+
* 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).
|
|
440
444
|
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
441
445
|
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
442
446
|
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
@@ -448,7 +452,8 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
448
452
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
449
453
|
* @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.
|
|
450
454
|
* @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.
|
|
451
|
-
* @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy
|
|
455
|
+
* @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 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).
|
|
456
|
+
* @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 (electronic invoice was not submitted for this order), Processing (electronic invoice is being processed for this order), Errored (last submitted electronic invoice was rejected for this order), Accepted (last submitted electronic invoice was submitted and accepted)
|
|
452
457
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
453
458
|
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
454
459
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
@@ -457,14 +462,14 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
457
462
|
* @param {*} [options] Override http request option.
|
|
458
463
|
* @throws {RequiredError}
|
|
459
464
|
*/
|
|
460
|
-
async getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options) {
|
|
461
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options);
|
|
465
|
+
async getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options) {
|
|
466
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options);
|
|
462
467
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
463
468
|
},
|
|
464
469
|
/**
|
|
465
|
-
* Update the shipment status. **Usage
|
|
470
|
+
* 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).
|
|
466
471
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
467
|
-
* @param {UpdateShipmentStatusRequest} payload
|
|
472
|
+
* @param {UpdateShipmentStatusRequest} payload The request body for the updateShipmentStatus operation.
|
|
468
473
|
* @param {*} [options] Override http request option.
|
|
469
474
|
* @throws {RequiredError}
|
|
470
475
|
*/
|
|
@@ -473,9 +478,9 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
473
478
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
474
479
|
},
|
|
475
480
|
/**
|
|
476
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage
|
|
481
|
+
* 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).
|
|
477
482
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
478
|
-
* @param {UpdateVerificationStatusRequest} payload
|
|
483
|
+
* @param {UpdateVerificationStatusRequest} payload The request body for the updateVerificationStatus operation.
|
|
479
484
|
* @param {*} [options] Override http request option.
|
|
480
485
|
* @throws {RequiredError}
|
|
481
486
|
*/
|
|
@@ -494,7 +499,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
494
499
|
const localVarFp = (0, exports.OrdersV0ApiFp)(configuration);
|
|
495
500
|
return {
|
|
496
501
|
/**
|
|
497
|
-
* Returns the order
|
|
502
|
+
* 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).
|
|
498
503
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
499
504
|
* @param {*} [options] Override http request option.
|
|
500
505
|
* @throws {RequiredError}
|
|
@@ -503,7 +508,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
503
508
|
return localVarFp.getOrder(orderId, options).then((request) => request(axios, basePath));
|
|
504
509
|
},
|
|
505
510
|
/**
|
|
506
|
-
* Returns the shipping address for the
|
|
511
|
+
* 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).
|
|
507
512
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
508
513
|
* @param {*} [options] Override http request option.
|
|
509
514
|
* @throws {RequiredError}
|
|
@@ -512,7 +517,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
512
517
|
return localVarFp.getOrderAddress(orderId, options).then((request) => request(axios, basePath));
|
|
513
518
|
},
|
|
514
519
|
/**
|
|
515
|
-
* Returns buyer information for the
|
|
520
|
+
* 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).
|
|
516
521
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
517
522
|
* @param {*} [options] Override http request option.
|
|
518
523
|
* @throws {RequiredError}
|
|
@@ -521,7 +526,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
521
526
|
return localVarFp.getOrderBuyerInfo(orderId, options).then((request) => request(axios, basePath));
|
|
522
527
|
},
|
|
523
528
|
/**
|
|
524
|
-
* Returns detailed order item information for the order
|
|
529
|
+
* 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).
|
|
525
530
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
526
531
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
527
532
|
* @param {*} [options] Override http request option.
|
|
@@ -531,7 +536,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
531
536
|
return localVarFp.getOrderItems(orderId, nextToken, options).then((request) => request(axios, basePath));
|
|
532
537
|
},
|
|
533
538
|
/**
|
|
534
|
-
* Returns buyer information for the order items in the
|
|
539
|
+
* 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).
|
|
535
540
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
536
541
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
537
542
|
* @param {*} [options] Override http request option.
|
|
@@ -541,7 +546,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
541
546
|
return localVarFp.getOrderItemsBuyerInfo(orderId, nextToken, options).then((request) => request(axios, basePath));
|
|
542
547
|
},
|
|
543
548
|
/**
|
|
544
|
-
* Returns regulated information for the order
|
|
549
|
+
* 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).
|
|
545
550
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
546
551
|
* @param {*} [options] Override http request option.
|
|
547
552
|
* @throws {RequiredError}
|
|
@@ -550,7 +555,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
550
555
|
return localVarFp.getOrderRegulatedInfo(orderId, options).then((request) => request(axios, basePath));
|
|
551
556
|
},
|
|
552
557
|
/**
|
|
553
|
-
* 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
|
|
558
|
+
* 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).
|
|
554
559
|
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
555
560
|
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
556
561
|
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
@@ -562,7 +567,8 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
562
567
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
563
568
|
* @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.
|
|
564
569
|
* @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.
|
|
565
|
-
* @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy
|
|
570
|
+
* @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 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).
|
|
571
|
+
* @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 (electronic invoice was not submitted for this order), Processing (electronic invoice is being processed for this order), Errored (last submitted electronic invoice was rejected for this order), Accepted (last submitted electronic invoice was submitted and accepted)
|
|
566
572
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
567
573
|
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
568
574
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
@@ -571,13 +577,13 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
571
577
|
* @param {*} [options] Override http request option.
|
|
572
578
|
* @throws {RequiredError}
|
|
573
579
|
*/
|
|
574
|
-
getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options) {
|
|
575
|
-
return localVarFp.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options).then((request) => request(axios, basePath));
|
|
580
|
+
getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options) {
|
|
581
|
+
return localVarFp.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options).then((request) => request(axios, basePath));
|
|
576
582
|
},
|
|
577
583
|
/**
|
|
578
|
-
* Update the shipment status. **Usage
|
|
584
|
+
* 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
585
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
580
|
-
* @param {UpdateShipmentStatusRequest} payload
|
|
586
|
+
* @param {UpdateShipmentStatusRequest} payload The request body for the updateShipmentStatus operation.
|
|
581
587
|
* @param {*} [options] Override http request option.
|
|
582
588
|
* @throws {RequiredError}
|
|
583
589
|
*/
|
|
@@ -585,9 +591,9 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
585
591
|
return localVarFp.updateShipmentStatus(orderId, payload, options).then((request) => request(axios, basePath));
|
|
586
592
|
},
|
|
587
593
|
/**
|
|
588
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage
|
|
594
|
+
* 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
595
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
590
|
-
* @param {UpdateVerificationStatusRequest} payload
|
|
596
|
+
* @param {UpdateVerificationStatusRequest} payload The request body for the updateVerificationStatus operation.
|
|
591
597
|
* @param {*} [options] Override http request option.
|
|
592
598
|
* @throws {RequiredError}
|
|
593
599
|
*/
|
|
@@ -605,7 +611,7 @@ exports.OrdersV0ApiFactory = OrdersV0ApiFactory;
|
|
|
605
611
|
*/
|
|
606
612
|
class OrdersV0Api extends base_1.BaseAPI {
|
|
607
613
|
/**
|
|
608
|
-
* Returns the order
|
|
614
|
+
* 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).
|
|
609
615
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
610
616
|
* @param {*} [options] Override http request option.
|
|
611
617
|
* @throws {RequiredError}
|
|
@@ -615,7 +621,7 @@ class OrdersV0Api extends base_1.BaseAPI {
|
|
|
615
621
|
return (0, exports.OrdersV0ApiFp)(this.configuration).getOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
616
622
|
}
|
|
617
623
|
/**
|
|
618
|
-
* Returns the shipping address for the
|
|
624
|
+
* 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).
|
|
619
625
|
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
620
626
|
* @param {*} [options] Override http request option.
|
|
621
627
|
* @throws {RequiredError}
|
|
@@ -625,7 +631,7 @@ class OrdersV0Api extends base_1.BaseAPI {
|
|
|
625
631
|
return (0, exports.OrdersV0ApiFp)(this.configuration).getOrderAddress(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
626
632
|
}
|
|
627
633
|
/**
|
|
628
|
-
* Returns buyer information for the
|
|
634
|
+
* 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).
|
|
629
635
|
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
630
636
|
* @param {*} [options] Override http request option.
|
|
631
637
|
* @throws {RequiredError}
|
|
@@ -635,7 +641,7 @@ class OrdersV0Api extends base_1.BaseAPI {
|
|
|
635
641
|
return (0, exports.OrdersV0ApiFp)(this.configuration).getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
636
642
|
}
|
|
637
643
|
/**
|
|
638
|
-
* Returns detailed order item information for the order
|
|
644
|
+
* 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).
|
|
639
645
|
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
640
646
|
* @param {*} [options] Override http request option.
|
|
641
647
|
* @throws {RequiredError}
|
|
@@ -645,7 +651,7 @@ class OrdersV0Api extends base_1.BaseAPI {
|
|
|
645
651
|
return (0, exports.OrdersV0ApiFp)(this.configuration).getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
646
652
|
}
|
|
647
653
|
/**
|
|
648
|
-
* Returns buyer information for the order items in the
|
|
654
|
+
* 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).
|
|
649
655
|
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
650
656
|
* @param {*} [options] Override http request option.
|
|
651
657
|
* @throws {RequiredError}
|
|
@@ -655,7 +661,7 @@ class OrdersV0Api extends base_1.BaseAPI {
|
|
|
655
661
|
return (0, exports.OrdersV0ApiFp)(this.configuration).getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
656
662
|
}
|
|
657
663
|
/**
|
|
658
|
-
* Returns regulated information for the order
|
|
664
|
+
* 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).
|
|
659
665
|
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
660
666
|
* @param {*} [options] Override http request option.
|
|
661
667
|
* @throws {RequiredError}
|
|
@@ -665,17 +671,17 @@ class OrdersV0Api extends base_1.BaseAPI {
|
|
|
665
671
|
return (0, exports.OrdersV0ApiFp)(this.configuration).getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
666
672
|
}
|
|
667
673
|
/**
|
|
668
|
-
* 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
|
|
674
|
+
* 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).
|
|
669
675
|
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
670
676
|
* @param {*} [options] Override http request option.
|
|
671
677
|
* @throws {RequiredError}
|
|
672
678
|
* @memberof OrdersV0Api
|
|
673
679
|
*/
|
|
674
680
|
getOrders(requestParameters, options) {
|
|
675
|
-
return (0, exports.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.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, options).then((request) => request(this.axios, this.basePath));
|
|
681
|
+
return (0, exports.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));
|
|
676
682
|
}
|
|
677
683
|
/**
|
|
678
|
-
* Update the shipment status. **Usage
|
|
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).
|
|
679
685
|
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
680
686
|
* @param {*} [options] Override http request option.
|
|
681
687
|
* @throws {RequiredError}
|
|
@@ -685,7 +691,7 @@ class OrdersV0Api extends base_1.BaseAPI {
|
|
|
685
691
|
return (0, exports.OrdersV0ApiFp)(this.configuration).updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
686
692
|
}
|
|
687
693
|
/**
|
|
688
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage
|
|
694
|
+
* 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).
|
|
689
695
|
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
690
696
|
* @param {*} [options] Override http request option.
|
|
691
697
|
* @throws {RequiredError}
|
|
@@ -0,0 +1,39 @@
|
|
|
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.EasyShipShipmentStatus = void 0;
|
|
17
|
+
/**
|
|
18
|
+
* The status of the Amazon Easy-Ship order. This property is included only for Amazon Easy-Ship orders.
|
|
19
|
+
* @export
|
|
20
|
+
* @enum {string}
|
|
21
|
+
*/
|
|
22
|
+
exports.EasyShipShipmentStatus = {
|
|
23
|
+
PendingSchedule: 'PendingSchedule',
|
|
24
|
+
PendingPickUp: 'PendingPickUp',
|
|
25
|
+
PendingDropOff: 'PendingDropOff',
|
|
26
|
+
LabelCanceled: 'LabelCanceled',
|
|
27
|
+
PickedUp: 'PickedUp',
|
|
28
|
+
DroppedOff: 'DroppedOff',
|
|
29
|
+
AtOriginFc: 'AtOriginFC',
|
|
30
|
+
AtDestinationFc: 'AtDestinationFC',
|
|
31
|
+
Delivered: 'Delivered',
|
|
32
|
+
RejectedByBuyer: 'RejectedByBuyer',
|
|
33
|
+
Undeliverable: 'Undeliverable',
|
|
34
|
+
ReturningToSeller: 'ReturningToSeller',
|
|
35
|
+
ReturnedToSeller: 'ReturnedToSeller',
|
|
36
|
+
Lost: 'Lost',
|
|
37
|
+
OutForDelivery: 'OutForDelivery',
|
|
38
|
+
Damaged: 'Damaged'
|
|
39
|
+
};
|