@sp-api-sdk/shipping-api-v2 2.0.1 → 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 (77) hide show
  1. package/dist/cjs/api-model/api/shipping-api.js +274 -29
  2. package/dist/cjs/api-model/configuration.js +1 -2
  3. package/dist/cjs/api-model/models/carrier-account.js +15 -0
  4. package/dist/cjs/api-model/models/claim-reason.js +28 -0
  5. package/dist/cjs/api-model/models/create-claim-request.js +15 -0
  6. package/dist/cjs/api-model/models/create-claim-response.js +15 -0
  7. package/dist/cjs/api-model/models/detail-codes.js +53 -0
  8. package/dist/cjs/api-model/models/event-code.js +4 -1
  9. package/dist/cjs/api-model/models/goods-owner.js +15 -0
  10. package/dist/cjs/api-model/models/index.js +13 -0
  11. package/dist/cjs/api-model/models/label-attribute.js +26 -0
  12. package/dist/cjs/api-model/models/ndr-action.js +26 -0
  13. package/dist/cjs/api-model/models/ndr-request-data.js +15 -0
  14. package/dist/cjs/api-model/models/rate-item-id.js +6 -1
  15. package/dist/cjs/api-model/models/requested-label-customization.js +15 -0
  16. package/dist/cjs/api-model/models/settlement-type.js +25 -0
  17. package/dist/cjs/api-model/models/status.js +2 -1
  18. package/dist/cjs/api-model/models/submit-ndr-feedback-request.js +15 -0
  19. package/dist/cjs/api-model/models/tracking-detail-codes.js +15 -0
  20. package/dist/cjs/client.js +21 -0
  21. package/dist/es/api-model/api/shipping-api.js +273 -28
  22. package/dist/es/api-model/configuration.js +1 -2
  23. package/dist/es/api-model/models/carrier-account.js +14 -0
  24. package/dist/es/api-model/models/claim-reason.js +25 -0
  25. package/dist/es/api-model/models/create-claim-request.js +14 -0
  26. package/dist/es/api-model/models/create-claim-response.js +14 -0
  27. package/dist/es/api-model/models/detail-codes.js +50 -0
  28. package/dist/es/api-model/models/event-code.js +4 -1
  29. package/dist/es/api-model/models/goods-owner.js +14 -0
  30. package/dist/es/api-model/models/index.js +13 -0
  31. package/dist/es/api-model/models/label-attribute.js +23 -0
  32. package/dist/es/api-model/models/ndr-action.js +23 -0
  33. package/dist/es/api-model/models/ndr-request-data.js +14 -0
  34. package/dist/es/api-model/models/rate-item-id.js +6 -1
  35. package/dist/es/api-model/models/requested-label-customization.js +14 -0
  36. package/dist/es/api-model/models/settlement-type.js +22 -0
  37. package/dist/es/api-model/models/status.js +2 -1
  38. package/dist/es/api-model/models/submit-ndr-feedback-request.js +14 -0
  39. package/dist/es/api-model/models/tracking-detail-codes.js +14 -0
  40. package/dist/es/client.js +21 -0
  41. package/dist/types/api-model/api/shipping-api.d.ts +251 -42
  42. package/dist/types/api-model/common.d.ts +1 -1
  43. package/dist/types/api-model/models/access-point-details.d.ts +1 -1
  44. package/dist/types/api-model/models/access-point.d.ts +2 -2
  45. package/dist/types/api-model/models/active-account.d.ts +1 -1
  46. package/dist/types/api-model/models/benefits.d.ts +1 -1
  47. package/dist/types/api-model/models/carrier-account.d.ts +30 -0
  48. package/dist/types/api-model/models/claim-reason.d.ts +24 -0
  49. package/dist/types/api-model/models/create-claim-request.d.ts +57 -0
  50. package/dist/types/api-model/models/create-claim-response.d.ts +24 -0
  51. package/dist/types/api-model/models/detail-codes.d.ts +49 -0
  52. package/dist/types/api-model/models/error-list.d.ts +1 -1
  53. package/dist/types/api-model/models/event-code.d.ts +3 -0
  54. package/dist/types/api-model/models/event.d.ts +7 -0
  55. package/dist/types/api-model/models/excluded-benefit.d.ts +5 -5
  56. package/dist/types/api-model/models/get-rates-request.d.ts +7 -0
  57. package/dist/types/api-model/models/get-shipment-documents-result.d.ts +7 -0
  58. package/dist/types/api-model/models/goods-owner.d.ts +24 -0
  59. package/dist/types/api-model/models/index.d.ts +13 -0
  60. package/dist/types/api-model/models/label-attribute.d.ts +22 -0
  61. package/dist/types/api-model/models/link-carrier-account-response.d.ts +6 -0
  62. package/dist/types/api-model/models/ndr-action.d.ts +22 -0
  63. package/dist/types/api-model/models/ndr-request-data.d.ts +30 -0
  64. package/dist/types/api-model/models/one-click-shipment-request.d.ts +7 -0
  65. package/dist/types/api-model/models/operating-hours.d.ts +1 -1
  66. package/dist/types/api-model/models/purchase-shipment-result.d.ts +7 -0
  67. package/dist/types/api-model/models/rate-item-id.d.ts +5 -0
  68. package/dist/types/api-model/models/requested-document-specification.d.ts +7 -0
  69. package/dist/types/api-model/models/requested-label-customization.d.ts +25 -0
  70. package/dist/types/api-model/models/settlement-type.d.ts +21 -0
  71. package/dist/types/api-model/models/status.d.ts +1 -0
  72. package/dist/types/api-model/models/submit-ndr-feedback-request.d.ts +38 -0
  73. package/dist/types/api-model/models/time-of-day.d.ts +3 -3
  74. package/dist/types/api-model/models/tracking-detail-codes.d.ts +31 -0
  75. package/dist/types/api-model/models/tracking-summary.d.ts +7 -0
  76. package/dist/types/api-model/models/unlink-carrier-account-request.d.ts +6 -0
  77. package/package.json +4 -4
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Amazon Shipping API
5
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
6
+ *
7
+ * The version of the OpenAPI document: v2
8
+ * Contact: swa-api-core@amazon.com
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
+ * Amazon Shipping API
5
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
6
+ *
7
+ * The version of the OpenAPI document: v2
8
+ * Contact: swa-api-core@amazon.com
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,50 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Amazon Shipping API
5
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
6
+ *
7
+ * The version of the OpenAPI document: v2
8
+ * Contact: swa-api-core@amazon.com
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
+ * A list of codes used to provide additional shipment information.
16
+ * @export
17
+ * @enum {string}
18
+ */
19
+ export const DetailCodes = {
20
+ BusinessClosed: 'BusinessClosed',
21
+ CustomerUnavailable: 'CustomerUnavailable',
22
+ PaymentNotReady: 'PaymentNotReady',
23
+ OtpNotAvailable: 'OtpNotAvailable',
24
+ DeliveryAttempted: 'DeliveryAttempted',
25
+ UnableToAccess: 'UnableToAccess',
26
+ UnableToContactRecipient: 'UnableToContactRecipient',
27
+ DeliveredToBehindWheelieBin: 'DeliveredToBehindWheelieBin',
28
+ DeliveredToPorch: 'DeliveredToPorch',
29
+ DeliveredToGarage: 'DeliveredToGarage',
30
+ DeliveredToGarden: 'DeliveredToGarden',
31
+ DeliveredToGreenhouse: 'DeliveredToGreenhouse',
32
+ DeliveredToMailSlot: 'DeliveredToMailSlot',
33
+ DeliveredToMailRoom: 'DeliveredToMailRoom',
34
+ DeliveredToNeighbor: 'DeliveredToNeighbor',
35
+ DeliveredToRearDoor: 'DeliveredToRearDoor',
36
+ DeliveredToReceptionist: 'DeliveredToReceptionist',
37
+ DeliveredToShed: 'DeliveredToShed',
38
+ DeliveredWithOtp: 'DeliveredWithOTP',
39
+ Signed: 'Signed',
40
+ Damaged: 'Damaged',
41
+ IncorrectItems: 'IncorrectItems',
42
+ NotRequired: 'NotRequired',
43
+ Rejected: 'Rejected',
44
+ RejectedByRecipientWithVerification: 'RejectedByRecipientWithVerification',
45
+ CancelledByRecipient: 'CancelledByRecipient',
46
+ AddressNotFound: 'AddressNotFound',
47
+ HazmatShipment: 'HazmatShipment',
48
+ Undeliverable: 'Undeliverable',
49
+ ArrivedAtLocalFacility: 'ArrivedAtLocalFacility'
50
+ };
@@ -27,5 +27,8 @@ export const EventCode = {
27
27
  ArrivedAtCarrierFacility: 'ArrivedAtCarrierFacility',
28
28
  Rejected: 'Rejected',
29
29
  Undeliverable: 'Undeliverable',
30
- PickupCancelled: 'PickupCancelled'
30
+ PickupCancelled: 'PickupCancelled',
31
+ ReturnInitiated: 'ReturnInitiated',
32
+ AvailableForPickup: 'AvailableForPickup',
33
+ RecipientRequestedAlternateDeliveryTiming: 'RecipientRequestedAlternateDeliveryTiming'
31
34
  };
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Amazon Shipping API
5
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
6
+ *
7
+ * The version of the OpenAPI document: v2
8
+ * Contact: swa-api-core@amazon.com
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 {};
@@ -12,18 +12,23 @@ export * from './available-value-added-service-group';
12
12
  export * from './benefits';
