@sp-api-sdk/vendor-shipments-api-v1 2.6.0 → 3.0.0

package/dist/types/api-model/models/get-shipment-details-response.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/get-shipment-labels.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { TransportationLabels } from './transportation-labels';
+/**
+ * The response schema for the GetShipmentLabels operation.
+ * @export
+ * @interface GetShipmentLabels
+ */
+export interface GetShipmentLabels {
+    /**
+     *
+     * @type {TransportationLabels}
+     * @memberof GetShipmentLabels
+     */
+    'payload'?: TransportationLabels;
+    /**
+     * A list of error responses returned when a request is unsuccessful.
+     * @type {Array<Error>}
+     * @memberof GetShipmentLabels
+     */
+    'errors'?: Array<Error>;
+}

package/dist/types/api-model/models/import-details.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/index.d.ts

@@ -11,25 +11,30 @@ export * from './dimensions';
 export * from './duration';
 export * from './expiry';
 export * from './get-shipment-details-response';
+export * from './get-shipment-labels';
 export * from './import-details';
 export * from './inner-containers-details';
 export * from './item';
 export * from './item-details';
 export * from './item-quantity';
+export * from './label-data';
 export * from './location';
 export * from './model-error';
 export * from './money';
 export * from './package-item-details';
 export * from './packed-items';
+export * from './packed-quantity';
 export * from './pagination';
 export * from './pallet';
 export * from './party-identification';
+export * from './purchase-order-item-details';
 export * from './purchase-order-items';
 export * from './purchase-orders';
 export * from './route';
 export * from './shipment';
 export * from './shipment-confirmation';
 export * from './shipment-details';
+export * from './shipment-information';
 export * from './shipment-measurements';
 export * from './shipment-status-details';
 export * from './stop';
@@ -39,8 +44,11 @@ export * from './submit-shipments';
 export * from './tax-registration-details';
 export * from './total-weight';
 export * from './transaction-reference';
+export * from './transport-label';
 export * from './transport-shipment-measurements';
 export * from './transportation-details';
 export * from './transportation-details-for-shipment-confirmation';
+export * from './transportation-labels';
+export * from './vendor-details';
 export * from './volume';
 export * from './weight';

package/dist/types/api-model/models/inner-containers-details.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -0,0 +1,52 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Label details as part of the transport label response
+ * @export
+ * @interface LabelData
+ */
+export interface LabelData {
+    /**
+     * A sequential number assigned to each label within a shipment.
+     * @type {number}
+     * @memberof LabelData
+     */
+    'labelSequenceNumber'?: number;
+    /**
+     * The format of the label.
+     * @type {string}
+     * @memberof LabelData
+     */
+    'labelFormat'?: LabelDataLabelFormatEnum;
+    /**
+     * Unique identification of the carrier.
+     * @type {string}
+     * @memberof LabelData
+     */
+    'carrierCode'?: string;
+    /**
+     * Tracking Id for the transportation.
+     * @type {string}
+     * @memberof LabelData
+     */
+    'trackingId'?: string;
+    /**
+     * The base-64 encoded string that represents the shipment label.
+     * @type {string}
+     * @memberof LabelData
+     */
+    'label'?: string;
+}
+export declare const LabelDataLabelFormatEnum: {
+    readonly Pdf: "PDF";
+};
+export type LabelDataLabelFormatEnum = typeof LabelDataLabelFormatEnum[keyof typeof LabelDataLabelFormatEnum];

package/dist/types/api-model/models/location.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/model-error.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/money.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -0,0 +1,41 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Details of item quantity.
+ * @export
+ * @interface PackedQuantity
+ */
+export interface PackedQuantity {
+    /**
+     * Amount of units shipped for a specific item at a shipment level. If the item is present only in certain cartons or pallets within the shipment, please provide this at the appropriate carton or pallet level.
+     * @type {number}
+     * @memberof PackedQuantity
+     */
+    'amount': number;
+    /**
+     * Unit of measure for the shipped quantity.
+     * @type {string}
+     * @memberof PackedQuantity
+     */
+    'unitOfMeasure': PackedQuantityUnitOfMeasureEnum;
+    /**
+     * The case size, in the event that we ordered using cases. Otherwise, 1.
+     * @type {number}
+     * @memberof PackedQuantity
+     */
+    'unitSize'?: number;
+}
+export declare const PackedQuantityUnitOfMeasureEnum: {
+    readonly Cases: "Cases";
+    readonly Eaches: "Eaches";
+};
+export type PackedQuantityUnitOfMeasureEnum = typeof PackedQuantityUnitOfMeasureEnum[keyof typeof PackedQuantityUnitOfMeasureEnum];

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/pallet.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/purchase-order-item-details.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Money } from './money';
+/**
+ * Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate.
+ * @export
+ * @interface PurchaseOrderItemDetails
+ */
+export interface PurchaseOrderItemDetails {
+    /**
+     *
+     * @type {Money}
+     * @memberof PurchaseOrderItemDetails
+     */
+    'maximumRetailPrice'?: Money;
+}

