@sp-api-sdk/orders-api-v0 1.12.3 → 1.14.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 +45 -45
- package/dist/cjs/src/api-model/models/address.js +4 -9
- package/dist/cjs/src/api-model/models/index.js +2 -0
- package/dist/cjs/src/api-model/models/order-item.js +4 -9
- package/dist/cjs/src/api-model/models/order-items-inner.js +15 -0
- package/dist/cjs/src/api-model/models/order.js +30 -55
- package/dist/cjs/src/api-model/models/regulated-information-field.js +4 -9
- package/dist/cjs/src/api-model/models/regulated-order-verification-status.js +0 -13
- package/dist/cjs/src/api-model/models/shipment-status.js +5 -6
- package/dist/cjs/src/api-model/models/tax-collection.js +6 -16
- package/dist/cjs/src/api-model/models/update-verification-status-request-body.js +0 -10
- package/dist/cjs/src/api-model/models/verification-status.js +28 -0
- package/dist/cjs/src/client.js +19 -12
- package/dist/es/src/api-model/api/orders-v0-api.js +45 -45
- package/dist/es/src/api-model/models/address.js +4 -9
- package/dist/es/src/api-model/models/index.js +2 -0
- package/dist/es/src/api-model/models/order-item.js +4 -9
- package/dist/es/src/api-model/models/order-items-inner.js +14 -0
- package/dist/es/src/api-model/models/order.js +30 -55
- package/dist/es/src/api-model/models/regulated-information-field.js +4 -9
- package/dist/es/src/api-model/models/regulated-order-verification-status.js +1 -12
- package/dist/es/src/api-model/models/shipment-status.js +5 -6
- package/dist/es/src/api-model/models/tax-collection.js +6 -16
- package/dist/es/src/api-model/models/update-verification-status-request-body.js +1 -9
- package/dist/es/src/api-model/models/verification-status.js +25 -0
- package/dist/es/src/client.js +19 -12
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +70 -70
- package/dist/types/src/api-model/base.d.ts +2 -2
- package/dist/types/src/api-model/common.d.ts +7 -7
- package/dist/types/src/api-model/models/address.d.ts +18 -21
- package/dist/types/src/api-model/models/automated-shipping-settings.d.ts +3 -3
- package/dist/types/src/api-model/models/buyer-customized-info-detail.d.ts +1 -1
- package/dist/types/src/api-model/models/buyer-info.d.ts +5 -5
- package/dist/types/src/api-model/models/buyer-requested-cancel.d.ts +3 -3
- package/dist/types/src/api-model/models/buyer-tax-info.d.ts +3 -3
- package/dist/types/src/api-model/models/buyer-tax-information.d.ts +4 -4
- package/dist/types/src/api-model/models/fulfillment-instruction.d.ts +1 -1
- package/dist/types/src/api-model/models/get-order-address-response.d.ts +2 -2
- package/dist/types/src/api-model/models/get-order-buyer-info-response.d.ts +2 -2
- package/dist/types/src/api-model/models/get-order-items-buyer-info-response.d.ts +2 -2
- package/dist/types/src/api-model/models/get-order-items-response.d.ts +2 -2
- package/dist/types/src/api-model/models/get-order-regulated-info-response.d.ts +2 -2
- package/dist/types/src/api-model/models/get-order-response.d.ts +2 -2
- package/dist/types/src/api-model/models/get-orders-response.d.ts +2 -2
- package/dist/types/src/api-model/models/index.d.ts +2 -0
- package/dist/types/src/api-model/models/item-buyer-info.d.ts +5 -5
- package/dist/types/src/api-model/models/marketplace-tax-info.d.ts +1 -1
- package/dist/types/src/api-model/models/model-error.d.ts +3 -3
- package/dist/types/src/api-model/models/money.d.ts +2 -2
- package/dist/types/src/api-model/models/order-address.d.ts +2 -2
- package/dist/types/src/api-model/models/order-buyer-info.d.ts +6 -6
- package/dist/types/src/api-model/models/order-item-buyer-info.d.ts +6 -6
- package/dist/types/src/api-model/models/order-item.d.ts +39 -42
- package/dist/types/src/api-model/models/order-items-buyer-info-list.d.ts +3 -3
- package/dist/types/src/api-model/models/order-items-inner.d.ts +30 -0
- package/dist/types/src/api-model/models/order-items-list.d.ts +3 -3
- package/dist/types/src/api-model/models/order-regulated-info.d.ts +4 -4
- package/dist/types/src/api-model/models/order.d.ts +86 -95
- package/dist/types/src/api-model/models/orders-list.d.ts +4 -4
- package/dist/types/src/api-model/models/payment-execution-detail-item.d.ts +2 -2
- package/dist/types/src/api-model/models/points-granted-detail.d.ts +2 -2
- package/dist/types/src/api-model/models/product-info-detail.d.ts +1 -1
- package/dist/types/src/api-model/models/regulated-information-field.d.ts +9 -12
- package/dist/types/src/api-model/models/regulated-information.d.ts +1 -1
- package/dist/types/src/api-model/models/regulated-order-verification-status.d.ts +9 -19
- package/dist/types/src/api-model/models/rejection-reason.d.ts +2 -2
- package/dist/types/src/api-model/models/shipment-status.d.ts +6 -5
- package/dist/types/src/api-model/models/tax-classification.d.ts +2 -2
- package/dist/types/src/api-model/models/tax-collection.d.ts +10 -16
- package/dist/types/src/api-model/models/update-shipment-status-error-response.d.ts +1 -1
- package/dist/types/src/api-model/models/update-shipment-status-request.d.ts +5 -4
- package/dist/types/src/api-model/models/update-verification-status-error-response.d.ts +1 -1
- package/dist/types/src/api-model/models/update-verification-status-request-body.d.ts +6 -13
- package/dist/types/src/api-model/models/update-verification-status-request.d.ts +1 -1
- package/dist/types/src/api-model/models/verification-status.d.ts +24 -0
- package/package.json +4 -4
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { AxiosPromise, AxiosInstance } from 'axios';
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { GetOrderAddressResponse } from '../models';
|
|
@@ -25,53 +25,53 @@ import { UpdateVerificationStatusRequest } from '../models';
|
|
|
25
25
|
* OrdersV0Api - axios parameter creator
|
|
26
26
|
* @export
|
|
27
27
|
*/
|
|
28
|
-
export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuration
|
|
28
|
+
export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29
29
|
/**
|
|
30
|
-
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
30
|
+
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
31
31
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
32
32
|
* @param {*} [options] Override http request option.
|
|
33
33
|
* @throws {RequiredError}
|
|
34
34
|
*/
|
|
35
|
-
getOrder: (orderId: string, options?:
|
|
35
|
+
getOrder: (orderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
36
|
/**
|
|
37
|
-
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
37
|
+
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
38
38
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
39
39
|
* @param {*} [options] Override http request option.
|
|
40
40
|
* @throws {RequiredError}
|
|
41
41
|
*/
|
|
42
|
-
getOrderAddress: (orderId: string, options?:
|
|
42
|
+
getOrderAddress: (orderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43
43
|
/**
|
|
44
|
-
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
44
|
+
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
45
45
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
46
46
|
* @param {*} [options] Override http request option.
|
|
47
47
|
* @throws {RequiredError}
|
|
48
48
|
*/
|
|
49
|
-
getOrderBuyerInfo: (orderId: string, options?:
|
|
49
|
+
getOrderBuyerInfo: (orderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
50
50
|
/**
|
|
51
|
-
* Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it\'s used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
51
|
+
* Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it\'s used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
52
52
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
53
53
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
54
54
|
* @param {*} [options] Override http request option.
|
|
55
55
|
* @throws {RequiredError}
|
|
56
56
|
*/
|
|
57
|
-
getOrderItems: (orderId: string, nextToken?: string
|
|
57
|
+
getOrderItems: (orderId: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
58
|
/**
|
|
59
|
-
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
59
|
+
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
60
60
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
61
61
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
62
62
|
* @param {*} [options] Override http request option.
|
|
63
63
|
* @throws {RequiredError}
|
|
64
64
|
*/
|
|
65
|
-
getOrderItemsBuyerInfo: (orderId: string, nextToken?: string
|
|
65
|
+
getOrderItemsBuyerInfo: (orderId: string, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
66
|
/**
|
|
67
|
-
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
67
|
+
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
68
68
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
69
69
|
* @param {*} [options] Override http request option.
|
|
70
70
|
* @throws {RequiredError}
|
|
71
71
|
*/
|
|
72
|
-
getOrderRegulatedInfo: (orderId: string, options?:
|
|
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 Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
74
|
+
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
75
75
|
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
76
76
|
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
77
77
|
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
@@ -92,75 +92,75 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
92
92
|
* @param {*} [options] Override http request option.
|
|
93
93
|
* @throws {RequiredError}
|
|
94
94
|
*/
|
|
95
|
-
getOrders: (marketplaceIds: Array<string>, createdAfter?: string
|
|
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
96
|
/**
|
|
97
|
-
* Update the shipment status.
|
|
97
|
+
* Update the shipment status. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 15 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
98
98
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
99
99
|
* @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
|
|
100
100
|
* @param {*} [options] Override http request option.
|
|
101
101
|
* @throws {RequiredError}
|
|
102
102
|
*/
|
|
103
|
-
updateShipmentStatus: (orderId: string, payload: UpdateShipmentStatusRequest, options?:
|
|
103
|
+
updateShipmentStatus: (orderId: string, payload: UpdateShipmentStatusRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
104
104
|
/**
|
|
105
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
105
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
106
106
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
107
107
|
* @param {UpdateVerificationStatusRequest} payload Request to update the verification status of an order containing regulated products.
|
|
108
108
|
* @param {*} [options] Override http request option.
|
|
109
109
|
* @throws {RequiredError}
|
|
110
110
|
*/
|
|
111
|
-
updateVerificationStatus: (orderId: string, payload: UpdateVerificationStatusRequest, options?:
|
|
111
|
+
updateVerificationStatus: (orderId: string, payload: UpdateVerificationStatusRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
112
112
|
};
|
|
113
113
|
/**
|
|
114
114
|
* OrdersV0Api - functional programming interface
|
|
115
115
|
* @export
|
|
116
116
|
*/
|
|
117
|
-
export declare const OrdersV0ApiFp: (configuration?: Configuration
|
|
117
|
+
export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
118
118
|
/**
|
|
119
|
-
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
119
|
+
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
120
120
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
121
121
|
* @param {*} [options] Override http request option.
|
|
122
122
|
* @throws {RequiredError}
|
|
123
123
|
*/
|
|
124
|
-
getOrder(orderId: string, options?:
|
|
124
|
+
getOrder(orderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderResponse>>;
|
|
125
125
|
/**
|
|
126
|
-
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
126
|
+
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
127
127
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
128
128
|
* @param {*} [options] Override http request option.
|
|
129
129
|
* @throws {RequiredError}
|
|
130
130
|
*/
|
|
131
|
-
getOrderAddress(orderId: string, options?:
|
|
131
|
+
getOrderAddress(orderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderAddressResponse>>;
|
|
132
132
|
/**
|
|
133
|
-
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
133
|
+
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
134
134
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
136
136
|
* @throws {RequiredError}
|
|
137
137
|
*/
|
|
138
|
-
getOrderBuyerInfo(orderId: string, options?:
|
|
138
|
+
getOrderBuyerInfo(orderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderBuyerInfoResponse>>;
|
|
139
139
|
/**
|
|
140
|
-
* Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it\'s used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
140
|
+
* Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it\'s used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
141
141
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
142
142
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
144
144
|
* @throws {RequiredError}
|
|
145
145
|
*/
|
|
146
|
-
getOrderItems(orderId: string, nextToken?: string
|
|
146
|
+
getOrderItems(orderId: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsResponse>>;
|
|
147
147
|
/**
|
|
148
|
-
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
148
|
+
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
149
149
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
150
150
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
151
151
|
* @param {*} [options] Override http request option.
|
|
152
152
|
* @throws {RequiredError}
|
|
153
153
|
*/
|
|
154
|
-
getOrderItemsBuyerInfo(orderId: string, nextToken?: string
|
|
154
|
+
getOrderItemsBuyerInfo(orderId: string, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsBuyerInfoResponse>>;
|
|
155
155
|
/**
|
|
156
|
-
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
156
|
+
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
157
157
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
158
158
|
* @param {*} [options] Override http request option.
|
|
159
159
|
* @throws {RequiredError}
|
|
160
160
|
*/
|
|
161
|
-
getOrderRegulatedInfo(orderId: string, options?:
|
|
161
|
+
getOrderRegulatedInfo(orderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderRegulatedInfoResponse>>;
|
|
162
162
|
/**
|
|
163
|
-
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
163
|
+
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
164
164
|
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
165
165
|
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
166
166
|
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
@@ -181,75 +181,75 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration | undefined)
|
|
|
181
181
|
* @param {*} [options] Override http request option.
|
|
182
182
|
* @throws {RequiredError}
|
|
183
183
|
*/
|
|
184
|
-
getOrders(marketplaceIds: Array<string>, createdAfter?: string
|
|
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>>;
|
|
185
185
|
/**
|
|
186
|
-
* Update the shipment status.
|
|
186
|
+
* Update the shipment status. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 15 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
187
187
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
188
188
|
* @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
|
|
189
189
|
* @param {*} [options] Override http request option.
|
|
190
190
|
* @throws {RequiredError}
|
|
191
191
|
*/
|
|
192
|
-
updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?:
|
|
192
|
+
updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
193
193
|
/**
|
|
194
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
194
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
195
195
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
196
196
|
* @param {UpdateVerificationStatusRequest} payload Request to update the verification status of an order containing regulated products.
|
|
197
197
|
* @param {*} [options] Override http request option.
|
|
198
198
|
* @throws {RequiredError}
|
|
199
199
|
*/
|
|
200
|
-
updateVerificationStatus(orderId: string, payload: UpdateVerificationStatusRequest, options?:
|
|
200
|
+
updateVerificationStatus(orderId: string, payload: UpdateVerificationStatusRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
201
201
|
};
|
|
202
202
|
/**
|
|
203
203
|
* OrdersV0Api - factory interface
|
|
204
204
|
* @export
|
|
205
205
|
*/
|
|
206
|
-
export declare const OrdersV0ApiFactory: (configuration?: Configuration
|
|
206
|
+
export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
207
207
|
/**
|
|
208
|
-
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
208
|
+
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
209
209
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
210
210
|
* @param {*} [options] Override http request option.
|
|
211
211
|
* @throws {RequiredError}
|
|
212
212
|
*/
|
|
213
213
|
getOrder(orderId: string, options?: any): AxiosPromise<GetOrderResponse>;
|
|
214
214
|
/**
|
|
215
|
-
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
215
|
+
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
216
216
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
217
217
|
* @param {*} [options] Override http request option.
|
|
218
218
|
* @throws {RequiredError}
|
|
219
219
|
*/
|
|
220
220
|
getOrderAddress(orderId: string, options?: any): AxiosPromise<GetOrderAddressResponse>;
|
|
221
221
|
/**
|
|
222
|
-
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
222
|
+
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
223
223
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
224
224
|
* @param {*} [options] Override http request option.
|
|
225
225
|
* @throws {RequiredError}
|
|
226
226
|
*/
|
|
227
227
|
getOrderBuyerInfo(orderId: string, options?: any): AxiosPromise<GetOrderBuyerInfoResponse>;
|
|
228
228
|
/**
|
|
229
|
-
* Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it\'s used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
229
|
+
* Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it\'s used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
230
230
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
231
231
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
232
232
|
* @param {*} [options] Override http request option.
|
|
233
233
|
* @throws {RequiredError}
|
|
234
234
|
*/
|
|
235
|
-
getOrderItems(orderId: string, nextToken?: string
|
|
235
|
+
getOrderItems(orderId: string, nextToken?: string, options?: any): AxiosPromise<GetOrderItemsResponse>;
|
|
236
236
|
/**
|
|
237
|
-
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
237
|
+
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
238
238
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
239
239
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
240
240
|
* @param {*} [options] Override http request option.
|
|
241
241
|
* @throws {RequiredError}
|
|
242
242
|
*/
|
|
243
|
-
getOrderItemsBuyerInfo(orderId: string, nextToken?: string
|
|
243
|
+
getOrderItemsBuyerInfo(orderId: string, nextToken?: string, options?: any): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
|
|
244
244
|
/**
|
|
245
|
-
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
245
|
+
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
246
246
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
247
247
|
* @param {*} [options] Override http request option.
|
|
248
248
|
* @throws {RequiredError}
|
|
249
249
|
*/
|
|
250
250
|
getOrderRegulatedInfo(orderId: string, options?: any): AxiosPromise<GetOrderRegulatedInfoResponse>;
|
|
251
251
|
/**
|
|
252
|
-
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
252
|
+
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
253
253
|
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
254
254
|
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
255
255
|
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
@@ -270,9 +270,9 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration | undefi
|
|
|
270
270
|
* @param {*} [options] Override http request option.
|
|
271
271
|
* @throws {RequiredError}
|
|
272
272
|
*/
|
|
273
|
-
getOrders(marketplaceIds: Array<string>, createdAfter?: string
|
|
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>;
|
|
274
274
|
/**
|
|
275
|
-
* Update the shipment status.
|
|
275
|
+
* Update the shipment status. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 15 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
276
276
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
277
277
|
* @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
|
|
278
278
|
* @param {*} [options] Override http request option.
|
|
@@ -280,7 +280,7 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration | undefi
|
|
|
280
280
|
*/
|
|
281
281
|
updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: any): AxiosPromise<void>;
|
|
282
282
|
/**
|
|
283
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
283
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
284
284
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
285
285
|
* @param {UpdateVerificationStatusRequest} payload Request to update the verification status of an order containing regulated products.
|
|
286
286
|
* @param {*} [options] Override http request option.
|
|
@@ -533,75 +533,75 @@ export interface OrdersV0ApiUpdateVerificationStatusRequest {
|
|
|
533
533
|
*/
|
|
534
534
|
export declare class OrdersV0Api extends BaseAPI {
|
|
535
535
|
/**
|
|
536
|
-
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
536
|
+
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
537
537
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
538
538
|
* @param {*} [options] Override http request option.
|
|
539
539
|
* @throws {RequiredError}
|
|
540
540
|
* @memberof OrdersV0Api
|
|
541
541
|
*/
|
|
542
|
-
getOrder(requestParameters: OrdersV0ApiGetOrderRequest, options?:
|
|
542
|
+
getOrder(requestParameters: OrdersV0ApiGetOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderResponse, any>>;
|
|
543
543
|
/**
|
|
544
|
-
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
544
|
+
* Returns the shipping address for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
545
545
|
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
546
546
|
* @param {*} [options] Override http request option.
|
|
547
547
|
* @throws {RequiredError}
|
|
548
548
|
* @memberof OrdersV0Api
|
|
549
549
|
*/
|
|
550
|
-
getOrderAddress(requestParameters: OrdersV0ApiGetOrderAddressRequest, options?:
|
|
550
|
+
getOrderAddress(requestParameters: OrdersV0ApiGetOrderAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderAddressResponse, any>>;
|
|
551
551
|
/**
|
|
552
|
-
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
552
|
+
* Returns buyer information for the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
553
553
|
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
554
554
|
* @param {*} [options] Override http request option.
|
|
555
555
|
* @throws {RequiredError}
|
|
556
556
|
* @memberof OrdersV0Api
|
|
557
557
|
*/
|
|
558
|
-
getOrderBuyerInfo(requestParameters: OrdersV0ApiGetOrderBuyerInfoRequest, options?:
|
|
558
|
+
getOrderBuyerInfo(requestParameters: OrdersV0ApiGetOrderBuyerInfoRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderBuyerInfoResponse, any>>;
|
|
559
559
|
/**
|
|
560
|
-
* Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it\'s used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
560
|
+
* Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it\'s used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
561
561
|
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
562
562
|
* @param {*} [options] Override http request option.
|
|
563
563
|
* @throws {RequiredError}
|
|
564
564
|
* @memberof OrdersV0Api
|
|
565
565
|
*/
|
|
566
|
-
getOrderItems(requestParameters: OrdersV0ApiGetOrderItemsRequest, options?:
|
|
566
|
+
getOrderItems(requestParameters: OrdersV0ApiGetOrderItemsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderItemsResponse, any>>;
|
|
567
567
|
/**
|
|
568
|
-
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
568
|
+
* Returns buyer information for the order items in the specified order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
569
569
|
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
570
570
|
* @param {*} [options] Override http request option.
|
|
571
571
|
* @throws {RequiredError}
|
|
572
572
|
* @memberof OrdersV0Api
|
|
573
573
|
*/
|
|
574
|
-
getOrderItemsBuyerInfo(requestParameters: OrdersV0ApiGetOrderItemsBuyerInfoRequest, options?:
|
|
574
|
+
getOrderItemsBuyerInfo(requestParameters: OrdersV0ApiGetOrderItemsBuyerInfoRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderItemsBuyerInfoResponse, any>>;
|
|
575
575
|
/**
|
|
576
|
-
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
576
|
+
* Returns regulated information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
577
577
|
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
578
578
|
* @param {*} [options] Override http request option.
|
|
579
579
|
* @throws {RequiredError}
|
|
580
580
|
* @memberof OrdersV0Api
|
|
581
581
|
*/
|
|
582
|
-
getOrderRegulatedInfo(requestParameters: OrdersV0ApiGetOrderRegulatedInfoRequest, options?:
|
|
582
|
+
getOrderRegulatedInfo(requestParameters: OrdersV0ApiGetOrderRegulatedInfoRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderRegulatedInfoResponse, any>>;
|
|
583
583
|
/**
|
|
584
|
-
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
584
|
+
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0167 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
585
585
|
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
586
586
|
* @param {*} [options] Override http request option.
|
|
587
587
|
* @throws {RequiredError}
|
|
588
588
|
* @memberof OrdersV0Api
|
|
589
589
|
*/
|
|
590
|
-
getOrders(requestParameters: OrdersV0ApiGetOrdersRequest, options?:
|
|
590
|
+
getOrders(requestParameters: OrdersV0ApiGetOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrdersResponse, any>>;
|
|
591
591
|
/**
|
|
592
|
-
* Update the shipment status.
|
|
592
|
+
* Update the shipment status. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 5 | 15 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
593
593
|
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
594
594
|
* @param {*} [options] Override http request option.
|
|
595
595
|
* @throws {RequiredError}
|
|
596
596
|
* @memberof OrdersV0Api
|
|
597
597
|
*/
|
|
598
|
-
updateShipmentStatus(requestParameters: OrdersV0ApiUpdateShipmentStatusRequest, options?:
|
|
598
|
+
updateShipmentStatus(requestParameters: OrdersV0ApiUpdateShipmentStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
599
599
|
/**
|
|
600
|
-
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.
|
|
600
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
601
601
|
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
602
602
|
* @param {*} [options] Override http request option.
|
|
603
603
|
* @throws {RequiredError}
|
|
604
604
|
* @memberof OrdersV0Api
|
|
605
605
|
*/
|
|
606
|
-
updateVerificationStatus(requestParameters: OrdersV0ApiUpdateVerificationStatusRequest, options?:
|
|
606
|
+
updateVerificationStatus(requestParameters: OrdersV0ApiUpdateVerificationStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
607
607
|
}
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import { Configuration } from "./configuration";
|
|
13
|
-
import { AxiosInstance } from 'axios';
|
|
13
|
+
import { AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
14
|
export declare const BASE_PATH: string;
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
@@ -29,7 +29,7 @@ export declare const COLLECTION_FORMATS: {
|
|
|
29
29
|
*/
|
|
30
30
|
export interface RequestArgs {
|
|
31
31
|
url: string;
|
|
32
|
-
options:
|
|
32
|
+
options: AxiosRequestConfig;
|
|
33
33
|
}
|
|
34
34
|
/**
|
|
35
35
|
*
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import { Configuration } from "./configuration";
|
|
13
13
|
import { RequestArgs } from "./base";
|
|
14
|
-
import { AxiosInstance } from 'axios';
|
|
14
|
+
import { AxiosInstance, AxiosResponse } from 'axios';
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
17
17
|
* @export
|
|
@@ -27,22 +27,22 @@ export declare const assertParamExists: (functionName: string, paramName: string
|
|
|
27
27
|
*
|
|
28
28
|
* @export
|
|
29
29
|
*/
|
|
30
|
-
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration
|
|
30
|
+
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
31
|
/**
|
|
32
32
|
*
|
|
33
33
|
* @export
|
|
34
34
|
*/
|
|
35
|
-
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration
|
|
35
|
+
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
36
|
/**
|
|
37
37
|
*
|
|
38
38
|
* @export
|
|
39
39
|
*/
|
|
40
|
-
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration
|
|
40
|
+
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
41
|
/**
|
|
42
42
|
*
|
|
43
43
|
* @export
|
|
44
44
|
*/
|
|
45
|
-
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration
|
|
45
|
+
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
46
|
/**
|
|
47
47
|
*
|
|
48
48
|
* @export
|
|
@@ -52,7 +52,7 @@ export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
|
52
52
|
*
|
|
53
53
|
* @export
|
|
54
54
|
*/
|
|
55
|
-
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration
|
|
55
|
+
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
56
|
/**
|
|
57
57
|
*
|
|
58
58
|
* @export
|
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|