@whiplashmerch/whiplash-api-client 3.2.39 → 3.2.41

package/generated/data-contracts.ts

@@ -1481,6 +1481,7 @@ export interface ApiV2EntitiesOrder {
    *           Note: this field has a limit of 35 chars.
    */
   package_label_reference?: string | null;
+  package_label_reference_record?: ApiV2EntitiesPackageLabelReference;
   packages?: ApiV2EntitiesPackage[];
   /** url for this orders packing slip */
   packingslip_pdf_url?: string | null;
@@ -1959,6 +1960,30 @@ export interface ApiV2EntitiesPackage {
   updated_at?: string | null;
 }
 
+/** V2 */
+export interface ApiV2EntitiesPackageLabelReference {
+  /** the package label reference identifier 2 (max 35 characters) */
+  reference_identifier_2?: string | null;
+  /** the package label reference identifier 3 (max 35 characters) */
+  reference_identifier_3?: string | null;
+  /** the package label reference identifier 4 (max 35 characters) */
+  reference_identifier_4?: string | null;
+  /** the package label reference identifier 5 (max 35 characters) */
+  reference_identifier_5?: string | null;
+  /**
+   * the package label reference id
+   * @format int32
+   */
+  id?: number;
+  /**
+   * the package label reference order id
+   * @format int32
+   */
+  order_id?: number;
+  /** the package label reference identifier (max 35 characters) */
+  reference_identifier?: string | null;
+}
+
 /** V2 */
 export interface ApiV2EntitiesPackingRule {
   /** is the rule currently active? */
@@ -4164,12 +4189,12 @@ export interface ApiV21EntitiesOrder {
    */
   order_batch_id?: number | null;
   /**
-   * number of SKUs in this Order
+   * number of merch line items in this Order
    * @format int32
    */
   order_item_count?: number;
   /**
-   * total quantity of all SKUs in this Order
+   * total quantity across the merch line items in this Order
    * @format int32
    */
   order_item_quantity?: number;
@@ -4186,6 +4211,7 @@ export interface ApiV21EntitiesOrder {
    *           Note: this field has a limit of 35 chars.
    */
   package_label_reference?: string | null;
+  package_label_reference_record?: ApiV21EntitiesPackageLabelReference;
   /** url for this orders packing slip */
   packingslip_pdf_url?: string | null;
   /** the order payment type */
@@ -4557,6 +4583,30 @@ export interface ApiV21EntitiesOriginator {
   updated_at?: string;
 }
 
+/** V3 */
+export interface ApiV21EntitiesPackageLabelReference {
+  /** the package label reference identifier 2 (max 35 characters) */
+  reference_identifier_2?: string | null;
+  /** the package label reference identifier 3 (max 35 characters) */
+  reference_identifier_3?: string | null;
+  /** the package label reference identifier 4 (max 35 characters) */
+  reference_identifier_4?: string | null;
+  /** the package label reference identifier 5 (max 35 characters) */
+  reference_identifier_5?: string | null;
+  /**
+   * the package label reference id
+   * @format int32
+   */
+  id?: number;
+  /**
+   * the package label reference order id
+   * @format int32
+   */
+  order_id?: number;
+  /** the package label reference identifier (max 35 characters) */
+  reference_identifier?: string | null;
+}
+
 /** V3 */
 export interface ApiV21EntitiesPackingRule {
   /** is the rule currently active? */
@@ -7468,6 +7518,8 @@ export interface PostApiV21OrdersBulkRequest {
     /** Permission limited orders are not editable, but still may be processed/shipped */
     permissions_limited?: boolean;
     order_items?: string;
+    /** Full package label reference record. */
+    package_label_reference_record?: string;
     /** desired incoterm for the order */
     incoterm?: PostApiV21OrdersBulkRequestIncoterm;
     /**
@@ -7721,6 +7773,19 @@ export interface PostApiV21OrdersIdOrderItemsRequest {
   };
 }
 
+export interface PostApiV21OrdersIdPackageLabelReferenceRequest {
+  /** Reference identifier 2 (max 35 characters) */
+  reference_identifier_2?: string;
+  /** Reference identifier 3 (max 35 characters) */
+  reference_identifier_3?: string;
+  /** Reference identifier 4 (max 35 characters) */
+  reference_identifier_4?: string;
+  /** Reference identifier 5 (max 35 characters) */
+  reference_identifier_5?: string;
+  /** Reference identifier (max 35 characters) */
+  reference_identifier?: string;
+}
+
 export interface PostApiV21OrdersRequest {
   /** the order billing street address 1 */
   billing_address_1?: string;
@@ -8016,11 +8081,20 @@ export interface PostApiV21OrdersRequest {
     /** miscellaneous info for the originator */
     misc?: string;
   };
-  /**
-   * User-defined reference for shipping labels on packages.
-   *           Note: this field has a limit of 35 chars.
-   */
+  /** User-defined reference for shipping labels (max 35 chars). Prefer package_label_reference_attributes. */
   package_label_reference?: string;
+  package_label_reference_attributes?: {
+    /** the package label reference identifier (max 35 characters) */
+    reference_identifier?: string;
+    /** the package label reference identifier 2 (max 35 characters) */
+    reference_identifier_2?: string;
+    /** the package label reference identifier 3 (max 35 characters) */
+    reference_identifier_3?: string;
+    /** the package label reference identifier 4 (max 35 characters) */
+    reference_identifier_4?: string;
+    /** the package label reference identifier 5 (max 35 characters) */
+    reference_identifier_5?: string;
+  };
   /** the order payment type */
   payment_type?: PostApiV21OrdersRequestPaymentType;
   /** Permission limited orders are not editable, but still may be processed/shipped */
@@ -9388,6 +9462,8 @@ export interface PostApiV2OrdersBulkRequest {
     /** Permission limited orders are not editable, but still may be processed/shipped */
     permissions_limited?: boolean;
     order_items?: string;
+    /** Full package label reference record. */
+    package_label_reference_record?: string;
     /** desired incoterm for the order */
     incoterm?: PostApiV2OrdersBulkRequestIncoterm;
     /**
@@ -9641,6 +9717,19 @@ export interface PostApiV2OrdersIdOrderItemsRequest {
   };
 }
 
+export interface PostApiV2OrdersIdPackageLabelReferenceRequest {
+  /** Reference identifier 2 (max 35 characters) */
+  reference_identifier_2?: string;
+  /** Reference identifier 3 (max 35 characters) */
+  reference_identifier_3?: string;
+  /** Reference identifier 4 (max 35 characters) */
+  reference_identifier_4?: string;
+  /** Reference identifier 5 (max 35 characters) */
+  reference_identifier_5?: string;
+  /** Reference identifier (max 35 characters) */
+  reference_identifier?: string;
+}
+
 export interface PostApiV2OrdersRequest {
   /** the order billing street address 1 */
   billing_address_1?: string;
@@ -9936,11 +10025,20 @@ export interface PostApiV2OrdersRequest {
     /** miscellaneous info for the originator */
     misc?: string;
   };
-  /**
-   * User-defined reference for shipping labels on packages.
-   *           Note: this field has a limit of 35 chars.
-   */
+  /** User-defined reference for shipping labels (max 35 chars). Prefer package_label_reference_attributes. */
   package_label_reference?: string;
+  package_label_reference_attributes?: {
+    /** the package label reference identifier (max 35 characters) */
+    reference_identifier?: string;
+    /** the package label reference identifier 2 (max 35 characters) */
+    reference_identifier_2?: string;
+    /** the package label reference identifier 3 (max 35 characters) */
+    reference_identifier_3?: string;
+    /** the package label reference identifier 4 (max 35 characters) */
+    reference_identifier_4?: string;
+    /** the package label reference identifier 5 (max 35 characters) */
+    reference_identifier_5?: string;
+  };
   /** the order payment type */
   payment_type?: PostApiV2OrdersRequestPaymentType;
   /** Permission limited orders are not editable, but still may be processed/shipped */
@@ -11355,11 +11453,20 @@ export interface PutApiV21OrdersIdRequest {
   order_orig?: string;
   /** the order type */
   order_type?: PutApiV21OrdersIdRequestOrderType;
-  /**
-   * User-defined reference for shipping labels on packages.
-   *           Note: this field has a limit of 35 chars.
-   */
+  /** User-defined reference for shipping labels (max 35 chars). Prefer package_label_reference_attributes. */
   package_label_reference?: string;
+  package_label_reference_attributes?: {
+    /** the package label reference identifier (max 35 characters) */
+    reference_identifier?: string;
+    /** the package label reference identifier 2 (max 35 characters) */
+    reference_identifier_2?: string;
+    /** the package label reference identifier 3 (max 35 characters) */
+    reference_identifier_3?: string;
+    /** the package label reference identifier 4 (max 35 characters) */
+    reference_identifier_4?: string;
+    /** the package label reference identifier 5 (max 35 characters) */
+    reference_identifier_5?: string;
+  };
   /** url for this orders packing slip */
   packingslip_pdf_url?: string;
   /** the order payment type */
@@ -11552,6 +11659,19 @@ export interface PutApiV21OrdersIdRequest {
   };
 }
 
+export interface PutApiV21PackageLabelReferencesIdRequest {
+  /** Reference identifier 2 (max 35 characters) */
+  reference_identifier_2?: string;
+  /** Reference identifier 3 (max 35 characters) */
+  reference_identifier_3?: string;
+  /** Reference identifier 4 (max 35 characters) */
+  reference_identifier_4?: string;
+  /** Reference identifier 5 (max 35 characters) */
+  reference_identifier_5?: string;
+  /** Reference identifier (max 35 characters) */
+  reference_identifier?: string;
+}
+
 export interface PutApiV21ShipnoticeItemsIdMetaFieldsRequest {
   /** Included meta fields for associations */
   association_fields?: object;
@@ -12555,11 +12675,20 @@ export interface PutApiV2OrdersIdRequest {
   order_orig?: string;
   /** the order type */
   order_type?: PutApiV2OrdersIdRequestOrderType;
-  /**
-   * User-defined reference for shipping labels on packages.
-   *           Note: this field has a limit of 35 chars.
-   */
+  /** User-defined reference for shipping labels (max 35 chars). Prefer package_label_reference_attributes. */
   package_label_reference?: string;
+  package_label_reference_attributes?: {
+    /** the package label reference identifier (max 35 characters) */
+    reference_identifier?: string;
+    /** the package label reference identifier 2 (max 35 characters) */
+    reference_identifier_2?: string;
+    /** the package label reference identifier 3 (max 35 characters) */
+    reference_identifier_3?: string;
+    /** the package label reference identifier 4 (max 35 characters) */
+    reference_identifier_4?: string;
+    /** the package label reference identifier 5 (max 35 characters) */
+    reference_identifier_5?: string;
+  };
   /** url for this orders packing slip */
   packingslip_pdf_url?: string;
   /** the order payment type */
@@ -12752,6 +12881,19 @@ export interface PutApiV2OrdersIdRequest {
   };
 }
 
+export interface PutApiV2PackageLabelReferencesIdRequest {
+  /** Reference identifier 2 (max 35 characters) */
+  reference_identifier_2?: string;
+  /** Reference identifier 3 (max 35 characters) */
+  reference_identifier_3?: string;
+  /** Reference identifier 4 (max 35 characters) */
+  reference_identifier_4?: string;
+  /** Reference identifier 5 (max 35 characters) */
+  reference_identifier_5?: string;
+  /** Reference identifier (max 35 characters) */
+  reference_identifier?: string;
+}
+
 export interface PutApiV2ShipnoticeItemsIdMetaFieldsRequest {
   /** Included meta fields for associations */
   association_fields?: object;

package/generated/index.ts

@@ -11,6 +11,7 @@ export * from './OrderItems';
 export * from './OrderTotes';
 export * from './Orders';
 export * from './Originators';
+export * from './PackageLabelReferences';
 export * from './Packages';
 export * from './Projects';
 export * from './Scancodes';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whiplashmerch/whiplash-api-client",
-  "version": "3.2.39",
+  "version": "3.2.41",
   "description": "",
   "devDependencies": {},
   "scripts": {