@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1 2.5.2 → 2.6.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 (23) hide show
  1. package/dist/cjs/api-model/api/vendor-shipping-api.js +58 -58
  2. package/dist/es/api-model/api/vendor-shipping-api.js +58 -58
  3. package/dist/types/api-model/api/vendor-shipping-api.d.ts +69 -69
  4. package/dist/types/api-model/models/customer-invoice-list.d.ts +1 -1
  5. package/dist/types/api-model/models/customer-invoice.d.ts +1 -1
  6. package/dist/types/api-model/models/get-customer-invoice-response.d.ts +1 -1
  7. package/dist/types/api-model/models/get-customer-invoices-response.d.ts +1 -1
  8. package/dist/types/api-model/models/get-packing-slip-list-response.d.ts +1 -1
  9. package/dist/types/api-model/models/get-shipping-label-list-response.d.ts +1 -1
  10. package/dist/types/api-model/models/get-shipping-label-response.d.ts +1 -1
  11. package/dist/types/api-model/models/item.d.ts +1 -1
  12. package/dist/types/api-model/models/label-data.d.ts +1 -1
  13. package/dist/types/api-model/models/packed-item.d.ts +1 -1
  14. package/dist/types/api-model/models/pagination.d.ts +1 -1
  15. package/dist/types/api-model/models/status-update-details-shipment-schedule.d.ts +3 -3
  16. package/dist/types/api-model/models/status-update-details.d.ts +4 -4
  17. package/dist/types/api-model/models/submit-shipment-confirmations-request.d.ts +2 -2
  18. package/dist/types/api-model/models/submit-shipment-confirmations-response.d.ts +1 -1
  19. package/dist/types/api-model/models/submit-shipment-status-updates-request.d.ts +2 -2
  20. package/dist/types/api-model/models/submit-shipment-status-updates-response.d.ts +1 -1
  21. package/dist/types/api-model/models/submit-shipping-labels-request.d.ts +1 -1
  22. package/dist/types/api-model/models/submit-shipping-labels-response.d.ts +1 -1
  23. package/package.json +2 -2
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { ShippingLabel } from './shipping-label';
13
13
  /**
14
- * The response schema for the `getShippingLabel` operation.
14
+ * The response schema for the getShippingLabel operation.
15
15
  * @export
16
16
  * @interface GetShippingLabelResponse
17
17
  */
