@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1 2.2.1 → 2.3.1

package/dist/types/src/api-model/models/customer-invoice-list.d.ts

@@ -12,7 +12,7 @@
 import type { CustomerInvoice } from './customer-invoice';
 import type { Pagination } from './pagination';
 /**
- *
+ * Represents a list of customer invoices, potentially paginated.
  * @export
  * @interface CustomerInvoiceList
  */
@@ -24,7 +24,7 @@ export interface CustomerInvoiceList {
      */
     'pagination'?: Pagination;
     /**
-     *
+     * Represents a customer invoice within the `CustomerInvoiceList`.
      * @type {Array<CustomerInvoice>}
      * @memberof CustomerInvoiceList
      */

package/dist/types/src/api-model/models/customer-invoice.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Represents a customer invoice associated with a purchase order.
  * @export
  * @interface CustomerInvoice
  */
@@ -22,7 +22,7 @@ export interface CustomerInvoice {
      */
     'purchaseOrderNumber': string;
     /**
-     * The Base64encoded customer invoice.
+     * The `Base64encoded` customer invoice.
      * @type {string}
      * @memberof CustomerInvoice
      */

package/dist/types/src/api-model/models/get-customer-invoice-response.d.ts

@@ -11,7 +11,7 @@
  */
 import type { CustomerInvoice } from './customer-invoice';
 /**
- * The response schema for the getCustomerInvoice operation.
+ * The response schema for the `getCustomerInvoice` operation.
  * @export
  * @interface GetCustomerInvoiceResponse
  */

package/dist/types/src/api-model/models/get-customer-invoices-response.d.ts

@@ -11,7 +11,7 @@
  */
 import type { CustomerInvoiceList } from './customer-invoice-list';
 /**
- * The response schema for the getCustomerInvoices operation.
+ * The response schema for the `getCustomerInvoices` operation.
  * @export
  * @interface GetCustomerInvoicesResponse
  */

package/dist/types/src/api-model/models/get-packing-slip-list-response.d.ts

@@ -11,7 +11,7 @@
  */
 import type { PackingSlipList } from './packing-slip-list';
 /**
- *
+ * Response payload with the list of packing slips.
  * @export
  * @interface GetPackingSlipListResponse
  */

package/dist/types/src/api-model/models/get-packing-slip-response.d.ts

@@ -11,7 +11,7 @@
  */
 import type { PackingSlip } from './packing-slip';
 /**
- *
+ * Response payload with packing slip.
  * @export
  * @interface GetPackingSlipResponse
  */

package/dist/types/src/api-model/models/get-shipping-label-list-response.d.ts

@@ -11,7 +11,7 @@
  */
 import type { ShippingLabelList } from './shipping-label-list';
 /**
- * The response schema for the getShippingLabels operation.
+ * The response schema for the `getShippingLabels` operation.
  * @export
  * @interface GetShippingLabelListResponse
  */

package/dist/types/src/api-model/models/get-shipping-label-response.d.ts

@@ -11,7 +11,7 @@
  */
 import type { ShippingLabel } from './shipping-label';
 /**
- * The response schema for the getShippingLabel operation.
+ * The response schema for the `getShippingLabel` operation.
  * @export
  * @interface GetShippingLabelResponse
  */

package/dist/types/src/api-model/models/item.d.ts

@@ -23,7 +23,7 @@ export interface Item {
      */
     'itemSequenceNumber': number;
     /**
-     * Buyer\'s Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required.
+     * Buyer\'s Standard Identification Number (ASIN) of an item. Either `buyerProductIdentifier` or `vendorProductIdentifier` is required.
      * @type {string}
      * @memberof Item
      */

package/dist/types/src/api-model/models/label-data.d.ts

@@ -28,7 +28,7 @@ export interface LabelData {
      */
     'trackingNumber'?: string;
     /**
-     * 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.
+     * 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.
      * @type {string}
      * @memberof LabelData
      */

package/dist/types/src/api-model/models/packed-item.d.ts

@@ -11,7 +11,7 @@
  */
 import type { ItemQuantity } from './item-quantity';
 /**
- *
+ * Represents an item that has been packed into a container for shipping.
  * @export
  * @interface PackedItem
  */
@@ -23,7 +23,7 @@ export interface PackedItem {
      */
     'itemSequenceNumber': number;
     /**
-     * Buyer\'s Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required.
+     * Buyer\'s Standard Identification Number (ASIN) of an item. Either `buyerProductIdentifier` or `vendorProductIdentifier` is required.
      * @type {string}
      * @memberof PackedItem
      */

package/dist/types/src/api-model/models/packing-slip-list.d.ts

@@ -24,7 +24,7 @@ export interface PackingSlipList {
      */
     'pagination'?: Pagination;
     /**
-     *
+     * An array of packing slip objects.
      * @type {Array<PackingSlip>}
      * @memberof PackingSlipList
      */

package/dist/types/src/api-model/models/pagination.d.ts

@@ -10,13 +10,13 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * The pagination elements required to retrieve the remaining data.
  * @export
  * @interface Pagination
  */
 export interface Pagination {
     /**
-     * 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.
+     * 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.
      * @type {string}
      * @memberof Pagination
      */

package/dist/types/src/api-model/models/party-identification.d.ts

@@ -12,7 +12,7 @@
 import type { Address } from './address';
 import type { TaxRegistrationDetails } from './tax-registration-details';
 /**
- *
+ * Name, address and tax details of a party.
  * @export
  * @interface PartyIdentification
  */

package/dist/types/src/api-model/models/shipment-confirmation.d.ts

@@ -14,7 +14,7 @@ import type { Item } from './item';
 import type { PartyIdentification } from './party-identification';
 import type { ShipmentDetails } from './shipment-details';
 /**
- *
+ * Represents the confirmation details of a shipment, including the purchase order number and other shipment details.
  * @export
  * @interface ShipmentConfirmation
  */

package/dist/types/src/api-model/models/shipment-status-update.d.ts

@@ -12,7 +12,7 @@
 import type { PartyIdentification } from './party-identification';
 import type { StatusUpdateDetails } from './status-update-details';
 /**
- *
+ * Represents an update to the status of a shipment.
  * @export
  * @interface ShipmentStatusUpdate
  */

package/dist/types/src/api-model/models/shipping-label-list.d.ts

@@ -12,7 +12,7 @@
 import type { Pagination } from './pagination';
 import type { ShippingLabel } from './shipping-label';
 /**
- *
+ * Response payload with the list of shipping labels
  * @export
  * @interface ShippingLabelList
  */
@@ -24,7 +24,7 @@ export interface ShippingLabelList {
      */
     'pagination'?: Pagination;
     /**
-     *
+     * An array containing the details of the generated shipping labels.
      * @type {Array<ShippingLabel>}
      * @memberof ShippingLabelList
      */

package/dist/types/src/api-model/models/shipping-label-request.d.ts

@@ -12,7 +12,7 @@
 import type { Container } from './container';
 import type { PartyIdentification } from './party-identification';
 /**
- *
+ * Represents the request payload for creating a shipping label, containing the purchase order number, selling party, ship from party, and a list of containers or packages in the shipment.
  * @export
  * @interface ShippingLabelRequest
  */

package/dist/types/src/api-model/models/shipping-label.d.ts

@@ -12,7 +12,7 @@
 import type { LabelData } from './label-data';
 import type { PartyIdentification } from './party-identification';
 /**
- *
+ * Shipping label information for an order, including the purchase order number, selling party, ship from party, label format, and package details.
  * @export
  * @interface ShippingLabel
  */

package/dist/types/src/api-model/models/status-update-details-shipment-schedule.d.ts

@@ -10,25 +10,25 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Details for the scheduled delivery timeline for a shipment, including the estimated delivery date and time, as well as the start and end times of the appointment window for delivery.
  * @export
  * @interface StatusUpdateDetailsShipmentSchedule
  */
 export interface StatusUpdateDetailsShipmentSchedule {
     /**
-     * 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.
+     * 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`.
      * @type {string}
      * @memberof StatusUpdateDetailsShipmentSchedule
      */
     'estimatedDeliveryDateTime'?: string;
     /**
-     * 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.
+     * 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`.
      * @type {string}
      * @memberof StatusUpdateDetailsShipmentSchedule
      */
     'apptWindowStartDateTime'?: string;
     /**
-     * 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.
+     * 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`.
      * @type {string}
      * @memberof StatusUpdateDetailsShipmentSchedule
      */

package/dist/types/src/api-model/models/status-update-details.d.ts

@@ -18,25 +18,25 @@ import type { StatusUpdateDetailsShipmentSchedule } from './status-update-detail
  */
 export interface StatusUpdateDetails {
     /**
-     * This is required to be provided for every package and should match with the trackingNumber sent for the shipment confirmation.
+     * This is required to be provided for every package and should match with the `trackingNumber` sent for the shipment confirmation.
      * @type {string}
      * @memberof StatusUpdateDetails
      */
     'trackingNumber': string;
     /**
-     * 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).
+     * 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).
      * @type {string}
      * @memberof StatusUpdateDetails
      */
     'statusCode': string;
     /**
-     * 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).
+     * 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).
      * @type {string}
      * @memberof StatusUpdateDetails
      */
     'reasonCode': string;
     /**
-     * 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.
+     * 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`.
      * @type {string}
      * @memberof StatusUpdateDetails
      */

package/dist/types/src/api-model/models/submit-shipment-confirmations-request.d.ts

@@ -11,13 +11,13 @@
  */
 import type { ShipmentConfirmation } from './shipment-confirmation';
 /**
- *
+ * The request schema for the `submitShipmentConfirmations` operation.
  * @export
  * @interface SubmitShipmentConfirmationsRequest
  */
 export interface SubmitShipmentConfirmationsRequest {
     /**
-     *
+     * Array of `ShipmentConfirmation` objects, each representing confirmation details for a specific shipment.
      * @type {Array<ShipmentConfirmation>}
      * @memberof SubmitShipmentConfirmationsRequest
      */

package/dist/types/src/api-model/models/submit-shipment-confirmations-response.d.ts

@@ -11,7 +11,7 @@
  */
 import type { TransactionReference } from './transaction-reference';
 /**
- * The response schema for the submitShipmentConfirmations operation.
+ * The response schema for the `submitShipmentConfirmations` operation.
  * @export
  * @interface SubmitShipmentConfirmationsResponse
  */

package/dist/types/src/api-model/models/submit-shipment-status-updates-request.d.ts

@@ -11,13 +11,13 @@
  */
 import type { ShipmentStatusUpdate } from './shipment-status-update';
 /**
- *
+ * Represents the request payload for submitting updates to the status of shipments, containing an array of one or more `ShipmentStatusUpdate` objects.
  * @export
  * @interface SubmitShipmentStatusUpdatesRequest
  */
 export interface SubmitShipmentStatusUpdatesRequest {
     /**
-     *
+     * Contains a list of one or more `ShipmentStatusUpdate` objects, each representing an update to the status of a specific shipment.
      * @type {Array<ShipmentStatusUpdate>}
      * @memberof SubmitShipmentStatusUpdatesRequest
      */

package/dist/types/src/api-model/models/submit-shipment-status-updates-response.d.ts

@@ -11,7 +11,7 @@
  */
 import type { TransactionReference } from './transaction-reference';
 /**
- * The response schema for the submitShipmentStatusUpdates operation.
+ * The response schema for the `submitShipmentStatusUpdates` operation.
  * @export
  * @interface SubmitShipmentStatusUpdatesResponse
  */

package/dist/types/src/api-model/models/submit-shipping-labels-request.d.ts

@@ -11,13 +11,13 @@
  */
 import type { ShippingLabelRequest } from './shipping-label-request';
 /**
- *
+ * The request schema for the `submitShippingLabelRequest` operation.
  * @export
  * @interface SubmitShippingLabelsRequest
  */
 export interface SubmitShippingLabelsRequest {
     /**
-     *
+     * An array of shipping label requests to be processed.
      * @type {Array<ShippingLabelRequest>}
      * @memberof SubmitShippingLabelsRequest
      */

package/dist/types/src/api-model/models/submit-shipping-labels-response.d.ts

@@ -11,7 +11,7 @@
  */
 import type { TransactionReference } from './transaction-reference';
 /**
- * The response schema for the submitShippingLabelRequest operation.
+ * The response schema for the `submitShippingLabelRequest` operation.
  * @export
  * @interface SubmitShippingLabelsResponse
  */

package/dist/types/src/api-model/models/transaction-reference.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * Response containing the transaction ID.
  * @export
  * @interface TransactionReference
  */

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1",
   "author": "Bertrand Marron <bertrand@bizon.solutions>",
   "description": "The Selling Partner API for Direct Fulfillment Shipping provides programmatic access to a direct fulfillment vendor's shipping data.",
-  "version": "2.2.1",
+  "version": "2.3.1",
   "main": "dist/cjs/index.js",
   "module": "dist/es/index.js",
   "types": "dist/types/index.d.ts",
@@ -18,7 +18,7 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "@sp-api-sdk/common": "2.0.9",
+    "@sp-api-sdk/common": "2.0.11",
     "axios": "^1.7.2"
   },
   "repository": {
@@ -40,5 +40,5 @@
     "sp sdk",
     "vendor direct fulfillment shipping api"
   ],
-  "gitHead": "cce8c720364baf071322463e8e3ed29c322cc93a"
+  "gitHead": "6f3dfd53cad528b970ec29dfd12b0105b351464b"
 }