@sp-api-sdk/orders-api-v0 1.12.3 → 1.13.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/src/api-model/api/orders-v0-api.js +36 -36
- package/dist/cjs/src/api-model/models/index.js +1 -0
- package/dist/cjs/src/api-model/models/regulated-order-verification-status.js +0 -13
- package/dist/cjs/src/api-model/models/update-verification-status-request-body.js +0 -10
- package/dist/cjs/src/api-model/models/verification-status.js +29 -0
- package/dist/cjs/src/client.js +19 -12
- package/dist/es/src/api-model/api/orders-v0-api.js +36 -36
- package/dist/es/src/api-model/models/index.js +1 -0
- package/dist/es/src/api-model/models/regulated-order-verification-status.js +1 -12
- package/dist/es/src/api-model/models/update-verification-status-request-body.js +1 -9
- package/dist/es/src/api-model/models/verification-status.js +26 -0
- package/dist/es/src/client.js +19 -12
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +36 -36
- package/dist/types/src/api-model/models/buyer-requested-cancel.d.ts +1 -1
- package/dist/types/src/api-model/models/index.d.ts +1 -0
- package/dist/types/src/api-model/models/order.d.ts +6 -0
- package/dist/types/src/api-model/models/regulated-order-verification-status.d.ts +4 -14
- package/dist/types/src/api-model/models/update-verification-status-request-body.d.ts +4 -11
- package/dist/types/src/api-model/models/verification-status.d.ts +23 -0
- package/package.json +4 -4
|
@@ -27,28 +27,28 @@ import { UpdateVerificationStatusRequest } from '../models';
|
|
|
27
27
|
*/
|
|
28
28
|
export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
29
29
|
/**
|
|
30
|
-
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
30
|
+
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
31
31
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
32
32
|
* @param {*} [options] Override http request option.
|
|
33
33
|
* @throws {RequiredError}
|
|
34
34
|
*/
|
|
35
35
|
getOrder: (orderId: string, options?: any) => Promise<RequestArgs>;
|
|
36
36
|
/**
|
|
37
|
-
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
37
|
+
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
38
38
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
39
39
|
* @param {*} [options] Override http request option.
|
|
40
40
|
* @throws {RequiredError}
|
|
41
41
|
*/
|
|
42
42
|
getOrderAddress: (orderId: string, options?: any) => Promise<RequestArgs>;
|
|
43
43
|
/**
|
|
44
|
-
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
44
|
+
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
45
45
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
46
46
|
* @param {*} [options] Override http request option.
|
|
47
47
|
* @throws {RequiredError}
|
|
48
48
|
*/
|
|
49
49
|
getOrderBuyerInfo: (orderId: string, options?: any) => Promise<RequestArgs>;
|
|
50
50
|
/**
|
|
51
|
-
* Returns detailed order item information for the order indicated by the specified order ID. 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
51
|
+
* Returns detailed order item information for the order indicated by the specified order ID. 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
52
52
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
53
53
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
54
54
|
* @param {*} [options] Override http request option.
|
|
@@ -56,7 +56,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
56
56
|
*/
|
|
57
57
|
getOrderItems: (orderId: string, nextToken?: string | undefined, options?: any) => Promise<RequestArgs>;
|
|
58
58
|
/**
|
|
59
|
-
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
59
|
+
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
60
60
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
61
61
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
62
62
|
* @param {*} [options] Override http request option.
|
|
@@ -64,14 +64,14 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
64
64
|
*/
|
|
65
65
|
getOrderItemsBuyerInfo: (orderId: string, nextToken?: string | undefined, options?: any) => Promise<RequestArgs>;
|
|
66
66
|
/**
|
|
67
|
-
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
67
|
+
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
68
68
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
69
69
|
* @param {*} [options] Override http request option.
|
|
70
70
|
* @throws {RequiredError}
|
|
71
71
|
*/
|
|
72
72
|
getOrderRegulatedInfo: (orderId: string, options?: any) => Promise<RequestArgs>;
|
|
73
73
|
/**
|
|
74
|
-
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
74
|
+
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
75
75
|
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
76
76
|
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
77
77
|
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
@@ -94,7 +94,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
94
94
|
*/
|
|
95
95
|
getOrders: (marketplaceIds: Array<string>, createdAfter?: string | undefined, createdBefore?: string | undefined, lastUpdatedAfter?: string | undefined, lastUpdatedBefore?: string | undefined, orderStatuses?: string[] | undefined, fulfillmentChannels?: string[] | undefined, paymentMethods?: string[] | undefined, buyerEmail?: string | undefined, sellerOrderId?: string | undefined, maxResultsPerPage?: number | undefined, easyShipShipmentStatuses?: string[] | undefined, nextToken?: string | undefined, amazonOrderIds?: string[] | undefined, actualFulfillmentSupplySourceId?: string | undefined, isISPU?: boolean | undefined, storeChainStoreId?: string | undefined, options?: any) => Promise<RequestArgs>;
|
|
96
96
|
/**
|
|
97
|
-
* Update the shipment status.
|
|
97
|
+
* Update the shipment status. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 15 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
98
98
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
99
99
|
* @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
|
|
100
100
|
* @param {*} [options] Override http request option.
|
|
@@ -102,7 +102,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
102
102
|
*/
|
|
103
103
|
updateShipmentStatus: (orderId: string, payload: UpdateShipmentStatusRequest, options?: any) => Promise<RequestArgs>;
|
|
104
104
|
/**
|
|
105
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
105
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
106
106
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
107
107
|
* @param {UpdateVerificationStatusRequest} payload Request to update the verification status of an order containing regulated products.
|
|
108
108
|
* @param {*} [options] Override http request option.
|
|
@@ -116,28 +116,28 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
116
116
|
*/
|
|
117
117
|
export declare const OrdersV0ApiFp: (configuration?: Configuration | undefined) => {
|
|
118
118
|
/**
|
|
119
|
-
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
119
|
+
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
120
120
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
121
121
|
* @param {*} [options] Override http request option.
|
|
122
122
|
* @throws {RequiredError}
|
|
123
123
|
*/
|
|
124
124
|
getOrder(orderId: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderResponse>>;
|
|
125
125
|
/**
|
|
126
|
-
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
126
|
+
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
127
127
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
128
128
|
* @param {*} [options] Override http request option.
|
|
129
129
|
* @throws {RequiredError}
|
|
130
130
|
*/
|
|
131
131
|
getOrderAddress(orderId: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderAddressResponse>>;
|
|
132
132
|
/**
|
|
133
|
-
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
133
|
+
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
134
134
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
136
136
|
* @throws {RequiredError}
|
|
137
137
|
*/
|
|
138
138
|
getOrderBuyerInfo(orderId: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderBuyerInfoResponse>>;
|
|
139
139
|
/**
|
|
140
|
-
* Returns detailed order item information for the order indicated by the specified order ID. 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
140
|
+
* Returns detailed order item information for the order indicated by the specified order ID. 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
141
141
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
142
142
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
@@ -145,7 +145,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration | undefined)
|
|
|
145
145
|
*/
|
|
146
146
|
getOrderItems(orderId: string, nextToken?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderItemsResponse>>;
|
|
147
147
|
/**
|
|
148
|
-
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
148
|
+
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
149
149
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
150
150
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
151
151
|
* @param {*} [options] Override http request option.
|
|
@@ -153,14 +153,14 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration | undefined)
|
|
|
153
153
|
*/
|
|
154
154
|
getOrderItemsBuyerInfo(orderId: string, nextToken?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderItemsBuyerInfoResponse>>;
|
|
155
155
|
/**
|
|
156
|
-
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
156
|
+
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
157
157
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
158
158
|
* @param {*} [options] Override http request option.
|
|
159
159
|
* @throws {RequiredError}
|
|
160
160
|
*/
|
|
161
161
|
getOrderRegulatedInfo(orderId: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderRegulatedInfoResponse>>;
|
|
162
162
|
/**
|
|
163
|
-
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
163
|
+
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
164
164
|
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
165
165
|
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
166
166
|
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
@@ -183,7 +183,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration | undefined)
|
|
|
183
183
|
*/
|
|
184
184
|
getOrders(marketplaceIds: Array<string>, createdAfter?: string | undefined, createdBefore?: string | undefined, lastUpdatedAfter?: string | undefined, lastUpdatedBefore?: string | undefined, orderStatuses?: string[] | undefined, fulfillmentChannels?: string[] | undefined, paymentMethods?: string[] | undefined, buyerEmail?: string | undefined, sellerOrderId?: string | undefined, maxResultsPerPage?: number | undefined, easyShipShipmentStatuses?: string[] | undefined, nextToken?: string | undefined, amazonOrderIds?: string[] | undefined, actualFulfillmentSupplySourceId?: string | undefined, isISPU?: boolean | undefined, storeChainStoreId?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrdersResponse>>;
|
|
185
185
|
/**
|
|
186
|
-
* Update the shipment status.
|
|
186
|
+
* Update the shipment status. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 15 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
187
187
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
188
188
|
* @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
|
|
189
189
|
* @param {*} [options] Override http request option.
|
|
@@ -191,7 +191,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration | undefined)
|
|
|
191
191
|
*/
|
|
192
192
|
updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
|
|
193
193
|
/**
|
|
194
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
194
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
195
195
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
196
196
|
* @param {UpdateVerificationStatusRequest} payload Request to update the verification status of an order containing regulated products.
|
|
197
197
|
* @param {*} [options] Override http request option.
|
|
@@ -205,28 +205,28 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration | undefined)
|
|
|
205
205
|
*/
|
|
206
206
|
export declare const OrdersV0ApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
207
207
|
/**
|
|
208
|
-
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
208
|
+
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
209
209
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
210
210
|
* @param {*} [options] Override http request option.
|
|
211
211
|
* @throws {RequiredError}
|
|
212
212
|
*/
|
|
213
213
|
getOrder(orderId: string, options?: any): AxiosPromise<GetOrderResponse>;
|
|
214
214
|
/**
|
|
215
|
-
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
215
|
+
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
216
216
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
217
217
|
* @param {*} [options] Override http request option.
|
|
218
218
|
* @throws {RequiredError}
|
|
219
219
|
*/
|
|
220
220
|
getOrderAddress(orderId: string, options?: any): AxiosPromise<GetOrderAddressResponse>;
|
|
221
221
|
/**
|
|
222
|
-
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
222
|
+
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
223
223
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
224
224
|
* @param {*} [options] Override http request option.
|
|
225
225
|
* @throws {RequiredError}
|
|
226
226
|
*/
|
|
227
227
|
getOrderBuyerInfo(orderId: string, options?: any): AxiosPromise<GetOrderBuyerInfoResponse>;
|
|
228
228
|
/**
|
|
229
|
-
* Returns detailed order item information for the order indicated by the specified order ID. 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
229
|
+
* Returns detailed order item information for the order indicated by the specified order ID. 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
230
230
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
231
231
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
232
232
|
* @param {*} [options] Override http request option.
|
|
@@ -234,7 +234,7 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration | undefi
|
|
|
234
234
|
*/
|
|
235
235
|
getOrderItems(orderId: string, nextToken?: string | undefined, options?: any): AxiosPromise<GetOrderItemsResponse>;
|
|
236
236
|
/**
|
|
237
|
-
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
237
|
+
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
238
238
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
239
239
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
240
240
|
* @param {*} [options] Override http request option.
|
|
@@ -242,14 +242,14 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration | undefi
|
|
|
242
242
|
*/
|
|
243
243
|
getOrderItemsBuyerInfo(orderId: string, nextToken?: string | undefined, options?: any): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
|
|
244
244
|
/**
|
|
245
|
-
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
245
|
+
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
246
246
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
247
247
|
* @param {*} [options] Override http request option.
|
|
248
248
|
* @throws {RequiredError}
|
|
249
249
|
*/
|
|
250
250
|
getOrderRegulatedInfo(orderId: string, options?: any): AxiosPromise<GetOrderRegulatedInfoResponse>;
|
|
251
251
|
/**
|
|
252
|
-
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
252
|
+
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
253
253
|
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
254
254
|
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
255
255
|
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
@@ -272,7 +272,7 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration | undefi
|
|
|
272
272
|
*/
|
|
273
273
|
getOrders(marketplaceIds: Array<string>, createdAfter?: string | undefined, createdBefore?: string | undefined, lastUpdatedAfter?: string | undefined, lastUpdatedBefore?: string | undefined, orderStatuses?: string[] | undefined, fulfillmentChannels?: string[] | undefined, paymentMethods?: string[] | undefined, buyerEmail?: string | undefined, sellerOrderId?: string | undefined, maxResultsPerPage?: number | undefined, easyShipShipmentStatuses?: string[] | undefined, nextToken?: string | undefined, amazonOrderIds?: string[] | undefined, actualFulfillmentSupplySourceId?: string | undefined, isISPU?: boolean | undefined, storeChainStoreId?: string | undefined, options?: any): AxiosPromise<GetOrdersResponse>;
|
|
274
274
|
/**
|
|
275
|
-
* Update the shipment status.
|
|
275
|
+
* Update the shipment status. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 15 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
276
276
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
277
277
|
* @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
|
|
278
278
|
* @param {*} [options] Override http request option.
|
|
@@ -280,7 +280,7 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration | undefi
|
|
|
280
280
|
*/
|
|
281
281
|
updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: any): AxiosPromise<void>;
|
|
282
282
|
/**
|
|
283
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
283
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
284
284
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
285
285
|
* @param {UpdateVerificationStatusRequest} payload Request to update the verification status of an order containing regulated products.
|
|
286
286
|
* @param {*} [options] Override http request option.
|
|
@@ -533,7 +533,7 @@ export interface OrdersV0ApiUpdateVerificationStatusRequest {
|
|
|
533
533
|
*/
|
|
534
534
|
export declare class OrdersV0Api extends BaseAPI {
|
|
535
535
|
/**
|
|
536
|
-
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
536
|
+
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
537
537
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
538
538
|
* @param {*} [options] Override http request option.
|
|
539
539
|
* @throws {RequiredError}
|
|
@@ -541,7 +541,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
541
541
|
*/
|
|
542
542
|
getOrder(requestParameters: OrdersV0ApiGetOrderRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderResponse, any>>;
|
|
543
543
|
/**
|
|
544
|
-
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
544
|
+
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
545
545
|
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
546
546
|
* @param {*} [options] Override http request option.
|
|
547
547
|
* @throws {RequiredError}
|
|
@@ -549,7 +549,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
549
549
|
*/
|
|
550
550
|
getOrderAddress(requestParameters: OrdersV0ApiGetOrderAddressRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderAddressResponse, any>>;
|
|
551
551
|
/**
|
|
552
|
-
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
552
|
+
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
553
553
|
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
554
554
|
* @param {*} [options] Override http request option.
|
|
555
555
|
* @throws {RequiredError}
|
|
@@ -557,7 +557,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
557
557
|
*/
|
|
558
558
|
getOrderBuyerInfo(requestParameters: OrdersV0ApiGetOrderBuyerInfoRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderBuyerInfoResponse, any>>;
|
|
559
559
|
/**
|
|
560
|
-
* Returns detailed order item information for the order indicated by the specified order ID. 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
560
|
+
* Returns detailed order item information for the order indicated by the specified order ID. 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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
561
561
|
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
562
562
|
* @param {*} [options] Override http request option.
|
|
563
563
|
* @throws {RequiredError}
|
|
@@ -565,7 +565,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
565
565
|
*/
|
|
566
566
|
getOrderItems(requestParameters: OrdersV0ApiGetOrderItemsRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderItemsResponse, any>>;
|
|
567
567
|
/**
|
|
568
|
-
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
568
|
+
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
569
569
|
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
570
570
|
* @param {*} [options] Override http request option.
|
|
571
571
|
* @throws {RequiredError}
|
|
@@ -573,7 +573,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
573
573
|
*/
|
|
574
574
|
getOrderItemsBuyerInfo(requestParameters: OrdersV0ApiGetOrderItemsBuyerInfoRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderItemsBuyerInfoResponse, any>>;
|
|
575
575
|
/**
|
|
576
|
-
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
576
|
+
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
577
577
|
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
578
578
|
* @param {*} [options] Override http request option.
|
|
579
579
|
* @throws {RequiredError}
|
|
@@ -581,7 +581,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
581
581
|
*/
|
|
582
582
|
getOrderRegulatedInfo(requestParameters: OrdersV0ApiGetOrderRegulatedInfoRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderRegulatedInfoResponse, any>>;
|
|
583
583
|
/**
|
|
584
|
-
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
584
|
+
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
585
585
|
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
586
586
|
* @param {*} [options] Override http request option.
|
|
587
587
|
* @throws {RequiredError}
|
|
@@ -589,7 +589,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
589
589
|
*/
|
|
590
590
|
getOrders(requestParameters: OrdersV0ApiGetOrdersRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrdersResponse, any>>;
|
|
591
591
|
/**
|
|
592
|
-
* Update the shipment status.
|
|
592
|
+
* Update the shipment status. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 15 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
593
593
|
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
594
594
|
* @param {*} [options] Override http request option.
|
|
595
595
|
* @throws {RequiredError}
|
|
@@ -597,7 +597,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
597
597
|
*/
|
|
598
598
|
updateShipmentStatus(requestParameters: OrdersV0ApiUpdateShipmentStatusRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
|
|
599
599
|
/**
|
|
600
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
600
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
601
601
|
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
602
602
|
* @param {*} [options] Override http request option.
|
|
603
603
|
* @throws {RequiredError}
|
|
@@ -41,3 +41,4 @@ export * from './update-shipment-status-request';
|
|
|
41
41
|
export * from './update-verification-status-error-response';
|
|
42
42
|
export * from './update-verification-status-request';
|
|
43
43
|
export * from './update-verification-status-request-body';
|
|
44
|
+
export * from './verification-status';
|
|
@@ -257,6 +257,12 @@ export interface Order {
|
|
|
257
257
|
* @memberof Order
|
|
258
258
|
*/
|
|
259
259
|
IsISPU?: boolean;
|
|
260
|
+
/**
|
|
261
|
+
* When true, this order is marked to be delivered to an Access Point. The access location is chosen by the customer. Access Points include Amazon Hub Lockers, Amazon Hub Counters, and pickup points operated by carriers.
|
|
262
|
+
* @type {boolean}
|
|
263
|
+
* @memberof Order
|
|
264
|
+
*/
|
|
265
|
+
IsAccessPointOrder?: boolean;
|
|
260
266
|
/**
|
|
261
267
|
*
|
|
262
268
|
* @type {MarketplaceTaxInfo}
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import { RejectionReason } from './rejection-reason';
|
|
13
|
+
import { VerificationStatus } from './verification-status';
|
|
13
14
|
/**
|
|
14
15
|
* The verification status of the order along with associated approval or rejection metadata.
|
|
15
16
|
* @export
|
|
@@ -17,11 +18,11 @@ import { RejectionReason } from './rejection-reason';
|
|
|
17
18
|
*/
|
|
18
19
|
export interface RegulatedOrderVerificationStatus {
|
|
19
20
|
/**
|
|
20
|
-
*
|
|
21
|
-
* @type {
|
|
21
|
+
*
|
|
22
|
+
* @type {VerificationStatus}
|
|
22
23
|
* @memberof RegulatedOrderVerificationStatus
|
|
23
24
|
*/
|
|
24
|
-
Status:
|
|
25
|
+
Status: VerificationStatus;
|
|
25
26
|
/**
|
|
26
27
|
* Whether the regulated information provided in the order requires a review by the merchant.
|
|
27
28
|
* @type {boolean}
|
|
@@ -53,14 +54,3 @@ export interface RegulatedOrderVerificationStatus {
|
|
|
53
54
|
*/
|
|
54
55
|
ExternalReviewerId?: string;
|
|
55
56
|
}
|
|
56
|
-
/**
|
|
57
|
-
* @export
|
|
58
|
-
* @enum {string}
|
|
59
|
-
*/
|
|
60
|
-
export declare enum RegulatedOrderVerificationStatusStatusEnum {
|
|
61
|
-
Pending = "Pending",
|
|
62
|
-
Approved = "Approved",
|
|
63
|
-
Rejected = "Rejected",
|
|
64
|
-
Expired = "Expired",
|
|
65
|
-
Cancelled = "Cancelled"
|
|
66
|
-
}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import { VerificationStatus } from './verification-status';
|
|
12
13
|
/**
|
|
13
14
|
* The updated values of the VerificationStatus field.
|
|
14
15
|
* @export
|
|
@@ -16,11 +17,11 @@
|
|
|
16
17
|
*/
|
|
17
18
|
export interface UpdateVerificationStatusRequestBody {
|
|
18
19
|
/**
|
|
19
|
-
*
|
|
20
|
-
* @type {
|
|
20
|
+
*
|
|
21
|
+
* @type {VerificationStatus}
|
|
21
22
|
* @memberof UpdateVerificationStatusRequestBody
|
|
22
23
|
*/
|
|
23
|
-
status:
|
|
24
|
+
status: VerificationStatus;
|
|
24
25
|
/**
|
|
25
26
|
* The identifier for the order\'s regulated information reviewer.
|
|
26
27
|
* @type {string}
|
|
@@ -34,11 +35,3 @@ export interface UpdateVerificationStatusRequestBody {
|
|
|
34
35
|
*/
|
|
35
36
|
rejectionReasonId?: string;
|
|
36
37
|
}
|
|
37
|
-
/**
|
|
38
|
-
* @export
|
|
39
|
-
* @enum {string}
|
|
40
|
-
*/
|
|
41
|
-
export declare enum UpdateVerificationStatusRequestBodyStatusEnum {
|
|
42
|
-
Approved = "Approved",
|
|
43
|
-
Rejected = "Rejected"
|
|
44
|
-
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Orders
|
|
3
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* The verification status of the order.
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare enum VerificationStatus {
|
|
18
|
+
Pending = "Pending",
|
|
19
|
+
Approved = "Approved",
|
|
20
|
+
Rejected = "Rejected",
|
|
21
|
+
Expired = "Expired",
|
|
22
|
+
Cancelled = "Cancelled"
|
|
23
|
+
}
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/orders-api-v0",
|
|
3
3
|
"author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
|
|
4
4
|
"description": "The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.",
|
|
5
|
-
"version": "1.
|
|
5
|
+
"version": "1.13.0",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -27,8 +27,8 @@
|
|
|
27
27
|
"test": "jest"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@sp-api-sdk/auth": "^1.9.
|
|
31
|
-
"@sp-api-sdk/common": "^1.9.
|
|
30
|
+
"@sp-api-sdk/auth": "^1.9.17",
|
|
31
|
+
"@sp-api-sdk/common": "^1.9.3",
|
|
32
32
|
"axios": "^0.27.2"
|
|
33
33
|
},
|
|
34
34
|
"repository": {
|
|
@@ -50,5 +50,5 @@
|
|
|
50
50
|
"sp sdk",
|
|
51
51
|
"orders api"
|
|
52
52
|
],
|
|
53
|
-
"gitHead": "
|
|
53
|
+
"gitHead": "a91680c9bce217db7412c5ad7c17aa6e918ada8e"
|
|
54
54
|
}
|