@sp-api-sdk/orders-api-v0 3.3.0 → 3.4.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/README.md +2 -2
- package/dist/cjs/src/api-model/api/orders-v0-api.js +130 -71
- package/dist/cjs/src/api-model/api.js +1 -1
- package/dist/cjs/src/api-model/base.js +1 -1
- package/dist/cjs/src/api-model/common.js +1 -1
- package/dist/cjs/src/api-model/configuration.js +1 -1
- package/dist/cjs/src/api-model/index.js +1 -1
- package/dist/cjs/src/api-model/models/address-extended-fields.js +1 -1
- package/dist/cjs/src/api-model/models/address.js +1 -1
- package/dist/cjs/src/api-model/models/associated-item.js +1 -1
- package/dist/cjs/src/api-model/models/association-type.js +1 -1
- package/dist/cjs/src/api-model/models/automated-shipping-settings.js +1 -1
- package/dist/cjs/src/api-model/models/business-hours.js +1 -1
- package/dist/cjs/src/api-model/models/buyer-customized-info-detail.js +1 -1
- package/dist/cjs/src/api-model/models/buyer-info.js +1 -1
- package/dist/cjs/src/api-model/models/buyer-requested-cancel.js +1 -1
- package/dist/cjs/src/api-model/models/buyer-tax-info.js +1 -1
- package/dist/cjs/src/api-model/models/buyer-tax-information.js +1 -1
- package/dist/cjs/src/api-model/models/confirm-shipment-error-response.js +1 -1
- package/dist/cjs/src/api-model/models/confirm-shipment-order-item.js +1 -1
- package/dist/cjs/src/api-model/models/confirm-shipment-request.js +1 -1
- package/dist/cjs/src/api-model/models/constraint-type.js +1 -1
- package/dist/cjs/src/api-model/models/delivery-preferences.js +1 -1
- package/dist/cjs/src/api-model/models/easy-ship-shipment-status.js +2 -2
- package/dist/cjs/src/api-model/models/electronic-invoice-status.js +1 -1
- package/dist/cjs/src/api-model/models/exception-dates.js +1 -1
- package/dist/cjs/src/api-model/models/fulfillment-instruction.js +1 -1
- package/dist/cjs/src/api-model/models/fulfillment-instructions.js +15 -0
- package/dist/cjs/src/api-model/models/fulfillment-location.js +15 -0
- package/dist/cjs/src/api-model/models/fulfillment-plan-constraint-type.js +25 -0
- package/dist/cjs/src/api-model/models/fulfillment-plan-item.js +15 -0
- package/dist/cjs/src/api-model/models/fulfillment-plan-shipping-constraints.js +15 -0
- package/dist/cjs/src/api-model/models/fulfillment-plan.js +27 -0
- package/dist/cjs/src/api-model/models/get-order-address-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-order-buyer-info-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-order-fulfillment-instructions-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-items-buyer-info-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-order-items-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-order-regulated-info-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-order-response.js +1 -1
- package/dist/cjs/src/api-model/models/get-orders-response.js +1 -1
- package/dist/cjs/src/api-model/models/index.js +11 -0
- package/dist/cjs/src/api-model/models/item-buyer-info.js +1 -1
- package/dist/cjs/src/api-model/models/marketplace-tax-info.js +1 -1
- package/dist/cjs/src/api-model/models/measurement.js +1 -1
- package/dist/cjs/src/api-model/models/model-error.js +1 -1
- package/dist/cjs/src/api-model/models/money.js +1 -1
- package/dist/cjs/src/api-model/models/open-interval.js +1 -1
- package/dist/cjs/src/api-model/models/open-time-interval.js +1 -1
- package/dist/cjs/src/api-model/models/order-address.js +1 -1
- package/dist/cjs/src/api-model/models/order-buyer-info.js +1 -1
- package/dist/cjs/src/api-model/models/order-item-buyer-info.js +1 -1
- package/dist/cjs/src/api-model/models/order-item.js +1 -1
- package/dist/cjs/src/api-model/models/order-items-buyer-info-list.js +1 -1
- package/dist/cjs/src/api-model/models/order-items-inner.js +1 -1
- package/dist/cjs/src/api-model/models/order-items-list.js +1 -1
- package/dist/cjs/src/api-model/models/order-regulated-info.js +1 -1
- package/dist/cjs/src/api-model/models/order.js +1 -1
- package/dist/cjs/src/api-model/models/orders-list.js +1 -1
- package/dist/cjs/src/api-model/models/other-delivery-attributes.js +1 -1
- package/dist/cjs/src/api-model/models/package-detail.js +1 -1
- package/dist/cjs/src/api-model/models/payment-execution-detail-item.js +1 -1
- package/dist/cjs/src/api-model/models/points-granted-detail.js +1 -1
- package/dist/cjs/src/api-model/models/preferred-delivery-time.js +1 -1
- package/dist/cjs/src/api-model/models/prescription-detail.js +15 -0
- package/dist/cjs/src/api-model/models/product-info-detail.js +1 -1
- package/dist/cjs/src/api-model/models/regulated-information-field.js +1 -1
- package/dist/cjs/src/api-model/models/regulated-information.js +1 -1
- package/dist/cjs/src/api-model/models/regulated-order-verification-status.js +1 -1
- package/dist/cjs/src/api-model/models/rejection-reason.js +1 -1
- package/dist/cjs/src/api-model/models/shipment-status.js +1 -1
- package/dist/cjs/src/api-model/models/shipping-constraints.js +1 -1
- package/dist/cjs/src/api-model/models/shipping-instructions.js +15 -0
- package/dist/cjs/src/api-model/models/substitution-option.js +1 -1
- package/dist/cjs/src/api-model/models/substitution-preferences.js +1 -1
- package/dist/cjs/src/api-model/models/tax-classification.js +1 -1
- package/dist/cjs/src/api-model/models/tax-collection.js +1 -1
- package/dist/cjs/src/api-model/models/update-shipment-status-error-response.js +1 -1
- package/dist/cjs/src/api-model/models/update-shipment-status-request.js +1 -1
- package/dist/cjs/src/api-model/models/update-verification-status-error-response.js +1 -1
- package/dist/cjs/src/api-model/models/update-verification-status-request-body.js +1 -1
- package/dist/cjs/src/api-model/models/update-verification-status-request.js +1 -1
- package/dist/cjs/src/api-model/models/valid-verification-detail.js +15 -0
- package/dist/cjs/src/api-model/models/verification-details.js +15 -0
- package/dist/cjs/src/api-model/models/verification-status.js +1 -1
- package/dist/cjs/src/client.js +7 -0
- package/dist/es/src/api-model/api/orders-v0-api.js +130 -71
- package/dist/es/src/api-model/api.js +1 -1
- package/dist/es/src/api-model/base.js +1 -1
- package/dist/es/src/api-model/common.js +1 -1
- package/dist/es/src/api-model/configuration.js +1 -1
- package/dist/es/src/api-model/index.js +1 -1
- package/dist/es/src/api-model/models/address-extended-fields.js +1 -1
- package/dist/es/src/api-model/models/address.js +1 -1
- package/dist/es/src/api-model/models/associated-item.js +1 -1
- package/dist/es/src/api-model/models/association-type.js +1 -1
- package/dist/es/src/api-model/models/automated-shipping-settings.js +1 -1
- package/dist/es/src/api-model/models/business-hours.js +1 -1
- package/dist/es/src/api-model/models/buyer-customized-info-detail.js +1 -1
- package/dist/es/src/api-model/models/buyer-info.js +1 -1
- package/dist/es/src/api-model/models/buyer-requested-cancel.js +1 -1
- package/dist/es/src/api-model/models/buyer-tax-info.js +1 -1
- package/dist/es/src/api-model/models/buyer-tax-information.js +1 -1
- package/dist/es/src/api-model/models/confirm-shipment-error-response.js +1 -1
- package/dist/es/src/api-model/models/confirm-shipment-order-item.js +1 -1
- package/dist/es/src/api-model/models/confirm-shipment-request.js +1 -1
- package/dist/es/src/api-model/models/constraint-type.js +1 -1
- package/dist/es/src/api-model/models/delivery-preferences.js +1 -1
- package/dist/es/src/api-model/models/easy-ship-shipment-status.js +2 -2
- package/dist/es/src/api-model/models/electronic-invoice-status.js +1 -1
- package/dist/es/src/api-model/models/exception-dates.js +1 -1
- package/dist/es/src/api-model/models/fulfillment-instruction.js +1 -1
- package/dist/es/src/api-model/models/fulfillment-instructions.js +14 -0
- package/dist/es/src/api-model/models/fulfillment-location.js +14 -0
- package/dist/es/src/api-model/models/fulfillment-plan-constraint-type.js +22 -0
- package/dist/es/src/api-model/models/fulfillment-plan-item.js +14 -0
- package/dist/es/src/api-model/models/fulfillment-plan-shipping-constraints.js +14 -0
- package/dist/es/src/api-model/models/fulfillment-plan.js +24 -0
- package/dist/es/src/api-model/models/get-order-address-response.js +1 -1
- package/dist/es/src/api-model/models/get-order-buyer-info-response.js +1 -1
- package/dist/es/src/api-model/models/get-order-fulfillment-instructions-response.js +14 -0
- package/dist/es/src/api-model/models/get-order-items-buyer-info-response.js +1 -1
- package/dist/es/src/api-model/models/get-order-items-response.js +1 -1
- package/dist/es/src/api-model/models/get-order-regulated-info-response.js +1 -1
- package/dist/es/src/api-model/models/get-order-response.js +1 -1
- package/dist/es/src/api-model/models/get-orders-response.js +1 -1
- package/dist/es/src/api-model/models/index.js +11 -0
- package/dist/es/src/api-model/models/item-buyer-info.js +1 -1
- package/dist/es/src/api-model/models/marketplace-tax-info.js +1 -1
- package/dist/es/src/api-model/models/measurement.js +1 -1
- package/dist/es/src/api-model/models/model-error.js +1 -1
- package/dist/es/src/api-model/models/money.js +1 -1
- package/dist/es/src/api-model/models/open-interval.js +1 -1
- package/dist/es/src/api-model/models/open-time-interval.js +1 -1
- package/dist/es/src/api-model/models/order-address.js +1 -1
- package/dist/es/src/api-model/models/order-buyer-info.js +1 -1
- package/dist/es/src/api-model/models/order-item-buyer-info.js +1 -1
- package/dist/es/src/api-model/models/order-item.js +1 -1
- package/dist/es/src/api-model/models/order-items-buyer-info-list.js +1 -1
- package/dist/es/src/api-model/models/order-items-inner.js +1 -1
- package/dist/es/src/api-model/models/order-items-list.js +1 -1
- package/dist/es/src/api-model/models/order-regulated-info.js +1 -1
- package/dist/es/src/api-model/models/order.js +1 -1
- package/dist/es/src/api-model/models/orders-list.js +1 -1
- package/dist/es/src/api-model/models/other-delivery-attributes.js +1 -1
- package/dist/es/src/api-model/models/package-detail.js +1 -1
- package/dist/es/src/api-model/models/payment-execution-detail-item.js +1 -1
- package/dist/es/src/api-model/models/points-granted-detail.js +1 -1
- package/dist/es/src/api-model/models/preferred-delivery-time.js +1 -1
- package/dist/es/src/api-model/models/prescription-detail.js +14 -0
- package/dist/es/src/api-model/models/product-info-detail.js +1 -1
- package/dist/es/src/api-model/models/regulated-information-field.js +1 -1
- package/dist/es/src/api-model/models/regulated-information.js +1 -1
- package/dist/es/src/api-model/models/regulated-order-verification-status.js +1 -1
- package/dist/es/src/api-model/models/rejection-reason.js +1 -1
- package/dist/es/src/api-model/models/shipment-status.js +1 -1
- package/dist/es/src/api-model/models/shipping-constraints.js +1 -1
- package/dist/es/src/api-model/models/shipping-instructions.js +14 -0
- package/dist/es/src/api-model/models/substitution-option.js +1 -1
- package/dist/es/src/api-model/models/substitution-preferences.js +1 -1
- package/dist/es/src/api-model/models/tax-classification.js +1 -1
- package/dist/es/src/api-model/models/tax-collection.js +1 -1
- package/dist/es/src/api-model/models/update-shipment-status-error-response.js +1 -1
- package/dist/es/src/api-model/models/update-shipment-status-request.js +1 -1
- package/dist/es/src/api-model/models/update-verification-status-error-response.js +1 -1
- package/dist/es/src/api-model/models/update-verification-status-request-body.js +1 -1
- package/dist/es/src/api-model/models/update-verification-status-request.js +1 -1
- package/dist/es/src/api-model/models/valid-verification-detail.js +14 -0
- package/dist/es/src/api-model/models/verification-details.js +14 -0
- package/dist/es/src/api-model/models/verification-status.js +1 -1
- package/dist/es/src/client.js +7 -0
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +129 -86
- package/dist/types/src/api-model/api.d.ts +1 -1
- package/dist/types/src/api-model/base.d.ts +1 -1
- package/dist/types/src/api-model/common.d.ts +1 -1
- package/dist/types/src/api-model/configuration.d.ts +1 -1
- package/dist/types/src/api-model/index.d.ts +1 -1
- package/dist/types/src/api-model/models/address-extended-fields.d.ts +4 -4
- package/dist/types/src/api-model/models/address.d.ts +2 -2
- package/dist/types/src/api-model/models/associated-item.d.ts +2 -2
- package/dist/types/src/api-model/models/association-type.d.ts +1 -1
- package/dist/types/src/api-model/models/automated-shipping-settings.d.ts +1 -1
- package/dist/types/src/api-model/models/business-hours.d.ts +1 -1
- package/dist/types/src/api-model/models/buyer-customized-info-detail.d.ts +2 -2
- package/dist/types/src/api-model/models/buyer-info.d.ts +2 -2
- package/dist/types/src/api-model/models/buyer-requested-cancel.d.ts +1 -1
- package/dist/types/src/api-model/models/buyer-tax-info.d.ts +1 -1
- package/dist/types/src/api-model/models/buyer-tax-information.d.ts +1 -1
- package/dist/types/src/api-model/models/confirm-shipment-error-response.d.ts +1 -1
- package/dist/types/src/api-model/models/confirm-shipment-order-item.d.ts +3 -3
- package/dist/types/src/api-model/models/confirm-shipment-request.d.ts +2 -2
- package/dist/types/src/api-model/models/constraint-type.d.ts +1 -1
- package/dist/types/src/api-model/models/delivery-preferences.d.ts +1 -1
- package/dist/types/src/api-model/models/easy-ship-shipment-status.d.ts +2 -2
- package/dist/types/src/api-model/models/electronic-invoice-status.d.ts +1 -1
- package/dist/types/src/api-model/models/exception-dates.d.ts +1 -1
- package/dist/types/src/api-model/models/fulfillment-instruction.d.ts +3 -3
- package/dist/types/src/api-model/models/fulfillment-instructions.d.ts +31 -0
- package/dist/types/src/api-model/models/fulfillment-location.d.ts +24 -0
- package/dist/types/src/api-model/models/fulfillment-plan-constraint-type.d.ts +21 -0
- package/dist/types/src/api-model/models/fulfillment-plan-item.d.ts +31 -0
- package/dist/types/src/api-model/models/fulfillment-plan-shipping-constraints.d.ts +31 -0
- package/dist/types/src/api-model/models/fulfillment-plan.d.ts +82 -0
- package/dist/types/src/api-model/models/get-order-address-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-order-buyer-info-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-order-fulfillment-instructions-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-order-items-buyer-info-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-order-items-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-order-regulated-info-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-order-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-orders-response.d.ts +1 -1
- package/dist/types/src/api-model/models/index.d.ts +11 -0
- package/dist/types/src/api-model/models/item-buyer-info.d.ts +2 -2
- package/dist/types/src/api-model/models/marketplace-tax-info.d.ts +1 -1
- package/dist/types/src/api-model/models/measurement.d.ts +3 -3
- package/dist/types/src/api-model/models/model-error.d.ts +1 -1
- package/dist/types/src/api-model/models/money.d.ts +1 -1
- package/dist/types/src/api-model/models/open-interval.d.ts +1 -1
- package/dist/types/src/api-model/models/open-time-interval.d.ts +1 -1
- 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 +2 -2
- package/dist/types/src/api-model/models/order-item-buyer-info.d.ts +2 -2
- package/dist/types/src/api-model/models/order-item.d.ts +14 -14
- package/dist/types/src/api-model/models/order-items-buyer-info-list.d.ts +1 -1
- package/dist/types/src/api-model/models/order-items-inner.d.ts +2 -2
- package/dist/types/src/api-model/models/order-items-list.d.ts +1 -1
- package/dist/types/src/api-model/models/order-regulated-info.d.ts +1 -1
- package/dist/types/src/api-model/models/order.d.ts +18 -18
- package/dist/types/src/api-model/models/orders-list.d.ts +3 -3
- package/dist/types/src/api-model/models/other-delivery-attributes.d.ts +1 -1
- package/dist/types/src/api-model/models/package-detail.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 +1 -1
- package/dist/types/src/api-model/models/preferred-delivery-time.d.ts +2 -2
- package/dist/types/src/api-model/models/prescription-detail.d.ts +60 -0
- 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 +4 -4
- 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 +10 -3
- package/dist/types/src/api-model/models/rejection-reason.d.ts +2 -2
- package/dist/types/src/api-model/models/shipment-status.d.ts +1 -1
- package/dist/types/src/api-model/models/shipping-constraints.d.ts +19 -1
- package/dist/types/src/api-model/models/shipping-instructions.d.ts +37 -0
- package/dist/types/src/api-model/models/substitution-option.d.ts +4 -4
- package/dist/types/src/api-model/models/substitution-preferences.d.ts +1 -1
- package/dist/types/src/api-model/models/tax-classification.d.ts +2 -2
- package/dist/types/src/api-model/models/tax-collection.d.ts +1 -1
- 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 +1 -1
- 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 +11 -4
- package/dist/types/src/api-model/models/update-verification-status-request.d.ts +1 -1
- package/dist/types/src/api-model/models/valid-verification-detail.d.ts +31 -0
- package/dist/types/src/api-model/models/verification-details.d.ts +25 -0
- package/dist/types/src/api-model/models/verification-status.d.ts +1 -1
- package/package.json +5 -5
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for Orders
|
|
3
|
-
*
|
|
3
|
+
* Use the Orders Selling Partner API to programmatically retrieve order information. With this API, you can develop fast, flexible, and custom applications to manage order synchronization, perform order research, and create demand-based decision support tools. _Note:_ For the JP, AU, and SG marketplaces, the Orders API supports orders from 2016 onward. For all other marketplaces, the Orders API supports orders for the last two years (orders older than this don\'t show up in the response).
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: v0
|
|
6
6
|
*
|
|
@@ -16,6 +16,7 @@ import { type RequestArgs, BaseAPI } from '../base';
|
|
|
16
16
|
import type { ConfirmShipmentRequest } from '../models';
|
|
17
17
|
import type { GetOrderAddressResponse } from '../models';
|
|
18
18
|
import type { GetOrderBuyerInfoResponse } from '../models';
|
|
19
|
+
import type { GetOrderFulfillmentInstructionsResponse } from '../models';
|
|
19
20
|
import type { GetOrderItemsBuyerInfoResponse } from '../models';
|
|
20
21
|
import type { GetOrderItemsResponse } from '../models';
|
|
21
22
|
import type { GetOrderRegulatedInfoResponse } from '../models';
|
|
@@ -29,36 +30,43 @@ import type { UpdateVerificationStatusRequest } from '../models';
|
|
|
29
30
|
*/
|
|
30
31
|
export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
31
32
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
33
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
34
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
34
|
-
* @param {ConfirmShipmentRequest} payload
|
|
35
|
+
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
35
36
|
* @param {*} [options] Override http request option.
|
|
36
37
|
* @throws {RequiredError}
|
|
37
38
|
*/
|
|
38
39
|
confirmShipment: (orderId: string, payload: ConfirmShipmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
40
|
/**
|
|
40
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
41
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
42
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
42
43
|
* @param {*} [options] Override http request option.
|
|
43
44
|
* @throws {RequiredError}
|
|
44
45
|
*/
|
|
45
46
|
getOrder: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
47
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
48
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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).
|
|
48
49
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
49
50
|
* @param {*} [options] Override http request option.
|
|
50
51
|
* @throws {RequiredError}
|
|
51
52
|
*/
|
|
52
53
|
getOrderAddress: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
54
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
55
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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).
|
|
55
56
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
56
57
|
* @param {*} [options] Override http request option.
|
|
57
58
|
* @throws {RequiredError}
|
|
58
59
|
*/
|
|
59
60
|
getOrderBuyerInfo: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
61
|
/**
|
|
61
|
-
* Returns
|
|
62
|
+
* Returns the fulfillment instructions for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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).
|
|
63
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
64
|
+
* @param {*} [options] Override http request option.
|
|
65
|
+
* @throws {RequiredError}
|
|
66
|
+
*/
|
|
67
|
+
getOrderFulfillmentInstructions: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
|
+
/**
|
|
69
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
70
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
63
71
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
64
72
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +74,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
66
74
|
*/
|
|
67
75
|
getOrderItems: (orderId: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
76
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
77
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
78
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
71
79
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
72
80
|
* @param {*} [options] Override http request option.
|
|
@@ -74,42 +82,42 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
74
82
|
*/
|
|
75
83
|
getOrderItemsBuyerInfo: (orderId: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
84
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
85
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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).
|
|
78
86
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
79
87
|
* @param {*} [options] Override http request option.
|
|
80
88
|
* @throws {RequiredError}
|
|
81
89
|
*/
|
|
82
90
|
getOrderRegulatedInfo: (orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
83
91
|
/**
|
|
84
|
-
* Returns orders created or updated during the time
|
|
85
|
-
* @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 `
|
|
86
|
-
* @param {string} [createdAfter]
|
|
87
|
-
* @param {string} [createdBefore]
|
|
88
|
-
* @param {string} [lastUpdatedAfter]
|
|
89
|
-
* @param {string} [lastUpdatedBefore]
|
|
92
|
+
* 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 returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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) in the Selling Partner API documentation.
|
|
93
|
+
* @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.
|
|
94
|
+
* @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.
|
|
95
|
+
* @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.
|
|
96
|
+
* @param {string} [lastUpdatedAfter] 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.
|
|
97
|
+
* @param {string} [lastUpdatedBefore] 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.
|
|
90
98
|
* @param {Array<string>} [orderStatuses] A list of `OrderStatus` values used to filter the results. **Possible values:** - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.) - `Pending` (The order has been placed but payment has not been authorized.) - `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.) - `PartiallyShipped` (One or more, but not all, items in the order have been shipped.) - `Shipped` (All items in the order have been shipped.) - `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.) - `Canceled` (The order has been canceled.) - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)
|
|
91
|
-
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (
|
|
92
|
-
* @param {Array<string>} [paymentMethods] A list of payment method values.
|
|
99
|
+
* @param {Array<string>} [fulfillmentChannels] 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).
|
|
100
|
+
* @param {Array<string>} [paymentMethods] 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).
|
|
93
101
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
94
|
-
* @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels
|
|
102
|
+
* @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore, and `BuyerEmail` cannot be specified.
|
|
95
103
|
* @param {number} [maxResultsPerPage] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
|
|
96
104
|
* @param {Array<string>} [easyShipShipmentStatuses] A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.)
|
|
97
105
|
* @param {Array<string>} [electronicInvoiceStatuses] A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.)
|
|
98
106
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
99
|
-
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
100
|
-
* @param {string} [actualFulfillmentSupplySourceId]
|
|
107
|
+
* @param {Array<string>} [amazonOrderIds] A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
108
|
+
* @param {string} [actualFulfillmentSupplySourceId] The `sourceId` of the location from where you want the order fulfilled.
|
|
101
109
|
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
102
110
|
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
103
|
-
* @param {string} [earliestDeliveryDateBefore]
|
|
104
|
-
* @param {string} [earliestDeliveryDateAfter]
|
|
105
|
-
* @param {string} [latestDeliveryDateBefore]
|
|
106
|
-
* @param {string} [latestDeliveryDateAfter]
|
|
111
|
+
* @param {string} [earliestDeliveryDateBefore] 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.
|
|
112
|
+
* @param {string} [earliestDeliveryDateAfter] 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.
|
|
113
|
+
* @param {string} [latestDeliveryDateBefore] 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.
|
|
114
|
+
* @param {string} [latestDeliveryDateAfter] 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.
|
|
107
115
|
* @param {*} [options] Override http request option.
|
|
108
116
|
* @throws {RequiredError}
|
|
109
117
|
*/
|
|
110
118
|
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
119
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
120
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
121
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
114
122
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
115
123
|
* @param {*} [options] Override http request option.
|
|
@@ -117,7 +125,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
117
125
|
*/
|
|
118
126
|
updateShipmentStatus: (orderId: string, payload: UpdateShipmentStatusRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
119
127
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
128
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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).
|
|
121
129
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
122
130
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
123
131
|
* @param {*} [options] Override http request option.
|
|
@@ -131,36 +139,43 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
131
139
|
*/
|
|
132
140
|
export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
133
141
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
142
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
143
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
136
|
-
* @param {ConfirmShipmentRequest} payload
|
|
144
|
+
* @param {ConfirmShipmentRequest} payload Request body of `confirmShipment`.
|
|
137
145
|
* @param {*} [options] Override http request option.
|
|
138
146
|
* @throws {RequiredError}
|
|
139
147
|
*/
|
|
140
148
|
confirmShipment(orderId: string, payload: ConfirmShipmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
141
149
|
/**
|
|
142
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
150
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
151
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
144
152
|
* @param {*} [options] Override http request option.
|
|
145
153
|
* @throws {RequiredError}
|
|
146
154
|
*/
|
|
147
155
|
getOrder(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderResponse>>;
|
|
148
156
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
157
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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).
|
|
150
158
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
151
159
|
* @param {*} [options] Override http request option.
|
|
152
160
|
* @throws {RequiredError}
|
|
153
161
|
*/
|
|
154
162
|
getOrderAddress(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderAddressResponse>>;
|
|
155
163
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
164
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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).
|
|
157
165
|
* @param {string} orderId An `orderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
158
166
|
* @param {*} [options] Override http request option.
|
|
159
167
|
* @throws {RequiredError}
|
|
160
168
|
*/
|
|
161
169
|
getOrderBuyerInfo(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderBuyerInfoResponse>>;
|
|
162
170
|
/**
|
|
163
|
-
* Returns
|
|
171
|
+
* Returns the fulfillment instructions for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
173
|
+
* @param {*} [options] Override http request option.
|
|
174
|
+
* @throws {RequiredError}
|
|
175
|
+
*/
|
|
176
|
+
getOrderFulfillmentInstructions(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderFulfillmentInstructionsResponse>>;
|
|
177
|
+
/**
|
|
178
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
179
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
165
180
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
166
181
|
* @param {*} [options] Override http request option.
|
|
@@ -168,7 +183,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
168
183
|
*/
|
|
169
184
|
getOrderItems(orderId: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsResponse>>;
|
|
170
185
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
186
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
187
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
173
188
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
174
189
|
* @param {*} [options] Override http request option.
|
|
@@ -176,42 +191,42 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
176
191
|
*/
|
|
177
192
|
getOrderItemsBuyerInfo(orderId: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderItemsBuyerInfoResponse>>;
|
|
178
193
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
194
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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).
|
|
180
195
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
181
196
|
* @param {*} [options] Override http request option.
|
|
182
197
|
* @throws {RequiredError}
|
|
183
198
|
*/
|
|
184
199
|
getOrderRegulatedInfo(orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderRegulatedInfoResponse>>;
|
|
185
200
|
/**
|
|
186
|
-
* Returns orders created or updated during the time
|
|
187
|
-
* @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 `
|
|
188
|
-
* @param {string} [createdAfter]
|
|
189
|
-
* @param {string} [createdBefore]
|
|
190
|
-
* @param {string} [lastUpdatedAfter]
|
|
191
|
-
* @param {string} [lastUpdatedBefore]
|
|
201
|
+
* 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 returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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) in the Selling Partner API documentation.
|
|
202
|
+
* @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.
|
|
203
|
+
* @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.
|
|
204
|
+
* @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.
|
|
205
|
+
* @param {string} [lastUpdatedAfter] 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.
|
|
206
|
+
* @param {string} [lastUpdatedBefore] 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.
|
|
192
207
|
* @param {Array<string>} [orderStatuses] A list of `OrderStatus` values used to filter the results. **Possible values:** - `PendingAvailability` (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.) - `Pending` (The order has been placed but payment has not been authorized.) - `Unshipped` (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped.) - `PartiallyShipped` (One or more, but not all, items in the order have been shipped.) - `Shipped` (All items in the order have been shipped.) - `InvoiceUnconfirmed` (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.) - `Canceled` (The order has been canceled.) - `Unfulfillable` (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.)
|
|
193
|
-
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (
|
|
194
|
-
* @param {Array<string>} [paymentMethods] A list of payment method values.
|
|
208
|
+
* @param {Array<string>} [fulfillmentChannels] 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).
|
|
209
|
+
* @param {Array<string>} [paymentMethods] 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).
|
|
195
210
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
196
|
-
* @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels
|
|
211
|
+
* @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If `SellerOrderId` is specified, then `FulfillmentChannels`, `OrderStatuses`, `PaymentMethod`, `LastUpdatedAfter`, LastUpdatedBefore, and `BuyerEmail` cannot be specified.
|
|
197
212
|
* @param {number} [maxResultsPerPage] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
|
|
198
213
|
* @param {Array<string>} [easyShipShipmentStatuses] A list of `EasyShipShipmentStatus` values. Used to select Easy Ship orders with statuses that match the specified values. If `EasyShipShipmentStatus` is specified, only Amazon Easy Ship orders are returned. **Possible values:** - `PendingSchedule` (The package is awaiting the schedule for pick-up.) - `PendingPickUp` (Amazon has not yet picked up the package from the seller.) - `PendingDropOff` (The seller will deliver the package to the carrier.) - `LabelCanceled` (The seller canceled the pickup.) - `PickedUp` (Amazon has picked up the package from the seller.) - `DroppedOff` (The package is delivered to the carrier by the seller.) - `AtOriginFC` (The packaged is at the origin fulfillment center.) - `AtDestinationFC` (The package is at the destination fulfillment center.) - `Delivered` (The package has been delivered.) - `RejectedByBuyer` (The package has been rejected by the buyer.) - `Undeliverable` (The package cannot be delivered.) - `ReturningToSeller` (The package was not delivered and is being returned to the seller.) - `ReturnedToSeller` (The package was not delivered and was returned to the seller.) - `Lost` (The package is lost.) - `OutForDelivery` (The package is out for delivery.) - `Damaged` (The package was damaged by the carrier.)
|
|
199
214
|
* @param {Array<string>} [electronicInvoiceStatuses] A list of `ElectronicInvoiceStatus` values. Used to select orders with electronic invoice statuses that match the specified values. **Possible values:** - `NotRequired` (Electronic invoice submission is not required for this order.) - `NotFound` (The electronic invoice was not submitted for this order.) - `Processing` (The electronic invoice is being processed for this order.) - `Errored` (The last submitted electronic invoice was rejected for this order.) - `Accepted` (The last submitted electronic invoice was submitted and accepted.)
|
|
200
215
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
201
|
-
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
202
|
-
* @param {string} [actualFulfillmentSupplySourceId]
|
|
216
|
+
* @param {Array<string>} [amazonOrderIds] A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
217
|
+
* @param {string} [actualFulfillmentSupplySourceId] The `sourceId` of the location from where you want the order fulfilled.
|
|
203
218
|
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
204
219
|
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
205
|
-
* @param {string} [earliestDeliveryDateBefore]
|
|
206
|
-
* @param {string} [earliestDeliveryDateAfter]
|
|
207
|
-
* @param {string} [latestDeliveryDateBefore]
|
|
208
|
-
* @param {string} [latestDeliveryDateAfter]
|
|
220
|
+
* @param {string} [earliestDeliveryDateBefore] 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.
|
|
221
|
+
* @param {string} [earliestDeliveryDateAfter] 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.
|
|
222
|
+
* @param {string} [latestDeliveryDateBefore] 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.
|
|
223
|
+
* @param {string} [latestDeliveryDateAfter] 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.
|
|
209
224
|
* @param {*} [options] Override http request option.
|
|
210
225
|
* @throws {RequiredError}
|
|
211
226
|
*/
|
|
212
227
|
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
228
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
229
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
230
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
216
231
|
* @param {UpdateShipmentStatusRequest} payload The request body for the `updateShipmentStatus` operation.
|
|
217
232
|
* @param {*} [options] Override http request option.
|
|
@@ -219,7 +234,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
219
234
|
*/
|
|
220
235
|
updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
221
236
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
237
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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).
|
|
223
238
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
224
239
|
* @param {UpdateVerificationStatusRequest} payload The request body for the `updateVerificationStatus` operation.
|
|
225
240
|
* @param {*} [options] Override http request option.
|
|
@@ -233,70 +248,77 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
233
248
|
*/
|
|
234
249
|
export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
235
250
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
251
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
252
|
* @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
238
253
|
* @param {*} [options] Override http request option.
|
|
239
254
|
* @throws {RequiredError}
|
|
240
255
|
*/
|
|
241
256
|
confirmShipment(requestParameters: OrdersV0ApiConfirmShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
242
257
|
/**
|
|
243
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
258
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
259
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
245
260
|
* @param {*} [options] Override http request option.
|
|
246
261
|
* @throws {RequiredError}
|
|
247
262
|
*/
|
|
248
263
|
getOrder(requestParameters: OrdersV0ApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderResponse>;
|
|
249
264
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
265
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
266
|
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
252
267
|
* @param {*} [options] Override http request option.
|
|
253
268
|
* @throws {RequiredError}
|
|
254
269
|
*/
|
|
255
270
|
getOrderAddress(requestParameters: OrdersV0ApiGetOrderAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderAddressResponse>;
|
|
256
271
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
272
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
273
|
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
259
274
|
* @param {*} [options] Override http request option.
|
|
260
275
|
* @throws {RequiredError}
|
|
261
276
|
*/
|
|
262
277
|
getOrderBuyerInfo(requestParameters: OrdersV0ApiGetOrderBuyerInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderBuyerInfoResponse>;
|
|
263
278
|
/**
|
|
264
|
-
* Returns
|
|
279
|
+
* Returns the fulfillment instructions for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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).
|
|
280
|
+
* @param {OrdersV0ApiGetOrderFulfillmentInstructionsRequest} requestParameters Request parameters.
|
|
281
|
+
* @param {*} [options] Override http request option.
|
|
282
|
+
* @throws {RequiredError}
|
|
283
|
+
*/
|
|
284
|
+
getOrderFulfillmentInstructions(requestParameters: OrdersV0ApiGetOrderFulfillmentInstructionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderFulfillmentInstructionsResponse>;
|
|
285
|
+
/**
|
|
286
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
287
|
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
266
288
|
* @param {*} [options] Override http request option.
|
|
267
289
|
* @throws {RequiredError}
|
|
268
290
|
*/
|
|
269
291
|
getOrderItems(requestParameters: OrdersV0ApiGetOrderItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderItemsResponse>;
|
|
270
292
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
293
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
294
|
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
273
295
|
* @param {*} [options] Override http request option.
|
|
274
296
|
* @throws {RequiredError}
|
|
275
297
|
*/
|
|
276
298
|
getOrderItemsBuyerInfo(requestParameters: OrdersV0ApiGetOrderItemsBuyerInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
|
|
277
299
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
300
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
301
|
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
280
302
|
* @param {*} [options] Override http request option.
|
|
281
303
|
* @throws {RequiredError}
|
|
282
304
|
*/
|
|
283
305
|
getOrderRegulatedInfo(requestParameters: OrdersV0ApiGetOrderRegulatedInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrderRegulatedInfoResponse>;
|
|
284
306
|
/**
|
|
285
|
-
* Returns orders created or updated during the time
|
|
307
|
+
* 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 returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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) in the Selling Partner API documentation.
|
|
286
308
|
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
287
309
|
* @param {*} [options] Override http request option.
|
|
288
310
|
* @throws {RequiredError}
|
|
289
311
|
*/
|
|
290
312
|
getOrders(requestParameters: OrdersV0ApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrdersResponse>;
|
|
291
313
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
314
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
315
|
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
294
316
|
* @param {*} [options] Override http request option.
|
|
295
317
|
* @throws {RequiredError}
|
|
296
318
|
*/
|
|
297
319
|
updateShipmentStatus(requestParameters: OrdersV0ApiUpdateShipmentStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
298
320
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
321
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
322
|
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
301
323
|
* @param {*} [options] Override http request option.
|
|
302
324
|
* @throws {RequiredError}
|
|
@@ -316,7 +338,7 @@ export interface OrdersV0ApiConfirmShipmentRequest {
|
|
|
316
338
|
*/
|
|
317
339
|
readonly orderId: string;
|
|
318
340
|
/**
|
|
319
|
-
*
|
|
341
|
+
* Request body of `confirmShipment`.
|
|
320
342
|
* @type {ConfirmShipmentRequest}
|
|
321
343
|
* @memberof OrdersV0ApiConfirmShipment
|
|
322
344
|
*/
|
|
@@ -361,6 +383,19 @@ export interface OrdersV0ApiGetOrderBuyerInfoRequest {
|
|
|
361
383
|
*/
|
|
362
384
|
readonly orderId: string;
|
|
363
385
|
}
|
|
386
|
+
/**
|
|
387
|
+
* Request parameters for getOrderFulfillmentInstructions operation in OrdersV0Api.
|
|
388
|
+
* @export
|
|
389
|
+
* @interface OrdersV0ApiGetOrderFulfillmentInstructionsRequest
|
|
390
|
+
*/
|
|
391
|
+
export interface OrdersV0ApiGetOrderFulfillmentInstructionsRequest {
|
|
392
|
+
/**
|
|
393
|
+
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
394
|
+
* @type {string}
|
|
395
|
+
* @memberof OrdersV0ApiGetOrderFulfillmentInstructions
|
|
396
|
+
*/
|
|
397
|
+
readonly orderId: string;
|
|
398
|
+
}
|
|
364
399
|
/**
|
|
365
400
|
* Request parameters for getOrderItems operation in OrdersV0Api.
|
|
366
401
|
* @export
|
|
@@ -419,31 +454,31 @@ export interface OrdersV0ApiGetOrderRegulatedInfoRequest {
|
|
|
419
454
|
*/
|
|
420
455
|
export interface OrdersV0ApiGetOrdersRequest {
|
|
421
456
|
/**
|
|
422
|
-
* 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 `
|
|
457
|
+
* 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
458
|
* @type {Array<string>}
|
|
424
459
|
* @memberof OrdersV0ApiGetOrders
|
|
425
460
|
*/
|
|
426
461
|
readonly marketplaceIds: Array<string>;
|
|
427
462
|
/**
|
|
428
|
-
*
|
|
463
|
+
* 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
464
|
* @type {string}
|
|
430
465
|
* @memberof OrdersV0ApiGetOrders
|
|
431
466
|
*/
|
|
432
467
|
readonly createdAfter?: string;
|
|
433
468
|
/**
|
|
434
|
-
*
|
|
469
|
+
* 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
470
|
* @type {string}
|
|
436
471
|
* @memberof OrdersV0ApiGetOrders
|
|
437
472
|
*/
|
|
438
473
|
readonly createdBefore?: string;
|
|
439
474
|
/**
|
|
440
|
-
*
|
|
475
|
+
* 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
476
|
* @type {string}
|
|
442
477
|
* @memberof OrdersV0ApiGetOrders
|
|
443
478
|
*/
|
|
444
479
|
readonly lastUpdatedAfter?: string;
|
|
445
480
|
/**
|
|
446
|
-
*
|
|
481
|
+
* 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
482
|
* @type {string}
|
|
448
483
|
* @memberof OrdersV0ApiGetOrders
|
|
449
484
|
*/
|
|
@@ -455,13 +490,13 @@ export interface OrdersV0ApiGetOrdersRequest {
|
|
|
455
490
|
*/
|
|
456
491
|
readonly orderStatuses?: Array<string>;
|
|
457
492
|
/**
|
|
458
|
-
* A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. **Possible values**: `AFN` (
|
|
493
|
+
* 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
494
|
* @type {Array<string>}
|
|
460
495
|
* @memberof OrdersV0ApiGetOrders
|
|
461
496
|
*/
|
|
462
497
|
readonly fulfillmentChannels?: Array<string>;
|
|
463
498
|
/**
|
|
464
|
-
* A list of payment method values.
|
|
499
|
+
* 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
500
|
* @type {Array<string>}
|
|
466
501
|
* @memberof OrdersV0ApiGetOrders
|
|
467
502
|
*/
|
|
@@ -473,7 +508,7 @@ export interface OrdersV0ApiGetOrdersRequest {
|
|
|
473
508
|
*/
|
|
474
509
|
readonly buyerEmail?: string;
|
|
475
510
|
/**
|
|
476
|
-
* 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
|
|
511
|
+
* 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
512
|
* @type {string}
|
|
478
513
|
* @memberof OrdersV0ApiGetOrders
|
|
479
514
|
*/
|
|
@@ -503,13 +538,13 @@ export interface OrdersV0ApiGetOrdersRequest {
|
|
|
503
538
|
*/
|
|
504
539
|
readonly nextToken?: string;
|
|
505
540
|
/**
|
|
506
|
-
* A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
541
|
+
* A list of `AmazonOrderId` values. An `AmazonOrderId` is an Amazon-defined order identifier, in 3-7-7 format.
|
|
507
542
|
* @type {Array<string>}
|
|
508
543
|
* @memberof OrdersV0ApiGetOrders
|
|
509
544
|
*/
|
|
510
545
|
readonly amazonOrderIds?: Array<string>;
|
|
511
546
|
/**
|
|
512
|
-
*
|
|
547
|
+
* The `sourceId` of the location from where you want the order fulfilled.
|
|
513
548
|
* @type {string}
|
|
514
549
|
* @memberof OrdersV0ApiGetOrders
|
|
515
550
|
*/
|
|
@@ -527,25 +562,25 @@ export interface OrdersV0ApiGetOrdersRequest {
|
|
|
527
562
|
*/
|
|
528
563
|
readonly storeChainStoreId?: string;
|
|
529
564
|
/**
|
|
530
|
-
*
|
|
565
|
+
* 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
566
|
* @type {string}
|
|
532
567
|
* @memberof OrdersV0ApiGetOrders
|
|
533
568
|
*/
|
|
534
569
|
readonly earliestDeliveryDateBefore?: string;
|
|
535
570
|
/**
|
|
536
|
-
*
|
|
571
|
+
* 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
572
|
* @type {string}
|
|
538
573
|
* @memberof OrdersV0ApiGetOrders
|
|
539
574
|
*/
|
|
540
575
|
readonly earliestDeliveryDateAfter?: string;
|
|
541
576
|
/**
|
|
542
|
-
*
|
|
577
|
+
* 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
578
|
* @type {string}
|
|
544
579
|
* @memberof OrdersV0ApiGetOrders
|
|
545
580
|
*/
|
|
546
581
|
readonly latestDeliveryDateBefore?: string;
|
|
547
582
|
/**
|
|
548
|
-
*
|
|
583
|
+
* 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
584
|
* @type {string}
|
|
550
585
|
* @memberof OrdersV0ApiGetOrders
|
|
551
586
|
*/
|
|
@@ -597,7 +632,7 @@ export interface OrdersV0ApiUpdateVerificationStatusRequest {
|
|
|
597
632
|
*/
|
|
598
633
|
export declare class OrdersV0Api extends BaseAPI {
|
|
599
634
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
635
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
636
|
* @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
602
637
|
* @param {*} [options] Override http request option.
|
|
603
638
|
* @throws {RequiredError}
|
|
@@ -605,7 +640,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
605
640
|
*/
|
|
606
641
|
confirmShipment(requestParameters: OrdersV0ApiConfirmShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
607
642
|
/**
|
|
608
|
-
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
643
|
+
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
644
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
610
645
|
* @param {*} [options] Override http request option.
|
|
611
646
|
* @throws {RequiredError}
|
|
@@ -613,7 +648,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
613
648
|
*/
|
|
614
649
|
getOrder(requestParameters: OrdersV0ApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderResponse, any>>;
|
|
615
650
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
651
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
652
|
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
618
653
|
* @param {*} [options] Override http request option.
|
|
619
654
|
* @throws {RequiredError}
|
|
@@ -621,7 +656,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
621
656
|
*/
|
|
622
657
|
getOrderAddress(requestParameters: OrdersV0ApiGetOrderAddressRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderAddressResponse, any>>;
|
|
623
658
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
659
|
+
* 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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
660
|
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
626
661
|
* @param {*} [options] Override http request option.
|
|
627
662
|
* @throws {RequiredError}
|
|
@@ -629,7 +664,15 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
629
664
|
*/
|
|
630
665
|
getOrderBuyerInfo(requestParameters: OrdersV0ApiGetOrderBuyerInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderBuyerInfoResponse, any>>;
|
|
631
666
|
/**
|
|
632
|
-
* Returns
|
|
667
|
+
* Returns the fulfillment instructions for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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).
|
|
668
|
+
* @param {OrdersV0ApiGetOrderFulfillmentInstructionsRequest} requestParameters Request parameters.
|
|
669
|
+
* @param {*} [options] Override http request option.
|
|
670
|
+
* @throws {RequiredError}
|
|
671
|
+
* @memberof OrdersV0Api
|
|
672
|
+
*/
|
|
673
|
+
getOrderFulfillmentInstructions(requestParameters: OrdersV0ApiGetOrderFulfillmentInstructionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderFulfillmentInstructionsResponse, any>>;
|
|
674
|
+
/**
|
|
675
|
+
* Returns detailed order item information for the order that you specify. If `NextToken` is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
676
|
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
634
677
|
* @param {*} [options] Override http request option.
|
|
635
678
|
* @throws {RequiredError}
|
|
@@ -637,7 +680,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
637
680
|
*/
|
|
638
681
|
getOrderItems(requestParameters: OrdersV0ApiGetOrderItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderItemsResponse, any>>;
|
|
639
682
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
683
|
+
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
684
|
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
642
685
|
* @param {*} [options] Override http request option.
|
|
643
686
|
* @throws {RequiredError}
|
|
@@ -645,7 +688,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
645
688
|
*/
|
|
646
689
|
getOrderItemsBuyerInfo(requestParameters: OrdersV0ApiGetOrderItemsBuyerInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderItemsBuyerInfoResponse, any>>;
|
|
647
690
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
691
|
+
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
692
|
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
650
693
|
* @param {*} [options] Override http request option.
|
|
651
694
|
* @throws {RequiredError}
|
|
@@ -653,7 +696,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
653
696
|
*/
|
|
654
697
|
getOrderRegulatedInfo(requestParameters: OrdersV0ApiGetOrderRegulatedInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderRegulatedInfoResponse, any>>;
|
|
655
698
|
/**
|
|
656
|
-
* Returns orders created or updated during the time
|
|
699
|
+
* 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 returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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) in the Selling Partner API documentation.
|
|
657
700
|
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
658
701
|
* @param {*} [options] Override http request option.
|
|
659
702
|
* @throws {RequiredError}
|
|
@@ -661,7 +704,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
661
704
|
*/
|
|
662
705
|
getOrders(requestParameters: OrdersV0ApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrdersResponse, any>>;
|
|
663
706
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
707
|
+
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
708
|
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
666
709
|
* @param {*} [options] Override http request option.
|
|
667
710
|
* @throws {RequiredError}
|
|
@@ -669,7 +712,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
669
712
|
*/
|
|
670
713
|
updateShipmentStatus(requestParameters: OrdersV0ApiUpdateShipmentStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any>>;
|
|
671
714
|
/**
|
|
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 returns the usage plan rate limits that were applied to the requested operation, when available. The table
|
|
715
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values then 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
716
|
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
674
717
|
* @param {*} [options] Override http request option.
|
|
675
718
|
* @throws {RequiredError}
|