@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
|
@@ -24,7 +24,7 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
|
|
|
24
24
|
export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
|
-
* Returns the order
|
|
27
|
+
* 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).
|
|
28
28
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
29
29
|
* @param {*} [options] Override http request option.
|
|
30
30
|
* @throws {RequiredError}
|
|
@@ -52,7 +52,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
52
52
|
};
|
|
53
53
|
},
|
|
54
54
|
/**
|
|
55
|
-
* Returns the shipping address for the
|
|
55
|
+
* 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).
|
|
56
56
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
57
57
|
* @param {*} [options] Override http request option.
|
|
58
58
|
* @throws {RequiredError}
|
|
@@ -80,7 +80,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
80
80
|
};
|
|
81
81
|
},
|
|
82
82
|
/**
|
|
83
|
-
* Returns buyer information for the
|
|
83
|
+
* 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).
|
|
84
84
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
85
85
|
* @param {*} [options] Override http request option.
|
|
86
86
|
* @throws {RequiredError}
|
|
@@ -108,7 +108,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
108
108
|
};
|
|
109
109
|
},
|
|
110
110
|
/**
|
|
111
|
-
* Returns detailed order item information for the order
|
|
111
|
+
* 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).
|
|
112
112
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
113
113
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
114
114
|
* @param {*} [options] Override http request option.
|
|
@@ -140,7 +140,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
140
140
|
};
|
|
141
141
|
},
|
|
142
142
|
/**
|
|
143
|
-
* Returns buyer information for the order items in the
|
|
143
|
+
* 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
144
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
145
145
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
146
146
|
* @param {*} [options] Override http request option.
|
|
@@ -172,7 +172,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
172
172
|
};
|
|
173
173
|
},
|
|
174
174
|
/**
|
|
175
|
-
* Returns regulated information for the order
|
|
175
|
+
* 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).
|
|
176
176
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
177
177
|
* @param {*} [options] Override http request option.
|
|
178
178
|
* @throws {RequiredError}
|
|
@@ -200,7 +200,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
200
200
|
};
|
|
201
201
|
},
|
|
202
202
|
/**
|
|
203
|
-
* 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
|
|
203
|
+
* 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).
|
|
204
204
|
* @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.
|
|
205
205
|
* @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.
|
|
206
206
|
* @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.
|
|
@@ -212,7 +212,8 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
212
212
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
213
213
|
* @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.
|
|
214
214
|
* @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.
|
|
215
|
-
* @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy
|
|
215
|
+
* @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).
|
|
216
|
+
* @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)
|
|
216
217
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
217
218
|
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
218
219
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
@@ -221,7 +222,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
221
222
|
* @param {*} [options] Override http request option.
|
|
222
223
|
* @throws {RequiredError}
|
|
223
224
|
*/
|
|
224
|
-
getOrders: async (marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options = {}) => {
|
|
225
|
+
getOrders: async (marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options = {}) => {
|
|
225
226
|
// verify required parameter 'marketplaceIds' is not null or undefined
|
|
226
227
|
assertParamExists('getOrders', 'marketplaceIds', marketplaceIds);
|
|
227
228
|
const localVarPath = `/orders/v0/orders`;
|
|
@@ -270,6 +271,9 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
270
271
|
if (easyShipShipmentStatuses) {
|
|
271
272
|
localVarQueryParameter['EasyShipShipmentStatuses'] = easyShipShipmentStatuses.join(COLLECTION_FORMATS.csv);
|
|
272
273
|
}
|
|
274
|
+
if (electronicInvoiceStatuses) {
|
|
275
|
+
localVarQueryParameter['ElectronicInvoiceStatuses'] = electronicInvoiceStatuses.join(COLLECTION_FORMATS.csv);
|
|
276
|
+
}
|
|
273
277
|
if (nextToken !== undefined) {
|
|
274
278
|
localVarQueryParameter['NextToken'] = nextToken;
|
|
275
279
|
}
|
|
@@ -294,9 +298,9 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
294
298
|
};
|
|
295
299
|
},
|
|
296
300
|
/**
|
|
297
|
-
* Update the shipment status. **Usage
|
|
301
|
+
* 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).
|
|
298
302
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
299
|
-
* @param {UpdateShipmentStatusRequest} payload
|
|
303
|
+
* @param {UpdateShipmentStatusRequest} payload The request body for the updateShipmentStatus operation.
|
|
300
304
|
* @param {*} [options] Override http request option.
|
|
301
305
|
* @throws {RequiredError}
|
|
302
306
|
*/
|
|
@@ -327,9 +331,9 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
327
331
|
};
|
|
328
332
|
},
|
|
329
333
|
/**
|
|
330
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage
|
|
334
|
+
* 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).
|
|
331
335
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
332
|
-
* @param {UpdateVerificationStatusRequest} payload
|
|
336
|
+
* @param {UpdateVerificationStatusRequest} payload The request body for the updateVerificationStatus operation.
|
|
333
337
|
* @param {*} [options] Override http request option.
|
|
334
338
|
* @throws {RequiredError}
|
|
335
339
|
*/
|
|
@@ -369,7 +373,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
369
373
|
const localVarAxiosParamCreator = OrdersV0ApiAxiosParamCreator(configuration);
|
|
370
374
|
return {
|
|
371
375
|
/**
|
|
372
|
-
* Returns the order
|
|
376
|
+
* 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).
|
|
373
377
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
374
378
|
* @param {*} [options] Override http request option.
|
|
375
379
|
* @throws {RequiredError}
|
|
@@ -379,7 +383,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
379
383
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
380
384
|
},
|
|
381
385
|
/**
|
|
382
|
-
* Returns the shipping address for the
|
|
386
|
+
* 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).
|
|
383
387
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
384
388
|
* @param {*} [options] Override http request option.
|
|
385
389
|
* @throws {RequiredError}
|
|
@@ -389,7 +393,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
389
393
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
390
394
|
},
|
|
391
395
|
/**
|
|
392
|
-
* Returns buyer information for the
|
|
396
|
+
* 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).
|
|
393
397
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
394
398
|
* @param {*} [options] Override http request option.
|
|
395
399
|
* @throws {RequiredError}
|
|
@@ -399,7 +403,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
399
403
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
400
404
|
},
|
|
401
405
|
/**
|
|
402
|
-
* Returns detailed order item information for the order
|
|
406
|
+
* 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).
|
|
403
407
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
404
408
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
405
409
|
* @param {*} [options] Override http request option.
|
|
@@ -410,7 +414,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
410
414
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
411
415
|
},
|
|
412
416
|
/**
|
|
413
|
-
* Returns buyer information for the order items in the
|
|
417
|
+
* 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).
|
|
414
418
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
415
419
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
416
420
|
* @param {*} [options] Override http request option.
|
|
@@ -421,7 +425,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
421
425
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
422
426
|
},
|
|
423
427
|
/**
|
|
424
|
-
* Returns regulated information for the order
|
|
428
|
+
* 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).
|
|
425
429
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
426
430
|
* @param {*} [options] Override http request option.
|
|
427
431
|
* @throws {RequiredError}
|
|
@@ -431,7 +435,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
431
435
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
432
436
|
},
|
|
433
437
|
/**
|
|
434
|
-
* 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
|
|
438
|
+
* 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).
|
|
435
439
|
* @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.
|
|
436
440
|
* @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.
|
|
437
441
|
* @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.
|
|
@@ -443,7 +447,8 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
443
447
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
444
448
|
* @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.
|
|
445
449
|
* @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.
|
|
446
|
-
* @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy
|
|
450
|
+
* @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).
|
|
451
|
+
* @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)
|
|
447
452
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
448
453
|
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
449
454
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
@@ -452,14 +457,14 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
452
457
|
* @param {*} [options] Override http request option.
|
|
453
458
|
* @throws {RequiredError}
|
|
454
459
|
*/
|
|
455
|
-
async getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options) {
|
|
456
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options);
|
|
460
|
+
async getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options) {
|
|
461
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options);
|
|
457
462
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
458
463
|
},
|
|
459
464
|
/**
|
|
460
|
-
* Update the shipment status. **Usage
|
|
465
|
+
* 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).
|
|
461
466
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
462
|
-
* @param {UpdateShipmentStatusRequest} payload
|
|
467
|
+
* @param {UpdateShipmentStatusRequest} payload The request body for the updateShipmentStatus operation.
|
|
463
468
|
* @param {*} [options] Override http request option.
|
|
464
469
|
* @throws {RequiredError}
|
|
465
470
|
*/
|
|
@@ -468,9 +473,9 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
468
473
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
469
474
|
},
|
|
470
475
|
/**
|
|
471
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage
|
|
476
|
+
* 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).
|
|
472
477
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
473
|
-
* @param {UpdateVerificationStatusRequest} payload
|
|
478
|
+
* @param {UpdateVerificationStatusRequest} payload The request body for the updateVerificationStatus operation.
|
|
474
479
|
* @param {*} [options] Override http request option.
|
|
475
480
|
* @throws {RequiredError}
|
|
476
481
|
*/
|
|
@@ -488,7 +493,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
488
493
|
const localVarFp = OrdersV0ApiFp(configuration);
|
|
489
494
|
return {
|
|
490
495
|
/**
|
|
491
|
-
* Returns the order
|
|
496
|
+
* 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).
|
|
492
497
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
493
498
|
* @param {*} [options] Override http request option.
|
|
494
499
|
* @throws {RequiredError}
|
|
@@ -497,7 +502,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
497
502
|
return localVarFp.getOrder(orderId, options).then((request) => request(axios, basePath));
|
|
498
503
|
},
|
|
499
504
|
/**
|
|
500
|
-
* Returns the shipping address for the
|
|
505
|
+
* 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).
|
|
501
506
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
502
507
|
* @param {*} [options] Override http request option.
|
|
503
508
|
* @throws {RequiredError}
|
|
@@ -506,7 +511,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
506
511
|
return localVarFp.getOrderAddress(orderId, options).then((request) => request(axios, basePath));
|
|
507
512
|
},
|
|
508
513
|
/**
|
|
509
|
-
* Returns buyer information for the
|
|
514
|
+
* 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).
|
|
510
515
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
511
516
|
* @param {*} [options] Override http request option.
|
|
512
517
|
* @throws {RequiredError}
|
|
@@ -515,7 +520,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
515
520
|
return localVarFp.getOrderBuyerInfo(orderId, options).then((request) => request(axios, basePath));
|
|
516
521
|
},
|
|
517
522
|
/**
|
|
518
|
-
* Returns detailed order item information for the order
|
|
523
|
+
* 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).
|
|
519
524
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
520
525
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
521
526
|
* @param {*} [options] Override http request option.
|
|
@@ -525,7 +530,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
525
530
|
return localVarFp.getOrderItems(orderId, nextToken, options).then((request) => request(axios, basePath));
|
|
526
531
|
},
|
|
527
532
|
/**
|
|
528
|
-
* Returns buyer information for the order items in the
|
|
533
|
+
* 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).
|
|
529
534
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
530
535
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
531
536
|
* @param {*} [options] Override http request option.
|
|
@@ -535,7 +540,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
535
540
|
return localVarFp.getOrderItemsBuyerInfo(orderId, nextToken, options).then((request) => request(axios, basePath));
|
|
536
541
|
},
|
|
537
542
|
/**
|
|
538
|
-
* Returns regulated information for the order
|
|
543
|
+
* 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).
|
|
539
544
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
540
545
|
* @param {*} [options] Override http request option.
|
|
541
546
|
* @throws {RequiredError}
|
|
@@ -544,7 +549,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
544
549
|
return localVarFp.getOrderRegulatedInfo(orderId, options).then((request) => request(axios, basePath));
|
|
545
550
|
},
|
|
546
551
|
/**
|
|
547
|
-
* 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
|
|
552
|
+
* 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).
|
|
548
553
|
* @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.
|
|
549
554
|
* @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.
|
|
550
555
|
* @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.
|
|
@@ -556,7 +561,8 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
556
561
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
557
562
|
* @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.
|
|
558
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.
|
|
559
|
-
* @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy
|
|
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 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 (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)
|
|
560
566
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
561
567
|
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
562
568
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
@@ -565,13 +571,13 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
565
571
|
* @param {*} [options] Override http request option.
|
|
566
572
|
* @throws {RequiredError}
|
|
567
573
|
*/
|
|
568
|
-
getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options) {
|
|
569
|
-
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));
|
|
574
|
+
getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options) {
|
|
575
|
+
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));
|
|
570
576
|
},
|
|
571
577
|
/**
|
|
572
|
-
* Update the shipment status. **Usage
|
|
578
|
+
* 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).
|
|
573
579
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
574
|
-
* @param {UpdateShipmentStatusRequest} payload
|
|
580
|
+
* @param {UpdateShipmentStatusRequest} payload The request body for the updateShipmentStatus operation.
|
|
575
581
|
* @param {*} [options] Override http request option.
|
|
576
582
|
* @throws {RequiredError}
|
|
577
583
|
*/
|
|
@@ -579,9 +585,9 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
579
585
|
return localVarFp.updateShipmentStatus(orderId, payload, options).then((request) => request(axios, basePath));
|
|
580
586
|
},
|
|
581
587
|
/**
|
|
582
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage
|
|
588
|
+
* 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).
|
|
583
589
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
584
|
-
* @param {UpdateVerificationStatusRequest} payload
|
|
590
|
+
* @param {UpdateVerificationStatusRequest} payload The request body for the updateVerificationStatus operation.
|
|
585
591
|
* @param {*} [options] Override http request option.
|
|
586
592
|
* @throws {RequiredError}
|
|
587
593
|
*/
|
|
@@ -598,7 +604,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
598
604
|
*/
|
|
599
605
|
export class OrdersV0Api extends BaseAPI {
|
|
600
606
|
/**
|
|
601
|
-
* Returns the order
|
|
607
|
+
* 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).
|
|
602
608
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
603
609
|
* @param {*} [options] Override http request option.
|
|
604
610
|
* @throws {RequiredError}
|
|
@@ -608,7 +614,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
608
614
|
return OrdersV0ApiFp(this.configuration).getOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
609
615
|
}
|
|
610
616
|
/**
|
|
611
|
-
* Returns the shipping address for the
|
|
617
|
+
* 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).
|
|
612
618
|
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
613
619
|
* @param {*} [options] Override http request option.
|
|
614
620
|
* @throws {RequiredError}
|
|
@@ -618,7 +624,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
618
624
|
return OrdersV0ApiFp(this.configuration).getOrderAddress(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
619
625
|
}
|
|
620
626
|
/**
|
|
621
|
-
* Returns buyer information for the
|
|
627
|
+
* 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).
|
|
622
628
|
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
623
629
|
* @param {*} [options] Override http request option.
|
|
624
630
|
* @throws {RequiredError}
|
|
@@ -628,7 +634,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
628
634
|
return OrdersV0ApiFp(this.configuration).getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
629
635
|
}
|
|
630
636
|
/**
|
|
631
|
-
* Returns detailed order item information for the order
|
|
637
|
+
* 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).
|
|
632
638
|
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
633
639
|
* @param {*} [options] Override http request option.
|
|
634
640
|
* @throws {RequiredError}
|
|
@@ -638,7 +644,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
638
644
|
return OrdersV0ApiFp(this.configuration).getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
639
645
|
}
|
|
640
646
|
/**
|
|
641
|
-
* Returns buyer information for the order items in the
|
|
647
|
+
* 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).
|
|
642
648
|
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
643
649
|
* @param {*} [options] Override http request option.
|
|
644
650
|
* @throws {RequiredError}
|
|
@@ -648,7 +654,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
648
654
|
return OrdersV0ApiFp(this.configuration).getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
649
655
|
}
|
|
650
656
|
/**
|
|
651
|
-
* Returns regulated information for the order
|
|
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).
|
|
652
658
|
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
653
659
|
* @param {*} [options] Override http request option.
|
|
654
660
|
* @throws {RequiredError}
|
|
@@ -658,17 +664,17 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
658
664
|
return OrdersV0ApiFp(this.configuration).getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
659
665
|
}
|
|
660
666
|
/**
|
|
661
|
-
* 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
|
|
667
|
+
* 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).
|
|
662
668
|
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
663
669
|
* @param {*} [options] Override http request option.
|
|
664
670
|
* @throws {RequiredError}
|
|
665
671
|
* @memberof OrdersV0Api
|
|
666
672
|
*/
|
|
667
673
|
getOrders(requestParameters, options) {
|
|
668
|
-
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.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, options).then((request) => request(this.axios, this.basePath));
|
|
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));
|
|
669
675
|
}
|
|
670
676
|
/**
|
|
671
|
-
* Update the shipment status. **Usage
|
|
677
|
+
* 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).
|
|
672
678
|
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
673
679
|
* @param {*} [options] Override http request option.
|
|
674
680
|
* @throws {RequiredError}
|
|
@@ -678,7 +684,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
678
684
|
return OrdersV0ApiFp(this.configuration).updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
679
685
|
}
|
|
680
686
|
/**
|
|
681
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage
|
|
687
|
+
* 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).
|
|
682
688
|
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
683
689
|
* @param {*} [options] Override http request option.
|
|
684
690
|
* @throws {RequiredError}
|
|
@@ -0,0 +1,36 @@
|
|
|
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
|
+
/**
|
|
15
|
+
* The status of the Amazon Easy-Ship order. This property is included only for Amazon Easy-Ship orders.
|
|
16
|
+
* @export
|
|
17
|
+
* @enum {string}
|
|
18
|
+
*/
|
|
19
|
+
export const EasyShipShipmentStatus = {
|
|
20
|
+
PendingSchedule: 'PendingSchedule',
|
|
21
|
+
PendingPickUp: 'PendingPickUp',
|
|
22
|
+
PendingDropOff: 'PendingDropOff',
|
|
23
|
+
LabelCanceled: 'LabelCanceled',
|
|
24
|
+
PickedUp: 'PickedUp',
|
|
25
|
+
DroppedOff: 'DroppedOff',
|
|
26
|
+
AtOriginFc: 'AtOriginFC',
|
|
27
|
+
AtDestinationFc: 'AtDestinationFC',
|
|
28
|
+
Delivered: 'Delivered',
|
|
29
|
+
RejectedByBuyer: 'RejectedByBuyer',
|
|
30
|
+
Undeliverable: 'Undeliverable',
|
|
31
|
+
ReturningToSeller: 'ReturningToSeller',
|
|
32
|
+
ReturnedToSeller: 'ReturnedToSeller',
|
|
33
|
+
Lost: 'Lost',
|
|
34
|
+
OutForDelivery: 'OutForDelivery',
|
|
35
|
+
Damaged: 'Damaged'
|
|
36
|
+
};
|