@sp-api-sdk/orders-api-v0 1.19.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/src/api-model/api/orders-v0-api.js +33 -124
- package/dist/cjs/src/api-model/base.js +1 -3
- package/dist/cjs/src/api-model/common.js +2 -0
- package/dist/cjs/src/api-model/models/index.js +0 -4
- package/dist/cjs/src/client.js +0 -7
- package/dist/es/src/api-model/api/orders-v0-api.js +33 -124
- package/dist/es/src/api-model/base.js +1 -3
- package/dist/es/src/api-model/common.js +2 -0
- package/dist/es/src/api-model/models/index.js +0 -4
- package/dist/es/src/client.js +0 -7
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +24 -103
- package/dist/types/src/api-model/base.d.ts +2 -3
- package/dist/types/src/api-model/common.d.ts +3 -3
- package/dist/types/src/api-model/models/index.d.ts +0 -4
- package/package.json +3 -3
- package/dist/cjs/src/api-model/models/confirm-shipment-error-response.js +0 -15
- package/dist/cjs/src/api-model/models/confirm-shipment-order-item.js +0 -15
- package/dist/cjs/src/api-model/models/confirm-shipment-request.js +0 -19
- package/dist/cjs/src/api-model/models/package-detail.js +0 -15
- package/dist/es/src/api-model/models/confirm-shipment-error-response.js +0 -14
- package/dist/es/src/api-model/models/confirm-shipment-order-item.js +0 -14
- package/dist/es/src/api-model/models/confirm-shipment-request.js +0 -16
- package/dist/es/src/api-model/models/package-detail.js +0 -14
- package/dist/types/src/api-model/models/confirm-shipment-error-response.d.ts +0 -24
- package/dist/types/src/api-model/models/confirm-shipment-order-item.d.ts +0 -36
- package/dist/types/src/api-model/models/confirm-shipment-request.d.ts +0 -41
- package/dist/types/src/api-model/models/package-detail.d.ts +0 -67
|
@@ -23,39 +23,6 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
|
|
|
23
23
|
*/
|
|
24
24
|
export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
|
-
/**
|
|
27
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
28
|
-
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
29
|
-
* @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
|
|
30
|
-
* @param {*} [options] Override http request option.
|
|
31
|
-
* @throws {RequiredError}
|
|
32
|
-
*/
|
|
33
|
-
confirmShipment: async (orderId, payload, options = {}) => {
|
|
34
|
-
// verify required parameter 'orderId' is not null or undefined
|
|
35
|
-
assertParamExists('confirmShipment', 'orderId', orderId);
|
|
36
|
-
// verify required parameter 'payload' is not null or undefined
|
|
37
|
-
assertParamExists('confirmShipment', 'payload', payload);
|
|
38
|
-
const localVarPath = `/orders/v0/orders/{orderId}/shipmentConfirmation`
|
|
39
|
-
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
40
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
42
|
-
let baseOptions;
|
|
43
|
-
if (configuration) {
|
|
44
|
-
baseOptions = configuration.baseOptions;
|
|
45
|
-
}
|
|
46
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
47
|
-
const localVarHeaderParameter = {};
|
|
48
|
-
const localVarQueryParameter = {};
|
|
49
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
50
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
52
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
53
|
-
localVarRequestOptions.data = serializeDataIfNeeded(payload, localVarRequestOptions, configuration);
|
|
54
|
-
return {
|
|
55
|
-
url: toPathString(localVarUrlObj),
|
|
56
|
-
options: localVarRequestOptions,
|
|
57
|
-
};
|
|
58
|
-
},
|
|
59
26
|
/**
|
|
60
27
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
61
28
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -486,17 +453,6 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
486
453
|
export const OrdersV0ApiFp = function (configuration) {
|
|
487
454
|
const localVarAxiosParamCreator = OrdersV0ApiAxiosParamCreator(configuration);
|
|
488
455
|
return {
|
|
489
|
-
/**
|
|
490
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
491
|
-
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
492
|
-
* @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
|
|
493
|
-
* @param {*} [options] Override http request option.
|
|
494
|
-
* @throws {RequiredError}
|
|
495
|
-
*/
|
|
496
|
-
async confirmShipment(orderId, payload, options) {
|
|
497
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.confirmShipment(orderId, payload, options);
|
|
498
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
499
|
-
},
|
|
500
456
|
/**
|
|
501
457
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
502
458
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -643,141 +599,104 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
643
599
|
export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
644
600
|
const localVarFp = OrdersV0ApiFp(configuration);
|
|
645
601
|
return {
|
|
646
|
-
/**
|
|
647
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
648
|
-
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
649
|
-
* @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
|
|
650
|
-
* @param {*} [options] Override http request option.
|
|
651
|
-
* @throws {RequiredError}
|
|
652
|
-
*/
|
|
653
|
-
confirmShipment(orderId, payload, options) {
|
|
654
|
-
return localVarFp.confirmShipment(orderId, payload, options).then((request) => request(axios, basePath));
|
|
655
|
-
},
|
|
656
602
|
/**
|
|
657
603
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
658
|
-
* @param {
|
|
604
|
+
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
659
605
|
* @param {*} [options] Override http request option.
|
|
660
606
|
* @throws {RequiredError}
|
|
661
607
|
*/
|
|
662
|
-
getOrder(
|
|
663
|
-
return localVarFp.getOrder(orderId, options).then((request) => request(axios, basePath));
|
|
608
|
+
getOrder(requestParameters, options) {
|
|
609
|
+
return localVarFp.getOrder(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
664
610
|
},
|
|
665
611
|
/**
|
|
666
612
|
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
667
|
-
* @param {
|
|
613
|
+
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
668
614
|
* @param {*} [options] Override http request option.
|
|
669
615
|
* @throws {RequiredError}
|
|
670
616
|
*/
|
|
671
|
-
getOrderAddress(
|
|
672
|
-
return localVarFp.getOrderAddress(orderId, options).then((request) => request(axios, basePath));
|
|
617
|
+
getOrderAddress(requestParameters, options) {
|
|
618
|
+
return localVarFp.getOrderAddress(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
673
619
|
},
|
|
674
620
|
/**
|
|
675
621
|
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
676
|
-
* @param {
|
|
622
|
+
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
677
623
|
* @param {*} [options] Override http request option.
|
|
678
624
|
* @throws {RequiredError}
|
|
679
625
|
*/
|
|
680
|
-
getOrderBuyerInfo(
|
|
681
|
-
return localVarFp.getOrderBuyerInfo(orderId, options).then((request) => request(axios, basePath));
|
|
626
|
+
getOrderBuyerInfo(requestParameters, options) {
|
|
627
|
+
return localVarFp.getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
682
628
|
},
|
|
683
629
|
/**
|
|
684
630
|
* Returns detailed order item information for the order that you specify. If NextToken is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
685
|
-
* @param {
|
|
686
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
631
|
+
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
687
632
|
* @param {*} [options] Override http request option.
|
|
688
633
|
* @throws {RequiredError}
|
|
689
634
|
*/
|
|
690
|
-
getOrderItems(
|
|
691
|
-
return localVarFp.getOrderItems(orderId, nextToken, options).then((request) => request(axios, basePath));
|
|
635
|
+
getOrderItems(requestParameters, options) {
|
|
636
|
+
return localVarFp.getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
692
637
|
},
|
|
693
638
|
/**
|
|
694
639
|
* Returns detailed order items approvals information for the order specified. If NextToken is provided, it\'s used to retrieve the next page of order items approvals. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
695
|
-
* @param {
|
|
696
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
697
|
-
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return approvals for items which approval type is contained in the specified approval types.
|
|
698
|
-
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return approvals that contain items which approval status is contained in the specified approval status.
|
|
640
|
+
* @param {OrdersV0ApiGetOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
699
641
|
* @param {*} [options] Override http request option.
|
|
700
642
|
* @throws {RequiredError}
|
|
701
643
|
*/
|
|
702
|
-
getOrderItemsApprovals(
|
|
703
|
-
return localVarFp.getOrderItemsApprovals(orderId, nextToken, itemApprovalTypes, itemApprovalStatus, options).then((request) => request(axios, basePath));
|
|
644
|
+
getOrderItemsApprovals(requestParameters, options) {
|
|
645
|
+
return localVarFp.getOrderItemsApprovals(requestParameters.orderId, requestParameters.nextToken, requestParameters.itemApprovalTypes, requestParameters.itemApprovalStatus, options).then((request) => request(axios, basePath));
|
|
704
646
|
},
|
|
705
647
|
/**
|
|
706
648
|
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
707
|
-
* @param {
|
|
708
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
649
|
+
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
709
650
|
* @param {*} [options] Override http request option.
|
|
710
651
|
* @throws {RequiredError}
|
|
711
652
|
*/
|
|
712
|
-
getOrderItemsBuyerInfo(
|
|
713
|
-
return localVarFp.getOrderItemsBuyerInfo(orderId, nextToken, options).then((request) => request(axios, basePath));
|
|
653
|
+
getOrderItemsBuyerInfo(requestParameters, options) {
|
|
654
|
+
return localVarFp.getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
714
655
|
},
|
|
715
656
|
/**
|
|
716
657
|
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
717
|
-
* @param {
|
|
658
|
+
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
718
659
|
* @param {*} [options] Override http request option.
|
|
719
660
|
* @throws {RequiredError}
|
|
720
661
|
*/
|
|
721
|
-
getOrderRegulatedInfo(
|
|
722
|
-
return localVarFp.getOrderRegulatedInfo(orderId, options).then((request) => request(axios, basePath));
|
|
662
|
+
getOrderRegulatedInfo(requestParameters, options) {
|
|
663
|
+
return localVarFp.getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
723
664
|
},
|
|
724
665
|
/**
|
|
725
666
|
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
726
|
-
* @param {
|
|
727
|
-
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
728
|
-
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
729
|
-
* @param {string} [lastUpdatedAfter] A date used for selecting 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 format.
|
|
730
|
-
* @param {string} [lastUpdatedBefore] A date used for selecting 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 format.
|
|
731
|
-
* @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.)
|
|
732
|
-
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: AFN (Fulfillment by Amazon); MFN (Fulfilled by the seller).
|
|
733
|
-
* @param {Array<string>} [paymentMethods] A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).
|
|
734
|
-
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
735
|
-
* @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.
|
|
736
|
-
* @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.
|
|
737
|
-
* @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.)
|
|
738
|
-
* @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.)
|
|
739
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
740
|
-
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
741
|
-
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
742
|
-
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
743
|
-
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
744
|
-
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return orders that contain items which approval type is contained in the specified approval types.
|
|
745
|
-
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return orders that contain items which approval status is contained in the specified approval status.
|
|
667
|
+
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
746
668
|
* @param {*} [options] Override http request option.
|
|
747
669
|
* @throws {RequiredError}
|
|
748
670
|
*/
|
|
749
|
-
getOrders(
|
|
750
|
-
return localVarFp.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, itemApprovalTypes, itemApprovalStatus, options).then((request) => request(axios, basePath));
|
|
671
|
+
getOrders(requestParameters, options) {
|
|
672
|
+
return localVarFp.getOrders(requestParameters.marketplaceIds, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.orderStatuses, requestParameters.fulfillmentChannels, requestParameters.paymentMethods, requestParameters.buyerEmail, requestParameters.sellerOrderId, requestParameters.maxResultsPerPage, requestParameters.easyShipShipmentStatuses, requestParameters.electronicInvoiceStatuses, requestParameters.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, requestParameters.itemApprovalTypes, requestParameters.itemApprovalStatus, options).then((request) => request(axios, basePath));
|
|
751
673
|
},
|
|
752
674
|
/**
|
|
753
675
|
* Update the order items approvals for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
754
|
-
* @param {
|
|
755
|
-
* @param {UpdateOrderApprovalsRequest} payload The request body for the updateOrderItemsApprovals operation.
|
|
676
|
+
* @param {OrdersV0ApiUpdateOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
756
677
|
* @param {*} [options] Override http request option.
|
|
757
678
|
* @throws {RequiredError}
|
|
758
679
|
*/
|
|
759
|
-
updateOrderItemsApprovals(
|
|
760
|
-
return localVarFp.updateOrderItemsApprovals(orderId, payload, options).then((request) => request(axios, basePath));
|
|
680
|
+
updateOrderItemsApprovals(requestParameters, options) {
|
|
681
|
+
return localVarFp.updateOrderItemsApprovals(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
|
|
761
682
|
},
|
|
762
683
|
/**
|
|
763
684
|
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
764
|
-
* @param {
|
|
765
|
-
* @param {UpdateShipmentStatusRequest} payload The request body for the updateShipmentStatus operation.
|
|
685
|
+
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
766
686
|
* @param {*} [options] Override http request option.
|
|
767
687
|
* @throws {RequiredError}
|
|
768
688
|
*/
|
|
769
|
-
updateShipmentStatus(
|
|
770
|
-
return localVarFp.updateShipmentStatus(orderId, payload, options).then((request) => request(axios, basePath));
|
|
689
|
+
updateShipmentStatus(requestParameters, options) {
|
|
690
|
+
return localVarFp.updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
|
|
771
691
|
},
|
|
772
692
|
/**
|
|
773
693
|
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
774
|
-
* @param {
|
|
775
|
-
* @param {UpdateVerificationStatusRequest} payload The request body for the updateVerificationStatus operation.
|
|
694
|
+
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
776
695
|
* @param {*} [options] Override http request option.
|
|
777
696
|
* @throws {RequiredError}
|
|
778
697
|
*/
|
|
779
|
-
updateVerificationStatus(
|
|
780
|
-
return localVarFp.updateVerificationStatus(orderId, payload, options).then((request) => request(axios, basePath));
|
|
698
|
+
updateVerificationStatus(requestParameters, options) {
|
|
699
|
+
return localVarFp.updateVerificationStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
|
|
781
700
|
},
|
|
782
701
|
};
|
|
783
702
|
};
|
|
@@ -788,16 +707,6 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
788
707
|
* @extends {BaseAPI}
|
|
789
708
|
*/
|
|
790
709
|
export class OrdersV0Api extends BaseAPI {
|
|
791
|
-
/**
|
|
792
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
793
|
-
* @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
794
|
-
* @param {*} [options] Override http request option.
|
|
795
|
-
* @throws {RequiredError}
|
|
796
|
-
* @memberof OrdersV0Api
|
|
797
|
-
*/
|
|
798
|
-
confirmShipment(requestParameters, options) {
|
|
799
|
-
return OrdersV0ApiFp(this.configuration).confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
800
|
-
}
|
|
801
710
|
/**
|
|
802
711
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
803
712
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
@@ -11,8 +11,6 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
-
// Some imports not used depending on template conditions
|
|
15
|
-
// @ts-ignore
|
|
16
14
|
import globalAxios from 'axios';
|
|
17
15
|
export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
|
|
18
16
|
/**
|
|
@@ -52,9 +50,9 @@ export class BaseAPI {
|
|
|
52
50
|
*/
|
|
53
51
|
export class RequiredError extends Error {
|
|
54
52
|
field;
|
|
55
|
-
name = "RequiredError";
|
|
56
53
|
constructor(field, msg) {
|
|
57
54
|
super(msg);
|
|
58
55
|
this.field = field;
|
|
56
|
+
this.name = "RequiredError";
|
|
59
57
|
}
|
|
60
58
|
}
|
|
@@ -73,6 +73,8 @@ export const setOAuthToObject = async function (object, name, scopes, configurat
|
|
|
73
73
|
}
|
|
74
74
|
};
|
|
75
75
|
function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
|
|
76
|
+
if (parameter == null)
|
|
77
|
+
return;
|
|
76
78
|
if (typeof parameter === "object") {
|
|
77
79
|
if (Array.isArray(parameter)) {
|
|
78
80
|
parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
|
|
@@ -6,9 +6,6 @@ export * from './buyer-info';
|
|
|
6
6
|
export * from './buyer-requested-cancel';
|
|
7
7
|
export * from './buyer-tax-info';
|
|
8
8
|
export * from './buyer-tax-information';
|
|
9
|
-
export * from './confirm-shipment-error-response';
|
|
10
|
-
export * from './confirm-shipment-order-item';
|
|
11
|
-
export * from './confirm-shipment-request';
|
|
12
9
|
export * from './easy-ship-shipment-status';
|
|
13
10
|
export * from './electronic-invoice-status';
|
|
14
11
|
export * from './fulfillment-instruction';
|
|
@@ -44,7 +41,6 @@ export * from './order-items-inner';
|
|
|
44
41
|
export * from './order-items-list';
|
|
45
42
|
export * from './order-regulated-info';
|
|
46
43
|
export * from './orders-list';
|
|
47
|
-
export * from './package-detail';
|
|
48
44
|
export * from './payment-execution-detail-item';
|
|
49
45
|
export * from './points-granted-detail';
|
|
50
46
|
export * from './product-info-detail';
|
package/dist/es/src/client.js
CHANGED
|
@@ -78,13 +78,6 @@ export const clientRateLimits = [
|
|
|
78
78
|
rate: 5,
|
|
79
79
|
burst: 15,
|
|
80
80
|
},
|
|
81
|
-
{
|
|
82
|
-
method: 'post',
|
|
83
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
84
|
-
urlRegex: new RegExp('^/orders/v0/orders/[^/]*/shipmentConfirmation$'),
|
|
85
|
-
rate: 2,
|
|
86
|
-
burst: 10,
|
|
87
|
-
},
|
|
88
81
|
];
|
|
89
82
|
export class OrdersApiClient extends OrdersV0Api {
|
|
90
83
|
constructor(configuration) {
|
|
@@ -9,10 +9,9 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import { ConfirmShipmentRequest } from '../models';
|
|
16
15
|
import { GetOrderAddressResponse } from '../models';
|
|
17
16
|
import { GetOrderApprovalsResponse } from '../models';
|
|
18
17
|
import { GetOrderBuyerInfoResponse } from '../models';
|
|
@@ -31,14 +30,6 @@ import { UpdateVerificationStatusRequest } from '../models';
|
|
|
31
30
|
* @export
|
|
32
31
|
*/
|
|
33
32
|
export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
34
|
-
/**
|
|
35
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
36
|
-
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
37
|
-
* @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
|
|
38
|
-
* @param {*} [options] Override http request option.
|
|
39
|
-
* @throws {RequiredError}
|
|
40
|
-
*/
|
|
41
|
-
confirmShipment: (orderId: string, payload: ConfirmShipmentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
33
|
/**
|
|
43
34
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
44
35
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -149,14 +140,6 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
149
140
|
* @export
|
|
150
141
|
*/
|
|
151
142
|
export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
152
|
-
/**
|
|
153
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
154
|
-
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
155
|
-
* @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
|
|
156
|
-
* @param {*} [options] Override http request option.
|
|
157
|
-
* @throws {RequiredError}
|
|
158
|
-
*/
|
|
159
|
-
confirmShipment(orderId: string, payload: ConfirmShipmentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
160
143
|
/**
|
|
161
144
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
162
145
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -267,138 +250,84 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
267
250
|
* @export
|
|
268
251
|
*/
|
|
269
252
|
export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
270
|
-
/**
|
|
271
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
272
|
-
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
273
|
-
* @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
|
|
274
|
-
* @param {*} [options] Override http request option.
|
|
275
|
-
* @throws {RequiredError}
|
|
276
|
-
*/
|
|
277
|
-
confirmShipment(orderId: string, payload: ConfirmShipmentRequest, options?: any): AxiosPromise<void>;
|
|
278
253
|
/**
|
|
279
254
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
280
|
-
* @param {
|
|
255
|
+
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
281
256
|
* @param {*} [options] Override http request option.
|
|
282
257
|
* @throws {RequiredError}
|
|
283
258
|
*/
|
|
284
|
-
getOrder(
|
|
259
|
+
getOrder(requestParameters: OrdersV0ApiGetOrderRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderResponse>;
|
|
285
260
|
/**
|
|
286
261
|
* Returns the shipping address for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
287
|
-
* @param {
|
|
262
|
+
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
288
263
|
* @param {*} [options] Override http request option.
|
|
289
264
|
* @throws {RequiredError}
|
|
290
265
|
*/
|
|
291
|
-
getOrderAddress(
|
|
266
|
+
getOrderAddress(requestParameters: OrdersV0ApiGetOrderAddressRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderAddressResponse>;
|
|
292
267
|
/**
|
|
293
268
|
* Returns buyer information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
294
|
-
* @param {
|
|
269
|
+
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
295
270
|
* @param {*} [options] Override http request option.
|
|
296
271
|
* @throws {RequiredError}
|
|
297
272
|
*/
|
|
298
|
-
getOrderBuyerInfo(
|
|
273
|
+
getOrderBuyerInfo(requestParameters: OrdersV0ApiGetOrderBuyerInfoRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderBuyerInfoResponse>;
|
|
299
274
|
/**
|
|
300
275
|
* Returns detailed order item information for the order that you specify. If NextToken is provided, it\'s used to retrieve the next page of order items. __Note__: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
301
|
-
* @param {
|
|
302
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
276
|
+
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
303
277
|
* @param {*} [options] Override http request option.
|
|
304
278
|
* @throws {RequiredError}
|
|
305
279
|
*/
|
|
306
|
-
getOrderItems(
|
|
280
|
+
getOrderItems(requestParameters: OrdersV0ApiGetOrderItemsRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderItemsResponse>;
|
|
307
281
|
/**
|
|
308
282
|
* Returns detailed order items approvals information for the order specified. If NextToken is provided, it\'s used to retrieve the next page of order items approvals. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.5 | 30 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
309
|
-
* @param {
|
|
310
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
311
|
-
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return approvals for items which approval type is contained in the specified approval types.
|
|
312
|
-
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return approvals that contain items which approval status is contained in the specified approval status.
|
|
283
|
+
* @param {OrdersV0ApiGetOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
313
284
|
* @param {*} [options] Override http request option.
|
|
314
285
|
* @throws {RequiredError}
|
|
315
286
|
*/
|
|
316
|
-
getOrderItemsApprovals(
|
|
287
|
+
getOrderItemsApprovals(requestParameters: OrdersV0ApiGetOrderItemsApprovalsRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderApprovalsResponse>;
|
|
317
288
|
/**
|
|
318
289
|
* Returns buyer information for the order items in the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
319
|
-
* @param {
|
|
320
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
290
|
+
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
321
291
|
* @param {*} [options] Override http request option.
|
|
322
292
|
* @throws {RequiredError}
|
|
323
293
|
*/
|
|
324
|
-
getOrderItemsBuyerInfo(
|
|
294
|
+
getOrderItemsBuyerInfo(requestParameters: OrdersV0ApiGetOrderItemsBuyerInfoRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
|
|
325
295
|
/**
|
|
326
296
|
* Returns regulated information for the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
327
|
-
* @param {
|
|
297
|
+
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
328
298
|
* @param {*} [options] Override http request option.
|
|
329
299
|
* @throws {RequiredError}
|
|
330
300
|
*/
|
|
331
|
-
getOrderRegulatedInfo(
|
|
301
|
+
getOrderRegulatedInfo(requestParameters: OrdersV0ApiGetOrderRegulatedInfoRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderRegulatedInfoResponse>;
|
|
332
302
|
/**
|
|
333
303
|
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
334
|
-
* @param {
|
|
335
|
-
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
336
|
-
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
337
|
-
* @param {string} [lastUpdatedAfter] A date used for selecting 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 format.
|
|
338
|
-
* @param {string} [lastUpdatedBefore] A date used for selecting 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 format.
|
|
339
|
-
* @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.)
|
|
340
|
-
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: AFN (Fulfillment by Amazon); MFN (Fulfilled by the seller).
|
|
341
|
-
* @param {Array<string>} [paymentMethods] A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).
|
|
342
|
-
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
343
|
-
* @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.
|
|
344
|
-
* @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.
|
|
345
|
-
* @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.)
|
|
346
|
-
* @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.)
|
|
347
|
-
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
348
|
-
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
349
|
-
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
350
|
-
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
351
|
-
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
352
|
-
* @param {Array<ItemApprovalType>} [itemApprovalTypes] When set, only return orders that contain items which approval type is contained in the specified approval types.
|
|
353
|
-
* @param {Array<ItemApprovalStatus>} [itemApprovalStatus] When set, only return orders that contain items which approval status is contained in the specified approval status.
|
|
304
|
+
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
354
305
|
* @param {*} [options] Override http request option.
|
|
355
306
|
* @throws {RequiredError}
|
|
356
307
|
*/
|
|
357
|
-
getOrders(
|
|
308
|
+
getOrders(requestParameters: OrdersV0ApiGetOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrdersResponse>;
|
|
358
309
|
/**
|
|
359
310
|
* Update the order items approvals for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
360
|
-
* @param {
|
|
361
|
-
* @param {UpdateOrderApprovalsRequest} payload The request body for the updateOrderItemsApprovals operation.
|
|
311
|
+
* @param {OrdersV0ApiUpdateOrderItemsApprovalsRequest} requestParameters Request parameters.
|
|
362
312
|
* @param {*} [options] Override http request option.
|
|
363
313
|
* @throws {RequiredError}
|
|
364
314
|
*/
|
|
365
|
-
updateOrderItemsApprovals(
|
|
315
|
+
updateOrderItemsApprovals(requestParameters: OrdersV0ApiUpdateOrderItemsApprovalsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
366
316
|
/**
|
|
367
317
|
* Update the shipment status for an order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 15 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
368
|
-
* @param {
|
|
369
|
-
* @param {UpdateShipmentStatusRequest} payload The request body for the updateShipmentStatus operation.
|
|
318
|
+
* @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
370
319
|
* @param {*} [options] Override http request option.
|
|
371
320
|
* @throws {RequiredError}
|
|
372
321
|
*/
|
|
373
|
-
updateShipmentStatus(
|
|
322
|
+
updateShipmentStatus(requestParameters: OrdersV0ApiUpdateShipmentStatusRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
374
323
|
/**
|
|
375
324
|
* Updates (approves or rejects) the verification status of an order containing regulated products. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
376
|
-
* @param {
|
|
377
|
-
* @param {UpdateVerificationStatusRequest} payload The request body for the updateVerificationStatus operation.
|
|
325
|
+
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
378
326
|
* @param {*} [options] Override http request option.
|
|
379
327
|
* @throws {RequiredError}
|
|
380
328
|
*/
|
|
381
|
-
updateVerificationStatus(
|
|
329
|
+
updateVerificationStatus(requestParameters: OrdersV0ApiUpdateVerificationStatusRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
382
330
|
};
|
|
383
|
-
/**
|
|
384
|
-
* Request parameters for confirmShipment operation in OrdersV0Api.
|
|
385
|
-
* @export
|
|
386
|
-
* @interface OrdersV0ApiConfirmShipmentRequest
|
|
387
|
-
*/
|
|
388
|
-
export interface OrdersV0ApiConfirmShipmentRequest {
|
|
389
|
-
/**
|
|
390
|
-
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
391
|
-
* @type {string}
|
|
392
|
-
* @memberof OrdersV0ApiConfirmShipment
|
|
393
|
-
*/
|
|
394
|
-
readonly orderId: string;
|
|
395
|
-
/**
|
|
396
|
-
* Request body of confirmShipment.
|
|
397
|
-
* @type {ConfirmShipmentRequest}
|
|
398
|
-
* @memberof OrdersV0ApiConfirmShipment
|
|
399
|
-
*/
|
|
400
|
-
readonly payload: ConfirmShipmentRequest;
|
|
401
|
-
}
|
|
402
331
|
/**
|
|
403
332
|
* Request parameters for getOrder operation in OrdersV0Api.
|
|
404
333
|
* @export
|
|
@@ -711,14 +640,6 @@ export interface OrdersV0ApiUpdateVerificationStatusRequest {
|
|
|
711
640
|
* @extends {BaseAPI}
|
|
712
641
|
*/
|
|
713
642
|
export declare class OrdersV0Api extends BaseAPI {
|
|
714
|
-
/**
|
|
715
|
-
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
716
|
-
* @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
717
|
-
* @param {*} [options] Override http request option.
|
|
718
|
-
* @throws {RequiredError}
|
|
719
|
-
* @memberof OrdersV0Api
|
|
720
|
-
*/
|
|
721
|
-
confirmShipment(requestParameters: OrdersV0ApiConfirmShipmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
722
643
|
/**
|
|
723
644
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
724
645
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|