@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
|
@@ -18,10 +18,10 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeed
|
|
|
18
18
|
// @ts-ignore
|
|
19
19
|
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../base';
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* OrdersApi - axios parameter creator
|
|
22
22
|
* @export
|
|
23
23
|
*/
|
|
24
|
-
export const
|
|
24
|
+
export const OrdersApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
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 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).
|
|
@@ -415,11 +415,11 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
|
415
415
|
};
|
|
416
416
|
};
|
|
417
417
|
/**
|
|
418
|
-
*
|
|
418
|
+
* OrdersApi - functional programming interface
|
|
419
419
|
* @export
|
|
420
420
|
*/
|
|
421
|
-
export const
|
|
422
|
-
const localVarAxiosParamCreator =
|
|
421
|
+
export const OrdersApiFp = function (configuration) {
|
|
422
|
+
const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration);
|
|
423
423
|
return {
|
|
424
424
|
/**
|
|
425
425
|
* 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).
|
|
@@ -431,7 +431,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
431
431
|
async confirmShipment(orderId, payload, options) {
|
|
432
432
|
const localVarAxiosArgs = await localVarAxiosParamCreator.confirmShipment(orderId, payload, options);
|
|
433
433
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
434
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
434
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.confirmShipment']?.[localVarOperationServerIndex]?.url;
|
|
435
435
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
436
436
|
},
|
|
437
437
|
/**
|
|
@@ -443,7 +443,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
443
443
|
async getOrder(orderId, options) {
|
|
444
444
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrder(orderId, options);
|
|
445
445
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
446
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
446
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrder']?.[localVarOperationServerIndex]?.url;
|
|
447
447
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
448
448
|
},
|
|
449
449
|
/**
|
|
@@ -455,7 +455,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
455
455
|
async getOrderAddress(orderId, options) {
|
|
456
456
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderAddress(orderId, options);
|
|
457
457
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
458
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
458
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderAddress']?.[localVarOperationServerIndex]?.url;
|
|
459
459
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
460
460
|
},
|
|
461
461
|
/**
|
|
@@ -467,7 +467,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
467
467
|
async getOrderBuyerInfo(orderId, options) {
|
|
468
468
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderBuyerInfo(orderId, options);
|
|
469
469
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
470
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
470
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderBuyerInfo']?.[localVarOperationServerIndex]?.url;
|
|
471
471
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
472
472
|
},
|
|
473
473
|
/**
|
|
@@ -480,7 +480,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
480
480
|
async getOrderItems(orderId, nextToken, options) {
|
|
481
481
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderItems(orderId, nextToken, options);
|
|
482
482
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
483
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
483
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderItems']?.[localVarOperationServerIndex]?.url;
|
|
484
484
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
485
485
|
},
|
|
486
486
|
/**
|
|
@@ -493,7 +493,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
493
493
|
async getOrderItemsBuyerInfo(orderId, nextToken, options) {
|
|
494
494
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderItemsBuyerInfo(orderId, nextToken, options);
|
|
495
495
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
496
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
496
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderItemsBuyerInfo']?.[localVarOperationServerIndex]?.url;
|
|
497
497
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
498
498
|
},
|
|
499
499
|
/**
|
|
@@ -505,7 +505,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
505
505
|
async getOrderRegulatedInfo(orderId, options) {
|
|
506
506
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderRegulatedInfo(orderId, options);
|
|
507
507
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
508
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
508
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderRegulatedInfo']?.[localVarOperationServerIndex]?.url;
|
|
509
509
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
510
510
|
},
|
|
511
511
|
/**
|
|
@@ -538,7 +538,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
538
538
|
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) {
|
|
539
539
|
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);
|
|
540
540
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
541
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
541
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrders']?.[localVarOperationServerIndex]?.url;
|
|
542
542
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
543
543
|
},
|
|
544
544
|
/**
|
|
@@ -551,7 +551,7 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
551
551
|
async updateShipmentStatus(orderId, payload, options) {
|
|
552
552
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentStatus(orderId, payload, options);
|
|
553
553
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
554
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
554
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.updateShipmentStatus']?.[localVarOperationServerIndex]?.url;
|
|
555
555
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
556
556
|
},
|
|
557
557
|
/**
|
|
@@ -564,21 +564,21 @@ export const OrdersV0ApiFp = function (configuration) {
|
|
|
564
564
|
async updateVerificationStatus(orderId, payload, options) {
|
|
565
565
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateVerificationStatus(orderId, payload, options);
|
|
566
566
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
567
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
567
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.updateVerificationStatus']?.[localVarOperationServerIndex]?.url;
|
|
568
568
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
569
569
|
},
|
|
570
570
|
};
|
|
571
571
|
};
|
|
572
572
|
/**
|
|
573
|
-
*
|
|
573
|
+
* OrdersApi - factory interface
|
|
574
574
|
* @export
|
|
575
575
|
*/
|
|
576
|
-
export const
|
|
577
|
-
const localVarFp =
|
|
576
|
+
export const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
577
|
+
const localVarFp = OrdersApiFp(configuration);
|
|
578
578
|
return {
|
|
579
579
|
/**
|
|
580
580
|
* 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).
|
|
581
|
-
* @param {
|
|
581
|
+
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
582
582
|
* @param {*} [options] Override http request option.
|
|
583
583
|
* @throws {RequiredError}
|
|
584
584
|
*/
|
|
@@ -587,7 +587,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
587
587
|
},
|
|
588
588
|
/**
|
|
589
589
|
* 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).
|
|
590
|
-
* @param {
|
|
590
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
591
591
|
* @param {*} [options] Override http request option.
|
|
592
592
|
* @throws {RequiredError}
|
|
593
593
|
*/
|
|
@@ -596,7 +596,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
596
596
|
},
|
|
597
597
|
/**
|
|
598
598
|
* 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).
|
|
599
|
-
* @param {
|
|
599
|
+
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
600
600
|
* @param {*} [options] Override http request option.
|
|
601
601
|
* @throws {RequiredError}
|
|
602
602
|
*/
|
|
@@ -605,7 +605,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
605
605
|
},
|
|
606
606
|
/**
|
|
607
607
|
* 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).
|
|
608
|
-
* @param {
|
|
608
|
+
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
609
609
|
* @param {*} [options] Override http request option.
|
|
610
610
|
* @throws {RequiredError}
|
|
611
611
|
*/
|
|
@@ -614,7 +614,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
614
614
|
},
|
|
615
615
|
/**
|
|
616
616
|
* 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).
|
|
617
|
-
* @param {
|
|
617
|
+
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
618
618
|
* @param {*} [options] Override http request option.
|
|
619
619
|
* @throws {RequiredError}
|
|
620
620
|
*/
|
|
@@ -623,7 +623,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
623
623
|
},
|
|
624
624
|
/**
|
|
625
625
|
* 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).
|
|
626
|
-
* @param {
|
|
626
|
+
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
627
627
|
* @param {*} [options] Override http request option.
|
|
628
628
|
* @throws {RequiredError}
|
|
629
629
|
*/
|
|
@@ -632,7 +632,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
632
632
|
},
|
|
633
633
|
/**
|
|
634
634
|
* 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).
|
|
635
|
-
* @param {
|
|
635
|
+
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
636
636
|
* @param {*} [options] Override http request option.
|
|
637
637
|
* @throws {RequiredError}
|
|
638
638
|
*/
|
|
@@ -641,7 +641,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
641
641
|
},
|
|
642
642
|
/**
|
|
643
643
|
* 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.
|
|
644
|
-
* @param {
|
|
644
|
+
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
645
645
|
* @param {*} [options] Override http request option.
|
|
646
646
|
* @throws {RequiredError}
|
|
647
647
|
*/
|
|
@@ -650,7 +650,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
650
650
|
},
|
|
651
651
|
/**
|
|
652
652
|
* 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).
|
|
653
|
-
* @param {
|
|
653
|
+
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
654
654
|
* @param {*} [options] Override http request option.
|
|
655
655
|
* @throws {RequiredError}
|
|
656
656
|
*/
|
|
@@ -659,7 +659,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
659
659
|
},
|
|
660
660
|
/**
|
|
661
661
|
* 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).
|
|
662
|
-
* @param {
|
|
662
|
+
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
663
663
|
* @param {*} [options] Override http request option.
|
|
664
664
|
* @throws {RequiredError}
|
|
665
665
|
*/
|
|
@@ -669,110 +669,110 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
|
669
669
|
};
|
|
670
670
|
};
|
|
671
671
|
/**
|
|
672
|
-
*
|
|
672
|
+
* OrdersApi - object-oriented interface
|
|
673
673
|
* @export
|
|
674
|
-
* @class
|
|
674
|
+
* @class OrdersApi
|
|
675
675
|
* @extends {BaseAPI}
|
|
676
676
|
*/
|
|
677
|
-
export class
|
|
677
|
+
export class OrdersApi extends BaseAPI {
|
|
678
678
|
/**
|
|
679
679
|
* 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).
|
|
680
|
-
* @param {
|
|
680
|
+
* @param {OrdersApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
681
681
|
* @param {*} [options] Override http request option.
|
|
682
682
|
* @throws {RequiredError}
|
|
683
|
-
* @memberof
|
|
683
|
+
* @memberof OrdersApi
|
|
684
684
|
*/
|
|
685
685
|
confirmShipment(requestParameters, options) {
|
|
686
|
-
return
|
|
686
|
+
return OrdersApiFp(this.configuration).confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
687
687
|
}
|
|
688
688
|
/**
|
|
689
689
|
* 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).
|
|
690
|
-
* @param {
|
|
690
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
691
691
|
* @param {*} [options] Override http request option.
|
|
692
692
|
* @throws {RequiredError}
|
|
693
|
-
* @memberof
|
|
693
|
+
* @memberof OrdersApi
|
|
694
694
|
*/
|
|
695
695
|
getOrder(requestParameters, options) {
|
|
696
|
-
return
|
|
696
|
+
return OrdersApiFp(this.configuration).getOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
697
697
|
}
|
|
698
698
|
/**
|
|
699
699
|
* 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).
|
|
700
|
-
* @param {
|
|
700
|
+
* @param {OrdersApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
701
701
|
* @param {*} [options] Override http request option.
|
|
702
702
|
* @throws {RequiredError}
|
|
703
|
-
* @memberof
|
|
703
|
+
* @memberof OrdersApi
|
|
704
704
|
*/
|
|
705
705
|
getOrderAddress(requestParameters, options) {
|
|
706
|
-
return
|
|
706
|
+
return OrdersApiFp(this.configuration).getOrderAddress(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
707
707
|
}
|
|
708
708
|
/**
|
|
709
709
|
* 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).
|
|
710
|
-
* @param {
|
|
710
|
+
* @param {OrdersApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
711
711
|
* @param {*} [options] Override http request option.
|
|
712
712
|
* @throws {RequiredError}
|
|
713
|
-
* @memberof
|
|
713
|
+
* @memberof OrdersApi
|
|
714
714
|
*/
|
|
715
715
|
getOrderBuyerInfo(requestParameters, options) {
|
|
716
|
-
return
|
|
716
|
+
return OrdersApiFp(this.configuration).getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
717
717
|
}
|
|
718
718
|
/**
|
|
719
719
|
* 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).
|
|
720
|
-
* @param {
|
|
720
|
+
* @param {OrdersApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
721
721
|
* @param {*} [options] Override http request option.
|
|
722
722
|
* @throws {RequiredError}
|
|
723
|
-
* @memberof
|
|
723
|
+
* @memberof OrdersApi
|
|
724
724
|
*/
|
|
725
725
|
getOrderItems(requestParameters, options) {
|
|
726
|
-
return
|
|
726
|
+
return OrdersApiFp(this.configuration).getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
727
727
|
}
|
|
728
728
|
/**
|
|
729
729
|
* 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).
|
|
730
|
-
* @param {
|
|
730
|
+
* @param {OrdersApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
731
731
|
* @param {*} [options] Override http request option.
|
|
732
732
|
* @throws {RequiredError}
|
|
733
|
-
* @memberof
|
|
733
|
+
* @memberof OrdersApi
|
|
734
734
|
*/
|
|
735
735
|
getOrderItemsBuyerInfo(requestParameters, options) {
|
|
736
|
-
return
|
|
736
|
+
return OrdersApiFp(this.configuration).getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
737
737
|
}
|
|
738
738
|
/**
|
|
739
739
|
* 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).
|
|
740
|
-
* @param {
|
|
740
|
+
* @param {OrdersApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
741
741
|
* @param {*} [options] Override http request option.
|
|
742
742
|
* @throws {RequiredError}
|
|
743
|
-
* @memberof
|
|
743
|
+
* @memberof OrdersApi
|
|
744
744
|
*/
|
|
745
745
|
getOrderRegulatedInfo(requestParameters, options) {
|
|
746
|
-
return
|
|
746
|
+
return OrdersApiFp(this.configuration).getOrderRegulatedInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
747
747
|
}
|
|
748
748
|
/**
|
|
749
749
|
* 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.
|
|
750
|
-
* @param {
|
|
750
|
+
* @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
|
|
751
751
|
* @param {*} [options] Override http request option.
|
|
752
752
|
* @throws {RequiredError}
|
|
753
|
-
* @memberof
|
|
753
|
+
* @memberof OrdersApi
|
|
754
754
|
*/
|
|
755
755
|
getOrders(requestParameters, options) {
|
|
756
|
-
return
|
|
756
|
+
return 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));
|
|
757
757
|
}
|
|
758
758
|
/**
|
|
759
759
|
* 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).
|
|
760
|
-
* @param {
|
|
760
|
+
* @param {OrdersApiUpdateShipmentStatusRequest} requestParameters Request parameters.
|
|
761
761
|
* @param {*} [options] Override http request option.
|
|
762
762
|
* @throws {RequiredError}
|
|
763
|
-
* @memberof
|
|
763
|
+
* @memberof OrdersApi
|
|
764
764
|
*/
|
|
765
765
|
updateShipmentStatus(requestParameters, options) {
|
|
766
|
-
return
|
|
766
|
+
return OrdersApiFp(this.configuration).updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
767
767
|
}
|
|
768
768
|
/**
|
|
769
769
|
* 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).
|
|
770
|
-
* @param {
|
|
770
|
+
* @param {OrdersApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
771
771
|
* @param {*} [options] Override http request option.
|
|
772
772
|
* @throws {RequiredError}
|
|
773
|
-
* @memberof
|
|
773
|
+
* @memberof OrdersApi
|
|
774
774
|
*/
|
|
775
775
|
updateVerificationStatus(requestParameters, options) {
|
|
776
|
-
return
|
|
776
|
+
return OrdersApiFp(this.configuration).updateVerificationStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
|
|
777
777
|
}
|
|
778
778
|
}
|
package/dist/es/api-model/api.js
CHANGED
package/dist/es/client.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { createAxiosInstance } from '@sp-api-sdk/common';
|
|
2
|
-
import { Configuration,
|
|
2
|
+
import { Configuration, OrdersApi } from './api-model';
|
|
3
3
|
export const clientRateLimits = [
|
|
4
4
|
{
|
|
5
5
|
method: 'get',
|
|
@@ -72,7 +72,7 @@ export const clientRateLimits = [
|
|
|
72
72
|
burst: 10,
|
|
73
73
|
},
|
|
74
74
|
];
|
|
75
|
-
export class OrdersApiClient extends
|
|
75
|
+
export class OrdersApiClient extends OrdersApi {
|
|
76
76
|
constructor(configuration) {
|
|
77
77
|
const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
|
|
78
78
|
super(new Configuration(), endpoint, axios);
|