@sp-api-sdk/orders-api-v0 2.0.0 → 2.1.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.
Files changed (44) hide show
  1. package/README.md +1 -0
  2. package/dist/cjs/src/api-model/api/orders-v0-api.js +63 -0
  3. package/dist/cjs/src/api-model/models/business-hours.js +25 -0
  4. package/dist/cjs/src/api-model/models/confirm-shipment-error-response.js +15 -0
  5. package/dist/cjs/src/api-model/models/confirm-shipment-order-item.js +15 -0
  6. package/dist/cjs/src/api-model/models/confirm-shipment-request.js +19 -0
  7. package/dist/cjs/src/api-model/models/delivery-preferences.js +15 -0
  8. package/dist/cjs/src/api-model/models/exception-dates.js +15 -0
  9. package/dist/cjs/src/api-model/models/index.js +11 -0
  10. package/dist/cjs/src/api-model/models/open-interval.js +15 -0
  11. package/dist/cjs/src/api-model/models/open-time-interval.js +15 -0
  12. package/dist/cjs/src/api-model/models/other-delivery-attributes.js +26 -0
  13. package/dist/cjs/src/api-model/models/package-detail.js +15 -0
  14. package/dist/cjs/src/api-model/models/preferred-delivery-time.js +15 -0
  15. package/dist/cjs/src/client.js +7 -0
  16. package/dist/es/src/api-model/api/orders-v0-api.js +63 -0
  17. package/dist/es/src/api-model/models/business-hours.js +22 -0
  18. package/dist/es/src/api-model/models/confirm-shipment-error-response.js +14 -0
  19. package/dist/es/src/api-model/models/confirm-shipment-order-item.js +14 -0
  20. package/dist/es/src/api-model/models/confirm-shipment-request.js +16 -0
  21. package/dist/es/src/api-model/models/delivery-preferences.js +14 -0
  22. package/dist/es/src/api-model/models/exception-dates.js +14 -0
  23. package/dist/es/src/api-model/models/index.js +11 -0
  24. package/dist/es/src/api-model/models/open-interval.js +14 -0
  25. package/dist/es/src/api-model/models/open-time-interval.js +14 -0
  26. package/dist/es/src/api-model/models/other-delivery-attributes.js +23 -0
  27. package/dist/es/src/api-model/models/package-detail.js +14 -0
  28. package/dist/es/src/api-model/models/preferred-delivery-time.js +14 -0
  29. package/dist/es/src/client.js +7 -0
  30. package/dist/types/src/api-model/api/orders-v0-api.d.ts +51 -0
  31. package/dist/types/src/api-model/models/business-hours.d.ts +41 -0
  32. package/dist/types/src/api-model/models/confirm-shipment-error-response.d.ts +24 -0
  33. package/dist/types/src/api-model/models/confirm-shipment-order-item.d.ts +36 -0
  34. package/dist/types/src/api-model/models/confirm-shipment-request.d.ts +41 -0
  35. package/dist/types/src/api-model/models/delivery-preferences.d.ts +44 -0
  36. package/dist/types/src/api-model/models/exception-dates.d.ts +37 -0
  37. package/dist/types/src/api-model/models/index.d.ts +11 -0
  38. package/dist/types/src/api-model/models/open-interval.d.ts +31 -0
  39. package/dist/types/src/api-model/models/open-time-interval.d.ts +30 -0
  40. package/dist/types/src/api-model/models/order-address.d.ts +13 -0
  41. package/dist/types/src/api-model/models/other-delivery-attributes.d.ts +22 -0
  42. package/dist/types/src/api-model/models/package-detail.d.ts +67 -0
  43. package/dist/types/src/api-model/models/preferred-delivery-time.d.ts +32 -0
  44. package/package.json +3 -3
