@sp-api-sdk/orders-api-v0 3.3.1 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/cjs/src/api-model/api/orders-v0-api.js +71 -71
- package/dist/cjs/src/api-model/api.js +1 -1
- package/dist/cjs/src/api-model/base.js +1 -1
- package/dist/cjs/src/api-model/common.js +1 -1
- package/dist/cjs/src/api-model/configuration.js +1 -1
- package/dist/cjs/src/api-model/index.js +1 -1
- package/dist/cjs/src/api-model/models/address-extended-fields.js +1 -1
- package/dist/cjs/src/api-model/models/address.js +1 -1
- package/dist/cjs/src/api-model/models/amazon-programs.js +15 -0
- package/dist/cjs/src/api-model/models/associated-item.js +1 -1
- package/dist/cjs/src/api-model/models/association-type.js +1 -1
- package/dist/cjs/src/api-model/models/automated-shipping-settings.js +1 -1
- package/dist/cjs/src/api-model/models/business-hours.js +1 -1
- package/dist/cjs/src/api-model/models/buyer-customized-info-detail.js +1 -1
- package/dist/cjs/src/api-model/models/buyer-info.js +1 -1
- package/dist/cjs/src/api-model/models/buyer-requested-cancel.js +1 -1
- package/dist/cjs/src/api-model/models/buyer-tax-info.js +1 -1
- package/dist/cjs/src/api-model/models/buyer-tax-information.js +1 -1
- package/dist/cjs/src/api-model/models/confirm-shipment-error-response.js +1 -1
- package/dist/cjs/src/api-model/models/confirm-shipment-order-item.js +1 -1
- package/dist/cjs/src/api-model/models/confirm-shipment-request.js +1 -1
- package/dist/cjs/src/api-model/models/constraint-type.js +1 -1
- package/dist/cjs/src/api-model/models/delivery-preferences.js +1 -1
- package/dist/cjs/src/api-model/models/easy-ship-shipment-status.js +2 -2
- package/dist/cjs/src/api-model/models/electronic-invoice-status.js +1 -1
- package/dist/cjs/src/api-model/models/exception-dates.js +1 -1
- package/dist/cjs/src/api-model/models/fulfillment-instruction.js +1 -1
- package/dist/cjs/src/api-model/models/get-order-address-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-order-buyer-info-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-order-items-buyer-info-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-order-items-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-order-regulated-info-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-order-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-orders-response.js +1 -1
- package/dist/cjs/src/api-model/models/index.js +4 -0
- package/dist/cjs/src/api-model/models/item-buyer-info.js +1 -1
- package/dist/cjs/src/api-model/models/marketplace-tax-info.js +1 -1
- package/dist/cjs/src/api-model/models/measurement.js +1 -1
- package/dist/cjs/src/api-model/models/model-error.js +1 -1
- package/dist/cjs/src/api-model/models/money.js +1 -1
- package/dist/cjs/src/api-model/models/open-interval.js +1 -1
- package/dist/cjs/src/api-model/models/open-time-interval.js +1 -1
- package/dist/cjs/src/api-model/models/order-address.js +1 -1
- package/dist/cjs/src/api-model/models/order-buyer-info.js +1 -1
- package/dist/cjs/src/api-model/models/order-item-buyer-info.js +1 -1
- package/dist/cjs/src/api-model/models/order-item.js +1 -1
- package/dist/cjs/src/api-model/models/order-items-buyer-info-list.js +1 -1
- package/dist/cjs/src/api-model/models/order-items-inner.js +1 -1
- package/dist/cjs/src/api-model/models/order-items-list.js +1 -1
- package/dist/cjs/src/api-model/models/order-regulated-info.js +1 -1
- package/dist/cjs/src/api-model/models/order.js +1 -1
- package/dist/cjs/src/api-model/models/orders-list.js +1 -1
- package/dist/cjs/src/api-model/models/other-delivery-attributes.js +1 -1
- package/dist/cjs/src/api-model/models/package-detail.js +1 -1
- package/dist/cjs/src/api-model/models/payment-execution-detail-item.js +1 -1
- package/dist/cjs/src/api-model/models/points-granted-detail.js +1 -1
- package/dist/cjs/src/api-model/models/preferred-delivery-time.js +1 -1
- package/dist/cjs/src/api-model/models/prescription-detail.js +15 -0
- package/dist/cjs/src/api-model/models/product-info-detail.js +1 -1
- package/dist/cjs/src/api-model/models/regulated-information-field.js +1 -1
- package/dist/cjs/src/api-model/models/regulated-information.js +1 -1
- package/dist/cjs/src/api-model/models/regulated-order-verification-status.js +1 -1
- package/dist/cjs/src/api-model/models/rejection-reason.js +1 -1
- package/dist/cjs/src/api-model/models/shipment-status.js +1 -1
- package/dist/cjs/src/api-model/models/shipping-constraints.js +1 -1
- package/dist/cjs/src/api-model/models/substitution-option.js +1 -1
- package/dist/cjs/src/api-model/models/substitution-preferences.js +1 -1
- package/dist/cjs/src/api-model/models/tax-classification.js +1 -1
- package/dist/cjs/src/api-model/models/tax-collection.js +1 -1
- package/dist/cjs/src/api-model/models/update-shipment-status-error-response.js +1 -1
- package/dist/cjs/src/api-model/models/update-shipment-status-request.js +1 -1
- package/dist/cjs/src/api-model/models/update-verification-status-error-response.js +1 -1
- package/dist/cjs/src/api-model/models/update-verification-status-request-body.js +1 -1
- package/dist/cjs/src/api-model/models/update-verification-status-request.js +1 -1
- package/dist/cjs/src/api-model/models/valid-verification-detail.js +15 -0
- package/dist/cjs/src/api-model/models/verification-details.js +15 -0
- package/dist/cjs/src/api-model/models/verification-status.js +1 -1
- package/dist/es/src/api-model/api/orders-v0-api.js +71 -71
- package/dist/es/src/api-model/api.js +1 -1
- package/dist/es/src/api-model/base.js +1 -1
- package/dist/es/src/api-model/common.js +1 -1
- package/dist/es/src/api-model/configuration.js +1 -1
- package/dist/es/src/api-model/index.js +1 -1
- package/dist/es/src/api-model/models/address-extended-fields.js +1 -1
- package/dist/es/src/api-model/models/address.js +1 -1
- package/dist/es/src/api-model/models/amazon-programs.js +14 -0
- package/dist/es/src/api-model/models/associated-item.js +1 -1
- package/dist/es/src/api-model/models/association-type.js +1 -1
- package/dist/es/src/api-model/models/automated-shipping-settings.js +1 -1
- package/dist/es/src/api-model/models/business-hours.js +1 -1
- package/dist/es/src/api-model/models/buyer-customized-info-detail.js +1 -1
- package/dist/es/src/api-model/models/buyer-info.js +1 -1
- package/dist/es/src/api-model/models/buyer-requested-cancel.js +1 -1
- package/dist/es/src/api-model/models/buyer-tax-info.js +1 -1
- package/dist/es/src/api-model/models/buyer-tax-information.js +1 -1
- package/dist/es/src/api-model/models/confirm-shipment-error-response.js +1 -1
- package/dist/es/src/api-model/models/confirm-shipment-order-item.js +1 -1
- package/dist/es/src/api-model/models/confirm-shipment-request.js +1 -1
- package/dist/es/src/api-model/models/constraint-type.js +1 -1
- package/dist/es/src/api-model/models/delivery-preferences.js +1 -1
- package/dist/es/src/api-model/models/easy-ship-shipment-status.js +2 -2
- package/dist/es/src/api-model/models/electronic-invoice-status.js +1 -1
- package/dist/es/src/api-model/models/exception-dates.js +1 -1
- package/dist/es/src/api-model/models/fulfillment-instruction.js +1 -1
- package/dist/es/src/api-model/models/get-order-address-response.js +1 -1
- package/dist/es/src/api-model/models/get-order-buyer-info-response.js +1 -1
- package/dist/es/src/api-model/models/get-order-items-buyer-info-response.js +1 -1
- package/dist/es/src/api-model/models/get-order-items-response.js +1 -1
- package/dist/es/src/api-model/models/get-order-regulated-info-response.js +1 -1
- package/dist/es/src/api-model/models/get-order-response.js +1 -1
- package/dist/es/src/api-model/models/get-orders-response.js +1 -1
- package/dist/es/src/api-model/models/index.js +4 -0
- package/dist/es/src/api-model/models/item-buyer-info.js +1 -1
- package/dist/es/src/api-model/models/marketplace-tax-info.js +1 -1
- package/dist/es/src/api-model/models/measurement.js +1 -1
- package/dist/es/src/api-model/models/model-error.js +1 -1
- package/dist/es/src/api-model/models/money.js +1 -1
- package/dist/es/src/api-model/models/open-interval.js +1 -1
- package/dist/es/src/api-model/models/open-time-interval.js +1 -1
- package/dist/es/src/api-model/models/order-address.js +1 -1
- package/dist/es/src/api-model/models/order-buyer-info.js +1 -1
- package/dist/es/src/api-model/models/order-item-buyer-info.js +1 -1
- package/dist/es/src/api-model/models/order-item.js +1 -1
- package/dist/es/src/api-model/models/order-items-buyer-info-list.js +1 -1
- package/dist/es/src/api-model/models/order-items-inner.js +1 -1
- package/dist/es/src/api-model/models/order-items-list.js +1 -1
- package/dist/es/src/api-model/models/order-regulated-info.js +1 -1
- package/dist/es/src/api-model/models/order.js +1 -1
- package/dist/es/src/api-model/models/orders-list.js +1 -1
- package/dist/es/src/api-model/models/other-delivery-attributes.js +1 -1
- package/dist/es/src/api-model/models/package-detail.js +1 -1
- package/dist/es/src/api-model/models/payment-execution-detail-item.js +1 -1
- package/dist/es/src/api-model/models/points-granted-detail.js +1 -1
- package/dist/es/src/api-model/models/preferred-delivery-time.js +1 -1
- package/dist/es/src/api-model/models/prescription-detail.js +14 -0
- package/dist/es/src/api-model/models/product-info-detail.js +1 -1
- package/dist/es/src/api-model/models/regulated-information-field.js +1 -1
- package/dist/es/src/api-model/models/regulated-information.js +1 -1
- package/dist/es/src/api-model/models/regulated-order-verification-status.js +1 -1
- package/dist/es/src/api-model/models/rejection-reason.js +1 -1
- package/dist/es/src/api-model/models/shipment-status.js +1 -1
- package/dist/es/src/api-model/models/shipping-constraints.js +1 -1
- package/dist/es/src/api-model/models/substitution-option.js +1 -1
- package/dist/es/src/api-model/models/substitution-preferences.js +1 -1
- package/dist/es/src/api-model/models/tax-classification.js +1 -1
- package/dist/es/src/api-model/models/tax-collection.js +1 -1
- package/dist/es/src/api-model/models/update-shipment-status-error-response.js +1 -1
- package/dist/es/src/api-model/models/update-shipment-status-request.js +1 -1
- package/dist/es/src/api-model/models/update-verification-status-error-response.js +1 -1
- package/dist/es/src/api-model/models/update-verification-status-request-body.js +1 -1
- package/dist/es/src/api-model/models/update-verification-status-request.js +1 -1
- package/dist/es/src/api-model/models/valid-verification-detail.js +14 -0
- package/dist/es/src/api-model/models/verification-details.js +14 -0
- package/dist/es/src/api-model/models/verification-status.js +1 -1
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +86 -86
- package/dist/types/src/api-model/api.d.ts +1 -1
- package/dist/types/src/api-model/base.d.ts +1 -1
- package/dist/types/src/api-model/common.d.ts +1 -1
- package/dist/types/src/api-model/configuration.d.ts +1 -1
- package/dist/types/src/api-model/index.d.ts +1 -1
- package/dist/types/src/api-model/models/address-extended-fields.d.ts +4 -4
- package/dist/types/src/api-model/models/address.d.ts +2 -2
- package/dist/types/src/api-model/models/amazon-programs.d.ts +24 -0
- package/dist/types/src/api-model/models/associated-item.d.ts +2 -2
- package/dist/types/src/api-model/models/association-type.d.ts +1 -1
- package/dist/types/src/api-model/models/automated-shipping-settings.d.ts +1 -1
- package/dist/types/src/api-model/models/business-hours.d.ts +1 -1
- package/dist/types/src/api-model/models/buyer-customized-info-detail.d.ts +2 -2
- package/dist/types/src/api-model/models/buyer-info.d.ts +2 -2
- package/dist/types/src/api-model/models/buyer-requested-cancel.d.ts +1 -1
- package/dist/types/src/api-model/models/buyer-tax-info.d.ts +1 -1
- package/dist/types/src/api-model/models/buyer-tax-information.d.ts +1 -1
- package/dist/types/src/api-model/models/confirm-shipment-error-response.d.ts +1 -1
- package/dist/types/src/api-model/models/confirm-shipment-order-item.d.ts +3 -3
- package/dist/types/src/api-model/models/confirm-shipment-request.d.ts +2 -2
- package/dist/types/src/api-model/models/constraint-type.d.ts +1 -1
- package/dist/types/src/api-model/models/delivery-preferences.d.ts +1 -1
- package/dist/types/src/api-model/models/easy-ship-shipment-status.d.ts +2 -2
- package/dist/types/src/api-model/models/electronic-invoice-status.d.ts +1 -1
- package/dist/types/src/api-model/models/exception-dates.d.ts +1 -1
- package/dist/types/src/api-model/models/fulfillment-instruction.d.ts +3 -3
- package/dist/types/src/api-model/models/get-order-address-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-order-buyer-info-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-order-items-buyer-info-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-order-items-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-order-regulated-info-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-order-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-orders-response.d.ts +1 -1
- package/dist/types/src/api-model/models/index.d.ts +4 -0
- package/dist/types/src/api-model/models/item-buyer-info.d.ts +2 -2
- package/dist/types/src/api-model/models/marketplace-tax-info.d.ts +1 -1
- package/dist/types/src/api-model/models/measurement.d.ts +3 -3
- package/dist/types/src/api-model/models/model-error.d.ts +1 -1
- package/dist/types/src/api-model/models/money.d.ts +1 -1
- package/dist/types/src/api-model/models/open-interval.d.ts +1 -1
- package/dist/types/src/api-model/models/open-time-interval.d.ts +1 -1
- package/dist/types/src/api-model/models/order-address.d.ts +2 -2
- package/dist/types/src/api-model/models/order-buyer-info.d.ts +2 -2
- package/dist/types/src/api-model/models/order-item-buyer-info.d.ts +2 -2
- package/dist/types/src/api-model/models/order-item.d.ts +21 -14
- package/dist/types/src/api-model/models/order-items-buyer-info-list.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-items-list.d.ts +1 -1
- package/dist/types/src/api-model/models/order-regulated-info.d.ts +1 -1
- package/dist/types/src/api-model/models/order.d.ts +18 -18
- package/dist/types/src/api-model/models/orders-list.d.ts +3 -3
- package/dist/types/src/api-model/models/other-delivery-attributes.d.ts +1 -1
- package/dist/types/src/api-model/models/package-detail.d.ts +4 -4
- package/dist/types/src/api-model/models/payment-execution-detail-item.d.ts +2 -2
- package/dist/types/src/api-model/models/points-granted-detail.d.ts +1 -1
- package/dist/types/src/api-model/models/preferred-delivery-time.d.ts +2 -2
- package/dist/types/src/api-model/models/prescription-detail.d.ts +60 -0
- package/dist/types/src/api-model/models/product-info-detail.d.ts +1 -1
- package/dist/types/src/api-model/models/regulated-information-field.d.ts +4 -4
- package/dist/types/src/api-model/models/regulated-information.d.ts +1 -1
- package/dist/types/src/api-model/models/regulated-order-verification-status.d.ts +10 -3
- package/dist/types/src/api-model/models/rejection-reason.d.ts +2 -2
- package/dist/types/src/api-model/models/shipment-status.d.ts +1 -1
- package/dist/types/src/api-model/models/shipping-constraints.d.ts +19 -1
- package/dist/types/src/api-model/models/substitution-option.d.ts +4 -4
- package/dist/types/src/api-model/models/substitution-preferences.d.ts +1 -1
- package/dist/types/src/api-model/models/tax-classification.d.ts +2 -2
- package/dist/types/src/api-model/models/tax-collection.d.ts +1 -1
- package/dist/types/src/api-model/models/update-shipment-status-error-response.d.ts +1 -1
- package/dist/types/src/api-model/models/update-shipment-status-request.d.ts +1 -1
- package/dist/types/src/api-model/models/update-verification-status-error-response.d.ts +1 -1
- package/dist/types/src/api-model/models/update-verification-status-request-body.d.ts +11 -4
- package/dist/types/src/api-model/models/update-verification-status-request.d.ts +1 -1
- package/dist/types/src/api-model/models/valid-verification-detail.d.ts +31 -0
- package/dist/types/src/api-model/models/verification-details.d.ts +25 -0
- package/dist/types/src/api-model/models/verification-status.d.ts +1 -1
- package/package.json +5 -5
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Selling Partner API for Orders
|
|
5
|
-
*
|
|
5
|
+
* Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools. _Note:_ For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don\'t show up in the response).
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v0
|
|
8
8
|
*
|
|
@@ -24,9 +24,9 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../b
|
|
|
24
24
|
export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
27
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](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
|
-
* @param {ConfirmShipmentRequest} payload
|
|
29
|
+
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
30
30
|
* @param {*} [options] Override http request option.
|
|
31
31
|
* @throws {RequiredError}
|
|
32
32
|
*/
|
|
@@ -57,7 +57,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
57
57
|
};
|
|
58
58
|
},
|
|
59
59
|
/**
|
|
60
|
-
* Returns 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
|
|
60
|
+
* Returns 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
61
61
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
62
62
|
* @param {*} [options] Override http request option.
|
|
63
63
|
* @throws {RequiredError}
|
|
@@ -85,7 +85,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
85
85
|
};
|
|
86
86
|
},
|
|
87
87
|
/**
|
|
88
|
-
* Returns the shipping address 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
|
|
88
|
+
* Returns the shipping address 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
89
89
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
90
90
|
* @param {*} [options] Override http request option.
|
|
91
91
|
* @throws {RequiredError}
|
|
@@ -113,7 +113,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
113
113
|
};
|
|
114
114
|
},
|
|
115
115
|
/**
|
|
116
|
-
* Returns buyer 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
|
|
116
|
+
* Returns buyer 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
117
117
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
118
118
|
* @param {*} [options] Override http request option.
|
|
119
119
|
* @throws {RequiredError}
|
|
@@ -141,7 +141,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
141
141
|
};
|
|
142
142
|
},
|
|
143
143
|
/**
|
|
144
|
-
* 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.
|
|
144
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
145
145
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
146
146
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
147
147
|
* @param {*} [options] Override http request option.
|
|
@@ -173,7 +173,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
173
173
|
};
|
|
174
174
|
},
|
|
175
175
|
/**
|
|
176
|
-
* 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
|
|
176
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
177
177
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
178
178
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
179
179
|
* @param {*} [options] Override http request option.
|
|
@@ -205,7 +205,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
205
205
|
};
|
|
206
206
|
},
|
|
207
207
|
/**
|
|
208
|
-
* 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
|
|
208
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
209
209
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
210
210
|
* @param {*} [options] Override http request option.
|
|
211
211
|
* @throws {RequiredError}
|
|
@@ -233,29 +233,29 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
233
233
|
};
|
|
234
234
|
},
|
|
235
235
|
/**
|
|
236
|
-
* Returns orders created or updated during the time
|
|
237
|
-
* @param {Array<string>} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `
|
|
238
|
-
* @param {string} [createdAfter]
|
|
239
|
-
* @param {string} [createdBefore]
|
|
240
|
-
* @param {string} [lastUpdatedAfter]
|
|
241
|
-
* @param {string} [lastUpdatedBefore]
|
|
236
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.
|
|
237
|
+
* @param {Array<string>} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
|
|
238
|
+
* @param {string} [createdAfter] Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.
|
|
239
|
+
* @param {string} [createdBefore] Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time.
|
|
240
|
+
* @param {string} [lastUpdatedAfter] Use this date to select orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or `CreatedBefore` cannot be set when `LastUpdatedAfter` is set.
|
|
241
|
+
* @param {string} [lastUpdatedBefore] Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the `LastUpdatedAfter` date and at least two minutes before current time.
|
|
242
242
|
* @param {Array<string>} [orderStatuses] A list of `OrderStatus` values used to filter the results. **Possible values:** - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.) - `Pending` (The order has been placed but payment has not been authorized.) - `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.) - `PartiallyShipped` (One or more, but not all, items in the order have been shipped.) - `Shipped` (All items in the order have been shipped.) - `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.) - `Canceled` (The order has been canceled.) - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)
|
|
243
|
-
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (
|
|
244
|
-
* @param {Array<string>} [paymentMethods] A list of payment method values.
|
|
243
|
+
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller).
|
|
244
|
+
* @param {Array<string>} [paymentMethods] A list of payment method values. Use this field to select orders that were paid with the specified payment methods. **Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS).
|
|
245
245
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
246
|
-
* @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
|
|
246
|
+
* @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.
|
|
247
247
|
* @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.
|
|
248
248
|
* @param {Array<string>} [easyShipShipmentStatuses] A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.)
|
|
249
249
|
* @param {Array<string>} [electronicInvoiceStatuses] A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.)
|
|
250
250
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
251
|
-
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
252
|
-
* @param {string} [actualFulfillmentSupplySourceId]
|
|
251
|
+
* @param {Array<string>} [amazonOrderIds] A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
252
|
+
* @param {string} [actualFulfillmentSupplySourceId] The `sourceId` of the location from where you want the order fulfilled.
|
|
253
253
|
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
254
254
|
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
255
|
-
* @param {string} [earliestDeliveryDateBefore]
|
|
256
|
-
* @param {string} [earliestDeliveryDateAfter]
|
|
257
|
-
* @param {string} [latestDeliveryDateBefore]
|
|
258
|
-
* @param {string} [latestDeliveryDateAfter]
|
|
255
|
+
* @param {string} [earliestDeliveryDateBefore] Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
256
|
+
* @param {string} [earliestDeliveryDateAfter] Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
257
|
+
* @param {string} [latestDeliveryDateBefore] Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
258
|
+
* @param {string} [latestDeliveryDateAfter] Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
259
259
|
* @param {*} [options] Override http request option.
|
|
260
260
|
* @throws {RequiredError}
|
|
261
261
|
*/
|
|
@@ -347,7 +347,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
347
347
|
};
|
|
348
348
|
},
|
|
349
349
|
/**
|
|
350
|
-
* 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
|
|
350
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
351
351
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
352
352
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
353
353
|
* @param {*} [options] Override http request option.
|
|
@@ -380,7 +380,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
380
380
|
};
|
|
381
381
|
},
|
|
382
382
|
/**
|
|
383
|
-
* 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
|
|
383
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
384
384
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
385
385
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
386
386
|
* @param {*} [options] Override http request option.
|
|
@@ -422,9 +422,9 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
422
422
|
const localVarAxiosParamCreator = OrdersV0ApiAxiosParamCreator(configuration);
|
|
423
423
|
return {
|
|
424
424
|
/**
|
|
425
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
425
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
426
426
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
427
|
-
* @param {ConfirmShipmentRequest} payload
|
|
427
|
+
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
428
428
|
* @param {*} [options] Override http request option.
|
|
429
429
|
* @throws {RequiredError}
|
|
430
430
|
*/
|
|
@@ -435,7 +435,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
435
435
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
436
436
|
},
|
|
437
437
|
/**
|
|
438
|
-
* Returns 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
|
|
438
|
+
* Returns 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
439
439
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
440
440
|
* @param {*} [options] Override http request option.
|
|
441
441
|
* @throws {RequiredError}
|
|
@@ -447,7 +447,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
447
447
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
448
448
|
},
|
|
449
449
|
/**
|
|
450
|
-
* Returns the shipping address 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
|
|
450
|
+
* Returns the shipping address 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
451
451
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
452
452
|
* @param {*} [options] Override http request option.
|
|
453
453
|
* @throws {RequiredError}
|
|
@@ -459,7 +459,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
459
459
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
460
460
|
},
|
|
461
461
|
/**
|
|
462
|
-
* Returns buyer 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
|
|
462
|
+
* Returns buyer 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
463
463
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
464
464
|
* @param {*} [options] Override http request option.
|
|
465
465
|
* @throws {RequiredError}
|
|
@@ -471,7 +471,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
471
471
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
472
472
|
},
|
|
473
473
|
/**
|
|
474
|
-
* 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.
|
|
474
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
475
475
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
476
476
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
477
477
|
* @param {*} [options] Override http request option.
|
|
@@ -484,7 +484,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
484
484
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
485
485
|
},
|
|
486
486
|
/**
|
|
487
|
-
* 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
|
|
487
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
488
488
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
489
489
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
490
490
|
* @param {*} [options] Override http request option.
|
|
@@ -497,7 +497,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
497
497
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
498
498
|
},
|
|
499
499
|
/**
|
|
500
|
-
* 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
|
|
500
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
501
501
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
502
502
|
* @param {*} [options] Override http request option.
|
|
503
503
|
* @throws {RequiredError}
|
|
@@ -509,29 +509,29 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
509
509
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
510
510
|
},
|
|
511
511
|
/**
|
|
512
|
-
* Returns orders created or updated during the time
|
|
513
|
-
* @param {Array<string>} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `
|
|
514
|
-
* @param {string} [createdAfter]
|
|
515
|
-
* @param {string} [createdBefore]
|
|
516
|
-
* @param {string} [lastUpdatedAfter]
|
|
517
|
-
* @param {string} [lastUpdatedBefore]
|
|
512
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.
|
|
513
|
+
* @param {Array<string>} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
|
|
514
|
+
* @param {string} [createdAfter] Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.
|
|
515
|
+
* @param {string} [createdBefore] Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time.
|
|
516
|
+
* @param {string} [lastUpdatedAfter] Use this date to select orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or `CreatedBefore` cannot be set when `LastUpdatedAfter` is set.
|
|
517
|
+
* @param {string} [lastUpdatedBefore] Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the `LastUpdatedAfter` date and at least two minutes before current time.
|
|
518
518
|
* @param {Array<string>} [orderStatuses] A list of `OrderStatus` values used to filter the results. **Possible values:** - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.) - `Pending` (The order has been placed but payment has not been authorized.) - `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.) - `PartiallyShipped` (One or more, but not all, items in the order have been shipped.) - `Shipped` (All items in the order have been shipped.) - `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.) - `Canceled` (The order has been canceled.) - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)
|
|
519
|
-
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (
|
|
520
|
-
* @param {Array<string>} [paymentMethods] A list of payment method values.
|
|
519
|
+
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller).
|
|
520
|
+
* @param {Array<string>} [paymentMethods] A list of payment method values. Use this field to select orders that were paid with the specified payment methods. **Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS).
|
|
521
521
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
522
|
-
* @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
|
|
522
|
+
* @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.
|
|
523
523
|
* @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.
|
|
524
524
|
* @param {Array<string>} [easyShipShipmentStatuses] A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.)
|
|
525
525
|
* @param {Array<string>} [electronicInvoiceStatuses] A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.)
|
|
526
526
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
527
|
-
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
528
|
-
* @param {string} [actualFulfillmentSupplySourceId]
|
|
527
|
+
* @param {Array<string>} [amazonOrderIds] A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
528
|
+
* @param {string} [actualFulfillmentSupplySourceId] The `sourceId` of the location from where you want the order fulfilled.
|
|
529
529
|
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
530
530
|
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
531
|
-
* @param {string} [earliestDeliveryDateBefore]
|
|
532
|
-
* @param {string} [earliestDeliveryDateAfter]
|
|
533
|
-
* @param {string} [latestDeliveryDateBefore]
|
|
534
|
-
* @param {string} [latestDeliveryDateAfter]
|
|
531
|
+
* @param {string} [earliestDeliveryDateBefore] Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
532
|
+
* @param {string} [earliestDeliveryDateAfter] Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
533
|
+
* @param {string} [latestDeliveryDateBefore] Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
534
|
+
* @param {string} [latestDeliveryDateAfter] Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
535
535
|
* @param {*} [options] Override http request option.
|
|
536
536
|
* @throws {RequiredError}
|
|
537
537
|
*/
|
|
@@ -542,7 +542,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
542
542
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
543
543
|
},
|
|
544
544
|
/**
|
|
545
|
-
* 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
|
|
545
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
546
546
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
547
547
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
548
548
|
* @param {*} [options] Override http request option.
|
|
@@ -555,7 +555,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
555
555
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
556
556
|
},
|
|
557
557
|
/**
|
|
558
|
-
* 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
|
|
558
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
559
559
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
560
560
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
561
561
|
* @param {*} [options] Override http request option.
|
|
@@ -577,7 +577,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
577
577
|
const localVarFp = OrdersV0ApiFp(configuration);
|
|
578
578
|
return {
|
|
579
579
|
/**
|
|
580
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
580
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
581
581
|
* @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
582
582
|
* @param {*} [options] Override http request option.
|
|
583
583
|
* @throws {RequiredError}
|
|
@@ -586,7 +586,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
586
586
|
return localVarFp.confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
|
|
587
587
|
},
|
|
588
588
|
/**
|
|
589
|
-
* Returns 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
|
|
589
|
+
* Returns 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
590
590
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
591
591
|
* @param {*} [options] Override http request option.
|
|
592
592
|
* @throws {RequiredError}
|
|
@@ -595,7 +595,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
595
595
|
return localVarFp.getOrder(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
596
596
|
},
|
|
597
597
|
/**
|
|
598
|
-
* Returns the shipping address 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
|
|
598
|
+
* Returns the shipping address 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
599
599
|
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
600
600
|
* @param {*} [options] Override http request option.
|
|
601
601
|
* @throws {RequiredError}
|
|
@@ -604,7 +604,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
604
604
|
return localVarFp.getOrderAddress(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
605
605
|
},
|
|
606
606
|
/**
|
|
607
|
-
* Returns buyer 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
|
|
607
|
+
* Returns buyer 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
608
608
|
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
609
609
|
* @param {*} [options] Override http request option.
|
|
610
610
|
* @throws {RequiredError}
|
|
@@ -613,7 +613,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
613
613
|
return localVarFp.getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
614
614
|
},
|
|
615
615
|
/**
|
|
616
|
-
* 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.
|
|
616
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
617
617
|
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
618
618
|
* @param {*} [options] Override http request option.
|
|
619
619
|
* @throws {RequiredError}
|
|
@@ -622,7 +622,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
622
622
|
return localVarFp.getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
623
623
|
},
|
|
624
624
|
/**
|
|
625
|
-
* 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
|
|
625
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
626
626
|
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
627
627
|
* @param {*} [options] Override http request option.
|
|
628
628
|
* @throws {RequiredError}
|
|
@@ -631,7 +631,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
631
631
|
return localVarFp.getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
632
632
|
},
|
|
633
633
|
/**
|
|
634
|
-
* 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
|
|
634
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
635
635
|
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
636
636
|
* @param {*} [options] Override http request option.
|
|
637
637
|
* @throws {RequiredError}
|
|
@@ -640,7 +640,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
640
640
|
return localVarFp.getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
641
641
|
},
|
|
642
642
|
/**
|
|
643
|
-
* Returns orders created or updated during the time
|
|
643
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.
|
|
644
644
|
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
645
645
|
* @param {*} [options] Override http request option.
|
|
646
646
|
* @throws {RequiredError}
|
|
@@ -649,7 +649,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
649
649
|
return localVarFp.getOrders(requestParameters.marketplaceIds, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.orderStatuses, requestParameters.fulfillmentChannels, requestParameters.paymentMethods, requestParameters.buyerEmail, requestParameters.sellerOrderId, requestParameters.maxResultsPerPage, requestParameters.easyShipShipmentStatuses, requestParameters.electronicInvoiceStatuses, requestParameters.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, requestParameters.earliestDeliveryDateBefore, requestParameters.earliestDeliveryDateAfter, requestParameters.latestDeliveryDateBefore, requestParameters.latestDeliveryDateAfter, options).then((request) => request(axios, basePath));
|
|
650
650
|
},
|
|
651
651
|
/**
|
|
652
|
-
* 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
|
|
652
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
653
653
|
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
654
654
|
* @param {*} [options] Override http request option.
|
|
655
655
|
* @throws {RequiredError}
|
|
@@ -658,7 +658,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
658
658
|
return localVarFp.updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
|
|
659
659
|
},
|
|
660
660
|
/**
|
|
661
|
-
* 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
|
|
661
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
662
662
|
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
663
663
|
* @param {*} [options] Override http request option.
|
|
664
664
|
* @throws {RequiredError}
|
|
@@ -676,7 +676,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
676
676
|
*/
|
|
677
677
|
export class OrdersV0Api extends BaseAPI {
|
|
678
678
|
/**
|
|
679
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
679
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
680
680
|
* @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
681
681
|
* @param {*} [options] Override http request option.
|
|
682
682
|
* @throws {RequiredError}
|
|
@@ -686,7 +686,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
686
686
|
return OrdersV0ApiFp(this.configuration).confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
687
687
|
}
|
|
688
688
|
/**
|
|
689
|
-
* Returns 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
|
|
689
|
+
* Returns 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
690
690
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
691
691
|
* @param {*} [options] Override http request option.
|
|
692
692
|
* @throws {RequiredError}
|
|
@@ -696,7 +696,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
696
696
|
return OrdersV0ApiFp(this.configuration).getOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
697
697
|
}
|
|
698
698
|
/**
|
|
699
|
-
* Returns the shipping address 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
|
|
699
|
+
* Returns the shipping address 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
700
700
|
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
701
701
|
* @param {*} [options] Override http request option.
|
|
702
702
|
* @throws {RequiredError}
|
|
@@ -706,7 +706,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
706
706
|
return OrdersV0ApiFp(this.configuration).getOrderAddress(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
707
707
|
}
|
|
708
708
|
/**
|
|
709
|
-
* Returns buyer 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
|
|
709
|
+
* Returns buyer 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
710
710
|
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
711
711
|
* @param {*} [options] Override http request option.
|
|
712
712
|
* @throws {RequiredError}
|
|
@@ -716,7 +716,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
716
716
|
return OrdersV0ApiFp(this.configuration).getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
717
717
|
}
|
|
718
718
|
/**
|
|
719
|
-
* 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.
|
|
719
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
720
720
|
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
721
721
|
* @param {*} [options] Override http request option.
|
|
722
722
|
* @throws {RequiredError}
|
|
@@ -726,7 +726,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
726
726
|
return OrdersV0ApiFp(this.configuration).getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
727
727
|
}
|
|
728
728
|
/**
|
|
729
|
-
* 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
|
|
729
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
730
730
|
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
731
731
|
* @param {*} [options] Override http request option.
|
|
732
732
|
* @throws {RequiredError}
|
|
@@ -736,7 +736,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
736
736
|
return OrdersV0ApiFp(this.configuration).getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
737
737
|
}
|
|
738
738
|
/**
|
|
739
|
-
* 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
|
|
739
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
740
740
|
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
741
741
|
* @param {*} [options] Override http request option.
|
|
742
742
|
* @throws {RequiredError}
|
|
@@ -746,7 +746,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
746
746
|
return OrdersV0ApiFp(this.configuration).getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
747
747
|
}
|
|
748
748
|
/**
|
|
749
|
-
* Returns orders created or updated during the time
|
|
749
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation.
|
|
750
750
|
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
751
751
|
* @param {*} [options] Override http request option.
|
|
752
752
|
* @throws {RequiredError}
|
|
@@ -756,7 +756,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
756
756
|
return OrdersV0ApiFp(this.configuration).getOrders(requestParameters.marketplaceIds, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.orderStatuses, requestParameters.fulfillmentChannels, requestParameters.paymentMethods, requestParameters.buyerEmail, requestParameters.sellerOrderId, requestParameters.maxResultsPerPage, requestParameters.easyShipShipmentStatuses, requestParameters.electronicInvoiceStatuses, requestParameters.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, requestParameters.earliestDeliveryDateBefore, requestParameters.earliestDeliveryDateAfter, requestParameters.latestDeliveryDateBefore, requestParameters.latestDeliveryDateAfter, options).then((request) => request(this.axios, this.basePath));
|
|
757
757
|
}
|
|
758
758
|
/**
|
|
759
|
-
* 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
|
|
759
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
760
760
|
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
761
761
|
* @param {*} [options] Override http request option.
|
|
762
762
|
* @throws {RequiredError}
|
|
@@ -766,7 +766,7 @@ export class OrdersV0Api extends BaseAPI {
|
|
|
766
766
|
return OrdersV0ApiFp(this.configuration).updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
767
767
|
}
|
|
768
768
|
/**
|
|
769
|
-
* 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
|
|
769
|
+
* 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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
770
770
|
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
771
771
|
* @param {*} [options] Override http request option.
|
|
772
772
|
* @throws {RequiredError}
|