@whiplashmerch/whiplash-api-client 3.2.39 → 3.2.41

package/dist/generated/Orders.d.ts

@@ -1,4 +1,4 @@
-import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesCount, ApiV21EntitiesCustomsInfo, ApiV21EntitiesIncident, ApiV21EntitiesListValue, ApiV21EntitiesMessage, ApiV21EntitiesOrder, ApiV21EntitiesOrderDocument, ApiV21EntitiesOrderEvent, ApiV21EntitiesOrderItem, ApiV21EntitiesOrderItemInventoryInfo, ApiV21EntitiesOrderItemLotMap, ApiV21EntitiesOrderMetadata, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPackingRule, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesShippingDocument, ApiV21EntitiesShippingRate, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesListValue, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemInventoryInfo, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOrderMetadata, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesPackingRule, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesShippingDocument, ApiV2EntitiesShippingRate, ApiV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsCountParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsInventoryInfoParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesCountParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdPackingRulesCountParams, GetApiV21OrdersIdPackingRulesParams, GetApiV21OrdersIdShippingDocumentsParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsCountParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsInventoryInfoParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesCountParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdPackingRulesCountParams, GetApiV2OrdersIdPackingRulesParams, GetApiV2OrdersIdShippingDocumentsParams, GetApiV2OrdersIdTraitsParams, GetApiV2OrdersParams, PostApiV21OrdersBulkRequest, PostApiV21OrdersIdIncidentsRequest, PostApiV21OrdersIdMessagesRequest, PostApiV21OrdersIdOrderDocumentsRequest, PostApiV21OrdersIdOrderItemsRequest, PostApiV21OrdersIdPackagesRequest, PostApiV21OrdersIdRuleDismissalsRequest, PostApiV21OrdersRequest, PostApiV2OrdersBulkRequest, PostApiV2OrdersIdIncidentsRequest, PostApiV2OrdersIdMessagesRequest, PostApiV2OrdersIdOrderDocumentsRequest, PostApiV2OrdersIdOrderItemsRequest, PostApiV2OrdersIdPackagesRequest, PostApiV2OrdersIdRuleDismissalsRequest, PostApiV2OrdersRequest, PutApiV21OrdersIdCallActionRequest, PutApiV21OrdersIdCallAsyncActionRequest, PutApiV21OrdersIdCustomsInfoRequest, PutApiV21OrdersIdMetaFieldsRequest, PutApiV21OrdersIdRequest, PutApiV21OrdersIdWholesaleRequest, PutApiV2OrdersIdCallActionRequest, PutApiV2OrdersIdCallAsyncActionRequest, PutApiV2OrdersIdCustomsInfoRequest, PutApiV2OrdersIdMetaFieldsRequest, PutApiV2OrdersIdRequest, PutApiV2OrdersIdWholesaleRequest } from "./data-contracts";
+import { ApiSharedEntitiesAudits, ApiSharedEntitiesMetaFields, ApiSharedEntitiesSidekiqBatch, ApiV21EntitiesCount, ApiV21EntitiesCustomsInfo, ApiV21EntitiesIncident, ApiV21EntitiesListValue, ApiV21EntitiesMessage, ApiV21EntitiesOrder, ApiV21EntitiesOrderDocument, ApiV21EntitiesOrderEvent, ApiV21EntitiesOrderItem, ApiV21EntitiesOrderItemInventoryInfo, ApiV21EntitiesOrderItemLotMap, ApiV21EntitiesOrderMetadata, ApiV21EntitiesOriginator, ApiV21EntitiesPackage, ApiV21EntitiesPackageLabelReference, ApiV21EntitiesPackingRule, ApiV21EntitiesPostResponse, ApiV21EntitiesResult, ApiV21EntitiesRuleDismissal, ApiV21EntitiesSerialNumber, ApiV21EntitiesShippingDocument, ApiV21EntitiesShippingRate, ApiV21EntitiesWholesale, ApiV2EntitiesCount, ApiV2EntitiesCustomsInfo, ApiV2EntitiesIncident, ApiV2EntitiesListValue, ApiV2EntitiesMessage, ApiV2EntitiesOrder, ApiV2EntitiesOrderDocument, ApiV2EntitiesOrderEvent, ApiV2EntitiesOrderItem, ApiV2EntitiesOrderItemInventoryInfo, ApiV2EntitiesOrderItemLotMap, ApiV2EntitiesOrderMetadata, ApiV2EntitiesOriginator, ApiV2EntitiesPackage, ApiV2EntitiesPackageLabelReference, ApiV2EntitiesPackingRule, ApiV2EntitiesResult, ApiV2EntitiesRuleDismissal, ApiV2EntitiesSerialNumber, ApiV2EntitiesShippingDocument, ApiV2EntitiesShippingRate, ApiV2EntitiesWholesale, GetApiV21OrdersAggregateParams, GetApiV21OrdersCountParams, GetApiV21OrdersIdCallTraitParams, GetApiV21OrdersIdEventsCountParams, GetApiV21OrdersIdEventsParams, GetApiV21OrdersIdIncidentsCountParams, GetApiV21OrdersIdIncidentsParams, GetApiV21OrdersIdMessagesCountParams, GetApiV21OrdersIdMessagesParams, GetApiV21OrdersIdMetaFieldsParams, GetApiV21OrdersIdOrderDocumentsCountParams, GetApiV21OrdersIdOrderDocumentsParams, GetApiV21OrdersIdOrderItemsCountParams, GetApiV21OrdersIdOrderItemsInventoryInfoParams, GetApiV21OrdersIdOrderItemsParams, GetApiV21OrdersIdPackagesCountParams, GetApiV21OrdersIdPackagesParams, GetApiV21OrdersIdPackingRulesCountParams, GetApiV21OrdersIdPackingRulesParams, GetApiV21OrdersIdShippingDocumentsParams, GetApiV21OrdersIdTraitsParams, GetApiV21OrdersParams, GetApiV2OrdersAggregateParams, GetApiV2OrdersCountParams, GetApiV2OrdersIdCallTraitParams, GetApiV2OrdersIdEventsCountParams, GetApiV2OrdersIdEventsParams, GetApiV2OrdersIdIncidentsCountParams, GetApiV2OrdersIdIncidentsParams, GetApiV2OrdersIdMessagesCountParams, GetApiV2OrdersIdMessagesParams, GetApiV2OrdersIdMetaFieldsParams, GetApiV2OrdersIdOrderDocumentsCountParams, GetApiV2OrdersIdOrderDocumentsParams, GetApiV2OrdersIdOrderItemsCountParams, GetApiV2OrdersIdOrderItemsInventoryInfoParams, GetApiV2OrdersIdOrderItemsParams, GetApiV2OrdersIdPackagesCountParams, GetApiV2OrdersIdPackagesParams, GetApiV2OrdersIdPackingRulesCountParams, GetApiV2OrdersIdPackingRulesParams, GetApiV2OrdersIdShippingDocumentsParams, GetApiV2OrdersIdTraitsParams, GetApiV2OrdersParams, PostApiV21OrdersBulkRequest, PostApiV21OrdersIdIncidentsRequest, PostApiV21OrdersIdMessagesRequest, PostApiV21OrdersIdOrderDocumentsRequest, PostApiV21OrdersIdOrderItemsRequest, PostApiV21OrdersIdPackageLabelReferenceRequest, PostApiV21OrdersIdPackagesRequest, PostApiV21OrdersIdRuleDismissalsRequest, PostApiV21OrdersRequest, PostApiV2OrdersBulkRequest, PostApiV2OrdersIdIncidentsRequest, PostApiV2OrdersIdMessagesRequest, PostApiV2OrdersIdOrderDocumentsRequest, PostApiV2OrdersIdOrderItemsRequest, PostApiV2OrdersIdPackageLabelReferenceRequest, PostApiV2OrdersIdPackagesRequest, PostApiV2OrdersIdRuleDismissalsRequest, PostApiV2OrdersRequest, PutApiV21OrdersIdCallActionRequest, PutApiV21OrdersIdCallAsyncActionRequest, PutApiV21OrdersIdCustomsInfoRequest, PutApiV21OrdersIdMetaFieldsRequest, PutApiV21OrdersIdRequest, PutApiV21OrdersIdWholesaleRequest, PutApiV2OrdersIdCallActionRequest, PutApiV2OrdersIdCallAsyncActionRequest, PutApiV2OrdersIdCustomsInfoRequest, PutApiV2OrdersIdMetaFieldsRequest, PutApiV2OrdersIdRequest, PutApiV2OrdersIdWholesaleRequest } from "./data-contracts";
 import { HttpClient, RequestParams } from "./http-client";
 /**
  * @description Retrieves a list of orders
@@ -333,6 +333,24 @@ export declare const getApiV2OrdersIdOrderItemsInventoryInfo: (client: HttpClien
  * @request GET:/api/v2/orders/{id}/originator
  */
 export declare const getApiV2OrdersIdOriginator: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesOriginator>;
