@sp-api-sdk/orders-api-v0 1.18.8 → 2.0.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 +176 -52
- package/dist/cjs/src/api-model/base.js +1 -3
- package/dist/cjs/src/api-model/common.js +2 -0
- package/dist/cjs/src/api-model/models/approval-support-data-element.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-approvals-response.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +14 -0
- package/dist/cjs/src/api-model/models/item-approval-action-changes.js +15 -0
- package/dist/cjs/src/api-model/models/item-approval-action.js +21 -0
- package/dist/cjs/src/api-model/models/item-approval-context.js +15 -0
- package/dist/cjs/src/api-model/models/item-approval-status.js +29 -0
- package/dist/cjs/src/api-model/models/item-approval-type.js +24 -0
- package/dist/cjs/src/api-model/models/item-approval.js +25 -0
- package/dist/cjs/src/api-model/models/item-identifier.js +21 -0
- package/dist/cjs/src/api-model/models/order-approvals-response.js +15 -0
- package/dist/cjs/src/api-model/models/order-item-approval-request.js +15 -0
- package/dist/cjs/src/api-model/models/order-item-approvals.js +15 -0
- package/dist/cjs/src/api-model/models/update-items-approvals-error-response.js +15 -0
- package/dist/cjs/src/api-model/models/update-order-approvals-request.js +15 -0
- package/dist/cjs/src/client.js +14 -0
- package/dist/es/src/api-model/api/orders-v0-api.js +176 -52
- package/dist/es/src/api-model/base.js +1 -3
- package/dist/es/src/api-model/common.js +2 -0
- package/dist/es/src/api-model/models/approval-support-data-element.js +14 -0
- package/dist/es/src/api-model/models/get-order-approvals-response.js +14 -0
- package/dist/es/src/api-model/models/index.js +14 -0
- package/dist/es/src/api-model/models/item-approval-action-changes.js +14 -0
- package/dist/es/src/api-model/models/item-approval-action.js +18 -0
- package/dist/es/src/api-model/models/item-approval-context.js +14 -0
- package/dist/es/src/api-model/models/item-approval-status.js +26 -0
- package/dist/es/src/api-model/models/item-approval-type.js +21 -0
- package/dist/es/src/api-model/models/item-approval.js +22 -0
- package/dist/es/src/api-model/models/item-identifier.js +18 -0
- package/dist/es/src/api-model/models/order-approvals-response.js +14 -0
- package/dist/es/src/api-model/models/order-item-approval-request.js +14 -0
- package/dist/es/src/api-model/models/order-item-approvals.js +14 -0
- package/dist/es/src/api-model/models/update-items-approvals-error-response.js +14 -0
- package/dist/es/src/api-model/models/update-order-approvals-request.js +14 -0
- package/dist/es/src/client.js +14 -0
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +158 -43
- package/dist/types/src/api-model/base.d.ts +2 -3
- package/dist/types/src/api-model/common.d.ts +3 -3
- package/dist/types/src/api-model/models/approval-support-data-element.d.ts +30 -0
- package/dist/types/src/api-model/models/get-order-approvals-response.d.ts +31 -0
- package/dist/types/src/api-model/models/index.d.ts +14 -0
- package/dist/types/src/api-model/models/item-approval-action-changes.d.ts +38 -0
- package/dist/types/src/api-model/models/item-approval-action.d.ts +43 -0
- package/dist/types/src/api-model/models/item-approval-context.d.ts +39 -0
- package/dist/types/src/api-model/models/item-approval-status.d.ts +25 -0
- package/dist/types/src/api-model/models/item-approval-type.d.ts +20 -0
- package/dist/types/src/api-model/models/item-approval.d.ts +72 -0
- package/dist/types/src/api-model/models/item-identifier.d.ts +36 -0
- package/dist/types/src/api-model/models/order-approvals-response.d.ts +31 -0
- package/dist/types/src/api-model/models/order-item-approval-request.d.ts +31 -0
- package/dist/types/src/api-model/models/order-item-approvals.d.ts +45 -0
- package/dist/types/src/api-model/models/order-item.d.ts +13 -0
- package/dist/types/src/api-model/models/order.d.ts +14 -0
- package/dist/types/src/api-model/models/update-items-approvals-error-response.d.ts +24 -0
- package/dist/types/src/api-model/models/update-order-approvals-request.d.ts +31 -0
- package/package.json +3 -3
|
@@ -9,16 +9,20 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { GetOrderAddressResponse } from '../models';
|
|
16
|
+
import { GetOrderApprovalsResponse } from '../models';
|
|
16
17
|
import { GetOrderBuyerInfoResponse } from '../models';
|
|
17
18
|
import { GetOrderItemsBuyerInfoResponse } from '../models';
|
|
18
19
|
import { GetOrderItemsResponse } from '../models';
|
|
19
20
|
import { GetOrderRegulatedInfoResponse } from '../models';
|
|
20
21
|
import { GetOrderResponse } from '../models';
|
|
21
22
|
import { GetOrdersResponse } from '../models';
|
|
23
|
+
import { ItemApprovalStatus } from '../models';
|
|
24
|
+
import { ItemApprovalType } from '../models';
|
|
25
|
+
import { UpdateOrderApprovalsRequest } from '../models';
|
|
22
26
|
import { UpdateShipmentStatusRequest } from '../models';
|
|
23
27
|
import { UpdateVerificationStatusRequest } from '../models';
|
|
24
28
|
/**
|
|
@@ -55,6 +59,16 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
55
59
|
* @throws {RequiredError}
|
|
56
60
|
*/
|
|
57
61
|
getOrderItems: (orderId: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
62
|
+
/**
|
|
63
|
+
* Returns detailed order items approvals information for the order specified. If NextToken is provided, it\'s used to retrieve the next page of order items approvals. **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.
|
|
64
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format, e.g. 933-1671587-0818628.
|
|
65
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
66
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return approvals for items which approval type is contained in the specified approval types.
|
|
67
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return approvals that contain items which approval status is contained in the specified approval status.
|
|
68
|
+
* @param {*} [options] Override http request option.
|
|
69
|
+
* @throws {RequiredError}
|
|
70
|
+
*/
|
|
71
|
+
getOrderItemsApprovals: (orderId: string, nextToken?: string, itemApprovalTypes?: Array<ItemApprovalType>, itemApprovalStatus?: Array<ItemApprovalStatus>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
72
|
/**
|
|
59
73
|
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
60
74
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -90,10 +104,20 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
90
104
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
91
105
|
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
92
106
|
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
107
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return orders that contain items which approval type is contained in the specified approval types.
|
|
108
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return orders that contain items which approval status is contained in the specified approval status.
|
|
109
|
+
* @param {*} [options] Override http request option.
|
|
110
|
+
* @throws {RequiredError}
|
|
111
|
+
*/
|
|
112
|
+
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, itemApprovalTypes?: Array<ItemApprovalType>, itemApprovalStatus?: Array<ItemApprovalStatus>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
113
|
+
/**
|
|
114
|
+
* Update the order items approvals for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
115
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
116
|
+
* @param {UpdateOrderApprovalsRequest} payload The request body for the updateOrderItemsApprovals operation.
|
|
93
117
|
* @param {*} [options] Override http request option.
|
|
94
118
|
* @throws {RequiredError}
|
|
95
119
|
*/
|
|
96
|
-
|
|
120
|
+
updateOrderItemsApprovals: (orderId: string, payload: UpdateOrderApprovalsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
97
121
|
/**
|
|
98
122
|
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
99
123
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -145,6 +169,16 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
145
169
|
* @throws {RequiredError}
|
|
146
170
|
*/
|
|
147
171
|
getOrderItems(orderId: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsResponse>>;
|
|
172
|
+
/**
|
|
173
|
+
* Returns detailed order items approvals information for the order specified. If NextToken is provided, it\'s used to retrieve the next page of order items approvals. **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.
|
|
174
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format, e.g. 933-1671587-0818628.
|
|
175
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
176
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return approvals for items which approval type is contained in the specified approval types.
|
|
177
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return approvals that contain items which approval status is contained in the specified approval status.
|
|
178
|
+
* @param {*} [options] Override http request option.
|
|
179
|
+
* @throws {RequiredError}
|
|
180
|
+
*/
|
|
181
|
+
getOrderItemsApprovals(orderId: string, nextToken?: string, itemApprovalTypes?: Array<ItemApprovalType>, itemApprovalStatus?: Array<ItemApprovalStatus>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderApprovalsResponse>>;
|
|
148
182
|
/**
|
|
149
183
|
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
150
184
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -180,10 +214,20 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
180
214
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
181
215
|
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
182
216
|
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
217
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return orders that contain items which approval type is contained in the specified approval types.
|
|
218
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return orders that contain items which approval status is contained in the specified approval status.
|
|
183
219
|
* @param {*} [options] Override http request option.
|
|
184
220
|
* @throws {RequiredError}
|
|
185
221
|
*/
|
|
186
|
-
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, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrdersResponse>>;
|
|
222
|
+
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, itemApprovalTypes?: Array<ItemApprovalType>, itemApprovalStatus?: Array<ItemApprovalStatus>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrdersResponse>>;
|
|
223
|
+
/**
|
|
224
|
+
* Update the order items approvals for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
225
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
226
|
+
* @param {UpdateOrderApprovalsRequest} payload The request body for the updateOrderItemsApprovals operation.
|
|
227
|
+
* @param {*} [options] Override http request option.
|
|
228
|
+
* @throws {RequiredError}
|
|
229
|
+
*/
|
|
230
|
+
updateOrderItemsApprovals(orderId: string, payload: UpdateOrderApprovalsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
187
231
|
/**
|
|
188
232
|
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
189
233
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -208,88 +252,81 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
208
252
|
export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
209
253
|
/**
|
|
210
254
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
211
|
-
* @param {
|
|
255
|
+
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
212
256
|
* @param {*} [options] Override http request option.
|
|
213
257
|
* @throws {RequiredError}
|
|
214
258
|
*/
|
|
215
|
-
getOrder(
|
|
259
|
+
getOrder(requestParameters: OrdersV0ApiGetOrderRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderResponse>;
|
|
216
260
|
/**
|
|
217
261
|
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
218
|
-
* @param {
|
|
262
|
+
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
219
263
|
* @param {*} [options] Override http request option.
|
|
220
264
|
* @throws {RequiredError}
|
|
221
265
|
*/
|
|
222
|
-
getOrderAddress(
|
|
266
|
+
getOrderAddress(requestParameters: OrdersV0ApiGetOrderAddressRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderAddressResponse>;
|
|
223
267
|
/**
|
|
224
268
|
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
225
|
-
* @param {
|
|
269
|
+
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
226
270
|
* @param {*} [options] Override http request option.
|
|
227
271
|
* @throws {RequiredError}
|
|
228
272
|
*/
|
|
229
|
-
getOrderBuyerInfo(
|
|
273
|
+
getOrderBuyerInfo(requestParameters: OrdersV0ApiGetOrderBuyerInfoRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderBuyerInfoResponse>;
|
|
230
274
|
/**
|
|
231
275
|
* Returns detailed order item information for the order that you specify. If NextToken is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
232
|
-
* @param {
|
|
233
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
276
|
+
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
234
277
|
* @param {*} [options] Override http request option.
|
|
235
278
|
* @throws {RequiredError}
|
|
236
279
|
*/
|
|
237
|
-
getOrderItems(
|
|
280
|
+
getOrderItems(requestParameters: OrdersV0ApiGetOrderItemsRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderItemsResponse>;
|
|
281
|
+
/**
|
|
282
|
+
* Returns detailed order items approvals information for the order specified. If NextToken is provided, it\'s used to retrieve the next page of order items approvals. **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.
|
|
283
|
+
* @param {OrdersV0ApiGetOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
284
|
+
* @param {*} [options] Override http request option.
|
|
285
|
+
* @throws {RequiredError}
|
|
286
|
+
*/
|
|
287
|
+
getOrderItemsApprovals(requestParameters: OrdersV0ApiGetOrderItemsApprovalsRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderApprovalsResponse>;
|
|
238
288
|
/**
|
|
239
289
|
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
240
|
-
* @param {
|
|
241
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
290
|
+
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
242
291
|
* @param {*} [options] Override http request option.
|
|
243
292
|
* @throws {RequiredError}
|
|
244
293
|
*/
|
|
245
|
-
getOrderItemsBuyerInfo(
|
|
294
|
+
getOrderItemsBuyerInfo(requestParameters: OrdersV0ApiGetOrderItemsBuyerInfoRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
|
|
246
295
|
/**
|
|
247
296
|
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
248
|
-
* @param {
|
|
297
|
+
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
249
298
|
* @param {*} [options] Override http request option.
|
|
250
299
|
* @throws {RequiredError}
|
|
251
300
|
*/
|
|
252
|
-
getOrderRegulatedInfo(
|
|
301
|
+
getOrderRegulatedInfo(requestParameters: OrdersV0ApiGetOrderRegulatedInfoRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderRegulatedInfoResponse>;
|
|
253
302
|
/**
|
|
254
303
|
* 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 Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
255
|
-
* @param {
|
|
256
|
-
* @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.
|
|
257
|
-
* @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.
|
|
258
|
-
* @param {string} [lastUpdatedAfter] A date used for selecting 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 format.
|
|
259
|
-
* @param {string} [lastUpdatedBefore] A date used for selecting 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 format.
|
|
260
|
-
* @param {Array<string>} [orderStatuses] 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.)
|
|
261
|
-
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: AFN (Fulfillment by Amazon); MFN (Fulfilled by the seller).
|
|
262
|
-
* @param {Array<string>} [paymentMethods] A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).
|
|
263
|
-
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
264
|
-
* @param {string} [sellerOrderId] 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.
|
|
265
|
-
* @param {number} [maxResultsPerPage] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
|
|
266
|
-
* @param {Array<string>} [easyShipShipmentStatuses] 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.)
|
|
267
|
-
* @param {Array<string>} [electronicInvoiceStatuses] 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.)
|
|
268
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
269
|
-
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
270
|
-
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
271
|
-
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
272
|
-
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
304
|
+
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
273
305
|
* @param {*} [options] Override http request option.
|
|
274
306
|
* @throws {RequiredError}
|
|
275
307
|
*/
|
|
276
|
-
getOrders(
|
|
308
|
+
getOrders(requestParameters: OrdersV0ApiGetOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrdersResponse>;
|
|
309
|
+
/**
|
|
310
|
+
* Update the order items approvals for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
311
|
+
* @param {OrdersV0ApiUpdateOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
312
|
+
* @param {*} [options] Override http request option.
|
|
313
|
+
* @throws {RequiredError}
|
|
314
|
+
*/
|
|
315
|
+
updateOrderItemsApprovals(requestParameters: OrdersV0ApiUpdateOrderItemsApprovalsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
277
316
|
/**
|
|
278
317
|
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
279
|
-
* @param {
|
|
280
|
-
* @param {UpdateShipmentStatusRequest} payload The request body for the updateShipmentStatus operation.
|
|
318
|
+
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
281
319
|
* @param {*} [options] Override http request option.
|
|
282
320
|
* @throws {RequiredError}
|
|
283
321
|
*/
|
|
284
|
-
updateShipmentStatus(
|
|
322
|
+
updateShipmentStatus(requestParameters: OrdersV0ApiUpdateShipmentStatusRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
285
323
|
/**
|
|
286
324
|
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
287
|
-
* @param {
|
|
288
|
-
* @param {UpdateVerificationStatusRequest} payload The request body for the updateVerificationStatus operation.
|
|
325
|
+
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
289
326
|
* @param {*} [options] Override http request option.
|
|
290
327
|
* @throws {RequiredError}
|
|
291
328
|
*/
|
|
292
|
-
updateVerificationStatus(
|
|
329
|
+
updateVerificationStatus(requestParameters: OrdersV0ApiUpdateVerificationStatusRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
293
330
|
};
|
|
294
331
|
/**
|
|
295
332
|
* Request parameters for getOrder operation in OrdersV0Api.
|
|
@@ -349,6 +386,37 @@ export interface OrdersV0ApiGetOrderItemsRequest {
|
|
|
349
386
|
*/
|
|
350
387
|
readonly nextToken?: string;
|
|
351
388
|
}
|
|
389
|
+
/**
|
|
390
|
+
* Request parameters for getOrderItemsApprovals operation in OrdersV0Api.
|
|
391
|
+
* @export
|
|
392
|
+
* @interface OrdersV0ApiGetOrderItemsApprovalsRequest
|
|
393
|
+
*/
|
|
394
|
+
export interface OrdersV0ApiGetOrderItemsApprovalsRequest {
|
|
395
|
+
/**
|
|
396
|
+
* An Amazon-defined order identifier, in 3-7-7 format, e.g. 933-1671587-0818628.
|
|
397
|
+
* @type {string}
|
|
398
|
+
* @memberof OrdersV0ApiGetOrderItemsApprovals
|
|
399
|
+
*/
|
|
400
|
+
readonly orderId: string;
|
|
401
|
+
/**
|
|
402
|
+
* A string token returned in the response of your previous request.
|
|
403
|
+
* @type {string}
|
|
404
|
+
* @memberof OrdersV0ApiGetOrderItemsApprovals
|
|
405
|
+
*/
|
|
406
|
+
readonly nextToken?: string;
|
|
407
|
+
/**
|
|
408
|
+
* When set, only return approvals for items which approval type is contained in the specified approval types.
|
|
409
|
+
* @type {Array<ItemApprovalType>}
|
|
410
|
+
* @memberof OrdersV0ApiGetOrderItemsApprovals
|
|
411
|
+
*/
|
|
412
|
+
readonly itemApprovalTypes?: Array<ItemApprovalType>;
|
|
413
|
+
/**
|
|
414
|
+
* When set, only return approvals that contain items which approval status is contained in the specified approval status.
|
|
415
|
+
* @type {Array<ItemApprovalStatus>}
|
|
416
|
+
* @memberof OrdersV0ApiGetOrderItemsApprovals
|
|
417
|
+
*/
|
|
418
|
+
readonly itemApprovalStatus?: Array<ItemApprovalStatus>;
|
|
419
|
+
}
|
|
352
420
|
/**
|
|
353
421
|
* Request parameters for getOrderItemsBuyerInfo operation in OrdersV0Api.
|
|
354
422
|
* @export
|
|
@@ -495,6 +563,37 @@ export interface OrdersV0ApiGetOrdersRequest {
|
|
|
495
563
|
* @memberof OrdersV0ApiGetOrders
|
|
496
564
|
*/
|
|
497
565
|
readonly storeChainStoreId?: string;
|
|
566
|
+
/**
|
|
567
|
+
* When set, only return orders that contain items which approval type is contained in the specified approval types.
|
|
568
|
+
* @type {Array<ItemApprovalType>}
|
|
569
|
+
* @memberof OrdersV0ApiGetOrders
|
|
570
|
+
*/
|
|
571
|
+
readonly itemApprovalTypes?: Array<ItemApprovalType>;
|
|
572
|
+
/**
|
|
573
|
+
* When set, only return orders that contain items which approval status is contained in the specified approval status.
|
|
574
|
+
* @type {Array<ItemApprovalStatus>}
|
|
575
|
+
* @memberof OrdersV0ApiGetOrders
|
|
576
|
+
*/
|
|
577
|
+
readonly itemApprovalStatus?: Array<ItemApprovalStatus>;
|
|
578
|
+
}
|
|
579
|
+
/**
|
|
580
|
+
* Request parameters for updateOrderItemsApprovals operation in OrdersV0Api.
|
|
581
|
+
* @export
|
|
582
|
+
* @interface OrdersV0ApiUpdateOrderItemsApprovalsRequest
|
|
583
|
+
*/
|
|
584
|
+
export interface OrdersV0ApiUpdateOrderItemsApprovalsRequest {
|
|
585
|
+
/**
|
|
586
|
+
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
587
|
+
* @type {string}
|
|
588
|
+
* @memberof OrdersV0ApiUpdateOrderItemsApprovals
|
|
589
|
+
*/
|
|
590
|
+
readonly orderId: string;
|
|
591
|
+
/**
|
|
592
|
+
* The request body for the updateOrderItemsApprovals operation.
|
|
593
|
+
* @type {UpdateOrderApprovalsRequest}
|
|
594
|
+
* @memberof OrdersV0ApiUpdateOrderItemsApprovals
|
|
595
|
+
*/
|
|
596
|
+
readonly payload: UpdateOrderApprovalsRequest;
|
|
498
597
|
}
|
|
499
598
|
/**
|
|
500
599
|
* Request parameters for updateShipmentStatus operation in OrdersV0Api.
|
|
@@ -573,6 +672,14 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
573
672
|
* @memberof OrdersV0Api
|
|
574
673
|
*/
|
|
575
674
|
getOrderItems(requestParameters: OrdersV0ApiGetOrderItemsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderItemsResponse, any>>;
|
|
675
|
+
/**
|
|
676
|
+
* Returns detailed order items approvals information for the order specified. If NextToken is provided, it\'s used to retrieve the next page of order items approvals. **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.
|
|
677
|
+
* @param {OrdersV0ApiGetOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
678
|
+
* @param {*} [options] Override http request option.
|
|
679
|
+
* @throws {RequiredError}
|
|
680
|
+
* @memberof OrdersV0Api
|
|
681
|
+
*/
|
|
682
|
+
getOrderItemsApprovals(requestParameters: OrdersV0ApiGetOrderItemsApprovalsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderApprovalsResponse, any>>;
|
|
576
683
|
/**
|
|
577
684
|
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
578
685
|
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
@@ -597,6 +704,14 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
597
704
|
* @memberof OrdersV0Api
|
|
598
705
|
*/
|
|
599
706
|
getOrders(requestParameters: OrdersV0ApiGetOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrdersResponse, any>>;
|
|
707
|
+
/**
|
|
708
|
+
* Update the order items approvals for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
709
|
+
* @param {OrdersV0ApiUpdateOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
710
|
+
* @param {*} [options] Override http request option.
|
|
711
|
+
* @throws {RequiredError}
|
|
712
|
+
* @memberof OrdersV0Api
|
|
713
|
+
*/
|
|
714
|
+
updateOrderItemsApprovals(requestParameters: OrdersV0ApiUpdateOrderItemsApprovalsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
600
715
|
/**
|
|
601
716
|
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
602
717
|
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { Configuration } from
|
|
13
|
-
import { AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
14
|
export declare const BASE_PATH: string;
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
@@ -50,6 +50,5 @@ export declare class BaseAPI {
|
|
|
50
50
|
*/
|
|
51
51
|
export declare class RequiredError extends Error {
|
|
52
52
|
field: string;
|
|
53
|
-
name: "RequiredError";
|
|
54
53
|
constructor(field: string, msg?: string);
|
|
55
54
|
}
|
|
@@ -10,9 +10,9 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/// <reference types="node" />
|
|
13
|
-
import { Configuration } from "./configuration";
|
|
14
|
-
import { RequestArgs } from "./base";
|
|
15
|
-
import { AxiosInstance, AxiosResponse } from 'axios';
|
|
13
|
+
import type { Configuration } from "./configuration";
|
|
14
|
+
import type { RequestArgs } from "./base";
|
|
15
|
+
import type { AxiosInstance, AxiosResponse } from 'axios';
|
|
16
16
|
/**
|
|
17
17
|
*
|
|
18
18
|
* @export
|
|
@@ -0,0 +1,30 @@
|
|
|
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
|
+
* <Name, Value> tuple to define item approval support data elements.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ApprovalSupportDataElement
|
|
16
|
+
*/
|
|
17
|
+
export interface ApprovalSupportDataElement {
|
|
18
|
+
/**
|
|
19
|
+
* Name of the approval support element. Allowed names are defined in specific approval types schemas.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ApprovalSupportDataElement
|
|
22
|
+
*/
|
|
23
|
+
'Name': string;
|
|
24
|
+
/**
|
|
25
|
+
* String value of the approval support element.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ApprovalSupportDataElement
|
|
28
|
+
*/
|
|
29
|
+
'Value': string;
|
|
30
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
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
|
+
import { OrderApprovalsResponse } from './order-approvals-response';
|
|
13
|
+
/**
|
|
14
|
+
* The response schema for the getOrderApprovalsItems operation.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface GetOrderApprovalsResponse
|
|
17
|
+
*/
|
|
18
|
+
export interface GetOrderApprovalsResponse {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {OrderApprovalsResponse}
|
|
22
|
+
* @memberof GetOrderApprovalsResponse
|
|
23
|
+
*/
|
|
24
|
+
'payload'?: OrderApprovalsResponse;
|
|
25
|
+
/**
|
|
26
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
27
|
+
* @type {Array<Error>}
|
|
28
|
+
* @memberof GetOrderApprovalsResponse
|
|
29
|
+
*/
|
|
30
|
+
'errors'?: Array<Error>;
|
|
31
|
+
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export * from './address';
|
|
2
|
+
export * from './approval-support-data-element';
|
|
2
3
|
export * from './automated-shipping-settings';
|
|
3
4
|
export * from './buyer-customized-info-detail';
|
|
4
5
|
export * from './buyer-info';
|
|
@@ -9,20 +10,31 @@ export * from './easy-ship-shipment-status';
|
|
|
9
10
|
export * from './electronic-invoice-status';
|
|
10
11
|
export * from './fulfillment-instruction';
|
|
11
12
|
export * from './get-order-address-response';
|
|
13
|
+
export * from './get-order-approvals-response';
|
|
12
14
|
export * from './get-order-buyer-info-response';
|
|
13
15
|
export * from './get-order-items-buyer-info-response';
|
|
14
16
|
export * from './get-order-items-response';
|
|
15
17
|
export * from './get-order-regulated-info-response';
|
|
16
18
|
export * from './get-order-response';
|
|
17
19
|
export * from './get-orders-response';
|
|
20
|
+
export * from './item-approval';
|
|
21
|
+
export * from './item-approval-action';
|
|
22
|
+
export * from './item-approval-action-changes';
|
|
23
|
+
export * from './item-approval-context';
|
|
24
|
+
export * from './item-approval-status';
|
|
25
|
+
export * from './item-approval-type';
|
|
18
26
|
export * from './item-buyer-info';
|
|
27
|
+
export * from './item-identifier';
|
|
19
28
|
export * from './marketplace-tax-info';
|
|
20
29
|
export * from './model-error';
|
|
21
30
|
export * from './money';
|
|
22
31
|
export * from './order';
|
|
23
32
|
export * from './order-address';
|
|
33
|
+
export * from './order-approvals-response';
|
|
24
34
|
export * from './order-buyer-info';
|
|
25
35
|
export * from './order-item';
|
|
36
|
+
export * from './order-item-approval-request';
|
|
37
|
+
export * from './order-item-approvals';
|
|
26
38
|
export * from './order-item-buyer-info';
|
|
27
39
|
export * from './order-items-buyer-info-list';
|
|
28
40
|
export * from './order-items-inner';
|
|
@@ -39,6 +51,8 @@ export * from './rejection-reason';
|
|
|
39
51
|
export * from './shipment-status';
|
|
40
52
|
export * from './tax-classification';
|
|
41
53
|
export * from './tax-collection';
|
|
54
|
+
export * from './update-items-approvals-error-response';
|
|
55
|
+
export * from './update-order-approvals-request';
|
|
42
56
|
export * from './update-shipment-status-error-response';
|
|
43
57
|
export * from './update-shipment-status-request';
|
|
44
58
|
export * from './update-verification-status-error-response';
|
|
@@ -0,0 +1,38 @@
|
|
|
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
|
+
import { ItemIdentifier } from './item-identifier';
|
|
13
|
+
import { Money } from './money';
|
|
14
|
+
/**
|
|
15
|
+
* Changes required for the approval. Each approval type defines the allowed changes valid sub-set in its specific schema.
|
|
16
|
+
* @export
|
|
17
|
+
* @interface ItemApprovalActionChanges
|
|
18
|
+
*/
|
|
19
|
+
export interface ItemApprovalActionChanges {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {Money}
|
|
23
|
+
* @memberof ItemApprovalActionChanges
|
|
24
|
+
*/
|
|
25
|
+
'ItemPrice'?: Money;
|
|
26
|
+
/**
|
|
27
|
+
* Quantity approved. If substitutedBy is specified, this value applies to the substitution item.
|
|
28
|
+
* @type {number}
|
|
29
|
+
* @memberof ItemApprovalActionChanges
|
|
30
|
+
*/
|
|
31
|
+
'Quantity'?: number;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {ItemIdentifier}
|
|
35
|
+
* @memberof ItemApprovalActionChanges
|
|
36
|
+
*/
|
|
37
|
+
'SubstitutedBy'?: ItemIdentifier;
|
|
38
|
+
}
|
|
@@ -0,0 +1,43 @@
|
|
|
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
|
+
import { ItemApprovalActionChanges } from './item-approval-action-changes';
|
|
13
|
+
/**
|
|
14
|
+
* This object represents an approval action used by the actors in the order item approval process. Check the applicable restrictions at the specific approval type schemas.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ItemApprovalAction
|
|
17
|
+
*/
|
|
18
|
+
export interface ItemApprovalAction {
|
|
19
|
+
/**
|
|
20
|
+
* Defines the type of action for the approval.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof ItemApprovalAction
|
|
23
|
+
*/
|
|
24
|
+
'ActionType': ItemApprovalActionActionTypeEnum;
|
|
25
|
+
/**
|
|
26
|
+
* Comment message to provide optional additional context on the approval action.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof ItemApprovalAction
|
|
29
|
+
*/
|
|
30
|
+
'Comment'?: string;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @type {ItemApprovalActionChanges}
|
|
34
|
+
* @memberof ItemApprovalAction
|
|
35
|
+
*/
|
|
36
|
+
'Changes'?: ItemApprovalActionChanges;
|
|
37
|
+
}
|
|
38
|
+
export declare const ItemApprovalActionActionTypeEnum: {
|
|
39
|
+
readonly Approve: "APPROVE";
|
|
40
|
+
readonly Decline: "DECLINE";
|
|
41
|
+
readonly ApproveWithChanges: "APPROVE_WITH_CHANGES";
|
|
42
|
+
};
|
|
43
|
+
export type ItemApprovalActionActionTypeEnum = typeof ItemApprovalActionActionTypeEnum[keyof typeof ItemApprovalActionActionTypeEnum];
|
|
@@ -0,0 +1,39 @@
|
|
|
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
|
+
import { ApprovalSupportDataElement } from './approval-support-data-element';
|
|
13
|
+
import { ItemApprovalStatus } from './item-approval-status';
|
|
14
|
+
import { ItemApprovalType } from './item-approval-type';
|
|
15
|
+
/**
|
|
16
|
+
* Generic item approval context. Check the applicable restrictions at the specific approval type schemas.
|
|
17
|
+
* @export
|
|
18
|
+
* @interface ItemApprovalContext
|
|
19
|
+
*/
|
|
20
|
+
export interface ItemApprovalContext {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {ItemApprovalType}
|
|
24
|
+
* @memberof ItemApprovalContext
|
|
25
|
+
*/
|
|
26
|
+
'ApprovalType': ItemApprovalType;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {ItemApprovalStatus}
|
|
30
|
+
* @memberof ItemApprovalContext
|
|
31
|
+
*/
|
|
32
|
+
'ApprovalStatus': ItemApprovalStatus;
|
|
33
|
+
/**
|
|
34
|
+
* List of additional data elements supporting the approval process. Check the applicable restrictions at the specific approval type schemas.
|
|
35
|
+
* @type {Array<ApprovalSupportDataElement>}
|
|
36
|
+
* @memberof ItemApprovalContext
|
|
37
|
+
*/
|
|
38
|
+
'ApprovalSupportData'?: Array<ApprovalSupportDataElement>;
|
|
39
|
+
}
|