@sp-api-sdk/orders-api-v0 1.18.7 → 1.19.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 +221 -6
- package/dist/cjs/src/api-model/base.js +5 -1
- package/dist/cjs/src/api-model/configuration.js +49 -0
- package/dist/cjs/src/api-model/models/approval-support-data-element.js +15 -0
- package/dist/cjs/src/api-model/models/confirm-shipment-error-response.js +15 -0
- package/dist/cjs/src/api-model/models/confirm-shipment-order-item.js +15 -0
- package/dist/cjs/src/api-model/models/confirm-shipment-request.js +19 -0
- package/dist/cjs/src/api-model/models/get-order-approvals-response.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +18 -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/package-detail.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 +21 -0
- package/dist/es/src/api-model/api/orders-v0-api.js +221 -6
- package/dist/es/src/api-model/base.js +5 -1
- package/dist/es/src/api-model/configuration.js +49 -0
- package/dist/es/src/api-model/models/approval-support-data-element.js +14 -0
- package/dist/es/src/api-model/models/confirm-shipment-error-response.js +14 -0
- package/dist/es/src/api-model/models/confirm-shipment-order-item.js +14 -0
- package/dist/es/src/api-model/models/confirm-shipment-request.js +16 -0
- package/dist/es/src/api-model/models/get-order-approvals-response.js +14 -0
- package/dist/es/src/api-model/models/index.js +18 -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/package-detail.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 +21 -0
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +197 -3
- package/dist/types/src/api-model/models/approval-support-data-element.d.ts +30 -0
- package/dist/types/src/api-model/models/confirm-shipment-error-response.d.ts +24 -0
- package/dist/types/src/api-model/models/confirm-shipment-order-item.d.ts +36 -0
- package/dist/types/src/api-model/models/confirm-shipment-request.d.ts +41 -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 +18 -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/package-detail.d.ts +67 -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
|
@@ -12,13 +12,18 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { ConfirmShipmentRequest } from '../models';
|
|
15
16
|
import { GetOrderAddressResponse } from '../models';
|
|
17
|
+
import { GetOrderApprovalsResponse } from '../models';
|
|
16
18
|
import { GetOrderBuyerInfoResponse } from '../models';
|
|
17
19
|
import { GetOrderItemsBuyerInfoResponse } from '../models';
|
|
18
20
|
import { GetOrderItemsResponse } from '../models';
|
|
19
21
|
import { GetOrderRegulatedInfoResponse } from '../models';
|
|
20
22
|
import { GetOrderResponse } from '../models';
|
|
21
23
|
import { GetOrdersResponse } from '../models';
|
|
24
|
+
import { ItemApprovalStatus } from '../models';
|
|
25
|
+
import { ItemApprovalType } from '../models';
|
|
26
|
+
import { UpdateOrderApprovalsRequest } from '../models';
|
|
22
27
|
import { UpdateShipmentStatusRequest } from '../models';
|
|
23
28
|
import { UpdateVerificationStatusRequest } from '../models';
|
|
24
29
|
/**
|
|
@@ -26,6 +31,14 @@ import { UpdateVerificationStatusRequest } from '../models';
|
|
|
26
31
|
* @export
|
|
27
32
|
*/
|
|
28
33
|
export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
34
|
+
/**
|
|
35
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The 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).
|
|
36
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
37
|
+
* @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
|
|
38
|
+
* @param {*} [options] Override http request option.
|
|
39
|
+
* @throws {RequiredError}
|
|
40
|
+
*/
|
|
41
|
+
confirmShipment: (orderId: string, payload: ConfirmShipmentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
42
|
/**
|
|
30
43
|
* 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).
|
|
31
44
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -55,6 +68,16 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
55
68
|
* @throws {RequiredError}
|
|
56
69
|
*/
|
|
57
70
|
getOrderItems: (orderId: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
71
|
+
/**
|
|
72
|
+
* 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.
|
|
73
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format, e.g. 933-1671587-0818628.
|
|
74
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
75
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return approvals for items which approval type is contained in the specified approval types.
|
|
76
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return approvals that contain items which approval status is contained in the specified approval status.
|
|
77
|
+
* @param {*} [options] Override http request option.
|
|
78
|
+
* @throws {RequiredError}
|
|
79
|
+
*/
|
|
80
|
+
getOrderItemsApprovals: (orderId: string, nextToken?: string, itemApprovalTypes?: Array<ItemApprovalType>, itemApprovalStatus?: Array<ItemApprovalStatus>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
81
|
/**
|
|
59
82
|
* 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
83
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -90,10 +113,20 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
90
113
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
91
114
|
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
92
115
|
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
116
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return orders that contain items which approval type is contained in the specified approval types.
|
|
117
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return orders that contain items which approval status is contained in the specified approval status.
|
|
93
118
|
* @param {*} [options] Override http request option.
|
|
94
119
|
* @throws {RequiredError}
|
|
95
120
|
*/
|
|
96
|
-
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<RequestArgs>;
|
|
121
|
+
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>;
|
|
122
|
+
/**
|
|
123
|
+
* 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).
|
|
124
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
125
|
+
* @param {UpdateOrderApprovalsRequest} payload The request body for the updateOrderItemsApprovals operation.
|
|
126
|
+
* @param {*} [options] Override http request option.
|
|
127
|
+
* @throws {RequiredError}
|
|
128
|
+
*/
|
|
129
|
+
updateOrderItemsApprovals: (orderId: string, payload: UpdateOrderApprovalsRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
97
130
|
/**
|
|
98
131
|
* 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
132
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -116,6 +149,14 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
116
149
|
* @export
|
|
117
150
|
*/
|
|
118
151
|
export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
152
|
+
/**
|
|
153
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The 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).
|
|
154
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
155
|
+
* @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
|
|
156
|
+
* @param {*} [options] Override http request option.
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
*/
|
|
159
|
+
confirmShipment(orderId: string, payload: ConfirmShipmentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
119
160
|
/**
|
|
120
161
|
* 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).
|
|
121
162
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -145,6 +186,16 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
145
186
|
* @throws {RequiredError}
|
|
146
187
|
*/
|
|
147
188
|
getOrderItems(orderId: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsResponse>>;
|
|
189
|
+
/**
|
|
190
|
+
* 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.
|
|
191
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format, e.g. 933-1671587-0818628.
|
|
192
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
193
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return approvals for items which approval type is contained in the specified approval types.
|
|
194
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return approvals that contain items which approval status is contained in the specified approval status.
|
|
195
|
+
* @param {*} [options] Override http request option.
|
|
196
|
+
* @throws {RequiredError}
|
|
197
|
+
*/
|
|
198
|
+
getOrderItemsApprovals(orderId: string, nextToken?: string, itemApprovalTypes?: Array<ItemApprovalType>, itemApprovalStatus?: Array<ItemApprovalStatus>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderApprovalsResponse>>;
|
|
148
199
|
/**
|
|
149
200
|
* 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
201
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -180,10 +231,20 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
180
231
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
181
232
|
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
182
233
|
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
234
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return orders that contain items which approval type is contained in the specified approval types.
|
|
235
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return orders that contain items which approval status is contained in the specified approval status.
|
|
183
236
|
* @param {*} [options] Override http request option.
|
|
184
237
|
* @throws {RequiredError}
|
|
185
238
|
*/
|
|
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>>;
|
|
239
|
+
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>>;
|
|
240
|
+
/**
|
|
241
|
+
* 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).
|
|
242
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
243
|
+
* @param {UpdateOrderApprovalsRequest} payload The request body for the updateOrderItemsApprovals operation.
|
|
244
|
+
* @param {*} [options] Override http request option.
|
|
245
|
+
* @throws {RequiredError}
|
|
246
|
+
*/
|
|
247
|
+
updateOrderItemsApprovals(orderId: string, payload: UpdateOrderApprovalsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
187
248
|
/**
|
|
188
249
|
* 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
250
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -206,6 +267,14 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
206
267
|
* @export
|
|
207
268
|
*/
|
|
208
269
|
export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
270
|
+
/**
|
|
271
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The 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).
|
|
272
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
273
|
+
* @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
|
|
274
|
+
* @param {*} [options] Override http request option.
|
|
275
|
+
* @throws {RequiredError}
|
|
276
|
+
*/
|
|
277
|
+
confirmShipment(orderId: string, payload: ConfirmShipmentRequest, options?: any): AxiosPromise<void>;
|
|
209
278
|
/**
|
|
210
279
|
* 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
280
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -235,6 +304,16 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePat
|
|
|
235
304
|
* @throws {RequiredError}
|
|
236
305
|
*/
|
|
237
306
|
getOrderItems(orderId: string, nextToken?: string, options?: any): AxiosPromise<GetOrderItemsResponse>;
|
|
307
|
+
/**
|
|
308
|
+
* 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.
|
|
309
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format, e.g. 933-1671587-0818628.
|
|
310
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
311
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return approvals for items which approval type is contained in the specified approval types.
|
|
312
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return approvals that contain items which approval status is contained in the specified approval status.
|
|
313
|
+
* @param {*} [options] Override http request option.
|
|
314
|
+
* @throws {RequiredError}
|
|
315
|
+
*/
|
|
316
|
+
getOrderItemsApprovals(orderId: string, nextToken?: string, itemApprovalTypes?: Array<ItemApprovalType>, itemApprovalStatus?: Array<ItemApprovalStatus>, options?: any): AxiosPromise<GetOrderApprovalsResponse>;
|
|
238
317
|
/**
|
|
239
318
|
* 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
319
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -270,10 +349,20 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePat
|
|
|
270
349
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
271
350
|
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
272
351
|
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
352
|
+
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return orders that contain items which approval type is contained in the specified approval types.
|
|
353
|
+
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return orders that contain items which approval status is contained in the specified approval status.
|
|
273
354
|
* @param {*} [options] Override http request option.
|
|
274
355
|
* @throws {RequiredError}
|
|
275
356
|
*/
|
|
276
|
-
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?: any): AxiosPromise<GetOrdersResponse>;
|
|
357
|
+
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?: any): AxiosPromise<GetOrdersResponse>;
|
|
358
|
+
/**
|
|
359
|
+
* 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).
|
|
360
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
361
|
+
* @param {UpdateOrderApprovalsRequest} payload The request body for the updateOrderItemsApprovals operation.
|
|
362
|
+
* @param {*} [options] Override http request option.
|
|
363
|
+
* @throws {RequiredError}
|
|
364
|
+
*/
|
|
365
|
+
updateOrderItemsApprovals(orderId: string, payload: UpdateOrderApprovalsRequest, options?: any): AxiosPromise<void>;
|
|
277
366
|
/**
|
|
278
367
|
* 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
368
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -291,6 +380,25 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePat
|
|
|
291
380
|
*/
|
|
292
381
|
updateVerificationStatus(orderId: string, payload: UpdateVerificationStatusRequest, options?: any): AxiosPromise<void>;
|
|
293
382
|
};
|
|
383
|
+
/**
|
|
384
|
+
* Request parameters for confirmShipment operation in OrdersV0Api.
|
|
385
|
+
* @export
|
|
386
|
+
* @interface OrdersV0ApiConfirmShipmentRequest
|
|
387
|
+
*/
|
|
388
|
+
export interface OrdersV0ApiConfirmShipmentRequest {
|
|
389
|
+
/**
|
|
390
|
+
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
391
|
+
* @type {string}
|
|
392
|
+
* @memberof OrdersV0ApiConfirmShipment
|
|
393
|
+
*/
|
|
394
|
+
readonly orderId: string;
|
|
395
|
+
/**
|
|
396
|
+
* Request body of confirmShipment.
|
|
397
|
+
* @type {ConfirmShipmentRequest}
|
|
398
|
+
* @memberof OrdersV0ApiConfirmShipment
|
|
399
|
+
*/
|
|
400
|
+
readonly payload: ConfirmShipmentRequest;
|
|
401
|
+
}
|
|
294
402
|
/**
|
|
295
403
|
* Request parameters for getOrder operation in OrdersV0Api.
|
|
296
404
|
* @export
|
|
@@ -349,6 +457,37 @@ export interface OrdersV0ApiGetOrderItemsRequest {
|
|
|
349
457
|
*/
|
|
350
458
|
readonly nextToken?: string;
|
|
351
459
|
}
|
|
460
|
+
/**
|
|
461
|
+
* Request parameters for getOrderItemsApprovals operation in OrdersV0Api.
|
|
462
|
+
* @export
|
|
463
|
+
* @interface OrdersV0ApiGetOrderItemsApprovalsRequest
|
|
464
|
+
*/
|
|
465
|
+
export interface OrdersV0ApiGetOrderItemsApprovalsRequest {
|
|
466
|
+
/**
|
|
467
|
+
* An Amazon-defined order identifier, in 3-7-7 format, e.g. 933-1671587-0818628.
|
|
468
|
+
* @type {string}
|
|
469
|
+
* @memberof OrdersV0ApiGetOrderItemsApprovals
|
|
470
|
+
*/
|
|
471
|
+
readonly orderId: string;
|
|
472
|
+
/**
|
|
473
|
+
* A string token returned in the response of your previous request.
|
|
474
|
+
* @type {string}
|
|
475
|
+
* @memberof OrdersV0ApiGetOrderItemsApprovals
|
|
476
|
+
*/
|
|
477
|
+
readonly nextToken?: string;
|
|
478
|
+
/**
|
|
479
|
+
* When set, only return approvals for items which approval type is contained in the specified approval types.
|
|
480
|
+
* @type {Array<ItemApprovalType>}
|
|
481
|
+
* @memberof OrdersV0ApiGetOrderItemsApprovals
|
|
482
|
+
*/
|
|
483
|
+
readonly itemApprovalTypes?: Array<ItemApprovalType>;
|
|
484
|
+
/**
|
|
485
|
+
* When set, only return approvals that contain items which approval status is contained in the specified approval status.
|
|
486
|
+
* @type {Array<ItemApprovalStatus>}
|
|
487
|
+
* @memberof OrdersV0ApiGetOrderItemsApprovals
|
|
488
|
+
*/
|
|
489
|
+
readonly itemApprovalStatus?: Array<ItemApprovalStatus>;
|
|
490
|
+
}
|
|
352
491
|
/**
|
|
353
492
|
* Request parameters for getOrderItemsBuyerInfo operation in OrdersV0Api.
|
|
354
493
|
* @export
|
|
@@ -495,6 +634,37 @@ export interface OrdersV0ApiGetOrdersRequest {
|
|
|
495
634
|
* @memberof OrdersV0ApiGetOrders
|
|
496
635
|
*/
|
|
497
636
|
readonly storeChainStoreId?: string;
|
|
637
|
+
/**
|
|
638
|
+
* When set, only return orders that contain items which approval type is contained in the specified approval types.
|
|
639
|
+
* @type {Array<ItemApprovalType>}
|
|
640
|
+
* @memberof OrdersV0ApiGetOrders
|
|
641
|
+
*/
|
|
642
|
+
readonly itemApprovalTypes?: Array<ItemApprovalType>;
|
|
643
|
+
/**
|
|
644
|
+
* When set, only return orders that contain items which approval status is contained in the specified approval status.
|
|
645
|
+
* @type {Array<ItemApprovalStatus>}
|
|
646
|
+
* @memberof OrdersV0ApiGetOrders
|
|
647
|
+
*/
|
|
648
|
+
readonly itemApprovalStatus?: Array<ItemApprovalStatus>;
|
|
649
|
+
}
|
|
650
|
+
/**
|
|
651
|
+
* Request parameters for updateOrderItemsApprovals operation in OrdersV0Api.
|
|
652
|
+
* @export
|
|
653
|
+
* @interface OrdersV0ApiUpdateOrderItemsApprovalsRequest
|
|
654
|
+
*/
|
|
655
|
+
export interface OrdersV0ApiUpdateOrderItemsApprovalsRequest {
|
|
656
|
+
/**
|
|
657
|
+
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
658
|
+
* @type {string}
|
|
659
|
+
* @memberof OrdersV0ApiUpdateOrderItemsApprovals
|
|
660
|
+
*/
|
|
661
|
+
readonly orderId: string;
|
|
662
|
+
/**
|
|
663
|
+
* The request body for the updateOrderItemsApprovals operation.
|
|
664
|
+
* @type {UpdateOrderApprovalsRequest}
|
|
665
|
+
* @memberof OrdersV0ApiUpdateOrderItemsApprovals
|
|
666
|
+
*/
|
|
667
|
+
readonly payload: UpdateOrderApprovalsRequest;
|
|
498
668
|
}
|
|
499
669
|
/**
|
|
500
670
|
* Request parameters for updateShipmentStatus operation in OrdersV0Api.
|
|
@@ -541,6 +711,14 @@ export interface OrdersV0ApiUpdateVerificationStatusRequest {
|
|
|
541
711
|
* @extends {BaseAPI}
|
|
542
712
|
*/
|
|
543
713
|
export declare class OrdersV0Api extends BaseAPI {
|
|
714
|
+
/**
|
|
715
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The 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).
|
|
716
|
+
* @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
717
|
+
* @param {*} [options] Override http request option.
|
|
718
|
+
* @throws {RequiredError}
|
|
719
|
+
* @memberof OrdersV0Api
|
|
720
|
+
*/
|
|
721
|
+
confirmShipment(requestParameters: OrdersV0ApiConfirmShipmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
544
722
|
/**
|
|
545
723
|
* 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).
|
|
546
724
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
@@ -573,6 +751,14 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
573
751
|
* @memberof OrdersV0Api
|
|
574
752
|
*/
|
|
575
753
|
getOrderItems(requestParameters: OrdersV0ApiGetOrderItemsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderItemsResponse, any>>;
|
|
754
|
+
/**
|
|
755
|
+
* 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.
|
|
756
|
+
* @param {OrdersV0ApiGetOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
757
|
+
* @param {*} [options] Override http request option.
|
|
758
|
+
* @throws {RequiredError}
|
|
759
|
+
* @memberof OrdersV0Api
|
|
760
|
+
*/
|
|
761
|
+
getOrderItemsApprovals(requestParameters: OrdersV0ApiGetOrderItemsApprovalsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderApprovalsResponse, any>>;
|
|
576
762
|
/**
|
|
577
763
|
* 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
764
|
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
@@ -597,6 +783,14 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
597
783
|
* @memberof OrdersV0Api
|
|
598
784
|
*/
|
|
599
785
|
getOrders(requestParameters: OrdersV0ApiGetOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrdersResponse, any>>;
|
|
786
|
+
/**
|
|
787
|
+
* 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).
|
|
788
|
+
* @param {OrdersV0ApiUpdateOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
789
|
+
* @param {*} [options] Override http request option.
|
|
790
|
+
* @throws {RequiredError}
|
|
791
|
+
* @memberof OrdersV0Api
|
|
792
|
+
*/
|
|
793
|
+
updateOrderItemsApprovals(requestParameters: OrdersV0ApiUpdateOrderItemsApprovalsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
600
794
|
/**
|
|
601
795
|
* 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
796
|
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
@@ -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,24 @@
|
|
|
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 error response schema for an shipment confirmation.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ConfirmShipmentErrorResponse
|
|
16
|
+
*/
|
|
17
|
+
export interface ConfirmShipmentErrorResponse {
|
|
18
|
+
/**
|
|
19
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
20
|
+
* @type {Array<Error>}
|
|
21
|
+
* @memberof ConfirmShipmentErrorResponse
|
|
22
|
+
*/
|
|
23
|
+
'errors'?: Array<Error>;
|
|
24
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
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
|
+
* A single order item.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ConfirmShipmentOrderItem
|
|
16
|
+
*/
|
|
17
|
+
export interface ConfirmShipmentOrderItem {
|
|
18
|
+
/**
|
|
19
|
+
* The unique identifier of the order item.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ConfirmShipmentOrderItem
|
|
22
|
+
*/
|
|
23
|
+
'orderItemId': string;
|
|
24
|
+
/**
|
|
25
|
+
* The quantity of the item.
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof ConfirmShipmentOrderItem
|
|
28
|
+
*/
|
|
29
|
+
'quantity': number;
|
|
30
|
+
/**
|
|
31
|
+
* A list of order items.
|
|
32
|
+
* @type {Array<string>}
|
|
33
|
+
* @memberof ConfirmShipmentOrderItem
|
|
34
|
+
*/
|
|
35
|
+
'transparencyCodes'?: Array<string>;
|
|
36
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
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 { PackageDetail } from './package-detail';
|
|
13
|
+
/**
|
|
14
|
+
* The request schema for an shipment confirmation.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ConfirmShipmentRequest
|
|
17
|
+
*/
|
|
18
|
+
export interface ConfirmShipmentRequest {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {PackageDetail}
|
|
22
|
+
* @memberof ConfirmShipmentRequest
|
|
23
|
+
*/
|
|
24
|
+
'packageDetail': PackageDetail;
|
|
25
|
+
/**
|
|
26
|
+
* The cod collection method, support in JP only.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof ConfirmShipmentRequest
|
|
29
|
+
*/
|
|
30
|
+
'codCollectionMethod'?: ConfirmShipmentRequestCodCollectionMethodEnum;
|
|
31
|
+
/**
|
|
32
|
+
* The unobfuscated marketplace identifier.
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof ConfirmShipmentRequest
|
|
35
|
+
*/
|
|
36
|
+
'marketplaceId': string;
|
|
37
|
+
}
|
|
38
|
+
export declare const ConfirmShipmentRequestCodCollectionMethodEnum: {
|
|
39
|
+
readonly DirectPayment: "DirectPayment";
|
|
40
|
+
};
|
|
41
|
+
export type ConfirmShipmentRequestCodCollectionMethodEnum = typeof ConfirmShipmentRequestCodCollectionMethodEnum[keyof typeof ConfirmShipmentRequestCodCollectionMethodEnum];
|
|
@@ -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,34 +1,50 @@
|
|
|
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';
|
|
5
6
|
export * from './buyer-requested-cancel';
|
|
6
7
|
export * from './buyer-tax-info';
|
|
7
8
|
export * from './buyer-tax-information';
|
|
9
|
+
export * from './confirm-shipment-error-response';
|
|
10
|
+
export * from './confirm-shipment-order-item';
|
|
11
|
+
export * from './confirm-shipment-request';
|
|
8
12
|
export * from './easy-ship-shipment-status';
|
|
9
13
|
export * from './electronic-invoice-status';
|
|
10
14
|
export * from './fulfillment-instruction';
|
|
11
15
|
export * from './get-order-address-response';
|
|
16
|
+
export * from './get-order-approvals-response';
|
|
12
17
|
export * from './get-order-buyer-info-response';
|
|
13
18
|
export * from './get-order-items-buyer-info-response';
|
|
14
19
|
export * from './get-order-items-response';
|
|
15
20
|
export * from './get-order-regulated-info-response';
|
|
16
21
|
export * from './get-order-response';
|
|
17
22
|
export * from './get-orders-response';
|
|
23
|
+
export * from './item-approval';
|
|
24
|
+
export * from './item-approval-action';
|
|
25
|
+
export * from './item-approval-action-changes';
|
|
26
|
+
export * from './item-approval-context';
|
|
27
|
+
export * from './item-approval-status';
|
|
28
|
+
export * from './item-approval-type';
|
|
18
29
|
export * from './item-buyer-info';
|
|
30
|
+
export * from './item-identifier';
|
|
19
31
|
export * from './marketplace-tax-info';
|
|
20
32
|
export * from './model-error';
|
|
21
33
|
export * from './money';
|
|
22
34
|
export * from './order';
|
|
23
35
|
export * from './order-address';
|
|
36
|
+
export * from './order-approvals-response';
|
|
24
37
|
export * from './order-buyer-info';
|
|
25
38
|
export * from './order-item';
|
|
39
|
+
export * from './order-item-approval-request';
|
|
40
|
+
export * from './order-item-approvals';
|
|
26
41
|
export * from './order-item-buyer-info';
|
|
27
42
|
export * from './order-items-buyer-info-list';
|
|
28
43
|
export * from './order-items-inner';
|
|
29
44
|
export * from './order-items-list';
|
|
30
45
|
export * from './order-regulated-info';
|
|
31
46
|
export * from './orders-list';
|
|
47
|
+
export * from './package-detail';
|
|
32
48
|
export * from './payment-execution-detail-item';
|
|
33
49
|
export * from './points-granted-detail';
|
|
34
50
|
export * from './product-info-detail';
|
|
@@ -39,6 +55,8 @@ export * from './rejection-reason';
|
|
|
39
55
|
export * from './shipment-status';
|
|
40
56
|
export * from './tax-classification';
|
|
41
57
|
export * from './tax-collection';
|
|
58
|
+
export * from './update-items-approvals-error-response';
|
|
59
|
+
export * from './update-order-approvals-request';
|
|
42
60
|
export * from './update-shipment-status-error-response';
|
|
43
61
|
export * from './update-shipment-status-request';
|
|
44
62
|
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
|
+
}
|