@sp-api-sdk/orders-api-v0 4.1.2 → 5.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/api-model/api/{orders-v0-api.js → orders-api.js} +66 -66
- package/dist/cjs/api-model/api.js +1 -1
- package/dist/cjs/client.js +1 -1
- package/dist/es/api-model/api/{orders-v0-api.js → orders-api.js} +61 -61
- package/dist/es/api-model/api.js +1 -1
- package/dist/es/client.js +2 -2
- package/dist/types/api-model/api/{orders-v0-api.d.ts → orders-api.d.ts} +125 -125
- package/dist/types/api-model/api.d.ts +1 -1
- package/dist/types/client.d.ts +2 -2
- package/package.json +4 -4
|
@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
16
16
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
17
17
|
};
|
|
18
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.
|
|
19
|
+
exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = void 0;
|
|
20
20
|
const axios_1 = __importDefault(require("axios"));
|
|
21
21
|
// Some imports not used depending on template conditions
|
|
22
22
|
// @ts-ignore
|
|
@@ -24,10 +24,10 @@ const common_1 = require("../common");
|
|
|
24
24
|
// @ts-ignore
|
|
25
25
|
const base_1 = require("../base");
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* OrdersApi - axios parameter creator
|
|
28
28
|
* @export
|
|
29
29
|
*/
|
|
30
|
-
const
|
|
30
|
+
const OrdersApiAxiosParamCreator = function (configuration) {
|
|
31
31
|
return {
|
|
32
32
|
/**
|
|
33
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).
|
|
@@ -420,13 +420,13 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
420
420
|
},
|
|
421
421
|
};
|
|
422
422
|
};
|
|
423
|
-
exports.
|
|
423
|
+
exports.OrdersApiAxiosParamCreator = OrdersApiAxiosParamCreator;
|
|
424
424
|
/**
|
|
425
|
-
*
|
|
425
|
+
* OrdersApi - functional programming interface
|
|
426
426
|
* @export
|
|
427
427
|
*/
|
|
428
|
-
const
|
|
429
|
-
const localVarAxiosParamCreator = (0, exports.
|
|
428
|
+
const OrdersApiFp = function (configuration) {
|
|
429
|
+
const localVarAxiosParamCreator = (0, exports.OrdersApiAxiosParamCreator)(configuration);
|
|
430
430
|
return {
|
|
431
431
|
/**
|
|
432
432
|
* 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).
|
|
@@ -438,7 +438,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
438
438
|
async confirmShipment(orderId, payload, options) {
|
|
439
439
|
const localVarAxiosArgs = await localVarAxiosParamCreator.confirmShipment(orderId, payload, options);
|
|
440
440
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
441
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
441
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.confirmShipment']?.[localVarOperationServerIndex]?.url;
|
|
442
442
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
443
443
|
},
|
|
444
444
|
/**
|
|
@@ -450,7 +450,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
450
450
|
async getOrder(orderId, options) {
|
|
451
451
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrder(orderId, options);
|
|
452
452
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
453
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
453
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrder']?.[localVarOperationServerIndex]?.url;
|
|
454
454
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
455
455
|
},
|
|
456
456
|
/**
|
|
@@ -462,7 +462,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
462
462
|
async getOrderAddress(orderId, options) {
|
|
463
463
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderAddress(orderId, options);
|
|
464
464
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
465
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
465
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrderAddress']?.[localVarOperationServerIndex]?.url;
|
|
466
466
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
467
467
|
},
|
|
468
468
|
/**
|
|
@@ -474,7 +474,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
474
474
|
async getOrderBuyerInfo(orderId, options) {
|
|
475
475
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderBuyerInfo(orderId, options);
|
|
476
476
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
477
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
477
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrderBuyerInfo']?.[localVarOperationServerIndex]?.url;
|
|
478
478
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
479
479
|
},
|
|
480
480
|
/**
|
|
@@ -487,7 +487,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
487
487
|
async getOrderItems(orderId, nextToken, options) {
|
|
488
488
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderItems(orderId, nextToken, options);
|
|
489
489
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
490
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
490
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrderItems']?.[localVarOperationServerIndex]?.url;
|
|
491
491
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
492
492
|
},
|
|
493
493
|
/**
|
|
@@ -500,7 +500,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
500
500
|
async getOrderItemsBuyerInfo(orderId, nextToken, options) {
|
|
501
501
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderItemsBuyerInfo(orderId, nextToken, options);
|
|
502
502
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
503
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
503
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrderItemsBuyerInfo']?.[localVarOperationServerIndex]?.url;
|
|
504
504
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
505
505
|
},
|
|
506
506
|
/**
|
|
@@ -512,7 +512,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
512
512
|
async getOrderRegulatedInfo(orderId, options) {
|
|
513
513
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderRegulatedInfo(orderId, options);
|
|
514
514
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
515
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
515
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrderRegulatedInfo']?.[localVarOperationServerIndex]?.url;
|
|
516
516
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
517
517
|
},
|
|
518
518
|
/**
|
|
@@ -545,7 +545,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
545
545
|
async getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, earliestDeliveryDateBefore, earliestDeliveryDateAfter, latestDeliveryDateBefore, latestDeliveryDateAfter, options) {
|
|
546
546
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, electronicInvoiceStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, earliestDeliveryDateBefore, earliestDeliveryDateAfter, latestDeliveryDateBefore, latestDeliveryDateAfter, options);
|
|
547
547
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
548
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
548
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.getOrders']?.[localVarOperationServerIndex]?.url;
|
|
549
549
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
550
550
|
},
|
|
551
551
|
/**
|
|
@@ -558,7 +558,7 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
558
558
|
async updateShipmentStatus(orderId, payload, options) {
|
|
559
559
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentStatus(orderId, payload, options);
|
|
560
560
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
561
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
561
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.updateShipmentStatus']?.[localVarOperationServerIndex]?.url;
|
|
562
562
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
563
563
|
},
|
|
564
564
|
/**
|
|
@@ -571,22 +571,22 @@ const OrdersV0ApiFp = function (configuration) {
|
|
|
571
571
|
async updateVerificationStatus(orderId, payload, options) {
|
|
572
572
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateVerificationStatus(orderId, payload, options);
|
|
573
573
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
574
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
574
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['OrdersApi.updateVerificationStatus']?.[localVarOperationServerIndex]?.url;
|
|
575
575
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
576
576
|
},
|
|
577
577
|
};
|
|
578
578
|
};
|
|
579
|
-
exports.
|
|
579
|
+
exports.OrdersApiFp = OrdersApiFp;
|
|
580
580
|
/**
|
|
581
|
-
*
|
|
581
|
+
* OrdersApi - factory interface
|
|
582
582
|
* @export
|
|
583
583
|
*/
|
|
584
|
-
const
|
|
585
|
-
const localVarFp = (0, exports.
|
|
584
|
+
const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
585
|
+
const localVarFp = (0, exports.OrdersApiFp)(configuration);
|
|
586
586
|
return {
|
|
587
587
|
/**
|
|
588
588
|
* 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).
|
|
589
|
-
* @param {
|
|
589
|
+
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
590
590
|
* @param {*} [options] Override http request option.
|
|
591
591
|
* @throws {RequiredError}
|
|
592
592
|
*/
|
|
@@ -595,7 +595,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
595
595
|
},
|
|
596
596
|
/**
|
|
597
597
|
* 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).
|
|
598
|
-
* @param {
|
|
598
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
599
599
|
* @param {*} [options] Override http request option.
|
|
600
600
|
* @throws {RequiredError}
|
|
601
601
|
*/
|
|
@@ -604,7 +604,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
604
604
|
},
|
|
605
605
|
/**
|
|
606
606
|
* 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).
|
|
607
|
-
* @param {
|
|
607
|
+
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
608
608
|
* @param {*} [options] Override http request option.
|
|
609
609
|
* @throws {RequiredError}
|
|
610
610
|
*/
|
|
@@ -613,7 +613,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
613
613
|
},
|
|
614
614
|
/**
|
|
615
615
|
* 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).
|
|
616
|
-
* @param {
|
|
616
|
+
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
617
617
|
* @param {*} [options] Override http request option.
|
|
618
618
|
* @throws {RequiredError}
|
|
619
619
|
*/
|
|
@@ -622,7 +622,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
622
622
|
},
|
|
623
623
|
/**
|
|
624
624
|
* 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).
|
|
625
|
-
* @param {
|
|
625
|
+
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
626
626
|
* @param {*} [options] Override http request option.
|
|
627
627
|
* @throws {RequiredError}
|
|
628
628
|
*/
|
|
@@ -631,7 +631,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
631
631
|
},
|
|
632
632
|
/**
|
|
633
633
|
* 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).
|
|
634
|
-
* @param {
|
|
634
|
+
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
635
635
|
* @param {*} [options] Override http request option.
|
|
636
636
|
* @throws {RequiredError}
|
|
637
637
|
*/
|
|
@@ -640,7 +640,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
640
640
|
},
|
|
641
641
|
/**
|
|
642
642
|
* 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).
|
|
643
|
-
* @param {
|
|
643
|
+
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
644
644
|
* @param {*} [options] Override http request option.
|
|
645
645
|
* @throws {RequiredError}
|
|
646
646
|
*/
|
|
@@ -649,7 +649,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
649
649
|
},
|
|
650
650
|
/**
|
|
651
651
|
* 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.
|
|
652
|
-
* @param {
|
|
652
|
+
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
653
653
|
* @param {*} [options] Override http request option.
|
|
654
654
|
* @throws {RequiredError}
|
|
655
655
|
*/
|
|
@@ -658,7 +658,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
658
658
|
},
|
|
659
659
|
/**
|
|
660
660
|
* 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).
|
|
661
|
-
* @param {
|
|
661
|
+
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
662
662
|
* @param {*} [options] Override http request option.
|
|
663
663
|
* @throws {RequiredError}
|
|
664
664
|
*/
|
|
@@ -667,7 +667,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
667
667
|
},
|
|
668
668
|
/**
|
|
669
669
|
* 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).
|
|
670
|
-
* @param {
|
|
670
|
+
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
671
671
|
* @param {*} [options] Override http request option.
|
|
672
672
|
* @throws {RequiredError}
|
|
673
673
|
*/
|
|
@@ -676,113 +676,113 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
676
676
|
},
|
|
677
677
|
};
|
|
678
678
|
};
|
|
679
|
-
exports.
|
|
679
|
+
exports.OrdersApiFactory = OrdersApiFactory;
|
|
680
680
|
/**
|
|
681
|
-
*
|
|
681
|
+
* OrdersApi - object-oriented interface
|
|
682
682
|
* @export
|
|
683
|
-
* @class
|
|
683
|
+
* @class OrdersApi
|
|
684
684
|
* @extends {BaseAPI}
|
|
685
685
|
*/
|
|
686
|
-
class
|
|
686
|
+
class OrdersApi extends base_1.BaseAPI {
|
|
687
687
|
/**
|
|
688
688
|
* 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).
|
|
689
|
-
* @param {
|
|
689
|
+
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
690
690
|
* @param {*} [options] Override http request option.
|
|
691
691
|
* @throws {RequiredError}
|
|
692
|
-
* @memberof
|
|
692
|
+
* @memberof OrdersApi
|
|
693
693
|
*/
|
|
694
694
|
confirmShipment(requestParameters, options) {
|
|
695
|
-
return (0, exports.
|
|
695
|
+
return (0, exports.OrdersApiFp)(this.configuration).confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
696
696
|
}
|
|
697
697
|
/**
|
|
698
698
|
* 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).
|
|
699
|
-
* @param {
|
|
699
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
700
700
|
* @param {*} [options] Override http request option.
|
|
701
701
|
* @throws {RequiredError}
|
|
702
|
-
* @memberof
|
|
702
|
+
* @memberof OrdersApi
|
|
703
703
|
*/
|
|
704
704
|
getOrder(requestParameters, options) {
|
|
705
|
-
return (0, exports.
|
|
705
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
706
706
|
}
|
|
707
707
|
/**
|
|
708
708
|
* 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).
|
|
709
|
-
* @param {
|
|
709
|
+
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
710
710
|
* @param {*} [options] Override http request option.
|
|
711
711
|
* @throws {RequiredError}
|
|
712
|
-
* @memberof
|
|
712
|
+
* @memberof OrdersApi
|
|
713
713
|
*/
|
|
714
714
|
getOrderAddress(requestParameters, options) {
|
|
715
|
-
return (0, exports.
|
|
715
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrderAddress(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
716
716
|
}
|
|
717
717
|
/**
|
|
718
718
|
* 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).
|
|
719
|
-
* @param {
|
|
719
|
+
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
720
720
|
* @param {*} [options] Override http request option.
|
|
721
721
|
* @throws {RequiredError}
|
|
722
|
-
* @memberof
|
|
722
|
+
* @memberof OrdersApi
|
|
723
723
|
*/
|
|
724
724
|
getOrderBuyerInfo(requestParameters, options) {
|
|
725
|
-
return (0, exports.
|
|
725
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
726
726
|
}
|
|
727
727
|
/**
|
|
728
728
|
* 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).
|
|
729
|
-
* @param {
|
|
729
|
+
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
730
730
|
* @param {*} [options] Override http request option.
|
|
731
731
|
* @throws {RequiredError}
|
|
732
|
-
* @memberof
|
|
732
|
+
* @memberof OrdersApi
|
|
733
733
|
*/
|
|
734
734
|
getOrderItems(requestParameters, options) {
|
|
735
|
-
return (0, exports.
|
|
735
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
736
736
|
}
|
|
737
737
|
/**
|
|
738
738
|
* 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).
|
|
739
|
-
* @param {
|
|
739
|
+
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
740
740
|
* @param {*} [options] Override http request option.
|
|
741
741
|
* @throws {RequiredError}
|
|
742
|
-
* @memberof
|
|
742
|
+
* @memberof OrdersApi
|
|
743
743
|
*/
|
|
744
744
|
getOrderItemsBuyerInfo(requestParameters, options) {
|
|
745
|
-
return (0, exports.
|
|
745
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
746
746
|
}
|
|
747
747
|
/**
|
|
748
748
|
* 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).
|
|
749
|
-
* @param {
|
|
749
|
+
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
750
750
|
* @param {*} [options] Override http request option.
|
|
751
751
|
* @throws {RequiredError}
|
|
752
|
-
* @memberof
|
|
752
|
+
* @memberof OrdersApi
|
|
753
753
|
*/
|
|
754
754
|
getOrderRegulatedInfo(requestParameters, options) {
|
|
755
|
-
return (0, exports.
|
|
755
|
+
return (0, exports.OrdersApiFp)(this.configuration).getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
756
756
|
}
|
|
757
757
|
/**
|
|
758
758
|
* 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.
|
|
759
|
-
* @param {
|
|
759
|
+
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
760
760
|
* @param {*} [options] Override http request option.
|
|
761
761
|
* @throws {RequiredError}
|
|
762
|
-
* @memberof
|
|
762
|
+
* @memberof OrdersApi
|
|
763
763
|
*/
|
|
764
764
|
getOrders(requestParameters, options) {
|
|
765
|
-
return (0, exports.
|
|
765
|
+
return (0, exports.OrdersApiFp)(this.configuration).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.earliestDeliveryDateBefore, requestParameters.earliestDeliveryDateAfter, requestParameters.latestDeliveryDateBefore, requestParameters.latestDeliveryDateAfter, options).then((request) => request(this.axios, this.basePath));
|
|
766
766
|
}
|
|
767
767
|
/**
|
|
768
768
|
* 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).
|
|
769
|
-
* @param {
|
|
769
|
+
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
770
770
|
* @param {*} [options] Override http request option.
|
|
771
771
|
* @throws {RequiredError}
|
|
772
|
-
* @memberof
|
|
772
|
+
* @memberof OrdersApi
|
|
773
773
|
*/
|
|
774
774
|
updateShipmentStatus(requestParameters, options) {
|
|
775
|
-
return (0, exports.
|
|
775
|
+
return (0, exports.OrdersApiFp)(this.configuration).updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
776
776
|
}
|
|
777
777
|
/**
|
|
778
778
|
* 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).
|
|
779
|
-
* @param {
|
|
779
|
+
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
780
780
|
* @param {*} [options] Override http request option.
|
|
781
781
|
* @throws {RequiredError}
|
|
782
|
-
* @memberof
|
|
782
|
+
* @memberof OrdersApi
|
|
783
783
|
*/
|
|
784
784
|
updateVerificationStatus(requestParameters, options) {
|
|
785
|
-
return (0, exports.
|
|
785
|
+
return (0, exports.OrdersApiFp)(this.configuration).updateVerificationStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
786
786
|
}
|
|
787
787
|
}
|
|
788
|
-
exports.
|
|
788
|
+
exports.OrdersApi = OrdersApi;
|
|
@@ -27,4 +27,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
27
27
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
28
28
|
};
|
|
29
29
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
30
|
-
__exportStar(require("./api/orders-
|
|
30
|
+
__exportStar(require("./api/orders-api"), exports);
|
package/dist/cjs/client.js
CHANGED
|
@@ -75,7 +75,7 @@ exports.clientRateLimits = [
|
|
|
75
75
|
burst: 10,
|
|
76
76
|
},
|
|
77
77
|
];
|
|
78
|
-
class OrdersApiClient extends api_model_1.
|
|
78
|
+
class OrdersApiClient extends api_model_1.OrdersApi {
|
|
79
79
|
constructor(configuration) {
|
|
80
80
|
const { axios, endpoint } = (0, common_1.createAxiosInstance)(configuration, exports.clientRateLimits);
|
|
81
81
|
super(new api_model_1.Configuration(), endpoint, axios);
|