@sp-api-sdk/orders-api-v0 4.1.2 → 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-v0-api.js → orders-api.js} +114 -114
- package/dist/cjs/api-model/api.js +1 -1
- package/dist/cjs/api-model/models/index.js +0 -1
- package/dist/cjs/client.js +1 -1
- package/dist/es/api-model/api/{orders-v0-api.js → orders-api.js} +109 -109
- package/dist/es/api-model/api.js +1 -1
- package/dist/es/api-model/models/index.js +0 -1
- package/dist/es/client.js +2 -2
- package/dist/types/api-model/api/{orders-v0-api.d.ts → orders-api.d.ts} +177 -177
- package/dist/types/api-model/api.d.ts +1 -1
- 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/dist/types/client.d.ts +2 -2
- 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
|
@@ -24,12 +24,12 @@ 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
|
-
* 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 OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
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 OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
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 OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
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 OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
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 OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
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}
|
|
@@ -126,12 +126,12 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
126
126
|
updateVerificationStatus: (orderId: string, payload: UpdateVerificationStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
127
127
|
};
|
|
128
128
|
/**
|
|
129
|
-
*
|
|
129
|
+
* OrdersApi - functional programming interface
|
|
130
130
|
* @export
|
|
131
131
|
*/
|
|
132
|
-
export declare const
|
|
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 OrdersV0ApiFp: (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 OrdersV0ApiFp: (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 OrdersV0ApiFp: (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 OrdersV0ApiFp: (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 OrdersV0ApiFp: (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}
|
|
@@ -228,452 +228,452 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
228
228
|
updateVerificationStatus(orderId: string, payload: UpdateVerificationStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
229
229
|
};
|
|
230
230
|
/**
|
|
231
|
-
*
|
|
231
|
+
* OrdersApi - factory interface
|
|
232
232
|
* @export
|
|
233
233
|
*/
|
|
234
|
-
export declare const
|
|
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
|
|
237
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
238
238
|
* @param {*} [options] Override http request option.
|
|
239
239
|
* @throws {RequiredError}
|
|
240
240
|
*/
|
|
241
|
-
confirmShipment(requestParameters:
|
|
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
|
|
244
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
245
245
|
* @param {*} [options] Override http request option.
|
|
246
246
|
* @throws {RequiredError}
|
|
247
247
|
*/
|
|
248
|
-
getOrder(requestParameters:
|
|
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
|
|
251
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
252
252
|
* @param {*} [options] Override http request option.
|
|
253
253
|
* @throws {RequiredError}
|
|
254
254
|
*/
|
|
255
|
-
getOrderAddress(requestParameters:
|
|
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
|
|
258
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
259
259
|
* @param {*} [options] Override http request option.
|
|
260
260
|
* @throws {RequiredError}
|
|
261
261
|
*/
|
|
262
|
-
getOrderBuyerInfo(requestParameters:
|
|
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
|
|
265
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
266
266
|
* @param {*} [options] Override http request option.
|
|
267
267
|
* @throws {RequiredError}
|
|
268
268
|
*/
|
|
269
|
-
getOrderItems(requestParameters:
|
|
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
|
|
272
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
273
273
|
* @param {*} [options] Override http request option.
|
|
274
274
|
* @throws {RequiredError}
|
|
275
275
|
*/
|
|
276
|
-
getOrderItemsBuyerInfo(requestParameters:
|
|
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
|
|
279
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
280
280
|
* @param {*} [options] Override http request option.
|
|
281
281
|
* @throws {RequiredError}
|
|
282
282
|
*/
|
|
283
|
-
getOrderRegulatedInfo(requestParameters:
|
|
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
|
|
286
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
287
287
|
* @param {*} [options] Override http request option.
|
|
288
288
|
* @throws {RequiredError}
|
|
289
289
|
*/
|
|
290
|
-
getOrders(requestParameters:
|
|
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
|
|
293
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
294
294
|
* @param {*} [options] Override http request option.
|
|
295
295
|
* @throws {RequiredError}
|
|
296
296
|
*/
|
|
297
|
-
updateShipmentStatus(requestParameters:
|
|
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
|
|
300
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
301
301
|
* @param {*} [options] Override http request option.
|
|
302
302
|
* @throws {RequiredError}
|
|
303
303
|
*/
|
|
304
|
-
updateVerificationStatus(requestParameters:
|
|
304
|
+
updateVerificationStatus(requestParameters: OrdersApiUpdateVerificationStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
305
305
|
};
|
|
306
306
|
/**
|
|
307
|
-
* Request parameters for confirmShipment operation in
|
|
307
|
+
* Request parameters for confirmShipment operation in OrdersApi.
|
|
308
308
|
* @export
|
|
309
|
-
* @interface
|
|
309
|
+
* @interface OrdersApiConfirmShipmentRequest
|
|
310
310
|
*/
|
|
311
|
-
export interface
|
|
311
|
+
export interface OrdersApiConfirmShipmentRequest {
|
|
312
312
|
/**
|
|
313
313
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
314
314
|
* @type {string}
|
|
315
|
-
* @memberof
|
|
315
|
+
* @memberof OrdersApiConfirmShipment
|
|
316
316
|
*/
|
|
317
317
|
readonly orderId: string;
|
|
318
318
|
/**
|
|
319
319
|
* Request body of `confirmShipment`.
|
|
320
320
|
* @type {ConfirmShipmentRequest}
|
|
321
|
-
* @memberof
|
|
321
|
+
* @memberof OrdersApiConfirmShipment
|
|
322
322
|
*/
|
|
323
323
|
readonly payload: ConfirmShipmentRequest;
|
|
324
324
|
}
|
|
325
325
|
/**
|
|
326
|
-
* Request parameters for getOrder operation in
|
|
326
|
+
* Request parameters for getOrder operation in OrdersApi.
|
|
327
327
|
* @export
|
|
328
|
-
* @interface
|
|
328
|
+
* @interface OrdersApiGetOrderRequest
|
|
329
329
|
*/
|
|
330
|
-
export interface
|
|
330
|
+
export interface OrdersApiGetOrderRequest {
|
|
331
331
|
/**
|
|
332
332
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
333
333
|
* @type {string}
|
|
334
|
-
* @memberof
|
|
334
|
+
* @memberof OrdersApiGetOrder
|
|
335
335
|
*/
|
|
336
336
|
readonly orderId: string;
|
|
337
337
|
}
|
|
338
338
|
/**
|
|
339
|
-
* Request parameters for getOrderAddress operation in
|
|
339
|
+
* Request parameters for getOrderAddress operation in OrdersApi.
|
|
340
340
|
* @export
|
|
341
|
-
* @interface
|
|
341
|
+
* @interface OrdersApiGetOrderAddressRequest
|
|
342
342
|
*/
|
|
343
|
-
export interface
|
|
343
|
+
export interface OrdersApiGetOrderAddressRequest {
|
|
344
344
|
/**
|
|
345
|
-
*
|
|
345
|
+
* The Amazon order identifier in 3-7-7 format.
|
|
346
346
|
* @type {string}
|
|
347
|
-
* @memberof
|
|
347
|
+
* @memberof OrdersApiGetOrderAddress
|
|
348
348
|
*/
|
|
349
349
|
readonly orderId: string;
|
|
350
350
|
}
|
|
351
351
|
/**
|
|
352
|
-
* Request parameters for getOrderBuyerInfo operation in
|
|
352
|
+
* Request parameters for getOrderBuyerInfo operation in OrdersApi.
|
|
353
353
|
* @export
|
|
354
|
-
* @interface
|
|
354
|
+
* @interface OrdersApiGetOrderBuyerInfoRequest
|
|
355
355
|
*/
|
|
356
|
-
export interface
|
|
356
|
+
export interface OrdersApiGetOrderBuyerInfoRequest {
|
|
357
357
|
/**
|
|
358
|
-
*
|
|
358
|
+
* The Amazon order identifier in 3-7-7 format.
|
|
359
359
|
* @type {string}
|
|
360
|
-
* @memberof
|
|
360
|
+
* @memberof OrdersApiGetOrderBuyerInfo
|
|
361
361
|
*/
|
|
362
362
|
readonly orderId: string;
|
|
363
363
|
}
|
|
364
364
|
/**
|
|
365
|
-
* Request parameters for getOrderItems operation in
|
|
365
|
+
* Request parameters for getOrderItems operation in OrdersApi.
|
|
366
366
|
* @export
|
|
367
|
-
* @interface
|
|
367
|
+
* @interface OrdersApiGetOrderItemsRequest
|
|
368
368
|
*/
|
|
369
|
-
export interface
|
|
369
|
+
export interface OrdersApiGetOrderItemsRequest {
|
|
370
370
|
/**
|
|
371
371
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
372
372
|
* @type {string}
|
|
373
|
-
* @memberof
|
|
373
|
+
* @memberof OrdersApiGetOrderItems
|
|
374
374
|
*/
|
|
375
375
|
readonly orderId: string;
|
|
376
376
|
/**
|
|
377
377
|
* A string token returned in the response of your previous request.
|
|
378
378
|
* @type {string}
|
|
379
|
-
* @memberof
|
|
379
|
+
* @memberof OrdersApiGetOrderItems
|
|
380
380
|
*/
|
|
381
381
|
readonly nextToken?: string;
|
|
382
382
|
}
|
|
383
383
|
/**
|
|
384
|
-
* Request parameters for getOrderItemsBuyerInfo operation in
|
|
384
|
+
* Request parameters for getOrderItemsBuyerInfo operation in OrdersApi.
|
|
385
385
|
* @export
|
|
386
|
-
* @interface
|
|
386
|
+
* @interface OrdersApiGetOrderItemsBuyerInfoRequest
|
|
387
387
|
*/
|
|
388
|
-
export interface
|
|
388
|
+
export interface OrdersApiGetOrderItemsBuyerInfoRequest {
|
|
389
389
|
/**
|
|
390
390
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
391
391
|
* @type {string}
|
|
392
|
-
* @memberof
|
|
392
|
+
* @memberof OrdersApiGetOrderItemsBuyerInfo
|
|
393
393
|
*/
|
|
394
394
|
readonly orderId: string;
|
|
395
395
|
/**
|
|
396
396
|
* A string token returned in the response of your previous request.
|
|
397
397
|
* @type {string}
|
|
398
|
-
* @memberof
|
|
398
|
+
* @memberof OrdersApiGetOrderItemsBuyerInfo
|
|
399
399
|
*/
|
|
400
400
|
readonly nextToken?: string;
|
|
401
401
|
}
|
|
402
402
|
/**
|
|
403
|
-
* Request parameters for getOrderRegulatedInfo operation in
|
|
403
|
+
* Request parameters for getOrderRegulatedInfo operation in OrdersApi.
|
|
404
404
|
* @export
|
|
405
|
-
* @interface
|
|
405
|
+
* @interface OrdersApiGetOrderRegulatedInfoRequest
|
|
406
406
|
*/
|
|
407
|
-
export interface
|
|
407
|
+
export interface OrdersApiGetOrderRegulatedInfoRequest {
|
|
408
408
|
/**
|
|
409
|
-
*
|
|
409
|
+
* The Amazon order identifier in 3-7-7 format.
|
|
410
410
|
* @type {string}
|
|
411
|
-
* @memberof
|
|
411
|
+
* @memberof OrdersApiGetOrderRegulatedInfo
|
|
412
412
|
*/
|
|
413
413
|
readonly orderId: string;
|
|
414
414
|
}
|
|
415
415
|
/**
|
|
416
|
-
* Request parameters for getOrders operation in
|
|
416
|
+
* Request parameters for getOrders operation in OrdersApi.
|
|
417
417
|
* @export
|
|
418
|
-
* @interface
|
|
418
|
+
* @interface OrdersApiGetOrdersRequest
|
|
419
419
|
*/
|
|
420
|
-
export interface
|
|
420
|
+
export interface OrdersApiGetOrdersRequest {
|
|
421
421
|
/**
|
|
422
422
|
* 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
423
|
* @type {Array<string>}
|
|
424
|
-
* @memberof
|
|
424
|
+
* @memberof OrdersApiGetOrders
|
|
425
425
|
*/
|
|
426
426
|
readonly marketplaceIds: Array<string>;
|
|
427
427
|
/**
|
|
428
428
|
* 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
429
|
* @type {string}
|
|
430
|
-
* @memberof
|
|
430
|
+
* @memberof OrdersApiGetOrders
|
|
431
431
|
*/
|
|
432
432
|
readonly createdAfter?: string;
|
|
433
433
|
/**
|
|
434
434
|
* 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
435
|
* @type {string}
|
|
436
|
-
* @memberof
|
|
436
|
+
* @memberof OrdersApiGetOrders
|
|
437
437
|
*/
|
|
438
438
|
readonly createdBefore?: string;
|
|
439
439
|
/**
|
|
440
440
|
* 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
441
|
* @type {string}
|
|
442
|
-
* @memberof
|
|
442
|
+
* @memberof OrdersApiGetOrders
|
|
443
443
|
*/
|
|
444
444
|
readonly lastUpdatedAfter?: string;
|
|
445
445
|
/**
|
|
446
446
|
* 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
447
|
* @type {string}
|
|
448
|
-
* @memberof
|
|
448
|
+
* @memberof OrdersApiGetOrders
|
|
449
449
|
*/
|
|
450
450
|
readonly lastUpdatedBefore?: string;
|
|
451
451
|
/**
|
|
452
452
|
* 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
453
|
* @type {Array<string>}
|
|
454
|
-
* @memberof
|
|
454
|
+
* @memberof OrdersApiGetOrders
|
|
455
455
|
*/
|
|
456
456
|
readonly orderStatuses?: Array<string>;
|
|
457
457
|
/**
|
|
458
458
|
* 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
459
|
* @type {Array<string>}
|
|
460
|
-
* @memberof
|
|
460
|
+
* @memberof OrdersApiGetOrders
|
|
461
461
|
*/
|
|
462
462
|
readonly fulfillmentChannels?: Array<string>;
|
|
463
463
|
/**
|
|
464
464
|
* 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
465
|
* @type {Array<string>}
|
|
466
|
-
* @memberof
|
|
466
|
+
* @memberof OrdersApiGetOrders
|
|
467
467
|
*/
|
|
468
468
|
readonly paymentMethods?: Array<string>;
|
|
469
469
|
/**
|
|
470
470
|
* The email address of a buyer. Used to select orders that contain the specified email address.
|
|
471
471
|
* @type {string}
|
|
472
|
-
* @memberof
|
|
472
|
+
* @memberof OrdersApiGetOrders
|
|
473
473
|
*/
|
|
474
474
|
readonly buyerEmail?: string;
|
|
475
475
|
/**
|
|
476
476
|
* 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
477
|
* @type {string}
|
|
478
|
-
* @memberof
|
|
478
|
+
* @memberof OrdersApiGetOrders
|
|
479
479
|
*/
|
|
480
480
|
readonly sellerOrderId?: string;
|
|
481
481
|
/**
|
|
482
482
|
* A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
|
|
483
483
|
* @type {number}
|
|
484
|
-
* @memberof
|
|
484
|
+
* @memberof OrdersApiGetOrders
|
|
485
485
|
*/
|
|
486
486
|
readonly maxResultsPerPage?: number;
|
|
487
487
|
/**
|
|
488
488
|
* 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
489
|
* @type {Array<string>}
|
|
490
|
-
* @memberof
|
|
490
|
+
* @memberof OrdersApiGetOrders
|
|
491
491
|
*/
|
|
492
492
|
readonly easyShipShipmentStatuses?: Array<string>;
|
|
493
493
|
/**
|
|
494
494
|
* 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
495
|
* @type {Array<string>}
|
|
496
|
-
* @memberof
|
|
496
|
+
* @memberof OrdersApiGetOrders
|
|
497
497
|
*/
|
|
498
498
|
readonly electronicInvoiceStatuses?: Array<string>;
|
|
499
499
|
/**
|
|
500
500
|
* A string token returned in the response of your previous request.
|
|
501
501
|
* @type {string}
|
|
502
|
-
* @memberof
|
|
502
|
+
* @memberof OrdersApiGetOrders
|
|
503
503
|
*/
|
|
504
504
|
readonly nextToken?: string;
|
|
505
505
|
/**
|
|
506
506
|
* A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
507
507
|
* @type {Array<string>}
|
|
508
|
-
* @memberof
|
|
508
|
+
* @memberof OrdersApiGetOrders
|
|
509
509
|
*/
|
|
510
510
|
readonly amazonOrderIds?: Array<string>;
|
|
511
511
|
/**
|
|
512
512
|
* The `sourceId` of the location from where you want the order fulfilled.
|
|
513
513
|
* @type {string}
|
|
514
|
-
* @memberof
|
|
514
|
+
* @memberof OrdersApiGetOrders
|
|
515
515
|
*/
|
|
516
516
|
readonly actualFulfillmentSupplySourceId?: string;
|
|
517
517
|
/**
|
|
518
518
|
* When true, this order is marked to be picked up from a store rather than delivered.
|
|
519
519
|
* @type {boolean}
|
|
520
|
-
* @memberof
|
|
520
|
+
* @memberof OrdersApiGetOrders
|
|
521
521
|
*/
|
|
522
522
|
readonly isISPU?: boolean;
|
|
523
523
|
/**
|
|
524
524
|
* The store chain store identifier. Linked to a specific store in a store chain.
|
|
525
525
|
* @type {string}
|
|
526
|
-
* @memberof
|
|
526
|
+
* @memberof OrdersApiGetOrders
|
|
527
527
|
*/
|
|
528
528
|
readonly storeChainStoreId?: string;
|
|
529
529
|
/**
|
|
530
530
|
* 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
531
|
* @type {string}
|
|
532
|
-
* @memberof
|
|
532
|
+
* @memberof OrdersApiGetOrders
|
|
533
533
|
*/
|
|
534
534
|
readonly earliestDeliveryDateBefore?: string;
|
|
535
535
|
/**
|
|
536
536
|
* 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
537
|
* @type {string}
|
|
538
|
-
* @memberof
|
|
538
|
+
* @memberof OrdersApiGetOrders
|
|
539
539
|
*/
|
|
540
540
|
readonly earliestDeliveryDateAfter?: string;
|
|
541
541
|
/**
|
|
542
542
|
* 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
543
|
* @type {string}
|
|
544
|
-
* @memberof
|
|
544
|
+
* @memberof OrdersApiGetOrders
|
|
545
545
|
*/
|
|
546
546
|
readonly latestDeliveryDateBefore?: string;
|
|
547
547
|
/**
|
|
548
548
|
* 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
549
|
* @type {string}
|
|
550
|
-
* @memberof
|
|
550
|
+
* @memberof OrdersApiGetOrders
|
|
551
551
|
*/
|
|
552
552
|
readonly latestDeliveryDateAfter?: string;
|
|
553
553
|
}
|
|
554
554
|
/**
|
|
555
|
-
* Request parameters for updateShipmentStatus operation in
|
|
555
|
+
* Request parameters for updateShipmentStatus operation in OrdersApi.
|
|
556
556
|
* @export
|
|
557
|
-
* @interface
|
|
557
|
+
* @interface OrdersApiUpdateShipmentStatusRequest
|
|
558
558
|
*/
|
|
559
|
-
export interface
|
|
559
|
+
export interface OrdersApiUpdateShipmentStatusRequest {
|
|
560
560
|
/**
|
|
561
561
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
562
562
|
* @type {string}
|
|
563
|
-
* @memberof
|
|
563
|
+
* @memberof OrdersApiUpdateShipmentStatus
|
|
564
564
|
*/
|
|
565
565
|
readonly orderId: string;
|
|
566
566
|
/**
|
|
567
567
|
* The request body for the `updateShipmentStatus` operation.
|
|
568
568
|
* @type {UpdateShipmentStatusRequest}
|
|
569
|
-
* @memberof
|
|
569
|
+
* @memberof OrdersApiUpdateShipmentStatus
|
|
570
570
|
*/
|
|
571
571
|
readonly payload: UpdateShipmentStatusRequest;
|
|
572
572
|
}
|
|
573
573
|
/**
|
|
574
|
-
* Request parameters for updateVerificationStatus operation in
|
|
574
|
+
* Request parameters for updateVerificationStatus operation in OrdersApi.
|
|
575
575
|
* @export
|
|
576
|
-
* @interface
|
|
576
|
+
* @interface OrdersApiUpdateVerificationStatusRequest
|
|
577
577
|
*/
|
|
578
|
-
export interface
|
|
578
|
+
export interface OrdersApiUpdateVerificationStatusRequest {
|
|
579
579
|
/**
|
|
580
|
-
*
|
|
580
|
+
* The Amazon order identifier in 3-7-7 format.
|
|
581
581
|
* @type {string}
|
|
582
|
-
* @memberof
|
|
582
|
+
* @memberof OrdersApiUpdateVerificationStatus
|
|
583
583
|
*/
|
|
584
584
|
readonly orderId: string;
|
|
585
585
|
/**
|
|
586
586
|
* The request body for the `updateVerificationStatus` operation.
|
|
587
587
|
* @type {UpdateVerificationStatusRequest}
|
|
588
|
-
* @memberof
|
|
588
|
+
* @memberof OrdersApiUpdateVerificationStatus
|
|
589
589
|
*/
|
|
590
590
|
readonly payload: UpdateVerificationStatusRequest;
|
|
591
591
|
}
|
|
592
592
|
/**
|
|
593
|
-
*
|
|
593
|
+
* OrdersApi - object-oriented interface
|
|
594
594
|
* @export
|
|
595
|
-
* @class
|
|
595
|
+
* @class OrdersApi
|
|
596
596
|
* @extends {BaseAPI}
|
|
597
597
|
*/
|
|
598
|
-
export declare class
|
|
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
|
|
601
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
602
602
|
* @param {*} [options] Override http request option.
|
|
603
603
|
* @throws {RequiredError}
|
|
604
|
-
* @memberof
|
|
604
|
+
* @memberof OrdersApi
|
|
605
605
|
*/
|
|
606
|
-
confirmShipment(requestParameters:
|
|
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
|
|
609
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
610
610
|
* @param {*} [options] Override http request option.
|
|
611
611
|
* @throws {RequiredError}
|
|
612
|
-
* @memberof
|
|
612
|
+
* @memberof OrdersApi
|
|
613
613
|
*/
|
|
614
|
-
getOrder(requestParameters:
|
|
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
|
|
617
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
618
618
|
* @param {*} [options] Override http request option.
|
|
619
619
|
* @throws {RequiredError}
|
|
620
|
-
* @memberof
|
|
620
|
+
* @memberof OrdersApi
|
|
621
621
|
*/
|
|
622
|
-
getOrderAddress(requestParameters:
|
|
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
|
|
625
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
626
626
|
* @param {*} [options] Override http request option.
|
|
627
627
|
* @throws {RequiredError}
|
|
628
|
-
* @memberof
|
|
628
|
+
* @memberof OrdersApi
|
|
629
629
|
*/
|
|
630
|
-
getOrderBuyerInfo(requestParameters:
|
|
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
|
|
633
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
634
634
|
* @param {*} [options] Override http request option.
|
|
635
635
|
* @throws {RequiredError}
|
|
636
|
-
* @memberof
|
|
636
|
+
* @memberof OrdersApi
|
|
637
637
|
*/
|
|
638
|
-
getOrderItems(requestParameters:
|
|
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
|
|
641
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
642
642
|
* @param {*} [options] Override http request option.
|
|
643
643
|
* @throws {RequiredError}
|
|
644
|
-
* @memberof
|
|
644
|
+
* @memberof OrdersApi
|
|
645
645
|
*/
|
|
646
|
-
getOrderItemsBuyerInfo(requestParameters:
|
|
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
|
|
649
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
650
650
|
* @param {*} [options] Override http request option.
|
|
651
651
|
* @throws {RequiredError}
|
|
652
|
-
* @memberof
|
|
652
|
+
* @memberof OrdersApi
|
|
653
653
|
*/
|
|
654
|
-
getOrderRegulatedInfo(requestParameters:
|
|
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
|
|
657
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
658
658
|
* @param {*} [options] Override http request option.
|
|
659
659
|
* @throws {RequiredError}
|
|
660
|
-
* @memberof
|
|
660
|
+
* @memberof OrdersApi
|
|
661
661
|
*/
|
|
662
|
-
getOrders(requestParameters:
|
|
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
|
|
665
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
666
666
|
* @param {*} [options] Override http request option.
|
|
667
667
|
* @throws {RequiredError}
|
|
668
|
-
* @memberof
|
|
668
|
+
* @memberof OrdersApi
|
|
669
669
|
*/
|
|
670
|
-
updateShipmentStatus(requestParameters:
|
|
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
|
|
673
|
-
* @param {
|
|
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
|
+
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
674
674
|
* @param {*} [options] Override http request option.
|
|
675
675
|
* @throws {RequiredError}
|
|
676
|
-
* @memberof
|
|
676
|
+
* @memberof OrdersApi
|
|
677
677
|
*/
|
|
678
|
-
updateVerificationStatus(requestParameters:
|
|
678
|
+
updateVerificationStatus(requestParameters: OrdersApiUpdateVerificationStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
679
679
|
}
|