@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,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
2
|
+
* Orders v0
|
|
3
3
|
* 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).
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
@@ -24,12 +24,13 @@ import type { GetOrdersResponse } from '../models';
|
|
|
24
24
|
import type { UpdateShipmentStatusRequest } from '../models';
|
|
25
25
|
import type { UpdateVerificationStatusRequest } from '../models';
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* OrdersApi - axios parameter creator
|
|
28
28
|
* @export
|
|
29
29
|
*/
|
|
30
|
-
export declare const
|
|
30
|
+
export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
31
31
|
/**
|
|
32
32
|
* 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).
|
|
33
|
+
* @summary confirmShipment
|
|
33
34
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
34
35
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
35
36
|
* @param {*} [options] Override http request option.
|
|
@@ -38,6 +39,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
38
39
|
confirmShipment: (orderId: string, payload: ConfirmShipmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
40
|
/**
|
|
40
41
|
* 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).
|
|
42
|
+
* @summary getOrder
|
|
41
43
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
42
44
|
* @param {*} [options] Override http request option.
|
|
43
45
|
* @throws {RequiredError}
|
|
@@ -45,6 +47,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
45
47
|
getOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
48
|
/**
|
|
47
49
|
* 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).
|
|
50
|
+
* @summary getOrderAddress
|
|
48
51
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
49
52
|
* @param {*} [options] Override http request option.
|
|
50
53
|
* @throws {RequiredError}
|
|
@@ -52,6 +55,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
52
55
|
getOrderAddress: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
56
|
/**
|
|
54
57
|
* 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).
|
|
58
|
+
* @summary getOrderBuyerInfo
|
|
55
59
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
56
60
|
* @param {*} [options] Override http request option.
|
|
57
61
|
* @throws {RequiredError}
|
|
@@ -59,6 +63,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
59
63
|
getOrderBuyerInfo: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
64
|
/**
|
|
61
65
|
* 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).
|
|
66
|
+
* @summary getOrderItems
|
|
62
67
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
63
68
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
64
69
|
* @param {*} [options] Override http request option.
|
|
@@ -67,6 +72,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
67
72
|
getOrderItems: (orderId: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
73
|
/**
|
|
69
74
|
* 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).
|
|
75
|
+
* @summary getOrderItemsBuyerInfo
|
|
70
76
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
71
77
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
72
78
|
* @param {*} [options] Override http request option.
|
|
@@ -75,6 +81,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
75
81
|
getOrderItemsBuyerInfo: (orderId: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
82
|
/**
|
|
77
83
|
* 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).
|
|
84
|
+
* @summary getOrderRegulatedInfo
|
|
78
85
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
79
86
|
* @param {*} [options] Override http request option.
|
|
80
87
|
* @throws {RequiredError}
|
|
@@ -82,6 +89,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
82
89
|
getOrderRegulatedInfo: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83
90
|
/**
|
|
84
91
|
* 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.
|
|
92
|
+
* @summary getOrders
|
|
85
93
|
* @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.
|
|
86
94
|
* @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.
|
|
87
95
|
* @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.
|
|
@@ -110,6 +118,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
110
118
|
getOrders: (marketplaceIds: Array<string>, createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, orderStatuses?: Array<string>, fulfillmentChannels?: Array<string>, paymentMethods?: Array<string>, buyerEmail?: string, sellerOrderId?: string, maxResultsPerPage?: number, easyShipShipmentStatuses?: Array<string>, electronicInvoiceStatuses?: Array<string>, nextToken?: string, amazonOrderIds?: Array<string>, actualFulfillmentSupplySourceId?: string, isISPU?: boolean, storeChainStoreId?: string, earliestDeliveryDateBefore?: string, earliestDeliveryDateAfter?: string, latestDeliveryDateBefore?: string, latestDeliveryDateAfter?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
111
119
|
/**
|
|
112
120
|
* 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).
|
|
121
|
+
* @summary updateShipmentStatus
|
|
113
122
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
114
123
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
115
124
|
* @param {*} [options] Override http request option.
|
|
@@ -118,6 +127,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
118
127
|
updateShipmentStatus: (orderId: string, payload: UpdateShipmentStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
119
128
|
/**
|
|
120
129
|
* 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).
|
|
130
|
+
* @summary updateVerificationStatus
|
|
121
131
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
122
132
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
123
133
|
* @param {*} [options] Override http request option.
|
|
@@ -126,12 +136,13 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
126
136
|
updateVerificationStatus: (orderId: string, payload: UpdateVerificationStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
127
137
|
};
|
|
128
138
|
/**
|
|
129
|
-
*
|
|
139
|
+
* OrdersApi - functional programming interface
|
|
130
140
|
* @export
|
|
131
141
|
*/
|
|
132
|
-
export declare const
|
|
142
|
+
export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
133
143
|
/**
|
|
134
144
|
* 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).
|
|
145
|
+
* @summary confirmShipment
|
|
135
146
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
136
147
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
137
148
|
* @param {*} [options] Override http request option.
|
|
@@ -140,6 +151,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
140
151
|
confirmShipment(orderId: string, payload: ConfirmShipmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
141
152
|
/**
|
|
142
153
|
* 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).
|
|
154
|
+
* @summary getOrder
|
|
143
155
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
144
156
|
* @param {*} [options] Override http request option.
|
|
145
157
|
* @throws {RequiredError}
|
|
@@ -147,6 +159,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
147
159
|
getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderResponse>>;
|
|
148
160
|
/**
|
|
149
161
|
* 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).
|
|
162
|
+
* @summary getOrderAddress
|
|
150
163
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
151
164
|
* @param {*} [options] Override http request option.
|
|
152
165
|
* @throws {RequiredError}
|
|
@@ -154,6 +167,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
154
167
|
getOrderAddress(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderAddressResponse>>;
|
|
155
168
|
/**
|
|
156
169
|
* 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).
|
|
170
|
+
* @summary getOrderBuyerInfo
|
|
157
171
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
158
172
|
* @param {*} [options] Override http request option.
|
|
159
173
|
* @throws {RequiredError}
|
|
@@ -161,6 +175,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
161
175
|
getOrderBuyerInfo(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderBuyerInfoResponse>>;
|
|
162
176
|
/**
|
|
163
177
|
* 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).
|
|
178
|
+
* @summary getOrderItems
|
|
164
179
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
165
180
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
166
181
|
* @param {*} [options] Override http request option.
|
|
@@ -169,6 +184,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
169
184
|
getOrderItems(orderId: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsResponse>>;
|
|
170
185
|
/**
|
|
171
186
|
* 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).
|
|
187
|
+
* @summary getOrderItemsBuyerInfo
|
|
172
188
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
173
189
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
174
190
|
* @param {*} [options] Override http request option.
|
|
@@ -177,6 +193,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
177
193
|
getOrderItemsBuyerInfo(orderId: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsBuyerInfoResponse>>;
|
|
178
194
|
/**
|
|
179
195
|
* 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).
|
|
196
|
+
* @summary getOrderRegulatedInfo
|
|
180
197
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
181
198
|
* @param {*} [options] Override http request option.
|
|
182
199
|
* @throws {RequiredError}
|
|
@@ -184,6 +201,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
184
201
|
getOrderRegulatedInfo(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderRegulatedInfoResponse>>;
|
|
185
202
|
/**
|
|
186
203
|
* 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.
|
|
204
|
+
* @summary getOrders
|
|
187
205
|
* @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.
|
|
188
206
|
* @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.
|
|
189
207
|
* @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.
|
|
@@ -212,6 +230,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
212
230
|
getOrders(marketplaceIds: Array<string>, createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, orderStatuses?: Array<string>, fulfillmentChannels?: Array<string>, paymentMethods?: Array<string>, buyerEmail?: string, sellerOrderId?: string, maxResultsPerPage?: number, easyShipShipmentStatuses?: Array<string>, electronicInvoiceStatuses?: Array<string>, nextToken?: string, amazonOrderIds?: Array<string>, actualFulfillmentSupplySourceId?: string, isISPU?: boolean, storeChainStoreId?: string, earliestDeliveryDateBefore?: string, earliestDeliveryDateAfter?: string, latestDeliveryDateBefore?: string, latestDeliveryDateAfter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrdersResponse>>;
|
|
213
231
|
/**
|
|
214
232
|
* 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).
|
|
233
|
+
* @summary updateShipmentStatus
|
|
215
234
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
216
235
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
217
236
|
* @param {*} [options] Override http request option.
|
|
@@ -220,6 +239,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
220
239
|
updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
221
240
|
/**
|
|
222
241
|
* 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).
|
|
242
|
+
* @summary updateVerificationStatus
|
|
223
243
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
224
244
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
225
245
|
* @param {*} [options] Override http request option.
|
|
@@ -228,452 +248,472 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
228
248
|
updateVerificationStatus(orderId: string, payload: UpdateVerificationStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
229
249
|
};
|
|
230
250
|
/**
|
|
231
|
-
*
|
|
251
|
+
* OrdersApi - factory interface
|
|
232
252
|
* @export
|
|
233
253
|
*/
|
|
234
|
-
export declare const
|
|
254
|
+
export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
235
255
|
/**
|
|
236
256
|
* 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).
|
|
237
|
-
* @
|
|
257
|
+
* @summary confirmShipment
|
|
258
|
+
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
238
259
|
* @param {*} [options] Override http request option.
|
|
239
260
|
* @throws {RequiredError}
|
|
240
261
|
*/
|
|
241
|
-
confirmShipment(requestParameters:
|
|
262
|
+
confirmShipment(requestParameters: OrdersApiConfirmShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
242
263
|
/**
|
|
243
264
|
* 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).
|
|
244
|
-
* @
|
|
265
|
+
* @summary getOrder
|
|
266
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
245
267
|
* @param {*} [options] Override http request option.
|
|
246
268
|
* @throws {RequiredError}
|
|
247
269
|
*/
|
|
248
|
-
getOrder(requestParameters:
|
|
270
|
+
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderResponse>;
|
|
249
271
|
/**
|
|
250
272
|
* 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).
|
|
251
|
-
* @
|
|
273
|
+
* @summary getOrderAddress
|
|
274
|
+
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
252
275
|
* @param {*} [options] Override http request option.
|
|
253
276
|
* @throws {RequiredError}
|
|
254
277
|
*/
|
|
255
|
-
getOrderAddress(requestParameters:
|
|
278
|
+
getOrderAddress(requestParameters: OrdersApiGetOrderAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderAddressResponse>;
|
|
256
279
|
/**
|
|
257
280
|
* 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).
|
|
258
|
-
* @
|
|
281
|
+
* @summary getOrderBuyerInfo
|
|
282
|
+
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
259
283
|
* @param {*} [options] Override http request option.
|
|
260
284
|
* @throws {RequiredError}
|
|
261
285
|
*/
|
|
262
|
-
getOrderBuyerInfo(requestParameters:
|
|
286
|
+
getOrderBuyerInfo(requestParameters: OrdersApiGetOrderBuyerInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderBuyerInfoResponse>;
|
|
263
287
|
/**
|
|
264
288
|
* 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).
|
|
265
|
-
* @
|
|
289
|
+
* @summary getOrderItems
|
|
290
|
+
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
266
291
|
* @param {*} [options] Override http request option.
|
|
267
292
|
* @throws {RequiredError}
|
|
268
293
|
*/
|
|
269
|
-
getOrderItems(requestParameters:
|
|
294
|
+
getOrderItems(requestParameters: OrdersApiGetOrderItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderItemsResponse>;
|
|
270
295
|
/**
|
|
271
296
|
* 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).
|
|
272
|
-
* @
|
|
297
|
+
* @summary getOrderItemsBuyerInfo
|
|
298
|
+
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
273
299
|
* @param {*} [options] Override http request option.
|
|
274
300
|
* @throws {RequiredError}
|
|
275
301
|
*/
|
|
276
|
-
getOrderItemsBuyerInfo(requestParameters:
|
|
302
|
+
getOrderItemsBuyerInfo(requestParameters: OrdersApiGetOrderItemsBuyerInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
|
|
277
303
|
/**
|
|
278
304
|
* 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).
|
|
279
|
-
* @
|
|
305
|
+
* @summary getOrderRegulatedInfo
|
|
306
|
+
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
280
307
|
* @param {*} [options] Override http request option.
|
|
281
308
|
* @throws {RequiredError}
|
|
282
309
|
*/
|
|
283
|
-
getOrderRegulatedInfo(requestParameters:
|
|
310
|
+
getOrderRegulatedInfo(requestParameters: OrdersApiGetOrderRegulatedInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderRegulatedInfoResponse>;
|
|
284
311
|
/**
|
|
285
312
|
* 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.
|
|
286
|
-
* @
|
|
313
|
+
* @summary getOrders
|
|
314
|
+
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
287
315
|
* @param {*} [options] Override http request option.
|
|
288
316
|
* @throws {RequiredError}
|
|
289
317
|
*/
|
|
290
|
-
getOrders(requestParameters:
|
|
318
|
+
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrdersResponse>;
|
|
291
319
|
/**
|
|
292
320
|
* 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).
|
|
293
|
-
* @
|
|
321
|
+
* @summary updateShipmentStatus
|
|
322
|
+
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
294
323
|
* @param {*} [options] Override http request option.
|
|
295
324
|
* @throws {RequiredError}
|
|
296
325
|
*/
|
|
297
|
-
updateShipmentStatus(requestParameters:
|
|
326
|
+
updateShipmentStatus(requestParameters: OrdersApiUpdateShipmentStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
298
327
|
/**
|
|
299
328
|
* 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).
|
|
300
|
-
* @
|
|
329
|
+
* @summary updateVerificationStatus
|
|
330
|
+
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
301
331
|
* @param {*} [options] Override http request option.
|
|
302
332
|
* @throws {RequiredError}
|
|
303
333
|
*/
|
|
304
|
-
updateVerificationStatus(requestParameters:
|
|
334
|
+
updateVerificationStatus(requestParameters: OrdersApiUpdateVerificationStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
305
335
|
};
|
|
306
336
|
/**
|
|
307
|
-
* Request parameters for confirmShipment operation in
|
|
337
|
+
* Request parameters for confirmShipment operation in OrdersApi.
|
|
308
338
|
* @export
|
|
309
|
-
* @interface
|
|
339
|
+
* @interface OrdersApiConfirmShipmentRequest
|
|
310
340
|
*/
|
|
311
|
-
export interface
|
|
341
|
+
export interface OrdersApiConfirmShipmentRequest {
|
|
312
342
|
/**
|
|
313
343
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
314
344
|
* @type {string}
|
|
315
|
-
* @memberof
|
|
345
|
+
* @memberof OrdersApiConfirmShipment
|
|
316
346
|
*/
|
|
317
347
|
readonly orderId: string;
|
|
318
348
|
/**
|
|
319
349
|
* Request body of `confirmShipment`.
|
|
320
350
|
* @type {ConfirmShipmentRequest}
|
|
321
|
-
* @memberof
|
|
351
|
+
* @memberof OrdersApiConfirmShipment
|
|
322
352
|
*/
|
|
323
353
|
readonly payload: ConfirmShipmentRequest;
|
|
324
354
|
}
|
|
325
355
|
/**
|
|
326
|
-
* Request parameters for getOrder operation in
|
|
356
|
+
* Request parameters for getOrder operation in OrdersApi.
|
|
327
357
|
* @export
|
|
328
|
-
* @interface
|
|
358
|
+
* @interface OrdersApiGetOrderRequest
|
|
329
359
|
*/
|
|
330
|
-
export interface
|
|
360
|
+
export interface OrdersApiGetOrderRequest {
|
|
331
361
|
/**
|
|
332
362
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
333
363
|
* @type {string}
|
|
334
|
-
* @memberof
|
|
364
|
+
* @memberof OrdersApiGetOrder
|
|
335
365
|
*/
|
|
336
366
|
readonly orderId: string;
|
|
337
367
|
}
|
|
338
368
|
/**
|
|
339
|
-
* Request parameters for getOrderAddress operation in
|
|
369
|
+
* Request parameters for getOrderAddress operation in OrdersApi.
|
|
340
370
|
* @export
|
|
341
|
-
* @interface
|
|
371
|
+
* @interface OrdersApiGetOrderAddressRequest
|
|
342
372
|
*/
|
|
343
|
-
export interface
|
|
373
|
+
export interface OrdersApiGetOrderAddressRequest {
|
|
344
374
|
/**
|
|
345
375
|
* An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
346
376
|
* @type {string}
|
|
347
|
-
* @memberof
|
|
377
|
+
* @memberof OrdersApiGetOrderAddress
|
|
348
378
|
*/
|
|
349
379
|
readonly orderId: string;
|
|
350
380
|
}
|
|
351
381
|
/**
|
|
352
|
-
* Request parameters for getOrderBuyerInfo operation in
|
|
382
|
+
* Request parameters for getOrderBuyerInfo operation in OrdersApi.
|
|
353
383
|
* @export
|
|
354
|
-
* @interface
|
|
384
|
+
* @interface OrdersApiGetOrderBuyerInfoRequest
|
|
355
385
|
*/
|
|
356
|
-
export interface
|
|
386
|
+
export interface OrdersApiGetOrderBuyerInfoRequest {
|
|
357
387
|
/**
|
|
358
388
|
* An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
359
389
|
* @type {string}
|
|
360
|
-
* @memberof
|
|
390
|
+
* @memberof OrdersApiGetOrderBuyerInfo
|
|
361
391
|
*/
|
|
362
392
|
readonly orderId: string;
|
|
363
393
|
}
|
|
364
394
|
/**
|
|
365
|
-
* Request parameters for getOrderItems operation in
|
|
395
|
+
* Request parameters for getOrderItems operation in OrdersApi.
|
|
366
396
|
* @export
|
|
367
|
-
* @interface
|
|
397
|
+
* @interface OrdersApiGetOrderItemsRequest
|
|
368
398
|
*/
|
|
369
|
-
export interface
|
|
399
|
+
export interface OrdersApiGetOrderItemsRequest {
|
|
370
400
|
/**
|
|
371
401
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
372
402
|
* @type {string}
|
|
373
|
-
* @memberof
|
|
403
|
+
* @memberof OrdersApiGetOrderItems
|
|
374
404
|
*/
|
|
375
405
|
readonly orderId: string;
|
|
376
406
|
/**
|
|
377
407
|
* A string token returned in the response of your previous request.
|
|
378
408
|
* @type {string}
|
|
379
|
-
* @memberof
|
|
409
|
+
* @memberof OrdersApiGetOrderItems
|
|
380
410
|
*/
|
|
381
411
|
readonly nextToken?: string;
|
|
382
412
|
}
|
|
383
413
|
/**
|
|
384
|
-
* Request parameters for getOrderItemsBuyerInfo operation in
|
|
414
|
+
* Request parameters for getOrderItemsBuyerInfo operation in OrdersApi.
|
|
385
415
|
* @export
|
|
386
|
-
* @interface
|
|
416
|
+
* @interface OrdersApiGetOrderItemsBuyerInfoRequest
|
|
387
417
|
*/
|
|
388
|
-
export interface
|
|
418
|
+
export interface OrdersApiGetOrderItemsBuyerInfoRequest {
|
|
389
419
|
/**
|
|
390
420
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
391
421
|
* @type {string}
|
|
392
|
-
* @memberof
|
|
422
|
+
* @memberof OrdersApiGetOrderItemsBuyerInfo
|
|
393
423
|
*/
|
|
394
424
|
readonly orderId: string;
|
|
395
425
|
/**
|
|
396
426
|
* A string token returned in the response of your previous request.
|
|
397
427
|
* @type {string}
|
|
398
|
-
* @memberof
|
|
428
|
+
* @memberof OrdersApiGetOrderItemsBuyerInfo
|
|
399
429
|
*/
|
|
400
430
|
readonly nextToken?: string;
|
|
401
431
|
}
|
|
402
432
|
/**
|
|
403
|
-
* Request parameters for getOrderRegulatedInfo operation in
|
|
433
|
+
* Request parameters for getOrderRegulatedInfo operation in OrdersApi.
|
|
404
434
|
* @export
|
|
405
|
-
* @interface
|
|
435
|
+
* @interface OrdersApiGetOrderRegulatedInfoRequest
|
|
406
436
|
*/
|
|
407
|
-
export interface
|
|
437
|
+
export interface OrdersApiGetOrderRegulatedInfoRequest {
|
|
408
438
|
/**
|
|
409
439
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
410
440
|
* @type {string}
|
|
411
|
-
* @memberof
|
|
441
|
+
* @memberof OrdersApiGetOrderRegulatedInfo
|
|
412
442
|
*/
|
|
413
443
|
readonly orderId: string;
|
|
414
444
|
}
|
|
415
445
|
/**
|
|
416
|
-
* Request parameters for getOrders operation in
|
|
446
|
+
* Request parameters for getOrders operation in OrdersApi.
|
|
417
447
|
* @export
|
|
418
|
-
* @interface
|
|
448
|
+
* @interface OrdersApiGetOrdersRequest
|
|
419
449
|
*/
|
|
420
|
-
export interface
|
|
450
|
+
export interface OrdersApiGetOrdersRequest {
|
|
421
451
|
/**
|
|
422
452
|
* 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.
|
|
423
453
|
* @type {Array<string>}
|
|
424
|
-
* @memberof
|
|
454
|
+
* @memberof OrdersApiGetOrders
|
|
425
455
|
*/
|
|
426
456
|
readonly marketplaceIds: Array<string>;
|
|
427
457
|
/**
|
|
428
458
|
* 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.
|
|
429
459
|
* @type {string}
|
|
430
|
-
* @memberof
|
|
460
|
+
* @memberof OrdersApiGetOrders
|
|
431
461
|
*/
|
|
432
462
|
readonly createdAfter?: string;
|
|
433
463
|
/**
|
|
434
464
|
* 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.
|
|
435
465
|
* @type {string}
|
|
436
|
-
* @memberof
|
|
466
|
+
* @memberof OrdersApiGetOrders
|
|
437
467
|
*/
|
|
438
468
|
readonly createdBefore?: string;
|
|
439
469
|
/**
|
|
440
470
|
* Use this date to select orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or `CreatedBefore` cannot be set when `LastUpdatedAfter` is set.
|
|
441
471
|
* @type {string}
|
|
442
|
-
* @memberof
|
|
472
|
+
* @memberof OrdersApiGetOrders
|
|
443
473
|
*/
|
|
444
474
|
readonly lastUpdatedAfter?: string;
|
|
445
475
|
/**
|
|
446
476
|
* Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the `LastUpdatedAfter` date and at least two minutes before current time.
|
|
447
477
|
* @type {string}
|
|
448
|
-
* @memberof
|
|
478
|
+
* @memberof OrdersApiGetOrders
|
|
449
479
|
*/
|
|
450
480
|
readonly lastUpdatedBefore?: string;
|
|
451
481
|
/**
|
|
452
482
|
* A list of `OrderStatus` values used to filter the results. **Possible values:** - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.) - `Pending` (The order has been placed but payment has not been authorized.) - `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.) - `PartiallyShipped` (One or more, but not all, items in the order have been shipped.) - `Shipped` (All items in the order have been shipped.) - `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.) - `Canceled` (The order has been canceled.) - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)
|
|
453
483
|
* @type {Array<string>}
|
|
454
|
-
* @memberof
|
|
484
|
+
* @memberof OrdersApiGetOrders
|
|
455
485
|
*/
|
|
456
486
|
readonly orderStatuses?: Array<string>;
|
|
457
487
|
/**
|
|
458
488
|
* A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller).
|
|
459
489
|
* @type {Array<string>}
|
|
460
|
-
* @memberof
|
|
490
|
+
* @memberof OrdersApiGetOrders
|
|
461
491
|
*/
|
|
462
492
|
readonly fulfillmentChannels?: Array<string>;
|
|
463
493
|
/**
|
|
464
494
|
* A list of payment method values. Use this field to select orders that were paid with the specified payment methods. **Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS).
|
|
465
495
|
* @type {Array<string>}
|
|
466
|
-
* @memberof
|
|
496
|
+
* @memberof OrdersApiGetOrders
|
|
467
497
|
*/
|
|
468
498
|
readonly paymentMethods?: Array<string>;
|
|
469
499
|
/**
|
|
470
500
|
* The email address of a buyer. Used to select orders that contain the specified email address.
|
|
471
501
|
* @type {string}
|
|
472
|
-
* @memberof
|
|
502
|
+
* @memberof OrdersApiGetOrders
|
|
473
503
|
*/
|
|
474
504
|
readonly buyerEmail?: string;
|
|
475
505
|
/**
|
|
476
506
|
* An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore, and `BuyerEmail` cannot be specified.
|
|
477
507
|
* @type {string}
|
|
478
|
-
* @memberof
|
|
508
|
+
* @memberof OrdersApiGetOrders
|
|
479
509
|
*/
|
|
480
510
|
readonly sellerOrderId?: string;
|
|
481
511
|
/**
|
|
482
512
|
* A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
|
|
483
513
|
* @type {number}
|
|
484
|
-
* @memberof
|
|
514
|
+
* @memberof OrdersApiGetOrders
|
|
485
515
|
*/
|
|
486
516
|
readonly maxResultsPerPage?: number;
|
|
487
517
|
/**
|
|
488
518
|
* A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.)
|
|
489
519
|
* @type {Array<string>}
|
|
490
|
-
* @memberof
|
|
520
|
+
* @memberof OrdersApiGetOrders
|
|
491
521
|
*/
|
|
492
522
|
readonly easyShipShipmentStatuses?: Array<string>;
|
|
493
523
|
/**
|
|
494
524
|
* A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.)
|
|
495
525
|
* @type {Array<string>}
|
|
496
|
-
* @memberof
|
|
526
|
+
* @memberof OrdersApiGetOrders
|
|
497
527
|
*/
|
|
498
528
|
readonly electronicInvoiceStatuses?: Array<string>;
|
|
499
529
|
/**
|
|
500
530
|
* A string token returned in the response of your previous request.
|
|
501
531
|
* @type {string}
|
|
502
|
-
* @memberof
|
|
532
|
+
* @memberof OrdersApiGetOrders
|
|
503
533
|
*/
|
|
504
534
|
readonly nextToken?: string;
|
|
505
535
|
/**
|
|
506
536
|
* A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
507
537
|
* @type {Array<string>}
|
|
508
|
-
* @memberof
|
|
538
|
+
* @memberof OrdersApiGetOrders
|
|
509
539
|
*/
|
|
510
540
|
readonly amazonOrderIds?: Array<string>;
|
|
511
541
|
/**
|
|
512
542
|
* The `sourceId` of the location from where you want the order fulfilled.
|
|
513
543
|
* @type {string}
|
|
514
|
-
* @memberof
|
|
544
|
+
* @memberof OrdersApiGetOrders
|
|
515
545
|
*/
|
|
516
546
|
readonly actualFulfillmentSupplySourceId?: string;
|
|
517
547
|
/**
|
|
518
548
|
* When true, this order is marked to be picked up from a store rather than delivered.
|
|
519
549
|
* @type {boolean}
|
|
520
|
-
* @memberof
|
|
550
|
+
* @memberof OrdersApiGetOrders
|
|
521
551
|
*/
|
|
522
552
|
readonly isISPU?: boolean;
|
|
523
553
|
/**
|
|
524
554
|
* The store chain store identifier. Linked to a specific store in a store chain.
|
|
525
555
|
* @type {string}
|
|
526
|
-
* @memberof
|
|
556
|
+
* @memberof OrdersApiGetOrders
|
|
527
557
|
*/
|
|
528
558
|
readonly storeChainStoreId?: string;
|
|
529
559
|
/**
|
|
530
560
|
* Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
531
561
|
* @type {string}
|
|
532
|
-
* @memberof
|
|
562
|
+
* @memberof OrdersApiGetOrders
|
|
533
563
|
*/
|
|
534
564
|
readonly earliestDeliveryDateBefore?: string;
|
|
535
565
|
/**
|
|
536
566
|
* Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
537
567
|
* @type {string}
|
|
538
|
-
* @memberof
|
|
568
|
+
* @memberof OrdersApiGetOrders
|
|
539
569
|
*/
|
|
540
570
|
readonly earliestDeliveryDateAfter?: string;
|
|
541
571
|
/**
|
|
542
572
|
* Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
543
573
|
* @type {string}
|
|
544
|
-
* @memberof
|
|
574
|
+
* @memberof OrdersApiGetOrders
|
|
545
575
|
*/
|
|
546
576
|
readonly latestDeliveryDateBefore?: string;
|
|
547
577
|
/**
|
|
548
578
|
* Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
549
579
|
* @type {string}
|
|
550
|
-
* @memberof
|
|
580
|
+
* @memberof OrdersApiGetOrders
|
|
551
581
|
*/
|
|
552
582
|
readonly latestDeliveryDateAfter?: string;
|
|
553
583
|
}
|
|
554
584
|
/**
|
|
555
|
-
* Request parameters for updateShipmentStatus operation in
|
|
585
|
+
* Request parameters for updateShipmentStatus operation in OrdersApi.
|
|
556
586
|
* @export
|
|
557
|
-
* @interface
|
|
587
|
+
* @interface OrdersApiUpdateShipmentStatusRequest
|
|
558
588
|
*/
|
|
559
|
-
export interface
|
|
589
|
+
export interface OrdersApiUpdateShipmentStatusRequest {
|
|
560
590
|
/**
|
|
561
591
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
562
592
|
* @type {string}
|
|
563
|
-
* @memberof
|
|
593
|
+
* @memberof OrdersApiUpdateShipmentStatus
|
|
564
594
|
*/
|
|
565
595
|
readonly orderId: string;
|
|
566
596
|
/**
|
|
567
597
|
* The request body for the `updateShipmentStatus` operation.
|
|
568
598
|
* @type {UpdateShipmentStatusRequest}
|
|
569
|
-
* @memberof
|
|
599
|
+
* @memberof OrdersApiUpdateShipmentStatus
|
|
570
600
|
*/
|
|
571
601
|
readonly payload: UpdateShipmentStatusRequest;
|
|
572
602
|
}
|
|
573
603
|
/**
|
|
574
|
-
* Request parameters for updateVerificationStatus operation in
|
|
604
|
+
* Request parameters for updateVerificationStatus operation in OrdersApi.
|
|
575
605
|
* @export
|
|
576
|
-
* @interface
|
|
606
|
+
* @interface OrdersApiUpdateVerificationStatusRequest
|
|
577
607
|
*/
|
|
578
|
-
export interface
|
|
608
|
+
export interface OrdersApiUpdateVerificationStatusRequest {
|
|
579
609
|
/**
|
|
580
610
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
581
611
|
* @type {string}
|
|
582
|
-
* @memberof
|
|
612
|
+
* @memberof OrdersApiUpdateVerificationStatus
|
|
583
613
|
*/
|
|
584
614
|
readonly orderId: string;
|
|
585
615
|
/**
|
|
586
616
|
* The request body for the `updateVerificationStatus` operation.
|
|
587
617
|
* @type {UpdateVerificationStatusRequest}
|
|
588
|
-
* @memberof
|
|
618
|
+
* @memberof OrdersApiUpdateVerificationStatus
|
|
589
619
|
*/
|
|
590
620
|
readonly payload: UpdateVerificationStatusRequest;
|
|
591
621
|
}
|
|
592
622
|
/**
|
|
593
|
-
*
|
|
623
|
+
* OrdersApi - object-oriented interface
|
|
594
624
|
* @export
|
|
595
|
-
* @class
|
|
625
|
+
* @class OrdersApi
|
|
596
626
|
* @extends {BaseAPI}
|
|
597
627
|
*/
|
|
598
|
-
export declare class
|
|
628
|
+
export declare class OrdersApi extends BaseAPI {
|
|
599
629
|
/**
|
|
600
630
|
* 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).
|
|
601
|
-
* @
|
|
631
|
+
* @summary confirmShipment
|
|
632
|
+
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
602
633
|
* @param {*} [options] Override http request option.
|
|
603
634
|
* @throws {RequiredError}
|
|
604
|
-
* @memberof
|
|
635
|
+
* @memberof OrdersApi
|
|
605
636
|
*/
|
|
606
|
-
confirmShipment(requestParameters:
|
|
637
|
+
confirmShipment(requestParameters: OrdersApiConfirmShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
607
638
|
/**
|
|
608
639
|
* 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).
|
|
609
|
-
* @
|
|
640
|
+
* @summary getOrder
|
|
641
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
610
642
|
* @param {*} [options] Override http request option.
|
|
611
643
|
* @throws {RequiredError}
|
|
612
|
-
* @memberof
|
|
644
|
+
* @memberof OrdersApi
|
|
613
645
|
*/
|
|
614
|
-
getOrder(requestParameters:
|
|
646
|
+
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderResponse, any>>;
|
|
615
647
|
/**
|
|
616
648
|
* 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).
|
|
617
|
-
* @
|
|
649
|
+
* @summary getOrderAddress
|
|
650
|
+
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
618
651
|
* @param {*} [options] Override http request option.
|
|
619
652
|
* @throws {RequiredError}
|
|
620
|
-
* @memberof
|
|
653
|
+
* @memberof OrdersApi
|
|
621
654
|
*/
|
|
622
|
-
getOrderAddress(requestParameters:
|
|
655
|
+
getOrderAddress(requestParameters: OrdersApiGetOrderAddressRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderAddressResponse, any>>;
|
|
623
656
|
/**
|
|
624
657
|
* 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).
|
|
625
|
-
* @
|
|
658
|
+
* @summary getOrderBuyerInfo
|
|
659
|
+
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
626
660
|
* @param {*} [options] Override http request option.
|
|
627
661
|
* @throws {RequiredError}
|
|
628
|
-
* @memberof
|
|
662
|
+
* @memberof OrdersApi
|
|
629
663
|
*/
|
|
630
|
-
getOrderBuyerInfo(requestParameters:
|
|
664
|
+
getOrderBuyerInfo(requestParameters: OrdersApiGetOrderBuyerInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderBuyerInfoResponse, any>>;
|
|
631
665
|
/**
|
|
632
666
|
* 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).
|
|
633
|
-
* @
|
|
667
|
+
* @summary getOrderItems
|
|
668
|
+
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
634
669
|
* @param {*} [options] Override http request option.
|
|
635
670
|
* @throws {RequiredError}
|
|
636
|
-
* @memberof
|
|
671
|
+
* @memberof OrdersApi
|
|
637
672
|
*/
|
|
638
|
-
getOrderItems(requestParameters:
|
|
673
|
+
getOrderItems(requestParameters: OrdersApiGetOrderItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderItemsResponse, any>>;
|
|
639
674
|
/**
|
|
640
675
|
* 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).
|
|
641
|
-
* @
|
|
676
|
+
* @summary getOrderItemsBuyerInfo
|
|
677
|
+
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
642
678
|
* @param {*} [options] Override http request option.
|
|
643
679
|
* @throws {RequiredError}
|
|
644
|
-
* @memberof
|
|
680
|
+
* @memberof OrdersApi
|
|
645
681
|
*/
|
|
646
|
-
getOrderItemsBuyerInfo(requestParameters:
|
|
682
|
+
getOrderItemsBuyerInfo(requestParameters: OrdersApiGetOrderItemsBuyerInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderItemsBuyerInfoResponse, any>>;
|
|
647
683
|
/**
|
|
648
684
|
* 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).
|
|
649
|
-
* @
|
|
685
|
+
* @summary getOrderRegulatedInfo
|
|
686
|
+
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
650
687
|
* @param {*} [options] Override http request option.
|
|
651
688
|
* @throws {RequiredError}
|
|
652
|
-
* @memberof
|
|
689
|
+
* @memberof OrdersApi
|
|
653
690
|
*/
|
|
654
|
-
getOrderRegulatedInfo(requestParameters:
|
|
691
|
+
getOrderRegulatedInfo(requestParameters: OrdersApiGetOrderRegulatedInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderRegulatedInfoResponse, any>>;
|
|
655
692
|
/**
|
|
656
693
|
* 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.
|
|
657
|
-
* @
|
|
694
|
+
* @summary getOrders
|
|
695
|
+
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
658
696
|
* @param {*} [options] Override http request option.
|
|
659
697
|
* @throws {RequiredError}
|
|
660
|
-
* @memberof
|
|
698
|
+
* @memberof OrdersApi
|
|
661
699
|
*/
|
|
662
|
-
getOrders(requestParameters:
|
|
700
|
+
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrdersResponse, any>>;
|
|
663
701
|
/**
|
|
664
702
|
* 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).
|
|
665
|
-
* @
|
|
703
|
+
* @summary updateShipmentStatus
|
|
704
|
+
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
666
705
|
* @param {*} [options] Override http request option.
|
|
667
706
|
* @throws {RequiredError}
|
|
668
|
-
* @memberof
|
|
707
|
+
* @memberof OrdersApi
|
|
669
708
|
*/
|
|
670
|
-
updateShipmentStatus(requestParameters:
|
|
709
|
+
updateShipmentStatus(requestParameters: OrdersApiUpdateShipmentStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
671
710
|
/**
|
|
672
711
|
* 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).
|
|
673
|
-
* @
|
|
712
|
+
* @summary updateVerificationStatus
|
|
713
|
+
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
674
714
|
* @param {*} [options] Override http request option.
|
|
675
715
|
* @throws {RequiredError}
|
|
676
|
-
* @memberof
|
|
716
|
+
* @memberof OrdersApi
|
|
677
717
|
*/
|
|
678
|
-
updateVerificationStatus(requestParameters:
|
|
718
|
+
updateVerificationStatus(requestParameters: OrdersApiUpdateVerificationStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
679
719
|
}
|