@whiplashmerch/whiplash-api-client 0.4.4 → 0.4.6

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

@@ -322,6 +322,54 @@ export interface APIV21EntitiesCustomer {
     /** Workday UUID */
     workday_uuid?: string;
 }
+export interface APIV21EntitiesCustomsInfo {
+    /** AU VAT number */
+    au_vat_number?: string;
+    /**
+     * the customs creation date and time
+     * @format date-time
+     */
+    created_at?: string;
+    /**
+     * the associated customer id
+     * @format int32
+     */
+    customer_id?: number;
+    /** EORI number */
+    eori_number?: string;
+    /** EU VAT number */
+    eu_vat_number?: string;
+    /**
+     * the customs info id
+     * @format int32
+     */
+    id?: number;
+    /**
+     * the associated importer of record id
+     * @format int32
+     */
+    importer_of_record_id?: number;
+    /** IOSS number */
+    ioss_number?: string;
+    /** non-EU/AU/UK VAT number */
+    misc_vat_number?: string;
+    /**
+     * the associated order id
+     * @format int32
+     */
+    order_id?: number;
+    /** send ETD to carrier */
+    send_electonic_trade_docs?: boolean;
+    /** e-signature for customs */
+    signer?: string;
+    /** UK VAT number */
+    uk_vat_number?: string;
+    /**
+     * the customs last update date and time
+     * @format date-time
+     */
+    updated_at?: string;
+}
 export interface APIV21EntitiesItem {
     /** is the item active? */
     active?: boolean;
@@ -613,6 +661,7 @@ export interface APIV21EntitiesOrder {
     /** the carrier on the customer provided label (for tracking purposes) */
     customer_provided_label_carrier?: string;
     customs_eori_number?: string;
+    customs_info?: APIV21EntitiesCustomsInfo;
     customs_ioss_number?: string;
     /** does the order require customs documents? */
     customs_required?: boolean;
@@ -827,10 +876,10 @@ export interface APIV21EntitiesOrder {
     /** skip street date for this order? */
     skip_street_date?: boolean;
     /**
-     * the order status
+     * the order status: 30 (Shipped Externally), 35 (Quote), 40 (Cancelled), 45 (Closed by Originator), 50 (Unpaid), 75 (Pending Return), 77 (Return Verified), 80 (Pre-Order), 90 (Paused), 95 (Insufficient Inventory), 100 (Processing), 120 (Printed), 150 (Picked), 155 (Prepacking in Progress), 160 (Packed), 200 (Label Scheduled for Purchase), 250 (Label Purchased), 300 (Shipped), 325 (Picked Up), 350 (Delivered), 375 (Return Expired), 380 (Replacement Cancelled), 400 (Returned Undeliverable), 410 (Replacement Requested), 430 (Exchanged), 450 (Refund Requested)
      * @format int32
      */
-    status?: number;
+    status?: ApiV21EntitiesOrderStatus;
     /** the order status name */
     status_name?: string;
     /** the order tracking numbers */
@@ -849,6 +898,7 @@ export interface APIV21EntitiesOrder {
     warehouse_id?: number;
     /** The name of the associated warehouse */
     warehouse_name?: string;
+    wholesale?: APIV21EntitiesWholesale;
     /**
      * the date and time the order is workable
      * @format date-time
@@ -1330,6 +1380,66 @@ export interface APIV21EntitiesWarehouse {
     vat?: number;
     warehouse_features?: string;
 }
+export interface APIV21EntitiesWholesale {
+    /**
+     * the latest possible arrival time for the shipment
+     * @format date
+     */
+    cancel_date?: string;
+    /** the name of the carrier code used for order goruping and filtering */
+    carrier_code?: string;
+    /** the service of the carrier code used for order goruping and filtering */
+    carrier_service?: string;
+    /**
+     * the wholesale creation date and time
+     * @format date-time
+     */
+    created_at?: string;
+    /** the recipient department */
+    department?: string;
+    /** description of the recipient department */
+    department_description?: string;
+    /** the recipient distribution center */
+    distribution_center?: string;
+    /** FOB code */
+    fob_code?: string;
+    /** the gift message that will need to show up on a packslip or gs1 label */
+    gift_note?: string;
+    /**
+     * the wholesale id
+     * @format int32
+     */
+    id?: number;
+    /** the recipient location */
+    location?: string;
+    /** the order merchandise type code */
+    merchandise_type_code?: string;
+    /**
+     * the associated order id
+     * @format int32
+     */
+    order_id?: number;
+    /** the name of the trading partner for order grouping and filtering */
+    partner?: string;
+    /** the purchase order number */
+    po_number?: string;
+    /** the associated sender */
+    sender?: string;
+    /**
+     * the earliest possible arrival time for the shipment
+     * @format date
+     */
+    start_date?: string;
+    /**
+     * the wholesale last update date and time
+     * @format date-time
+     */
+    updated_at?: string;
+    /** the associated vendor */
+    vendor?: string;
+    /** the vendor number */
+    vendor_number?: string;
+}
 export interface APIV2EntitiesApiError {
     /** error message */
     message?: string;
@@ -2511,10 +2621,10 @@ export interface APIV2EntitiesOrder {
     /** skip street date for this order? */
     skip_street_date?: boolean;
     /**
-     * the order status
+     * the order status: 30 (Shipped Externally), 35 (Quote), 40 (Cancelled), 45 (Closed by Originator), 50 (Unpaid), 75 (Pending Return), 77 (Return Verified), 80 (Pre-Order), 90 (Paused), 95 (Insufficient Inventory), 100 (Processing), 120 (Printed), 150 (Picked), 155 (Prepacking in Progress), 160 (Packed), 200 (Label Scheduled for Purchase), 250 (Label Purchased), 300 (Shipped), 325 (Picked Up), 350 (Delivered), 375 (Return Expired), 380 (Replacement Cancelled), 400 (Returned Undeliverable), 410 (Replacement Requested), 430 (Exchanged), 450 (Refund Requested)
      * @format int32
      */
-    status?: number;
+    status?: ApiV2EntitiesOrderStatus;
     /** the order status name */
     status_name?: string;
     /** the order tracking numbers */
@@ -4829,6 +4939,38 @@ export declare enum ApiV21EntitiesOrderIncoterm {
     DEQ = "DEQ",
     DDU = "DDU"
 }
+/**
+ * the order status: 30 (Shipped Externally), 35 (Quote), 40 (Cancelled), 45 (Closed by Originator), 50 (Unpaid), 75 (Pending Return), 77 (Return Verified), 80 (Pre-Order), 90 (Paused), 95 (Insufficient Inventory), 100 (Processing), 120 (Printed), 150 (Picked), 155 (Prepacking in Progress), 160 (Packed), 200 (Label Scheduled for Purchase), 250 (Label Purchased), 300 (Shipped), 325 (Picked Up), 350 (Delivered), 375 (Return Expired), 380 (Replacement Cancelled), 400 (Returned Undeliverable), 410 (Replacement Requested), 430 (Exchanged), 450 (Refund Requested)
+ * @format int32
+ */
+export declare enum ApiV21EntitiesOrderStatus {
+    Value30 = 30,
+    Value35 = 35,
+    Value40 = 40,
+    Value45 = 45,
+    Value50 = 50,
+    Value75 = 75,
+    Value77 = 77,
+    Value80 = 80,
+    Value90 = 90,
+    Value95 = 95,
+    Value100 = 100,
+    Value120 = 120,
+    Value150 = 150,
+    Value155 = 155,
+    Value160 = 160,
+    Value200 = 200,
+    Value250 = 250,
+    Value300 = 300,
+    Value325 = 325,
+    Value350 = 350,
+    Value375 = 375,
+    Value380 = 380,
+    Value400 = 400,
+    Value410 = 410,
+    Value430 = 430,
+    Value450 = 450
+}
 /** hazmat class */
 export declare enum ApiV2EntitiesItemHazmatType {
     Ormd = "ormd",
@@ -5157,6 +5299,38 @@ export declare enum ApiV2EntitiesOrderIncoterm {
     DEQ = "DEQ",
     DDU = "DDU"
 }
+/**
+ * the order status: 30 (Shipped Externally), 35 (Quote), 40 (Cancelled), 45 (Closed by Originator), 50 (Unpaid), 75 (Pending Return), 77 (Return Verified), 80 (Pre-Order), 90 (Paused), 95 (Insufficient Inventory), 100 (Processing), 120 (Printed), 150 (Picked), 155 (Prepacking in Progress), 160 (Packed), 200 (Label Scheduled for Purchase), 250 (Label Purchased), 300 (Shipped), 325 (Picked Up), 350 (Delivered), 375 (Return Expired), 380 (Replacement Cancelled), 400 (Returned Undeliverable), 410 (Replacement Requested), 430 (Exchanged), 450 (Refund Requested)
+ * @format int32
+ */
+export declare enum ApiV2EntitiesOrderStatus {
+    Value30 = 30,
+    Value35 = 35,
+    Value40 = 40,
+    Value45 = 45,
+    Value50 = 50,
+    Value75 = 75,
+    Value77 = 77,
+    Value80 = 80,
+    Value90 = 90,
+    Value95 = 95,
+    Value100 = 100,
+    Value120 = 120,
+    Value150 = 150,
+    Value155 = 155,
+    Value160 = 160,
+    Value200 = 200,
+    Value250 = 250,
+    Value300 = 300,
+    Value325 = 325,
+    Value350 = 350,
+    Value375 = 375,
+    Value380 = 380,
+    Value400 = 400,
+    Value410 = 410,
+    Value430 = 430,
+    Value450 = 450
+}
 /** locale for language settings */
 export declare enum ApiV2EntitiesUserLocale {
     En = "en",
@@ -5906,11 +6080,6 @@ export interface PostApiV21Orders {
     shipping_address_2?: string;
     /** the order shipping country iso2 (US, GB, CA, etc) */
     shipping_country_iso2?: string;
-    /**
-     * the order approxiamte delivery date
-     * @format date
-     */
-    approximate_delivery_date?: string;
     /** the order billing city */
     billing_city?: string;
     /** the order billing company */
@@ -5925,8 +6094,6 @@ export interface PostApiV21Orders {
     billing_state?: string;
     /** the order billing zip */
     billing_zip?: string;
-    /** the orders calculated return time limit */
-    calculated_time_limit?: string;
     /**
      * the carrier account id for this package, if it has shipped (staff only)
      * @format int32
@@ -5936,10 +6103,35 @@ export interface PostApiV21Orders {
     cf_packingslip_pdf_url?: string;
     /** does the order contain alcohol? */
     contains_alcohol?: boolean;
+    /** The name of the associated customer */
+    customer_name?: string;
     /** the carrier on the customer provided label (for tracking purposes) */
     customer_provided_label_carrier?: string;
     /** Economic Operators Registration and Identification number for the sender of the order */
     customs_eori_number?: string;
+    customs_info_attributes?: {
+        /**
+         * the associated importer of record id
+         * @format int32
+         */
+        importer_of_record_id?: number;
+        /** send ETD to carrier */
+        send_electonic_trade_docs?: boolean;
+        /** e-signature for customs */
+        signer?: string;
+        /** AU VAT number */
+        au_vat_number?: string;
+        /** EU VAT number */
+        eu_vat_number?: string;
+        /** non-EU/AU/UK VAT number */
+        misc_vat_number?: string;
+        /** UK VAT number */
+        uk_vat_number?: string;
+        /** IOSS number */
+        ioss_number?: string;
+        /** EORI number */
+        eori_number?: string;
+    };
     /** Import One-Stop Shop number for the sender of the order */
     customs_ioss_number?: string;
     /** does the order require customs documents? */
@@ -5986,6 +6178,8 @@ export interface PostApiV21Orders {
     incoterm?: PostApiV21OrdersIncoterm;
     /** is the order insured? */
     insure?: boolean;
+    /** is the Order an international Order */
+    international?: boolean;
     /** is the order gestating? */
     is_gestating?: boolean;
     /** is the order workable? */
@@ -6003,6 +6197,16 @@ export interface PostApiV21Orders {
         /** Included meta fields for associations */
         association_fields?: object;
     };
+    /**
+     * number of SKUs in this Order
+     * @format int32
+     */
+    order_item_count?: number;
+    /**
+     * total quantity of all SKUs in this Order
+     * @format int32
+     */
+    order_item_quantity?: number;
     order_items_attributes?: {
         /**
          * number of this item in Order
@@ -6115,6 +6319,8 @@ export interface PostApiV21Orders {
     };
     /** Permission limited orders are not editable, but still may be processed/shipped */
     permissions_limited?: boolean;
+    /** is the order a pickup order */
+    pickup?: boolean;
     /** the order public note */
     public_note?: string;
     /** the purchase order this order */
@@ -6167,11 +6373,15 @@ export interface PostApiV21Orders {
     shipping_country?: string;
     /** pickup option for carrier facility on the address destination */
     shipping_hold_for_pickup?: boolean;
+    /** Shipping method carrier name */
+    shipping_method_carrier?: string;
     /**
      * the order shipping method id
      * @format int32
      */
     shipping_method_id?: number;
+    /** Shipping method service name */
+    shipping_method_name?: string;
     /** the order shipping name */
     shipping_name?: string;
     /** the order shipping phone number */
@@ -6206,7 +6416,7 @@ export interface PostApiV21Orders {
     /** skip street date for this order? */
     skip_street_date?: boolean;
     /**
-     * the order status
+     * the order status: 30 (Shipped Externally), 35 (Quote), 40 (Cancelled), 45 (Closed by Originator), 50 (Unpaid), 75 (Pending Return), 77 (Return Verified), 80 (Pre-Order), 90 (Paused), 95 (Insufficient Inventory), 100 (Processing), 120 (Printed), 150 (Picked), 155 (Prepacking in Progress), 160 (Packed), 200 (Label Scheduled for Purchase), 250 (Label Purchased), 300 (Shipped), 325 (Picked Up), 350 (Delivered), 375 (Return Expired), 380 (Replacement Cancelled), 400 (Returned Undeliverable), 410 (Replacement Requested), 430 (Exchanged), 450 (Refund Requested)
      * @format int32
      */
     status?: PostApiV21OrdersStatus;
@@ -6214,8 +6424,48 @@ export interface PostApiV21Orders {
     tracking?: string[];
     /** the order tracking links */
     tracking_links?: string[];
-    /** is the order within its return time limit */
-    within_return_time_limit?: boolean;
+    /** The name of the associated warehouse */
+    warehouse_name?: string;
+    wholesale_attributes?: {
+        /** the name of the carrier code used for order goruping and filtering */
+        carrier_code?: string;
+        /** the service of the carrier code used for order goruping and filtering */
+        carrier_service?: string;
+        /** the recipient department */
+        department?: string;
+        /** description of the recipient department */
+        department_description?: string;
+        /** the recipient distribution center */
+        distribution_center?: string;
+        /** FOB code */
+        fob_code?: string;
+        /** the gift message that will need to show up on a packslip or gs1 label */
+        gift_note?: string;
+        /** the recipient location */
+        location?: string;
+        /** the order merchandise type code */
+        merchandise_type_code?: string;
+        /** the name of the trading partner for order grouping and filtering */
+        partner?: string;
+        /** the purchase order number */
+        po_number?: string;
+        /** the associated sender */
+        sender?: string;
+        /** the associated vendor */
+        vendor?: string;
+        /** the vendor number */
+        vendor_number?: string;
+        /**
+         * the earliest possible arrival time for the shipment
+         * @format date
+         */
+        start_date?: string;
+        /**
+         * the latest possible arrival time for the shipment
+         * @format date
+         */
+        cancel_date?: string;
+    };
 }
 /** Create an order document for an order */
 export interface PostApiV21OrdersIdOrderDocuments {
@@ -6339,7 +6589,7 @@ export declare enum PostApiV21OrdersOrderType {
     Wholesale = "wholesale"
 }
 /**
- * the order status
+ * the order status: 30 (Shipped Externally), 35 (Quote), 40 (Cancelled), 45 (Closed by Originator), 50 (Unpaid), 75 (Pending Return), 77 (Return Verified), 80 (Pre-Order), 90 (Paused), 95 (Insufficient Inventory), 100 (Processing), 120 (Printed), 150 (Picked), 155 (Prepacking in Progress), 160 (Packed), 200 (Label Scheduled for Purchase), 250 (Label Purchased), 300 (Shipped), 325 (Picked Up), 350 (Delivered), 375 (Return Expired), 380 (Replacement Cancelled), 400 (Returned Undeliverable), 410 (Replacement Requested), 430 (Exchanged), 450 (Refund Requested)
  * @format int32
  */
 export declare enum PostApiV21OrdersStatus {
@@ -7640,7 +7890,7 @@ export interface PostApiV2Orders {
     /** skip street date for this order? */
     skip_street_date?: boolean;
     /**
-     * the order status
+     * the order status: 30 (Shipped Externally), 35 (Quote), 40 (Cancelled), 45 (Closed by Originator), 50 (Unpaid), 75 (Pending Return), 77 (Return Verified), 80 (Pre-Order), 90 (Paused), 95 (Insufficient Inventory), 100 (Processing), 120 (Printed), 150 (Picked), 155 (Prepacking in Progress), 160 (Packed), 200 (Label Scheduled for Purchase), 250 (Label Purchased), 300 (Shipped), 325 (Picked Up), 350 (Delivered), 375 (Return Expired), 380 (Replacement Cancelled), 400 (Returned Undeliverable), 410 (Replacement Requested), 430 (Exchanged), 450 (Refund Requested)
      * @format int32
      */
     status?: PostApiV2OrdersStatus;
@@ -7773,7 +8023,7 @@ export declare enum PostApiV2OrdersOrderType {
     Wholesale = "wholesale"
 }
 /**
- * the order status
+ * the order status: 30 (Shipped Externally), 35 (Quote), 40 (Cancelled), 45 (Closed by Originator), 50 (Unpaid), 75 (Pending Return), 77 (Return Verified), 80 (Pre-Order), 90 (Paused), 95 (Insufficient Inventory), 100 (Processing), 120 (Printed), 150 (Picked), 155 (Prepacking in Progress), 160 (Packed), 200 (Label Scheduled for Purchase), 250 (Label Purchased), 300 (Shipped), 325 (Picked Up), 350 (Delivered), 375 (Return Expired), 380 (Replacement Cancelled), 400 (Returned Undeliverable), 410 (Replacement Requested), 430 (Exchanged), 450 (Refund Requested)
  * @format int32
  */
 export declare enum PostApiV2OrdersStatus {