@sp-api-sdk/orders-api-v0 1.8.10 → 1.9.2

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.
Files changed (29) hide show
  1. package/README.md +4 -1
  2. package/dist/cjs/src/api-model/api/orders-v0-api.js +67 -3
  3. package/dist/cjs/src/api-model/models/automated-shipping-settings.js +15 -0
  4. package/dist/cjs/src/api-model/models/buyer-tax-information.js +15 -0
  5. package/dist/cjs/src/api-model/models/index.js +5 -0
  6. package/dist/cjs/src/api-model/models/order.js +10 -1
  7. package/dist/cjs/src/api-model/models/shipment-status.js +27 -0
  8. package/dist/cjs/src/api-model/models/update-shipment-status-error-response.js +15 -0
  9. package/dist/cjs/src/api-model/models/update-shipment-status-request.js +15 -0
  10. package/dist/cjs/src/client.js +12 -9
  11. package/dist/es/src/api-model/api/orders-v0-api.js +68 -4
  12. package/dist/es/src/api-model/models/automated-shipping-settings.js +14 -0
  13. package/dist/es/src/api-model/models/buyer-tax-information.js +14 -0
  14. package/dist/es/src/api-model/models/index.js +5 -0
  15. package/dist/es/src/api-model/models/order.js +9 -0
  16. package/dist/es/src/api-model/models/shipment-status.js +24 -0
  17. package/dist/es/src/api-model/models/update-shipment-status-error-response.js +14 -0
  18. package/dist/es/src/api-model/models/update-shipment-status-request.js +14 -0
  19. package/dist/es/src/client.js +12 -9
  20. package/dist/types/src/api-model/api/orders-v0-api.d.ts +56 -4
  21. package/dist/types/src/api-model/models/automated-shipping-settings.d.ts +36 -0
  22. package/dist/types/src/api-model/models/buyer-tax-information.d.ts +42 -0
  23. package/dist/types/src/api-model/models/index.d.ts +5 -0
  24. package/dist/types/src/api-model/models/order.d.ts +28 -0
  25. package/dist/types/src/api-model/models/shipment-status.d.ts +21 -0
  26. package/dist/types/src/api-model/models/update-shipment-status-error-response.d.ts +24 -0
  27. package/dist/types/src/api-model/models/update-shipment-status-request.d.ts +37 -0
  28. package/dist/types/src/client.d.ts +3 -2
  29. package/package.json +6 -5
package/README.md CHANGED
@@ -2,6 +2,9 @@
2
2
 
3
3
  The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
4
4
 