13
13
  export * from './cancel-shipment-response';
14
14
  export * from './carrier';
15
+ export * from './carrier-account';
15
16
  export * from './carrier-account-attribute';
16
17
  export * from './carrier-account-input';
17
18
  export * from './channel-details';
18
19
  export * from './channel-type';
19
20
  export * from './charge-component';
21
+ export * from './claim-reason';
20
22
  export * from './client-reference-detail';
21
23
  export * from './collect-on-delivery';
22
24
  export * from './collection-forms-history-record';
23
25
  export * from './collections-form-document';
26
+ export * from './create-claim-request';
27
+ export * from './create-claim-response';
24
28
  export * from './currency';
25
29
  export * from './dangerous-goods-details';
26
30
  export * from './date-range';
31
+ export * from './detail-codes';
27
32
  export * from './dimensions';
28
33
  export * from './direct-fulfillment-item-identifiers';
29
34
  export * from './direct-purchase-request';
@@ -59,12 +64,14 @@ export * from './get-tracking-response';
59
64
  export * from './get-tracking-result';
60
65
  export * from './get-unmanifested-shipments-request';
61
66
  export * from './get-unmanifested-shipments-response';
67
+ export * from './goods-owner';
62
68
  export * from './ineligibility-reason';
63
69
  export * from './ineligibility-reason-code';
