@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,21 @@
1
+ /**
2
+ * Amazon Shipping API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: v2
6
+ * Contact: swa-api-core@amazon.com
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
+ * Type of settlement the shipper wants to receive for a particular shipment.
14
+ * @export
15
+ * @enum {string}
16
+ */
17
+ export declare const SettlementType: {
18
+ readonly Refund: "REFUND";
19
+ readonly CertificateOfFact: "CERTIFICATE_OF_FACT";
20
+ };
21
+ export type SettlementType = typeof SettlementType[keyof typeof SettlementType];
@@ -24,5 +24,6 @@ export declare const Status: {
24
24
  readonly Undeliverable: "Undeliverable";
25
25
  readonly DeliveryAttempted: "DeliveryAttempted";
26
26
  readonly PickupCancelled: "PickupCancelled";
27
+ readonly AwaitingCustomerPickup: "AwaitingCustomerPickup";
27
28
  };
28
29
  export type Status = typeof Status[keyof typeof Status];
@@ -0,0 +1,38 @@
1
+ /**
2
+ * Amazon Shipping API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: v2
6
+ * Contact: swa-api-core@amazon.com
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 type { NdrAction } from './ndr-action';
13
+ import type { NdrRequestData } from './ndr-request-data';
14
+ /**
15
+ * The request schema for the NdrFeedback operation
16
+ * @export
17
+ * @interface SubmitNdrFeedbackRequest
18
+ */
19
+ export interface SubmitNdrFeedbackRequest {
20
+ /**
21
+ * The carrier generated identifier for a package in a purchased shipment.
22
+ * @type {string}
23
+ * @memberof SubmitNdrFeedbackRequest
24
+ */
25
+ 'trackingId': string;
26
+ /**
27
+ *
28
+ * @type {NdrAction}
29
+ * @memberof SubmitNdrFeedbackRequest
30
+ */
31
+ 'ndrAction': NdrAction;
32
+ /**
33
+ *
34
+ * @type {NdrRequestData}
35
+ * @memberof SubmitNdrFeedbackRequest
36
+ */
37
+ 'ndrRequestData'?: NdrRequestData;
38
+ }
@@ -16,19 +16,19 @@
16
16
  */
17
17
  export interface TimeOfDay {
18
18
  /**
19
- *
19
+ * Denotes hour of the day, used for defining opening or closing time of access points
20
20
  * @type {number}
21
21
  * @memberof TimeOfDay
22
22
  */
23
23
  'hourOfDay'?: number;
24
24
  /**
25
- *
25
+ * Denotes minute of the hour, used for defining opening or closing time of access points
26
26
  * @type {number}
27
27
  * @memberof TimeOfDay
28
28
  */
29
29
  'minuteOfHour'?: number;
30
30
  /**
31
- *
31
+ * Denotes second of the minute, used for defining opening or closing time of access points
32
32
  * @type {number}
33
33
  * @memberof TimeOfDay
34
34
  */
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Amazon Shipping API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: v2
6
+ * Contact: swa-api-core@amazon.com
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 type { DetailCodes } from './detail-codes';
13
+ /**
14
+ * Contains detail codes that provide additional details related to the forward and return leg of the shipment.
15
+ * @export
16
+ * @interface TrackingDetailCodes
17
+ */
18
+ export interface TrackingDetailCodes {
19
+ /**
20
+ * Contains detail codes that provide additional details related to the forward leg of the shipment.
21
+ * @type {Array<DetailCodes>}
22
+ * @memberof TrackingDetailCodes
23
+ */
24
+ 'forward': Array<DetailCodes>;
25
+ /**
26
+ * Contains detail codes that provide additional details related to the return leg of the shipment.
27
+ * @type {Array<DetailCodes>}
28
+ * @memberof TrackingDetailCodes
29
+ */
30
+ 'returns': Array<DetailCodes>;
31
+ }
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { Status } from './status';
13
+ import type { TrackingDetailCodes } from './tracking-detail-codes';
13
14
  /**
14
15
  * A package status summary.
15
16
  * @export
@@ -22,4 +23,10 @@ export interface TrackingSummary {
22
23
  * @memberof TrackingSummary
23
24
  */
24
25
  'status'?: Status;
26
+ /**
27
+ *
28
+ * @type {TrackingDetailCodes}
29
+ * @memberof TrackingSummary
30
+ */
31
+ 'trackingDetailCodes'?: TrackingDetailCodes;
25
32
  }
@@ -22,4 +22,10 @@ export interface UnlinkCarrierAccountRequest {
22
22
  * @memberof UnlinkCarrierAccountRequest
23
23
  */
24
24
  'clientReferenceDetails'?: Array<ClientReferenceDetail>;
25
+ /**
26
+ * Identifier for the seller\'s carrier account.
27
+ * @type {string}
28
+ * @memberof UnlinkCarrierAccountRequest
29
+ */
30
+ 'accountId'?: string;
25
31
  }
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/shipping-api-v2",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "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.",
5
- "version": "2.0.1",
5
+ "version": "2.1.0",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.1.10",
22
- "axios": "^1.7.9"
21
+ "@sp-api-sdk/common": "2.1.11",
22
+ "axios": "^1.8.1"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "shipping api"
42
42
  ],
43
- "gitHead": "4098c9f3375b3b56212baa3bf21c18dd987baab2"
43
+ "gitHead": "b5799742765e819f70161d2ac1905d8e570de8c0"
44
44
  }