5
+ [![npm version](https://badgen.net/npm/v/@sp-api-sdk/orders-api-v0)](https://www.npmjs.com/package/@sp-api-sdk/orders-api-v0)
6
+ [![XO code style](https://badgen.net/badge/code%20style/XO/cyan)](https://github.com/xojs/xo)
7
+
5
8
  ## Documentation
6
9
 
7
10
  Learn more about this Selling Partner API by visiting the [official documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/orders-api/ordersV0.md).
@@ -59,7 +62,7 @@ const client = new OrdersApiClient({
59
62
  })
60
63
  ```
61
64
 
62
- The rate limits used for each route are specified in the [API documentation]((https://github.com/amzn/selling-partner-api-docs/tree/main/references/orders-api/ordersV0.md)).
65
+ The rate limits used for each route are specified in the [API documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/orders-api/ordersV0.md).
63
66
 
64
67
  ## License
65
68
 
@@ -177,7 +177,7 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
177
177
  },
178
178
  /**
179
179
  * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
180
- * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
180
+ * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#marketplaceid-values) for a complete list of marketplaceId values.
181
181
  * @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.
182
182
  * @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.
183
183
  * @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.
@@ -269,6 +269,39 @@ const OrdersV0ApiAxiosParamCreator = function (configuration) {
269
269
  options: localVarRequestOptions,
270
270
  };
271
271
  },
272
+ /**
273
+ * Update the shipment status.
274
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
275
+ * @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
276
+ * @param {*} [options] Override http request option.
277
+ * @throws {RequiredError}
278
+ */
279
+ updateShipmentStatus: async (orderId, payload, options = {}) => {
280
+ // verify required parameter 'orderId' is not null or undefined
281
+ (0, common_1.assertParamExists)('updateShipmentStatus', 'orderId', orderId);
282
+ // verify required parameter 'payload' is not null or undefined
283
+ (0, common_1.assertParamExists)('updateShipmentStatus', 'payload', payload);
284
+ const localVarPath = `/orders/v0/orders/{orderId}/shipment`
285
+ .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
286
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
287
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
288
+ let baseOptions;
289
+ if (configuration) {
290
+ baseOptions = configuration.baseOptions;
291
+ }
292
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
293
+ const localVarHeaderParameter = {};
294
+ const localVarQueryParameter = {};
295
+ localVarHeaderParameter['Content-Type'] = 'application/json';
296
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
297
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
298
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
299
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(payload, localVarRequestOptions, configuration);
300
+ return {
301
+ url: (0, common_1.toPathString)(localVarUrlObj),
302
+ options: localVarRequestOptions,
303
+ };
304
+ },
272
305
  };
273
306
  };
274
307
  exports.OrdersV0ApiAxiosParamCreator = OrdersV0ApiAxiosParamCreator;
@@ -333,7 +366,7 @@ const OrdersV0ApiFp = function (configuration) {
333
366
  },
334
367
  /**
335
368
  * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
336
- * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
369
+ * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#marketplaceid-values) for a complete list of marketplaceId values.
337
370
  * @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.
338
371
  * @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.
339
372
  * @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.
@@ -357,6 +390,17 @@ const OrdersV0ApiFp = function (configuration) {
357
390
  const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options);
358
391
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
359
392
  },
393
+ /**
394
+ * Update the shipment status.
395
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
396
+ * @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
397
+ * @param {*} [options] Override http request option.
398
+ * @throws {RequiredError}
399
+ */
400
+ async updateShipmentStatus(orderId, payload, options) {
401
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentStatus(orderId, payload, options);
402
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
403
+ },
360
404
  };
361
405
  };
362
406
  exports.OrdersV0ApiFp = OrdersV0ApiFp;
@@ -416,7 +460,7 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
416
460
  },
417
461
  /**
418
462
  * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
419
- * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
463
+ * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#marketplaceid-values) for a complete list of marketplaceId values.
420
464
  * @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.
421
465
  * @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.
422
466
  * @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.
@@ -439,6 +483,16 @@ const OrdersV0ApiFactory = function (configuration, basePath, axios) {
439
483
  getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options) {
440
484
  return localVarFp.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options).then((request) => request(axios, basePath));
441
485
  },
486
+ /**
487
+ * Update the shipment status.
488
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
489
+ * @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
490
+ * @param {*} [options] Override http request option.
491
+ * @throws {RequiredError}
492
+ */
493
+ updateShipmentStatus(orderId, payload, options) {
494
+ return localVarFp.updateShipmentStatus(orderId, payload, options).then((request) => request(axios, basePath));
495
+ },
442
496
  };
443
497
  };
444
498
  exports.OrdersV0ApiFactory = OrdersV0ApiFactory;
@@ -509,5 +563,15 @@ class OrdersV0Api extends base_1.BaseAPI {
509
563
  getOrders(requestParameters, options) {
510
564
  return (0, exports.OrdersV0ApiFp)(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.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, options).then((request) => request(this.axios, this.basePath));
511
565
  }
566
+ /**
567
+ * Update the shipment status.
568
+ * @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
569
+ * @param {*} [options] Override http request option.
570
+ * @throws {RequiredError}
571
+ * @memberof OrdersV0Api
572
+ */
573
+ updateShipmentStatus(requestParameters, options) {
574
+ return (0, exports.OrdersV0ApiFp)(this.configuration).updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
575
+ }
512
576
  }
513
577
  exports.OrdersV0Api = OrdersV0Api;
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Orders
6
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
7
+ *
8
+ * The version of the OpenAPI document: v0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Orders
6
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
7
+ *
8
+ * The version of the OpenAPI document: v0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -2,9 +2,11 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const tslib_1 = require("tslib");
4
4
  (0, tslib_1.__exportStar)(require("./address"), exports);
5
+ (0, tslib_1.__exportStar)(require("./automated-shipping-settings"), exports);
5
6
  (0, tslib_1.__exportStar)(require("./buyer-customized-info-detail"), exports);
6
7
  (0, tslib_1.__exportStar)(require("./buyer-info"), exports);
7
8
  (0, tslib_1.__exportStar)(require("./buyer-tax-info"), exports);
9
+ (0, tslib_1.__exportStar)(require("./buyer-tax-information"), exports);
8
10
  (0, tslib_1.__exportStar)(require("./fulfillment-instruction"), exports);
9
11
  (0, tslib_1.__exportStar)(require("./get-order-address-response"), exports);
10
12
  (0, tslib_1.__exportStar)(require("./get-order-buyer-info-response"), exports);
@@ -27,5 +29,8 @@ const tslib_1 = require("tslib");
27
29
  (0, tslib_1.__exportStar)(require("./payment-execution-detail-item"), exports);
28
30
  (0, tslib_1.__exportStar)(require("./points-granted-detail"), exports);
29
31
  (0, tslib_1.__exportStar)(require("./product-info-detail"), exports);
32
+ (0, tslib_1.__exportStar)(require("./shipment-status"), exports);
30
33
  (0, tslib_1.__exportStar)(require("./tax-classification"), exports);
31
34
  (0, tslib_1.__exportStar)(require("./tax-collection"), exports);
35
+ (0, tslib_1.__exportStar)(require("./update-shipment-status-error-response"), exports);
36
+ (0, tslib_1.__exportStar)(require("./update-shipment-status-request"), exports);
@@ -13,7 +13,7 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.OrderOrderTypeEnum = exports.OrderPaymentMethodEnum = exports.OrderFulfillmentChannelEnum = exports.OrderOrderStatusEnum = void 0;
16
+ exports.OrderBuyerInvoicePreferenceEnum = exports.OrderOrderTypeEnum = exports.OrderPaymentMethodEnum = exports.OrderFulfillmentChannelEnum = exports.OrderOrderStatusEnum = void 0;
17
17
  /**
18
18
  * @export
19
19
  * @enum {string}
@@ -60,3 +60,12 @@ var OrderOrderTypeEnum;
60
60
  OrderOrderTypeEnum["BackOrder"] = "BackOrder";
61
61
  OrderOrderTypeEnum["SourcingOnDemandOrder"] = "SourcingOnDemandOrder";
62
62
  })(OrderOrderTypeEnum = exports.OrderOrderTypeEnum || (exports.OrderOrderTypeEnum = {}));
63
+ /**
64
+ * @export
65
+ * @enum {string}
66
+ */
67
+ var OrderBuyerInvoicePreferenceEnum;
68
+ (function (OrderBuyerInvoicePreferenceEnum) {
69
+ OrderBuyerInvoicePreferenceEnum["Individual"] = "INDIVIDUAL";
70
+ OrderBuyerInvoicePreferenceEnum["Business"] = "BUSINESS";
71
+ })(OrderBuyerInvoicePreferenceEnum = exports.OrderBuyerInvoicePreferenceEnum || (exports.OrderBuyerInvoicePreferenceEnum = {}));
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Orders
6
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
7
+ *
8
+ * The version of the OpenAPI document: v0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ShipmentStatus = void 0;
17
+ /**
18
+ * the status of the shipment of the order to be updated
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+ var ShipmentStatus;
23
+ (function (ShipmentStatus) {
24
+ ShipmentStatus["ReadyForPickup"] = "ReadyForPickup";
25
+ ShipmentStatus["PickedUp"] = "PickedUp";
26
+ ShipmentStatus["RefusedPickup"] = "RefusedPickup";
27
+ })(ShipmentStatus = exports.ShipmentStatus || (exports.ShipmentStatus = {}));
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Orders
6
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
7
+ *
8
+ * The version of the OpenAPI document: v0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Orders
6
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
7
+ *
8
+ * The version of the OpenAPI document: v0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,11 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.OrdersApiClient = exports.RATE_LIMITS = void 0;
3
+ exports.OrdersApiClient = exports.clientRateLimits = void 0;
4
4
  /* eslint-disable prefer-regex-literals */
5
5
  const common_1 = require("@sp-api-sdk/common");
6
6
  const api_model_1 = require("./api-model");
7
7
  const error_1 = require("./error");
8
- exports.RATE_LIMITS = [
8
+ exports.clientRateLimits = [
9
9
  {
10
10
  method: 'get',
11
11
  urlRegex: new RegExp('^/orders/v0/orders$'),
@@ -45,20 +45,23 @@ exports.RATE_LIMITS = [
45
45
  ];
46
46
  class OrdersApiClient extends api_model_1.OrdersV0Api {
47
47
  constructor(parameters) {
48
- const region = common_1.awsRegionByCode[parameters.region] ?? parameters.region;
48
+ const config = common_1.sellingPartnerRegions[parameters.region];
49
+ if (!config) {
50
+ throw new error_1.OrdersApiError(`Unknown region: ${parameters.region}`);
51
+ }
49
52
  const { rateLimiting, ...clientParameters } = parameters;
50
- const axiosParameters = { ...clientParameters, region };
53
+ const axiosParameters = {
54
+ ...clientParameters,
55
+ region: config.awsRegion,
56
+ };
51
57
  if (rateLimiting?.retry) {
52
- axiosParameters.rateLimits = exports.RATE_LIMITS;
58
+ axiosParameters.rateLimits = exports.clientRateLimits;
53
59
  axiosParameters.onRetry = rateLimiting.onRetry;
54
60
  }
55
61
  const axiosInstance = (0, common_1.createAxiosInstance)(axiosParameters);
56
62
  const configuration = new api_model_1.Configuration();
57
63
  const environment = parameters.sandbox ? 'sandbox' : 'production';
58
- const endpoint = common_1.endpoints[environment][region];
59
- if (!endpoint) {
60
- throw new error_1.OrdersApiError(`Unknown region : ${region}`);
61
- }
64
+ const endpoint = config.endpoints[environment];
62
65
  super(configuration, endpoint, axiosInstance);
63
66
  }
64
67
  }
@@ -14,7 +14,7 @@
14
14
  import globalAxios from 'axios';
15
15
  // Some imports not used depending on template conditions
16
16
  // @ts-ignore
17
- import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, createRequestFunction } from '../common';
17
+ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
18
18
  // @ts-ignore
19
19
  import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
20
20
  /**
@@ -173,7 +173,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
173
173
  },
174
174
  /**
175
175
  * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
176
- * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
176
+ * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#marketplaceid-values) for a complete list of marketplaceId values.
177
177
  * @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.
178
178
  * @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.
179
179
  * @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.
@@ -265,6 +265,39 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
265
265
  options: localVarRequestOptions,
266
266
  };
267
267
  },
268
+ /**
269
+ * Update the shipment status.
270
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
271
+ * @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
272
+ * @param {*} [options] Override http request option.
273
+ * @throws {RequiredError}
274
+ */
275
+ updateShipmentStatus: async (orderId, payload, options = {}) => {
276
+ // verify required parameter 'orderId' is not null or undefined
277
+ assertParamExists('updateShipmentStatus', 'orderId', orderId);
278
+ // verify required parameter 'payload' is not null or undefined
279
+ assertParamExists('updateShipmentStatus', 'payload', payload);
280
+ const localVarPath = `/orders/v0/orders/{orderId}/shipment`
281
+ .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
282
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
283
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
284
+ let baseOptions;
285
+ if (configuration) {
286
+ baseOptions = configuration.baseOptions;
287
+ }
288
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
289
+ const localVarHeaderParameter = {};
290
+ const localVarQueryParameter = {};
291
+ localVarHeaderParameter['Content-Type'] = 'application/json';
292
+ setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
293
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
294
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
295
+ localVarRequestOptions.data = serializeDataIfNeeded(payload, localVarRequestOptions, configuration);
296
+ return {
297
+ url: toPathString(localVarUrlObj),
298
+ options: localVarRequestOptions,
299
+ };
300
+ },
268
301
  };
269
302
  };
270
303
  /**
@@ -328,7 +361,7 @@ export const OrdersV0ApiFp = function (configuration) {
328
361
  },
329
362
  /**
330
363
  * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
331
- * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
364
+ * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#marketplaceid-values) for a complete list of marketplaceId values.
332
365
  * @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.
333
366
  * @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.
334
367
  * @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.
@@ -352,6 +385,17 @@ export const OrdersV0ApiFp = function (configuration) {
352
385
  const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options);
353
386
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
354
387
  },
388
+ /**
389
+ * Update the shipment status.
390
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
391
+ * @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
392
+ * @param {*} [options] Override http request option.
393
+ * @throws {RequiredError}
394
+ */
395
+ async updateShipmentStatus(orderId, payload, options) {
396
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentStatus(orderId, payload, options);
397
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
398
+ },
355
399
  };
356
400
  };
357
401
  /**
@@ -410,7 +454,7 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
410
454
  },
411
455
  /**
412
456
  * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
413
- * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
457
+ * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#marketplaceid-values) for a complete list of marketplaceId values.
414
458
  * @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.
415
459
  * @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.
416
460
  * @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.
@@ -433,6 +477,16 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
433
477
  getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options) {
434
478
  return localVarFp.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options).then((request) => request(axios, basePath));
435
479
  },
480
+ /**
481
+ * Update the shipment status.
482
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
483
+ * @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
484
+ * @param {*} [options] Override http request option.
485
+ * @throws {RequiredError}
486
+ */
487
+ updateShipmentStatus(orderId, payload, options) {
488
+ return localVarFp.updateShipmentStatus(orderId, payload, options).then((request) => request(axios, basePath));
489
+ },
436
490
  };
437
491
  };
438
492
  /**
@@ -502,4 +556,14 @@ export class OrdersV0Api extends BaseAPI {
502
556
  getOrders(requestParameters, options) {
503
557
  return OrdersV0ApiFp(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.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, options).then((request) => request(this.axios, this.basePath));
504
558
  }
559
+ /**
560
+ * Update the shipment status.
561
+ * @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
562
+ * @param {*} [options] Override http request option.
563
+ * @throws {RequiredError}
564
+ * @memberof OrdersV0Api
565
+ */
566
+ updateShipmentStatus(requestParameters, options) {
567
+ return OrdersV0ApiFp(this.configuration).updateShipmentStatus(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
568
+ }
505
569
  }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -1,7 +1,9 @@
1
1
  export * from './address';
2
+ export * from './automated-shipping-settings';
2
3
  export * from './buyer-customized-info-detail';
3
4
  export * from './buyer-info';
4
5
  export * from './buyer-tax-info';
6
+ export * from './buyer-tax-information';
5
7
  export * from './fulfillment-instruction';
6
8
  export * from './get-order-address-response';
7
9
  export * from './get-order-buyer-info-response';
@@ -24,5 +26,8 @@ export * from './orders-list';
24
26
  export * from './payment-execution-detail-item';
25
27
  export * from './points-granted-detail';
26
28
  export * from './product-info-detail';
29
+ export * from './shipment-status';
27
30
  export * from './tax-classification';
28
31
  export * from './tax-collection';
32
+ export * from './update-shipment-status-error-response';
33
+ export * from './update-shipment-status-request';
@@ -57,3 +57,12 @@ export var OrderOrderTypeEnum;
57
57
  OrderOrderTypeEnum["BackOrder"] = "BackOrder";
58
58
  OrderOrderTypeEnum["SourcingOnDemandOrder"] = "SourcingOnDemandOrder";
59
59
  })(OrderOrderTypeEnum || (OrderOrderTypeEnum = {}));
60
+ /**
61
+ * @export
62
+ * @enum {string}
63
+ */
64
+ export var OrderBuyerInvoicePreferenceEnum;
65
+ (function (OrderBuyerInvoicePreferenceEnum) {
66
+ OrderBuyerInvoicePreferenceEnum["Individual"] = "INDIVIDUAL";
67
+ OrderBuyerInvoicePreferenceEnum["Business"] = "BUSINESS";
68
+ })(OrderBuyerInvoicePreferenceEnum || (OrderBuyerInvoicePreferenceEnum = {}));
@@ -0,0 +1,24 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * the status of the shipment of the order to be updated
16
+ * @export
17
+ * @enum {string}
18
+ */
19
+ export var ShipmentStatus;
20
+ (function (ShipmentStatus) {
21
+ ShipmentStatus["ReadyForPickup"] = "ReadyForPickup";
22
+ ShipmentStatus["PickedUp"] = "PickedUp";
23
+ ShipmentStatus["RefusedPickup"] = "RefusedPickup";
24
+ })(ShipmentStatus || (ShipmentStatus = {}));
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Orders
5
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
6
+ *
7
+ * The version of the OpenAPI document: v0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -1,8 +1,8 @@
1
1
  /* eslint-disable prefer-regex-literals */
2
- import { endpoints, awsRegionByCode, createAxiosInstance } from '@sp-api-sdk/common';
2
+ import { sellingPartnerRegions, createAxiosInstance } from '@sp-api-sdk/common';
3
3
  import { Configuration, OrdersV0Api } from './api-model';
4
4
  import { OrdersApiError } from './error';
5
- export const RATE_LIMITS = [
5
+ export const clientRateLimits = [
6
6
  {
7
7
  method: 'get',
8
8
  urlRegex: new RegExp('^/orders/v0/orders$'),
@@ -42,20 +42,23 @@ export const RATE_LIMITS = [
42
42
  ];
43
43
  export class OrdersApiClient extends OrdersV0Api {
44
44
  constructor(parameters) {
45
- const region = awsRegionByCode[parameters.region] ?? parameters.region;
45
+ const config = sellingPartnerRegions[parameters.region];
46
+ if (!config) {
47
+ throw new OrdersApiError(`Unknown region: ${parameters.region}`);
48
+ }
46
49
  const { rateLimiting, ...clientParameters } = parameters;
47
- const axiosParameters = { ...clientParameters, region };
50
+ const axiosParameters = {
51
+ ...clientParameters,
52
+ region: config.awsRegion,
53
+ };
48
54
  if (rateLimiting?.retry) {
49
- axiosParameters.rateLimits = RATE_LIMITS;
55
+ axiosParameters.rateLimits = clientRateLimits;
50
56
  axiosParameters.onRetry = rateLimiting.onRetry;
51
57
  }
52
58
  const axiosInstance = createAxiosInstance(axiosParameters);
53
59
  const configuration = new Configuration();
54
60
  const environment = parameters.sandbox ? 'sandbox' : 'production';
55
- const endpoint = endpoints[environment][region];
56
- if (!endpoint) {
57
- throw new OrdersApiError(`Unknown region : ${region}`);
58
- }
61
+ const endpoint = config.endpoints[environment];
59
62
  super(configuration, endpoint, axiosInstance);
60
63
  }
61
64
  }
@@ -18,6 +18,7 @@ import { GetOrderItemsBuyerInfoResponse } from '../models';
18
18
  import { GetOrderItemsResponse } from '../models';
19
19
  import { GetOrderResponse } from '../models';
20
20
  import { GetOrdersResponse } from '../models';
21
+ import { UpdateShipmentStatusRequest } from '../models';
21
22
  /**
22
23
  * OrdersV0Api - axios parameter creator
23
24
  * @export
@@ -62,7 +63,7 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
62
63
  getOrderItemsBuyerInfo: (orderId: string, nextToken?: string | undefined, options?: any) => Promise<RequestArgs>;
63
64
  /**
64
65
  * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
65
- * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
66
+ * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#marketplaceid-values) for a complete list of marketplaceId values.
66
67
  * @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.
67
68
  * @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.
68
69
  * @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.
@@ -83,6 +84,14 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
83
84
  * @throws {RequiredError}
84
85
  */
85
86
  getOrders: (marketplaceIds: Array<string>, createdAfter?: string | undefined, createdBefore?: string | undefined, lastUpdatedAfter?: string | undefined, lastUpdatedBefore?: string | undefined, orderStatuses?: string[] | undefined, fulfillmentChannels?: string[] | undefined, paymentMethods?: string[] | undefined, buyerEmail?: string | undefined, sellerOrderId?: string | undefined, maxResultsPerPage?: number | undefined, easyShipShipmentStatuses?: string[] | undefined, nextToken?: string | undefined, amazonOrderIds?: string[] | undefined, actualFulfillmentSupplySourceId?: string | undefined, isISPU?: boolean | undefined, storeChainStoreId?: string | undefined, options?: any) => Promise<RequestArgs>;
87
+ /**
88
+ * Update the shipment status.
89
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
90
+ * @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
91
+ * @param {*} [options] Override http request option.
92
+ * @throws {RequiredError}
93
+ */
94
+ updateShipmentStatus: (orderId: string, payload: UpdateShipmentStatusRequest, options?: any) => Promise<RequestArgs>;
86
95
  };
87
96
  /**
88
97
  * OrdersV0Api - functional programming interface
@@ -128,7 +137,7 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration | undefined)
128
137
  getOrderItemsBuyerInfo(orderId: string, nextToken?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderItemsBuyerInfoResponse>>;
129
138
  /**
130
139
  * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
131
- * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
140
+ * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#marketplaceid-values) for a complete list of marketplaceId values.
132
141
  * @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.
133
142
  * @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.
134
143
  * @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.
@@ -149,6 +158,14 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration | undefined)
149
158
  * @throws {RequiredError}
150
159
  */
151
160
  getOrders(marketplaceIds: Array<string>, createdAfter?: string | undefined, createdBefore?: string | undefined, lastUpdatedAfter?: string | undefined, lastUpdatedBefore?: string | undefined, orderStatuses?: string[] | undefined, fulfillmentChannels?: string[] | undefined, paymentMethods?: string[] | undefined, buyerEmail?: string | undefined, sellerOrderId?: string | undefined, maxResultsPerPage?: number | undefined, easyShipShipmentStatuses?: string[] | undefined, nextToken?: string | undefined, amazonOrderIds?: string[] | undefined, actualFulfillmentSupplySourceId?: string | undefined, isISPU?: boolean | undefined, storeChainStoreId?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrdersResponse>>;
161
+ /**
162
+ * Update the shipment status.
163
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
164
+ * @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
165
+ * @param {*} [options] Override http request option.
166
+ * @throws {RequiredError}
167
+ */
168
+ updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
152
169
  };
153
170
  /**
154
171
  * OrdersV0Api - factory interface
@@ -194,7 +211,7 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration | undefi
194
211
  getOrderItemsBuyerInfo(orderId: string, nextToken?: string | undefined, options?: any): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
195
212
  /**
196
213
  * Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
197
- * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
214
+ * @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#marketplaceid-values) for a complete list of marketplaceId values.
198
215
  * @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.
199
216
  * @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.
200
217
  * @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.
@@ -215,6 +232,14 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration | undefi
215
232
  * @throws {RequiredError}
216
233
  */
217
234
  getOrders(marketplaceIds: Array<string>, createdAfter?: string | undefined, createdBefore?: string | undefined, lastUpdatedAfter?: string | undefined, lastUpdatedBefore?: string | undefined, orderStatuses?: string[] | undefined, fulfillmentChannels?: string[] | undefined, paymentMethods?: string[] | undefined, buyerEmail?: string | undefined, sellerOrderId?: string | undefined, maxResultsPerPage?: number | undefined, easyShipShipmentStatuses?: string[] | undefined, nextToken?: string | undefined, amazonOrderIds?: string[] | undefined, actualFulfillmentSupplySourceId?: string | undefined, isISPU?: boolean | undefined, storeChainStoreId?: string | undefined, options?: any): AxiosPromise<GetOrdersResponse>;
235
+ /**
236
+ * Update the shipment status.
237
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
238
+ * @param {UpdateShipmentStatusRequest} payload Request to update the shipment status.
239
+ * @param {*} [options] Override http request option.
240
+ * @throws {RequiredError}
241
+ */
242
+ updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: any): AxiosPromise<void>;
218
243
  };
219
244
  /**
220
245
  * Request parameters for getOrder operation in OrdersV0Api.
@@ -300,7 +325,7 @@ export interface OrdersV0ApiGetOrderItemsBuyerInfoRequest {
300
325
  */
301
326
  export interface OrdersV0ApiGetOrdersRequest {
302
327
  /**
303
- * A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
328
+ * A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/developer-guide/SellingPartnerApiDeveloperGuide.md#marketplaceid-values) for a complete list of marketplaceId values.
304
329
  * @type {Array<string>}
305
330
  * @memberof OrdersV0ApiGetOrders
306
331
  */
@@ -402,6 +427,25 @@ export interface OrdersV0ApiGetOrdersRequest {
402
427
  */
403
428
  readonly storeChainStoreId?: string;
404
429
  }
430
+ /**
431
+ * Request parameters for updateShipmentStatus operation in OrdersV0Api.
432
+ * @export
433
+ * @interface OrdersV0ApiUpdateShipmentStatusRequest
434
+ */
435
+ export interface OrdersV0ApiUpdateShipmentStatusRequest {
436
+ /**
437
+ * An Amazon-defined order identifier, in 3-7-7 format.
438
+ * @type {string}
439
+ * @memberof OrdersV0ApiUpdateShipmentStatus
440
+ */
441
+ readonly orderId: string;
442
+ /**
443
+ * Request to update the shipment status.
444
+ * @type {UpdateShipmentStatusRequest}
445
+ * @memberof OrdersV0ApiUpdateShipmentStatus
446
+ */
447
+ readonly payload: UpdateShipmentStatusRequest;
448
+ }
405
449
  /**
406
450
  * OrdersV0Api - object-oriented interface
407
451
  * @export
@@ -457,4 +501,12 @@ export declare class OrdersV0Api extends BaseAPI {
457
501
  * @memberof OrdersV0Api
458
502
  */
459
503
  getOrders(requestParameters: OrdersV0ApiGetOrdersRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrdersResponse, any>>;
504
+ /**
505
+ * Update the shipment status.
506
+ * @param {OrdersV0ApiUpdateShipmentStatusRequest} requestParameters Request parameters.
507
+ * @param {*} [options] Override http request option.
508
+ * @throws {RequiredError}
509
+ * @memberof OrdersV0Api
510
+ */
511
+ updateShipmentStatus(requestParameters: OrdersV0ApiUpdateShipmentStatusRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
460
512
  }
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Selling Partner API for Orders
3
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Contains information regarding the Shipping Settings Automation program, such as whether the order\'s shipping settings were generated automatically, and what those settings are.
14
+ * @export
15
+ * @interface AutomatedShippingSettings
16
+ */
17
+ export interface AutomatedShippingSettings {
18
+ /**
19
+ * If true, this order has automated shipping settings generated by Amazon. This order could be identified as an SSA order.
20
+ * @type {boolean}
21
+ * @memberof AutomatedShippingSettings
22
+ */
23
+ HasAutomatedShippingSettings?: boolean;
24
+ /**
25
+ * Auto-generated carrier for SSA orders.
26
+ * @type {string}
27
+ * @memberof AutomatedShippingSettings
28
+ */
29
+ AutomatedCarrier?: string;
30
+ /**
31
+ * Auto-generated ship method for SSA orders.
32
+ * @type {string}
33
+ * @memberof AutomatedShippingSettings
34
+ */
35
+ AutomatedShipMethod?: string;
36
+ }
@@ -0,0 +1,42 @@
1
+ /**
2
+ * Selling Partner API for Orders
3
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * Contains the business invoice tax information.
14
+ * @export
15
+ * @interface BuyerTaxInformation
16
+ */
17
+ export interface BuyerTaxInformation {
18
+ /**
19
+ * Business buyer\'s company legal name.
20
+ * @type {string}
21
+ * @memberof BuyerTaxInformation
22
+ */
23
+ BuyerLegalCompanyName?: string;
24
+ /**
25
+ * Business buyer\'s address.
26
+ * @type {string}
27
+ * @memberof BuyerTaxInformation
28
+ */
29
+ BuyerBusinessAddress?: string;
30
+ /**
31
+ * Business buyer\'s tax registration ID.
32
+ * @type {string}
33
+ * @memberof BuyerTaxInformation
34
+ */
35
+ BuyerTaxRegistrationId?: string;
36
+ /**
37
+ * Business buyer\'s tax office.
38
+ * @type {string}
39
+ * @memberof BuyerTaxInformation
40
+ */
41
+ BuyerTaxOffice?: string;
42
+ }
@@ -1,7 +1,9 @@
1
1
  export * from './address';
2
+ export * from './automated-shipping-settings';
2
3
  export * from './buyer-customized-info-detail';
3
4
  export * from './buyer-info';
4
5
  export * from './buyer-tax-info';
6
+ export * from './buyer-tax-information';
5
7
  export * from './fulfillment-instruction';
6
8
  export * from './get-order-address-response';
7
9
  export * from './get-order-buyer-info-response';
@@ -24,5 +26,8 @@ export * from './orders-list';
24
26
  export * from './payment-execution-detail-item';
25
27
  export * from './points-granted-detail';
26
28
  export * from './product-info-detail';
29
+ export * from './shipment-status';
27
30
  export * from './tax-classification';
28
31
  export * from './tax-collection';
32
+ export * from './update-shipment-status-error-response';
33
+ export * from './update-shipment-status-request';
@@ -10,7 +10,9 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import { Address } from './address';
13
+ import { AutomatedShippingSettings } from './automated-shipping-settings';
13
14
  import { BuyerInfo } from './buyer-info';
15
+ import { BuyerTaxInformation } from './buyer-tax-information';
14
16
  import { FulfillmentInstruction } from './fulfillment-instruction';
15
17
  import { MarketplaceTaxInfo } from './marketplace-tax-info';
16
18
  import { Money } from './money';
@@ -225,6 +227,18 @@ export interface Order {
225
227
  * @memberof Order
226
228
  */
227
229
  DefaultShipFromLocationAddress?: Address;
230
+ /**
231
+ * The buyer’s invoicing preference.
232
+ * @type {string}
233
+ * @memberof Order
234
+ */
235
+ BuyerInvoicePreference?: OrderBuyerInvoicePreferenceEnum;
236
+ /**
237
+ *
238
+ * @type {BuyerTaxInformation}
239
+ * @memberof Order
240
+ */
241
+ BuyerTaxInformation?: BuyerTaxInformation;
228
242
  /**
229
243
  *
230
244
  * @type {FulfillmentInstruction}
@@ -261,6 +275,12 @@ export interface Order {
261
275
  * @memberof Order
262
276
  */
263
277
  BuyerInfo?: BuyerInfo;
278
+ /**
279
+ *
280
+ * @type {AutomatedShippingSettings}
281
+ * @memberof Order
282
+ */
283
+ AutomatedShippingSettings?: AutomatedShippingSettings;
264
284
  }
265
285
  /**
266
286
  * @export
@@ -304,3 +324,11 @@ export declare enum OrderOrderTypeEnum {
304
324
  BackOrder = "BackOrder",
305
325
  SourcingOnDemandOrder = "SourcingOnDemandOrder"
306
326
  }
327
+ /**
328
+ * @export
329
+ * @enum {string}
330
+ */
331
+ export declare enum OrderBuyerInvoicePreferenceEnum {
332
+ Individual = "INDIVIDUAL",
333
+ Business = "BUSINESS"
334
+ }
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Selling Partner API for Orders
3
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * the status of the shipment of the order to be updated
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare enum ShipmentStatus {
18
+ ReadyForPickup = "ReadyForPickup",
19
+ PickedUp = "PickedUp",
20
+ RefusedPickup = "RefusedPickup"
21
+ }
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Selling Partner API for Orders
3
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * The error response schema for the UpdateShipmentStatus operation.
14
+ * @export
15
+ * @interface UpdateShipmentStatusErrorResponse
16
+ */
17
+ export interface UpdateShipmentStatusErrorResponse {
18
+ /**
19
+ * A list of error responses returned when a request is unsuccessful.
20
+ * @type {Array<Error>}
21
+ * @memberof UpdateShipmentStatusErrorResponse
22
+ */
23
+ errors?: Array<Error>;
24
+ }
@@ -0,0 +1,37 @@
1
+ /**
2
+ * Selling Partner API for Orders
3
+ * The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
4
+ *
5
+ * The version of the OpenAPI document: v0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ShipmentStatus } from './shipment-status';
13
+ /**
14
+ * Request to update the status of shipment of an order.
15
+ * @export
16
+ * @interface UpdateShipmentStatusRequest
17
+ */
18
+ export interface UpdateShipmentStatusRequest {
19
+ /**
20
+ * the unobfuscated marketplace ID
21
+ * @type {string}
22
+ * @memberof UpdateShipmentStatusRequest
23
+ */
24
+ marketplaceId: string;
25
+ /**
26
+ *
27
+ * @type {ShipmentStatus}
28
+ * @memberof UpdateShipmentStatusRequest
29
+ */
30
+ shipmentStatus: ShipmentStatus;
31
+ /**
32
+ * the list of order items and quantities when the seller wants to partially update the shipment status of the order
33
+ * @type {Array<object>}
34
+ * @memberof UpdateShipmentStatusRequest
35
+ */
36
+ orderItems?: Array<object>;
37
+ }
@@ -1,7 +1,8 @@
1
- import type { ClientConfiguration, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
1
+ import type { ClientConfiguration, SellingPartnerRegion, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
2
2
  import { OrdersV0Api } from './api-model';
3
- export declare const RATE_LIMITS: RateLimit[];
3
+ export declare const clientRateLimits: RateLimit[];
4
4
  export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
5
+ region: SellingPartnerRegion;
5
6
  rateLimiting?: {
6
7
  retry: boolean;
7
8
  onRetry?: OnRetryHandler;
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/orders-api-v0",
3
3
  "author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.",
5
- "version": "1.8.10",
5
+ "version": "1.9.2",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,6 +18,7 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "scripts": {
21
+ "check:ts": "yarn tsc --noEmit",
21
22
  "build:cjs": "tsc -p tsconfig.json",
22
23
  "build:es": "tsc -p tsconfig.es.json",
23
24
  "build": "yarn build:cjs && yarn build:es",
@@ -25,9 +26,9 @@
25
26
  "test": "NODE_ENV='test' yarn jest"
26
27
  },
27
28
  "dependencies": {
28
- "@sp-api-sdk/auth": "^1.9.5",
29
- "@sp-api-sdk/common": "^1.7.7",
30
- "axios": "^0.24.0"
29
+ "@sp-api-sdk/auth": "^1.9.8",
30
+ "@sp-api-sdk/common": "^1.7.10",
31
+ "axios": "^0.26.0"
31
32
  },
32
33
  "repository": {
33
34
  "type": "git",
@@ -48,5 +49,5 @@
48
49
  "sp sdk",
49
50
  "orders api"
50
51
  ],
51
- "gitHead": "e8c21d7d481263e8a6663ee11f6708d4dc6968b6"
52
+ "gitHead": "3f4ecdeef2ce06ff28612448d263cc8d08eb69f6"
52
53
  }