@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
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Orders v0
|
|
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
|
|
@@ -18,13 +18,14 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeed
|
|
|
18
18
|
// @ts-ignore
|
|
19
19
|
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../base';
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* OrdersApi - axios parameter creator
|
|
22
22
|
* @export
|
|
23
23
|
*/
|
|
24
|
-
export const
|
|
24
|
+
export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
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
|
+
* @summary confirmShipment
|
|
28
29
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
29
30
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
30
31
|
* @param {*} [options] Override http request option.
|
|
@@ -58,6 +59,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
58
59
|
},
|
|
59
60
|
/**
|
|
60
61
|
* 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).
|
|
62
|
+
* @summary getOrder
|
|
61
63
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
62
64
|
* @param {*} [options] Override http request option.
|
|
63
65
|
* @throws {RequiredError}
|
|
@@ -86,6 +88,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
86
88
|
},
|
|
87
89
|
/**
|
|
88
90
|
* 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).
|
|
91
|
+
* @summary getOrderAddress
|
|
89
92
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
90
93
|
* @param {*} [options] Override http request option.
|
|
91
94
|
* @throws {RequiredError}
|
|
@@ -114,6 +117,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
114
117
|
},
|
|
115
118
|
/**
|
|
116
119
|
* 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).
|
|
120
|
+
* @summary getOrderBuyerInfo
|
|
117
121
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
118
122
|
* @param {*} [options] Override http request option.
|
|
119
123
|
* @throws {RequiredError}
|
|
@@ -142,6 +146,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
142
146
|
},
|
|
143
147
|
/**
|
|
144
148
|
* 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).
|
|
149
|
+
* @summary getOrderItems
|
|
145
150
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
146
151
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
147
152
|
* @param {*} [options] Override http request option.
|
|
@@ -174,6 +179,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
174
179
|
},
|
|
175
180
|
/**
|
|
176
181
|
* 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).
|
|
182
|
+
* @summary getOrderItemsBuyerInfo
|
|
177
183
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
178
184
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
179
185
|
* @param {*} [options] Override http request option.
|
|
@@ -206,6 +212,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
206
212
|
},
|
|
207
213
|
/**
|
|
208
214
|
* 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).
|
|
215
|
+
* @summary getOrderRegulatedInfo
|
|
209
216
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
210
217
|
* @param {*} [options] Override http request option.
|
|
211
218
|
* @throws {RequiredError}
|
|
@@ -234,6 +241,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
234
241
|
},
|
|
235
242
|
/**
|
|
236
243
|
* 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.
|
|
244
|
+
* @summary getOrders
|
|
237
245
|
* @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
246
|
* @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
247
|
* @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.
|
|
@@ -348,6 +356,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
348
356
|
},
|
|
349
357
|
/**
|
|
350
358
|
* 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).
|
|
359
|
+
* @summary updateShipmentStatus
|
|
351
360
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
352
361
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
353
362
|
* @param {*} [options] Override http request option.
|
|
@@ -381,6 +390,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
381
390
|
},
|
|
382
391
|
/**
|
|
383
392
|
* 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).
|
|
393
|
+
* @summary updateVerificationStatus
|
|
384
394
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
385
395
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
386
396
|
* @param {*} [options] Override http request option.
|
|
@@ -415,14 +425,15 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
415
425
|
};
|
|
416
426
|
};
|
|
417
427
|
/**
|
|
418
|
-
*
|
|
428
|
+
* OrdersApi - functional programming interface
|
|
419
429
|
* @export
|
|
420
430
|
*/
|
|
421
|
-
export const
|
|
422
|
-
const localVarAxiosParamCreator =
|
|
431
|
+
export const OrdersApiFp = function (configuration) {
|
|
432
|
+
const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration);
|
|
423
433
|
return {
|
|
424
434
|
/**
|
|
425
435
|
* 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).
|
|
436
|
+
* @summary confirmShipment
|
|
426
437
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
427
438
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
428
439
|
* @param {*} [options] Override http request option.
|
|
@@ -431,11 +442,12 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
431
442
|
async confirmShipment(orderId, payload, options) {
|
|
432
443
|
const localVarAxiosArgs = await localVarAxiosParamCreator.confirmShipment(orderId, payload, options);
|
|
433
444
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
434
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
445
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.confirmShipment']?.[localVarOperationServerIndex]?.url;
|
|
435
446
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
436
447
|
},
|
|
437
448
|
/**
|
|
438
449
|
* 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).
|
|
450
|
+
* @summary getOrder
|
|
439
451
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
440
452
|
* @param {*} [options] Override http request option.
|
|
441
453
|
* @throws {RequiredError}
|
|
@@ -443,11 +455,12 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
443
455
|
async getOrder(orderId, options) {
|
|
444
456
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrder(orderId, options);
|
|
445
457
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
446
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
458
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrder']?.[localVarOperationServerIndex]?.url;
|
|
447
459
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
448
460
|
},
|
|
449
461
|
/**
|
|
450
462
|
* 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).
|
|
463
|
+
* @summary getOrderAddress
|
|
451
464
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
452
465
|
* @param {*} [options] Override http request option.
|
|
453
466
|
* @throws {RequiredError}
|
|
@@ -455,11 +468,12 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
455
468
|
async getOrderAddress(orderId, options) {
|
|
456
469
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderAddress(orderId, options);
|
|
457
470
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
458
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
471
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderAddress']?.[localVarOperationServerIndex]?.url;
|
|
459
472
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
460
473
|
},
|
|
461
474
|
/**
|
|
462
475
|
* 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).
|
|
476
|
+
* @summary getOrderBuyerInfo
|
|
463
477
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
464
478
|
* @param {*} [options] Override http request option.
|
|
465
479
|
* @throws {RequiredError}
|
|
@@ -467,11 +481,12 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
467
481
|
async getOrderBuyerInfo(orderId, options) {
|
|
468
482
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderBuyerInfo(orderId, options);
|
|
469
483
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
470
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
484
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderBuyerInfo']?.[localVarOperationServerIndex]?.url;
|
|
471
485
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
472
486
|
},
|
|
473
487
|
/**
|
|
474
488
|
* 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).
|
|
489
|
+
* @summary getOrderItems
|
|
475
490
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
476
491
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
477
492
|
* @param {*} [options] Override http request option.
|
|
@@ -480,11 +495,12 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
480
495
|
async getOrderItems(orderId, nextToken, options) {
|
|
481
496
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderItems(orderId, nextToken, options);
|
|
482
497
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
483
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
498
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderItems']?.[localVarOperationServerIndex]?.url;
|
|
484
499
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
485
500
|
},
|
|
486
501
|
/**
|
|
487
502
|
* 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).
|
|
503
|
+
* @summary getOrderItemsBuyerInfo
|
|
488
504
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
489
505
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
490
506
|
* @param {*} [options] Override http request option.
|
|
@@ -493,11 +509,12 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
493
509
|
async getOrderItemsBuyerInfo(orderId, nextToken, options) {
|
|
494
510
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderItemsBuyerInfo(orderId, nextToken, options);
|
|
495
511
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
496
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
512
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderItemsBuyerInfo']?.[localVarOperationServerIndex]?.url;
|
|
497
513
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
498
514
|
},
|
|
499
515
|
/**
|
|
500
516
|
* 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).
|
|
517
|
+
* @summary getOrderRegulatedInfo
|
|
501
518
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
502
519
|
* @param {*} [options] Override http request option.
|
|
503
520
|
* @throws {RequiredError}
|
|
@@ -505,11 +522,12 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
505
522
|
async getOrderRegulatedInfo(orderId, options) {
|
|
506
523
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderRegulatedInfo(orderId, options);
|
|
507
524
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
508
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
525
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderRegulatedInfo']?.[localVarOperationServerIndex]?.url;
|
|
509
526
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
510
527
|
},
|
|
511
528
|
/**
|
|
512
529
|
* 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.
|
|
530
|
+
* @summary getOrders
|
|
513
531
|
* @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
532
|
* @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
533
|
* @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.
|
|
@@ -538,11 +556,12 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
538
556
|
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) {
|
|
539
557
|
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);
|
|
540
558
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
541
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
559
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrders']?.[localVarOperationServerIndex]?.url;
|
|
542
560
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
543
561
|
},
|
|
544
562
|
/**
|
|
545
563
|
* 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).
|
|
564
|
+
* @summary updateShipmentStatus
|
|
546
565
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
547
566
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
548
567
|
* @param {*} [options] Override http request option.
|
|
@@ -551,11 +570,12 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
551
570
|
async updateShipmentStatus(orderId, payload, options) {
|
|
552
571
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentStatus(orderId, payload, options);
|
|
553
572
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
554
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
573
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.updateShipmentStatus']?.[localVarOperationServerIndex]?.url;
|
|
555
574
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
556
575
|
},
|
|
557
576
|
/**
|
|
558
577
|
* 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).
|
|
578
|
+
* @summary updateVerificationStatus
|
|
559
579
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
560
580
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
561
581
|
* @param {*} [options] Override http request option.
|
|
@@ -564,21 +584,22 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
564
584
|
async updateVerificationStatus(orderId, payload, options) {
|
|
565
585
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateVerificationStatus(orderId, payload, options);
|
|
566
586
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
567
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
587
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.updateVerificationStatus']?.[localVarOperationServerIndex]?.url;
|
|
568
588
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
569
589
|
},
|
|
570
590
|
};
|
|
571
591
|
};
|
|
572
592
|
/**
|
|
573
|
-
*
|
|
593
|
+
* OrdersApi - factory interface
|
|
574
594
|
* @export
|
|
575
595
|
*/
|
|
576
|
-
export const
|
|
577
|
-
const localVarFp =
|
|
596
|
+
export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
597
|
+
const localVarFp = OrdersApiFp(configuration);
|
|
578
598
|
return {
|
|
579
599
|
/**
|
|
580
600
|
* 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
|
-
* @
|
|
601
|
+
* @summary confirmShipment
|
|
602
|
+
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
582
603
|
* @param {*} [options] Override http request option.
|
|
583
604
|
* @throws {RequiredError}
|
|
584
605
|
*/
|
|
@@ -587,7 +608,8 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
587
608
|
},
|
|
588
609
|
/**
|
|
589
610
|
* 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
|
-
* @
|
|
611
|
+
* @summary getOrder
|
|
612
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
591
613
|
* @param {*} [options] Override http request option.
|
|
592
614
|
* @throws {RequiredError}
|
|
593
615
|
*/
|
|
@@ -596,7 +618,8 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
596
618
|
},
|
|
597
619
|
/**
|
|
598
620
|
* 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
|
-
* @
|
|
621
|
+
* @summary getOrderAddress
|
|
622
|
+
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
600
623
|
* @param {*} [options] Override http request option.
|
|
601
624
|
* @throws {RequiredError}
|
|
602
625
|
*/
|
|
@@ -605,7 +628,8 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
605
628
|
},
|
|
606
629
|
/**
|
|
607
630
|
* 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
|
-
* @
|
|
631
|
+
* @summary getOrderBuyerInfo
|
|
632
|
+
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
609
633
|
* @param {*} [options] Override http request option.
|
|
610
634
|
* @throws {RequiredError}
|
|
611
635
|
*/
|
|
@@ -614,7 +638,8 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
614
638
|
},
|
|
615
639
|
/**
|
|
616
640
|
* 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
|
-
* @
|
|
641
|
+
* @summary getOrderItems
|
|
642
|
+
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
618
643
|
* @param {*} [options] Override http request option.
|
|
619
644
|
* @throws {RequiredError}
|
|
620
645
|
*/
|
|
@@ -623,7 +648,8 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
623
648
|
},
|
|
624
649
|
/**
|
|
625
650
|
* 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
|
-
* @
|
|
651
|
+
* @summary getOrderItemsBuyerInfo
|
|
652
|
+
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
627
653
|
* @param {*} [options] Override http request option.
|
|
628
654
|
* @throws {RequiredError}
|
|
629
655
|
*/
|
|
@@ -632,7 +658,8 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
632
658
|
},
|
|
633
659
|
/**
|
|
634
660
|
* 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
|
-
* @
|
|
661
|
+
* @summary getOrderRegulatedInfo
|
|
662
|
+
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
636
663
|
* @param {*} [options] Override http request option.
|
|
637
664
|
* @throws {RequiredError}
|
|
638
665
|
*/
|
|
@@ -641,7 +668,8 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
641
668
|
},
|
|
642
669
|
/**
|
|
643
670
|
* 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
|
-
* @
|
|
671
|
+
* @summary getOrders
|
|
672
|
+
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
645
673
|
* @param {*} [options] Override http request option.
|
|
646
674
|
* @throws {RequiredError}
|
|
647
675
|
*/
|
|
@@ -650,7 +678,8 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
650
678
|
},
|
|
651
679
|
/**
|
|
652
680
|
* 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
|
-
* @
|
|
681
|
+
* @summary updateShipmentStatus
|
|
682
|
+
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
654
683
|
* @param {*} [options] Override http request option.
|
|
655
684
|
* @throws {RequiredError}
|
|
656
685
|
*/
|
|
@@ -659,7 +688,8 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
659
688
|
},
|
|
660
689
|
/**
|
|
661
690
|
* 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
|
-
* @
|
|
691
|
+
* @summary updateVerificationStatus
|
|
692
|
+
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
663
693
|
* @param {*} [options] Override http request option.
|
|
664
694
|
* @throws {RequiredError}
|
|
665
695
|
*/
|
|
@@ -669,110 +699,120 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
669
699
|
};
|
|
670
700
|
};
|
|
671
701
|
/**
|
|
672
|
-
*
|
|
702
|
+
* OrdersApi - object-oriented interface
|
|
673
703
|
* @export
|
|
674
|
-
* @class
|
|
704
|
+
* @class OrdersApi
|
|
675
705
|
* @extends {BaseAPI}
|
|
676
706
|
*/
|
|
677
|
-
export class
|
|
707
|
+
export class OrdersApi extends BaseAPI {
|
|
678
708
|
/**
|
|
679
709
|
* 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
|
-
* @
|
|
710
|
+
* @summary confirmShipment
|
|
711
|
+
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
681
712
|
* @param {*} [options] Override http request option.
|
|
682
713
|
* @throws {RequiredError}
|
|
683
|
-
* @memberof
|
|
714
|
+
* @memberof OrdersApi
|
|
684
715
|
*/
|
|
685
716
|
confirmShipment(requestParameters, options) {
|
|
686
|
-
return
|
|
717
|
+
return OrdersApiFp(this.configuration).confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
687
718
|
}
|
|
688
719
|
/**
|
|
689
720
|
* 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
|
-
* @
|
|
721
|
+
* @summary getOrder
|
|
722
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
691
723
|
* @param {*} [options] Override http request option.
|
|
692
724
|
* @throws {RequiredError}
|
|
693
|
-
* @memberof
|
|
725
|
+
* @memberof OrdersApi
|
|
694
726
|
*/
|
|
695
727
|
getOrder(requestParameters, options) {
|
|
696
|
-
return
|
|
728
|
+
return OrdersApiFp(this.configuration).getOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
697
729
|
}
|
|
698
730
|
/**
|
|
699
731
|
* 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
|
-
* @
|
|
732
|
+
* @summary getOrderAddress
|
|
733
|
+
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
701
734
|
* @param {*} [options] Override http request option.
|
|
702
735
|
* @throws {RequiredError}
|
|
703
|
-
* @memberof
|
|
736
|
+
* @memberof OrdersApi
|
|
704
737
|
*/
|
|
705
738
|
getOrderAddress(requestParameters, options) {
|
|
706
|
-
return
|
|
739
|
+
return OrdersApiFp(this.configuration).getOrderAddress(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
707
740
|
}
|
|
708
741
|
/**
|
|
709
742
|
* 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
|
-
* @
|
|
743
|
+
* @summary getOrderBuyerInfo
|
|
744
|
+
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
711
745
|
* @param {*} [options] Override http request option.
|
|
712
746
|
* @throws {RequiredError}
|
|
713
|
-
* @memberof
|
|
747
|
+
* @memberof OrdersApi
|
|
714
748
|
*/
|
|
715
749
|
getOrderBuyerInfo(requestParameters, options) {
|
|
716
|
-
return
|
|
750
|
+
return OrdersApiFp(this.configuration).getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
717
751
|
}
|
|
718
752
|
/**
|
|
719
753
|
* 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
|
-
* @
|
|
754
|
+
* @summary getOrderItems
|
|
755
|
+
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
721
756
|
* @param {*} [options] Override http request option.
|
|
722
757
|
* @throws {RequiredError}
|
|
723
|
-
* @memberof
|
|
758
|
+
* @memberof OrdersApi
|
|
724
759
|
*/
|
|
725
760
|
getOrderItems(requestParameters, options) {
|
|
726
|
-
return
|
|
761
|
+
return OrdersApiFp(this.configuration).getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
727
762
|
}
|
|
728
763
|
/**
|
|
729
764
|
* 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
|
-
* @
|
|
765
|
+
* @summary getOrderItemsBuyerInfo
|
|
766
|
+
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
731
767
|
* @param {*} [options] Override http request option.
|
|
732
768
|
* @throws {RequiredError}
|
|
733
|
-
* @memberof
|
|
769
|
+
* @memberof OrdersApi
|
|
734
770
|
*/
|
|
735
771
|
getOrderItemsBuyerInfo(requestParameters, options) {
|
|
736
|
-
return
|
|
772
|
+
return OrdersApiFp(this.configuration).getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
737
773
|
}
|
|
738
774
|
/**
|
|
739
775
|
* 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
|
-
* @
|
|
776
|
+
* @summary getOrderRegulatedInfo
|
|
777
|
+
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
741
778
|
* @param {*} [options] Override http request option.
|
|
742
779
|
* @throws {RequiredError}
|
|
743
|
-
* @memberof
|
|
780
|
+
* @memberof OrdersApi
|
|
744
781
|
*/
|
|
745
782
|
getOrderRegulatedInfo(requestParameters, options) {
|
|
746
|
-
return
|
|
783
|
+
return OrdersApiFp(this.configuration).getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
747
784
|
}
|
|
748
785
|
/**
|
|
749
786
|
* 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
|
-
* @
|
|
787
|
+
* @summary getOrders
|
|
788
|
+
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
751
789
|
* @param {*} [options] Override http request option.
|
|
752
790
|
* @throws {RequiredError}
|
|
753
|
-
* @memberof
|
|
791
|
+
* @memberof OrdersApi
|
|
754
792
|
*/
|
|
755
793
|
getOrders(requestParameters, options) {
|
|
756
|
-
return
|
|
794
|
+
return 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));
|
|
757
795
|
}
|
|
758
796
|
/**
|
|
759
797
|
* 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
|
-
* @
|
|
798
|
+
* @summary updateShipmentStatus
|
|
799
|
+
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
761
800
|
* @param {*} [options] Override http request option.
|
|
762
801
|
* @throws {RequiredError}
|
|
763
|
-
* @memberof
|
|
802
|
+
* @memberof OrdersApi
|
|
764
803
|
*/
|
|
765
804
|
updateShipmentStatus(requestParameters, options) {
|
|
766
|
-
return
|
|
805
|
+
return OrdersApiFp(this.configuration).updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
767
806
|
}
|
|
768
807
|
/**
|
|
769
808
|
* 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
|
-
* @
|
|
809
|
+
* @summary updateVerificationStatus
|
|
810
|
+
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
771
811
|
* @param {*} [options] Override http request option.
|
|
772
812
|
* @throws {RequiredError}
|
|
773
|
-
* @memberof
|
|
813
|
+
* @memberof OrdersApi
|
|
774
814
|
*/
|
|
775
815
|
updateVerificationStatus(requestParameters, options) {
|
|
776
|
-
return
|
|
816
|
+
return OrdersApiFp(this.configuration).updateVerificationStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
777
817
|
}
|
|
778
818
|
}
|
package/dist/es/api-model/api.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Orders v0
|
|
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
|
|
@@ -11,4 +11,4 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
-
export * from './api/orders-
|
|
14
|
+
export * from './api/orders-api';
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Orders v0
|
|
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
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Orders v0
|
|
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
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Orders v0
|
|
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
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Orders v0
|
|
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
|