64
70
  export * from './ineligible-rate';
65
71
  export * from './input-type';
66
72
  export * from './invoice-details';
67
73
  export * from './item';
74
+ export * from './label-attribute';
68
75
  export * from './link-carrier-account-request';
69
76
  export * from './link-carrier-account-response';
70
77
  export * from './linkable-account-type';
@@ -72,6 +79,8 @@ export * from './linkable-carrier';
72
79
  export * from './liquid-volume';
73
80
  export * from './location';
74
81
  export * from './model-error';
82
+ export * from './ndr-action';
83
+ export * from './ndr-request-data';
75
84
  export * from './one-click-shipment-request';
76
85
  export * from './one-click-shipment-response';
77
86
  export * from './one-click-shipment-result';
@@ -91,18 +100,22 @@ export * from './rate-item';
91
100
  export * from './rate-item-id';
92
101
  export * from './rate-item-type';
93
102
  export * from './requested-document-specification';
103
+ export * from './requested-label-customization';
94
104
  export * from './requested-value-added-service';
95
105
  export * from './service';
96
106
  export * from './service-selection';
107
+ export * from './settlement-type';
97
108
  export * from './shipment-type';
98
109
  export * from './shipper-instruction';
99
110
  export * from './status';
111
+ export * from './submit-ndr-feedback-request';
100
112
  export * from './supported-document-detail';
101
113
  export * from './supported-document-specification';
102
114
  export * from './tax-detail';
103
115
  export * from './tax-type';
104
116
  export * from './time-of-day';
105
117
  export * from './time-window';
118
+ export * from './tracking-detail-codes';
106
119
  export * from './tracking-summary';
107
120
  export * from './unlink-carrier-account-request';
108
121
  export * from './unlink-carrier-account-response';