package/README.md CHANGED
@@ -33,6 +33,7 @@ const auth = new SellingPartnerApiAuth({
33
33
  refreshToken: 'Atzr|…',
34
34
  accessKeyId: '',
35
35
  secretAccessKey: '',
36
+ region: 'eu-west-1',
36
37
  role: {
37
38
  arn: 'arn:aws:iam::…',
38
39
  },
@@ -27,6 +27,39 @@ const base_1 = require("../base");
27
27
  */
28
28
  const OrdersV0ApiAxiosParamCreator = function (configuration) {
29
29
  return {
30
+ /**
31
+ * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
32
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
33
+ * @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
34
+ * @param {*} [options] Override http request option.
35
+ * @throws {RequiredError}
36
+ */
37
+ confirmShipment: async (orderId, payload, options = {}) => {
38
+ // verify required parameter 'orderId' is not null or undefined
39
+ (0, common_1.assertParamExists)('confirmShipment', 'orderId', orderId);
40
+ // verify required parameter 'payload' is not null or undefined
41
+ (0, common_1.assertParamExists)('confirmShipment', 'payload', payload);
42
+ const localVarPath = `/orders/v0/orders/{orderId}/shipmentConfirmation`
43
+ .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
44
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
45
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
46
+ let baseOptions;
47
+ if (configuration) {
48
+ baseOptions = configuration.baseOptions;
49
+ }
50
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
51
+ const localVarHeaderParameter = {};
52
+ const localVarQueryParameter = {};
53
+ localVarHeaderParameter['Content-Type'] = 'application/json';
54
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
55
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
56
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
57
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(payload, localVarRequestOptions, configuration);
58
+ return {
59
+ url: (0, common_1.toPathString)(localVarUrlObj),
60
+ options: localVarRequestOptions,
61
+ };
62
+ },
30
63
  /**
31
64
  * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
32
65
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
@@ -458,6 +491,17 @@ exports.OrdersV0ApiAxiosParamCreator = OrdersV0ApiAxiosParamCreator;
458
491
  const OrdersV0ApiFp = function (configuration) {
459
492
  const localVarAxiosParamCreator = (0, exports.OrdersV0ApiAxiosParamCreator)(configuration);
460
493
  return {
494
+ /**
495
+ * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
496
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
497
+ * @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
498
+ * @param {*} [options] Override http request option.
499
+ * @throws {RequiredError}
500
+ */
501
+ async confirmShipment(orderId, payload, options) {
502
+ const localVarAxiosArgs = await localVarAxiosParamCreator.confirmShipment(orderId, payload, options);
503
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
504
+ },
461
505
  /**
462
506
  * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
463
507
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
@@ -605,6 +649,15 @@ exports.OrdersV0ApiFp = OrdersV0ApiFp;
605
649
  const OrdersV0ApiFactory = function (configuration, basePath, axios) {
606
650
  const localVarFp = (0, exports.OrdersV0ApiFp)(configuration);
607
651
  return {
652
+ /**
653
+ * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
654
+ * @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters.
655
+ * @param {*} [options] Override http request option.
656
+ * @throws {RequiredError}
657
+ */
658
+ confirmShipment(requestParameters, options) {
659
+ return localVarFp.confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
660
+ },
608
661
  /**
609
662
  * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
610
663
  * @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
@@ -714,6 +767,16 @@ exports.OrdersV0ApiFactory = OrdersV0ApiFactory;
714
767
  * @extends {BaseAPI}
715
768
  */
716
769
  class OrdersV0Api extends base_1.BaseAPI {
770
+ /**
771
+ * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
772
+ * @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters.
773
+ * @param {*} [options] Override http request option.
774
+ * @throws {RequiredError}
775
+ * @memberof OrdersV0Api
776
+ */
777
+ confirmShipment(requestParameters, options) {
778
+ return (0, exports.OrdersV0ApiFp)(this.configuration).confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
779
+ }
717
780
  /**
718
781
  * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
719
782
  * @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
@@ -0,0 +1,25 @@
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.BusinessHoursDayOfWeekEnum = void 0;
17
+ exports.BusinessHoursDayOfWeekEnum = {
18
+ Sun: 'SUN',
19
+ Mon: 'MON',
20
+ Tue: 'TUE',
21
+ Wed: 'WED',
22
+ Thu: 'THU',
23
+ Fri: 'FRI',
24
+ Sat: 'SAT'
25
+ };
@@ -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 });
@@ -0,0 +1,19 @@
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.ConfirmShipmentRequestCodCollectionMethodEnum = void 0;
17
+ exports.ConfirmShipmentRequestCodCollectionMethodEnum = {
18
+ DirectPayment: 'DirectPayment'
19
+ };
@@ -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 });
@@ -4,13 +4,19 @@ const tslib_1 = require("tslib");
4
4
  tslib_1.__exportStar(require("./address"), exports);
5
5
  tslib_1.__exportStar(require("./approval-support-data-element"), exports);
6
6
  tslib_1.__exportStar(require("./automated-shipping-settings"), exports);
7
+ tslib_1.__exportStar(require("./business-hours"), exports);
7
8
  tslib_1.__exportStar(require("./buyer-customized-info-detail"), exports);
8
9
  tslib_1.__exportStar(require("./buyer-info"), exports);
9
10
  tslib_1.__exportStar(require("./buyer-requested-cancel"), exports);
10
11
  tslib_1.__exportStar(require("./buyer-tax-info"), exports);
11
12
  tslib_1.__exportStar(require("./buyer-tax-information"), exports);
13
+ tslib_1.__exportStar(require("./confirm-shipment-error-response"), exports);
14
+ tslib_1.__exportStar(require("./confirm-shipment-order-item"), exports);
15
+ tslib_1.__exportStar(require("./confirm-shipment-request"), exports);
16
+ tslib_1.__exportStar(require("./delivery-preferences"), exports);
12
17
  tslib_1.__exportStar(require("./easy-ship-shipment-status"), exports);
13
18
  tslib_1.__exportStar(require("./electronic-invoice-status"), exports);
19
+ tslib_1.__exportStar(require("./exception-dates"), exports);
14
20
  tslib_1.__exportStar(require("./fulfillment-instruction"), exports);
15
21
  tslib_1.__exportStar(require("./get-order-address-response"), exports);
16
22
  tslib_1.__exportStar(require("./get-order-approvals-response"), exports);
@@ -31,6 +37,8 @@ tslib_1.__exportStar(require("./item-identifier"), exports);
31
37
  tslib_1.__exportStar(require("./marketplace-tax-info"), exports);
32
38
  tslib_1.__exportStar(require("./model-error"), exports);
33
39
  tslib_1.__exportStar(require("./money"), exports);
40
+ tslib_1.__exportStar(require("./open-interval"), exports);
41
+ tslib_1.__exportStar(require("./open-time-interval"), exports);
34
42
  tslib_1.__exportStar(require("./order"), exports);
35
43
  tslib_1.__exportStar(require("./order-address"), exports);
36
44
  tslib_1.__exportStar(require("./order-approvals-response"), exports);
@@ -44,8 +52,11 @@ tslib_1.__exportStar(require("./order-items-inner"), exports);
44
52
  tslib_1.__exportStar(require("./order-items-list"), exports);
45
53
  tslib_1.__exportStar(require("./order-regulated-info"), exports);
46
54
  tslib_1.__exportStar(require("./orders-list"), exports);
55
+ tslib_1.__exportStar(require("./other-delivery-attributes"), exports);
56
+ tslib_1.__exportStar(require("./package-detail"), exports);
47
57
  tslib_1.__exportStar(require("./payment-execution-detail-item"), exports);
48
58
  tslib_1.__exportStar(require("./points-granted-detail"), exports);
59
+ tslib_1.__exportStar(require("./preferred-delivery-time"), exports);
49
60
  tslib_1.__exportStar(require("./product-info-detail"), exports);
50
61
  tslib_1.__exportStar(require("./regulated-information"), exports);
51
62
  tslib_1.__exportStar(require("./regulated-information-field"), exports);
@@ -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 });
@@ -0,0 +1,26 @@
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.OtherDeliveryAttributes = void 0;
17
+ /**
18
+ * Miscellaneous delivery attributes associated with the shipping address.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+ exports.OtherDeliveryAttributes = {
23
+ HasAccessPoint: 'HAS_ACCESS_POINT',
24
+ PalletEnabled: 'PALLET_ENABLED',
25
+ PalletDisabled: 'PALLET_DISABLED'
26
+ };
@@ -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 });
@@ -81,6 +81,13 @@ exports.clientRateLimits = [
81
81
  rate: 5,
82
82
  burst: 15,
83
83
  },
84
+ {
85
+ method: 'post',
86
+ // eslint-disable-next-line prefer-regex-literals
87
+ urlRegex: new RegExp('^/orders/v0/orders/[^/]*/shipmentConfirmation$'),
88
+ rate: 2,
89
+ burst: 10,
90
+ },
84
91
  ];
85
92
  class OrdersApiClient extends api_model_1.OrdersV0Api {
86
93
  constructor(configuration) {
@@ -23,6 +23,39 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
23
23
  */
24
24
  export const OrdersV0ApiAxiosParamCreator = function (configuration) {
25
25
  return {
26
+ /**
27
+ * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
28
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
29
+ * @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
30
+ * @param {*} [options] Override http request option.
31
+ * @throws {RequiredError}
32
+ */
33
+ confirmShipment: async (orderId, payload, options = {}) => {
34
+ // verify required parameter 'orderId' is not null or undefined
35
+ assertParamExists('confirmShipment', 'orderId', orderId);
36
+ // verify required parameter 'payload' is not null or undefined
37
+ assertParamExists('confirmShipment', 'payload', payload);
38
+ const localVarPath = `/orders/v0/orders/{orderId}/shipmentConfirmation`
39
+ .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
40
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
41
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
42
+ let baseOptions;
43
+ if (configuration) {
44
+ baseOptions = configuration.baseOptions;
45
+ }
46
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
47
+ const localVarHeaderParameter = {};
48
+ const localVarQueryParameter = {};
49
+ localVarHeaderParameter['Content-Type'] = 'application/json';
50
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
51
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
52
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
53
+ localVarRequestOptions.data = serializeDataIfNeeded(payload, localVarRequestOptions, configuration);
54
+ return {
55
+ url: toPathString(localVarUrlObj),
56
+ options: localVarRequestOptions,
57
+ };
58
+ },
26
59
  /**
27
60
  * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
28
61
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
@@ -453,6 +486,17 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration) {
453
486
  export const OrdersV0ApiFp = function (configuration) {
454
487
  const localVarAxiosParamCreator = OrdersV0ApiAxiosParamCreator(configuration);
455
488
  return {
489
+ /**
490
+ * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
491
+ * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
492
+ * @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
493
+ * @param {*} [options] Override http request option.
494
+ * @throws {RequiredError}
495
+ */
496
+ async confirmShipment(orderId, payload, options) {
497
+ const localVarAxiosArgs = await localVarAxiosParamCreator.confirmShipment(orderId, payload, options);
498
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
499
+ },
456
500
  /**
457
501
  * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
458
502
  * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
@@ -599,6 +643,15 @@ export const OrdersV0ApiFp = function (configuration) {
599
643
  export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
600
644
  const localVarFp = OrdersV0ApiFp(configuration);
601
645
  return {
646
+ /**
647
+ * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
648
+ * @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters.
649
+ * @param {*} [options] Override http request option.
650
+ * @throws {RequiredError}
651
+ */
652
+ confirmShipment(requestParameters, options) {
653
+ return localVarFp.confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(axios, basePath));
654
+ },
602
655
  /**
603
656
  * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
604
657
  * @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
@@ -707,6 +760,16 @@ export const OrdersV0ApiFactory = function (configuration, basePath, axios) {
707
760
  * @extends {BaseAPI}
708
761
  */
709
762
  export class OrdersV0Api extends BaseAPI {
763
+ /**
764
+ * Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
765
+ * @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters.
766
+ * @param {*} [options] Override http request option.
767
+ * @throws {RequiredError}
768
+ * @memberof OrdersV0Api
769
+ */
770
+ confirmShipment(requestParameters, options) {
771
+ return OrdersV0ApiFp(this.configuration).confirmShipment(requestParameters.orderId, requestParameters.payload, options).then((request) => request(this.axios, this.basePath));
772
+ }
710
773
  /**
711
774
  * Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
712
775
  * @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
@@ -0,0 +1,22 @@
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 const BusinessHoursDayOfWeekEnum = {
15
+ Sun: 'SUN',
16
+ Mon: 'MON',
17
+ Tue: 'TUE',
18
+ Wed: 'WED',
19
+ Thu: 'THU',
20
+ Fri: 'FRI',
21
+ Sat: 'SAT'
22
+ };
@@ -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 {};
@@ -0,0 +1,16 @@
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 const ConfirmShipmentRequestCodCollectionMethodEnum = {
15
+ DirectPayment: 'DirectPayment'
16
+ };
@@ -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,13 +1,19 @@
1
1
  export * from './address';
2
2
  export * from './approval-support-data-element';
3
3
  export * from './automated-shipping-settings';
4
+ export * from './business-hours';
4
5
  export * from './buyer-customized-info-detail';
5
6
  export * from './buyer-info';
6
7
  export * from './buyer-requested-cancel';
7
8
  export * from './buyer-tax-info';
8
9
  export * from './buyer-tax-information';
10
+ export * from './confirm-shipment-error-response';
11
+ export * from './confirm-shipment-order-item';
12
+ export * from './confirm-shipment-request';
13
+ export * from './delivery-preferences';
9
14
  export * from './easy-ship-shipment-status';
10
15
  export * from './electronic-invoice-status';
16
+ export * from './exception-dates';
11
17
  export * from './fulfillment-instruction';
12
18
  export * from './get-order-address-response';
13
19
  export * from './get-order-approvals-response';
@@ -28,6 +34,8 @@ export * from './item-identifier';
28
34
  export * from './marketplace-tax-info';
29
35
  export * from './model-error';
30
36
  export * from './money';
37
+ export * from './open-interval';
38
+ export * from './open-time-interval';
31
39
  export * from './order';
32
40
  export * from './order-address';
33
41
  export * from './order-approvals-response';
@@ -41,8 +49,11 @@ export * from './order-items-inner';
41
49
  export * from './order-items-list';
42
50
  export * from './order-regulated-info';
43
51
  export * from './orders-list';
52
+ export * from './other-delivery-attributes';
53
+ export * from './package-detail';
44
54
  export * from './payment-execution-detail-item';
45
55
  export * from './points-granted-detail';
56
+ export * from './preferred-delivery-time';
46
57
  export * from './product-info-detail';
47
58
  export * from './regulated-information';
48
59
  export * from './regulated-information-field';
@@ -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 {};