package/dist/types/api-model/models/purchase-order-items.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/purchase-orders.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/route.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -0,0 +1,73 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { PartyIdentification } from './party-identification';
+import type { VendorDetails } from './vendor-details';
+/**
+ * Shipment Information details for Label request.
+ * @export
+ * @interface ShipmentInformation
+ */
+export interface ShipmentInformation {
+    /**
+     *
+     * @type {VendorDetails}
+     * @memberof ShipmentInformation
+     */
+    'vendorDetails'?: VendorDetails;
+    /**
+     * The buyer reference number is a unique identifier generated by the buyer for all Collect and WePay shipments.
+     * @type {string}
+     * @memberof ShipmentInformation
+     */
+    'buyerReferenceNumber'?: string;
+    /**
+     *
+     * @type {PartyIdentification}
+     * @memberof ShipmentInformation
+     */
+    'shipToParty'?: PartyIdentification;
+    /**
+     *
+     * @type {PartyIdentification}
+     * @memberof ShipmentInformation
+     */
+    'shipFromParty'?: PartyIdentification;
+    /**
+     * Vendor Warehouse ID from where the shipment is scheduled to be picked up by buyer / Carrier.
+     * @type {string}
+     * @memberof ShipmentInformation
+     */
+    'warehouseId'?: string;
+    /**
+     * Unique Id with  which  the shipment can be tracked for Small Parcels.
+     * @type {string}
+     * @memberof ShipmentInformation
+     */
+    'masterTrackingId'?: string;
+    /**
+     * Number of Labels that are created as part of this shipment.
+     * @type {number}
+     * @memberof ShipmentInformation
+     */
+    'totalLabelCount'?: number;
+    /**
+     * Type of shipment whether it is Small Parcel
+     * @type {string}
+     * @memberof ShipmentInformation
+     */
+    'shipMode'?: ShipmentInformationShipModeEnum;
+}
+export declare const ShipmentInformationShipModeEnum: {
+    readonly SmallParcel: "SmallParcel";
+    readonly Ltl: "LTL";
+};
+export type ShipmentInformationShipModeEnum = typeof ShipmentInformationShipModeEnum[keyof typeof ShipmentInformationShipModeEnum];

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/stop.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/submit-shipments.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/tax-registration-details.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/total-weight.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1
@@ -10,13 +10,13 @@
  * Do not edit the class manually.
  */
 /**
- * Amount of units shipped for items sold by weight at a shipment level.
+ * The total weight of units that are sold by weight in a shipment.
  * @export
  * @interface TotalWeight
  */
 export interface TotalWeight {
     /**
-     * This field represents weight unit of measure of items that are ordered by cases and supporting priced by weight.
+     * The unit of measure for the weight of items that are ordered by cases and support pricing by weight.
      * @type {string}
      * @memberof TotalWeight
      */

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

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

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

@@ -0,0 +1,38 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { LabelData } from './label-data';
+import type { ShipmentInformation } from './shipment-information';
+/**
+ * A list of one or more ShipmentLabels.
+ * @export
+ * @interface TransportLabel
+ */
+export interface TransportLabel {
+    /**
+     * Date on which label is created.
+     * @type {string}
+     * @memberof TransportLabel
+     */
+    'labelCreateDateTime'?: string;
+    /**
+     *
+     * @type {ShipmentInformation}
+     * @memberof TransportLabel
+     */
+    'shipmentInformation'?: ShipmentInformation;
+    /**
+     * Indicates the label data,format and type associated .
+     * @type {Array<LabelData>}
+     * @memberof TransportLabel
+     */
+    'labelData'?: Array<LabelData>;
+}

package/dist/types/api-model/models/transport-shipment-measurements.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/transportation-details-for-shipment-confirmation.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/transportation-details.d.ts

@@ -1,5 +1,5 @@
 /**
- * Vendor Shipments v1
+ * Selling Partner API for Retail Procurement Shipments
  * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
  *
  * The version of the OpenAPI document: v1

package/dist/types/api-model/models/transportation-labels.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Pagination } from './pagination';
+import type { TransportLabel } from './transport-label';
+/**
+ * The request schema for the GetShipmentLabels operation.
+ * @export
+ * @interface TransportationLabels
+ */
+export interface TransportationLabels {
+    /**
+     *
+     * @type {Pagination}
+     * @memberof TransportationLabels
+     */
+    'pagination'?: Pagination;
+    /**
+     * A list of one or more ShipmentLabels.
+     * @type {Array<TransportLabel>}
+     * @memberof TransportationLabels
+     */
+    'transportLabels'?: Array<TransportLabel>;
+}

package/dist/types/api-model/models/vendor-details.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Selling Partner API for Retail Procurement Shipments
+ * The Selling Partner API for Retail Procurement Shipments provides programmatic access to retail shipping data for vendors.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { PartyIdentification } from './party-identification';
+/**
+ * Vendor Details as part of Label response.
+ * @export
+ * @interface VendorDetails
+ */
+export interface VendorDetails {
+    /**
+     *
+     * @type {PartyIdentification}
+     * @memberof VendorDetails
+     */
+    'sellingParty'?: PartyIdentification;
+    /**
+     * Unique vendor shipment id which is not used in last 365 days
+     * @type {string}
+     * @memberof VendorDetails
+     */
+    'vendorShipmentIdentifier'?: string;
+}