@@ -23,7 +23,7 @@ export interface Item {
23
23
  */
24
24
  'itemSequenceNumber': number;
25
25
  /**
26
- * Buyer\'s Standard Identification Number (ASIN) of an item. Either `buyerProductIdentifier` or `vendorProductIdentifier` is required.
26
+ * Buyer\'s Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required.
27
27
  * @type {string}
28
28
  * @memberof Item
29
29
  */
@@ -28,7 +28,7 @@ export interface LabelData {
28
28
  */
29
29
  'trackingNumber'?: string;
30
30
  /**
31
- * Ship method to be used for shipping the order. Amazon defines ship method codes indicating shipping carrier and shipment service level. Ship method codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the ship method codes are vendor specific and will be provided to each vendor during the implementation.
31
+ * Ship method to be used for shipping the order. Amazon defines Ship Method Codes indicating shipping carrier and shipment service level. Ship Method Codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the Ship Method Codes are vendor specific and will be provided to each vendor during the implementation.
32
32
  * @type {string}
33
33
  * @memberof LabelData
34
34
  */
@@ -23,7 +23,7 @@ export interface PackedItem {
23
23
  */
24
24
  'itemSequenceNumber': number;
25
25
  /**
26
- * Buyer\'s Standard Identification Number (ASIN) of an item. Either `buyerProductIdentifier` or `vendorProductIdentifier` is required.
26
+ * Buyer\'s Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required.
27
27
  * @type {string}
28
28
  * @memberof PackedItem
29
29
  */
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface Pagination {
18
18
  /**
19
- * A generated string used to pass information to your next request. If `NextToken` is returned, pass the value of `NextToken` to the next request. If `NextToken` is not returned, there are no more order items to return.
19
+ * A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return.
20
20
  * @type {string}
21
21
  * @memberof Pagination
22
22
  */
@@ -16,19 +16,19 @@
16
16
  */
17
17
  export interface StatusUpdateDetailsShipmentSchedule {
18
18
  /**
19
- * Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`.
19
+ * Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
20
20
  * @type {string}
21
21
  * @memberof StatusUpdateDetailsShipmentSchedule
22
22
  */
23
23
  'estimatedDeliveryDateTime'?: string;
24
24
  /**
25
- * This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`.
25
+ * This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
26
26
  * @type {string}
27
27
  * @memberof StatusUpdateDetailsShipmentSchedule
28
28
  */
29
29
  'apptWindowStartDateTime'?: string;
30
30
  /**
31
- * This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`.
31
+ * This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
32
32
  * @type {string}
33
33
  * @memberof StatusUpdateDetailsShipmentSchedule
34
34
  */
@@ -18,25 +18,25 @@ import type { StatusUpdateDetailsShipmentSchedule } from './status-update-detail
18
18
  */
19
19
  export interface StatusUpdateDetails {
20
20
  /**
21
- * This is required to be provided for every package and should match with the `trackingNumber` sent for the shipment confirmation.
21
+ * This is required to be provided for every package and should match with the trackingNumber sent for the shipment confirmation.
22
22
  * @type {string}
23
23
  * @memberof StatusUpdateDetails
24
24
  */
25
25
  'trackingNumber': string;
26
26
  /**
27
- * Indicates the shipment status code for the package that provides transportation information for Amazon tracking systems and ultimately for the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation).
27
+ * Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation).
28
28
  * @type {string}
29
29
  * @memberof StatusUpdateDetails
30
30
  */
31
31
  'statusCode': string;
32
32
  /**
33
- * Provides a reason code for the status for the package that will provide additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation).
33
+ * Provides a reason code for the status of the package that will provide additional information about the transportation status. For more information, refer to the [Additional Fields Explanation](https://developer-docs.amazon.com/sp-api/docs/vendor-direct-fulfillment-shipping-api-use-case-guide#additional-fields-explanation).
34
34
  * @type {string}
35
35
  * @memberof StatusUpdateDetails
36
36
  */
37
37
  'reasonCode': string;
38
38
  /**
39
- * The date and time when the shipment status was updated. This field is expected to be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format, with UTC time zone or UTC offset. For example, `2020-07-16T23:00:00Z` or `2020-07-16T23:00:00+01:00`.
39
+ * The date and time when the shipment status was updated. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00.
40
40
  * @type {string}
41
41
  * @memberof StatusUpdateDetails
42
42
  */
@@ -11,13 +11,13 @@
11
11
  */
12
12
  import type { ShipmentConfirmation } from './shipment-confirmation';
13
13
  /**
14
- * The request schema for the `submitShipmentConfirmations` operation.
14
+ * The request schema for the submitShipmentConfirmations operation.
15
15
  * @export
16
16
  * @interface SubmitShipmentConfirmationsRequest
17
17
  */
18
18
  export interface SubmitShipmentConfirmationsRequest {
19
19
  /**
20
- * Array of `ShipmentConfirmation` objects, each representing confirmation details for a specific shipment.
20
+ * Array of ShipmentConfirmation objects, each representing confirmation details for a specific shipment.
21
21
  * @type {Array<ShipmentConfirmation>}
22
22
  * @memberof SubmitShipmentConfirmationsRequest
23
23
  */
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { TransactionReference } from './transaction-reference';
13
13
  /**
14
- * The response schema for the `submitShipmentConfirmations` operation.
14
+ * The response schema for the submitShipmentConfirmations operation.
15
15
  * @export
16
16
  * @interface SubmitShipmentConfirmationsResponse
17
17
  */
@@ -11,13 +11,13 @@
11
11
  */
12
12
  import type { ShipmentStatusUpdate } from './shipment-status-update';
13
13
  /**
14
- * Represents the request payload for submitting updates to the status of shipments, containing an array of one or more `ShipmentStatusUpdate` objects.
14
+ * Represents the request payload for submitting updates to the status of shipments, containing an array of one or more ShipmentStatusUpdate objects.
15
15
  * @export
16
16
  * @interface SubmitShipmentStatusUpdatesRequest
17
17
  */
18
18
  export interface SubmitShipmentStatusUpdatesRequest {
19
19
  /**
20
- * Contains a list of one or more `ShipmentStatusUpdate` objects, each representing an update to the status of a specific shipment.
20
+ * Contains a list of one or more ShipmentStatusUpdate objects, each representing an update to the status of a specific shipment.
21
21
  * @type {Array<ShipmentStatusUpdate>}
22
22
  * @memberof SubmitShipmentStatusUpdatesRequest
23
23
  */
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { TransactionReference } from './transaction-reference';
13
13
  /**
14
- * The response schema for the `submitShipmentStatusUpdates` operation.
14
+ * The response schema for the submitShipmentStatusUpdates operation.
15
15
  * @export
16
16
  * @interface SubmitShipmentStatusUpdatesResponse
17
17
  */
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { ShippingLabelRequest } from './shipping-label-request';
13
13
  /**
14
- * The request schema for the `submitShippingLabelRequest` operation.
14
+ * The request schema for the submitShippingLabelRequest operation.
15
15
  * @export
16
16
  * @interface SubmitShippingLabelsRequest
17
17
  */
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { TransactionReference } from './transaction-reference';
13
13
  /**
14
- * The response schema for the `submitShippingLabelRequest` operation.
14
+ * The response schema for the submitShippingLabelRequest operation.
15
15
  * @export
16
16
  * @interface SubmitShippingLabelsResponse
17
17
  */
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor's shipping data.",
5
- "version": "2.5.2",
5
+ "version": "2.6.0",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "vendor direct fulfillment shipping api"
42
42
  ],
43
- "gitHead": "cde6991012a79a8483a72ecb1c71d92087f390a6"
43
+ "gitHead": "709bf500f3a6a5851b204903c5a0ea2afff80d9a"
44
44
  }