@sp-api-sdk/orders-api-v0 5.0.0 → 5.1.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-api.js +48 -48
- package/dist/cjs/api-model/models/index.js +0 -1
- package/dist/es/api-model/api/orders-api.js +48 -48
- package/dist/es/api-model/models/index.js +0 -1
- package/dist/types/api-model/api/orders-api.d.ts +52 -52
- package/dist/types/api-model/models/amazon-programs.d.ts +2 -2
- package/dist/types/api-model/models/index.d.ts +0 -1
- package/dist/types/api-model/models/order-item.d.ts +0 -7
- package/dist/types/api-model/models/orders-list.d.ts +1 -1
- package/dist/types/api-model/models/package-detail.d.ts +1 -1
- package/package.json +4 -4
- package/dist/cjs/api-model/models/export-info.js +0 -15
- package/dist/es/api-model/models/export-info.js +0 -14
- package/dist/types/api-model/models/export-info.d.ts +0 -31
|
@@ -29,7 +29,7 @@ import type { UpdateVerificationStatusRequest } from '../models';
|
|
|
29
29
|
*/
|
|
30
30
|
export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
31
31
|
/**
|
|
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
|
|
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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
33
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
34
34
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
35
35
|
* @param {*} [options] Override http request option.
|
|
@@ -37,28 +37,28 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
37
37
|
*/
|
|
38
38
|
confirmShipment: (orderId: string, payload: ConfirmShipmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
39
|
/**
|
|
40
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
40
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
41
41
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
42
42
|
* @param {*} [options] Override http request option.
|
|
43
43
|
* @throws {RequiredError}
|
|
44
44
|
*/
|
|
45
45
|
getOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
/**
|
|
47
|
-
* 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
|
|
48
|
-
* @param {string} orderId
|
|
47
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
48
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
49
49
|
* @param {*} [options] Override http request option.
|
|
50
50
|
* @throws {RequiredError}
|
|
51
51
|
*/
|
|
52
52
|
getOrderAddress: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
53
|
/**
|
|
54
|
-
* 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
|
|
55
|
-
* @param {string} orderId
|
|
54
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
55
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
56
56
|
* @param {*} [options] Override http request option.
|
|
57
57
|
* @throws {RequiredError}
|
|
58
58
|
*/
|
|
59
59
|
getOrderBuyerInfo: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
60
|
/**
|
|
61
|
-
* 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
|
|
61
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
62
62
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
63
63
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +66,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
66
66
|
*/
|
|
67
67
|
getOrderItems: (orderId: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
68
|
/**
|
|
69
|
-
* 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
|
|
69
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
70
70
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
71
71
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
72
72
|
* @param {*} [options] Override http request option.
|
|
@@ -74,14 +74,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
74
74
|
*/
|
|
75
75
|
getOrderItemsBuyerInfo: (orderId: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
76
|
/**
|
|
77
|
-
* 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
|
|
78
|
-
* @param {string} orderId
|
|
77
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
78
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
79
79
|
* @param {*} [options] Override http request option.
|
|
80
80
|
* @throws {RequiredError}
|
|
81
81
|
*/
|
|
82
82
|
getOrderRegulatedInfo: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83
83
|
/**
|
|
84
|
-
* 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
|
|
84
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
85
85
|
* @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
86
|
* @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
87
|
* @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.
|
|
@@ -109,7 +109,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
109
109
|
*/
|
|
110
110
|
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
111
|
/**
|
|
112
|
-
* 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
|
|
112
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
113
113
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
114
114
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
115
115
|
* @param {*} [options] Override http request option.
|
|
@@ -117,8 +117,8 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
117
117
|
*/
|
|
118
118
|
updateShipmentStatus: (orderId: string, payload: UpdateShipmentStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
119
119
|
/**
|
|
120
|
-
* 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
|
|
121
|
-
* @param {string} orderId
|
|
120
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
122
122
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
123
123
|
* @param {*} [options] Override http request option.
|
|
124
124
|
* @throws {RequiredError}
|
|
@@ -131,7 +131,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
131
131
|
*/
|
|
132
132
|
export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
133
133
|
/**
|
|
134
|
-
* 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
|
|
134
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
135
135
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
136
136
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
137
137
|
* @param {*} [options] Override http request option.
|
|
@@ -139,28 +139,28 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
139
139
|
*/
|
|
140
140
|
confirmShipment(orderId: string, payload: ConfirmShipmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
141
141
|
/**
|
|
142
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
142
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
143
143
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
144
144
|
* @param {*} [options] Override http request option.
|
|
145
145
|
* @throws {RequiredError}
|
|
146
146
|
*/
|
|
147
147
|
getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderResponse>>;
|
|
148
148
|
/**
|
|
149
|
-
* 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
|
|
150
|
-
* @param {string} orderId
|
|
149
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
150
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
151
151
|
* @param {*} [options] Override http request option.
|
|
152
152
|
* @throws {RequiredError}
|
|
153
153
|
*/
|
|
154
154
|
getOrderAddress(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderAddressResponse>>;
|
|
155
155
|
/**
|
|
156
|
-
* 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
|
|
157
|
-
* @param {string} orderId
|
|
156
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
157
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
158
158
|
* @param {*} [options] Override http request option.
|
|
159
159
|
* @throws {RequiredError}
|
|
160
160
|
*/
|
|
161
161
|
getOrderBuyerInfo(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderBuyerInfoResponse>>;
|
|
162
162
|
/**
|
|
163
|
-
* 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
|
|
163
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
164
164
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
165
165
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
166
166
|
* @param {*} [options] Override http request option.
|
|
@@ -168,7 +168,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
168
168
|
*/
|
|
169
169
|
getOrderItems(orderId: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsResponse>>;
|
|
170
170
|
/**
|
|
171
|
-
* 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
|
|
171
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
172
172
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
173
173
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
174
174
|
* @param {*} [options] Override http request option.
|
|
@@ -176,14 +176,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
176
176
|
*/
|
|
177
177
|
getOrderItemsBuyerInfo(orderId: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsBuyerInfoResponse>>;
|
|
178
178
|
/**
|
|
179
|
-
* 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
|
|
180
|
-
* @param {string} orderId
|
|
179
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
180
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
181
181
|
* @param {*} [options] Override http request option.
|
|
182
182
|
* @throws {RequiredError}
|
|
183
183
|
*/
|
|
184
184
|
getOrderRegulatedInfo(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderRegulatedInfoResponse>>;
|
|
185
185
|
/**
|
|
186
|
-
* 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
|
|
186
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
187
|
* @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
188
|
* @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
189
|
* @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.
|
|
@@ -211,7 +211,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
211
211
|
*/
|
|
212
212
|
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
213
|
/**
|
|
214
|
-
* 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
|
|
214
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
215
215
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
216
216
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
217
217
|
* @param {*} [options] Override http request option.
|
|
@@ -219,8 +219,8 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
219
219
|
*/
|
|
220
220
|
updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
221
221
|
/**
|
|
222
|
-
* 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
|
|
223
|
-
* @param {string} orderId
|
|
222
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
223
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
224
224
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
225
225
|
* @param {*} [options] Override http request option.
|
|
226
226
|
* @throws {RequiredError}
|
|
@@ -233,70 +233,70 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
233
233
|
*/
|
|
234
234
|
export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
235
235
|
/**
|
|
236
|
-
* 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
|
|
236
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
237
|
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
238
238
|
* @param {*} [options] Override http request option.
|
|
239
239
|
* @throws {RequiredError}
|
|
240
240
|
*/
|
|
241
241
|
confirmShipment(requestParameters: OrdersApiConfirmShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
242
242
|
/**
|
|
243
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
243
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
244
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
245
245
|
* @param {*} [options] Override http request option.
|
|
246
246
|
* @throws {RequiredError}
|
|
247
247
|
*/
|
|
248
248
|
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderResponse>;
|
|
249
249
|
/**
|
|
250
|
-
* 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
|
|
250
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
251
|
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
252
252
|
* @param {*} [options] Override http request option.
|
|
253
253
|
* @throws {RequiredError}
|
|
254
254
|
*/
|
|
255
255
|
getOrderAddress(requestParameters: OrdersApiGetOrderAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderAddressResponse>;
|
|
256
256
|
/**
|
|
257
|
-
* 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
|
|
257
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
258
|
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
259
259
|
* @param {*} [options] Override http request option.
|
|
260
260
|
* @throws {RequiredError}
|
|
261
261
|
*/
|
|
262
262
|
getOrderBuyerInfo(requestParameters: OrdersApiGetOrderBuyerInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderBuyerInfoResponse>;
|
|
263
263
|
/**
|
|
264
|
-
* 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
|
|
264
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
265
|
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
266
266
|
* @param {*} [options] Override http request option.
|
|
267
267
|
* @throws {RequiredError}
|
|
268
268
|
*/
|
|
269
269
|
getOrderItems(requestParameters: OrdersApiGetOrderItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderItemsResponse>;
|
|
270
270
|
/**
|
|
271
|
-
* 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
|
|
271
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
272
|
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
273
273
|
* @param {*} [options] Override http request option.
|
|
274
274
|
* @throws {RequiredError}
|
|
275
275
|
*/
|
|
276
276
|
getOrderItemsBuyerInfo(requestParameters: OrdersApiGetOrderItemsBuyerInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
|
|
277
277
|
/**
|
|
278
|
-
* 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
|
|
278
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
279
|
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
280
280
|
* @param {*} [options] Override http request option.
|
|
281
281
|
* @throws {RequiredError}
|
|
282
282
|
*/
|
|
283
283
|
getOrderRegulatedInfo(requestParameters: OrdersApiGetOrderRegulatedInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderRegulatedInfoResponse>;
|
|
284
284
|
/**
|
|
285
|
-
* 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
|
|
285
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
286
286
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
287
287
|
* @param {*} [options] Override http request option.
|
|
288
288
|
* @throws {RequiredError}
|
|
289
289
|
*/
|
|
290
290
|
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrdersResponse>;
|
|
291
291
|
/**
|
|
292
|
-
* 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
|
|
292
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
293
|
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
294
294
|
* @param {*} [options] Override http request option.
|
|
295
295
|
* @throws {RequiredError}
|
|
296
296
|
*/
|
|
297
297
|
updateShipmentStatus(requestParameters: OrdersApiUpdateShipmentStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
298
298
|
/**
|
|
299
|
-
* 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
|
|
299
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
300
|
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
301
301
|
* @param {*} [options] Override http request option.
|
|
302
302
|
* @throws {RequiredError}
|
|
@@ -342,7 +342,7 @@ export interface OrdersApiGetOrderRequest {
|
|
|
342
342
|
*/
|
|
343
343
|
export interface OrdersApiGetOrderAddressRequest {
|
|
344
344
|
/**
|
|
345
|
-
*
|
|
345
|
+
* The Amazon order identifier in 3-7-7 format.
|
|
346
346
|
* @type {string}
|
|
347
347
|
* @memberof OrdersApiGetOrderAddress
|
|
348
348
|
*/
|
|
@@ -355,7 +355,7 @@ export interface OrdersApiGetOrderAddressRequest {
|
|
|
355
355
|
*/
|
|
356
356
|
export interface OrdersApiGetOrderBuyerInfoRequest {
|
|
357
357
|
/**
|
|
358
|
-
*
|
|
358
|
+
* The Amazon order identifier in 3-7-7 format.
|
|
359
359
|
* @type {string}
|
|
360
360
|
* @memberof OrdersApiGetOrderBuyerInfo
|
|
361
361
|
*/
|
|
@@ -406,7 +406,7 @@ export interface OrdersApiGetOrderItemsBuyerInfoRequest {
|
|
|
406
406
|
*/
|
|
407
407
|
export interface OrdersApiGetOrderRegulatedInfoRequest {
|
|
408
408
|
/**
|
|
409
|
-
*
|
|
409
|
+
* The Amazon order identifier in 3-7-7 format.
|
|
410
410
|
* @type {string}
|
|
411
411
|
* @memberof OrdersApiGetOrderRegulatedInfo
|
|
412
412
|
*/
|
|
@@ -577,7 +577,7 @@ export interface OrdersApiUpdateShipmentStatusRequest {
|
|
|
577
577
|
*/
|
|
578
578
|
export interface OrdersApiUpdateVerificationStatusRequest {
|
|
579
579
|
/**
|
|
580
|
-
*
|
|
580
|
+
* The Amazon order identifier in 3-7-7 format.
|
|
581
581
|
* @type {string}
|
|
582
582
|
* @memberof OrdersApiUpdateVerificationStatus
|
|
583
583
|
*/
|
|
@@ -597,7 +597,7 @@ export interface OrdersApiUpdateVerificationStatusRequest {
|
|
|
597
597
|
*/
|
|
598
598
|
export declare class OrdersApi extends BaseAPI {
|
|
599
599
|
/**
|
|
600
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
600
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
601
|
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
602
602
|
* @param {*} [options] Override http request option.
|
|
603
603
|
* @throws {RequiredError}
|
|
@@ -605,7 +605,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
605
605
|
*/
|
|
606
606
|
confirmShipment(requestParameters: OrdersApiConfirmShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
607
607
|
/**
|
|
608
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
608
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
609
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
610
610
|
* @param {*} [options] Override http request option.
|
|
611
611
|
* @throws {RequiredError}
|
|
@@ -613,7 +613,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
613
613
|
*/
|
|
614
614
|
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderResponse, any>>;
|
|
615
615
|
/**
|
|
616
|
-
* 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
|
|
616
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
617
617
|
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
618
618
|
* @param {*} [options] Override http request option.
|
|
619
619
|
* @throws {RequiredError}
|
|
@@ -621,7 +621,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
621
621
|
*/
|
|
622
622
|
getOrderAddress(requestParameters: OrdersApiGetOrderAddressRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderAddressResponse, any>>;
|
|
623
623
|
/**
|
|
624
|
-
* 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
|
|
624
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
625
|
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
626
626
|
* @param {*} [options] Override http request option.
|
|
627
627
|
* @throws {RequiredError}
|
|
@@ -629,7 +629,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
629
629
|
*/
|
|
630
630
|
getOrderBuyerInfo(requestParameters: OrdersApiGetOrderBuyerInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderBuyerInfoResponse, any>>;
|
|
631
631
|
/**
|
|
632
|
-
* 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
|
|
632
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
633
|
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
634
634
|
* @param {*} [options] Override http request option.
|
|
635
635
|
* @throws {RequiredError}
|
|
@@ -637,7 +637,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
637
637
|
*/
|
|
638
638
|
getOrderItems(requestParameters: OrdersApiGetOrderItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderItemsResponse, any>>;
|
|
639
639
|
/**
|
|
640
|
-
* 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
|
|
640
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
641
|
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
642
642
|
* @param {*} [options] Override http request option.
|
|
643
643
|
* @throws {RequiredError}
|
|
@@ -645,7 +645,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
645
645
|
*/
|
|
646
646
|
getOrderItemsBuyerInfo(requestParameters: OrdersApiGetOrderItemsBuyerInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderItemsBuyerInfoResponse, any>>;
|
|
647
647
|
/**
|
|
648
|
-
* 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
|
|
648
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
649
|
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
650
650
|
* @param {*} [options] Override http request option.
|
|
651
651
|
* @throws {RequiredError}
|
|
@@ -653,7 +653,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
653
653
|
*/
|
|
654
654
|
getOrderRegulatedInfo(requestParameters: OrdersApiGetOrderRegulatedInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderRegulatedInfoResponse, any>>;
|
|
655
655
|
/**
|
|
656
|
-
* 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
|
|
656
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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).
|
|
657
657
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
658
658
|
* @param {*} [options] Override http request option.
|
|
659
659
|
* @throws {RequiredError}
|
|
@@ -661,7 +661,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
661
661
|
*/
|
|
662
662
|
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrdersResponse, any>>;
|
|
663
663
|
/**
|
|
664
|
-
* 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
|
|
664
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
665
|
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
666
666
|
* @param {*} [options] Override http request option.
|
|
667
667
|
* @throws {RequiredError}
|
|
@@ -669,7 +669,7 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
669
669
|
*/
|
|
670
670
|
updateShipmentStatus(requestParameters: OrdersApiUpdateShipmentStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
671
671
|
/**
|
|
672
|
-
* 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
|
|
672
|
+
* 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than 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
673
|
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
674
674
|
* @param {*} [options] Override http request option.
|
|
675
675
|
* @throws {RequiredError}
|
|
@@ -10,13 +10,13 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* Contains the list of programs that
|
|
13
|
+
* Contains the list of programs that Amazon associates with an item. Possible programs are: - **Subscribe and Save**: Offers recurring, scheduled deliveries to Amazon customers and Amazon Business customers for their frequently ordered products. - **FBM Ship+**: Unlocks expedited shipping without the extra cost. Helps you to provide accurate and fast delivery dates to Amazon customers. You also receive protection from late deliveries, a discount on expedited shipping rates, and cash back when you ship.
|
|
14
14
|
* @export
|
|
15
15
|
* @interface AmazonPrograms
|
|
16
16
|
*/
|
|
17
17
|
export interface AmazonPrograms {
|
|
18
18
|
/**
|
|
19
|
-
* A list of the programs that
|
|
19
|
+
* A list of the programs that Amazon associates with the order item. **Possible values**: `SUBSCRIBE_AND_SAVE`, `FBM_SHIP_PLUS`
|
|
20
20
|
* @type {Array<string>}
|
|
21
21
|
* @memberof AmazonPrograms
|
|
22
22
|
*/
|
|
@@ -18,7 +18,6 @@ export * from './delivery-preferences';
|
|
|
18
18
|
export * from './easy-ship-shipment-status';
|
|
19
19
|
export * from './electronic-invoice-status';
|
|
20
20
|
export * from './exception-dates';
|
|
21
|
-
export * from './export-info';
|
|
22
21
|
export * from './fulfillment-instruction';
|
|
23
22
|
export * from './get-order-address-response';
|
|
24
23
|
export * from './get-order-buyer-info-response';
|
|
@@ -12,7 +12,6 @@
|
|
|
12
12
|
import type { AmazonPrograms } from './amazon-programs';
|
|
13
13
|
import type { AssociatedItem } from './associated-item';
|
|
14
14
|
import type { BuyerRequestedCancel } from './buyer-requested-cancel';
|
|
15
|
-
import type { ExportInfo } from './export-info';
|
|
16
15
|
import type { ItemBuyerInfo } from './item-buyer-info';
|
|
17
16
|
import type { Measurement } from './measurement';
|
|
18
17
|
import type { Money } from './money';
|
|
@@ -267,12 +266,6 @@ export interface OrderItem {
|
|
|
267
266
|
* @memberof OrderItem
|
|
268
267
|
*/
|
|
269
268
|
'AmazonPrograms'?: AmazonPrograms;
|
|
270
|
-
/**
|
|
271
|
-
*
|
|
272
|
-
* @type {ExportInfo}
|
|
273
|
-
* @memberof OrderItem
|
|
274
|
-
*/
|
|
275
|
-
'ExportInfo'?: ExportInfo;
|
|
276
269
|
}
|
|
277
270
|
export declare const OrderItemDeemedResellerCategoryEnum: {
|
|
278
271
|
readonly Ioss: "IOSS";
|
|
@@ -29,7 +29,7 @@ export interface OrdersList {
|
|
|
29
29
|
*/
|
|
30
30
|
'NextToken'?: string;
|
|
31
31
|
/**
|
|
32
|
-
* 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.
|
|
32
|
+
* 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. Use [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format for all dates.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof OrdersList
|
|
35
35
|
*/
|
|
@@ -29,7 +29,7 @@ export interface PackageDetail {
|
|
|
29
29
|
*/
|
|
30
30
|
'carrierCode': string;
|
|
31
31
|
/**
|
|
32
|
-
* Carrier
|
|
32
|
+
* Carrier name that will deliver the package. Required when `carrierCode` is \"Other\"
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof PackageDetail
|
|
35
35
|
*/
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/orders-api-v0",
|
|
3
3
|
"author": "Bertrand Marron <bertrand@bizon.solutions>",
|
|
4
4
|
"description": "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).",
|
|
5
|
-
"version": "5.
|
|
5
|
+
"version": "5.1.0",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
"dist/**/*.d.ts"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@sp-api-sdk/common": "2.1.
|
|
22
|
-
"axios": "^1.
|
|
21
|
+
"@sp-api-sdk/common": "2.1.15",
|
|
22
|
+
"axios": "^1.10.0"
|
|
23
23
|
},
|
|
24
24
|
"repository": {
|
|
25
25
|
"type": "git",
|
|
@@ -40,5 +40,5 @@
|
|
|
40
40
|
"sp sdk",
|
|
41
41
|
"orders api"
|
|
42
42
|
],
|
|
43
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "b36600f33d62a2b6c3a9035968a93bc83e9838a9"
|
|
44
44
|
}
|