@sp-api-sdk/orders-api-v0 1.14.0 → 1.16.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 +57 -51
- package/dist/cjs/src/api-model/models/easy-ship-shipment-status.js +39 -0
- package/dist/cjs/src/api-model/models/electronic-invoice-status.js +28 -0
- package/dist/cjs/src/api-model/models/index.js +2 -0
- package/dist/cjs/src/api-model/models/shipment-status.js +1 -1
- package/dist/es/src/api-model/api/orders-v0-api.js +57 -51
- package/dist/es/src/api-model/models/easy-ship-shipment-status.js +36 -0
- package/dist/es/src/api-model/models/electronic-invoice-status.js +25 -0
- package/dist/es/src/api-model/models/index.js +2 -0
- package/dist/es/src/api-model/models/shipment-status.js +1 -1
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +60 -51
- package/dist/types/src/api-model/common.d.ts +1 -0
- package/dist/types/src/api-model/models/automated-shipping-settings.d.ts +1 -1
- package/dist/types/src/api-model/models/buyer-info.d.ts +1 -1
- package/dist/types/src/api-model/models/easy-ship-shipment-status.d.ts +35 -0
- package/dist/types/src/api-model/models/electronic-invoice-status.d.ts +24 -0
- package/dist/types/src/api-model/models/index.d.ts +2 -0
- package/dist/types/src/api-model/models/model-error.d.ts +1 -1
- package/dist/types/src/api-model/models/order-items-inner.d.ts +2 -2
- package/dist/types/src/api-model/models/order-regulated-info.d.ts +1 -1
- package/dist/types/src/api-model/models/order.d.ts +14 -6
- package/dist/types/src/api-model/models/regulated-information-field.d.ts +3 -3
- package/dist/types/src/api-model/models/regulated-order-verification-status.d.ts +1 -1
- package/dist/types/src/api-model/models/rejection-reason.d.ts +1 -1
- package/dist/types/src/api-model/models/shipment-status.d.ts +1 -1
- package/dist/types/src/api-model/models/update-shipment-status-request.d.ts +3 -3
- package/dist/types/src/api-model/models/update-verification-status-request.d.ts +1 -1
- package/package.json +7 -5
|
@@ -27,28 +27,28 @@ import { UpdateVerificationStatusRequest } from '../models';
|
|
|
27
27
|
*/
|
|
28
28
|
export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29
29
|
/**
|
|
30
|
-
* Returns the order
|
|
30
|
+
* 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
31
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
32
32
|
* @param {*} [options] Override http request option.
|
|
33
33
|
* @throws {RequiredError}
|
|
34
34
|
*/
|
|
35
35
|
getOrder: (orderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
36
|
/**
|
|
37
|
-
* Returns the shipping address for the
|
|
37
|
+
* 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).
|
|
38
38
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
39
39
|
* @param {*} [options] Override http request option.
|
|
40
40
|
* @throws {RequiredError}
|
|
41
41
|
*/
|
|
42
42
|
getOrderAddress: (orderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
43
|
/**
|
|
44
|
-
* Returns buyer information for the
|
|
44
|
+
* 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).
|
|
45
45
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
46
46
|
* @param {*} [options] Override http request option.
|
|
47
47
|
* @throws {RequiredError}
|
|
48
48
|
*/
|
|
49
49
|
getOrderBuyerInfo: (orderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50
50
|
/**
|
|
51
|
-
* Returns detailed order item information for the order
|
|
51
|
+
* 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).
|
|
52
52
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
53
53
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
54
54
|
* @param {*} [options] Override http request option.
|
|
@@ -56,7 +56,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
56
56
|
*/
|
|
57
57
|
getOrderItems: (orderId: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
58
|
/**
|
|
59
|
-
* Returns buyer information for the order items in the
|
|
59
|
+
* 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
60
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
61
61
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
62
62
|
* @param {*} [options] Override http request option.
|
|
@@ -64,14 +64,14 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
64
64
|
*/
|
|
65
65
|
getOrderItemsBuyerInfo: (orderId: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
66
|
/**
|
|
67
|
-
* Returns regulated information for the order
|
|
67
|
+
* 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).
|
|
68
68
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
69
69
|
* @param {*} [options] Override http request option.
|
|
70
70
|
* @throws {RequiredError}
|
|
71
71
|
*/
|
|
72
72
|
getOrderRegulatedInfo: (orderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
73
|
/**
|
|
74
|
-
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage
|
|
74
|
+
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage 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).
|
|
75
75
|
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
76
76
|
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
77
77
|
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
@@ -83,7 +83,8 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
83
83
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
84
84
|
* @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.
|
|
85
85
|
* @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.
|
|
86
|
-
* @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy
|
|
86
|
+
* @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 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).
|
|
87
|
+
* @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 (electronic invoice was not submitted for this order), Processing (electronic invoice is being processed for this order), Errored (last submitted electronic invoice was rejected for this order), Accepted (last submitted electronic invoice was submitted and accepted)
|
|
87
88
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
88
89
|
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
89
90
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
@@ -92,19 +93,19 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
92
93
|
* @param {*} [options] Override http request option.
|
|
93
94
|
* @throws {RequiredError}
|
|
94
95
|
*/
|
|
95
|
-
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>, nextToken?: string, amazonOrderIds?: Array<string>, actualFulfillmentSupplySourceId?: string, isISPU?: boolean, storeChainStoreId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
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>;
|
|
96
97
|
/**
|
|
97
|
-
* Update the shipment status. **Usage
|
|
98
|
+
* 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).
|
|
98
99
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
99
|
-
* @param {UpdateShipmentStatusRequest} payload
|
|
100
|
+
* @param {UpdateShipmentStatusRequest} payload The request body for the updateShipmentStatus operation.
|
|
100
101
|
* @param {*} [options] Override http request option.
|
|
101
102
|
* @throws {RequiredError}
|
|
102
103
|
*/
|
|
103
104
|
updateShipmentStatus: (orderId: string, payload: UpdateShipmentStatusRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
104
105
|
/**
|
|
105
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage
|
|
106
|
+
* 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).
|
|
106
107
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
107
|
-
* @param {UpdateVerificationStatusRequest} payload
|
|
108
|
+
* @param {UpdateVerificationStatusRequest} payload The request body for the updateVerificationStatus operation.
|
|
108
109
|
* @param {*} [options] Override http request option.
|
|
109
110
|
* @throws {RequiredError}
|
|
110
111
|
*/
|
|
@@ -116,28 +117,28 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
116
117
|
*/
|
|
117
118
|
export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
118
119
|
/**
|
|
119
|
-
* Returns the order
|
|
120
|
+
* 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).
|
|
120
121
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
121
122
|
* @param {*} [options] Override http request option.
|
|
122
123
|
* @throws {RequiredError}
|
|
123
124
|
*/
|
|
124
125
|
getOrder(orderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderResponse>>;
|
|
125
126
|
/**
|
|
126
|
-
* Returns the shipping address for the
|
|
127
|
+
* 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).
|
|
127
128
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
128
129
|
* @param {*} [options] Override http request option.
|
|
129
130
|
* @throws {RequiredError}
|
|
130
131
|
*/
|
|
131
132
|
getOrderAddress(orderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderAddressResponse>>;
|
|
132
133
|
/**
|
|
133
|
-
* Returns buyer information for the
|
|
134
|
+
* 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).
|
|
134
135
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
135
136
|
* @param {*} [options] Override http request option.
|
|
136
137
|
* @throws {RequiredError}
|
|
137
138
|
*/
|
|
138
139
|
getOrderBuyerInfo(orderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderBuyerInfoResponse>>;
|
|
139
140
|
/**
|
|
140
|
-
* Returns detailed order item information for the order
|
|
141
|
+
* 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).
|
|
141
142
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
142
143
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
143
144
|
* @param {*} [options] Override http request option.
|
|
@@ -145,7 +146,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
145
146
|
*/
|
|
146
147
|
getOrderItems(orderId: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsResponse>>;
|
|
147
148
|
/**
|
|
148
|
-
* Returns buyer information for the order items in the
|
|
149
|
+
* 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).
|
|
149
150
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
150
151
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
151
152
|
* @param {*} [options] Override http request option.
|
|
@@ -153,14 +154,14 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
153
154
|
*/
|
|
154
155
|
getOrderItemsBuyerInfo(orderId: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsBuyerInfoResponse>>;
|
|
155
156
|
/**
|
|
156
|
-
* Returns regulated information for the order
|
|
157
|
+
* 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).
|
|
157
158
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
158
159
|
* @param {*} [options] Override http request option.
|
|
159
160
|
* @throws {RequiredError}
|
|
160
161
|
*/
|
|
161
162
|
getOrderRegulatedInfo(orderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderRegulatedInfoResponse>>;
|
|
162
163
|
/**
|
|
163
|
-
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage
|
|
164
|
+
* 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).
|
|
164
165
|
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
165
166
|
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
166
167
|
* @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.
|
|
@@ -172,7 +173,8 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
172
173
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
173
174
|
* @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.
|
|
174
175
|
* @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.
|
|
175
|
-
* @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy
|
|
176
|
+
* @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 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).
|
|
177
|
+
* @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 (electronic invoice was not submitted for this order), Processing (electronic invoice is being processed for this order), Errored (last submitted electronic invoice was rejected for this order), Accepted (last submitted electronic invoice was submitted and accepted)
|
|
176
178
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
177
179
|
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
178
180
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
@@ -181,19 +183,19 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
181
183
|
* @param {*} [options] Override http request option.
|
|
182
184
|
* @throws {RequiredError}
|
|
183
185
|
*/
|
|
184
|
-
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>, nextToken?: string, amazonOrderIds?: Array<string>, actualFulfillmentSupplySourceId?: string, isISPU?: boolean, storeChainStoreId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrdersResponse>>;
|
|
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>>;
|
|
185
187
|
/**
|
|
186
|
-
* Update the shipment status. **Usage
|
|
188
|
+
* 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).
|
|
187
189
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
188
|
-
* @param {UpdateShipmentStatusRequest} payload
|
|
190
|
+
* @param {UpdateShipmentStatusRequest} payload The request body for the updateShipmentStatus operation.
|
|
189
191
|
* @param {*} [options] Override http request option.
|
|
190
192
|
* @throws {RequiredError}
|
|
191
193
|
*/
|
|
192
194
|
updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
193
195
|
/**
|
|
194
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage
|
|
196
|
+
* 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).
|
|
195
197
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
196
|
-
* @param {UpdateVerificationStatusRequest} payload
|
|
198
|
+
* @param {UpdateVerificationStatusRequest} payload The request body for the updateVerificationStatus operation.
|
|
197
199
|
* @param {*} [options] Override http request option.
|
|
198
200
|
* @throws {RequiredError}
|
|
199
201
|
*/
|
|
@@ -205,28 +207,28 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
205
207
|
*/
|
|
206
208
|
export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
207
209
|
/**
|
|
208
|
-
* Returns the order
|
|
210
|
+
* 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).
|
|
209
211
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
210
212
|
* @param {*} [options] Override http request option.
|
|
211
213
|
* @throws {RequiredError}
|
|
212
214
|
*/
|
|
213
215
|
getOrder(orderId: string, options?: any): AxiosPromise<GetOrderResponse>;
|
|
214
216
|
/**
|
|
215
|
-
* Returns the shipping address for the
|
|
217
|
+
* 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).
|
|
216
218
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
217
219
|
* @param {*} [options] Override http request option.
|
|
218
220
|
* @throws {RequiredError}
|
|
219
221
|
*/
|
|
220
222
|
getOrderAddress(orderId: string, options?: any): AxiosPromise<GetOrderAddressResponse>;
|
|
221
223
|
/**
|
|
222
|
-
* Returns buyer information for the
|
|
224
|
+
* 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).
|
|
223
225
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
224
226
|
* @param {*} [options] Override http request option.
|
|
225
227
|
* @throws {RequiredError}
|
|
226
228
|
*/
|
|
227
229
|
getOrderBuyerInfo(orderId: string, options?: any): AxiosPromise<GetOrderBuyerInfoResponse>;
|
|
228
230
|
/**
|
|
229
|
-
* Returns detailed order item information for the order
|
|
231
|
+
* 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).
|
|
230
232
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
231
233
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
232
234
|
* @param {*} [options] Override http request option.
|
|
@@ -234,7 +236,7 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePat
|
|
|
234
236
|
*/
|
|
235
237
|
getOrderItems(orderId: string, nextToken?: string, options?: any): AxiosPromise<GetOrderItemsResponse>;
|
|
236
238
|
/**
|
|
237
|
-
* Returns buyer information for the order items in the
|
|
239
|
+
* 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).
|
|
238
240
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
239
241
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
240
242
|
* @param {*} [options] Override http request option.
|
|
@@ -242,14 +244,14 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePat
|
|
|
242
244
|
*/
|
|
243
245
|
getOrderItemsBuyerInfo(orderId: string, nextToken?: string, options?: any): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
|
|
244
246
|
/**
|
|
245
|
-
* Returns regulated information for the order
|
|
247
|
+
* 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).
|
|
246
248
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
247
249
|
* @param {*} [options] Override http request option.
|
|
248
250
|
* @throws {RequiredError}
|
|
249
251
|
*/
|
|
250
252
|
getOrderRegulatedInfo(orderId: string, options?: any): AxiosPromise<GetOrderRegulatedInfoResponse>;
|
|
251
253
|
/**
|
|
252
|
-
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage
|
|
254
|
+
* 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).
|
|
253
255
|
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
254
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.
|
|
255
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.
|
|
@@ -261,7 +263,8 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePat
|
|
|
261
263
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
262
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.
|
|
263
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.
|
|
264
|
-
* @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy
|
|
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 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 (electronic invoice was not submitted for this order), Processing (electronic invoice is being processed for this order), Errored (last submitted electronic invoice was rejected for this order), Accepted (last submitted electronic invoice was submitted and accepted)
|
|
265
268
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
266
269
|
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
267
270
|
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
@@ -270,19 +273,19 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePat
|
|
|
270
273
|
* @param {*} [options] Override http request option.
|
|
271
274
|
* @throws {RequiredError}
|
|
272
275
|
*/
|
|
273
|
-
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>, nextToken?: string, amazonOrderIds?: Array<string>, actualFulfillmentSupplySourceId?: string, isISPU?: boolean, storeChainStoreId?: string, options?: any): AxiosPromise<GetOrdersResponse>;
|
|
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>;
|
|
274
277
|
/**
|
|
275
|
-
* Update the shipment status. **Usage
|
|
278
|
+
* 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).
|
|
276
279
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
277
|
-
* @param {UpdateShipmentStatusRequest} payload
|
|
280
|
+
* @param {UpdateShipmentStatusRequest} payload The request body for the updateShipmentStatus operation.
|
|
278
281
|
* @param {*} [options] Override http request option.
|
|
279
282
|
* @throws {RequiredError}
|
|
280
283
|
*/
|
|
281
284
|
updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: any): AxiosPromise<void>;
|
|
282
285
|
/**
|
|
283
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage
|
|
286
|
+
* 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).
|
|
284
287
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
285
|
-
* @param {UpdateVerificationStatusRequest} payload
|
|
288
|
+
* @param {UpdateVerificationStatusRequest} payload The request body for the updateVerificationStatus operation.
|
|
286
289
|
* @param {*} [options] Override http request option.
|
|
287
290
|
* @throws {RequiredError}
|
|
288
291
|
*/
|
|
@@ -451,11 +454,17 @@ export interface OrdersV0ApiGetOrdersRequest {
|
|
|
451
454
|
*/
|
|
452
455
|
readonly maxResultsPerPage?: number;
|
|
453
456
|
/**
|
|
454
|
-
* A list of EasyShipShipmentStatus values. Used to select Easy
|
|
457
|
+
* 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 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).
|
|
455
458
|
* @type {Array<string>}
|
|
456
459
|
* @memberof OrdersV0ApiGetOrders
|
|
457
460
|
*/
|
|
458
461
|
readonly easyShipShipmentStatuses?: Array<string>;
|
|
462
|
+
/**
|
|
463
|
+
* 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 (electronic invoice was not submitted for this order), Processing (electronic invoice is being processed for this order), Errored (last submitted electronic invoice was rejected for this order), Accepted (last submitted electronic invoice was submitted and accepted)
|
|
464
|
+
* @type {Array<string>}
|
|
465
|
+
* @memberof OrdersV0ApiGetOrders
|
|
466
|
+
*/
|
|
467
|
+
readonly electronicInvoiceStatuses?: Array<string>;
|
|
459
468
|
/**
|
|
460
469
|
* A string token returned in the response of your previous request.
|
|
461
470
|
* @type {string}
|
|
@@ -500,7 +509,7 @@ export interface OrdersV0ApiUpdateShipmentStatusRequest {
|
|
|
500
509
|
*/
|
|
501
510
|
readonly orderId: string;
|
|
502
511
|
/**
|
|
503
|
-
*
|
|
512
|
+
* The request body for the updateShipmentStatus operation.
|
|
504
513
|
* @type {UpdateShipmentStatusRequest}
|
|
505
514
|
* @memberof OrdersV0ApiUpdateShipmentStatus
|
|
506
515
|
*/
|
|
@@ -519,7 +528,7 @@ export interface OrdersV0ApiUpdateVerificationStatusRequest {
|
|
|
519
528
|
*/
|
|
520
529
|
readonly orderId: string;
|
|
521
530
|
/**
|
|
522
|
-
*
|
|
531
|
+
* The request body for the updateVerificationStatus operation.
|
|
523
532
|
* @type {UpdateVerificationStatusRequest}
|
|
524
533
|
* @memberof OrdersV0ApiUpdateVerificationStatus
|
|
525
534
|
*/
|
|
@@ -533,7 +542,7 @@ export interface OrdersV0ApiUpdateVerificationStatusRequest {
|
|
|
533
542
|
*/
|
|
534
543
|
export declare class OrdersV0Api extends BaseAPI {
|
|
535
544
|
/**
|
|
536
|
-
* Returns the order
|
|
545
|
+
* 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).
|
|
537
546
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
538
547
|
* @param {*} [options] Override http request option.
|
|
539
548
|
* @throws {RequiredError}
|
|
@@ -541,7 +550,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
541
550
|
*/
|
|
542
551
|
getOrder(requestParameters: OrdersV0ApiGetOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderResponse, any>>;
|
|
543
552
|
/**
|
|
544
|
-
* Returns the shipping address for the
|
|
553
|
+
* 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).
|
|
545
554
|
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
546
555
|
* @param {*} [options] Override http request option.
|
|
547
556
|
* @throws {RequiredError}
|
|
@@ -549,7 +558,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
549
558
|
*/
|
|
550
559
|
getOrderAddress(requestParameters: OrdersV0ApiGetOrderAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderAddressResponse, any>>;
|
|
551
560
|
/**
|
|
552
|
-
* Returns buyer information for the
|
|
561
|
+
* 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).
|
|
553
562
|
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
554
563
|
* @param {*} [options] Override http request option.
|
|
555
564
|
* @throws {RequiredError}
|
|
@@ -557,7 +566,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
557
566
|
*/
|
|
558
567
|
getOrderBuyerInfo(requestParameters: OrdersV0ApiGetOrderBuyerInfoRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderBuyerInfoResponse, any>>;
|
|
559
568
|
/**
|
|
560
|
-
* Returns detailed order item information for the order
|
|
569
|
+
* 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).
|
|
561
570
|
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
562
571
|
* @param {*} [options] Override http request option.
|
|
563
572
|
* @throws {RequiredError}
|
|
@@ -565,7 +574,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
565
574
|
*/
|
|
566
575
|
getOrderItems(requestParameters: OrdersV0ApiGetOrderItemsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderItemsResponse, any>>;
|
|
567
576
|
/**
|
|
568
|
-
* Returns buyer information for the order items in the
|
|
577
|
+
* 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).
|
|
569
578
|
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
570
579
|
* @param {*} [options] Override http request option.
|
|
571
580
|
* @throws {RequiredError}
|
|
@@ -573,7 +582,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
573
582
|
*/
|
|
574
583
|
getOrderItemsBuyerInfo(requestParameters: OrdersV0ApiGetOrderItemsBuyerInfoRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderItemsBuyerInfoResponse, any>>;
|
|
575
584
|
/**
|
|
576
|
-
* Returns regulated information for the order
|
|
585
|
+
* 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).
|
|
577
586
|
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
578
587
|
* @param {*} [options] Override http request option.
|
|
579
588
|
* @throws {RequiredError}
|
|
@@ -581,7 +590,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
581
590
|
*/
|
|
582
591
|
getOrderRegulatedInfo(requestParameters: OrdersV0ApiGetOrderRegulatedInfoRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderRegulatedInfoResponse, any>>;
|
|
583
592
|
/**
|
|
584
|
-
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage
|
|
593
|
+
* 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).
|
|
585
594
|
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
586
595
|
* @param {*} [options] Override http request option.
|
|
587
596
|
* @throws {RequiredError}
|
|
@@ -589,7 +598,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
589
598
|
*/
|
|
590
599
|
getOrders(requestParameters: OrdersV0ApiGetOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrdersResponse, any>>;
|
|
591
600
|
/**
|
|
592
|
-
* Update the shipment status. **Usage
|
|
601
|
+
* 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).
|
|
593
602
|
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
594
603
|
* @param {*} [options] Override http request option.
|
|
595
604
|
* @throws {RequiredError}
|
|
@@ -597,7 +606,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
597
606
|
*/
|
|
598
607
|
updateShipmentStatus(requestParameters: OrdersV0ApiUpdateShipmentStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
599
608
|
/**
|
|
600
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage
|
|
609
|
+
* 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).
|
|
601
610
|
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
602
611
|
* @param {*} [options] Override http request option.
|
|
603
612
|
* @throws {RequiredError}
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface AutomatedShippingSettings {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* When true, this order has automated shipping settings generated by Amazon. This order could be identified as an SSA order.
|
|
20
20
|
* @type {boolean}
|
|
21
21
|
* @memberof AutomatedShippingSettings
|
|
22
22
|
*/
|