@@ -0,0 +1,23 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Amazon Shipping API
5
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
6
+ *
7
+ * The version of the OpenAPI document: v2
8
+ * Contact: swa-api-core@amazon.com
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
+ * Enumerates the attributes supported to be printed on a shipping label. The values for these attributes are retrieved from GetRates/OneClickShipment request
16
+ * @export
17
+ * @enum {string}
18
+ */
19
+ export const LabelAttribute = {
20
+ PackageClientReferenceId: 'PACKAGE_CLIENT_REFERENCE_ID',
21
+ SellerDisplayName: 'SELLER_DISPLAY_NAME',
22
+ CollectOnDeliveryAmount: 'COLLECT_ON_DELIVERY_AMOUNT'
23
+ };
@@ -0,0 +1,23 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Amazon Shipping API
5
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
6
+ *
7
+ * The version of the OpenAPI document: v2
8
+ * Contact: swa-api-core@amazon.com
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 type of NDR action shipper wants to take for a particular shipment.
16
+ * @export
17
+ * @enum {string}
18
+ */
19
+ export const NdrAction = {
20
+ Reschedule: 'RESCHEDULE',
21
+ Reattempt: 'REATTEMPT',
22
+ Rto: 'RTO'
23
+ };
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Amazon Shipping API
5
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
6
+ *
7
+ * The version of the OpenAPI document: v2
8
+ * Contact: swa-api-core@amazon.com
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 {};
@@ -44,5 +44,10 @@ export const RateItemID = {
44
44
  ResidentialSurcharge: 'RESIDENTIAL_SURCHARGE',
45
45
  AdditionalSurcharge: 'ADDITIONAL_SURCHARGE',
46
46
  Surcharge: 'SURCHARGE',
47
- Rebate: 'REBATE'
47
+ Rebate: 'REBATE',
48
+ HighCubeSurcharge: 'HIGH_CUBE_SURCHARGE',
49
+ HighLengthSurcharge: 'HIGH_LENGTH_SURCHARGE',
50
+ HighWidthSurcharge: 'HIGH_WIDTH_SURCHARGE',
51
+ DemandSurcharge: 'DEMAND_SURCHARGE',
52
+ NonstandardFee: 'NONSTANDARD_FEE'
48
53
  };
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Amazon Shipping API
5
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
6
+ *
7
+ * The version of the OpenAPI document: v2
8
+ * Contact: swa-api-core@amazon.com
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,22 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Amazon Shipping API
5
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
6
+ *
7
+ * The version of the OpenAPI document: v2
8
+ * Contact: swa-api-core@amazon.com
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
+ * Type of settlement the shipper wants to receive for a particular shipment.
16
+ * @export
17
+ * @enum {string}
18
+ */
19
+ export const SettlementType = {
20
+ Refund: 'REFUND',
21
+ CertificateOfFact: 'CERTIFICATE_OF_FACT'
22
+ };
@@ -25,5 +25,6 @@ export const Status = {
25
25
  Rejected: 'Rejected',
26
26
  Undeliverable: 'Undeliverable',
27
27
  DeliveryAttempted: 'DeliveryAttempted',
28
- PickupCancelled: 'PickupCancelled'
28
+ PickupCancelled: 'PickupCancelled',
29
+ AwaitingCustomerPickup: 'AwaitingCustomerPickup'
29
30
  };
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Amazon Shipping API
5
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
6
+ *
7
+ * The version of the OpenAPI document: v2
8
+ * Contact: swa-api-core@amazon.com
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
+ * Amazon Shipping API
5
+ * The Amazon Shipping API is designed to support outbound shipping use cases both for orders originating on Amazon-owned marketplaces as well as external channels/marketplaces. With these APIs, you can request shipping rates, create shipments, cancel shipments, and track shipments.
6
+ *
7
+ * The version of the OpenAPI document: v2
8
+ * Contact: swa-api-core@amazon.com
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 {};
package/dist/es/client.js CHANGED
@@ -78,6 +78,13 @@ export const clientRateLimits = [
78
78
  rate: 80,
79
79
  burst: 100,
80
80
  },
81
+ {
82
+ method: 'post',
83
+ // eslint-disable-next-line prefer-regex-literals
84
+ urlRegex: new RegExp('^/shipping/v2/carrierAccounts/[^/]*$'),
85
+ rate: 5,
86
+ burst: 10,
87
+ },
81
88
  {
82
89
  method: 'put',
83
90
  // eslint-disable-next-line prefer-regex-literals
@@ -120,6 +127,20 @@ export const clientRateLimits = [
120
127
  rate: 80,
121
128
  burst: 100,
122
129
  },
130
+ {
131
+ method: 'post',
132
+ // eslint-disable-next-line prefer-regex-literals
133
+ urlRegex: new RegExp('^/shipping/v2/ndrFeedback$'),
134
+ rate: 80,
135
+ burst: 100,
136
+ },
137
+ {
138
+ method: 'post',
139
+ // eslint-disable-next-line prefer-regex-literals
140
+ urlRegex: new RegExp('^/shipping/v2/claims$'),
141
+ rate: 80,
142
+ burst: 100,
143
+ },
123
144
  ];
124
145
  export class ShippingApiClient extends ShippingApi {
125
146
  constructor(configuration) {