@sp-api-sdk/orders-api-v0 5.0.0 → 5.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api-model/api/orders-api.js +48 -64
- package/dist/cjs/api-model/base.js +0 -19
- package/dist/cjs/api-model/common.js +0 -37
- package/dist/cjs/api-model/configuration.js +0 -17
- package/dist/cjs/api-model/models/association-type.js +0 -2
- package/dist/cjs/api-model/models/constraint-type.js +0 -2
- package/dist/cjs/api-model/models/easy-ship-shipment-status.js +0 -2
- package/dist/cjs/api-model/models/electronic-invoice-status.js +0 -2
- package/dist/cjs/api-model/models/index.js +0 -1
- package/dist/cjs/api-model/models/other-delivery-attributes.js +0 -2
- package/dist/cjs/api-model/models/shipment-status.js +0 -2
- package/dist/cjs/api-model/models/verification-status.js +0 -2
- package/dist/es/api-model/api/orders-api.js +48 -64
- package/dist/es/api-model/base.js +0 -19
- package/dist/es/api-model/common.js +0 -37
- package/dist/es/api-model/configuration.js +0 -17
- package/dist/es/api-model/models/association-type.js +0 -2
- package/dist/es/api-model/models/constraint-type.js +0 -2
- package/dist/es/api-model/models/easy-ship-shipment-status.js +0 -2
- package/dist/es/api-model/models/electronic-invoice-status.js +0 -2
- package/dist/es/api-model/models/index.js +0 -1
- package/dist/es/api-model/models/other-delivery-attributes.js +0 -2
- package/dist/es/api-model/models/shipment-status.js +0 -2
- package/dist/es/api-model/models/verification-status.js +0 -2
- package/dist/types/api-model/api/orders-api.d.ts +52 -160
- package/dist/types/api-model/base.d.ts +0 -24
- package/dist/types/api-model/common.d.ts +0 -37
- package/dist/types/api-model/configuration.d.ts +0 -17
- package/dist/types/api-model/models/address-extended-fields.d.ts +0 -10
- package/dist/types/api-model/models/address.d.ts +0 -35
- package/dist/types/api-model/models/amazon-programs.d.ts +2 -6
- package/dist/types/api-model/models/associated-item.d.ts +0 -11
- package/dist/types/api-model/models/association-type.d.ts +0 -2
- package/dist/types/api-model/models/automated-shipping-settings.d.ts +0 -8
- package/dist/types/api-model/models/business-hours.d.ts +0 -6
- package/dist/types/api-model/models/buyer-customized-info-detail.d.ts +0 -4
- package/dist/types/api-model/models/buyer-info.d.ts +0 -15
- package/dist/types/api-model/models/buyer-requested-cancel.d.ts +0 -6
- package/dist/types/api-model/models/buyer-tax-info.d.ts +0 -8
- package/dist/types/api-model/models/buyer-tax-information.d.ts +0 -10
- package/dist/types/api-model/models/confirm-shipment-error-response.d.ts +0 -4
- package/dist/types/api-model/models/confirm-shipment-order-item.d.ts +0 -8
- package/dist/types/api-model/models/confirm-shipment-request.d.ts +0 -11
- package/dist/types/api-model/models/constraint-type.d.ts +0 -2
- package/dist/types/api-model/models/delivery-preferences.d.ts +0 -13
- package/dist/types/api-model/models/easy-ship-shipment-status.d.ts +0 -2
- package/dist/types/api-model/models/electronic-invoice-status.d.ts +0 -2
- package/dist/types/api-model/models/exception-dates.d.ts +0 -8
- package/dist/types/api-model/models/fulfillment-instruction.d.ts +0 -4
- package/dist/types/api-model/models/get-order-address-response.d.ts +0 -9
- package/dist/types/api-model/models/get-order-buyer-info-response.d.ts +0 -9
- package/dist/types/api-model/models/get-order-items-buyer-info-response.d.ts +0 -9
- package/dist/types/api-model/models/get-order-items-response.d.ts +0 -9
- package/dist/types/api-model/models/get-order-regulated-info-response.d.ts +0 -9
- package/dist/types/api-model/models/get-order-response.d.ts +0 -9
- package/dist/types/api-model/models/get-orders-response.d.ts +0 -9
- package/dist/types/api-model/models/index.d.ts +0 -1
- package/dist/types/api-model/models/item-buyer-info.d.ts +0 -21
- package/dist/types/api-model/models/marketplace-tax-info.d.ts +0 -4
- package/dist/types/api-model/models/measurement.d.ts +0 -6
- package/dist/types/api-model/models/model-error.d.ts +0 -8
- package/dist/types/api-model/models/money.d.ts +0 -6
- package/dist/types/api-model/models/open-interval.d.ts +0 -12
- package/dist/types/api-model/models/open-time-interval.d.ts +0 -6
- package/dist/types/api-model/models/order-address.d.ts +0 -16
- package/dist/types/api-model/models/order-buyer-info.d.ts +0 -17
- package/dist/types/api-model/models/order-item-buyer-info.d.ts +0 -23
- package/dist/types/api-model/models/order-item.d.ts +0 -146
- package/dist/types/api-model/models/order-items-buyer-info-list.d.ts +0 -8
- package/dist/types/api-model/models/order-items-inner.d.ts +0 -9
- package/dist/types/api-model/models/order-items-list.d.ts +0 -8
- package/dist/types/api-model/models/order-regulated-info.d.ts +0 -16
- package/dist/types/api-model/models/order.d.ts +0 -126
- package/dist/types/api-model/models/orders-list.d.ts +1 -11
- package/dist/types/api-model/models/other-delivery-attributes.d.ts +0 -2
- package/dist/types/api-model/models/package-detail.d.ts +1 -19
- package/dist/types/api-model/models/payment-execution-detail-item.d.ts +0 -9
- package/dist/types/api-model/models/points-granted-detail.d.ts +0 -9
- package/dist/types/api-model/models/preferred-delivery-time.d.ts +0 -6
- package/dist/types/api-model/models/prescription-detail.d.ts +0 -16
- package/dist/types/api-model/models/product-info-detail.d.ts +0 -4
- package/dist/types/api-model/models/regulated-information-field.d.ts +0 -10
- package/dist/types/api-model/models/regulated-information.d.ts +0 -4
- package/dist/types/api-model/models/regulated-order-verification-status.d.ts +0 -22
- package/dist/types/api-model/models/rejection-reason.d.ts +0 -6
- package/dist/types/api-model/models/shipment-status.d.ts +0 -2
- package/dist/types/api-model/models/shipping-constraints.d.ts +0 -22
- package/dist/types/api-model/models/substitution-option.d.ts +0 -15
- package/dist/types/api-model/models/substitution-preferences.d.ts +0 -6
- package/dist/types/api-model/models/tax-classification.d.ts +0 -6
- package/dist/types/api-model/models/tax-collection.d.ts +0 -6
- package/dist/types/api-model/models/update-shipment-status-error-response.d.ts +0 -4
- package/dist/types/api-model/models/update-shipment-status-request.d.ts +0 -11
- package/dist/types/api-model/models/update-verification-status-error-response.d.ts +0 -4
- package/dist/types/api-model/models/update-verification-status-request-body.d.ts +0 -16
- package/dist/types/api-model/models/update-verification-status-request.d.ts +0 -7
- package/dist/types/api-model/models/valid-verification-detail.d.ts +0 -6
- package/dist/types/api-model/models/verification-details.d.ts +0 -7
- package/dist/types/api-model/models/verification-status.d.ts +0 -2
- package/package.json +25 -4
- package/dist/cjs/api-model/models/export-info.js +0 -15
- package/dist/es/api-model/models/export-info.js +0 -14
- package/dist/types/api-model/models/export-info.d.ts +0 -31
|
@@ -25,11 +25,10 @@ import type { UpdateShipmentStatusRequest } from '../models';
|
|
|
25
25
|
import type { UpdateVerificationStatusRequest } from '../models';
|
|
26
26
|
/**
|
|
27
27
|
* OrdersApi - axios parameter creator
|
|
28
|
-
* @export
|
|
29
28
|
*/
|
|
30
29
|
export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
31
30
|
/**
|
|
32
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
31
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
33
32
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
34
33
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
35
34
|
* @param {*} [options] Override http request option.
|
|
@@ -37,28 +36,28 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
37
36
|
*/
|
|
38
37
|
confirmShipment: (orderId: string, payload: ConfirmShipmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
38
|
/**
|
|
40
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
39
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
41
40
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
42
41
|
* @param {*} [options] Override http request option.
|
|
43
42
|
* @throws {RequiredError}
|
|
44
43
|
*/
|
|
45
44
|
getOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
45
|
/**
|
|
47
|
-
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
48
|
-
* @param {string} orderId
|
|
46
|
+
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
47
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
49
48
|
* @param {*} [options] Override http request option.
|
|
50
49
|
* @throws {RequiredError}
|
|
51
50
|
*/
|
|
52
51
|
getOrderAddress: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
52
|
/**
|
|
54
|
-
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
55
|
-
* @param {string} orderId
|
|
53
|
+
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
54
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
56
55
|
* @param {*} [options] Override http request option.
|
|
57
56
|
* @throws {RequiredError}
|
|
58
57
|
*/
|
|
59
58
|
getOrderBuyerInfo: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
59
|
/**
|
|
61
|
-
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
60
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
62
61
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
63
62
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
64
63
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +65,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
66
65
|
*/
|
|
67
66
|
getOrderItems: (orderId: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
67
|
/**
|
|
69
|
-
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
68
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
70
69
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
71
70
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
72
71
|
* @param {*} [options] Override http request option.
|
|
@@ -74,14 +73,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
74
73
|
*/
|
|
75
74
|
getOrderItemsBuyerInfo: (orderId: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
75
|
/**
|
|
77
|
-
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
78
|
-
* @param {string} orderId
|
|
76
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
77
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
79
78
|
* @param {*} [options] Override http request option.
|
|
80
79
|
* @throws {RequiredError}
|
|
81
80
|
*/
|
|
82
81
|
getOrderRegulatedInfo: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83
82
|
/**
|
|
84
|
-
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header
|
|
83
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
85
84
|
* @param {Array<string>} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
|
|
86
85
|
* @param {string} [createdAfter] Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.
|
|
87
86
|
* @param {string} [createdBefore] Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time.
|
|
@@ -109,7 +108,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
109
108
|
*/
|
|
110
109
|
getOrders: (marketplaceIds: Array<string>, createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, orderStatuses?: Array<string>, fulfillmentChannels?: Array<string>, paymentMethods?: Array<string>, buyerEmail?: string, sellerOrderId?: string, maxResultsPerPage?: number, easyShipShipmentStatuses?: Array<string>, electronicInvoiceStatuses?: Array<string>, nextToken?: string, amazonOrderIds?: Array<string>, actualFulfillmentSupplySourceId?: string, isISPU?: boolean, storeChainStoreId?: string, earliestDeliveryDateBefore?: string, earliestDeliveryDateAfter?: string, latestDeliveryDateBefore?: string, latestDeliveryDateAfter?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
111
110
|
/**
|
|
112
|
-
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header
|
|
111
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
113
112
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
114
113
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
115
114
|
* @param {*} [options] Override http request option.
|
|
@@ -117,8 +116,8 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
117
116
|
*/
|
|
118
117
|
updateShipmentStatus: (orderId: string, payload: UpdateShipmentStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
119
118
|
/**
|
|
120
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
121
|
-
* @param {string} orderId
|
|
119
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
120
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
122
121
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
123
122
|
* @param {*} [options] Override http request option.
|
|
124
123
|
* @throws {RequiredError}
|
|
@@ -127,11 +126,10 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
127
126
|
};
|
|
128
127
|
/**
|
|
129
128
|
* OrdersApi - functional programming interface
|
|
130
|
-
* @export
|
|
131
129
|
*/
|
|
132
130
|
export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
133
131
|
/**
|
|
134
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
132
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
135
133
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
136
134
|
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
137
135
|
* @param {*} [options] Override http request option.
|
|
@@ -139,28 +137,28 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
139
137
|
*/
|
|
140
138
|
confirmShipment(orderId: string, payload: ConfirmShipmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
141
139
|
/**
|
|
142
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
140
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
143
141
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
144
142
|
* @param {*} [options] Override http request option.
|
|
145
143
|
* @throws {RequiredError}
|
|
146
144
|
*/
|
|
147
145
|
getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderResponse>>;
|
|
148
146
|
/**
|
|
149
|
-
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
150
|
-
* @param {string} orderId
|
|
147
|
+
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
148
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
151
149
|
* @param {*} [options] Override http request option.
|
|
152
150
|
* @throws {RequiredError}
|
|
153
151
|
*/
|
|
154
152
|
getOrderAddress(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderAddressResponse>>;
|
|
155
153
|
/**
|
|
156
|
-
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
157
|
-
* @param {string} orderId
|
|
154
|
+
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
155
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
158
156
|
* @param {*} [options] Override http request option.
|
|
159
157
|
* @throws {RequiredError}
|
|
160
158
|
*/
|
|
161
159
|
getOrderBuyerInfo(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderBuyerInfoResponse>>;
|
|
162
160
|
/**
|
|
163
|
-
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
161
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
164
162
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
165
163
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
166
164
|
* @param {*} [options] Override http request option.
|
|
@@ -168,7 +166,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
168
166
|
*/
|
|
169
167
|
getOrderItems(orderId: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsResponse>>;
|
|
170
168
|
/**
|
|
171
|
-
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
169
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
172
170
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
173
171
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
174
172
|
* @param {*} [options] Override http request option.
|
|
@@ -176,14 +174,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
176
174
|
*/
|
|
177
175
|
getOrderItemsBuyerInfo(orderId: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsBuyerInfoResponse>>;
|
|
178
176
|
/**
|
|
179
|
-
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
180
|
-
* @param {string} orderId
|
|
177
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
178
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
181
179
|
* @param {*} [options] Override http request option.
|
|
182
180
|
* @throws {RequiredError}
|
|
183
181
|
*/
|
|
184
182
|
getOrderRegulatedInfo(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderRegulatedInfoResponse>>;
|
|
185
183
|
/**
|
|
186
|
-
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header
|
|
184
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
187
185
|
* @param {Array<string>} marketplaceIds A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
|
|
188
186
|
* @param {string} [createdAfter] Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.
|
|
189
187
|
* @param {string} [createdBefore] Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time.
|
|
@@ -211,7 +209,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
211
209
|
*/
|
|
212
210
|
getOrders(marketplaceIds: Array<string>, createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, orderStatuses?: Array<string>, fulfillmentChannels?: Array<string>, paymentMethods?: Array<string>, buyerEmail?: string, sellerOrderId?: string, maxResultsPerPage?: number, easyShipShipmentStatuses?: Array<string>, electronicInvoiceStatuses?: Array<string>, nextToken?: string, amazonOrderIds?: Array<string>, actualFulfillmentSupplySourceId?: string, isISPU?: boolean, storeChainStoreId?: string, earliestDeliveryDateBefore?: string, earliestDeliveryDateAfter?: string, latestDeliveryDateBefore?: string, latestDeliveryDateAfter?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrdersResponse>>;
|
|
213
211
|
/**
|
|
214
|
-
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header
|
|
212
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
215
213
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
216
214
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
217
215
|
* @param {*} [options] Override http request option.
|
|
@@ -219,8 +217,8 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
219
217
|
*/
|
|
220
218
|
updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
221
219
|
/**
|
|
222
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
223
|
-
* @param {string} orderId
|
|
220
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
221
|
+
* @param {string} orderId The Amazon order identifier in 3-7-7 format.
|
|
224
222
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
225
223
|
* @param {*} [options] Override http request option.
|
|
226
224
|
* @throws {RequiredError}
|
|
@@ -229,74 +227,73 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
229
227
|
};
|
|
230
228
|
/**
|
|
231
229
|
* OrdersApi - factory interface
|
|
232
|
-
* @export
|
|
233
230
|
*/
|
|
234
231
|
export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
235
232
|
/**
|
|
236
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
233
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
237
234
|
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
238
235
|
* @param {*} [options] Override http request option.
|
|
239
236
|
* @throws {RequiredError}
|
|
240
237
|
*/
|
|
241
238
|
confirmShipment(requestParameters: OrdersApiConfirmShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
242
239
|
/**
|
|
243
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
240
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
244
241
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
245
242
|
* @param {*} [options] Override http request option.
|
|
246
243
|
* @throws {RequiredError}
|
|
247
244
|
*/
|
|
248
245
|
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderResponse>;
|
|
249
246
|
/**
|
|
250
|
-
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
247
|
+
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
251
248
|
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
252
249
|
* @param {*} [options] Override http request option.
|
|
253
250
|
* @throws {RequiredError}
|
|
254
251
|
*/
|
|
255
252
|
getOrderAddress(requestParameters: OrdersApiGetOrderAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderAddressResponse>;
|
|
256
253
|
/**
|
|
257
|
-
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
254
|
+
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
258
255
|
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
259
256
|
* @param {*} [options] Override http request option.
|
|
260
257
|
* @throws {RequiredError}
|
|
261
258
|
*/
|
|
262
259
|
getOrderBuyerInfo(requestParameters: OrdersApiGetOrderBuyerInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderBuyerInfoResponse>;
|
|
263
260
|
/**
|
|
264
|
-
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
261
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
265
262
|
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
266
263
|
* @param {*} [options] Override http request option.
|
|
267
264
|
* @throws {RequiredError}
|
|
268
265
|
*/
|
|
269
266
|
getOrderItems(requestParameters: OrdersApiGetOrderItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderItemsResponse>;
|
|
270
267
|
/**
|
|
271
|
-
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
268
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
272
269
|
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
273
270
|
* @param {*} [options] Override http request option.
|
|
274
271
|
* @throws {RequiredError}
|
|
275
272
|
*/
|
|
276
273
|
getOrderItemsBuyerInfo(requestParameters: OrdersApiGetOrderItemsBuyerInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
|
|
277
274
|
/**
|
|
278
|
-
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
275
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
279
276
|
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
280
277
|
* @param {*} [options] Override http request option.
|
|
281
278
|
* @throws {RequiredError}
|
|
282
279
|
*/
|
|
283
280
|
getOrderRegulatedInfo(requestParameters: OrdersApiGetOrderRegulatedInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderRegulatedInfoResponse>;
|
|
284
281
|
/**
|
|
285
|
-
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header
|
|
282
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
286
283
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
287
284
|
* @param {*} [options] Override http request option.
|
|
288
285
|
* @throws {RequiredError}
|
|
289
286
|
*/
|
|
290
287
|
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrdersResponse>;
|
|
291
288
|
/**
|
|
292
|
-
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header
|
|
289
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
293
290
|
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
294
291
|
* @param {*} [options] Override http request option.
|
|
295
292
|
* @throws {RequiredError}
|
|
296
293
|
*/
|
|
297
294
|
updateShipmentStatus(requestParameters: OrdersApiUpdateShipmentStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
298
295
|
/**
|
|
299
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
296
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
300
297
|
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
301
298
|
* @param {*} [options] Override http request option.
|
|
302
299
|
* @throws {RequiredError}
|
|
@@ -305,375 +302,270 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
305
302
|
};
|
|
306
303
|
/**
|
|
307
304
|
* Request parameters for confirmShipment operation in OrdersApi.
|
|
308
|
-
* @export
|
|
309
|
-
* @interface OrdersApiConfirmShipmentRequest
|
|
310
305
|
*/
|
|
311
306
|
export interface OrdersApiConfirmShipmentRequest {
|
|
312
307
|
/**
|
|
313
308
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
314
|
-
* @type {string}
|
|
315
|
-
* @memberof OrdersApiConfirmShipment
|
|
316
309
|
*/
|
|
317
310
|
readonly orderId: string;
|
|
318
311
|
/**
|
|
319
312
|
* Request body of `confirmShipment`.
|
|
320
|
-
* @type {ConfirmShipmentRequest}
|
|
321
|
-
* @memberof OrdersApiConfirmShipment
|
|
322
313
|
*/
|
|
323
314
|
readonly payload: ConfirmShipmentRequest;
|
|
324
315
|
}
|
|
325
316
|
/**
|
|
326
317
|
* Request parameters for getOrder operation in OrdersApi.
|
|
327
|
-
* @export
|
|
328
|
-
* @interface OrdersApiGetOrderRequest
|
|
329
318
|
*/
|
|
330
319
|
export interface OrdersApiGetOrderRequest {
|
|
331
320
|
/**
|
|
332
321
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
333
|
-
* @type {string}
|
|
334
|
-
* @memberof OrdersApiGetOrder
|
|
335
322
|
*/
|
|
336
323
|
readonly orderId: string;
|
|
337
324
|
}
|
|
338
325
|
/**
|
|
339
326
|
* Request parameters for getOrderAddress operation in OrdersApi.
|
|
340
|
-
* @export
|
|
341
|
-
* @interface OrdersApiGetOrderAddressRequest
|
|
342
327
|
*/
|
|
343
328
|
export interface OrdersApiGetOrderAddressRequest {
|
|
344
329
|
/**
|
|
345
|
-
*
|
|
346
|
-
* @type {string}
|
|
347
|
-
* @memberof OrdersApiGetOrderAddress
|
|
330
|
+
* The Amazon order identifier in 3-7-7 format.
|
|
348
331
|
*/
|
|
349
332
|
readonly orderId: string;
|
|
350
333
|
}
|
|
351
334
|
/**
|
|
352
335
|
* Request parameters for getOrderBuyerInfo operation in OrdersApi.
|
|
353
|
-
* @export
|
|
354
|
-
* @interface OrdersApiGetOrderBuyerInfoRequest
|
|
355
336
|
*/
|
|
356
337
|
export interface OrdersApiGetOrderBuyerInfoRequest {
|
|
357
338
|
/**
|
|
358
|
-
*
|
|
359
|
-
* @type {string}
|
|
360
|
-
* @memberof OrdersApiGetOrderBuyerInfo
|
|
339
|
+
* The Amazon order identifier in 3-7-7 format.
|
|
361
340
|
*/
|
|
362
341
|
readonly orderId: string;
|
|
363
342
|
}
|
|
364
343
|
/**
|
|
365
344
|
* Request parameters for getOrderItems operation in OrdersApi.
|
|
366
|
-
* @export
|
|
367
|
-
* @interface OrdersApiGetOrderItemsRequest
|
|
368
345
|
*/
|
|
369
346
|
export interface OrdersApiGetOrderItemsRequest {
|
|
370
347
|
/**
|
|
371
348
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
372
|
-
* @type {string}
|
|
373
|
-
* @memberof OrdersApiGetOrderItems
|
|
374
349
|
*/
|
|
375
350
|
readonly orderId: string;
|
|
376
351
|
/**
|
|
377
352
|
* A string token returned in the response of your previous request.
|
|
378
|
-
* @type {string}
|
|
379
|
-
* @memberof OrdersApiGetOrderItems
|
|
380
353
|
*/
|
|
381
354
|
readonly nextToken?: string;
|
|
382
355
|
}
|
|
383
356
|
/**
|
|
384
357
|
* Request parameters for getOrderItemsBuyerInfo operation in OrdersApi.
|
|
385
|
-
* @export
|
|
386
|
-
* @interface OrdersApiGetOrderItemsBuyerInfoRequest
|
|
387
358
|
*/
|
|
388
359
|
export interface OrdersApiGetOrderItemsBuyerInfoRequest {
|
|
389
360
|
/**
|
|
390
361
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
391
|
-
* @type {string}
|
|
392
|
-
* @memberof OrdersApiGetOrderItemsBuyerInfo
|
|
393
362
|
*/
|
|
394
363
|
readonly orderId: string;
|
|
395
364
|
/**
|
|
396
365
|
* A string token returned in the response of your previous request.
|
|
397
|
-
* @type {string}
|
|
398
|
-
* @memberof OrdersApiGetOrderItemsBuyerInfo
|
|
399
366
|
*/
|
|
400
367
|
readonly nextToken?: string;
|
|
401
368
|
}
|
|
402
369
|
/**
|
|
403
370
|
* Request parameters for getOrderRegulatedInfo operation in OrdersApi.
|
|
404
|
-
* @export
|
|
405
|
-
* @interface OrdersApiGetOrderRegulatedInfoRequest
|
|
406
371
|
*/
|
|
407
372
|
export interface OrdersApiGetOrderRegulatedInfoRequest {
|
|
408
373
|
/**
|
|
409
|
-
*
|
|
410
|
-
* @type {string}
|
|
411
|
-
* @memberof OrdersApiGetOrderRegulatedInfo
|
|
374
|
+
* The Amazon order identifier in 3-7-7 format.
|
|
412
375
|
*/
|
|
413
376
|
readonly orderId: string;
|
|
414
377
|
}
|
|
415
378
|
/**
|
|
416
379
|
* Request parameters for getOrders operation in OrdersApi.
|
|
417
|
-
* @export
|
|
418
|
-
* @interface OrdersApiGetOrdersRequest
|
|
419
380
|
*/
|
|
420
381
|
export interface OrdersApiGetOrdersRequest {
|
|
421
382
|
/**
|
|
422
383
|
* A list of `MarketplaceId` values. Used to select orders that were placed in the specified marketplaces. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of `marketplaceId` values.
|
|
423
|
-
* @type {Array<string>}
|
|
424
|
-
* @memberof OrdersApiGetOrders
|
|
425
384
|
*/
|
|
426
385
|
readonly marketplaceIds: Array<string>;
|
|
427
386
|
/**
|
|
428
387
|
* Use this date to select orders created after (or at) a specified time. Only orders placed after the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `LastUpdatedAfter` and `LastUpdatedBefore` cannot be set when `CreatedAfter` is set.
|
|
429
|
-
* @type {string}
|
|
430
|
-
* @memberof OrdersApiGetOrders
|
|
431
388
|
*/
|
|
432
389
|
readonly createdAfter?: string;
|
|
433
390
|
/**
|
|
434
391
|
* Use this date to select orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `CreatedBefore` is optional when `CreatedAfter` is set. If specified, `CreatedBefore` must be equal to or after the `CreatedAfter` date and at least two minutes before current time.
|
|
435
|
-
* @type {string}
|
|
436
|
-
* @memberof OrdersApiGetOrders
|
|
437
392
|
*/
|
|
438
393
|
readonly createdBefore?: string;
|
|
439
394
|
/**
|
|
440
395
|
* Use this date to select orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: Either the `CreatedAfter` parameter or the `LastUpdatedAfter` parameter is required. Both cannot be empty. `CreatedAfter` or `CreatedBefore` cannot be set when `LastUpdatedAfter` is set.
|
|
441
|
-
* @type {string}
|
|
442
|
-
* @memberof OrdersApiGetOrders
|
|
443
396
|
*/
|
|
444
397
|
readonly lastUpdatedAfter?: string;
|
|
445
398
|
/**
|
|
446
399
|
* Use this date to select orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format. **Note**: `LastUpdatedBefore` is optional when `LastUpdatedAfter` is set. But if specified, `LastUpdatedBefore` must be equal to or after the `LastUpdatedAfter` date and at least two minutes before current time.
|
|
447
|
-
* @type {string}
|
|
448
|
-
* @memberof OrdersApiGetOrders
|
|
449
400
|
*/
|
|
450
401
|
readonly lastUpdatedBefore?: string;
|
|
451
402
|
/**
|
|
452
403
|
* A list of `OrderStatus` values used to filter the results. **Possible values:** - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.) - `Pending` (The order has been placed but payment has not been authorized.) - `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.) - `PartiallyShipped` (One or more, but not all, items in the order have been shipped.) - `Shipped` (All items in the order have been shipped.) - `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.) - `Canceled` (The order has been canceled.) - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)
|
|
453
|
-
* @type {Array<string>}
|
|
454
|
-
* @memberof OrdersApiGetOrders
|
|
455
404
|
*/
|
|
456
405
|
readonly orderStatuses?: Array<string>;
|
|
457
406
|
/**
|
|
458
407
|
* A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (fulfilled by Amazon), `MFN` (fulfilled by seller).
|
|
459
|
-
* @type {Array<string>}
|
|
460
|
-
* @memberof OrdersApiGetOrders
|
|
461
408
|
*/
|
|
462
409
|
readonly fulfillmentChannels?: Array<string>;
|
|
463
410
|
/**
|
|
464
411
|
* A list of payment method values. Use this field to select orders that were paid with the specified payment methods. **Possible values**: `COD` (cash on delivery), `CVS` (convenience store), `Other` (Any payment method other than COD or CVS).
|
|
465
|
-
* @type {Array<string>}
|
|
466
|
-
* @memberof OrdersApiGetOrders
|
|
467
412
|
*/
|
|
468
413
|
readonly paymentMethods?: Array<string>;
|
|
469
414
|
/**
|
|
470
415
|
* The email address of a buyer. Used to select orders that contain the specified email address.
|
|
471
|
-
* @type {string}
|
|
472
|
-
* @memberof OrdersApiGetOrders
|
|
473
416
|
*/
|
|
474
417
|
readonly buyerEmail?: string;
|
|
475
418
|
/**
|
|
476
419
|
* An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore, and `BuyerEmail` cannot be specified.
|
|
477
|
-
* @type {string}
|
|
478
|
-
* @memberof OrdersApiGetOrders
|
|
479
420
|
*/
|
|
480
421
|
readonly sellerOrderId?: string;
|
|
481
422
|
/**
|
|
482
423
|
* A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
|
|
483
|
-
* @type {number}
|
|
484
|
-
* @memberof OrdersApiGetOrders
|
|
485
424
|
*/
|
|
486
425
|
readonly maxResultsPerPage?: number;
|
|
487
426
|
/**
|
|
488
427
|
* A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.)
|
|
489
|
-
* @type {Array<string>}
|
|
490
|
-
* @memberof OrdersApiGetOrders
|
|
491
428
|
*/
|
|
492
429
|
readonly easyShipShipmentStatuses?: Array<string>;
|
|
493
430
|
/**
|
|
494
431
|
* A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.)
|
|
495
|
-
* @type {Array<string>}
|
|
496
|
-
* @memberof OrdersApiGetOrders
|
|
497
432
|
*/
|
|
498
433
|
readonly electronicInvoiceStatuses?: Array<string>;
|
|
499
434
|
/**
|
|
500
435
|
* A string token returned in the response of your previous request.
|
|
501
|
-
* @type {string}
|
|
502
|
-
* @memberof OrdersApiGetOrders
|
|
503
436
|
*/
|
|
504
437
|
readonly nextToken?: string;
|
|
505
438
|
/**
|
|
506
439
|
* A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
507
|
-
* @type {Array<string>}
|
|
508
|
-
* @memberof OrdersApiGetOrders
|
|
509
440
|
*/
|
|
510
441
|
readonly amazonOrderIds?: Array<string>;
|
|
511
442
|
/**
|
|
512
443
|
* The `sourceId` of the location from where you want the order fulfilled.
|
|
513
|
-
* @type {string}
|
|
514
|
-
* @memberof OrdersApiGetOrders
|
|
515
444
|
*/
|
|
516
445
|
readonly actualFulfillmentSupplySourceId?: string;
|
|
517
446
|
/**
|
|
518
447
|
* When true, this order is marked to be picked up from a store rather than delivered.
|
|
519
|
-
* @type {boolean}
|
|
520
|
-
* @memberof OrdersApiGetOrders
|
|
521
448
|
*/
|
|
522
449
|
readonly isISPU?: boolean;
|
|
523
450
|
/**
|
|
524
451
|
* The store chain store identifier. Linked to a specific store in a store chain.
|
|
525
|
-
* @type {string}
|
|
526
|
-
* @memberof OrdersApiGetOrders
|
|
527
452
|
*/
|
|
528
453
|
readonly storeChainStoreId?: string;
|
|
529
454
|
/**
|
|
530
455
|
* Use this date to select orders with a earliest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
531
|
-
* @type {string}
|
|
532
|
-
* @memberof OrdersApiGetOrders
|
|
533
456
|
*/
|
|
534
457
|
readonly earliestDeliveryDateBefore?: string;
|
|
535
458
|
/**
|
|
536
459
|
* Use this date to select orders with a earliest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
537
|
-
* @type {string}
|
|
538
|
-
* @memberof OrdersApiGetOrders
|
|
539
460
|
*/
|
|
540
461
|
readonly earliestDeliveryDateAfter?: string;
|
|
541
462
|
/**
|
|
542
463
|
* Use this date to select orders with a latest delivery date before (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
543
|
-
* @type {string}
|
|
544
|
-
* @memberof OrdersApiGetOrders
|
|
545
464
|
*/
|
|
546
465
|
readonly latestDeliveryDateBefore?: string;
|
|
547
466
|
/**
|
|
548
467
|
* Use this date to select orders with a latest delivery date after (or at) a specified time. The date must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.
|
|
549
|
-
* @type {string}
|
|
550
|
-
* @memberof OrdersApiGetOrders
|
|
551
468
|
*/
|
|
552
469
|
readonly latestDeliveryDateAfter?: string;
|
|
553
470
|
}
|
|
554
471
|
/**
|
|
555
472
|
* Request parameters for updateShipmentStatus operation in OrdersApi.
|
|
556
|
-
* @export
|
|
557
|
-
* @interface OrdersApiUpdateShipmentStatusRequest
|
|
558
473
|
*/
|
|
559
474
|
export interface OrdersApiUpdateShipmentStatusRequest {
|
|
560
475
|
/**
|
|
561
476
|
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
562
|
-
* @type {string}
|
|
563
|
-
* @memberof OrdersApiUpdateShipmentStatus
|
|
564
477
|
*/
|
|
565
478
|
readonly orderId: string;
|
|
566
479
|
/**
|
|
567
480
|
* The request body for the `updateShipmentStatus` operation.
|
|
568
|
-
* @type {UpdateShipmentStatusRequest}
|
|
569
|
-
* @memberof OrdersApiUpdateShipmentStatus
|
|
570
481
|
*/
|
|
571
482
|
readonly payload: UpdateShipmentStatusRequest;
|
|
572
483
|
}
|
|
573
484
|
/**
|
|
574
485
|
* Request parameters for updateVerificationStatus operation in OrdersApi.
|
|
575
|
-
* @export
|
|
576
|
-
* @interface OrdersApiUpdateVerificationStatusRequest
|
|
577
486
|
*/
|
|
578
487
|
export interface OrdersApiUpdateVerificationStatusRequest {
|
|
579
488
|
/**
|
|
580
|
-
*
|
|
581
|
-
* @type {string}
|
|
582
|
-
* @memberof OrdersApiUpdateVerificationStatus
|
|
489
|
+
* The Amazon order identifier in 3-7-7 format.
|
|
583
490
|
*/
|
|
584
491
|
readonly orderId: string;
|
|
585
492
|
/**
|
|
586
493
|
* The request body for the `updateVerificationStatus` operation.
|
|
587
|
-
* @type {UpdateVerificationStatusRequest}
|
|
588
|
-
* @memberof OrdersApiUpdateVerificationStatus
|
|
589
494
|
*/
|
|
590
495
|
readonly payload: UpdateVerificationStatusRequest;
|
|
591
496
|
}
|
|
592
497
|
/**
|
|
593
498
|
* OrdersApi - object-oriented interface
|
|
594
|
-
* @export
|
|
595
|
-
* @class OrdersApi
|
|
596
|
-
* @extends {BaseAPI}
|
|
597
499
|
*/
|
|
598
500
|
export declare class OrdersApi extends BaseAPI {
|
|
599
501
|
/**
|
|
600
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
502
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
601
503
|
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
602
504
|
* @param {*} [options] Override http request option.
|
|
603
505
|
* @throws {RequiredError}
|
|
604
|
-
* @memberof OrdersApi
|
|
605
506
|
*/
|
|
606
507
|
confirmShipment(requestParameters: OrdersApiConfirmShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
607
508
|
/**
|
|
608
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
509
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
609
510
|
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
610
511
|
* @param {*} [options] Override http request option.
|
|
611
512
|
* @throws {RequiredError}
|
|
612
|
-
* @memberof OrdersApi
|
|
613
513
|
*/
|
|
614
514
|
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderResponse, any>>;
|
|
615
515
|
/**
|
|
616
|
-
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
516
|
+
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
617
517
|
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
618
518
|
* @param {*} [options] Override http request option.
|
|
619
519
|
* @throws {RequiredError}
|
|
620
|
-
* @memberof OrdersApi
|
|
621
520
|
*/
|
|
622
521
|
getOrderAddress(requestParameters: OrdersApiGetOrderAddressRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderAddressResponse, any>>;
|
|
623
522
|
/**
|
|
624
|
-
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
523
|
+
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
625
524
|
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
626
525
|
* @param {*} [options] Override http request option.
|
|
627
526
|
* @throws {RequiredError}
|
|
628
|
-
* @memberof OrdersApi
|
|
629
527
|
*/
|
|
630
528
|
getOrderBuyerInfo(requestParameters: OrdersApiGetOrderBuyerInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderBuyerInfoResponse, any>>;
|
|
631
529
|
/**
|
|
632
|
-
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
530
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
633
531
|
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
634
532
|
* @param {*} [options] Override http request option.
|
|
635
533
|
* @throws {RequiredError}
|
|
636
|
-
* @memberof OrdersApi
|
|
637
534
|
*/
|
|
638
535
|
getOrderItems(requestParameters: OrdersApiGetOrderItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderItemsResponse, any>>;
|
|
639
536
|
/**
|
|
640
|
-
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
537
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
641
538
|
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
642
539
|
* @param {*} [options] Override http request option.
|
|
643
540
|
* @throws {RequiredError}
|
|
644
|
-
* @memberof OrdersApi
|
|
645
541
|
*/
|
|
646
542
|
getOrderItemsBuyerInfo(requestParameters: OrdersApiGetOrderItemsBuyerInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderItemsBuyerInfoResponse, any>>;
|
|
647
543
|
/**
|
|
648
|
-
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
544
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
649
545
|
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
650
546
|
* @param {*} [options] Override http request option.
|
|
651
547
|
* @throws {RequiredError}
|
|
652
|
-
* @memberof OrdersApi
|
|
653
548
|
*/
|
|
654
549
|
getOrderRegulatedInfo(requestParameters: OrdersApiGetOrderRegulatedInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderRegulatedInfoResponse, any>>;
|
|
655
550
|
/**
|
|
656
|
-
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header
|
|
551
|
+
* Returns orders that are created or updated during the specified time period. If you want to return specific types of orders, you can apply filters to your request. `NextToken` doesn\'t affect any filters that you include in your request; it only impacts the pagination for the filtered orders response. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
657
552
|
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
658
553
|
* @param {*} [options] Override http request option.
|
|
659
554
|
* @throws {RequiredError}
|
|
660
|
-
* @memberof OrdersApi
|
|
661
555
|
*/
|
|
662
556
|
getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrdersResponse, any>>;
|
|
663
557
|
/**
|
|
664
|
-
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header
|
|
558
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
665
559
|
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
666
560
|
* @param {*} [options] Override http request option.
|
|
667
561
|
* @throws {RequiredError}
|
|
668
|
-
* @memberof OrdersApi
|
|
669
562
|
*/
|
|
670
563
|
updateShipmentStatus(requestParameters: OrdersApiUpdateShipmentStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
671
564
|
/**
|
|
672
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header
|
|
565
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
673
566
|
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
674
567
|
* @param {*} [options] Override http request option.
|
|
675
568
|
* @throws {RequiredError}
|
|
676
|
-
* @memberof OrdersApi
|
|
677
569
|
*/
|
|
678
570
|
updateVerificationStatus(requestParameters: OrdersApiUpdateVerificationStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
679
571
|
}
|