+/**
+ * @description Retrieve the package label reference for an order
+ *
+ * @tags orders
+ * @name GetApiV2OrdersIdPackageLabelReference
+ * @summary Retrieve package label reference
+ * @request GET:/api/v2/orders/{id}/package_label_reference
+ */
+export declare const getApiV2OrdersIdPackageLabelReference: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesPackageLabelReference>;
+/**
+ * @description Create a package label reference for an order
+ *
+ * @tags orders
+ * @name PostApiV2OrdersIdPackageLabelReference
+ * @summary Create a package label reference
+ * @request POST:/api/v2/orders/{id}/package_label_reference
+ */
+export declare const postApiV2OrdersIdPackageLabelReference: (client: HttpClient, id: number, data: PostApiV2OrdersIdPackageLabelReferenceRequest, params?: RequestParams) => Promise<ApiV2EntitiesPackageLabelReference>;
 /**
  * @description Get all packages for an order
  *
@@ -810,6 +828,24 @@ export declare const getApiV21OrdersIdOrderItemsInventoryInfo: (client: HttpClie
  * @request GET:/api/v2.1/orders/{id}/originator
  */
 export declare const getApiV21OrdersIdOriginator: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesOriginator>;
+/**
+ * @description Retrieve the package label reference for an order
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdPackageLabelReference
+ * @summary Retrieve package label reference
+ * @request GET:/api/v2.1/orders/{id}/package_label_reference
+ */
+export declare const getApiV21OrdersIdPackageLabelReference: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesPackageLabelReference>;
+/**
+ * @description Create a package label reference for an order
+ *
+ * @tags orders
+ * @name PostApiV21OrdersIdPackageLabelReference
+ * @summary Create a package label reference
+ * @request POST:/api/v2.1/orders/{id}/package_label_reference
+ */
+export declare const postApiV21OrdersIdPackageLabelReference: (client: HttpClient, id: number, data: PostApiV21OrdersIdPackageLabelReferenceRequest, params?: RequestParams) => Promise<ApiV21EntitiesPostResponse>;
 /**
  * @description Get all packages for an order
  *

package/dist/generated/PackageLabelReferences.d.ts

@@ -0,0 +1,56 @@
+import { ApiV21EntitiesPackageLabelReference, ApiV2EntitiesPackageLabelReference, PutApiV21PackageLabelReferencesIdRequest, PutApiV2PackageLabelReferencesIdRequest } from "./data-contracts";
+import { HttpClient, RequestParams } from "./http-client";
+/**
+ * @description Retrieve a package label reference
+ *
+ * @tags package_label_references
+ * @name GetApiV2PackageLabelReferencesId
+ * @summary Retrieve a package label reference
+ * @request GET:/api/v2/package_label_references/{id}
+ */
+export declare const getApiV2PackageLabelReferencesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV2EntitiesPackageLabelReference>;
+/**
+ * @description Update a package label reference
+ *
+ * @tags package_label_references
+ * @name PutApiV2PackageLabelReferencesId
+ * @summary Update a package label reference
+ * @request PUT:/api/v2/package_label_references/{id}
+ */
+export declare const putApiV2PackageLabelReferencesId: (client: HttpClient, id: number, data: PutApiV2PackageLabelReferencesIdRequest, params?: RequestParams) => Promise<ApiV2EntitiesPackageLabelReference>;
+/**
+ * @description Destroy a package label reference
+ *
+ * @tags package_label_references
+ * @name DeleteApiV2PackageLabelReferencesId
+ * @summary Destroy a package label reference
+ * @request DELETE:/api/v2/package_label_references/{id}
+ */
+export declare const deleteApiV2PackageLabelReferencesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;
+/**
+ * @description Retrieve a package label reference
+ *
+ * @tags package_label_references
+ * @name GetApiV21PackageLabelReferencesId
+ * @summary Retrieve a package label reference
+ * @request GET:/api/v2.1/package_label_references/{id}
+ */
+export declare const getApiV21PackageLabelReferencesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<ApiV21EntitiesPackageLabelReference>;
+/**
+ * @description Update a package label reference
+ *
+ * @tags package_label_references
+ * @name PutApiV21PackageLabelReferencesId
+ * @summary Update a package label reference
+ * @request PUT:/api/v2.1/package_label_references/{id}
+ */
+export declare const putApiV21PackageLabelReferencesId: (client: HttpClient, id: number, data: PutApiV21PackageLabelReferencesIdRequest, params?: RequestParams) => Promise<void>;
+/**
+ * @description Destroy a package label reference
+ *
+ * @tags package_label_references
+ * @name DeleteApiV21PackageLabelReferencesId
+ * @summary Destroy a package label reference
+ * @request DELETE:/api/v2.1/package_label_references/{id}
+ */
+export declare const deleteApiV21PackageLabelReferencesId: (client: HttpClient, id: number, params?: RequestParams) => Promise<void>;

