@whiplashmerch/whiplash-api-client 0.4.42 → 0.4.44

package/generated/data-contracts.ts

@@ -769,6 +769,11 @@ export interface APIV21EntitiesOrder {
   /** the order type */
   order_type?: string;
   originator?: APIV2EntitiesOriginator;
+  /**
+   * User-defined reference for shipping labels on packages.
+   *           Note: this field has a limit of 35 chars.
+   */
+  package_label_reference?: string;
   /** url for this orders packing slip */
   packingslip_pdf_url?: string;
   /** Permission limited orders are not editable, but still may be processed/shipped */
@@ -2559,6 +2564,11 @@ export interface APIV2EntitiesOrder {
   /** the order type */
   order_type?: string;
   originator?: APIV2EntitiesOriginator;
+  /**
+   * User-defined reference for shipping labels on packages.
+   *           Note: this field has a limit of 35 chars.
+   */
+  package_label_reference?: string;
   packages?: APIV2EntitiesPackage[];
   /** url for this orders packing slip */
   packingslip_pdf_url?: string;
@@ -5791,6 +5801,152 @@ export interface PostApiV21ConsumerReturns {
   warehouse_id?: number;
 }
 
+/** Create consumer_returns in bulk */
+export interface PostApiV21ConsumerReturnsBulk {
+  /** An array of consumer_return objects to create in bulk */
+  resources: {
+    /**
+     * The whiplash id of the order from which an item is being returned
+     * @format int32
+     */
+    order_id: number;
+    /**
+     * the consumer return customer id
+     * @format int32
+     */
+    customer_id?: number;
+    /**
+     * The ID of the whiplash warehouse this return should be delivered to
+     * @format int32
+     */
+    warehouse_id?: number;
+    /** the consumer return sender */
+    sender?: string;
+    /**
+     * the consumer return estimated arrival date
+     * @format date-time
+     */
+    eta?: string;
+    /**
+     * status of the consumer return
+     * @format int32
+     */
+    status?: number;
+    /** the shipnotice status name */
+    status_name?: string;
+    /** the name of the person who received the consumer return */
+    received_by?: string;
+    /** notes by whiplash */
+    notes_by_whiplash?: string;
+    /** notes by customer */
+    notes_by_customer?: string;
+    /**
+     * total number of boxes in the consumer return
+     * @format int32
+     */
+    total_boxes?: number;
+    /**
+     * the consumer return arrival date and time
+     * @format date-time
+     */
+    arrived_at?: string;
+    /** allow skipping of images for this consumer return? */
+    skip_images?: boolean;
+    /** the ID of the easypost shipment or tracker */
+    easypostable_id?: string;
+    /** the type of the easypost object (shipment or tracker) */
+    easypostable_type?: string;
+    /** url of the shipping label */
+    shipping_label_url?: string;
+    /**
+     * the consumer return actual cost of shipping
+     * @format float
+     */
+    ship_actual_cost?: number;
+    /** the method of shipping for the consumer return */
+    shipping_method_text?: string;
+    /** shipping carrier */
+    carrier?: string;
+    /** the tracking number of the consumer return */
+    tracking?: string;
+    /** consumer return type (Shipnotice, ConsumerReturn) */
+    type?: string;
+    /** was postage billed? */
+    postage_billed?: boolean;
+    /** was handling billed? */
+    handling_billed?: boolean;
+    /**
+     * the consumer return actual cost of shipping
+     * @format float
+     */
+    ship_3rdparty_cost?: number;
+    /** does this consumer return require a label? */
+    requires_label: boolean;
+    /**
+     * the consumer return completion date and time
+     * @format date-time
+     */
+    completed_at?: string;
+    /** currency used for this consumer return */
+    ship_actual_currency?: string;
+    /**
+     * date when was the consumer return delivered
+     * @format date-time
+     */
+    delivered_at?: string;
+    /**
+     * date when the consumer return is due to be delivered
+     * @format date-time
+     */
+    due_at?: string;
+    /** purchase order number or other human readable token to another system */
+    reference?: string;
+    return_items?: string;
+    shipnotice_items_attributes?: {
+      /**
+       * the shipnotice item item id
+       * @format int32
+       */
+      item_id: number;
+      /**
+       * the number of this shipnotice item in the shipnotice
+       * @format int32
+       */
+      quantity: number;
+      /** action to perform on item return  */
+      return_action: string;
+      /** description of the item */
+      description: string;
+      extended_description?: string;
+      originator_attributes?: {
+        /** the originator original id (from the provider) */
+        original_id?: string;
+        /** the originator group id */
+        group_id?: string;
+        /** miscellaneous info for the originator */
+        misc?: string;
+      };
+    }[];
+    originator_attributes?: {
+      /** the originator original id (from the provider) */
+      original_id?: string;
+      /** the originator group id */
+      group_id?: string;
+      /** miscellaneous info for the originator */
+      misc?: string;
+    };
+    /** Hash of key value pairs (must conform to available meta keys) */
+    meta_fields?: {
+      /** Hash of key/value pairs */
+      fields?: object;
+      /** Included meta fields for associations */
+      association_fields?: object;
+    };
+    /** List of whiplash item ids to be added to an exchange order */
+    exchange_items?: number[];
+  }[];
+}
+
 /** Create a document */
 export interface PostApiV21Documents {
   /** Comma seperated list of context tags */
@@ -6618,6 +6774,11 @@ export interface PostApiV21Orders {
     /** miscellaneous info for the originator */
     misc?: string;
   };
+  /**
+   * User-defined reference for shipping labels on packages.
+   *           Note: this field has a limit of 35 chars.
+   */
+  package_label_reference?: string;
   /** Permission limited orders are not editable, but still may be processed/shipped */
   permissions_limited?: boolean;
   /** is the order a pickup order */
@@ -6776,6 +6937,390 @@ export interface PostApiV21Orders {
   };
 }
 
+/** Create orders in bulk */
+export interface PostApiV21OrdersBulk {
+  /** An array of order objects to create in bulk */
+  resources?: {
+    /**
+     * the order shipping method id
+     * @format int32
+     */
+    shipping_method_id?: number;
+    /**
+     * the estimated order shipping method id, if set to cheapest rate
+     * @format int32
+     */
+    estimated_shipping_method_id?: number;
+    /** the order humanized id */
+    humanize_id?: string;
+    /**
+     * the order original id (from the shop that sent whiplash the order)
+     *           Note: contains the global-e order id for any global-e order.
+     */
+    order_orig?: string;
+    /**
+     * User-defined reference for shipping labels on packages.
+     *           Note: this field has a limit of 35 chars.
+     */
+    package_label_reference?: string;
+    /** the order level 1 token */
+    level1_token?: string;
+    /** the order level 2 token */
+    level2_token?: string;
+    /** skip street date for this order? */
+    skip_street_date?: boolean;
+    /**
+     * the order due at date and time
+     * @format date-time
+     */
+    due_at?: string;
+    /** meta data for this order as stringified JSON */
+    meta_data?: string;
+    /** the carrier on the customer provided label (for tracking purposes) */
+    customer_provided_label_carrier?: string;
+    /** the purchase order this order */
+    purchase_order?: string;
+    /** the order type */
+    order_type?: PostApiV21OrdersBulkOrderType;
+    /** the order shipping email */
+    email?: string;
+    /** are the items in the order updateable */
+    items_updateable?: boolean;
+    /** skip order shipping address verification? (staff only) */
+    skip_address_verification?: boolean;
+    /** the order shop warehouse ids */
+    shop_warehouse_ids?: number[];
+    /** the order shop shipping method currency */
+    shop_shipping_method_currency?: string;
+    /**
+     * the order shop creation date and time
+     * @format date-time
+     */
+    shop_created_at?: string;
+    /**
+     * the order shop last update date and time
+     * @format date-time
+     */
+    shop_updated_at?: string;
+    /**
+     * the order shop shipping method text
+     *           ge_standard = order uses global-e standard shipping method
+     *           ge_express = order uses global-e express shipping method
+     *           Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
+     */
+    shop_shipping_method_text?: string;
+    /**
+     * the order shop shipping method price
+     * @format float
+     */
+    shop_shipping_method_price?: number;
+    /** the order billing company */
+    billing_company?: string;
+    /** the order billing street address 1 */
+    billing_address_1?: string;
+    /** the order billing street address 2 */
+    billing_address_2?: string;
+    /** the order billing street address 3 */
+    billing_address_3?: string;
+    /** the order billing city */
+    billing_city?: string;
+    /** the order billing state */
+    billing_state?: string;
+    /** the order billing zip */
+    billing_zip?: string;
+    /** the order billing country */
+    billing_country?: string;
+    /** the order billing phone number */
+    billing_phone?: string;
+    /** do not bill for the order? (staff only) */
+    do_not_bill?: boolean;
+    /** the order billing name */
+    billing_name?: string;
+    /** the first name of the person the order is being shipped to */
+    first_name?: string;
+    /** the last name of the person the order is being shipped to */
+    last_name?: string;
+    /** the full name of the person the order is being shipped to */
+    full_name?: string;
+    /** the order shipping name */
+    shipping_name?: string;
+    /** the order shipping company */
+    shipping_company?: string;
+    /** the order shipping street address 1 */
+    shipping_address_1?: string;
+    /** the order shipping street address 2 */
+    shipping_address_2?: string;
+    /** the order shipping city */
+    shipping_city?: string;
+    /** the order shipping state */
+    shipping_state?: string;
+    /** the order shipping zip */
+    shipping_zip?: string;
+    /** the order shipping country */
+    shipping_country?: string;
+    /** the order shipping country iso2 (US, GB, CA, etc) */
+    shipping_country_iso2?: string;
+    /** the order shipping phone number */
+    shipping_phone?: string;
+    /** the order requested address */
+    requested_address?: string;
+    /** is the order address residential? */
+    residential?: boolean;
+    /** is the order expedited? */
+    expedited?: boolean;
+    /** does the order require a signature upon delivery? */
+    require_signature?: boolean;
+    /** does the order require an adult signature upon delivery? */
+    require_adult_signature?: boolean;
+    /** require a carrier that delivers on Saturdays for this order? */
+    saturday_delivery?: boolean;
+    /** is the order a gift? */
+    gift?: boolean;
+    /** is the order insured? */
+    insure?: boolean;
+    /** does the order contain alcohol? */
+    contains_alcohol?: boolean;
+    /** does the order require customs documents? */
+    customs_required?: boolean;
+    /** carrier facility access point for the address destination */
+    shipping_carrier_facility?: string;
+    /** pickup option for carrier facility on the address destination */
+    shipping_hold_for_pickup?: boolean;
+    /** the order ship notes */
+    ship_notes?: string;
+    /**
+     * the order third party shipping cost
+     * @format float
+     */
+    ship_3rdparty_cost?: number;
+    /** the order third party shipping account */
+    ship_3rdparty_account?: string;
+    /** the order third party shipping zip */
+    ship_3rdparty_zip?: string;
+    /** the order third party shipping country */
+    ship_3rdparty_country?: string;
+    /** the order public note */
+    public_note?: string;
+    /**
+     * the order estimated days in transit (used for release planning)
+     * @format int32
+     */
+    days_in_transit?: number;
+    /**
+     * the order estimated days in transit estimate from the carrier
+     * @format int32
+     */
+    days_in_transit_carrier_estimate?: number;
+    /**
+     * the order requested insurance value
+     * @format float
+     */
+    req_insurance_value?: number;
+    /** packingslip pdf url */
+    cf_packingslip_pdf_url?: string;
+    /** Value Added Tax identifcation number for the sender of the order */
+    customs_vat_number?: string;
+    /** Economic Operators Registration and Identification number for the sender of the order */
+    customs_eori_number?: string;
+    /** Import One-Stop Shop number for the sender of the order */
+    customs_ioss_number?: string;
+    /**
+     * the carrier account id for this package, if it has shipped (staff only)
+     * @format int32
+     */
+    carrier_account_id?: number;
+    /** the order tracking numbers */
+    tracking?: string[];
+    /** the order tracking links */
+    tracking_links?: string[];
+    /**
+     * the order approxiamte delivery date
+     * @format date
+     */
+    approximate_delivery_date?: string;
+    /** is the order a global_e order? */
+    global_e_ge_order?: boolean;
+    /** the orders calculated return time limit */
+    calculated_time_limit?: string;
+    /** is the order within its return time limit */
+    within_return_time_limit?: boolean;
+    /** the order return name */
+    return_name?: string;
+    /** the order return company */
+    return_company?: string;
+    /** the order return street address 1 */
+    return_address_1?: string;
+    /** the order return street address 2 */
+    return_address_2?: string;
+    /** the order return city */
+    return_city?: string;
+    /** the order return state */
+    return_state?: string;
+    /** the order return country */
+    return_country?: string;
+    /** the order return zip */
+    return_zip?: string;
+    /** the order return phone number */
+    return_phone?: string;
+    /** the order return email */
+    return_email?: string;
+    /**
+     * the order return time limit
+     * @format int32
+     */
+    return_time_limit?: number;
+    /** is the order workable? */
+    is_workable?: boolean;
+    /** is the order gestating? */
+    is_gestating?: boolean;
+    /** Permission limited orders are not editable, but still may be processed/shipped */
+    permissions_limited?: boolean;
+    order_items?: string;
+    /** desired incoterm for the order */
+    incoterm?: PostApiV21OrdersBulkIncoterm;
+    /**
+     * 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?: PostApiV21OrdersBulkStatus;
+    order_items_attributes?: {
+      /**
+       * number of this item in Order
+       * @format int32
+       */
+      quantity?: number;
+      /**
+       * the order item order id
+       * @format int32
+       */
+      order_id?: number;
+      /**
+       * the order item customer id
+       * @format int32
+       */
+      customer_id?: number;
+      /**
+       * the order item item id
+       * @format int32
+       */
+      item_id?: number;
+      /** the SKU of this item */
+      sku?: string;
+      /** description for this order item. This will appear in packing slips. If not set, the description will be inherited from the parent Item. */
+      description?: string;
+      /**
+       * price of this item
+       * @format float
+       */
+      price?: number;
+      /** is this item unshippable? */
+      unshippable?: boolean;
+      /** is this item available? */
+      available?: boolean;
+      /**
+       * number of items packed
+       * @format int32
+       */
+      packed?: number;
+      /** is this item packaging? */
+      packaging?: boolean;
+      /**
+       * wholesale cost of the item
+       * @format float
+       */
+      wholesale_cost?: number;
+      /** is this item a bundle? */
+      is_bundle?: boolean;
+      /**
+       * retail fee of this item
+       * @format float
+       */
+      retail_fee?: number;
+      /** is this item a promo? */
+      promo?: boolean;
+      /** is this item returnable? */
+      returnable?: boolean;
+      /** currency code for this item */
+      currency?: string;
+      /**
+       * wholesale fee of this item
+       * @format float
+       */
+      wholesale_fee?: number;
+      /** (deprecated) is the order item hazmat? */
+      hazmat?: boolean;
+      /** miscellaneous information about the order item */
+      misc?: string;
+      /** does the item require a serial number when shipping? */
+      request_serial_number?: boolean;
+      /** The original id of the order item */
+      originator_id?: string;
+      /** The original id of the item */
+      item_originator_id?: string;
+      originator_attributes?: {
+        /** the originator original id (from the provider) */
+        original_id?: string;
+        /** the originator group id */
+        group_id?: string;
+        /** miscellaneous info for the originator */
+        misc?: string;
+      };
+    }[];
+    originator_attributes?: {
+      /** the originator original id (from the provider) */
+      original_id?: string;
+      /** the originator group id */
+      group_id?: string;
+      /** miscellaneous info for the originator */
+      misc?: string;
+    };
+    /** Hash of key value pairs (must conform to available meta keys) */
+    meta_fields?: {
+      /** Hash of key/value pairs */
+      fields?: object;
+      /** Included meta fields for associations */
+      association_fields?: object;
+    };
+  }[];
+}
+
+/** desired incoterm for the order */
+export enum PostApiV21OrdersBulkIncoterm {
+  EXW = "EXW",
+  FCA = "FCA",
+  CPT = "CPT",
+  CIP = "CIP",
+  DAT = "DAT",
+  DAP = "DAP",
+  DDP = "DDP",
+  FAS = "FAS",
+  FOB = "FOB",
+  CFR = "CFR",
+  CIF = "CIF",
+  DAF = "DAF",
+  DES = "DES",
+  DEQ = "DEQ",
+  DDU = "DDU",
+}
+
+/** the order type */
+export enum PostApiV21OrdersBulkOrderType {
+  DirectToConsumer = "direct_to_consumer",
+  Dropship = "dropship",
+  Retail = "retail",
+  Transfer = "transfer",
+  Wholesale = "wholesale",
+}
+
+/**
+ * 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 enum PostApiV21OrdersBulkStatus {
+  Value30 = 30,
+  Value35 = 35,
+}
+
 /** Create an order document for an order */
 export interface PostApiV21OrdersIdOrderDocuments {
   /**
@@ -7088,6 +7633,185 @@ export interface PostApiV21Shipnotices {
   warehouse_id: number;
 }
 
+/** Create shipnotices in bulk */
+export interface PostApiV21ShipnoticesBulk {
+  /** An array of shipnotice objects to create in bulk */
+  resources: {
+    /** the shipnotice sender */
+    sender: string;
+    /**
+     * the shipnotice estimated arrival date
+     * @format date-time
+     */
+    eta: string;
+    /**
+     * the shipnotice warehouse id
+     * @format int32
+     */
+    warehouse_id: number;
+    /**
+     * status of the shipnotice
+     * @format int32
+     */
+    status?: number;
+    /** the shipnotice status name */
+    status_name?: string;
+    /** the name of the person who received the shipnotice */
+    received_by?: string;
+    /** notes by whiplash */
+    notes_by_whiplash?: string;
+    /** notes by customer */
+    notes_by_customer?: string;
+    /**
+     * total number of boxes in the shipnotice
+     * @format int32
+     */
+    total_boxes?: number;
+    /**
+     * the shipnotice arrival date and time
+     * @format date-time
+     */
+    arrived_at?: string;
+    /** allow skipping of images for this shipnotice? */
+    skip_images?: boolean;
+    /** the ID of the easypost shipment or tracker */
+    easypostable_id?: string;
+    /** the type of the easypost object (shipment or tracker) */
+    easypostable_type?: string;
+    /** url of the shipping label */
+    shipping_label_url?: string;
+    /**
+     * the shipnotice actual cost of shipping
+     * @format float
+     */
+    ship_actual_cost?: number;
+    /** the method of shipping for the shipnotice */
+    shipping_method_text?: string;
+    /** shipping carrier */
+    carrier?: string;
+    /**
+     * shipping method id
+     * @format int32
+     */
+    shipping_method_id?: number;
+    /** the tracking number of the shipnotice */
+    tracking?: string;
+    /**
+     * the order_id of the shipnotice
+     * @format int32
+     */
+    order_id?: number;
+    /** shipnotice type (Shipnotice, ConsumerReturn) */
+    type?: string;
+    /** was postage billed? */
+    postage_billed?: boolean;
+    /** was handling billed? */
+    handling_billed?: boolean;
+    /**
+     * 3rd party cost for the shipnotice
+     * @format float
+     */
+    ship_3rdparty_cost?: number;
+    /** does this shipnotice require a label? */
+    requires_label?: boolean;
+    /**
+     * the shipnotice completion date and time
+     * @format date-time
+     */
+    completed_at?: string;
+    /**
+     * the shipnotice must be completed by date and time
+     * @format date-time
+     */
+    complete_by?: string;
+    /** currency used for this shipnotice */
+    ship_actual_currency?: string;
+    /**
+     * date when was the shipnoticed delivered
+     * @format date-time
+     */
+    delivered_at?: string;
+    /**
+     * date when the shipnotice is due to be delivered
+     * @format date-time
+     */
+    due_at?: string;
+    /** meta data for this shipnotice as stringified JSON */
+    meta_data?: string;
+    /** purchase order number or other human readable token to another system */
+    reference?: string;
+    /**
+     * number of line items in this Ship Notice
+     * @format int32
+     */
+    shipnotice_item_count?: number;
+    /**
+     * number of unique items in this Ship Notice
+     * @format int32
+     */
+    shipnotice_item_sku_count?: number;
+    /**
+     * quantity of all the line items in this Ship Notice
+     * @format int32
+     */
+    shipnotice_item_quantity?: number;
+    /** purchase order numbers associated with this Ship Notice */
+    purchase_order_numbers?: string[];
+    /** JSON object of required and optional receiving quantities verified by staff */
+    quantities_verified?: object;
+    /** is inspection required? (default: false) */
+    inspection_required?: boolean;
+    shipnotice_items_attributes?: {
+      /**
+       * the number of this shipnotice item in the shipnotice
+       * @format int32
+       */
+      quantity: number;
+      /**
+       * the shipnotice item item id
+       * @format int32
+       */
+      item_id?: number;
+      /** The original id of the item */
+      item_originator_id?: string;
+      /** The purchase order number */
+      purchase_order_number?: string;
+      originator_attributes?: {
+        /** the originator original id (from the provider) */
+        original_id?: string;
+        /** the originator group id */
+        group_id?: string;
+        /** miscellaneous info for the originator */
+        misc?: string;
+      };
+      lot_attributes?: {
+        /** The lot number of the item. */
+        number: string;
+        /**
+         * The lot expiration date.
+         * @format date-time
+         */
+        expires_on: string;
+      };
+    }[];
+    originator_attributes?: {
+      /** the originator original id (from the provider) */
+      original_id?: string;
+      /** the originator group id */
+      group_id?: string;
+      /** miscellaneous info for the originator */
+      misc?: string;
+    };
+    /** Hash of key value pairs (must conform to available meta keys) */
+    meta_fields?: {
+      /** Hash of key/value pairs */
+      fields?: object;
+      /** Included meta fields for associations */
+      association_fields?: object;
+    };
+  }[];
+}
+
 /** create a shipnotice item */
 export interface PostApiV21ShipnoticesIdShipnoticeItems {
   /** description of the item */
@@ -7336,6 +8060,152 @@ export interface PostApiV2ConsumerReturns {
   warehouse_id?: number;
 }
 
+/** Create consumer_returns in bulk */
+export interface PostApiV2ConsumerReturnsBulk {
+  /** An array of consumer_return objects to create in bulk */
+  resources: {
+    /**
+     * The whiplash id of the order from which an item is being returned
+     * @format int32
+     */
+    order_id: number;
+    /**
+     * the consumer return customer id
+     * @format int32
+     */
+    customer_id?: number;
+    /**
+     * The ID of the whiplash warehouse this return should be delivered to
+     * @format int32
+     */
+    warehouse_id?: number;
+    /** the consumer return sender */
+    sender?: string;
+    /**
+     * the consumer return estimated arrival date
+     * @format date-time
+     */
+    eta?: string;
+    /**
+     * status of the consumer return
+     * @format int32
+     */
+    status?: number;
+    /** the shipnotice status name */
+    status_name?: string;
+    /** the name of the person who received the consumer return */
+    received_by?: string;
+    /** notes by whiplash */
+    notes_by_whiplash?: string;
+    /** notes by customer */
+    notes_by_customer?: string;
+    /**
+     * total number of boxes in the consumer return
+     * @format int32
+     */
+    total_boxes?: number;
+    /**
+     * the consumer return arrival date and time
+     * @format date-time
+     */
+    arrived_at?: string;
+    /** allow skipping of images for this consumer return? */
+    skip_images?: boolean;
+    /** the ID of the easypost shipment or tracker */
+    easypostable_id?: string;
+    /** the type of the easypost object (shipment or tracker) */
+    easypostable_type?: string;
+    /** url of the shipping label */
+    shipping_label_url?: string;
+    /**
+     * the consumer return actual cost of shipping
+     * @format float
+     */
+    ship_actual_cost?: number;
+    /** the method of shipping for the consumer return */
+    shipping_method_text?: string;
+    /** shipping carrier */
+    carrier?: string;
+    /** the tracking number of the consumer return */
+    tracking?: string;
+    /** consumer return type (Shipnotice, ConsumerReturn) */
+    type?: string;
+    /** was postage billed? */
+    postage_billed?: boolean;
+    /** was handling billed? */
+    handling_billed?: boolean;
+    /**
+     * the consumer return actual cost of shipping
+     * @format float
+     */
+    ship_3rdparty_cost?: number;
+    /** does this consumer return require a label? */
+    requires_label: boolean;
+    /**
+     * the consumer return completion date and time
+     * @format date-time
+     */
+    completed_at?: string;
+    /** currency used for this consumer return */
+    ship_actual_currency?: string;
+    /**
+     * date when was the consumer return delivered
+     * @format date-time
+     */
+    delivered_at?: string;
+    /**
+     * date when the consumer return is due to be delivered
+     * @format date-time
+     */
+    due_at?: string;
+    /** purchase order number or other human readable token to another system */
+    reference?: string;
+    return_items?: string;
+    shipnotice_items_attributes?: {
+      /**
+       * the shipnotice item item id
+       * @format int32
+       */
+      item_id: number;
+      /**
+       * the number of this shipnotice item in the shipnotice
+       * @format int32
+       */
+      quantity: number;
+      /** action to perform on item return  */
+      return_action: string;
+      /** description of the item */
+      description: string;
+      extended_description?: string;
+      originator_attributes?: {
+        /** the originator original id (from the provider) */
+        original_id?: string;
+        /** the originator group id */
+        group_id?: string;
+        /** miscellaneous info for the originator */
+        misc?: string;
+      };
+    }[];
+    originator_attributes?: {
+      /** the originator original id (from the provider) */
+      original_id?: string;
+      /** the originator group id */
+      group_id?: string;
+      /** miscellaneous info for the originator */
+      misc?: string;
+    };
+    /** Hash of key value pairs (must conform to available meta keys) */
+    meta_fields?: {
+      /** Hash of key/value pairs */
+      fields?: object;
+      /** Included meta fields for associations */
+      association_fields?: object;
+    };
+    /** List of whiplash item ids to be added to an exchange order */
+    exchange_items?: number[];
+  }[];
+}
+
 /** Create a document */
 export interface PostApiV2Documents {
   /** Comma seperated list of context tags */
@@ -8134,6 +9004,11 @@ export interface PostApiV2Orders {
     /** miscellaneous info for the originator */
     misc?: string;
   };
+  /**
+   * User-defined reference for shipping labels on packages.
+   *           Note: this field has a limit of 35 chars.
+   */
+  package_label_reference?: string;
   /** Permission limited orders are not editable, but still may be processed/shipped */
   permissions_limited?: boolean;
   /** the order public note */
@@ -8244,6 +9119,390 @@ export interface PostApiV2Orders {
   within_return_time_limit?: boolean;
 }
 
+/** Create orders in bulk */
+export interface PostApiV2OrdersBulk {
+  /** An array of order objects to create in bulk */
+  resources?: {
+    /**
+     * the order shipping method id
+     * @format int32
+     */
+    shipping_method_id?: number;
+    /**
+     * the estimated order shipping method id, if set to cheapest rate
+     * @format int32
+     */
+    estimated_shipping_method_id?: number;
+    /** the order humanized id */
+    humanize_id?: string;
+    /**
+     * the order original id (from the shop that sent whiplash the order)
+     *           Note: contains the global-e order id for any global-e order.
+     */
+    order_orig?: string;
+    /**
+     * User-defined reference for shipping labels on packages.
+     *           Note: this field has a limit of 35 chars.
+     */
+    package_label_reference?: string;
+    /** the order level 1 token */
+    level1_token?: string;
+    /** the order level 2 token */
+    level2_token?: string;
+    /** skip street date for this order? */
+    skip_street_date?: boolean;
+    /**
+     * the order due at date and time
+     * @format date-time
+     */
+    due_at?: string;
+    /** meta data for this order as stringified JSON */
+    meta_data?: string;
+    /** the carrier on the customer provided label (for tracking purposes) */
+    customer_provided_label_carrier?: string;
+    /** the purchase order this order */
+    purchase_order?: string;
+    /** the order type */
+    order_type?: PostApiV2OrdersBulkOrderType;
+    /** the order shipping email */
+    email?: string;
+    /** are the items in the order updateable */
+    items_updateable?: boolean;
+    /** skip order shipping address verification? (staff only) */
+    skip_address_verification?: boolean;
+    /** the order shop warehouse ids */
+    shop_warehouse_ids?: number[];
+    /** the order shop shipping method currency */
+    shop_shipping_method_currency?: string;
+    /**
+     * the order shop creation date and time
+     * @format date-time
+     */
+    shop_created_at?: string;
+    /**
+     * the order shop last update date and time
+     * @format date-time
+     */
+    shop_updated_at?: string;
+    /**
+     * the order shop shipping method text
+     *           ge_standard = order uses global-e standard shipping method
+     *           ge_express = order uses global-e express shipping method
+     *           Note: the global-e values will not match the global-e official shipping method mappings set up in the UI
+     */
+    shop_shipping_method_text?: string;
+    /**
+     * the order shop shipping method price
+     * @format float
+     */
+    shop_shipping_method_price?: number;
+    /** the order billing company */
+    billing_company?: string;
+    /** the order billing street address 1 */
+    billing_address_1?: string;
+    /** the order billing street address 2 */
+    billing_address_2?: string;
+    /** the order billing street address 3 */
+    billing_address_3?: string;
+    /** the order billing city */
+    billing_city?: string;
+    /** the order billing state */
+    billing_state?: string;
+    /** the order billing zip */
+    billing_zip?: string;
+    /** the order billing country */
+    billing_country?: string;
+    /** the order billing phone number */
+    billing_phone?: string;
+    /** do not bill for the order? (staff only) */
+    do_not_bill?: boolean;
+    /** the order billing name */
+    billing_name?: string;
+    /** the first name of the person the order is being shipped to */
+    first_name?: string;
+    /** the last name of the person the order is being shipped to */
+    last_name?: string;
+    /** the full name of the person the order is being shipped to */
+    full_name?: string;
+    /** the order shipping name */
+    shipping_name?: string;
+    /** the order shipping company */
+    shipping_company?: string;
+    /** the order shipping street address 1 */
+    shipping_address_1?: string;
+    /** the order shipping street address 2 */
+    shipping_address_2?: string;
+    /** the order shipping city */
+    shipping_city?: string;
+    /** the order shipping state */
+    shipping_state?: string;
+    /** the order shipping zip */
+    shipping_zip?: string;
+    /** the order shipping country */
+    shipping_country?: string;
+    /** the order shipping country iso2 (US, GB, CA, etc) */
+    shipping_country_iso2?: string;
+    /** the order shipping phone number */
+    shipping_phone?: string;
+    /** the order requested address */
+    requested_address?: string;
+    /** is the order address residential? */
+    residential?: boolean;
+    /** is the order expedited? */
+    expedited?: boolean;
+    /** does the order require a signature upon delivery? */
+    require_signature?: boolean;
+    /** does the order require an adult signature upon delivery? */
+    require_adult_signature?: boolean;
+    /** require a carrier that delivers on Saturdays for this order? */
+    saturday_delivery?: boolean;
+    /** is the order a gift? */
+    gift?: boolean;
+    /** is the order insured? */
+    insure?: boolean;
+    /** does the order contain alcohol? */
+    contains_alcohol?: boolean;
+    /** does the order require customs documents? */
+    customs_required?: boolean;
+    /** carrier facility access point for the address destination */
+    shipping_carrier_facility?: string;
+    /** pickup option for carrier facility on the address destination */
+    shipping_hold_for_pickup?: boolean;
+    /** the order ship notes */
+    ship_notes?: string;
+    /**
+     * the order third party shipping cost
+     * @format float
+     */
+    ship_3rdparty_cost?: number;
+    /** the order third party shipping account */
+    ship_3rdparty_account?: string;
+    /** the order third party shipping zip */
+    ship_3rdparty_zip?: string;
+    /** the order third party shipping country */
+    ship_3rdparty_country?: string;
+    /** the order public note */
+    public_note?: string;
+    /**
+     * the order estimated days in transit (used for release planning)
+     * @format int32
+     */
+    days_in_transit?: number;
+    /**
+     * the order estimated days in transit estimate from the carrier
+     * @format int32
+     */
+    days_in_transit_carrier_estimate?: number;
+    /**
+     * the order requested insurance value
+     * @format float
+     */
+    req_insurance_value?: number;
+    /** packingslip pdf url */
+    cf_packingslip_pdf_url?: string;
+    /** Value Added Tax identifcation number for the sender of the order */
+    customs_vat_number?: string;
+    /** Economic Operators Registration and Identification number for the sender of the order */
+    customs_eori_number?: string;
+    /** Import One-Stop Shop number for the sender of the order */
+    customs_ioss_number?: string;
+    /**
+     * the carrier account id for this package, if it has shipped (staff only)
+     * @format int32
+     */
+    carrier_account_id?: number;
+    /** the order tracking numbers */
+    tracking?: string[];
+    /** the order tracking links */
+    tracking_links?: string[];
+    /**
+     * the order approxiamte delivery date
+     * @format date
+     */
+    approximate_delivery_date?: string;
+    /** is the order a global_e order? */
+    global_e_ge_order?: boolean;
+    /** the orders calculated return time limit */
+    calculated_time_limit?: string;
+    /** is the order within its return time limit */
+    within_return_time_limit?: boolean;
+    /** the order return name */
+    return_name?: string;
+    /** the order return company */
+    return_company?: string;
+    /** the order return street address 1 */
+    return_address_1?: string;
+    /** the order return street address 2 */
+    return_address_2?: string;
+    /** the order return city */
+    return_city?: string;
+    /** the order return state */
+    return_state?: string;
+    /** the order return country */
+    return_country?: string;
+    /** the order return zip */
+    return_zip?: string;
+    /** the order return phone number */
+    return_phone?: string;
+    /** the order return email */
+    return_email?: string;
+    /**
+     * the order return time limit
+     * @format int32
+     */
+    return_time_limit?: number;
+    /** is the order workable? */
+    is_workable?: boolean;
+    /** is the order gestating? */
+    is_gestating?: boolean;
+    /** Permission limited orders are not editable, but still may be processed/shipped */
+    permissions_limited?: boolean;
+    order_items?: string;
+    /** desired incoterm for the order */
+    incoterm?: PostApiV2OrdersBulkIncoterm;
+    /**
+     * 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?: PostApiV2OrdersBulkStatus;
+    order_items_attributes?: {
+      /**
+       * number of this item in Order
+       * @format int32
+       */
+      quantity?: number;
+      /**
+       * the order item order id
+       * @format int32
+       */
+      order_id?: number;
+      /**
+       * the order item customer id
+       * @format int32
+       */
+      customer_id?: number;
+      /**
+       * the order item item id
+       * @format int32
+       */
+      item_id?: number;
+      /** the SKU of this item */
+      sku?: string;
+      /** description for this order item. This will appear in packing slips. If not set, the description will be inherited from the parent Item. */
+      description?: string;
+      /**
+       * price of this item
+       * @format float
+       */
+      price?: number;
+      /** is this item unshippable? */
+      unshippable?: boolean;
+      /** is this item available? */
+      available?: boolean;
+      /**
+       * number of items packed
+       * @format int32
+       */
+      packed?: number;
+      /** is this item packaging? */
+      packaging?: boolean;
+      /**
+       * wholesale cost of the item
+       * @format float
+       */
+      wholesale_cost?: number;
+      /** is this item a bundle? */
+      is_bundle?: boolean;
+      /**
+       * retail fee of this item
+       * @format float
+       */
+      retail_fee?: number;
+      /** is this item a promo? */
+      promo?: boolean;
+      /** is this item returnable? */
+      returnable?: boolean;
+      /** currency code for this item */
+      currency?: string;
+      /**
+       * wholesale fee of this item
+       * @format float
+       */
+      wholesale_fee?: number;
+      /** (deprecated) is the order item hazmat? */
+      hazmat?: boolean;
+      /** miscellaneous information about the order item */
+      misc?: string;
+      /** does the item require a serial number when shipping? */
+      request_serial_number?: boolean;
+      /** The original id of the order item */
+      originator_id?: string;
+      /** The original id of the item */
+      item_originator_id?: string;
+      originator_attributes?: {
+        /** the originator original id (from the provider) */
+        original_id?: string;
+        /** the originator group id */
+        group_id?: string;
+        /** miscellaneous info for the originator */
+        misc?: string;
+      };
+    }[];
+    originator_attributes?: {
+      /** the originator original id (from the provider) */
+      original_id?: string;
+      /** the originator group id */
+      group_id?: string;
+      /** miscellaneous info for the originator */
+      misc?: string;
+    };
+    /** Hash of key value pairs (must conform to available meta keys) */
+    meta_fields?: {
+      /** Hash of key/value pairs */
+      fields?: object;
+      /** Included meta fields for associations */
+      association_fields?: object;
+    };
+  }[];
+}
+
+/** desired incoterm for the order */
+export enum PostApiV2OrdersBulkIncoterm {
+  EXW = "EXW",
+  FCA = "FCA",
+  CPT = "CPT",
+  CIP = "CIP",
+  DAT = "DAT",
+  DAP = "DAP",
+  DDP = "DDP",
+  FAS = "FAS",
+  FOB = "FOB",
+  CFR = "CFR",
+  CIF = "CIF",
+  DAF = "DAF",
+  DES = "DES",
+  DEQ = "DEQ",
+  DDU = "DDU",
+}
+
+/** the order type */
+export enum PostApiV2OrdersBulkOrderType {
+  DirectToConsumer = "direct_to_consumer",
+  Dropship = "dropship",
+  Retail = "retail",
+  Transfer = "transfer",
+  Wholesale = "wholesale",
+}
+
+/**
+ * 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 enum PostApiV2OrdersBulkStatus {
+  Value30 = 30,
+  Value35 = 35,
+}
+
 /** Create an order document for an order */
 export interface PostApiV2OrdersIdOrderDocuments {
   /**
@@ -8556,6 +9815,185 @@ export interface PostApiV2Shipnotices {
   warehouse_id: number;
 }
 
+/** Create shipnotices in bulk */
+export interface PostApiV2ShipnoticesBulk {
+  /** An array of shipnotice objects to create in bulk */
+  resources: {
+    /** the shipnotice sender */
+    sender: string;
+    /**
+     * the shipnotice estimated arrival date
+     * @format date-time
+     */
+    eta: string;
+    /**
+     * the shipnotice warehouse id
+     * @format int32
+     */
+    warehouse_id: number;
+    /**
+     * status of the shipnotice
+     * @format int32
+     */
+    status?: number;
+    /** the shipnotice status name */
+    status_name?: string;
+    /** the name of the person who received the shipnotice */
+    received_by?: string;
+    /** notes by whiplash */
+    notes_by_whiplash?: string;
+    /** notes by customer */
+    notes_by_customer?: string;
+    /**
+     * total number of boxes in the shipnotice
+     * @format int32
+     */
+    total_boxes?: number;
+    /**
+     * the shipnotice arrival date and time
+     * @format date-time
+     */
+    arrived_at?: string;
+    /** allow skipping of images for this shipnotice? */
+    skip_images?: boolean;
+    /** the ID of the easypost shipment or tracker */
+    easypostable_id?: string;
+    /** the type of the easypost object (shipment or tracker) */
+    easypostable_type?: string;
+    /** url of the shipping label */
+    shipping_label_url?: string;
+    /**
+     * the shipnotice actual cost of shipping
+     * @format float
+     */
+    ship_actual_cost?: number;
+    /** the method of shipping for the shipnotice */
+    shipping_method_text?: string;
+    /** shipping carrier */
+    carrier?: string;
+    /**
+     * shipping method id
+     * @format int32
+     */
+    shipping_method_id?: number;
+    /** the tracking number of the shipnotice */
+    tracking?: string;
+    /**
+     * the order_id of the shipnotice
+     * @format int32
+     */
+    order_id?: number;
+    /** shipnotice type (Shipnotice, ConsumerReturn) */
+    type?: string;
+    /** was postage billed? */
+    postage_billed?: boolean;
+    /** was handling billed? */
+    handling_billed?: boolean;
+    /**
+     * 3rd party cost for the shipnotice
+     * @format float
+     */
+    ship_3rdparty_cost?: number;
+    /** does this shipnotice require a label? */
+    requires_label?: boolean;
+    /**
+     * the shipnotice completion date and time
+     * @format date-time
+     */
+    completed_at?: string;
+    /**
+     * the shipnotice must be completed by date and time
+     * @format date-time
+     */
+    complete_by?: string;
+    /** currency used for this shipnotice */
+    ship_actual_currency?: string;
+    /**
+     * date when was the shipnoticed delivered
+     * @format date-time
+     */
+    delivered_at?: string;
+    /**
+     * date when the shipnotice is due to be delivered
+     * @format date-time
+     */
+    due_at?: string;
+    /** meta data for this shipnotice as stringified JSON */
+    meta_data?: string;
+    /** purchase order number or other human readable token to another system */
+    reference?: string;
+    /**
+     * number of line items in this Ship Notice
+     * @format int32
+     */
+    shipnotice_item_count?: number;
+    /**
+     * number of unique items in this Ship Notice
+     * @format int32
+     */
+    shipnotice_item_sku_count?: number;
+    /**
+     * quantity of all the line items in this Ship Notice
+     * @format int32
+     */
+    shipnotice_item_quantity?: number;
+    /** purchase order numbers associated with this Ship Notice */
+    purchase_order_numbers?: string[];
+    /** JSON object of required and optional receiving quantities verified by staff */
+    quantities_verified?: object;
+    /** is inspection required? (default: false) */
+    inspection_required?: boolean;
+    shipnotice_items_attributes?: {
+      /**
+       * the number of this shipnotice item in the shipnotice
+       * @format int32
+       */
+      quantity: number;
+      /**
+       * the shipnotice item item id
+       * @format int32
+       */
+      item_id?: number;
+      /** The original id of the item */
+      item_originator_id?: string;
+      /** The purchase order number */
+      purchase_order_number?: string;
+      originator_attributes?: {
+        /** the originator original id (from the provider) */
+        original_id?: string;
+        /** the originator group id */
+        group_id?: string;
+        /** miscellaneous info for the originator */
+        misc?: string;
+      };
+      lot_attributes?: {
+        /** The lot number of the item. */
+        number: string;
+        /**
+         * The lot expiration date.
+         * @format date-time
+         */
+        expires_on: string;
+      };
+    }[];
+    originator_attributes?: {
+      /** the originator original id (from the provider) */
+      original_id?: string;
+      /** the originator group id */
+      group_id?: string;
+      /** miscellaneous info for the originator */
+      misc?: string;
+    };
+    /** Hash of key value pairs (must conform to available meta keys) */
+    meta_fields?: {
+      /** Hash of key/value pairs */
+      fields?: object;
+      /** Included meta fields for associations */
+      association_fields?: object;
+    };
+  }[];
+}
+
 /** create a shipnotice item */
 export interface PostApiV2ShipnoticesIdShipnoticeItems {
   /** description of the item */
@@ -10179,6 +11617,11 @@ export interface PutApiV21Orders {
   order_orig?: string;
   /** the order type */
   order_type?: string;
+  /**
+   * User-defined reference for shipping labels on packages.
+   *           Note: this field has a limit of 35 chars.
+   */
+  package_label_reference?: string;
   /** url for this orders packing slip */
   packingslip_pdf_url?: string;
   /** Permission limited orders are not editable, but still may be processed/shipped */
@@ -10446,6 +11889,11 @@ export interface PutApiV21OrdersOriginator {
   order_orig?: string;
   /** the order type */
   order_type?: string;
+  /**
+   * User-defined reference for shipping labels on packages.
+   *           Note: this field has a limit of 35 chars.
+   */
+  package_label_reference?: string;
   /** url for this orders packing slip */
   packingslip_pdf_url?: string;
   /** Permission limited orders are not editable, but still may be processed/shipped */
@@ -12415,6 +13863,11 @@ export interface PutApiV2Orders {
   order_orig?: string;
   /** the order type */
   order_type?: string;
+  /**
+   * User-defined reference for shipping labels on packages.
+   *           Note: this field has a limit of 35 chars.
+   */
+  package_label_reference?: string;
   /** url for this orders packing slip */
   packingslip_pdf_url?: string;
   /** Permission limited orders are not editable, but still may be processed/shipped */
@@ -12680,6 +14133,11 @@ export interface PutApiV2OrdersOriginator {
   order_orig?: string;
   /** the order type */
   order_type?: string;
+  /**
+   * User-defined reference for shipping labels on packages.
+   *           Note: this field has a limit of 35 chars.
+   */
+  package_label_reference?: string;
   /** url for this orders packing slip */
   packingslip_pdf_url?: string;
   /** Permission limited orders are not editable, but still may be processed/shipped */