@sp-api-sdk/orders-api-v0 3.6.2 → 3.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api-model/api/{orders-v0-api.js → orders-api.js} +107 -67
- package/dist/cjs/api-model/api.js +2 -2
- package/dist/cjs/api-model/base.js +1 -1
- package/dist/cjs/api-model/common.js +1 -1
- package/dist/cjs/api-model/configuration.js +1 -1
- package/dist/cjs/api-model/index.js +1 -1
- package/dist/cjs/api-model/models/address-extended-fields.js +1 -1
- package/dist/cjs/api-model/models/address.js +1 -1
- package/dist/cjs/api-model/models/amazon-programs.js +1 -1
- package/dist/cjs/api-model/models/associated-item.js +1 -1
- package/dist/cjs/api-model/models/association-type.js +1 -1
- package/dist/cjs/api-model/models/automated-shipping-settings.js +1 -1
- package/dist/cjs/api-model/models/business-hours.js +1 -1
- package/dist/cjs/api-model/models/buyer-customized-info-detail.js +1 -1
- package/dist/cjs/api-model/models/buyer-info.js +1 -1
- package/dist/cjs/api-model/models/buyer-requested-cancel.js +1 -1
- package/dist/cjs/api-model/models/buyer-tax-info.js +1 -1
- package/dist/cjs/api-model/models/buyer-tax-information.js +1 -1
- package/dist/cjs/api-model/models/confirm-shipment-error-response.js +1 -1
- package/dist/cjs/api-model/models/confirm-shipment-order-item.js +1 -1
- package/dist/cjs/api-model/models/confirm-shipment-request.js +1 -1
- package/dist/cjs/api-model/models/constraint-type.js +1 -1
- package/dist/cjs/api-model/models/delivery-preferences.js +1 -1
- package/dist/cjs/api-model/models/easy-ship-shipment-status.js +1 -1
- package/dist/cjs/api-model/models/electronic-invoice-status.js +1 -1
- package/dist/cjs/api-model/models/exception-dates.js +1 -1
- package/dist/cjs/api-model/models/fulfillment-instruction.js +1 -1
- package/dist/cjs/api-model/models/get-order-address-response.js +1 -1
- package/dist/cjs/api-model/models/get-order-buyer-info-response.js +1 -1
- package/dist/cjs/api-model/models/get-order-items-buyer-info-response.js +1 -1
- package/dist/cjs/api-model/models/get-order-items-response.js +1 -1
- package/dist/cjs/api-model/models/get-order-regulated-info-response.js +1 -1
- package/dist/cjs/api-model/models/get-order-response.js +1 -1
- package/dist/cjs/api-model/models/get-orders-response.js +1 -1
- package/dist/cjs/api-model/models/item-buyer-info.js +1 -1
- package/dist/cjs/api-model/models/marketplace-tax-info.js +1 -1
- package/dist/cjs/api-model/models/measurement.js +1 -1
- package/dist/cjs/api-model/models/model-error.js +1 -1
- package/dist/cjs/api-model/models/money.js +1 -1
- package/dist/cjs/api-model/models/open-interval.js +1 -1
- package/dist/cjs/api-model/models/open-time-interval.js +1 -1
- package/dist/cjs/api-model/models/order-address.js +1 -1
- package/dist/cjs/api-model/models/order-buyer-info.js +1 -1
- package/dist/cjs/api-model/models/order-item-buyer-info.js +1 -1
- package/dist/cjs/api-model/models/order-item.js +1 -1
- package/dist/cjs/api-model/models/order-items-buyer-info-list.js +1 -1
- package/dist/cjs/api-model/models/order-items-inner.js +1 -1
- package/dist/cjs/api-model/models/order-items-list.js +1 -1
- package/dist/cjs/api-model/models/order-regulated-info.js +1 -1
- package/dist/cjs/api-model/models/order.js +1 -1
- package/dist/cjs/api-model/models/orders-list.js +1 -1
- package/dist/cjs/api-model/models/other-delivery-attributes.js +1 -1
- package/dist/cjs/api-model/models/package-detail.js +1 -1
- package/dist/cjs/api-model/models/payment-execution-detail-item.js +1 -1
- package/dist/cjs/api-model/models/points-granted-detail.js +1 -1
- package/dist/cjs/api-model/models/preferred-delivery-time.js +1 -1
- package/dist/cjs/api-model/models/prescription-detail.js +1 -1
- package/dist/cjs/api-model/models/product-info-detail.js +1 -1
- package/dist/cjs/api-model/models/regulated-information-field.js +1 -1
- package/dist/cjs/api-model/models/regulated-information.js +1 -1
- package/dist/cjs/api-model/models/regulated-order-verification-status.js +1 -1
- package/dist/cjs/api-model/models/rejection-reason.js +1 -1
- package/dist/cjs/api-model/models/shipment-status.js +1 -1
- package/dist/cjs/api-model/models/shipping-constraints.js +1 -1
- package/dist/cjs/api-model/models/substitution-option.js +1 -1
- package/dist/cjs/api-model/models/substitution-preferences.js +1 -1
- package/dist/cjs/api-model/models/tax-classification.js +1 -1
- package/dist/cjs/api-model/models/tax-collection.js +1 -1
- package/dist/cjs/api-model/models/update-shipment-status-error-response.js +1 -1
- package/dist/cjs/api-model/models/update-shipment-status-request.js +1 -1
- package/dist/cjs/api-model/models/update-verification-status-error-response.js +1 -1
- package/dist/cjs/api-model/models/update-verification-status-request-body.js +1 -1
- package/dist/cjs/api-model/models/update-verification-status-request.js +1 -1
- package/dist/cjs/api-model/models/valid-verification-detail.js +1 -1
- package/dist/cjs/api-model/models/verification-details.js +1 -1
- package/dist/cjs/api-model/models/verification-status.js +1 -1
- package/dist/cjs/client.js +1 -1
- package/dist/es/api-model/api/{orders-v0-api.js → orders-api.js} +102 -62
- package/dist/es/api-model/api.js +2 -2
- package/dist/es/api-model/base.js +1 -1
- package/dist/es/api-model/common.js +1 -1
- package/dist/es/api-model/configuration.js +1 -1
- package/dist/es/api-model/index.js +1 -1
- package/dist/es/api-model/models/address-extended-fields.js +1 -1
- package/dist/es/api-model/models/address.js +1 -1
- package/dist/es/api-model/models/amazon-programs.js +1 -1
- package/dist/es/api-model/models/associated-item.js +1 -1
- package/dist/es/api-model/models/association-type.js +1 -1
- package/dist/es/api-model/models/automated-shipping-settings.js +1 -1
- package/dist/es/api-model/models/business-hours.js +1 -1
- package/dist/es/api-model/models/buyer-customized-info-detail.js +1 -1
- package/dist/es/api-model/models/buyer-info.js +1 -1
- package/dist/es/api-model/models/buyer-requested-cancel.js +1 -1
- package/dist/es/api-model/models/buyer-tax-info.js +1 -1
- package/dist/es/api-model/models/buyer-tax-information.js +1 -1
- package/dist/es/api-model/models/confirm-shipment-error-response.js +1 -1
- package/dist/es/api-model/models/confirm-shipment-order-item.js +1 -1
- package/dist/es/api-model/models/confirm-shipment-request.js +1 -1
- package/dist/es/api-model/models/constraint-type.js +1 -1
- package/dist/es/api-model/models/delivery-preferences.js +1 -1
- package/dist/es/api-model/models/easy-ship-shipment-status.js +1 -1
- package/dist/es/api-model/models/electronic-invoice-status.js +1 -1
- package/dist/es/api-model/models/exception-dates.js +1 -1
- package/dist/es/api-model/models/fulfillment-instruction.js +1 -1
- package/dist/es/api-model/models/get-order-address-response.js +1 -1
- package/dist/es/api-model/models/get-order-buyer-info-response.js +1 -1
- package/dist/es/api-model/models/get-order-items-buyer-info-response.js +1 -1
- package/dist/es/api-model/models/get-order-items-response.js +1 -1
- package/dist/es/api-model/models/get-order-regulated-info-response.js +1 -1
- package/dist/es/api-model/models/get-order-response.js +1 -1
- package/dist/es/api-model/models/get-orders-response.js +1 -1
- package/dist/es/api-model/models/item-buyer-info.js +1 -1
- package/dist/es/api-model/models/marketplace-tax-info.js +1 -1
- package/dist/es/api-model/models/measurement.js +1 -1
- package/dist/es/api-model/models/model-error.js +1 -1
- package/dist/es/api-model/models/money.js +1 -1
- package/dist/es/api-model/models/open-interval.js +1 -1
- package/dist/es/api-model/models/open-time-interval.js +1 -1
- package/dist/es/api-model/models/order-address.js +1 -1
- package/dist/es/api-model/models/order-buyer-info.js +1 -1
- package/dist/es/api-model/models/order-item-buyer-info.js +1 -1
- package/dist/es/api-model/models/order-item.js +1 -1
- package/dist/es/api-model/models/order-items-buyer-info-list.js +1 -1
- package/dist/es/api-model/models/order-items-inner.js +1 -1
- package/dist/es/api-model/models/order-items-list.js +1 -1
- package/dist/es/api-model/models/order-regulated-info.js +1 -1
- package/dist/es/api-model/models/order.js +1 -1
- package/dist/es/api-model/models/orders-list.js +1 -1
- package/dist/es/api-model/models/other-delivery-attributes.js +1 -1
- package/dist/es/api-model/models/package-detail.js +1 -1
- package/dist/es/api-model/models/payment-execution-detail-item.js +1 -1
- package/dist/es/api-model/models/points-granted-detail.js +1 -1
- package/dist/es/api-model/models/preferred-delivery-time.js +1 -1
- package/dist/es/api-model/models/prescription-detail.js +1 -1
- package/dist/es/api-model/models/product-info-detail.js +1 -1
- package/dist/es/api-model/models/regulated-information-field.js +1 -1
- package/dist/es/api-model/models/regulated-information.js +1 -1
- package/dist/es/api-model/models/regulated-order-verification-status.js +1 -1
- package/dist/es/api-model/models/rejection-reason.js +1 -1
- package/dist/es/api-model/models/shipment-status.js +1 -1
- package/dist/es/api-model/models/shipping-constraints.js +1 -1
- package/dist/es/api-model/models/substitution-option.js +1 -1
- package/dist/es/api-model/models/substitution-preferences.js +1 -1
- package/dist/es/api-model/models/tax-classification.js +1 -1
- package/dist/es/api-model/models/tax-collection.js +1 -1
- package/dist/es/api-model/models/update-shipment-status-error-response.js +1 -1
- package/dist/es/api-model/models/update-shipment-status-request.js +1 -1
- package/dist/es/api-model/models/update-verification-status-error-response.js +1 -1
- package/dist/es/api-model/models/update-verification-status-request-body.js +1 -1
- package/dist/es/api-model/models/update-verification-status-request.js +1 -1
- package/dist/es/api-model/models/valid-verification-detail.js +1 -1
- package/dist/es/api-model/models/verification-details.js +1 -1
- package/dist/es/api-model/models/verification-status.js +1 -1
- package/dist/es/client.js +2 -2
- package/dist/types/api-model/api/{orders-v0-api.d.ts → orders-api.d.ts} +166 -126
- package/dist/types/api-model/api.d.ts +2 -2
- package/dist/types/api-model/base.d.ts +1 -1
- package/dist/types/api-model/common.d.ts +1 -1
- package/dist/types/api-model/configuration.d.ts +1 -1
- package/dist/types/api-model/index.d.ts +1 -1
- package/dist/types/api-model/models/address-extended-fields.d.ts +1 -1
- package/dist/types/api-model/models/address.d.ts +1 -1
- package/dist/types/api-model/models/amazon-programs.d.ts +1 -1
- package/dist/types/api-model/models/associated-item.d.ts +1 -1
- package/dist/types/api-model/models/association-type.d.ts +1 -1
- package/dist/types/api-model/models/automated-shipping-settings.d.ts +1 -1
- package/dist/types/api-model/models/business-hours.d.ts +1 -1
- package/dist/types/api-model/models/buyer-customized-info-detail.d.ts +1 -1
- package/dist/types/api-model/models/buyer-info.d.ts +1 -1
- package/dist/types/api-model/models/buyer-requested-cancel.d.ts +1 -1
- package/dist/types/api-model/models/buyer-tax-info.d.ts +1 -1
- package/dist/types/api-model/models/buyer-tax-information.d.ts +1 -1
- package/dist/types/api-model/models/confirm-shipment-error-response.d.ts +1 -1
- package/dist/types/api-model/models/confirm-shipment-order-item.d.ts +1 -1
- package/dist/types/api-model/models/confirm-shipment-request.d.ts +1 -1
- package/dist/types/api-model/models/constraint-type.d.ts +1 -1
- package/dist/types/api-model/models/delivery-preferences.d.ts +1 -1
- package/dist/types/api-model/models/easy-ship-shipment-status.d.ts +1 -1
- package/dist/types/api-model/models/electronic-invoice-status.d.ts +1 -1
- package/dist/types/api-model/models/exception-dates.d.ts +1 -1
- package/dist/types/api-model/models/fulfillment-instruction.d.ts +1 -1
- package/dist/types/api-model/models/get-order-address-response.d.ts +1 -1
- package/dist/types/api-model/models/get-order-buyer-info-response.d.ts +1 -1
- package/dist/types/api-model/models/get-order-items-buyer-info-response.d.ts +1 -1
- package/dist/types/api-model/models/get-order-items-response.d.ts +1 -1
- package/dist/types/api-model/models/get-order-regulated-info-response.d.ts +1 -1
- package/dist/types/api-model/models/get-order-response.d.ts +1 -1
- package/dist/types/api-model/models/get-orders-response.d.ts +1 -1
- package/dist/types/api-model/models/item-buyer-info.d.ts +1 -1
- package/dist/types/api-model/models/marketplace-tax-info.d.ts +1 -1
- package/dist/types/api-model/models/measurement.d.ts +1 -1
- package/dist/types/api-model/models/model-error.d.ts +1 -1
- package/dist/types/api-model/models/money.d.ts +1 -1
- package/dist/types/api-model/models/open-interval.d.ts +1 -1
- package/dist/types/api-model/models/open-time-interval.d.ts +1 -1
- package/dist/types/api-model/models/order-address.d.ts +1 -1
- package/dist/types/api-model/models/order-buyer-info.d.ts +1 -1
- package/dist/types/api-model/models/order-item-buyer-info.d.ts +1 -1
- package/dist/types/api-model/models/order-item.d.ts +1 -1
- package/dist/types/api-model/models/order-items-buyer-info-list.d.ts +1 -1
- package/dist/types/api-model/models/order-items-inner.d.ts +1 -1
- package/dist/types/api-model/models/order-items-list.d.ts +1 -1
- package/dist/types/api-model/models/order-regulated-info.d.ts +1 -1
- package/dist/types/api-model/models/order.d.ts +1 -1
- package/dist/types/api-model/models/orders-list.d.ts +1 -1
- package/dist/types/api-model/models/other-delivery-attributes.d.ts +1 -1
- package/dist/types/api-model/models/package-detail.d.ts +1 -1
- package/dist/types/api-model/models/payment-execution-detail-item.d.ts +1 -1
- package/dist/types/api-model/models/points-granted-detail.d.ts +1 -1
- package/dist/types/api-model/models/preferred-delivery-time.d.ts +1 -1
- package/dist/types/api-model/models/prescription-detail.d.ts +1 -1
- package/dist/types/api-model/models/product-info-detail.d.ts +1 -1
- package/dist/types/api-model/models/regulated-information-field.d.ts +1 -1
- package/dist/types/api-model/models/regulated-information.d.ts +1 -1
- package/dist/types/api-model/models/regulated-order-verification-status.d.ts +1 -1
- package/dist/types/api-model/models/rejection-reason.d.ts +1 -1
- package/dist/types/api-model/models/shipment-status.d.ts +1 -1
- package/dist/types/api-model/models/shipping-constraints.d.ts +1 -1
- package/dist/types/api-model/models/substitution-option.d.ts +1 -1
- package/dist/types/api-model/models/substitution-preferences.d.ts +1 -1
- package/dist/types/api-model/models/tax-classification.d.ts +1 -1
- package/dist/types/api-model/models/tax-collection.d.ts +1 -1
- package/dist/types/api-model/models/update-shipment-status-error-response.d.ts +1 -1
- package/dist/types/api-model/models/update-shipment-status-request.d.ts +1 -1
- package/dist/types/api-model/models/update-verification-status-error-response.d.ts +1 -1
- package/dist/types/api-model/models/update-verification-status-request-body.d.ts +1 -1
- package/dist/types/api-model/models/update-verification-status-request.d.ts +1 -1
- package/dist/types/api-model/models/valid-verification-detail.d.ts +1 -1
- package/dist/types/api-model/models/verification-details.d.ts +1 -1
- package/dist/types/api-model/models/verification-status.d.ts +1 -1
- package/dist/types/client.d.ts +2 -2
- package/package.json +2 -2
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* tslint:disable */
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* Orders v0
|
|
6
6
|
* 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).
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: v0
|
|
@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
16
16
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
17
17
|
};
|
|
18
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.
|
|
19
|
+
exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = void 0;
|
|
20
20
|
const axios_1 = __importDefault(require("axios"));
|
|
21
21
|
// Some imports not used depending on template conditions
|
|
22
22
|
// @ts-ignore
|
|
@@ -24,13 +24,14 @@ const common_1 = require("../common");
|
|
|
24
24
|
// @ts-ignore
|
|
25
25
|
const base_1 = require("../base");
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* OrdersApi - axios parameter creator
|
|
28
28
|
* @export
|
|
29
29
|
*/
|
|
30
|
-
const
|
|
30
|
+
const OrdersApiAxiosParamCreator = function (configuration) {
|
|
31
31
|
return {
|
|
32
32
|
/**
|
|
33
33
|
* 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).
|
|
34
|
+
* @summary confirmShipment
|
|
34
35
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
35
36
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
36
37
|
* @param {*} [options] Override http request option.
|
|
@@ -64,6 +65,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
64
65
|
},
|
|
65
66
|
/**
|
|
66
67
|
* 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).
|
|
68
|
+
* @summary getOrder
|
|
67
69
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
68
70
|
* @param {*} [options] Override http request option.
|
|
69
71
|
* @throws {RequiredError}
|
|
@@ -92,6 +94,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
92
94
|
},
|
|
93
95
|
/**
|
|
94
96
|
* 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).
|
|
97
|
+
* @summary getOrderAddress
|
|
95
98
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
96
99
|
* @param {*} [options] Override http request option.
|
|
97
100
|
* @throws {RequiredError}
|
|
@@ -120,6 +123,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
120
123
|
},
|
|
121
124
|
/**
|
|
122
125
|
* 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).
|
|
126
|
+
* @summary getOrderBuyerInfo
|
|
123
127
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
124
128
|
* @param {*} [options] Override http request option.
|
|
125
129
|
* @throws {RequiredError}
|
|
@@ -148,6 +152,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
148
152
|
},
|
|
149
153
|
/**
|
|
150
154
|
* 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).
|
|
155
|
+
* @summary getOrderItems
|
|
151
156
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
152
157
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
153
158
|
* @param {*} [options] Override http request option.
|
|
@@ -180,6 +185,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
180
185
|
},
|
|
181
186
|
/**
|
|
182
187
|
* 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).
|
|
188
|
+
* @summary getOrderItemsBuyerInfo
|
|
183
189
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
184
190
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
185
191
|
* @param {*} [options] Override http request option.
|
|
@@ -212,6 +218,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
212
218
|
},
|
|
213
219
|
/**
|
|
214
220
|
* 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).
|
|
221
|
+
* @summary getOrderRegulatedInfo
|
|
215
222
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
216
223
|
* @param {*} [options] Override http request option.
|
|
217
224
|
* @throws {RequiredError}
|
|
@@ -240,6 +247,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
240
247
|
},
|
|
241
248
|
/**
|
|
242
249
|
* 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.
|
|
250
|
+
* @summary getOrders
|
|
243
251
|
* @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.
|
|
244
252
|
* @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.
|
|
245
253
|
* @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.
|
|
@@ -354,6 +362,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
354
362
|
},
|
|
355
363
|
/**
|
|
356
364
|
* 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).
|
|
365
|
+
* @summary updateShipmentStatus
|
|
357
366
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
358
367
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
359
368
|
* @param {*} [options] Override http request option.
|
|
@@ -387,6 +396,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
387
396
|
},
|
|
388
397
|
/**
|
|
389
398
|
* 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).
|
|
399
|
+
* @summary updateVerificationStatus
|
|
390
400
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
391
401
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
392
402
|
* @param {*} [options] Override http request option.
|
|
@@ -420,16 +430,17 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
420
430
|
},
|
|
421
431
|
};
|
|
422
432
|
};
|
|
423
|
-
exports.
|
|
433
|
+
exports.OrdersApiAxiosParamCreator = OrdersApiAxiosParamCreator;
|
|
424
434
|
/**
|
|
425
|
-
*
|
|
435
|
+
* OrdersApi - functional programming interface
|
|
426
436
|
* @export
|
|
427
437
|
*/
|
|
428
|
-
const
|
|
429
|
-
const localVarAxiosParamCreator = (0, exports.
|
|
438
|
+
const OrdersApiFp = function (configuration) {
|
|
439
|
+
const localVarAxiosParamCreator = (0, exports.OrdersApiAxiosParamCreator)(configuration);
|
|
430
440
|
return {
|
|
431
441
|
/**
|
|
432
442
|
* 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).
|
|
443
|
+
* @summary confirmShipment
|
|
433
444
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
434
445
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
435
446
|
* @param {*} [options] Override http request option.
|
|
@@ -438,11 +449,12 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
438
449
|
async confirmShipment(orderId, payload, options) {
|
|
439
450
|
const localVarAxiosArgs = await localVarAxiosParamCreator.confirmShipment(orderId, payload, options);
|
|
440
451
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
441
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
452
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.confirmShipment']?.[localVarOperationServerIndex]?.url;
|
|
442
453
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
443
454
|
},
|
|
444
455
|
/**
|
|
445
456
|
* 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).
|
|
457
|
+
* @summary getOrder
|
|
446
458
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
447
459
|
* @param {*} [options] Override http request option.
|
|
448
460
|
* @throws {RequiredError}
|
|
@@ -450,11 +462,12 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
450
462
|
async getOrder(orderId, options) {
|
|
451
463
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrder(orderId, options);
|
|
452
464
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
453
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
465
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrder']?.[localVarOperationServerIndex]?.url;
|
|
454
466
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
455
467
|
},
|
|
456
468
|
/**
|
|
457
469
|
* 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).
|
|
470
|
+
* @summary getOrderAddress
|
|
458
471
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
459
472
|
* @param {*} [options] Override http request option.
|
|
460
473
|
* @throws {RequiredError}
|
|
@@ -462,11 +475,12 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
462
475
|
async getOrderAddress(orderId, options) {
|
|
463
476
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderAddress(orderId, options);
|
|
464
477
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
465
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
478
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrderAddress']?.[localVarOperationServerIndex]?.url;
|
|
466
479
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
467
480
|
},
|
|
468
481
|
/**
|
|
469
482
|
* 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).
|
|
483
|
+
* @summary getOrderBuyerInfo
|
|
470
484
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
471
485
|
* @param {*} [options] Override http request option.
|
|
472
486
|
* @throws {RequiredError}
|
|
@@ -474,11 +488,12 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
474
488
|
async getOrderBuyerInfo(orderId, options) {
|
|
475
489
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderBuyerInfo(orderId, options);
|
|
476
490
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
477
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
491
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrderBuyerInfo']?.[localVarOperationServerIndex]?.url;
|
|
478
492
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
479
493
|
},
|
|
480
494
|
/**
|
|
481
495
|
* 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).
|
|
496
|
+
* @summary getOrderItems
|
|
482
497
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
483
498
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
484
499
|
* @param {*} [options] Override http request option.
|
|
@@ -487,11 +502,12 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
487
502
|
async getOrderItems(orderId, nextToken, options) {
|
|
488
503
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderItems(orderId, nextToken, options);
|
|
489
504
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
490
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
505
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrderItems']?.[localVarOperationServerIndex]?.url;
|
|
491
506
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
492
507
|
},
|
|
493
508
|
/**
|
|
494
509
|
* 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).
|
|
510
|
+
* @summary getOrderItemsBuyerInfo
|
|
495
511
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
496
512
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
497
513
|
* @param {*} [options] Override http request option.
|
|
@@ -500,11 +516,12 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
500
516
|
async getOrderItemsBuyerInfo(orderId, nextToken, options) {
|
|
501
517
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderItemsBuyerInfo(orderId, nextToken, options);
|
|
502
518
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
503
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
519
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrderItemsBuyerInfo']?.[localVarOperationServerIndex]?.url;
|
|
504
520
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
505
521
|
},
|
|
506
522
|
/**
|
|
507
523
|
* 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).
|
|
524
|
+
* @summary getOrderRegulatedInfo
|
|
508
525
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
509
526
|
* @param {*} [options] Override http request option.
|
|
510
527
|
* @throws {RequiredError}
|
|
@@ -512,11 +529,12 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
512
529
|
async getOrderRegulatedInfo(orderId, options) {
|
|
513
530
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderRegulatedInfo(orderId, options);
|
|
514
531
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
515
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
532
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrderRegulatedInfo']?.[localVarOperationServerIndex]?.url;
|
|
516
533
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
517
534
|
},
|
|
518
535
|
/**
|
|
519
536
|
* 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.
|
|
537
|
+
* @summary getOrders
|
|
520
538
|
* @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.
|
|
521
539
|
* @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.
|
|
522
540
|
* @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.
|
|
@@ -545,11 +563,12 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
545
563
|
async getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, earliestDeliveryDateBefore, earliestDeliveryDateAfter, latestDeliveryDateBefore, latestDeliveryDateAfter, options) {
|
|
546
564
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, earliestDeliveryDateBefore, earliestDeliveryDateAfter, latestDeliveryDateBefore, latestDeliveryDateAfter, options);
|
|
547
565
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
548
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
566
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrders']?.[localVarOperationServerIndex]?.url;
|
|
549
567
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
550
568
|
},
|
|
551
569
|
/**
|
|
552
570
|
* 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).
|
|
571
|
+
* @summary updateShipmentStatus
|
|
553
572
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
554
573
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
555
574
|
* @param {*} [options] Override http request option.
|
|
@@ -558,11 +577,12 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
558
577
|
async updateShipmentStatus(orderId, payload, options) {
|
|
559
578
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentStatus(orderId, payload, options);
|
|
560
579
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
561
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
580
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.updateShipmentStatus']?.[localVarOperationServerIndex]?.url;
|
|
562
581
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
563
582
|
},
|
|
564
583
|
/**
|
|
565
584
|
* 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).
|
|
585
|
+
* @summary updateVerificationStatus
|
|
566
586
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
567
587
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
568
588
|
* @param {*} [options] Override http request option.
|
|
@@ -571,22 +591,23 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
571
591
|
async updateVerificationStatus(orderId, payload, options) {
|
|
572
592
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateVerificationStatus(orderId, payload, options);
|
|
573
593
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
574
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
594
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.updateVerificationStatus']?.[localVarOperationServerIndex]?.url;
|
|
575
595
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
576
596
|
},
|
|
577
597
|
};
|
|
578
598
|
};
|
|
579
|
-
exports.
|
|
599
|
+
exports.OrdersApiFp = OrdersApiFp;
|
|
580
600
|
/**
|
|
581
|
-
*
|
|
601
|
+
* OrdersApi - factory interface
|
|
582
602
|
* @export
|
|
583
603
|
*/
|
|
584
|
-
const
|
|
585
|
-
const localVarFp = (0, exports.
|
|
604
|
+
const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
605
|
+
const localVarFp = (0, exports.OrdersApiFp)(configuration);
|
|
586
606
|
return {
|
|
587
607
|
/**
|
|
588
608
|
* 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).
|
|
589
|
-
* @
|
|
609
|
+
* @summary confirmShipment
|
|
610
|
+
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
590
611
|
* @param {*} [options] Override http request option.
|
|
591
612
|
* @throws {RequiredError}
|
|
592
613
|
*/
|
|
@@ -595,7 +616,8 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
595
616
|
},
|
|
596
617
|
/**
|
|
597
618
|
* 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).
|
|
598
|
-
* @
|
|
619
|
+
* @summary getOrder
|
|
620
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
599
621
|
* @param {*} [options] Override http request option.
|
|
600
622
|
* @throws {RequiredError}
|
|
601
623
|
*/
|
|
@@ -604,7 +626,8 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
604
626
|
},
|
|
605
627
|
/**
|
|
606
628
|
* 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).
|
|
607
|
-
* @
|
|
629
|
+
* @summary getOrderAddress
|
|
630
|
+
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
608
631
|
* @param {*} [options] Override http request option.
|
|
609
632
|
* @throws {RequiredError}
|
|
610
633
|
*/
|
|
@@ -613,7 +636,8 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
613
636
|
},
|
|
614
637
|
/**
|
|
615
638
|
* 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).
|
|
616
|
-
* @
|
|
639
|
+
* @summary getOrderBuyerInfo
|
|
640
|
+
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
617
641
|
* @param {*} [options] Override http request option.
|
|
618
642
|
* @throws {RequiredError}
|
|
619
643
|
*/
|
|
@@ -622,7 +646,8 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
622
646
|
},
|
|
623
647
|
/**
|
|
624
648
|
* 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).
|
|
625
|
-
* @
|
|
649
|
+
* @summary getOrderItems
|
|
650
|
+
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
626
651
|
* @param {*} [options] Override http request option.
|
|
627
652
|
* @throws {RequiredError}
|
|
628
653
|
*/
|
|
@@ -631,7 +656,8 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
631
656
|
},
|
|
632
657
|
/**
|
|
633
658
|
* 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).
|
|
634
|
-
* @
|
|
659
|
+
* @summary getOrderItemsBuyerInfo
|
|
660
|
+
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
635
661
|
* @param {*} [options] Override http request option.
|
|
636
662
|
* @throws {RequiredError}
|
|
637
663
|
*/
|
|
@@ -640,7 +666,8 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
640
666
|
},
|
|
641
667
|
/**
|
|
642
668
|
* 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).
|
|
643
|
-
* @
|
|
669
|
+
* @summary getOrderRegulatedInfo
|
|
670
|
+
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
644
671
|
* @param {*} [options] Override http request option.
|
|
645
672
|
* @throws {RequiredError}
|
|
646
673
|
*/
|
|
@@ -649,7 +676,8 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
649
676
|
},
|
|
650
677
|
/**
|
|
651
678
|
* 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.
|
|
652
|
-
* @
|
|
679
|
+
* @summary getOrders
|
|
680
|
+
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
653
681
|
* @param {*} [options] Override http request option.
|
|
654
682
|
* @throws {RequiredError}
|
|
655
683
|
*/
|
|
@@ -658,7 +686,8 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
658
686
|
},
|
|
659
687
|
/**
|
|
660
688
|
* 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).
|
|
661
|
-
* @
|
|
689
|
+
* @summary updateShipmentStatus
|
|
690
|
+
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
662
691
|
* @param {*} [options] Override http request option.
|
|
663
692
|
* @throws {RequiredError}
|
|
664
693
|
*/
|
|
@@ -667,7 +696,8 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
667
696
|
},
|
|
668
697
|
/**
|
|
669
698
|
* 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).
|
|
670
|
-
* @
|
|
699
|
+
* @summary updateVerificationStatus
|
|
700
|
+
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
671
701
|
* @param {*} [options] Override http request option.
|
|
672
702
|
* @throws {RequiredError}
|
|
673
703
|
*/
|
|
@@ -676,113 +706,123 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
676
706
|
},
|
|
677
707
|
};
|
|
678
708
|
};
|
|
679
|
-
exports.
|
|
709
|
+
exports.OrdersApiFactory = OrdersApiFactory;
|
|
680
710
|
/**
|
|
681
|
-
*
|
|
711
|
+
* OrdersApi - object-oriented interface
|
|
682
712
|
* @export
|
|
683
|
-
* @class
|
|
713
|
+
* @class OrdersApi
|
|
684
714
|
* @extends {BaseAPI}
|
|
685
715
|
*/
|
|
686
|
-
class
|
|
716
|
+
class OrdersApi extends base_1.BaseAPI {
|
|
687
717
|
/**
|
|
688
718
|
* 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).
|
|
689
|
-
* @
|
|
719
|
+
* @summary confirmShipment
|
|
720
|
+
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
690
721
|
* @param {*} [options] Override http request option.
|
|
691
722
|
* @throws {RequiredError}
|
|
692
|
-
* @memberof
|
|
723
|
+
* @memberof OrdersApi
|
|
693
724
|
*/
|
|
694
725
|
confirmShipment(requestParameters, options) {
|
|
695
|
-
return (0, exports.
|
|
726
|
+
return (0, exports.OrdersApiFp)(this.configuration).confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
696
727
|
}
|
|
697
728
|
/**
|
|
698
729
|
* 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).
|
|
699
|
-
* @
|
|
730
|
+
* @summary getOrder
|
|
731
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
700
732
|
* @param {*} [options] Override http request option.
|
|
701
733
|
* @throws {RequiredError}
|
|
702
|
-
* @memberof
|
|
734
|
+
* @memberof OrdersApi
|
|
703
735
|
*/
|
|
704
736
|
getOrder(requestParameters, options) {
|
|
705
|
-
return (0, exports.
|
|
737
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
706
738
|
}
|
|
707
739
|
/**
|
|
708
740
|
* 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).
|
|
709
|
-
* @
|
|
741
|
+
* @summary getOrderAddress
|
|
742
|
+
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
710
743
|
* @param {*} [options] Override http request option.
|
|
711
744
|
* @throws {RequiredError}
|
|
712
|
-
* @memberof
|
|
745
|
+
* @memberof OrdersApi
|
|
713
746
|
*/
|
|
714
747
|
getOrderAddress(requestParameters, options) {
|
|
715
|
-
return (0, exports.
|
|
748
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrderAddress(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
716
749
|
}
|
|
717
750
|
/**
|
|
718
751
|
* 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).
|
|
719
|
-
* @
|
|
752
|
+
* @summary getOrderBuyerInfo
|
|
753
|
+
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
720
754
|
* @param {*} [options] Override http request option.
|
|
721
755
|
* @throws {RequiredError}
|
|
722
|
-
* @memberof
|
|
756
|
+
* @memberof OrdersApi
|
|
723
757
|
*/
|
|
724
758
|
getOrderBuyerInfo(requestParameters, options) {
|
|
725
|
-
return (0, exports.
|
|
759
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
726
760
|
}
|
|
727
761
|
/**
|
|
728
762
|
* 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).
|
|
729
|
-
* @
|
|
763
|
+
* @summary getOrderItems
|
|
764
|
+
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
730
765
|
* @param {*} [options] Override http request option.
|
|
731
766
|
* @throws {RequiredError}
|
|
732
|
-
* @memberof
|
|
767
|
+
* @memberof OrdersApi
|
|
733
768
|
*/
|
|
734
769
|
getOrderItems(requestParameters, options) {
|
|
735
|
-
return (0, exports.
|
|
770
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
736
771
|
}
|
|
737
772
|
/**
|
|
738
773
|
* 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).
|
|
739
|
-
* @
|
|
774
|
+
* @summary getOrderItemsBuyerInfo
|
|
775
|
+
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
740
776
|
* @param {*} [options] Override http request option.
|
|
741
777
|
* @throws {RequiredError}
|
|
742
|
-
* @memberof
|
|
778
|
+
* @memberof OrdersApi
|
|
743
779
|
*/
|
|
744
780
|
getOrderItemsBuyerInfo(requestParameters, options) {
|
|
745
|
-
return (0, exports.
|
|
781
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
746
782
|
}
|
|
747
783
|
/**
|
|
748
784
|
* 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).
|
|
749
|
-
* @
|
|
785
|
+
* @summary getOrderRegulatedInfo
|
|
786
|
+
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
750
787
|
* @param {*} [options] Override http request option.
|
|
751
788
|
* @throws {RequiredError}
|
|
752
|
-
* @memberof
|
|
789
|
+
* @memberof OrdersApi
|
|
753
790
|
*/
|
|
754
791
|
getOrderRegulatedInfo(requestParameters, options) {
|
|
755
|
-
return (0, exports.
|
|
792
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
756
793
|
}
|
|
757
794
|
/**
|
|
758
795
|
* 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.
|
|
759
|
-
* @
|
|
796
|
+
* @summary getOrders
|
|
797
|
+
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
760
798
|
* @param {*} [options] Override http request option.
|
|
761
799
|
* @throws {RequiredError}
|
|
762
|
-
* @memberof
|
|
800
|
+
* @memberof OrdersApi
|
|
763
801
|
*/
|
|
764
802
|
getOrders(requestParameters, options) {
|
|
765
|
-
return (0, exports.
|
|
803
|
+
return (0, exports.OrdersApiFp)(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));
|
|
766
804
|
}
|
|
767
805
|
/**
|
|
768
806
|
* 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).
|
|
769
|
-
* @
|
|
807
|
+
* @summary updateShipmentStatus
|
|
808
|
+
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
770
809
|
* @param {*} [options] Override http request option.
|
|
771
810
|
* @throws {RequiredError}
|
|
772
|
-
* @memberof
|
|
811
|
+
* @memberof OrdersApi
|
|
773
812
|
*/
|
|
774
813
|
updateShipmentStatus(requestParameters, options) {
|
|
775
|
-
return (0, exports.
|
|
814
|
+
return (0, exports.OrdersApiFp)(this.configuration).updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
776
815
|
}
|
|
777
816
|
/**
|
|
778
817
|
* 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).
|
|
779
|
-
* @
|
|
818
|
+
* @summary updateVerificationStatus
|
|
819
|
+
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
780
820
|
* @param {*} [options] Override http request option.
|
|
781
821
|
* @throws {RequiredError}
|
|
782
|
-
* @memberof
|
|
822
|
+
* @memberof OrdersApi
|
|
783
823
|
*/
|
|
784
824
|
updateVerificationStatus(requestParameters, options) {
|
|
785
|
-
return (0, exports.
|
|
825
|
+
return (0, exports.OrdersApiFp)(this.configuration).updateVerificationStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
786
826
|
}
|
|
787
827
|
}
|
|
788
|
-
exports.
|
|
828
|
+
exports.OrdersApi = OrdersApi;
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* tslint:disable */
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* Orders v0
|
|
6
6
|
* 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).
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: v0
|
|
@@ -27,4 +27,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
27
27
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
28
28
|
};
|
|
29
29
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
30
|
-
__exportStar(require("./api/orders-
|
|
30
|
+
__exportStar(require("./api/orders-api"), exports);
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* tslint:disable */
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* Orders v0
|
|
6
6
|
* 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).
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: v0
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* tslint:disable */
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* Orders v0
|
|
6
6
|
* 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).
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: v0
|