package/dist/generated/data-contracts.d.ts

@@ -2841,6 +2841,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;
@@ -3779,6 +3780,29 @@ 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? */
     active?: boolean | null;
@@ -8057,12 +8081,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;
@@ -8079,6 +8103,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 */
@@ -8991,6 +9016,29 @@ export interface ApiV21EntitiesPackage {
     updated_at?: string | null;
 }
 /** 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? */
     active?: boolean | null;
@@ -18390,6 +18438,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;
         /**
@@ -18690,6 +18740,18 @@ export interface PostApiV21OrdersIdOrderItemsRequest {
         ih_category?: string;
     };
 }
+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 PostApiV21OrdersIdPackagesRequest {
     /** the package dimensional weight (in ounces) */
     actual_dimensional_weight?: string;
@@ -19021,11 +19083,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 */
@@ -21898,6 +21969,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;
         /**
@@ -22198,6 +22271,18 @@ export interface PostApiV2OrdersIdOrderItemsRequest {
         ih_category?: string;
     };
 }
+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 PostApiV2OrdersIdPackagesRequest {
     /** the package dimensional weight (in ounces) */
     actual_dimensional_weight?: string;
@@ -22529,11 +22614,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 */
@@ -25371,11 +25465,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 */
@@ -25669,6 +25772,18 @@ export interface PutApiV21OriginatorsIdRequest {
      */
     last_notified_at?: string;
 }
+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 PutApiV21PackagesIdCallActionRequest {
     action?: string;
     /** Method params */
@@ -28228,11 +28343,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 */
@@ -28526,6 +28650,18 @@ export interface PutApiV2OriginatorsIdRequest {
      */
     last_notified_at?: string;
 }
+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 PutApiV2PackagesIdCallActionRequest {
     action?: string;
     /** Method params */

package/dist/generated/index.d.ts

@@ -45,6 +45,7 @@ export * from './OrderItems';
 export * from './OrderTotes';
 export * from './Orders';
 export * from './Originators';
+export * from './PackageLabelReferences';
 export * from './Packages';
 export * from './PalletLocations';
 export * from './Pallets';

package/dist/mock-data/index.d.ts

@@ -85,6 +85,7 @@ export * from './v2_1/item/single';
 export * from './v2_1/order/processing';
 export * from './v2_1/shipnotice/processing';
 export * from './v2_1/originator/created';
+export * from './v2_1/package-label-reference/created';
 export * from './v2_1/package/created';
 export * from './v2_1/pallet-location/created';
 export * from './v2_1/pallet/created';

package/dist/mock-data/v2_1/package-label-reference/created.d.ts

@@ -0,0 +1 @@
+export declare const ApiV21PackageLabelReferenceCreatedExample = "{\"id\":123}";

package/generated/Orders.ts

@@ -18,6 +18,7 @@ import {
   ApiV21EntitiesOrderDocument,
   ApiV21EntitiesOrderEvent,
   ApiV21EntitiesOrderItem,
+  ApiV21EntitiesPackageLabelReference,
   ApiV21EntitiesPackingRule,
   ApiV21EntitiesPostResponse,
   ApiV21EntitiesResult,
@@ -30,6 +31,7 @@ import {
   ApiV2EntitiesOrderDocument,
   ApiV2EntitiesOrderEvent,
   ApiV2EntitiesOrderItem,
+  ApiV2EntitiesPackageLabelReference,
   ApiV2EntitiesPackingRule,
   ApiV2EntitiesResult,
   ApiV2EntitiesSerialNumber,
@@ -62,10 +64,12 @@ import {
   PostApiV21OrdersBulkRequest,
   PostApiV21OrdersIdOrderDocumentsRequest,
   PostApiV21OrdersIdOrderItemsRequest,
+  PostApiV21OrdersIdPackageLabelReferenceRequest,
   PostApiV21OrdersRequest,
   PostApiV2OrdersBulkRequest,
   PostApiV2OrdersIdOrderDocumentsRequest,
   PostApiV2OrdersIdOrderItemsRequest,
+  PostApiV2OrdersIdPackageLabelReferenceRequest,
   PostApiV2OrdersRequest,
   PutApiV21OrdersIdCallActionRequest,
   PutApiV21OrdersIdMetaFieldsRequest,
@@ -463,6 +467,45 @@ export const getApiV2OrdersIdOrderItemsCount = (
     ...params,
   });
 };
+/**
+ * @description Retrieve the package label reference for an order
+ *
+ * @tags orders
+ * @name GetApiV2OrdersIdPackageLabelReference
+ * @summary Retrieve package label reference
+ * @request GET:/api/v2/orders/{id}/package_label_reference
+ */
+export const getApiV2OrdersIdPackageLabelReference = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<ApiV2EntitiesPackageLabelReference, ApiSharedEntitiesApiError>({
+    path: `/api/v2/orders/${id}/package_label_reference`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Create a package label reference for an order
+ *
+ * @tags orders
+ * @name PostApiV2OrdersIdPackageLabelReference
+ * @summary Create a package label reference
+ * @request POST:/api/v2/orders/{id}/package_label_reference
+ */
+export const postApiV2OrdersIdPackageLabelReference = (
+  client: HttpClient,
+  id: number,
+  data: PostApiV2OrdersIdPackageLabelReferenceRequest,
+  params: RequestParams = {},
+) => {
+  return client.request<ApiV2EntitiesPackageLabelReference, ApiSharedEntitiesApiError>({
+    path: `/api/v2/orders/${id}/package_label_reference`,
+    method: "POST",
+    body: data,
+    type: ContentType.Json,
+    format: "json",
+    ...params,
+  });
+};
 /**
  * @description Get packing rules with suggested items
  *
@@ -943,6 +986,45 @@ export const getApiV21OrdersIdOrderItemsCount = (
     ...params,
   });
 };
+/**
+ * @description Retrieve the package label reference for an order
+ *
+ * @tags orders
+ * @name GetApiV21OrdersIdPackageLabelReference
+ * @summary Retrieve package label reference
+ * @request GET:/api/v2.1/orders/{id}/package_label_reference
+ */
+export const getApiV21OrdersIdPackageLabelReference = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<ApiV21EntitiesPackageLabelReference, ApiSharedEntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/package_label_reference`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Create a package label reference for an order
+ *
+ * @tags orders
+ * @name PostApiV21OrdersIdPackageLabelReference
+ * @summary Create a package label reference
+ * @request POST:/api/v2.1/orders/{id}/package_label_reference
+ */
+export const postApiV21OrdersIdPackageLabelReference = (
+  client: HttpClient,
+  id: number,
+  data: PostApiV21OrdersIdPackageLabelReferenceRequest,
+  params: RequestParams = {},
+) => {
+  return client.request<ApiV21EntitiesPostResponse, ApiSharedEntitiesApiError>({
+    path: `/api/v2.1/orders/${id}/package_label_reference`,
+    method: "POST",
+    body: data,
+    type: ContentType.Json,
+    format: "json",
+    ...params,
+  });
+};
 /**
  * @description Get packing rules with suggested items
  *

package/generated/PackageLabelReferences.ts

@@ -0,0 +1,127 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import {
+  ApiSharedEntitiesApiError,
+  ApiV21EntitiesPackageLabelReference,
+  ApiV2EntitiesPackageLabelReference,
+  PutApiV21PackageLabelReferencesIdRequest,
+  PutApiV2PackageLabelReferencesIdRequest,
+} from "./data-contracts";
+import { ContentType, HttpClient, RequestParams } from "./http-client";
+
+/**
+ * @description Retrieve a package label reference
+ *
+ * @tags package_label_references
+ * @name GetApiV2PackageLabelReferencesId
+ * @summary Retrieve a package label reference
+ * @request GET:/api/v2/package_label_references/{id}
+ */
+export const getApiV2PackageLabelReferencesId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<ApiV2EntitiesPackageLabelReference, ApiSharedEntitiesApiError>({
+    path: `/api/v2/package_label_references/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Update a package label reference
+ *
+ * @tags package_label_references
+ * @name PutApiV2PackageLabelReferencesId
+ * @summary Update a package label reference
+ * @request PUT:/api/v2/package_label_references/{id}
+ */
+export const putApiV2PackageLabelReferencesId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV2PackageLabelReferencesIdRequest,
+  params: RequestParams = {},
+) => {
+  return client.request<ApiV2EntitiesPackageLabelReference, ApiSharedEntitiesApiError>({
+    path: `/api/v2/package_label_references/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.Json,
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Destroy a package label reference
+ *
+ * @tags package_label_references
+ * @name DeleteApiV2PackageLabelReferencesId
+ * @summary Destroy a package label reference
+ * @request DELETE:/api/v2/package_label_references/{id}
+ */
+export const deleteApiV2PackageLabelReferencesId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, ApiSharedEntitiesApiError>({
+    path: `/api/v2/package_label_references/${id}`,
+    method: "DELETE",
+    ...params,
+  });
+};
+/**
+ * @description Retrieve a package label reference
+ *
+ * @tags package_label_references
+ * @name GetApiV21PackageLabelReferencesId
+ * @summary Retrieve a package label reference
+ * @request GET:/api/v2.1/package_label_references/{id}
+ */
+export const getApiV21PackageLabelReferencesId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<ApiV21EntitiesPackageLabelReference, ApiSharedEntitiesApiError>({
+    path: `/api/v2.1/package_label_references/${id}`,
+    method: "GET",
+    format: "json",
+    ...params,
+  });
+};
+/**
+ * @description Update a package label reference
+ *
+ * @tags package_label_references
+ * @name PutApiV21PackageLabelReferencesId
+ * @summary Update a package label reference
+ * @request PUT:/api/v2.1/package_label_references/{id}
+ */
+export const putApiV21PackageLabelReferencesId = (
+  client: HttpClient,
+  id: number,
+  data: PutApiV21PackageLabelReferencesIdRequest,
+  params: RequestParams = {},
+) => {
+  return client.request<void, ApiSharedEntitiesApiError>({
+    path: `/api/v2.1/package_label_references/${id}`,
+    method: "PUT",
+    body: data,
+    type: ContentType.Json,
+    ...params,
+  });
+};
+/**
+ * @description Destroy a package label reference
+ *
+ * @tags package_label_references
+ * @name DeleteApiV21PackageLabelReferencesId
+ * @summary Destroy a package label reference
+ * @request DELETE:/api/v2.1/package_label_references/{id}
+ */
+export const deleteApiV21PackageLabelReferencesId = (client: HttpClient, id: number, params: RequestParams = {}) => {
+  return client.request<void, ApiSharedEntitiesApiError>({
+    path: `/api/v2.1/package_label_references/${id}`,
+    method: "DELETE",
+    ...params,
+  });
+};