> ## Documentation Index > Fetch the complete documentation index at: https://docs.trackstarhq.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Trackstar is a unified REST API for WMS, cart, and carrier systems. Base URL: https://production.trackstarhq.com. There is no SDK; call the API with plain HTTP. > Send x-trackstar-api-key on every request. Endpoints scoped to one connection also need x-trackstar-access-token. Read both from environment variables and never print them. > Reads return data Trackstar has already synced from the connected system. Writes (POST, PUT, PATCH, DELETE) are forwarded to the connected system immediately. > A new connection has no data until its initial sync finishes. Wait for the connection.historical-sync-completed webhook, or poll GET /connections/{connection_id} and check historical_sync_completed. > List endpoints page with page_token and next_token (limit is capped at 1000). Repeat every filter on every page. Filters use field[operator]=value, for example created_date[gte]=2026-01-01T00:00:00Z. > Write bodies must not contain null or empty strings; omit the field instead. Call GET /integrations/{integration_type}/{integration_name}/write-info first to learn the exact fields an integration accepts. > To test without real credentials, POST /sandbox/generate-sandbox/{wms|cart|carrier} with the API key returns a sandbox access token. Start at https://docs.trackstarhq.com/how-to-guides/build-with-ai.md and install the skills with: npx skills add https://docs.trackstarhq.com # Create Order > Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint. ## OpenAPI ````yaml post /wms/orders openapi: 3.1.0 info: description: > Trackstar is a Unified API that provides standard endpoints for Supply Chain Logistics. We currently offer an API for Warehouse Management Systems (WMS). title: Trackstar API version: 0.1.0 servers: - description: Trackstar API url: https://production.trackstarhq.com security: [] tags: [] externalDocs: description: Trackstar API Documentation url: https://docs.trackstarhq.com paths: /wms/orders: post: tags: - wms - Orders summary: Create Order description: >- Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint. operationId: post_wms_create_order parameters: - in: header name: x-trackstar-api-key description: Your organization-level Trackstar API key. schema: type: string example: required: true - in: header name: x-trackstar-access-token description: >- Your user's access token for a specific integration (ShipHero, Extensiv, etc). schema: type: string example: required: true - in: header name: Idempotency-Key description: >- Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours. schema: type: string minLength: 1 maxLength: 255 example: 9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00 required: false requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatewmsOrderInputSchema' responses: '200': content: application/json: schema: $ref: '#/components/schemas/wmsCreateOrderResponse' description: Successful response '422': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: Validation error components: schemas: CreatewmsOrderInputSchema: type: object properties: {} additionalProperties: false oneOf: - $ref: '#/components/schemas/CreatewmsOrder--WMS__Sandbox--' - $ref: '#/components/schemas/CreatewmsOrder--Active__Ants--' - $ref: '#/components/schemas/CreatewmsOrder--A.__Duie__Pyle__-_ADP_---' - $ref: '#/components/schemas/CreatewmsOrder--Amphora--' - $ref: '#/components/schemas/CreatewmsOrder--Amplifier--' - $ref: '#/components/schemas/CreatewmsOrder--AMS--' - $ref: '#/components/schemas/CreatewmsOrder--Staci__Americas__-_AMWare_---' - $ref: '#/components/schemas/CreatewmsOrder--Atomix--' - $ref: '#/components/schemas/CreatewmsOrder--Bergen--' - $ref: '#/components/schemas/CreatewmsOrder--BEST__Inc.--' - $ref: >- #/components/schemas/CreatewmsOrder--BlueBox__-_IDrive__Fulfillment_--- - $ref: '#/components/schemas/CreatewmsOrder--Boxzooka--' - $ref: '#/components/schemas/CreatewmsOrder--Camelot--' - $ref: '#/components/schemas/CreatewmsOrder--Capacity--' - $ref: '#/components/schemas/CreatewmsOrder--CartonCloud--' - $ref: '#/components/schemas/CreatewmsOrder--Clarus--' - $ref: >- #/components/schemas/CreatewmsOrder--J_AMP_J__Global__Fulfillment__-_Control__Port_--- - $ref: '#/components/schemas/CreatewmsOrder--Darwynn__Fulfillment--' - $ref: '#/components/schemas/CreatewmsOrder--DCL--' - $ref: '#/components/schemas/CreatewmsOrder--Cin7__Core__-_Dear__Systems_---' - $ref: '#/components/schemas/CreatewmsOrder--Delmar--' - $ref: '#/components/schemas/CreatewmsOrder--Deposco--' - $ref: '#/components/schemas/CreatewmsOrder--Distribution__Management--' - $ref: '#/components/schemas/CreatewmsOrder--Dotcom__Distribution--' - $ref: '#/components/schemas/CreatewmsOrder--Elite__Ops--' - $ref: '#/components/schemas/CreatewmsOrder--eShipping--' - $ref: '#/components/schemas/CreatewmsOrder--Evolve--' - $ref: '#/components/schemas/CreatewmsOrder--Extensiv__-_3PL__Central_---' - $ref: '#/components/schemas/CreatewmsOrder--Amazon--' - $ref: '#/components/schemas/CreatewmsOrder--FedEx__Fulfillment--' - $ref: '#/components/schemas/CreatewmsOrder--FFE--' - $ref: '#/components/schemas/CreatewmsOrder--Finale--' - $ref: '#/components/schemas/CreatewmsOrder--Flexport__-_Deliverr_---' - $ref: '#/components/schemas/CreatewmsOrder--Flowspace--' - $ref: '#/components/schemas/CreatewmsOrder--Fulfillor--' - $ref: '#/components/schemas/CreatewmsOrder--fulfilmentcrowd--' - $ref: '#/components/schemas/CreatewmsOrder--G__Global--' - $ref: '#/components/schemas/CreatewmsOrder--GoBolt--' - $ref: '#/components/schemas/CreatewmsOrder--Greenmark__Logistics--' - $ref: '#/components/schemas/CreatewmsOrder--I-Fulfilment--' - $ref: '#/components/schemas/CreatewmsOrder--Infoplus--' - $ref: '#/components/schemas/CreatewmsOrder--JAS--' - $ref: '#/components/schemas/CreatewmsOrder--JayGroup--' - $ref: '#/components/schemas/CreatewmsOrder--Cart.com__-_Jazz__Central_---' - $ref: '#/components/schemas/CreatewmsOrder--Leanafy--' - $ref: '#/components/schemas/CreatewmsOrder--Linnworks--' - $ref: '#/components/schemas/CreatewmsOrder--Quickbox__-_LogicPod_---' - $ref: '#/components/schemas/CreatewmsOrder--Logiwa--' - $ref: '#/components/schemas/CreatewmsOrder--Logiwa__IO--' - $ref: '#/components/schemas/CreatewmsOrder--Luminous--' - $ref: '#/components/schemas/CreatewmsOrder--Luxroutage__LRI--' - $ref: '#/components/schemas/CreatewmsOrder--Mabang--' - $ref: '#/components/schemas/CreatewmsOrder--Mai__Fulfillment--' - $ref: '#/components/schemas/CreatewmsOrder--Mainfreight--' - $ref: '#/components/schemas/CreatewmsOrder--MasonHub--' - $ref: '#/components/schemas/CreatewmsOrder--Mintsoft--' - $ref: '#/components/schemas/CreatewmsOrder--Moda__Express--' - $ref: '#/components/schemas/CreatewmsOrder--Next3PL--' - $ref: '#/components/schemas/CreatewmsOrder--NextSmartShip--' - $ref: '#/components/schemas/CreatewmsOrder--NFI--' - $ref: '#/components/schemas/CreatewmsOrder--Nimble--' - $ref: '#/components/schemas/CreatewmsOrder--NLRP--' - $ref: '#/components/schemas/CreatewmsOrder--NPFulfilment--' - $ref: '#/components/schemas/CreatewmsOrder--NRI--' - $ref: '#/components/schemas/CreatewmsOrder--OIA__Global--' - $ref: '#/components/schemas/CreatewmsOrder--Ongoing__WMS--' - $ref: '#/components/schemas/CreatewmsOrder--OrderWise--' - $ref: '#/components/schemas/CreatewmsOrder--PackemWMS--' - $ref: '#/components/schemas/CreatewmsOrder--Packiyo--' - $ref: '#/components/schemas/CreatewmsOrder--Pattern--' - $ref: '#/components/schemas/CreatewmsOrder--Picqer--' - $ref: '#/components/schemas/CreatewmsOrder--Portless--' - $ref: '#/components/schemas/CreatewmsOrder--QLS--' - $ref: '#/components/schemas/CreatewmsOrder--Quiet__Platforms--' - $ref: '#/components/schemas/CreatewmsOrder--Salesupply--' - $ref: '#/components/schemas/CreatewmsOrder--ShipBob--' - $ref: '#/components/schemas/CreatewmsOrder--Shipedge--' - $ref: '#/components/schemas/CreatewmsOrder--Shipfusion--' - $ref: '#/components/schemas/CreatewmsOrder--ShipHero--' - $ref: '#/components/schemas/CreatewmsOrder--ShipMonk--' - $ref: '#/components/schemas/CreatewmsOrder--Shipping__and__Handling--' - $ref: '#/components/schemas/CreatewmsOrder--ShippingTree--' - $ref: '#/components/schemas/CreatewmsOrder--ShipStation--' - $ref: '#/components/schemas/CreatewmsOrder--ShipStream--' - $ref: '#/components/schemas/CreatewmsOrder--Shipwire--' - $ref: '#/components/schemas/CreatewmsOrder--SKUSavvy--' - $ref: '#/components/schemas/CreatewmsOrder--Linnworks__Core__-_SKUVault_---' - $ref: '#/components/schemas/CreatewmsOrder--Smart__Warehousing--' - $ref: '#/components/schemas/CreatewmsOrder--Sojo--' - $ref: '#/components/schemas/CreatewmsOrder--Star__WMS--' - $ref: '#/components/schemas/CreatewmsOrder--States__Logistics--' - $ref: '#/components/schemas/CreatewmsOrder--Stord--' - $ref: '#/components/schemas/CreatewmsOrder--TLogistics--' - $ref: '#/components/schemas/CreatewmsOrder--TPS--' - $ref: '#/components/schemas/CreatewmsOrder--Unis--' - $ref: '#/components/schemas/CreatewmsOrder--Unleashed--' - $ref: '#/components/schemas/CreatewmsOrder--Veeqo--' - $ref: '#/components/schemas/CreatewmsOrder--VeraCore--' - $ref: '#/components/schemas/CreatewmsOrder--Warehance--' - $ref: '#/components/schemas/CreatewmsOrder--Whiplash__-_Ryder_---' - $ref: '#/components/schemas/CreatewmsOrder--Xorosoft--' - $ref: '#/components/schemas/CreatewmsOrder--Zenfulfillment--' - $ref: '#/components/schemas/CreatewmsOrder--Zenventory--' - $ref: '#/components/schemas/CreatewmsOrder--Zoho--' title: CreatewmsOrderInputSchema wmsCreateOrderResponse: type: object properties: data: $ref: '#/components/schemas/CreateWmsOrderResponseDataSchema' id: type: string description: The ID of the object that has been created or modified example: id unused_fields: type: array description: Unused fields items: type: string description: '' example: unused_fields required: - id - unused_fields additionalProperties: false title: wmsCreateOrderResponse ValidationError: properties: error: type: string detail: type: object properties: : type: object properties: : type: array items: type: string required: - error type: object title: ValidationError CreatewmsOrder--WMS__Sandbox--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string enum: - N/A - Connect an account to see options description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: so_98512 channel_object: $ref: '#/components/schemas/SandboxChannelIdSchema' description: The channel the order was placed on. shipping_method_id: type: string enum: - N/A - Connect an account to see options description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground service_level: type: string description: The type of shipping method requested by the customer. example: Standard invoice_currency_code: type: string description: >- The currency used for this order. If not provided explicitly, defaults to USD. example: USD total_price: type: number description: The total price a customer paid for the order. example: 13.49 ship_to_address: $ref: '#/components/schemas/SandboxCreateOrderShipToAddress' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 1 items: $ref: '#/components/schemas/WmsOrderCreateLineItemsandbox' required: - order_number - reference_id - ship_to_address additionalProperties: false title: WMS Sandbox CreatewmsOrder--Active__Ants--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemactive-ants' ship_to_address: $ref: '#/components/schemas/ShipToAddressActive-Ants' order_type_id: type: string enum: - N/A — connect an account to see options description: Active Ants order type name example: order_type_id required: - line_items - order_type_id - reference_id - ship_to_address additionalProperties: false title: Active Ants CreatewmsOrder--A.__Duie__Pyle__-_ADP_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string maxLength: 22 description: A user-friendly identifier for their order. example: order_number reference_id: type: string maxLength: 22 description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/ShipToAddressAdp' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 uom: CT items: $ref: '#/components/schemas/WmsOrderCreateLineItemadp' required: - line_items - order_number - ship_to_address additionalProperties: false title: A. Duie Pyle (ADP) CreatewmsOrder--Amphora--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number invoice_currency_code: type: string description: The currency code for this order (e.g. EUR, USD). example: USD total_price: type: number description: The total price a customer paid for the order. example: 13.49 ship_to_address: $ref: '#/components/schemas/ShipToAddressAmphora' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemamphora' required: - invoice_currency_code - line_items - order_number - ship_to_address - total_price additionalProperties: false title: Amphora CreatewmsOrder--Amplifier--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number channel_object: $ref: '#/components/schemas/AmplifierChannelIdSchema' description: The channel the order was placed on. service_level: type: string description: The type of shipping method requested by the customer. example: Standard ship_to_address: $ref: '#/components/schemas/ShipToAddressAmplifier' bill_to_address: $ref: '#/components/schemas/BillToAddressAmplifier' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 1 description: Widget items: $ref: '#/components/schemas/WmsOrderWriteLineItemamplifier' required: - bill_to_address - line_items - order_number - service_level - ship_to_address additionalProperties: false title: Amplifier CreatewmsOrder--AMS--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} client_code: type: string description: The AMS-assigned client code the order should be created under. example: AB reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground channel_object: $ref: '#/components/schemas/ChannelIdSchema' description: The channel the order was placed on. required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' total_price: type: number description: The total price a customer paid for the order. example: 13.49 total_tax: type: number description: The total tax on the order. example: 1.5 total_discount: type: number description: The total amount discounted from the order. example: 2.5 total_shipping: type: number description: The total shipping cost for the order incurred by the customer. example: 3.5 ship_to_address: $ref: '#/components/schemas/ShipToAddressAms' bill_to_address: $ref: '#/components/schemas/BillToAddressAms' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemams' required: - bill_to_address - channel_object - client_code - line_items - reference_id - ship_to_address - shipping_method_id - warehouse_id additionalProperties: false title: AMS CreatewmsOrder--Staci__Americas__-_AMWare_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id ship_to_address: $ref: '#/components/schemas/ShipToAddressAmware' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemamware' shipping_method_id: type: string enum: - AEG0 - CPU - SRG - AMH - UP04 - UP05 - UP03 - UP01 - UP02 - UP08 - UP06 - UP12 - UP36 - UP37 - UP33 - SURP - UP15 - UP16 - UP17 - UP18 - UP35 - UP21 - UP13 - UP22 - UP19 - UP25 - UP20 - US02 - US03 - US18 - USPS - US04 - US05 - RASP - RSNU - RS2D - PP01 - PP02 - PP03 description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: AEG0 channel_object: $ref: '#/components/schemas/ChannelIdSchema' description: The channel the order was placed on. type: type: string enum: - d2c - b2b description: The type of order, such as d2c, b2b, dropship, or transfer. example: d2c order_type: type: string description: >- A free-text order flag (e.g. a sales channel like "TikTok"). Separate from `type`, which sets B2C / B2B billing. example: TikTok required: - line_items - reference_id - ship_to_address - warehouse_id additionalProperties: false title: Staci Americas (AMWare) CreatewmsOrder--Atomix--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number type: type: string enum: - dtc - b2b description: The type of order, such as d2c, b2b, dropship, or transfer. example: b2b shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground ship_to_address: $ref: '#/components/schemas/ShipToAddressAtomix' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItematomix' required: - line_items - reference_id - ship_to_address - shipping_method_id additionalProperties: false title: Atomix CreatewmsOrder--Bergen--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id payment_terms: type: string enum: - Net - COD - CC - WIRE description: Payment terms of the order. example: CC carrier_id: type: string enum: - GILBERT EAST - FREIGHT FORWARDER - ROUTING GUIDE - CUSTOMER PICKUP - TRUCK P/P - TRUCK F/C - FEDEX - DHL EXPRESS - BAX GLOBAL - TNT - UPS - USPS - UPS FREIGHT - JB HUNT - A&S TRUCKING SERVICE - PORT LOGISTICS GROUP - ESTES EXPRESS LINES - PITT OHIO - EXACTA MESSENGER - ROCKET MESSENGER - Front Line Freight - DMS EXPRESS - Messenger - KINGS EXPRESS - Gilbert Express - RANGER TRANSPORTATION INC - Fedex Freight east - Fedex Freight West - FREIGHTCO LOGISTICS - Vale Trucking - EDI TRUCKING - SWIFT TRANSPORT - PERFORMANCE TEAM - DISPATCH CENTRAL - warehouse transfer - NORTH EAST COURIERS INC - Old Dominion - Champion - YRC - All Time - BENJAMIN MAZER TRUCKING - VEECO SERVICES - CTE - GALE TRIANGLE - VISION EXPRESS - THE RIGHT MOVE - ABF - JAYDEE - BARNEYS - NEW DEAL - FOXS - NRT - T&M - MIGO TRUCKING - TRIANGLE - YELLOW FREIGHT - ROADWAY - Gilbert West - Pacific Logistics - City Fashion - Main Freight - Allstates Freight - NEW ENGLAND MOTOR FREIGHT - YAMATO TRANSPORTATION - PANALPINA - EXPEDITORS - DSV AIR & SEA - YUSEN AIR - HERCULES TRANSPORTATION - CITY GARMENT - US XPRESS - DYNAMIC - R&S TRANSPORTATION - Knight Transportation - WTG - SCHNEIDER TRANSPORT - Araiza Express - SELECT EXPRESS & LOGISTICS - INTERCARGO LOGISTICS - RoadEx America - ASSET TRANSFER - Fedex Freight Regional - UPS EU - National Retail Trans - EASTERN FREIGHT WAYS - Daylight Transport - Jet Speed - MOL - TOWNE AIR FREIGHT - ROADRUNNER - DIAMOND LOGISTICS - Global Spedition - Altruck Inc - DL EXpress - EVER CONCORD - LAND AIR EXPRESS - RONIE TRUCKING - JET SPEED AIR CARGO - DAX EXPRESS - J.O. TRUCKING INC - Same Day Delivery - KEYSTONE TRUCKING - ROBINSON TRANSPORTATION SERVICES - UNITED CENTURY EXPRESS C. - TI LOGISTICS - WTG. - FREIGHT FORCE - TY DELIVERY SERVICES - USF REDDAWAY INC - ClearLane Freight - Landstar - PASCHALL TRUCK LINES INBOUND - ARCTIC EXPRESS - SCHNEIDER - JRC - KINTETSU WORLD EXPRESS - TOPOCEAN CONSOLIDATION - DHL - Borderlinx - O.T Delivery - UBER - OAK HARBOR FREIGHT - Caltop Logistics - AFN - OCEAN ONE - NFI LOGISTICS - Jamex - DeCaro - Vanguard Logistics - ATS - CONWAY - ARCHILLA TRANSPORT - AMERICAN CARGO EXPRESS - Pacer - SKYWAY TRUCKING - New Rochell - RAPID DELIVERY SERVICE - REGIONAL TRUCKING - MRZ TRUCKING - BEO SUPPLY INC - FORWARD AIR - 1st Freight - WESTERN EXPRESS - GRANDVIEW - Cargo International - UPS SUPPLY CHAIN - AXIS GLOBAL LOGISTICS - FRESH AIR TRUCKING - CRST - CSA TRANSPORTATION - BLJ TRUCKING - EAGLE TRANSPORTATION - ADAMS THIRD WAVE CONSULTING - MERCER TRANSPORTATION - A DUIE PYLE - PIZA TRUCKING - MOUNTAIN VALLEY EXORESS - R & L Transfer - SAIA MOTOR FREIGHT - Celadon Trucking Services - NATIONAL RETAIL SYSTEMS INC. - DM TRANSPORTATION - JV Transportation - VSS TRANSPORTATION GROUP INC - GLS - INXP - Dependable Highway Express - GILBERT CONSOLIDATION - Crosby Trucking Inbound - SCOTT LOGISTICS - EXPO LOGISTICS - NEW PENN - West End Express - L-Freight - OCEAN ONE - Dms services - JSTAR - Land Air Express - CRYSTAL MOTORS - MAP CARGO - DHL GLOBAL FORWARDING - VOLPE EXPRESS - XPORT SERVICE - RANGER EXPRESS - T I Logistics - Roadrunner - WTG OTR Inbound - Bergen Truck EC - BLACKHAWK SOUTHWEST - SERVICE TRANSPORT - DOT-LINE TRANSPORTATION - HUB GROUP INTERMODAL - PAYSTAR LOGISTICS - SPI INTL TRANSPORTATION - SAIA INC - ALL CARTAGE - HASSET EXPRESS - HAWK TRANSPORTATION - WARD trucking - Diamond freight distribution INC - GOLDEN - Logical Logistics - Transport America Regional Fleet - CELADON - BEST OVERNITE LTL - HTL - APPAREL MOVERS - Keanes Cartage - BRUIN TRUCKING - Polaris Transport - OSBORN - FRONTLINE FREIGHT - BTX GLOBAL LOGISITICS - XPO LOGISTICS - J.Q. Trucking Inc - IMPULSE - SKYNET - Central Freight Lines Inc - DESANTIS - EXPORT SERVICES - PAI TRUCKING - Central Transport - AMERICAN TRUCKING - Shinju Express - AIR CITY - AMERICAN AIRFREIGHT TRUCKING - AAA TRUCKING - CONCORD TRUCKING - BREAKWAY CARRIER - FERSCHO TRUCKING - CH ROBINSON - MGR FREIGHT - DHL GLOBAL FORWARDING - A&F - CROWN TRUCKING - DYNAMIC EXPRESS - Premier Transportation Inbound - ALBATRANS - Fedex LTL - Prostar Logistics - INTERSTATE DISTRIBUTOR COMPANY - CSRT - USA TRUCK, INC. - EZ WORLDWIDE EXPRESS - BEAR TRANSPORTATION - TRICAP INTERNATIONAL - Unyson Logistics - NFI - Complete distribution solution - BNSF LOGISTICS LLC - SCHNEIDER NATIONAL - APC - TOTAL QUALITY LOGISTICS - TM LOGISTICS - Transplace - ZTC FREIGHT - Falcon Logistics - Transport America Inbound - FARMORE TRANSPORTATION - FNS DISTRIBUTING COMPNAY - FNS DISTRIBUTING COMPANY - JEM EXPRESS INC - KRG Logistics - Covenant Transport - Globaltranz description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: FEDEX shipping_method_id: type: string enum: - 1st Freight - AAAT - AAIE - ABFS - AFN - AHWE - ALBA WHEELS - ALBATRANS - ALCY - ALTR - ALUK - ANSW - APC LOGISTICS - APPAREL MOVERS - ARIE - ASSET - ASUR - AXIG - All Time - Araiza Express - BARNEYS - BAX GLOBAL GURANTEED- 1ST ARRIVAL - BAX GLOBAL GURANTEED- 2ND DAY - BAX GLOBAL GURANTEED- AIRPORT TO AIRPORT - BAX GLOBAL GURANTEED- OVERNIGHT - BAX GLOBAL STANDARD- 2ND DAY - BAX GLOBAL STANDARD- BAX SAVER - BAX GLOBAL STANDARD- NEXT AVAILABLE FLIGHT - BAX GLOBAL STANDARD- OVERNIGHT - BAX GLOBAL TRUCK - BAXG - BEOS - BLJF - BLKW - BNLS - BREAKWAY CARRIER - BRTK - BTG - BTVP - BTXA - Bergen Truck - Borderlinx - CAIE - CARRIER - CDNK - CDSS - CENF - CETR - CEVA LOGISTICS - CFX - CGMC - CH ROBINSON - CLFS - CNWY - CONC - COURIER EXPRESS LLC - CPPV - CPUP - CRGO - CRPS - CRWT - CRYS - CSAP - CSBI - CTQH - CUSTOMER TRUCK - Pickup By Customer - CVEN - Carrier - Celadon Trucking Services - Central Freight Lines Inc - Cosmo Freight Solutions - DAXX - DCDS - DFDO - DHE - DHL 2ND DAY - DHL 2ND DAY -Residential - DHL DOMESTIC PRIORITY - DHL DOMESTIC PRIORITY -Residential - DHL DOMESTIC STANDARD - DHL DOMESTIC STANDARD -Residential - DHL EASYSHOP - DHL EASYSHOP - SATURDAY DELIVERY - DHL ECONOMY SELECT - DHL ECONOMY SELECT - SATURDAY DELIVERY - DHL EUROPACK - DHL EUROPACK - SATURDAY DELIVERY - DHL EXPRESS 10:30 - DHL EXPRESS 10:30 - SATURDAY DELIVERY - DHL EXPRESS 12:00 - DHL EXPRESS 12:00 - SATURDAY DELIVERY - DHL EXPRESS 9:00 - DHL EXPRESS 9:00 - SATURDAY DELIVERY - DHL EXPRESS WORLDWIDE - DHL EXPRESS WORLDWIDE - SATURDAY DELIVERY - DHL GLOBAL FORWARDING - DHL GROUND - DHL GROUND -Residential - DHL INTL PRIORITY - DHL INTL PRIORITY -Residential - DHL INTL STANDARD - DHL INTL STANDARD -Residential - DHL NEXT DAY 10:30 - DHL NEXT DAY 10:30 -Residential - DHL NEXT DAY 12PM - DHL NEXT DAY 12PM -Residential - DHL NEXT DAY 3PM - DHL NEXT DAY 3PM -Residential - DHL SATURDAY DELIVERY(OPTIONAL) - DHL SATURDAY DELIVERY(OPTIONAL) -Residential - DHLG - DISP - DMRG - DMSD - DOLR - DSV1 - DYEX - DYLT - DYXI - DYXT - Daylight Transport - EDI - EFWY - ESDR - ETSI - EVCD - EXLA - EXPD - EZWO - FCLL - FCSY - FEDEX 2Day - Commercial - FEDEX 2Day - Residential - FEDEX 2Day - SATURDAY DELIVERY - Commercial - FEDEX 2Day - SATURDAY DELIVERY - Residential - FEDEX Express Saver - Commercial - FEDEX Express Saver - Residential - FEDEX First Overnight - Commercial - FEDEX First Overnight - Residential - FEDEX Ground - Commercial - FEDEX Ground - Residential - FEDEX International Economy - Commercial - FEDEX International Economy - Residential - FEDEX International Ground (to Canada) - Commercial - FEDEX International Ground (to Canada) - Residential - FEDEX International Priority - Commercial - FEDEX International Priority - Residential - FEDEX Priority Overnight - Commercial - FEDEX Priority Overnight - Residential - FEDEX Standard Overnight - Commercial - FEDEX Standard Overnight - Residential - FETR - FFFF - FLOG - FMTS - FNSD - FORWARD AIR - FORWARDER - FOXS - FREIGHT - FREIGHT FORWARDER - FRESH AIR TRUCKING - FWDR - FXFE - FXFW - FXNL - Falcon Logistics - GADQ - GBEA - GBXI - GILBERT EAST - GLS Standard - GLTN - GOLD - GRWE - Gilbert Express - Globaltranz - HACC - HAXS - HJBT - HRCF - HTL GROUND - HUBG - IMPULSE - INTD - INXPRESS - J.O. TRUCKING INC - JANEL GROUP - JDFD - JEM EXPRESS INC. - JEMA - JETP - JETS - JQTR - JRS TRUCKING - JRSK - JV Transportation - Jefron - KCSS - KIGE - KNIG - KRGS - KWEO - KYSO - LAEX - LAND - LFGT - LTL - Land Air Express - Landstar - Logical Logistics - MAPC - MAZR - MCET - MESSENGER - MGRF - MIGO TRUCKING - MRZT - MSNG - MVEX - Main Freight - Metro Trucking - NAFT - NART - NDCW - NDLO - NECI - NEMF - NEW PENN - NRCL - NRD - OAKH - ODFL - OSTP - OTDS - PASC - PAYL - PFLP - PITD - PNE1 - POGM - POLT - PSLP - PTAG - PYLE - PYLR - PZAT - RBTW - RDFS - RDSC - RDWY - RDXA - RGTR - RNGR - RNLO - ROTR - ROUTING GUIDE - RSTN - RTNG - RXPF - Rock freight system - SAIA - SAMD - SCDS - SCGP - SCNN - SIVP - SKYNET Worldwide Express - SRVP - SWFT - SXLT - T I Logistics - T&M - T-soon trucking - TCAM - TCSI - TGIR - TGNA - THE RIGHT MOVE - TMLS - TNT DOMESTICS- TRUCK - TNT DOMESTICS- USA EXPRESS - TNT DOMESTICS- USA GROUND - TNT INTL- 12PM EXPRESS - TNT INTL- 9PM EXPRESS - TNT INTL- ECONOMY EXPRESS - TNT INTL- GLOBAL EXPRESS - TNT INTL- NEXT DAY - TODL - TODM - TPFF - TPQL - TPXY - TQYL - TRMI - TRUCK F/C TRUCK F/C - TRUCK P/P TRUCK P/P - TRUCKING - TYDS - Transport America Inbound - Trucking - UBER - UCEC - UCL trucking - UPGF - UPS 2ND DAY AIR - Commercial - UPS 2ND DAY AIR - Residential - UPS 2ND DAY AIR AM - Commercial - UPS 2ND DAY AIR AM - Residential - UPS 3 DAY SELECT - Commercial - UPS 3 DAY SELECT - Residential - UPS Expedited - UPS Express - UPS Express Saver - UPS FREIGHT - UPS GROUND - Commercial - UPS GROUND - Residential - UPS NEXT DAY AIR - Commercial - UPS NEXT DAY AIR - Residential - UPS NEXT DAY AIR EARLY AM - Commercial - UPS NEXT DAY AIR EARLY AM - Residential - UPS NEXT DAY AIR SAVER - Commercial - UPS NEXT DAY AIR SAVER - Residential - UPS Standard - UPS WORLD SHIP EXPEDITED - Commercial - UPS WORLD SHIP EXPEDITED - Residential - UPS WORLD SHIP EXPRESS - Commercial - UPS WORLD SHIP EXPRESS - Residential - UPS WORLD SHIP EXPRESS PLUS- Commercial - UPS WORLD SHIP EXPRESS SAVER- Commercial - UPS WORLD SHIP EXPRESS SAVER- Residential - UPSF - USFR - USIT - USPS DOM 1ST CLASS - USPS DOM EXPRESS - USPS DOM PARCEL POST - USPS DOM PRIORITY - USPS GLOB 1ST CLASS PACKAGE - USPS GLOB AIRMAIL - USPS GLOB EXP GTD - USPS GLOB EXP MAIL - USPS GLOB PRI MAIL - USPS Media Mail - USPS United States Postal Service - USXI - UYSN - VALT - VHLC - VIEX - VISION EXPRESS - VOEX - VSS TRANSPORTATION GROUP INC - VSXP - WEXI - WHTN - WMI - WRDT - WTGG - XPORT - YAT1 - YFSY - YUS1 - ZTCF description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: 1st Freight billing_option: type: string enum: - Prepaid - Freight Collect - Third Party - Consignee Bill - Collect Billing description: Billing option of the order. example: Collect Billing ship_to_address: $ref: '#/components/schemas/ShipToAddressBergen' bill_to_address: $ref: '#/components/schemas/BillToAddressBergen' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItembergen' order_type: type: string enum: - Web - Wholesale - Retail - Dropship - CrossDock description: Type of the order. example: CrossDock order_number: type: string description: A user-friendly identifier for their order. example: order_number order_date: type: string format: date-time description: Date the order was placed. example: '2023-09-28T00:00:00Z' start_date: type: string format: date-time description: Earliest date the order can ship. example: '2023-10-01T00:00:00Z' cancel_date: type: string format: date-time description: Date after which the order should be cancelled if not shipped. example: '2023-10-15T00:00:00Z' required: - billing_option - carrier_id - line_items - order_number - order_type - payment_terms - ship_to_address - shipping_method_id - warehouse_id additionalProperties: false title: Bergen CreatewmsOrder--BEST__Inc.--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id order_number: type: string description: A user-friendly identifier for their order. example: order_number carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex service_level: type: string description: The type of shipping method requested by the customer. example: Standard is_third_party_freight: type: boolean description: True if the order was shipped using a third party freight account. example: false third_party_freight_account_number: type: - string - 'null' description: >- The carrier account number to bill when is_third_party_freight is true. example: '123456' invoice_currency_code: type: string enum: - USD - CAD - CNY - THB description: >- The currency for this order. Best Inc. supports USD, CAD, CNY, and THB. example: USD total_price: type: number description: The total price a customer paid for the order. example: 13.49 total_shipping: type: number description: The total shipping cost for the order incurred by the customer. example: 3.5 ship_to_address: $ref: '#/components/schemas/ShipToAddressBest-Inc' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItembest-inc' required: - carrier_id - line_items - ship_to_address - warehouse_id additionalProperties: false title: BEST Inc. CreatewmsOrder--BlueBox__-_IDrive__Fulfillment_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/ShipToAddressBluebox' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItembluebox' carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground trading_partner: type: string description: >- For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart). example: Target required: - carrier_id - line_items - reference_id - ship_to_address - shipping_method_id additionalProperties: false title: BlueBox (IDrive Fulfillment) CreatewmsOrder--Boxzooka--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id shipping_method_id: type: string enum: - BXZ.PKP - BXZ.USA.1 - BXZ.USA.2 - BXZ.USA.3 - BXZ.USA.5 - BXZ.USA.7 - UPS.EXP.1 - UPS.DOM.1 - UPS.DOM.2 - UPS.DOM.3 - UPS.GRD.RESI - SUREPOST - USPS.PRIORITY - USPS.GRD - USPS.EXPRESS - FDX.EXP.1 - FDX.DOM.1 - FDX.DOM.2 - FDX.DOM.3 - FDX.GRD - FDX.GRD.COLLECT - FDX.HOME - SMARTPOST - DHLEC.GRD - DHLEC.MAX - FDX.INTL.ECO - FDX.CONNECT.PLUS - UPS.INTL.EXP - DHLEC.PLT description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Must be one of Boxzooka's documented method codes, e.g. FDX.GRD or UPS.GRD.RESI. example: BXZ.PKP total_price: type: number description: The total price a customer paid for the order. example: 13.49 ship_to_address: $ref: '#/components/schemas/CreateOrderShipToAddressBoxzooka' line_items: type: array description: List of the products included in the order. example: - sku: sku name: Crew Tee - XS / White quantity: 0 weight: 1.5 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemboxzooka' type: type: string enum: - d2c - b2b - dropship description: The type of order, such as d2c, b2b, dropship, or transfer. example: d2c required: - line_items - reference_id - ship_to_address - shipping_method_id - total_price additionalProperties: false title: Boxzooka CreatewmsOrder--Camelot--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string maxLength: 30 description: A user-friendly identifier for their order. example: order_number ship_to_address: $ref: '#/components/schemas/ShipToAddressCamelot' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemcamelot' required: - line_items - order_number - ship_to_address additionalProperties: false title: Camelot CreatewmsOrder--Capacity--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} shipping_method_id: type: string enum: - DHL SmartMail Parcel Expedited Max - DHL SmartMail Parcel Plus Expedited Max - FedEx Home - FedEx 2nd Day Air - UPS Ground Residential - USPS Priority Mail - FedEx Express Saver - UPS 2nd Day Air - UPS 3 Day Select - UPS Next Day Air Saver - FedEx Standard Overnight - Free - 3-4 Day - 2-3 Day - 1-2 Day - FedEx Overnight Saturday Delivery - DHL International Standard - FedEx Priority Overnight - OpenBorder - DHL Parcel International Direct - Customer Pickup - USPS Ground Advantage description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: 1-2 Day line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemcapacity' ship_to_address: $ref: '#/components/schemas/ShipToAddressCapacity' order_number: type: string description: A user-friendly identifier for their order. example: order_number required: - line_items - order_number - ship_to_address - shipping_method_id additionalProperties: false title: Capacity CreatewmsOrder--CartonCloud--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id ship_to_address: $ref: '#/components/schemas/ShipToAddressCarton-Cloud' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemcarton-cloud' service_level: type: string description: Requested shipping service level example: service_level required_ship_date: type: string format: date-time description: Required delivery date (YYYY-MM-DD) example: '2023-03-15T13:45:30Z' required: - line_items - reference_id - ship_to_address additionalProperties: false title: CartonCloud CreatewmsOrder--Clarus--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' ship_to_address: $ref: '#/components/schemas/ClarusCreateOrderShipToAddressClarus' line_items: type: array description: List of the products included in the order. example: - product_id: '108' sku: '40116' quantity: 1 items: $ref: '#/components/schemas/WmsOrderCreateLineItemclarus' required: - line_items - reference_id - required_ship_date - ship_to_address - warehouse_id additionalProperties: false title: Clarus CreatewmsOrder--J_AMP_J__Global__Fulfillment__-_Control__Port_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id channel_object: $ref: '#/components/schemas/ControlportChannelIdSchema' description: The channel the order was placed on. type: type: string enum: - d2c - b2b description: The type of order, such as d2c, b2b, dropship, or transfer. example: d2c postage_speed: type: integer description: >- How fast the order should ship. 0 is urgent (fastest, most expensive), 3 is economy (cheapest, slowest). example: 2 preferred_carrier_id: type: integer description: >- The carrier to prefer when choosing a shipping service for the order. example: 1 international_duty_paid_by: type: string enum: - sender - recipient description: Who pays international duties on the order. example: sender invoice_currency_code: type: string description: >- The currency used for this order. If not provided, uses the account default. example: GBP total_price: type: number description: The total price a customer paid for the order. example: 13.49 total_shipping: type: number description: The total shipping cost for the order incurred by the customer. example: 3.5 warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id ship_to_address: $ref: '#/components/schemas/CreateOrderShipToAddressControlport' bill_to_address: $ref: '#/components/schemas/CreateOrderBillToAddressControlport' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 1 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemcontrolport' required: - bill_to_address - channel_object - line_items - reference_id - ship_to_address additionalProperties: false title: J&J Global Fulfillment (Control Port) CreatewmsOrder--Darwynn__Fulfillment--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number type: type: string enum: - b2b - d2c description: The type of order, such as d2c, b2b, dropship, or transfer. example: d2c warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex service_level: type: string enum: - Standard - Expedited description: >- The type of shipping method requested by the customer. Darwynn courier SLA: Standard or Expedited. example: Standard operation_sla: type: string enum: - Standard - Expedited - Priority description: >- Darwynn pick/processing SLA: Standard (24-48h), Expedited (same day), or Priority (3h rush). example: Standard signature_required: type: boolean description: '' example: true required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' note: type: string description: '' example: note from_plat_code: type: string description: '' example: from_plat_code shop_id: type: string description: '' example: shop_id ship_to_address: $ref: '#/components/schemas/ShipToAddressDarwynn-Fulfillment' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemdarwynn-fulfillment' required: - carrier_id - line_items - operation_sla - order_number - required_ship_date - service_level - ship_to_address - type - warehouse_id additionalProperties: false title: Darwynn Fulfillment CreatewmsOrder--DCL--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string pattern: ^[^a-z]*$ description: >- The order number for the order in DCL. Must be uppercase (letters, digits, '#' or '-', max 25 characters). Auto-generated if not provided. example: ORDER-1001 freight_account: type: string description: >- Which account to bill for freight. To charge DCL, use 00500, for Collect shipment use 99999, to charge the customer use the customer's account number, to a third party account use 00000. If left blank, the customer's account number will be used. example: '00500' shipping_instructions: type: string description: >- Instructions for the warehouse's distribution clerks. Not printed on the packing list. example: Ship with ice packs custom_field1: type: string description: Custom field 1. example: custom value custom_field2: type: string description: Custom field 2. example: custom value custom_field3: type: string description: Custom field 3. example: custom value custom_field4: type: string description: Custom field 4. For B2B orders, DCL stores the vendor number here. example: custom value custom_field5: type: string description: Custom field 5. example: custom value shipping_method_id: type: string enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - '10' - '11' - '12' - '13' - '14' - '15' - '16' - '17' - '18' - '19' - '20' - '21' - '22' - '23' - '24' - '25' - '26' - '27' - '28' - '29' - '30' - '31' - '32' - '33' - '34' - '35' - '36' - '37' - '38' - '39' - '40' - '41' - '42' - '43' - '44' - '45' - '46' - '47' - '48' - '49' - '50' - '51' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '60' - '61' - '62' - '63' - '64' - '65' - '66' - '67' - '68' - '69' - '70' - '71' - '72' - '73' - '74' - '75' - '76' - '77' - '78' - '79' - '80' - '81' - '82' - '83' - '84' - '85' - '86' - '87' - '88' - '89' - '90' - '91' - '92' - '93' - '94' - '95' - '96' - '97' - '98' - '99' - '100' - '101' - '102' - '103' - '104' - '105' - '106' - '107' - '108' - '109' - '110' - '111' - '112' - '113' - '114' - '115' - '116' - '117' - '118' - '119' - '120' - '121' - '122' - '123' - '124' - '125' - '126' - '127' - '128' - '129' - '130' - '131' - '132' - '133' - '134' - '135' - '136' - '137' - '138' - '139' - '140' - '141' - '142' - '143' - '144' - '145' - '146' - '147' - '148' - '149' - '150' - '151' - '152' - '153' - '154' - '155' - '156' - '157' - '158' - '159' - '160' - '161' - '162' - '163' - '164' - '165' - '166' - '167' - '168' - '169' - '170' - '171' - '172' - '173' - '174' - '175' - '176' - '177' - '178' - '179' - '180' - '181' - '182' - '183' - '184' - '185' - '186' - '187' - '188' - '189' - '190' - '191' - '192' - '193' - '194' - '195' - '196' - '197' - '198' - '199' - '200' - '201' - '202' - '203' - '204' - '205' - '206' - '207' - '208' - '209' - '210' - '211' - '212' - '213' - '214' - '215' - '216' - '217' - '218' - '219' - '220' - '221' - '222' - '223' - '224' - '225' - '226' - '227' - '228' - '229' - '230' - '231' - '232' - '233' - '234' - '235' - '236' - '237' - '238' - '239' - '240' - '241' - '242' - '243' - '244' - '245' - '246' - '247' - '248' - '249' - '250' - '251' - '252' - '253' - '254' - '255' - '256' - '257' - '258' - '259' - '260' - '261' - '262' - '263' - '264' - '265' - '266' - '267' - '268' - '269' - '270' - '271' - '272' - '273' - '274' - '275' - '276' - '277' - '278' - '279' - '280' - '281' - '282' - '283' - '284' - '285' - '286' - '287' - '288' - '289' - '290' - '291' - '292' - '293' - '294' - '295' - '296' - '297' - '298' - '299' - '300' - '301' - '302' - '303' - '304' - '305' - '306' - '307' - '308' - '309' - '310' - '311' - '312' - '313' - '314' - '315' - '316' - '317' - '318' - '319' - '320' - '321' - '322' - '323' - '324' - '325' - '326' - '327' - '328' - '329' - '330' - '331' - '332' - '333' - '334' - '335' - '336' - '337' - '338' - '339' - '340' - '341' - '342' - '343' - '344' - '345' - '346' - '347' - '348' - '349' - '350' - '351' - '352' - '353' - '354' - '355' - '356' - '357' - '358' - '359' - '360' - '361' - '362' - '363' - '364' - '365' - '366' - '367' - '368' - '369' - '370' - '371' - '372' - '373' - '374' - '375' - '376' - '377' - '378' - '379' - '380' - '381' - '382' - '383' - '384' - '385' - '386' - '387' - '388' - '389' - '390' - '391' - '392' - '393' - '394' - '395' - '396' - '397' - '398' - '399' - '400' - '401' - '402' - '403' - '404' - '405' - '406' - '407' - '408' - '409' - '410' - '411' - '412' - '413' - '414' - '415' - '416' - '417' - '418' - '419' - '420' - '421' - '422' - '423' - '424' - '425' - '426' - '427' - '428' - '429' - '430' - '431' - '432' - '433' - '434' - '435' - '436' - '437' - '438' - '439' - '440' - '441' - '442' - '443' - '444' - '445' - '446' - '447' - '448' - '449' - '450' - '451' - '452' - '453' - '454' - '455' - '456' - '457' - '458' - '459' - '460' - '461' - '462' - '463' - '464' - '465' - '466' - '467' - '468' - '469' - '470' - '471' - '472' - '473' - '474' - '475' - '476' - '477' - '478' - '479' - '480' - '481' - '482' - '483' - '484' - '485' - '486' - '487' - '488' - '489' - '490' - '491' - '492' - '493' - '494' - '495' - '496' - '497' - '498' - '499' - '500' - '501' - '502' - '503' - '504' - '505' - '506' - '507' - '508' - '509' - '510' - '511' - '512' - '513' - '514' - '515' - '516' - '517' - '518' - '519' - '520' - '521' - '522' - '523' - '524' - '525' - '526' - '527' - '528' - '529' - '530' - '531' - '532' - '533' - '534' - '535' - '536' - '537' - '538' - '539' - '540' - '541' - '542' - '543' - '544' - '545' - '546' - '547' - '548' - '549' - '550' - '551' - '552' - '553' - '554' - '555' - '556' - '557' - '558' - '559' - '560' - '561' - '562' - '563' - '564' - '565' - '566' - '567' - '568' - '569' - '570' - '571' - '572' - '573' - '574' - '575' - '576' - '577' - '578' - '579' - '580' - '581' - '582' - '583' - '584' - '585' - '586' - '587' - '588' - '589' - '590' - '591' - '592' - '593' - '594' - '595' - '596' - '597' - '598' - '599' - '600' - '601' - '602' - '603' - '604' - '605' - '606' - '607' - '608' - '609' - '610' - '611' - '612' - '613' - '614' - '615' - '616' - '617' - '618' - '619' - '620' - '621' - '622' - '623' - '624' - '625' - '626' - '627' - '628' - '629' - '630' - '631' - '632' - '633' - '634' - '635' - '636' - '637' - '638' - '639' - '640' - '641' - '642' - '643' - '644' - '645' - '646' - '647' - '648' - '649' - '650' - '651' - '652' - '653' - '654' - '655' - '656' - '657' - '658' - '659' - '660' - '661' - '662' - '663' - '664' - '665' - '666' - '667' - '668' - '669' - '670' - '671' - '672' - '673' - '674' - '675' - '676' - '677' - '678' - '679' - '680' - '681' - '682' - '683' - '684' - '685' - '686' - '687' - '688' - '689' - '690' - '691' - '692' - '693' - '694' - '695' - '696' - '697' - '698' - '699' - '700' - '701' - '702' - '703' - '704' - '705' - '706' - '707' - '708' - '709' - '710' - '711' - '712' - '713' - '714' - '715' - '716' - '717' - '718' - '719' - '720' - '721' - '722' - '723' - '724' - '725' - '726' - '727' - '728' - '729' - '730' - '731' - '732' - '733' - '734' - '735' - '736' - '737' - '738' - '739' - '740' - '741' - '742' - '743' - '744' - '745' - '746' - '747' - '748' - '749' - '750' - '751' - '752' - '753' - '754' - '755' - '756' - '757' - '758' - '759' - '760' - '761' - '762' - '763' - '764' - '765' - '766' - '767' - '768' - '769' - '770' - '771' - '772' - '773' - '774' - '775' - '776' - '777' - '778' - '779' - '780' - '781' - '782' - '783' - '784' - '785' - '786' - '787' - '788' - '789' - '790' - '791' - '792' - '793' - '794' - '795' - '796' - '797' - '798' - '799' - '800' - '801' - '802' - '803' - '804' - '805' - '806' - '807' - '808' - '809' - '810' - '811' - '812' - '813' - '814' - '815' - '816' - '817' - '818' - '819' - '820' - '821' - '822' - '823' - '824' - '825' - '826' - '827' - '828' - '829' - '830' - '831' - '832' - '833' - '834' - '835' - '836' - '837' - '838' - '839' - '840' - '841' - '842' - '843' - '844' - '845' - '846' - '847' - '848' - '849' - '850' - '851' - '852' - '853' - '854' - '855' - '856' - '857' - '858' - '859' - '860' - '861' - '862' - '863' - '864' - '865' - '866' - '867' - '868' - '869' - '870' - '871' - '872' - '873' - '874' - '875' - '876' - '877' - '878' - '879' - '880' - '881' - '882' - '883' - '884' - '885' - '886' - '887' - '888' - '889' - '890' - '891' - '892' - '893' - '894' - '895' - '896' - '897' - '898' - '899' - '900' - '901' - '902' - '903' - '904' - '905' - '906' - '907' - '908' - '909' - '910' - '911' - '912' - '913' - '914' - '915' - '916' - '917' - '918' - '919' - '920' - '921' - '922' - '923' - '924' - '925' - '926' - '927' - '928' - '929' - '930' - '931' - '932' - '933' - '934' - '935' - '936' - '937' - '938' - '939' - '940' - '941' - '942' - '943' - '944' - '945' - '946' - '947' - '948' - '949' - '950' - '951' - '952' - '953' - '954' - '955' - '956' - '957' - '958' - '959' - '960' - '961' - '962' - '963' - '964' - '965' - '966' - '967' - '968' - '969' - '970' - '971' - '972' - '973' - '974' - '975' - '976' - '977' - '978' - '979' - '980' - '981' - '982' - '983' description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Must pass in shipping_method_id or shipping_method_name + carrier_id example: '1' shipping_method_name: type: string enum: - STANDARD OVERNIGHT OR - 2ND DAY AIR-APH - 3DAY - Express Plus - GROUND SERVICE COMMERCIAL - PRIORITY OVERNIGHT OR - EXPEDITERS - SCH - INT CUSTOMS BROKERAGE - STANDARD OVERNIGHT RES-SR - INT IMPORT - TX POOL DISTRIBUTION - GROUND ADVANTAGE SR PB - 2ND DAY - 2ND DAY AIR - HOME DELIVERY-CSR - DOMESTIC AIR - SM Parcel Plus Expedited Max - WORLDWIDE EXPEDITED-SR - WORLDWIDE EXPRESS SAVER-SR - INTERNATIONAL CONNECT PLUS - 3 DAY SELECT-SR RS - GUIDE - NEXT DAY AIR SATURDAY SR - FIRST-CLASS MAIL PB - EXPRESS SAVER RESIDENTIAL RS - 2DAY-RPDCS - Express Worldwide-NDS - STANDARD INTRASTATE CA - GROUND SERVICE RESIDENTIAL RS - NEXT DAY AIR SAVER RES-SR - Priority Mail FRB S PB - LCL OCEAN - PRIORITY OVERNIGHT RES-CSR - GROUND RS - PRIORITY OVERNIGHT SATURDAY RE - PRIORITY OVERNIGHT -SR - GROUND RESIDENTIAL-RPS - 2 Day - TX POOL FLEX - HOME DELIVERY-RPDCS - SM Parcels Expedited RS - EXPRESS SAVER-RPS - Standard Overnight - INSIDE DELIVERY - 3 DAY SERVICE - 3 DAY SELECT RES-SR - 3DAY-RPS - PRIORITY OVERNIGHT RS - CANADA - 3 DAY SELECT-PRS - 2ND DAY AIR RES-SR - WORLDWIDE - EXPRESS WORLDWIDE - GROUND SERVICE - Regional - TRUCK-GROUND - 2DAY OR RS - First Overnight RES-ASR - 3 DAYS SELECT - LTL FREIGHT - International - Priority Mail FRB M PB - FIRST CLASS PACKAGE INT - 2ND DAY AIR SATURDAY-PRS - EXPRESS SAVER OR - GROUND SERVICE COMMERCIAL-PRS - GROUND ADVANTAGE ASR PB - Overnight - PARCEL INTERNATIONAL DIRECT - SERVICE METHOD - PRIORITY OVERNIGHT RESIDENTIAL - NEXT DAY AIR SATURDAY - SOUTHERN-US - GROUND RESIDENTIAL - GROUND SERVICE RES-SR - PRIORITY MAIL PB - DEFERRED AIR - EXPRESS SAVER - WORLDWIDE EXPRESS FREIGHT - AIR FREIGHT DIRECT INT - NEXT DAY AIR SAVER-APH RS - STANDARD INTL. - NEXT DAY AIR-PRS - PRIORITY MAIL EXPRESS INT - Ground - 2ND DAY AIR FREIGHT - 3DAY-RPDCS - 2ND DAY AIR SATURDAY-APH RS - AIR STANDARD - PRIORITY OVERNIGHT-RPS - FCL OCEAN - NEXT DAY AIR SATURDAY-PRS - Room of Choice-PRS - 2ND DAY AIR AM -SR - COLLECT - GLOBAL FORWARDING - PRIORITY OVERNIGHT SATURDAY RS - GROUND SERVICE COMMERCIAL RS - NEXT DAY AIR SAVER - NEXT DAY AIR SAVER-APH - FIRST-CLASS PACKAGE INT PB - 3 DAY SELECT-SR - PICKUP - 2 DAY SERVICE - 2DAY FREIGHT - EXPRESS SAVER RS - EXPEDITED - TL - SUNRISE - TRUCKLOAD - DOOR TO DOOR - HOME DELIVERY-SR - NEXT DAY AIR FREIGHT NGS - GROUND SERVICE RES-ASR - 2DAY-RPS - BES - 3DAY RESIDENTIAL RS - DOMESTIC GROUND - 3RD DAY AIR FREIGHT NGS - 3 DAY - Parcel Select - FIRST CLASS-ASR - INTERNATIONAL STANDARD DDP - To the Door - STANDARD OVERNIGHT - NEXT DAY AIR EARLY AM-APH RS - GROUND-ASR - PRIORITY MAIL EXPRESS INT PB - STANDARD OVERNIGHT SR - URGENT - 3 DAY SELECT-APH RS - WORLDWIDE EXPRESS SAVER - Through the Door-PRS - First Overnight - 3rd DAY - EXPRESS - Packet International - 2ND DAY AIR SATURDAY-APH - NEXT DAY AIR SAVER-PRS - STANDARD INTERSTATE - USPS PARCEL SELECT - Ground Economy Standard Mail - 2ND DAY AIR AM-APH - RETAIL GROUND PB - STANDARD OVERNIGHT-RPDCS - PRIORITY MAIL EXPRESS PB - SELECT - FIRST CLASS-SR - SPECIAL DELIVERY - DEFERRED 3-5 DAY - AIR FREIGHT - GROUND ADVANTAGE RS PB - GROUND RESIDENTIAL RS - 3DAY FREIGHT - EXPEDIT - INTERNATIONAL ECONOMY - MPS - AIR - AM - EXPRESS ECONOMY - LIGHTWEIGHT PARCEL - Priority Mail International PB - INT LCL - HOME DELIVERY - EXPRESS SAVER FREIGHT - EXPRESS SAVER SR - RUSH 1-HR DIRECT - WORLDWIDE EXPRESS SAVER-ASR - HOME DELIVERY-ASR - SPECIAL INTRASTATE CA - STANDARD OVERNIGHT RESIDEN RS - INTERNATIONAL PRIORITY MPS - EXPEDITED TO CANADA - GROUND RESIDENTIAL-RPDCS - TX POOL PM - 3DAY RES-ASR - INTL CONSOLIDATE FREIGHT PR - STANDARD OVERNIGHT-RPS - Express Worldwide - TX POOL AM - STD. INTERSTATE - 3-5 DAY - 3DAY RS - WORLDWIDE EXPEDITED-ASR - PRIORITY OVERNIGHT-RPDCS - 2ND DAY AIR-PRS - First Overnight RESIDENTIAL RS - GROUND ADVANTAGE PB - FL POOL - NEXT DAY AIR RESIDENTIAL-ASR - 2ND DAY AIR SATURDAY RS - 3 DAY SELECT RES-ASR - PRIORITY OVERNIGHT - 2DAY RES-SR - First Overnight RES-SR - Parcel Select Ground PB - GROUND ADVANTAGE - 2ND DAY AIR-APH RS - SM Parcel Plus Expedited - STANDARD TO CANADA-SR - 2DAY RES-CSR - STANDARD OVERNIGHT RES-CSR - WORLDWIDE EXPRESS - International Air - NEXT DAY AIR - PRIORITY MAIL RS PB - SPECIAL 1-2 HOUR - GROUND-APH - NEXT DAY AIR RES-SR - DG Routing - TEST - EXPRESS MAIL ACSR PB - 2 DAY - INTERNATIONAL ECONOMY - PARCEL SELECT - Expedited - DCL - NEXT DAY AIR SATURDAY RESIDENT - NEXT DAY AIR SATURDAY-APH RS - GROUND DELIVERY - PRIORITY EXPRESS - STANDARD TO MEXICO - WORLDWIDE EXPEDITED - WORLD EASE - INTL AIR - OCEAN - 2DAY RESIDENTIAL - 3DAY RESIDENTIAL - Priority Mail FRB L PB - Parcel Select Lightweight - EXPRESS AIR - INTERNATIONAL PRIORITY-SR - FIRST CLASS MAIL - STANDARD - PRIORITY OVERNIGHT RESIDENT RS - AIR EXPRESS - EXPEDITE - Expedited Canada - NEXT DAY - HOME DELIVERY-RPS - INT EXPORT - NON CONTINENTAL STANDARD - Economy - 3DAY RES-SR - 2ND DAY AIR AM RS - First Overnight RES-CSR - FREIGHT - NEXT DAY AIR EARLY AM-APH - 2ND DAY AIR-SR - EXPRESS PREMIUM - 3 Day - FREIGHT SERVICES - PRIORITY OVERNIGHT SATURDAY - INT FCL - GROUND EXPEDITED - SAMEDAY - OVERNIGHT FREIGHT - 3 DAY SELECT RESIDENTIAL - INTERNATIONAL PRIORITY-CSR - BEST WAY RATE - GROUND SERV RESIDENTIAL-SR RS - NEXT DAY AIR EARLY AM - CA POOL W2 - 2ND DAY AIR AM - PRIME - SM Parcel Expedited Max RS - STANDARD PREMIUM DDP - INTERNATIONAL ECONOMY-CSR - Ground Economy PS - 3 DAY SELECT - NIE - INTERNATIONAL CONNECT PLUS-SR - 2DAY SAT OR - First Overnight Freight - INTERNATIONAL GROUND - FTL - PRI DDU DC - ECONOMY SERVICE - NEXT DAY AIR SAVER RES-ASR - NEXT DAY AIR SAVER RS - PRIORITY OVERNIGHT RES-SR - 2DAY OR - NEXT DAY AIR-APH RS - INT CUSTOMS CLEARANCE - 2ND DAY AIR RESIDENTIAL - 2DAY-SR - CA POOL W1 - INTERNATIONAL ECONOMY FREIGHT - SEE ROUTING GUIDE - 2ND DAY AIR RESIDENTIAL RS - EXPRESS SAVER RESIDENTIAL - OVERNIGHT - EXPRESS MAIL ASR PB - STANDARD AIR - 3 DAY SELECT RESIDENTIAL RS - 1DAY FREIGHT - VALUE EXPRESS - INTERNATIONAL ECONOMY-SR - EPKT DDP - TRANSPORTATION - REGULAR 2-4 HOUR - NEXT DAY AIR FREIGHT - SM Parcel Plus Exp Max RS - PRIORITY OVERNIGHT RES-ASR - MAIL INNOVATIONS - 2DAY RESIDENTIAL RS - SM Parcel Plus Expedited RS - GROUND-SR - 2DAY RES-ASR - STANDARD OVERNIGHT RES-ASR - 3DAY RES-CSR - TRANSPORTATION STANDARD - WORLDWIDE EXPRESS-ASR - STANDARD OVERNIGHT RESIDENTIAL - SUNRISE GOLD - First Overnight-RPDCS - DIRECT - STANDARD TO CANADA - STD INTERSTATE - PRIORITY - EXPRESS SAVER RES-ASR - Parcel International Standard - NFO - WAREHOUSE-LTL - NEXT DAY AIR EARLY AM-SR RS - NEXT DAY AIR RESIDENTIAL RS - First Overnight RS - Expedited Parcel Select - 2DAY - CARGO LOGISTICS - INTERNATIONAL AIR - OSM PREMIUM EXPEDITED - EXPRESS MAIL SR PB - NEXT DAY AIR SAVER-SR - AT CARRIER - SAME DAY - EXPRESS MAIL PB - 2DAY AM - NEXT DAY AIR RS - 2ND DAY AIR SATURDAY RESIDENT - First Overnight RESIDENTIAL - EXPRESS SAVER RES-CSR - LOCAL - INTERNATIONAL PARCELS - HOO - SB POOL DISTRIBUTION - GROUND SERVICE COMMERCIAL-SR - LIFTGATE - HOME DELIVERY RS - INTERNATIONAL PRIORITY - EXPRESS SAVER CANADA - Standard - 2ND DAY AIR RS - PRIORITY MAIL INT - SEE SHIPPING INSTRUCTIONS - SM Parcel Plus Ground RS - SAVER - EXPRESS MAIL INT PB - Priority Overnight - FIRST CLASS - Priority Mail FRB ENV PB - PRIORITY MAIL SR PB - ECONOMY - STANDARD OVERNIGHT RS - INTERNATIONAL MANUAL - GROUND SERVICE RESIDENTIAL - 2ND DAY AIR-SR RS - INTL CONSOLIDATE FREIGHT EC - STANDARD INTERNATIONAL - STANDARD FREIGHT - CONSIGNEE - NEXT DAY AIR SATURDAY RS - Less than 1 lb RESIDENTIAL - 2DAY RS - Express Worldwide RESIDENTIAL - SM Parcel Expedited Max - 2ND DAY AIR FREIGHT NGS - XPRESSPOST - STD INTRASTATE CA - INTERNATIONAL CONNECT PLUS-CSR - SYSTEMS - 3 DAY SELECT-APH - STD TO CANADA - 2DAY AM RS - PRIORITY MAIL ASR PB - NEXT DAY AIR SAVER RESIDENTIAL - PARCEL - NEXT DAY AIR EARLY AM RS - GROUND - FIRST-CLASS MAIL INTL PB - NEXT DAY AIR EARLY AM SR - SM Parcels Ground - Priority Mail FRB XL PB - TRANSPORTATION INC - NEXT DAY AIR-APH - NEXT DAY AIR RES-ASR - SM Parcels Expedited - STANDARD ABQR - 2ND DAY AIR AM-APH RS - OSM PREMIUM - International Document Service - STANDARD INTL - 2ND DAY AIR SATURDAY - NEXTDAY - Parcel Select Non-Presort PB - INTERNATIONAL STANDARD DDU - LIVE LOAD FREIGHT - GROUND-APH RS - 1 DAY - 1 lb or Greater RESIDENTIAL - FIRST OVERNIGHT OR - AIR FREIGHT CONSOLIDATED INT - NEXT DAY AIR RESIDENTIAL - 3RD DAY AIR FREIGHT - INTERNATIONAL PRIORITY FREIGHT - INTERNATIONAL - PRIORITY MAIL ACSR PB - GROUND SERVICE RESIDENTIAL-PRS - TIMEKEEPER - EXPRESS SAVER RES-SR - NEXT DAY AIR-SR - PRI DDP DC - STD INTRASTATE - WORLDWIDE EXPRESS-SR - International Economy - First Overnight-RPS - International Priority - INT DOOR TO DOOR - 2DAY AM OR - 2ND DAY AIR RES-ASR - SM Parcel Plus Ground - NEXT DAY AIR SATURDAY-APH - Expedited to Canada - TRUCK-3 DAY SELECT - ESU - EXPRESS CANADA - 3 DAY SELECT RS - NEXT DAY AIR-SR RS - REDDAWAY INC - LTL - PRIORITY MAIL - EXPRESS SAVER-RPDCS description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. Must pass in shipping_method_id or shipping_method_name + carrier_id example: 1 DAY carrier_id: type: string enum: - UTI - DIGITAL RIVER - K LINE - ESTES EXPRESS LINES - ALTRIA - AMERICAN FREIGHTWAYS - MAINFREIGHT INTERNATIONAL - MACH 1 GLOBAL - DART EXPRESS - CAL STATE EXPRESS - PREMIER LOGISTICS - FGE Inc. - TRAFFIC TECH - DUPRE LOGISTICS - KCC TRANSPORT - CSX INTERMODAL TERMINALS - VALENCIA TRANSPORT SERVICE INC - GREAT AMERICAN TRANS - COVENANT TRANSPORT - POLARIS - GENTRANS CARGO EXPRESS - AOC FREIGHT CORPORATION - PACE AIR FREIGHT - R&L TRANSFER - CUSTOMER - PLATINUM - GLOBALE - TRUCKLAND INC - HORIZON INTL CARGO - USF - GILBERT COMPANY - MC CARGO - SPECIALTY LOGISTICS - CLICK4TRUCK - SONICA - AVILA TRUCKING - CAVALIER LOGISTICS - HUB INTERMODAL - E&A TRANSPORT LLC - USPS_ATS_PARCEL - CONCORD - DEL MAR USA - AMZ_US_LMA - BNSF LOGISTICS - ADAMS THIRD WAVE - MAINFREIGHT - WHITE ARROW - CIRCLE LOGISTICS - SWIFT TRANSPORTATION - CH ROBINSON - LIVE LOGISTICS - ARAMEX INTERNATIONAL COURIERS - PROGRESSIVE LOGISTICS - ESL EXPRESS - PREMIERE LOGISTICS - MARTINEZ ENTERPRISE - ARAMEX - HILTON TRANSPORT - JTS LOGISTICS - UPDIKE DISTRIBUTION LOGISTICS - American Worldwide Agencies - FNS INC - CANADA POST - PRECISION TRUCK LINES - AXIZ - OMNI LOGISTICS - KOHLS 855 BACKHAUL GALE - DPD - KUEHNE AND NAGEL - TRIAD - SEKO WORLDWIDE - WESHIP - BEST OVERNITE EXPRESS - BRENTWOOD DRIVE - ADELCAR - RHEOUS - YRC - FEDEX CUSTOM CRITICAL - SONDH FREIGHT SYSTEMS - PRIORITY1 - CANADIAN SERVICE - JIT - GALE TRIANGLE - USA TRUCK BROKERAGE - MOTO TRANSPORTATION - CSA TRANSPORTATION - AIRGROUP - TARGET LOGISTICS - FREIGHT LOGISTICS - AAA COOPER - 10G LOGISTICS - EASE LOGISTICS - ORANGE COURIER - PILOT PORTLAND - AIT WORLDWIDE LOGISTICS - FEDEX - FEED THE CHILDREN - RE TRANSPORTATION - TLW FREIGHT - KINTETSU WORLD EXPRESS - USA TRUCK - NORCON - SHIFT FREIGHT - ROUTING - ENGLAND LOGISTICS - AMERICAN GLOBAL - CVS HEALTH DISTRIBUTION CENTER - ASTEC LOGISTICS - BULLET TRANSPORT - KNICHEL LOGISTICS - DSV - ALLSTATE INT FREIGHT - OMNI - S&J - GSC LOGISTICS - ABILENE MOTOR EXPRESS - HUB GROUP - AIRWAVES - SWIFT DEDICATED - APORTILLOTRANSPORTLLC - COOL RUNNINGS INC - RXO - CALTOP LOGISTICS - NEWGISTICS - CALIFORNIA OVERNIGHT - WARREN TRANSPORT - USPS_ATS_BPM - DHL DANZAS - RJW - CLOCK - JMZ TRANSPORT - COMTRAK LOGISTICS - NFI INDUSTRIES - BESTUSA - CONWAY - UPS Ground Saver - PERIMETER GLOBAL - CEVA LOGISTICS - JAEZRA TRANSPORT - REALWAY - INTELLITRANS LLC - MAIL ON THE MOVE - WESTERN EAGLE FOUNDATION - ROADRUNNER - CENTRAL TRANSPORT - DAYLIGHT TRANSPORT - CTS - EXPRESS LINE - VRTX LOGISTICS - UNYSON LOGISTICS - CH ROBINSON WORLDWIDE - AMZ_US_PREMIUM - INXPRESS - DYNAMIC EXPRESS - YUSEN - ECHO GLOBAL LOGISTICS - DIMERCO EXPRESS SINGAPORE - NEXZIS - AVERITT EXPRESS - NISSIN - PUROLATOR LTL - PANALPINA - CLEAR LANE FREIGHT SYSTEMS - HELLMANN WORLDWIDE LOGISTICS - EAGLE USA - SAIA - BEST DELIVERY SERVICES - JW LOGISTICS - NATIONAL CONSOLIDATION SERVICE - NEW LEGEND - JAS FORWARDING - ALL CARTAGE - VITRAN - NATIONAL RETAIL TRANSPORTATION - JB HUNT INTERMODAL - WALMART - SUNTECK TRANSPORT - ONE SOURCE - INTERCARGO - WILL CALL GLOBAL-E - FITZMARK TRUCKING - EXPEDITORS - NIPPON EXPRESS - OLD DOMINION - CONVOY - JC MARTINEZ TRUCKING - ESTENSON LOGISTICS - FEDEX FREIGHT - GEODIS - TROPICAL SHIPPING - CON-WAY - MAV TRANSPORTATION - PERFORMANCE TEAM GALE TRIANGLE - ABF - TOTAL TRANSPORTATION - Pacer Group IM - FEDEX EXPRESS FREIGHT - ALYBRE TRUCKING - WRDS - ADCOM WORLDWIDE LAX - SEKO LOGISTICS - DHL Global Mail - TRANSPLACE - CENTRAL TRANSPORT INC - UNYSON - ALPHA HOLDING - BAX GLOBAL - CORTRANS - YRC INC - HOLLAND MOTOR EXPRESS - OAK HARBOR - DYNAMEX OPERATIONS - M AND W LOGISTICS - DPD/BES - AirOne Logistics - OSM - DEPENDABLE HIGHWAY EXPRESS - CENTRAL FREIGHT LINES - DAY AND ROSS - CURRENT EXPRESS - DLS WORLDWIDE - URBAN FREIGHT - MSM TRANSPORTATION INC. - GEFCO COURIER - MAKO WAVES DISTRIBUTION - EXPRESS FREIGHT SYSTEM - BLM TRANSPORTATION - UPS CANADA - OTX LOGISTICS - U GOT IT TRANSPORT - Home Direct - TRUMP CARD - ROHLIG - DUNBLARE IPORT EXPORT - WEST COAST - Federal Express - TEAM WORLDWIDE - Great World Express - ARRIVE LOGISTICS - KUEHNE+NAGEL - TRU58 - TRANSGROUP - ESTES LOGISTICS - HEAVEN - R&L CARRIERS INC - TRANSCON - USPS_ATS_STD - WHITACRE INTERMODAL - WEBTRANS - WORLDWIDE EXPRESS - EXPEDITORS INTL - AGILITY INTL LOGISTICS - GARRY MERCER - SPEEDMARK - PRIMARY FREIGHT SERVICE - SIGNATURE SUPPLY - KULAR ENTERPRISES INC - AMAZON - LOADSMART - UNIUNI - DAYTON FREIGHT - HERCULES - HUB DEDICATED - US GROUP CONSOLIDATOR - CONVOY INTERSTATE - INTERMARK TRANSPORT - XPO LOGISTICS - MARITIME-ONTARIO FREIGHT - JB HUNT - SPEEDX - TST OVERLAND EXPRESS - TFORCE FREIGHT - AIT WORLWIDE LOGISTICS - SFO EXPRESS - FLEXPORT - PTL FREIGHT FORWARDERS - DCL14 - WERNER ENTERPRISE - SERVICE PLUS TRANS - JSI - UPS LTL - PEGASUS - TOTAL QUALITY LOGISTICS - WORLD ASIA - JD GLOBAL LOGISTICS - CALIFORNIA SIERRA EXPRESS - GALEX LOGISTICS - BEST WAY RATE - UPS Access Point - PROTRANS INTERNATIONAL - CUSTOM COMPANIES - KINETIC - ITF GROUP - JL BARR TRUCKING - UPS - ATL TRANSPORTATION INC - DYNASTY - WATCO SUPPLY CHAIN - AMZ_US_PREMIUM_SWA - ULTRA EX - STG LOGISTICS - ARMSTRONG TRANSPORT - MARANATHA TRANSPORTATION - ORANGECOURIER - US XPRESS - KEYSTONE DEDICATED - ALGON TRANSPORT INC - WESTERN EXPRESS - INTERNATIONAL BRIDGE - FEDEX TRUCKLOAD BROKERAGE - UPS SurePost - MILGRAM - Corporate Traffic TL - RAIL DELIVERY - MOUNTAIN VALLEY EXPRESS - DCL DELIVERY - PORTLINK USA - AMAZON FREIGHT - LOADMASTER - ALLIANCE SHIPPERS - AO FREIGHT - DTS - UNIS TRANSPORTATION - WESTERN DIRECT EXPRESS - ASR TRANSPORTATION - SCHNEIDER NATIONAL CARRIERS - C AND S TRANSPORTATION - HG FORWARDING - PGL - SEE ROUTING GUIDE - ULTRA LOGISTICS - FE TRUCKLOAD - ES EXPRESS - SUPERCARGO - RHAPSODY NAVIGATION LIMITED - PILOT - PITT OHIO EXPRESS - RHENUS LOGISTICS - AIT - ROADWAY EXPRESS - UNI-TRADE BROKERS LOGISTICS - LETAREMAN INC - FORWARD AIR - PUROLATOR COURIER - XPRESS GLOBAL SYSTEMS - JOHANSON - HUB GROUP CENTRAL TRANSPORT - USF HOLLAND - SHIPCO TRANSPORTATION - SELECTSHIP - STR GROUP - KGL AMERICA - U FREIGHT - FALCON GLOBAL EDGE - BAY CITY - UNIVERSAL TRUCK LOAD INC - WALMART FLEET - GLOBAL TRANZ - DYNAMIC LTL - OPC TRUCKING - USA FULGER TRANSPORT - NEXT TRUCKING - GORDON TRUCKING - JOHNNY AIR CARGO - VFR TRANSPORT - ANC INTERNATIONAL - KWE - ONEATOS TRUCKING - PRIORITY - SOUTHEASTERN FREIGHT - FREIGHTQUOTE.COM - NEXTRANS - CITY TRANSPORT - AMZ_US_BULK - KAMINO - LANDMARK - EASYPOST USPS - NATIONAL RETAIL SYSTEMS - POS - LYNDEN - W AND D - ONTRAC - CORNERSTONE - EU CARRIER - GULF RELAY - USF REDDAWAY - HOLD - WILL CALL - ABNT - AMERIKA LAND - CEVA - CTE - CANPAR - CRANE WW - ACB - SCHENKER - PAM TRANSPORT - ALD LOGISTICS - PONCE GROUND SERIVE - AMAZON LOGISTICS INC - Claude Laguerre Transport - SEE SHIPPING INSTRUCTIONS - SEAAIR - ACE FLEET - ALFA LOGISTICS - VZ TRANSPORTATION INC - GREATWIDE AMERICAN TRANS - R&B - MIDWEST EXPRESS - ASSOCIATED GLOBAL SYSTEMS - THE TRANSPORT COMPANY - CANADIAN TIRE - WESTERN REGIONAL DELIVERY - EPES LOGISTICS - AMAZON FREIGHT EXCHANGE NETWOR - SWIFT LOGISTICS - WATCHPOINT LOGISTICS - CALSIERRA - CRANE - SUNSET PACIFIC TRANSPORTATION - UPS SUPPLY CHAIN SOLUTIONS - RELAY LOAD BOARD - SPOT - MAGELLAN TRANSPORT LOGISITCS - MAERSK LOGISTICS - APC_DCL - TRANS EXPEDITE - FARREX FREIGHT - FRONTLINE FREIGHT - ZNS CARGO - SURE SHOT TRANSIT SOLUTIONS - TRANSFIX - BA CARRIER INC - MORRISON EXPRESS CORP - ESTES LEVEL 2 - COYOTE LOGISTICS - UPS Mail Innovations - DYNASTY CUSTOMS BROKER INC - FEDEX TRUCKLOAD - INSTICO GLOBAL LOGISTICS - UBER FREIGHT - RED LOGISTICS - ROCHESTER ART CLUB - DBSH - USPS - AERONET - DHL - CALIFORNIA TRANSPORT - ESTES FORWARDING WORLDWIDE - UPS FREIGHT - FLAVOR CLOUD - DBSCHENKER - MEGA FLEET CORP - G & I LOGISTICS - B2C/WEE - LAB CARRIER - HUB HIGHWAY - CANADIAN FREIGHTWAYS - STREAMLINE INC - ICAT LOGISTICS - USF BESTWAY - TIA CHAPIS TRANSPORTATION LLC - TRI-AD - STERLING - HEARTLAND EXPRESS - EXPRESS AIR FREIGHT - SONICAIR - TNT - INTEGRITY LOGISTICS - PITNEY BOWES - DMX LOGISTICS - FREIGHTSAVER - PASSPORT - MODE TRANSPORTATION - BTX GLOBAL LOGISTICS - JB HUNT CENTRAL TRANSPORT - EAGLE - KNIGHT TRANSPORTATION INC - LTL - SUNNY EXPR description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. Must pass in shipping_method_id or shipping_method_name + carrier_id example: FEDEX warehouse_id: type: string enum: - FR - LA - LN - YK - EX - EU - KY description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: EU line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 custom_field1: custom value custom_field2: custom value custom_field5: custom value items: $ref: '#/components/schemas/WmsOrderWriteLineItemdcl' ship_to_address: $ref: '#/components/schemas/ShipToAddressDcl' required: - line_items - ship_to_address additionalProperties: false title: DCL CreatewmsOrder--Cin7__Core__-_Dear__Systems_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id ship_to_address: $ref: '#/components/schemas/ShipToAddressDear-Systems' bill_to_address: $ref: '#/components/schemas/BillToAddressDear-Systems' line_items: type: array description: List of the products included in the order. example: - product_id: product_id quantity: 0 unit_price: 0 tax: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemdear-systems' required: - warehouse_id additionalProperties: false title: Cin7 Core (Dear Systems) CreatewmsOrder--Delmar--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number invoice_currency_code: type: string default: USD description: The currency of the line item unit prices. example: USD ship_to_address: $ref: '#/components/schemas/ShipToAddressDelmarcargo' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemdelmarcargo' required: - line_items - order_number - ship_to_address - warehouse_id additionalProperties: false title: Delmar CreatewmsOrder--Deposco--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id ship_to_address: $ref: '#/components/schemas/OrderShipToAddressCreateDeposco' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 unit_cost: 0 notes: - title: Note Title body: Note Body items: $ref: '#/components/schemas/WmsOrderWriteLineItemdeposco' reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground channel_object: $ref: '#/components/schemas/ChannelSchema' description: The channel the order was placed on. required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' trading_partner: type: string description: >- For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart). example: Target cancel_by_ship_date: type: string format: date-time description: Date to cancel the order by example: '2023-10-01T00:00:00Z' custom_attribute_1: type: string description: Custom attribute 1 example: Custom attribute 1 custom_attribute_2: type: string description: Custom attribute 2 example: Custom attribute 2 custom_attribute_6: type: string description: Custom attribute 6 example: Custom attribute 6 custom_attribute_7: type: string description: Custom attribute 7 example: Custom attribute 7 order_type: type: string default: Sales Order enum: - Sales Order - Outbound Transfer Order description: The type of Deposco order, defaults to Sales Order. example: Sales Order freight_account_number: type: string description: The freight account number. example: '123456789' notes: type: array description: List of the custom fields example: - title: Note Title body: Note Body items: $ref: '#/components/schemas/Notes' required: - line_items - ship_to_address additionalProperties: false title: Deposco CreatewmsOrder--Distribution__Management--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} type: type: string enum: - d2c - b2b - Dealer Dropship description: The type of order example: Dealer Dropship comment: type: string description: The comment to add to the order example: This is a test comment confirmation_email: type: string description: The email address to send the confirmation to example: email@email.com warehouse_id: type: string enum: - '2' - '3' - '4' - '6' - '8' description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: '2' ship_to_address: $ref: '#/components/schemas/ShipToAddressDistribution-Management' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemdistribution-management' order_number: type: string description: A user-friendly identifier for their order. example: order_number customer_po_number: type: string description: The customer PO number example: customer_po_number ship_window_start_date: type: string format: date-time description: The date to start the shipping window example: '2023-03-15T13:45:30Z' required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' retailer_id: type: string description: The retailer ID DM assigned to the retailer this order is for example: '644' required: - line_items - order_number - ship_to_address - type additionalProperties: false title: Distribution Management CreatewmsOrder--Dotcom__Distribution--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string maxLength: 20 description: A user-friendly identifier for their order. example: order_number shipping_method_id: type: string enum: - N/A - Connect an account to see options description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground total_price: type: number description: The total price a customer paid for the order. example: 13.49 total_tax: type: number description: The total tax on the order. example: 1.5 total_shipping: type: number description: The total shipping cost for the order incurred by the customer. example: 3.5 ship_to_address: $ref: '#/components/schemas/ShipToAddressDotcom-Distribution' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemdotcom-distribution' required: - line_items - order_number - ship_to_address - shipping_method_id - total_price - total_shipping - total_tax additionalProperties: false title: Dotcom Distribution CreatewmsOrder--Elite__Ops--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemelite-ops' ship_to_address: $ref: '#/components/schemas/ShipToAddressElite-Ops' shipping_method_id: type: string enum: - '122' - '125' - '126' - '129' - '130' - '308' - '309' - '310' - '311' - '312' - '128' - '69' - '102' - '106' - '11' - '13' - '135' - '14' - '20' - '200' - '21' - '37' - '39' - '40' - '44' - '52' - '53' - '54' - '55' - '56' - '57' - '58' - '59' - '67' - '307' - '0' - '305' - '306' - '301' - '302' - '5' - '8' - '10' - '9' - '6' - '4' - '7' - 121OPP - 121LOP - '12' - '48' - '50' - 81P description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: '0' shipping_method_name: type: string enum: - DHL GLOBAL MAIL-EXPEDITED - DHL GM PACKET PLUS - DHL XPARCEL GROUND - DHL PARCEL DIRECT PLT DDP - DHL PARCEL DIRECT PLT DDU - BUKUSHIP - DHL PARCEL EXPEDITED - BUKUSHIP - DHL PARCEL GROUND - BUKUSHIP - DHL PARCEL INTERNATIO - BUKUSHIP - DHL PARCEL PRIORITY - BUKUSHIP - DHL PACKET PRIORITY - DHL EXPRESS WORLDWIDE LETTER - DHL Express Worldwide (nondoc) - FedEx Smartpost - Amazon Prime - FedEx Express Saver (3 day) - FedEx Ground - FedEx Home Delivery w/ Signature - Fedex Home Delivery - FedEx 2 day - FedEx Ground Canada - Fedex First Overnight - FedEx Saturday - FedEx Priority Overnight - FedEx Standard Overnight - FedEx International Priority - FedEx 2 Day Freight - FedEx 3 Day Freight - FedEx Ground w/Signature - FedEx Priority Overnight w/Signa - FedEx Standard Overnight w/Sign - FedEx 2 day w/Signature - FedEx Express Saver w/Signature - FedEx International Economy - FedEx Express Saver w/Signature - Global-e - Unassigned - Parcel Priority DDU - Parcel Priority DDP - BUKUSHIP - USPS PRIORITY MAIL IN - BUKUSHIP - USPS COMMERICAL EPACK - UPS Next Day Air - UPS 2nd Day Air - UPS Ground - UPS 3 Day Select - UPS Next Day Air Saver - UPS Next Day Air Early AM - UPS 2nd Day Air AM - UPS SurePost 1 or More - UPS SurePost less 1 LB - UPS Home Delivery - USPS Priority Mail - USPS First Class Mail - FLAT RATE PADDED ENVELOPE description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground required: - line_items - order_number - ship_to_address additionalProperties: false title: Elite Ops CreatewmsOrder--eShipping--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number warehouse_id: type: string enum: - N/A - Connect an account to see options description: Facility code to ship from example: warehouse_id ship_to_address: $ref: '#/components/schemas/ShipToAddressEshipping' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemeshipping' shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex priority: type: string default: '0' enum: - '0' - A - S description: Order priority. Defaults to '0' (normal) example: '0' ship_type: type: string default: S enum: - S - L - T description: Shipment type. Defaults to 'S' (small parcel) example: S shipment_terms: type: string default: PPD enum: - PPD - COL - 3RD description: Shipment terms. Defaults to 'PPD' (prepaid) example: PPD required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' required: - line_items - order_number - reference_id - required_ship_date - ship_to_address - warehouse_id additionalProperties: false title: eShipping CreatewmsOrder--Evolve--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' ship_to_address: $ref: '#/components/schemas/ShipToAddressEvolve' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemevolve' required: - line_items - reference_id - ship_to_address additionalProperties: false title: Evolve CreatewmsOrder--Extensiv__-_3PL__Central_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id ship_to_address: $ref: '#/components/schemas/ShipToAddressExtensiv' billing_code: type: string enum: - default_Prepaid - default_FreightCollect - default_BillThirdParty - fedex_collect - fedex_recipient - fedex_sender - fedex_third_party - ups_BillThirdParty - ups_ConsigneeBilled - ups_FreightCollect - ups_Prepaid description: Billing Type example: default_BillThirdParty carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex carrier_account_number: type: string description: >- Carrier account number to bill freight against (e.g. for third-party billing). example: carrier_account_number shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground line_items: type: array description: List of the products included in the order. example: - product_id: product_id sku: sku quantity: 0 unit_price: 0 custom_fields: - name: CustomField value: CustomValue items: $ref: '#/components/schemas/WmsOrderWriteLineItemextensiv-3pl-central' trading_partner: type: string description: >- For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart). example: Target custom_fields: type: array description: List of the custom fields example: - name: CustomField value: CustomValue items: $ref: '#/components/schemas/CustomField' channel_object: $ref: '#/components/schemas/ChannelSchema' description: The channel the order was placed on. total_discount: type: number description: The total amount discounted from the order. example: 2.5 total_shipping: type: number description: The total shipping cost for the order incurred by the customer. example: 3.5 total_tax: type: number description: The total tax on the order. example: 1.5 gift_message: type: string description: Gift message example: gift_message earliest_ship_date: type: string format: date-time description: The projected ship date of the order example: '2023-03-15T13:45:30Z' ship_cancel_date: type: string format: date-time description: Ship cancel date example: '2023-03-15T13:45:30Z' purchase_order_number: type: string description: Purchase order number example: purchase_order_number bill_to_address: $ref: '#/components/schemas/BillToAddressExtensiv' notes: type: string description: Notes example: notes required: - line_items - order_number - ship_to_address - warehouse_id additionalProperties: false title: Extensiv (3PL Central) CreatewmsOrder--Amazon--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number displayable_order_comment: type: string description: '' example: displayable_order_comment service_level: type: string enum: - Standard - Expedited - Priority description: The type of shipping method requested by the customer. example: Standard warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/ShipToAddressFba' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemfba' required: - displayable_order_comment - line_items - order_number - service_level - ship_to_address additionalProperties: false title: Amazon CreatewmsOrder--FedEx__Fulfillment--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/CreateOrderFedex-Fulfillment' warehouse_id: type: string enum: - HFY - FCA description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: FCA line_items: type: array description: List of the products included in the order. example: - sku: sku vendor_sku: vendor_sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemfedex-fulfillment' channel_object: $ref: '#/components/schemas/Fedex-FulfillmentChannelIdSchema' description: The channel the order was placed on. type: type: string description: The type of order, such as d2c, b2b, dropship, or transfer. example: d2c shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Only used when ship type is PCL example: fedex_ground ship_type: type: string enum: - LTL - PCL description: '' example: LTL purchase_order_number: type: string description: '' example: purchase_order_number required: - line_items - order_number - ship_to_address - ship_type - type - warehouse_id additionalProperties: false title: FedEx Fulfillment CreatewmsOrder--FFE--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/ShipToAddressFfe' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 external_id: retail item number items: $ref: '#/components/schemas/WmsOrderCreateLineItemffe' notes: type: array description: List of notes associated with the order. example: - note_1 - note_2 items: type: string description: A note associated with the order. example: note purchase_order_number: type: string description: The purchase order number associated with the order. example: PO123 is_edi: type: boolean description: Whether the order is an EDI order. example: false trading_partner: type: string description: >- For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart). example: Target carrier_id: type: - string - 'null' description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. Maps to FFE's PreferredCarrierId. Use GET /wms/shipping-methods (carrier_id) to find valid IDs. If omitted, the carrier is inferred from the shipping_method_id composite. example: fedex shipping_method_id: type: - string - 'null' description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Maps to FFE's PreferredCarrierServiceTypeId. Pass the id field returned by GET /wms/shipping-methods, which has the composite format '{carrier_id}-{service_type_id}'. A bare service_type_id (e.g. '21') is also accepted, in which case carrier_id should be supplied separately. example: fedex_ground required: - line_items - reference_id - ship_to_address additionalProperties: false title: FFE CreatewmsOrder--Finale--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItem' required: - line_items - warehouse_id additionalProperties: false title: Finale CreatewmsOrder--Flexport__-_Deliverr_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} ship_to_address: $ref: '#/components/schemas/ShipToAddressFlexport' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 product_id: product_id customs_unit_value: null items: $ref: '#/components/schemas/WmsOrderWriteLineItemflexport' shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground delivery_days: type: integer enum: - 1 - 2 - 3 - 7 description: >- Define the number of days in which this order must be delivered, counting from the date of shipment. Accepted values are limited to: 1,2,3,7. example: 1 required_delivery_date: type: string format: date-time description: >- The date and time (ISO 8601 format) the packages in this fulfillment order should arrive at the buyer's address. example: '2022-05-06T01:02:03Z' required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id duties: $ref: '#/components/schemas/Duties' channel_object: $ref: '#/components/schemas/ChannelSchema' description: The channel the order was placed on. required: - line_items - reference_id - ship_to_address additionalProperties: false title: Flexport (Deliverr) CreatewmsOrder--Flowspace--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id ship_to_address: $ref: '#/components/schemas/FlowspaceCreateOrderShipToAddressFlowspace' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemflowspace' carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex scac: type: string description: Standard Carrier Alpha Code example: scac shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Either a service level (Ground, Three-Day, Two-Day, Next Day, Three-Day Guaranteed, Two-Day Guaranteed, Next Day Guaranteed) or, together with carrier_id, the carrier's own service code (e.g. GROUND_HOME_DELIVERY for FedEx). example: Ground tags: type: array description: >- A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`. example: - tag_0 items: type: string description: A tag associated with the order. example: tag_0 saturday_delivery: type: boolean description: Whether Saturday delivery is requested example: false signature_required: type: boolean description: Whether a signature is required for delivery example: false needs_transportation: type: boolean description: 'Whether Flowspace should arrange transportation (default: false)' example: false transportation_mode: type: string default: parcel enum: - parcel - freight description: 'Whether the order ships as parcel or freight (default: parcel)' example: parcel freight_class: type: string description: Freight class for freight orders (e.g. 125) example: freight_class pallets: type: array description: Pallet details for freight orders example: - length: 48 width: 40 height: 48 weight: 500 number_of_pallets: 1 items: $ref: '#/components/schemas/FlowspaceCreateOrderPallet' accessorial_services: $ref: '#/components/schemas/FlowspaceCreateOrderAccessorialServices' transportation_special_requests: type: string description: Transportation notes for freight orders example: transportation_special_requests channel_object: $ref: '#/components/schemas/FlowspaceCreateOrderChannelObject' required: - line_items - ship_to_address additionalProperties: false title: Flowspace CreatewmsOrder--Fulfillor--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/FulfillorShipToAddressFulfillor' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemfulfillor' required: - line_items - ship_to_address additionalProperties: false title: Fulfillor CreatewmsOrder--fulfilmentcrowd--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string enum: - N/A - Connect an account to see options description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id channel_object: $ref: '#/components/schemas/FulfilmentcrowdChannelSchema' description: >- The channel the order was placed on. Defaults to what you provided while installing. invoice_currency_code: type: string default: USD enum: - USD description: >- The currency used for this order. If not provided explicitly, defaults to USD. example: USD line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemfulfilmentcrowd' ship_to_address: $ref: '#/components/schemas/CreateOrderShipToAddressFulfilmentcrowd' order_number: type: string description: A user-friendly identifier for their order. example: order_number type: type: string default: d2c enum: - d2c - b2b - dropship - transfer description: The type of order, such as d2c, b2b, dropship, or transfer. example: d2c total_shipping: type: number default: 0 minimum: 0 description: >- The total shipping cost for the order incurred by the customer. Fulfilmentcrowd picks the delivery method from this, so we send 0 when you leave it out. example: 3.5 required: - line_items - warehouse_id additionalProperties: false title: fulfilmentcrowd CreatewmsOrder--G__Global--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/ShipToAddressG-Global' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemg-global' service_level: type: string description: The type of shipping method requested by the customer. example: Standard total_price: type: number description: The total price a customer paid for the order. example: 13.49 required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' required: - line_items - order_number - ship_to_address - total_price additionalProperties: false title: G Global CreatewmsOrder--GoBolt--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id service_level: type: string description: The type of shipping method requested by the customer. example: Standard signature_required: type: boolean description: '' example: true channel_object: $ref: '#/components/schemas/ChannelSchema' description: The channel the order was placed on. notes: type: string description: '' example: notes tags: type: array description: >- A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`. example: - tag_0 items: type: string description: A tag associated with the order. example: tag_0 line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemgobolt' ship_to_address: $ref: '#/components/schemas/ShipToAddressGobolt' required: - line_items - order_number - ship_to_address additionalProperties: false title: GoBolt CreatewmsOrder--Greenmark__Logistics--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number ship_to_address: $ref: '#/components/schemas/ShipToAddressGreenmark' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemgreenmark' required: - line_items - order_number - ship_to_address additionalProperties: false title: Greenmark Logistics CreatewmsOrder--I-Fulfilment--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id channel_object: $ref: '#/components/schemas/I-FulfilmentChannelIdSchema' description: The channel the order was placed on. product_channel: type: string enum: - N/A - Connect an account to see options description: The channel of the product example: product_channel invoice_currency_code: type: string default: GBP description: Defaults to GBP if not provided. example: GBP ship_to_address: $ref: '#/components/schemas/ShipToAddressI-Fulfilment' line_items: type: array description: List of the products included in the order. example: - sku: sku unit_price: 0 quantity: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemi-fulfilment' requested_service_level: type: string description: The REQUESTED service level for the order. example: requested_service_level tax_rate: type: string enum: - N/A - Connect an account to see options description: '' example: tax_rate required: - line_items - product_channel - reference_id - requested_service_level - ship_to_address - tax_rate - warehouse_id additionalProperties: false title: I-Fulfilment CreatewmsOrder--Infoplus--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. Used for 3PL accounts. example: warehouse_customer_id warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id bill_to_address: $ref: '#/components/schemas/BillToAddressInfoplus' ship_to_address: $ref: '#/components/schemas/ShipToAddressInfoplus' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineIteminfoplus' channel_object: $ref: '#/components/schemas/ChannelSchema' description: The channel the order was placed on. shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground tags: type: array description: A list of tags associated with the order. example: - tag_0 items: type: string description: A tag associated with the order. example: tag_0 customer_po_number: type: string description: Customer's purchase order number example: customer_po_number order_number: type: string description: A user-friendly identifier for their order. example: order_number gift_message: type: string description: Gift message example: gift_message required: - bill_to_address - line_items - warehouse_id additionalProperties: false title: Infoplus CreatewmsOrder--JAS--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id invoice_currency_code: type: string description: '' example: invoice_currency_code service_level: type: string description: The type of shipping method requested by the customer. example: Standard type: type: string description: The type of order example: type ship_to_address: $ref: '#/components/schemas/ShipToAddressJas' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemjas' required: - line_items - order_number - reference_id - ship_to_address - type additionalProperties: false title: JAS CreatewmsOrder--JayGroup--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string enum: - Lancaster - Reno - Chicago description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: Chicago shipping_method_id: type: string enum: - Economy - Standard - Express - Expedited - NextDay description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: Economy line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemjaygroup' ship_to_address: $ref: '#/components/schemas/ShipToAddressJaygroup' required: - line_items - ship_to_address additionalProperties: false title: JayGroup CreatewmsOrder--Cart.com__-_Jazz__Central_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemjazz-central' ship_to_address: $ref: '#/components/schemas/ShipToAddressJazz-Central' channel_object: $ref: '#/components/schemas/ChannelSchema' description: The channel the order was placed on. trading_partner: type: string description: >- For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart). example: Target shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id required: - channel_object - line_items - ship_to_address additionalProperties: false title: Cart.com (Jazz Central) CreatewmsOrder--Leanafy--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} ship_to_address: $ref: '#/components/schemas/ShipToAddressLeanafy' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemleanafy' reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id is_address_residential: type: boolean default: true description: Shipping address is residential example: true required: - line_items - ship_to_address additionalProperties: false title: Leanafy CreatewmsOrder--Linnworks--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemlinnworks' shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground payment_status: type: string default: UNPAID enum: - UNPAID - PAID - CANCELLED description: >- Payment status the order is created with. Linnworks parks UNPAID orders. example: UNPAID required: - line_items - reference_id additionalProperties: false title: Linnworks CreatewmsOrder--Quickbox__-_LogicPod_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number connection: type: string default: CARTROVER enum: - CARTROVER - DPSH - DROPSTREAM - IQCONNECT - PURA - SALESSUPPLY description: Order connection/channel source example: CARTROVER ship_to_address: $ref: '#/components/schemas/OrderShipToAddressLogicpod' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemlogicpod' required: - line_items - order_number - ship_to_address additionalProperties: false title: Quickbox (LogicPod) CreatewmsOrder--Logiwa--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemlogiwa' order_number: type: string description: A user-friendly identifier for their order. example: order_number ship_to_address: $ref: '#/components/schemas/ShipToAddressLogiwa' order_type: type: string default: Customer Order description: The type of order. Defaults to 'Customer Order'. example: Customer Order required: - line_items - ship_to_address - warehouse_id additionalProperties: false title: Logiwa CreatewmsOrder--Logiwa__IO--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number order_date: type: string format: date-time description: '' example: '2023-03-15T13:45:30Z' warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex carrier_name: type: string description: >- The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level. example: FedEx notes: type: string description: '' example: notes shipment_order_type: type: string description: '' example: shipment_order_type line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 pack_type: Each unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemlogiwa-io' ship_to_address: $ref: '#/components/schemas/ShipToAddressLogiwa-Io' required: - line_items - order_date - order_number - ship_to_address - warehouse_id additionalProperties: false title: Logiwa IO CreatewmsOrder--Luminous--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number channel_object: $ref: '#/components/schemas/ChannelSchema' description: The channel the order was placed on. service_level: type: string description: The type of shipping method requested by the customer. example: Standard total_tax: type: number description: The total tax on the order. example: 1.5 total_discount: type: number description: The total amount discounted from the order. example: 2.5 total_shipping: type: number description: The total shipping cost for the order incurred by the customer. example: 3.5 ship_to_address: $ref: '#/components/schemas/CreateOrderShipToAddressLuminous' line_items: type: array description: List of the products included in the order. example: - product_id: 0 sku: sku quantity: 2 unit_price: 9.99 items: $ref: '#/components/schemas/WmsOrderCreateLineItemluminous' required: - channel_object - line_items - order_number - ship_to_address additionalProperties: false title: Luminous CreatewmsOrder--Luxroutage__LRI--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number carrier_code: type: string description: >- The code of the carrier to ship the order with. Reach out to your Luxroutage representative to get the mapping of available carrier_codes. example: carrier_code total_price: type: number description: The total price a customer paid for the order. example: 13.49 ship_to_address: $ref: '#/components/schemas/LuxroutageShipToLuxroutage' bill_to_address: $ref: '#/components/schemas/LuxroutageBillToLuxroutage' line_items: type: array description: List of the products included in the order. example: - sku: sku name: name quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemluxroutage' required: - bill_to_address - carrier_code - line_items - order_number - ship_to_address - total_price additionalProperties: false title: Luxroutage LRI CreatewmsOrder--Mabang--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number ship_to_address: $ref: '#/components/schemas/ShipToAddressMabang' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemmabang' shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shop_name: type: string description: Shop name example: My Store reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id required: - line_items - ship_to_address - shipping_method_id - shop_name additionalProperties: false title: Mabang CreatewmsOrder--Mai__Fulfillment--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemmai' ship_to_address: $ref: '#/components/schemas/ShipToAddressMai' shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' required: - line_items - order_number - ship_to_address - shipping_method_name additionalProperties: false title: Mai Fulfillment CreatewmsOrder--Mainfreight--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id debtor_id: type: string description: Mainfreight debtor code billed for the order. example: D12345 service_level: type: string description: The type of shipping method requested by the customer. example: Standard required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' ship_to_address: $ref: '#/components/schemas/ShipToAddressMainfreight' line_items: type: array description: List of the products included in the order. example: - sku: SKU123 quantity: 1 items: $ref: '#/components/schemas/WmsOrderCreateLineItemmainfreight' required: - debtor_id - line_items - order_number - ship_to_address - warehouse_id additionalProperties: false title: Mainfreight CreatewmsOrder--MasonHub--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 passthrough_fields: custom_field_1: value1 custom_field_2: 123 items: $ref: '#/components/schemas/WmsOrderWriteLineItemmasonhub' ship_to_address: $ref: '#/components/schemas/ShipToAddressMasonhub' order_number: type: string description: A user-friendly identifier for their order. example: order_number type: type: string default: customer enum: - customer - destroy - packAndHold - quarantine - returnToVendor - transfer - wholesale - workOrder - dropship description: The type of order. example: customer carrier_id: type: string default: masonhub enum: - rate_shop - masonhub - UPS - USPS - FEDEX - DHL - willCall description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: FEDEX service_level: type: string enum: - economy - nextDayAirEarlyAM - nextDay - guaranteedNextDay - standardOvernight - priorityOvernight - 2-day - 2day - 3-day - 3day - guaranteed2Day - ground - groundSelect - groundPlus - priority - LTL - FTL - willCall - international description: The type of shipping method requested by the customer. example: 2-day priority: type: integer default: 100 minimum: 1 maximum: 10000 description: >- The priority number of the order. 1 is the highest priority and should only be used in special circumstances. example: 0 shipping_address_type: type: string default: residential enum: - business - residential description: Business or residential address. example: residential passthrough_fields: type: object description: >- Use this object to pass fields directly to the underlying API. You will have to read the API's documentation to know what fields are available, and cannot override fields that are managed by Trackstar. example: custom_field_1: value1 custom_field_2: 123 additionalProperties: {} required: - line_items - service_level - ship_to_address additionalProperties: false title: MasonHub CreatewmsOrder--Mintsoft--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemmintsoft' ship_to_address: $ref: '#/components/schemas/ShipToAddressMintsoft' channel_object: $ref: '#/components/schemas/ChannelSchema' description: The channel the order was placed on. order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id notes: type: string description: A note to attach to the order example: notes delivery_notes: type: string description: Delivery instructions, passed to the courier where supported example: delivery_notes gift_messages: type: string description: Gift message printed on the despatch note example: gift_messages required: - line_items - ship_to_address - shipping_method_id - warehouse_id additionalProperties: false title: Mintsoft CreatewmsOrder--Moda__Express--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number service_level: type: string description: The type of shipping method requested by the customer. example: Standard required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' invoice_currency_code: type: string minLength: 3 maxLength: 3 description: >- The currency used for this order. If not provided explicitly, defaults to USD. example: USD ship_to_address: $ref: '#/components/schemas/ShipToAddressModa-Express' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 1 unit_price: 10.99 items: $ref: '#/components/schemas/WmsOrderCreateLineItemmoda-express' required: - line_items - order_number - ship_to_address - warehouse_id additionalProperties: false title: Moda Express CreatewmsOrder--Next3PL--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number ship_to_address: $ref: '#/components/schemas/ShipToAddressNext3Pl' customer_instructions: type: string description: Customer Instructions example: customer_instructions warehouse_instructions: type: string description: Warehouse Instructions example: warehouse_instructions freight_instructions: type: string description: Freight Instructions example: freight_instructions shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground postage_rate: type: number description: Postage Rate example: 0 line_items: type: array description: List of the products included in the order. example: - sku: sku sku_description: sku_description quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemnext3pl' required: - line_items - order_number - reference_id - ship_to_address - shipping_method_id additionalProperties: false title: Next3PL CreatewmsOrder--NextSmartShip--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/ShipToAddressNextsmartship' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemnextsmartship' tags: type: array description: >- A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`. example: - tag_0 items: type: string description: A tag associated with the order. example: tag_0 note: type: string description: '' example: note required: - line_items - reference_id - ship_to_address additionalProperties: false title: NextSmartShip CreatewmsOrder--NFI--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number invoice_currency_code: type: string enum: - USD - CAD description: >- The currency used for this order. If not provided explicitly, defaults to USD. example: USD shipping_method_id: type: string enum: - LowCost - CanadaZoneSkipExpress - GROUND - Expedited - Xpresspost description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: CanadaZoneSkipExpress required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' ship_to_address: $ref: '#/components/schemas/ShipToAddressNFI' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 country_of_origin: country_of_origin items: $ref: '#/components/schemas/WmsOrderWriteLineItemnfi' required: - line_items - reference_id - required_ship_date - ship_to_address additionalProperties: false title: NFI CreatewmsOrder--Nimble--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 1 items: $ref: '#/components/schemas/WmsOrderWriteLineItemnimble' ship_to_address: $ref: '#/components/schemas/ShipToAddressNimble' reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id warehouse_id: type: string enum: - N/A - Connect an account to see options description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground required: - line_items - reference_id - ship_to_address additionalProperties: false title: Nimble CreatewmsOrder--NLRP--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/ShipToAddressNlrp' purchase_order_number: type: string description: PO Number example: purchase_order_number terms: type: string description: Terms example: Net 30 sales_rep: type: string description: Sales Rep example: VA ship_date: type: string format: date-time description: The earliest date the order can ship example: '2023-03-15T13:45:30Z' required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground memo: type: string description: '' example: memo total_tax: type: number description: The total tax on the order. example: 1.5 sales_tax_code: type: string description: '' example: sales_tax_code sales_tax_item: type: string description: '' example: sales_tax_item sales_tax_percentage: type: number description: '' example: 0 other: type: number description: '' example: 0 line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 description: description unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemnlrp' required: - line_items - reference_id - shipping_method_id - terms additionalProperties: false title: NLRP CreatewmsOrder--NPFulfilment--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: npf's SalesOrderNo. Defaults to `reference_id` if not provided. example: order_number shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. npf's dispatch method code, e.g. EP or AP. npf rejects an unrecognized code with its own error. example: fedex_ground total_price: type: number description: The total price a customer paid for the order. example: 13.49 total_discount: type: number description: The total amount discounted from the order. example: 2.5 total_shipping: type: number description: The total shipping cost for the order incurred by the customer. example: 3.5 ship_to_address: $ref: '#/components/schemas/ShipToAddressNpfulfilment' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 barcode: barcode items: $ref: '#/components/schemas/WmsOrderWriteLineItemnpfulfilment' customer_number: type: string description: npf's identifier for the customer placing the order. example: '227232' required: - customer_number - line_items - ship_to_address - shipping_method_id - total_price additionalProperties: false title: NPFulfilment CreatewmsOrder--NRI--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemnri' ship_to_address: $ref: '#/components/schemas/ShipToAddressNri' bill_to_address: $ref: '#/components/schemas/BillToAddressNri' order_number: type: string description: A user-friendly identifier for their order. example: order_number first_ship_date: type: string format: date-time description: Beginning of shipping window. example: '2025-01-01T00:00:00Z' last_ship_date: type: string format: date-time description: Last date of shipping window example: '2025-01-01T00:00:00Z' freight_term_code: type: string enum: - Prepaid - Collect - Third Party - Recipient description: Who is paying for shipment. Defaults to Prepaid if not provided. example: Collect carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. Only required if freight_term_code is 'Collect' or 'Third Party'. example: fedex carrier_account_number: type: string description: Only required if freight_term_code is 'Collect' or 'Third Party'. example: carrier_account_number order_type: type: string description: The type of order, defaults to Wholesale. example: order_type warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id required: - line_items - order_number - reference_id - ship_to_address additionalProperties: false title: NRI CreatewmsOrder--OIA__Global--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number service_level: type: string description: >- The type of shipping method requested by the customer. OIA's service level code for the chosen carrier, e.g. G for ground: the service_level under additional_fields of a shipping method from GET /shipping-methods. OIA requires it and the valid codes differ per carrier, so no default is applied. example: Standard transportation_mode: type: string description: OIA's transportation mode. Defaults to G. example: G carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. OIA's carrier_code: the carrier_id of a shipping method from GET /shipping-methods. Defaults to CALL (call for routing), which ships without a tracking number. example: fedex carrier_name: type: string description: >- The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level. example: FedEx required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' ship_to_address: $ref: '#/components/schemas/ShipToAddressOia-Global' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemoia-global' signature_required: type: boolean description: True if the order requires a signature upon delivery. example: false priority: type: integer minimum: 1 maximum: 30 description: OIA order priority. example: 15 freight_terms: type: string enum: - C - P - T - R - CB description: Who pays freight for the order. example: P required: - line_items - order_number - reference_id - service_level - ship_to_address additionalProperties: false title: OIA Global CreatewmsOrder--Ongoing__WMS--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id delivery_date: type: string format: date-time description: Expected delivery date example: '2023-03-15T13:45:30Z' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemongoing' ship_to_address: $ref: '#/components/schemas/ShipToAddressOngoing' required: - delivery_date - line_items - order_number - ship_to_address - warehouse_id additionalProperties: false title: Ongoing WMS CreatewmsOrder--OrderWise--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/OrderWiseShipToAddressOrderwise' shipping_method_id: type: string enum: - >- N/A: Get your Delivery Method IDs from your OrderWise representative description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 1 unit_price: 10.99 items: $ref: '#/components/schemas/WmsOrderWriteLineItemorderwise' required: - line_items - order_number - reference_id - ship_to_address - shipping_method_id additionalProperties: false title: OrderWise CreatewmsOrder--PackemWMS--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/ShipToAddressPackem' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItempackem' required: - line_items - reference_id - ship_to_address additionalProperties: false title: PackemWMS CreatewmsOrder--Packiyo--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number service_level: type: string description: The type of shipping method requested by the customer. example: Standard line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItempackiyo' ship_to_address: $ref: '#/components/schemas/ShipToAddressPackiyo' reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id channel_object: $ref: '#/components/schemas/ChannelSchema' description: The channel the order was placed on. required: - line_items - order_number - service_level - ship_to_address additionalProperties: false title: Packiyo CreatewmsOrder--Pattern--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number ship_to_address: $ref: '#/components/schemas/addressPattern' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItempattern' carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex required: - line_items - order_number - ship_to_address additionalProperties: false title: Pattern CreatewmsOrder--Picqer--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/OrderShipToAddressPicqer' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItempicqer' required: - line_items - ship_to_address additionalProperties: false title: Picqer CreatewmsOrder--Portless--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number ship_to_address: $ref: '#/components/schemas/shippingAddressPortless' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 discount_amount: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemportless' carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground custom_fields: type: array description: List of the custom fields example: - name: recipientTaxId value: '12345678909' items: $ref: '#/components/schemas/CustomField' required: - carrier_id - line_items - order_number - ship_to_address - shipping_method_id additionalProperties: false title: Portless CreatewmsOrder--QLS--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/ShipToAddressQls' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemqls' required: - line_items - reference_id - ship_to_address - warehouse_id additionalProperties: false title: QLS CreatewmsOrder--Quiet__Platforms--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id order_number: type: string description: A user-friendly identifier for their order. example: order_number shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex ship_to_address: $ref: '#/components/schemas/QuietOrderAddress' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemquiet' required: - carrier_id - line_items - order_number - ship_to_address - shipping_method_id - warehouse_id additionalProperties: false title: Quiet Platforms CreatewmsOrder--Salesupply--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} shop_id: type: string default: N/A - Connect an account to see options enum: - N/A - Connect an account to see options description: Salesupply Shop ID example: N/A - Connect an account to see options order_number: type: string description: A user-friendly identifier for their order. example: order_number ship_to_address: $ref: '#/components/schemas/CreateOrderShipToAddressSalesupply' bill_to_address: $ref: '#/components/schemas/CreateOrderBillToAddressSalesupply' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemsalesupply' invoice_currency_code: type: string default: USD enum: - USD description: '' example: USD channel_object: $ref: '#/components/schemas/SaleSupplyCreateOrderChannelObject' required: - bill_to_address - line_items - order_number - ship_to_address additionalProperties: false title: Salesupply CreatewmsOrder--ShipBob--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id order_number: type: string description: A user-friendly identifier for their order. example: order_number shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Must pass in either shipping_method_id or shipping_method_name. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. Must pass in either shipping_method_id or shipping_method_name. example: FedEx Ground ship_to_address: $ref: '#/components/schemas/ShipToAddressShipbob' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemshipbob' type: type: string enum: - b2b - d2c - dropship description: The type of order, such as d2c, b2b, dropship, or transfer. example: d2c carrier_type: type: string enum: - parcel - freight description: The carrier type for B2B orders. example: freight payment_term: type: string enum: - prepaid - merchant_responsible description: The payment term for B2B orders. example: merchant_responsible purchase_order_number: type: string description: Purchase order number for B2B orders. example: purchase_order_number tags: type: array description: A list of tags to attach to the order, formatted as `key:value`. example: - category:electronics items: type: string description: A tag for the order. example: category:electronics channel_object: $ref: '#/components/schemas/ShipbobCreateOrderChannelObject' required: - line_items - reference_id - ship_to_address additionalProperties: false title: ShipBob CreatewmsOrder--Shipedge--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id channel_object: $ref: '#/components/schemas/ShipedgeChannelSchema' description: The channel the order was placed on. shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground ship_to_address: $ref: '#/components/schemas/ShipToAddressShipedge' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemshipedge' required: - line_items - order_number - ship_to_address - shipping_method_id additionalProperties: false title: Shipedge CreatewmsOrder--Shipfusion--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemshipfusion' ship_to_address: $ref: '#/components/schemas/ShipToAddressShipfusion' shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex channel_object: $ref: '#/components/schemas/ShipfusionCreateOrderChannelObject' extra_data: type: object description: Free-form fields passed through to Shipfusion's `extraData` as-is. example: Channel_type: SHOPIFY shopifyTags: [] additionalProperties: {} required: - line_items - order_number - ship_to_address - warehouse_id additionalProperties: false title: Shipfusion CreatewmsOrder--ShipHero--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id order_number: type: string description: A user-friendly identifier for their order. example: order_number ship_to_address: $ref: '#/components/schemas/CreateOrderShipToAddressShiphero' bill_to_address: $ref: '#/components/schemas/CreateOrderBillToAddressShiphero' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 warehouse_id: warehouse_id quantity_pending_fulfillment: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemshiphero' reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id packing_note: type: string description: Packing note for the order example: packing_note gift_note: type: string description: Gift note for the order example: gift_note shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex shipping_price: type: number description: Shipping price example: 0 tags: type: array description: >- A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`. example: - tag_0 items: type: string description: A tag associated with the order. example: tag_0 required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' hold_until_date: type: string format: date-time description: >- Date before which shiphero should not fulfill the order. Shiphero reads the time of day in the warehouse account's own timezone, so it comes back shifted by that offset. example: '2023-03-15T13:45:30Z' channel_object: $ref: '#/components/schemas/ChannelSchema' description: The channel the order was placed on. type: type: string enum: - d2c - b2b description: The type of order, such as d2c, b2b, dropship, or transfer. example: d2c trading_partner: type: string description: >- For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart). example: Target trading_partner_id: type: string description: Vendor-specific trading-partner identifier provided by shiphero ops. example: trading_partner_id gs1_labels_required: type: boolean description: Whether shiphero should generate GS1 labels for this order. example: true store_location_number: type: string description: Store location number for retail/EDI orders. example: store_location_number shipping_option: type: string enum: - COURIER - FREIGHT description: COURIER or FREIGHT — wholesale shipping mode. example: COURIER requested_delivery_date: type: string format: date-time description: Requested delivery date. example: '2023-03-15T13:45:30Z' ship_not_before_date: type: string format: date-time description: Earliest acceptable ship date. example: '2023-03-15T13:45:30Z' ship_no_later_than_date: type: string format: date-time description: Latest acceptable ship date. example: '2023-03-15T13:45:30Z' department: type: string description: Department for retail/EDI orders. example: department department_number: type: string description: Department number for retail/EDI orders. example: department_number division: type: string description: Division for retail/EDI orders. example: division vendor: type: string description: Vendor name. example: vendor vendor_id: type: string description: Vendor identifier. example: vendor_id purchase_order_type: type: string description: Free-form purchase-order type (e.g. 'New', 'Reorder'). example: purchase_order_type reference_fields: type: object description: >- Arbitrary key/value passthrough emitted to shiphero's JSONObjectScalar reference_fields. example: {} additionalProperties: type: string description: '' example: reference_fields wholesale_shipping_details: $ref: '#/components/schemas/WholesaleShippingDetails' required: - line_items - order_number - ship_to_address additionalProperties: false title: ShipHero CreatewmsOrder--ShipMonk--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id type: type: string enum: - direct_to_consumer - retail - amazon - transfer - removal_liquidation - disposal - bonded_inventory_clearance - work_order description: The type of order, such as d2c, b2b, dropship, or transfer. example: amazon trading_partner: type: string description: >- For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart). example: Target line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 name: name unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemshipmonk' ship_to_address: $ref: '#/components/schemas/CreateOrderShipToAddressShipmonk' customer_notes: type: string description: >- Notes from the buyer (e.g. delivery preferences), stored by ShipMonk on order creation only. example: customer_notes internal_notes: type: string description: >- Notes for warehouse staff, not shown to the buyer. Stored by ShipMonk on order creation only. example: internal_notes custom_data: type: array description: >- Key/value metadata stored on the ShipMonk order, usable by ShipMonk automation rules. example: - name: Channel value: Wholesale items: $ref: '#/components/schemas/ShipmonkOrderCustomData' required: - line_items - order_number - ship_to_address additionalProperties: false title: ShipMonk CreatewmsOrder--Shipping__and__Handling--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} ship_to_address: $ref: '#/components/schemas/ShipToAddressShipping-And-Handling' line_items: type: array description: List of the products included in the order. example: - sku: sku name: name quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemshipping-and-handling' service_level: type: string description: The type of shipping method requested by the customer. example: Standard notes: type: string description: '' example: notes order_number: type: string description: A user-friendly identifier for their order. example: order_number required: - line_items additionalProperties: false title: Shipping and Handling CreatewmsOrder--ShippingTree--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemshipping-tree' ship_to_address: $ref: '#/components/schemas/ShipToAddressShipping-Tree' reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number tags: type: array description: >- A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`. example: - tag_0 items: type: string description: A tag associated with the order. example: tag_0 warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id required: - line_items - ship_to_address additionalProperties: false title: ShippingTree CreatewmsOrder--ShipStation--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number status: type: string enum: - awaiting_payment - awaiting_shipment description: >- The ShipStation status to create the order with. Orders created as `awaiting_payment` sit in the Awaiting Payment tab and have to be moved before they can ship. example: awaiting_shipment required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground bill_to_address: $ref: '#/components/schemas/CreateBillingAddressShipstation' ship_to_address: $ref: '#/components/schemas/CreateOrderShipToAddressShipstation' line_items: type: array description: List of the products included in the order. example: - quantity: 0 sku: sku unit_price: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemshipstation' required: - line_items - ship_to_address additionalProperties: false title: ShipStation CreatewmsOrder--ShipStream--: type: object properties: custom_fields: type: string description: Connect an account to see custom fields. example: custom_fields shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground channel_object: $ref: '#/components/schemas/ChannelIdSchema' description: The channel the order was placed on. reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/ShipToAddressShipstream' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemshipstream' trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} required: - custom_fields - line_items - ship_to_address additionalProperties: false title: ShipStream CreatewmsOrder--Shipwire--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string minLength: 1 maxLength: 25 description: A user-friendly identifier for their order. example: order_number ship_to_address: $ref: '#/components/schemas/ShipToAddressShipwire' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemshipwire' required: - line_items - order_number - ship_to_address additionalProperties: false title: Shipwire CreatewmsOrder--SKUSavvy--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id ship_to_address: $ref: '#/components/schemas/ShipToAddressSkusavvy' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemskusavvy' required: - line_items - ship_to_address - warehouse_id additionalProperties: false title: SKUSavvy CreatewmsOrder--Linnworks__Core__-_SKUVault_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number ship_to_address: $ref: '#/components/schemas/ShipToAddressSkuvault' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemskuvault' required: - line_items - order_number - ship_to_address additionalProperties: false title: Linnworks Core (SKUVault) CreatewmsOrder--Smart__Warehousing--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/ShipToAddressSmart-Warehousing' bill_to_address: $ref: '#/components/schemas/BillToAddressSmart-Warehousing' cod_flag: type: boolean description: Whether or not the order is COD (cash on delivery). example: true client_tracking: type: string description: >- Pre-defined list of values that Smart Warehousing sets up for you to track orders by deparment, cost center, or sales rep. Use '2' if not specified example: client_tracking shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 2 items: $ref: '#/components/schemas/WmsOrderWriteLineItemsmart-warehousing' required: - line_items - ship_to_address additionalProperties: false title: Smart Warehousing CreatewmsOrder--Sojo--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number memo: type: string description: A note or memo that will be added to the order for internal use example: memo warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id expected_ship_date: type: string format: date description: The date when the shipment is expected to be dispatched. example: '2023-03-15' line_items: type: array description: List of the products included in the order. example: - product_id: product_id quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemsojo' ship_to_address: $ref: '#/components/schemas/ShipToAddressSojo' required: - expected_ship_date - line_items - memo - reference_id - ship_to_address - warehouse_id additionalProperties: false title: Sojo CreatewmsOrder--Star__WMS--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id warehouse_id: type: string enum: - N/A - Connect an account to see options description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id ship_to_address: $ref: '#/components/schemas/ShipToAddressStar' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemstar' shipping_method_id: type: string enum: - N/A - Connect an account to see options description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Can also use 'Other'. Make sure that the shipping method's additional_fields corresponds with the warehouse_id specified in this order. example: fedex_ground notes: type: string description: A note to attach to the order example: notes platform_order_number: type: string description: The originating sales platform's order number example: platform_order_number passthrough_fields: type: object description: >- Use this object to pass fields directly to the underlying API. You will have to read the API's documentation to know what fields are available, and cannot override fields that are managed by Trackstar. example: custom_field_1: value1 custom_field_2: 123 additionalProperties: {} required: - line_items - order_number - ship_to_address - warehouse_id additionalProperties: false title: Star WMS CreatewmsOrder--States__Logistics--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/StatesShipToAddressStates-Logistics' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 lot_id: lot_id items: $ref: '#/components/schemas/WmsOrderWriteLineItemstates-logistics' required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' required: - line_items - order_number - ship_to_address additionalProperties: false title: States Logistics CreatewmsOrder--Stord--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number reference_id: type: - string - 'null' default: null description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id ship_to_address: $ref: '#/components/schemas/ShipToAddressStord' bill_to_address: $ref: '#/components/schemas/BillToAddressStord' warehouse_id: type: string enum: - N/A - Connect an account to see options description: A PREFERRED warehouse that the order will be shipped from. example: warehouse_id required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' channel_object: $ref: '#/components/schemas/ChannelSchema' description: The channel the order was placed on. line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 lot_id: lot_id unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemstord' carrier_name: type: string description: >- The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level. example: FedEx scac: type: string description: The Standard Carrier Alpha Code (SCAC) for the carrier. example: FDXG service_level: type: string description: The type of shipping method requested by the customer. example: Standard integration_metadata: type: object description: >- Free-form metadata fields for integration-specific data. See https://developers.stord.com/reference/createsalesorder#body-params for available fields. Passed through to Stord API as-is. example: integration_metadata_order1: value1 SourceSystem: Shopify additionalProperties: {} shipping_code: type: string description: Shipping code for the order example: Priority external_posted_at: type: string format: date-time description: The date and time the order was posted externally. example: '2023-03-15T13:45:30Z' required: - line_items - order_number - ship_to_address additionalProperties: false title: Stord CreatewmsOrder--TLogistics--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string maxLength: 20 description: A user-friendly identifier for their order. example: order_number trading_partner: type: string description: >- For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart). example: Target carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex service_level: type: string description: The type of shipping method requested by the customer. example: Standard type: type: string enum: - d2c - b2b description: The type of order, such as d2c, b2b, dropship, or transfer. example: d2c incoterm: type: string description: The Incoterm for the order. example: DAP ship_to_address: $ref: '#/components/schemas/CreateOrderShipToAddressTlogistics' invoice_currency_code: type: string minLength: 3 maxLength: 3 description: >- The currency of the line items' unit_price. Required when any line has a unit_price. example: EUR line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 1 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemtlogistics' required: - line_items - order_number - ship_to_address additionalProperties: false title: TLogistics CreatewmsOrder--TPS--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number type: type: string enum: - d2c - b2b description: The type of order, such as d2c, b2b, dropship, or transfer. example: d2c shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground invoice_currency_code: type: string description: The currency used for this order. example: GBP required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' ship_to_address: $ref: '#/components/schemas/TpsShipToAddressTps' line_items: type: array description: List of the products included in the order. example: - sku: SKU-001 quantity: 2 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemtps' note: type: string description: '' example: Leave with reception gift_message: type: string description: '' example: Enjoy required: - line_items - reference_id - required_ship_date - ship_to_address - shipping_method_id additionalProperties: false title: TPS CreatewmsOrder--Unis--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id freight_term: type: string enum: - CC - PP - TP description: '' example: CC shipping_account_number: type: string description: '' example: shipping_account_number shipping_method_id: type: string enum: - M - L - U - W - NA description: '' example: L shipping_method: type: string enum: - M - L - U - W - NA description: Deprecated - use shipping_method_id instead example: L carrier_name: type: string description: >- The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level. example: FedEx scac: type: string description: '' example: scac ship_to_address: $ref: '#/components/schemas/ShipToAddressUnis' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemunis' required: - freight_term - line_items - reference_id - ship_to_address - warehouse_id additionalProperties: false title: Unis CreatewmsOrder--Unleashed--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} ship_to_address: $ref: '#/components/schemas/ShipToAddressUnleashed' order_number: type: string description: A user-friendly identifier for their order. example: order_number warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderCreateLineItemunleashed' reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id customer_code: type: string description: '' example: customer_code required: - line_items - ship_to_address additionalProperties: false title: Unleashed CreatewmsOrder--Veeqo--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} channel_object: $ref: '#/components/schemas/ChannelIdSchema' description: The channel the order was placed on. ship_to_address: $ref: '#/components/schemas/ShipToAddressVeeqo' order_number: type: string description: A user-friendly identifier for their order. example: order_number line_items: type: array description: List of the products included in the order. example: - product_id: product_id unit_price: 0 quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemveeqo' shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground required: - line_items additionalProperties: false title: Veeqo CreatewmsOrder--VeraCore--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_id: type: string description: Custom order ID example: order_id delivery_date: type: string format: date-time description: Expected delivery date of the order. example: '2023-03-15T13:45:30Z' ship_to_address: $ref: '#/components/schemas/ShipToAddressVeracore' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderLineItemveracore' shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground notes: type: string description: Notes associated with the inbound shipment. example: notes required: - line_items - ship_to_address additionalProperties: false title: VeraCore CreatewmsOrder--Warehance--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id order_number: type: string description: A user-friendly identifier for their order. example: order_number service_level: type: string enum: [] description: The type of shipping method requested by the customer. example: Standard shipping_method_id: type: string description: Use service_level instead. example: shipping_method_id shipping_method_name: type: string description: Use service_level instead. example: shipping_method_name ship_to_address: $ref: '#/components/schemas/OrderShipToAddressWarehance' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemwarehance' channel_object: $ref: '#/components/schemas/WarehanceChannelIdSchema' description: The channel the order was placed on. required_ship_date: type: string format: date-time description: The date by which this order must be shipped. example: '2023-03-15T13:45:30Z' required: - channel_object - line_items - ship_to_address - warehouse_id additionalProperties: false title: Warehance CreatewmsOrder--Whiplash__-_Ryder_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} shipping_method_id: type: string description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. Can pass in either shipping_method_id or shipping_method_name + carrier_id example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. Can pass in either shipping_method_id or shipping_method_name + carrier_id example: FedEx Ground carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. Can pass in either shipping_method_id or shipping_method_name + carrier_id example: fedex status: type: string enum: - open - fulfilled - processing description: >- The status of the order. See the [order information](info) for more details. example: open order_type: type: string enum: - direct_to_consumer - dropship - retail - transfer - value_added_service - wholesale description: The type of order. example: direct_to_consumer ship_to_address: $ref: '#/components/schemas/ShipToAddressWhiplash' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 2 unit_price: 2 items: $ref: '#/components/schemas/WmsOrderWriteLineItemwhiplash' reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id required: - ship_to_address additionalProperties: false title: Whiplash (Ryder) CreatewmsOrder--Xorosoft--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} brand_name: type: string description: >- The brand name associated with this order. Defaults to your 3PL Account Name if not provided. example: brand_name reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number warehouse_id: type: string description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id required_ship_date: type: string format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' cancel_by_date: type: string format: date-time description: >- The date an order should be canceled by if not fulfilled. Must be greater than required_ship_date example: '2021-01-01T12:00:00Z' invoice_currency_code: type: string default: USD enum: - USD - CAD - EUR - AUD description: '' example: USD carrier_name: type: string default: RATE SHOP - GROUND enum: - ABF FREIGHT - ACE Courier Services - AEROPACEX - AEROSTREAM - Apex Motor Express - APPS Express - ARGUS GROUND - ATLAS COURIER - ATS - C&D Logistics - CALYX - Canaan Group - Canada Post - CANADA WEST WAREHOUSING - CANPAR - Carson International - CCT Canada - CENTRAL TRANSPORT - CEVA - CH ROBINSON - CLARKE TRANSPORT - COASTLINE - CONSOLIDATED FASTFRATE - CONWAY - CSA TRANSPORTATION - DAN FOSS - Davidson & Sons - DAY & ROSS - DHL - DIAMOND DELIVERY - DICOM - DIRECTRIGHT CARTAGE 2001 INC - Dynatrans - ESTES EXPRESS - Exmark Transportation Services Ltd - EXPEDITORS - FedEx - FEDEX FREIGHT - FRONTLINE - GALAXY FREIGHT - Globco - GLOBE - GORDON TRUCKING - GREENLIGHT - GUILBAULT LOGISTIQUE - Hi-Way 9 Express - HODGSON FREIGHT - INTERURBAN - J&R HALL - JB HUNT - K & H DISPATCH - KINDERSLEY TRANSPORT LTD - KP TRANSPORT - KWE - LOOMIS - Manatee Logistics - MANITOULIN TRANSPORT - MC FREIGHT - Midland Transport - M-O GROUND - MORNEAU TRANSPORT - MTF - NAT - Rate Shop 2-3 Days - NAT - Rate Shop Air - NAT - Rate Shop Ground - NATIONAL FASTFREIGHT - NATIONAL GROUND - NEW LEGEND - NIJJAR TRUCKING LTD. - NOVEX - Number 8 Freight - OAK HARBOR - OLD DOMINION - Olympia Transportation LTD. - ONTRAC - OVERLAND WEST FREIGHT LINES - P/U Surrey - PCX - PACIFIC COAST EXPRESS - PLAYBOOK LOGISITICS - PRIORITY LOGISTICS - PROWEST - Prudential Transportation LTD - PUROLATOR - PUROLATOR FREIGHT - QAAW - QRC LOGISTICS - QUIKX - RADIUS LOGISTICS - RATE SHOP - 2 DAY - RATE SHOP - 3 DAY - RATE SHOP - AIR - RATE SHOP - GROUND - RATE SHOP - INTERNATIONAL - REDDAWAY - RE-JAY FREIGHT - REMCO - ROADRUNNER - ROLLS RIGHT - ROSEDALE TRANSPORTATION - RR PLETT TRUCKING - S. & S. Forwarding LTD - SAMEDAY - Sarai Express Trucking - SCOTT FREIGHT - SEA TO SKY - Sealion Cargo - Secam - SEE ROUTING GUIDE - SEER - SIMARD WESTLINK - SPEEDEE TRANSPORT - TFORCE - Toppers - TRADEWINDS - TRANS GLOBAL - TRANSX - TRI-AD - TST Overland - TST-CF Express - U.S. XPRESS - Uniuni - UPS - UPS FREIGHT - VAN-KAM FREIGHTWAYS LTD - VITRAN - VK Logistics - WESTERN CANADA - WIZMO - XPO LOGISTICS - YRC FREIGHT - Z&H Freight International description: >- The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level. example: FedEx shipping_method_name: type: string default: RATE SHOP - GROUND description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground service_level: type: string default: Delivery (Third Party) description: The type of shipping method requested by the customer. example: Standard ship_to_address: $ref: '#/components/schemas/CreateOrderShipToAddressXorosoft' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 item_quality: XYZ-FRST unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemxorosoft' type: type: string enum: - d2c - b2b description: The type of order, such as d2c, b2b, dropship, or transfer. example: d2c purchase_order_number: type: string description: Customer purchase order number used for identification example: '1234567' required: - line_items - reference_id - required_ship_date - ship_to_address - type - warehouse_id additionalProperties: false title: Xorosoft CreatewmsOrder--Zenfulfillment--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number shipping_method_id: type: string enum: - DHE - DHL - DHL_BULKY - DHL_AGE - DHL_CLOSEST_DROPPOINT - DHL_KLEINPAKET - DHL_KLEINPAKET_FIL - DHL_NACHNAME - DHL_FIL - DHL_ECONNECT - DHL_DDP - DHL_SWAP - DPD - DPD_EXP_PACK_1 - DPD_EXP_PACK_5 - DPD_PARCEL_24 - DPD_PARCEL_48 - DPD_PARCEL_INTL - AMZ_PRIME_DPD - AMZ_PRIME_DHL - AMZ_SHIPPING_US - WRP - WRP_SIGNED - WRP_UNTRACKED - UPS_EXPRESS_SAVER - UPS_EXPRESS_PLUS - UPS_EXPRESS - UPS_AGES - UPS_WORLDWIDE_ECONOMY - LETTER - EXPORTO_DPD - EXPORTO_SWISSPOST - EXPORTO_ROYAL_MAIL - HERMES - HERMES_18 - DB_SCHENKER - KUEHNE_NAGEL - UPS - GRB - CASH_ON_DELIVERY - SPED_OA - SPED_MA - SPED_ND_OA - SPED_ND_MA - OTTO_DHL - DHL_RETURN_LABEL_NOPRINT - SWISSPOST - SWISSPOST_PRIORITY - EXPORTO_EVRI - EVRI_PACK_24 - EVRI_PACK_48 - EVRI_PARCEL_24 - EVRI_PARCEL_48 - EVRI_LANDL_48 - SEVEN_SENDERS_DPD_FR - SEVEN_SENDERS_DPD_AT - SEVEN_SENDERS_COLISSIMO - SEVEN_SENDERS_BARTOLINI - SEVEN_SENDERS_POST_AT - SEVEN_SENDERS_POST_AT_LQ - SEVEN_SENDERS_POST_AT_KLEINPAKET - SEVEN_SENDERS_POST_NL - SEVEN_SENDERS_POST_NL_LQ - SEVEN_SENDERS_SWISSPOST - GLS - GLS_LETTER - GLS_NACHNAME - GLS_IT_NACHNAME - GLS_PAKET_IT - GLS_KLEINPAKET - FEDEX - SWAP_FEDEX - FEDEX_INTERNATIONAL_PRIORITY - USPS - AMAZON_LOGISTICS_DE - QUICKPAC - POST_AT - POST_AT_KLEINPAKET - ROYAL_MAIL - RM_TRCK_24 - RM_TRCK_48 - RM_PACK_24 - RM_PACK_48 - RM_LL_24 - RM_LL_48 - RM_LB_TRCK_24 - RM_LB_TRCK_48 - UNDEFINED_CARRIER - MONDIAL_RELAY - SELBSTABHOLER - GLOBAL_E - PARCEL_ONE - POST_NL - MEIN_EINKAUF_CH_POST - MEIN_EINKAUF_CH_DPD - ZUFALL - GO_EXPRESS - HERMES_SERVICE_POINT - DACHSER - ZENRUSH - ZENRUSH_STANDARD_GLS - ZENRUSH_GLS - ZENRUSH_GLS_KLEINPAKET - ZENRUSH_STANDARD_DHL - ZENRUSH_DHL - ZENRUSH_STD - ZENRUSH_STANDARD_HERMES - FELDPOST - ASENDIA_LA_POSTE - ASENDIA_POST_AT - ASENDIA_SWISSPOST - PARCEL_FORCE_EXPRESS24 - FBA description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. If shipping_method_name is also provided, this will take precedence. example: AMAZON_LOGISTICS_DE invoice_currency_code: type: string description: ISO 4217 currency code for total_price and line item prices. example: EUR total_price: type: number description: The total price a customer paid for the order. example: 13.49 total_discount: type: number description: The total amount discounted from the order. example: 2.5 total_shipping: type: number description: The total shipping cost for the order incurred by the customer. example: 3.5 ship_to_address: $ref: '#/components/schemas/OrderShipToAddressZenfulfillment' bill_to_address: $ref: '#/components/schemas/OrderBillToAddressZenfulfillment' line_items: type: array description: List of the products included in the order. example: - product_id: product_id sku: sku quantity: 1 unit_price: 10.99 discount_amount: 1.5 items: $ref: '#/components/schemas/WmsOrderWriteLineItemzenfulfillment' required: - bill_to_address - invoice_currency_code - line_items - reference_id - ship_to_address - shipping_method_id - total_price additionalProperties: false title: Zenfulfillment CreatewmsOrder--Zenventory--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} ship_to_address: $ref: '#/components/schemas/ShipToAddressZenventory' line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 2 items: $ref: '#/components/schemas/WmsOrderWriteLineItemzenventory' reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: A user-friendly identifier for their order. example: order_number required: - line_items - ship_to_address additionalProperties: false title: Zenventory CreatewmsOrder--Zoho--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} order_number: type: string description: A user-friendly identifier for their order. example: order_number ship_to_address: $ref: '#/components/schemas/ShipToAddressZoho' reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 unit_price: 0 items: $ref: '#/components/schemas/WmsOrderWriteLineItemzoho' required: - line_items - ship_to_address additionalProperties: false title: Zoho CreateWmsOrderResponseDataSchema: type: object properties: id: type: string description: The unique ID of the order. example: order_id warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id warehouse_id: type: - string - 'null' description: >- If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id created_date: type: string format: date-time description: The date the order was created. example: '2022-01-01T00:00:00Z' updated_date: type: string format: date-time description: The date the order was last updated. example: '2022-01-02T05:05:05Z' reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: >- A user-friendly identifier for their order. Defaults to `reference_id` if not provided. example: order_number status: type: string enum: - open - confirmed - processing - picked - packed - partially_fulfilled - fulfilled - exception - cancelled - backordered - other description: >- The status of the order. See the [order information](info) for more details. example: open raw_status: type: - string - 'null' description: The raw status (if available) returned directly from the WMS. example: raw_status channel_object: anyOf: - $ref: '#/components/schemas/OrderChannel' - type: 'null' type: type: - string - 'null' enum: - d2c - b2b - dropship - transfer description: The type of order, such as d2c, b2b, dropship, or transfer. example: d2c trading_partner: type: - string - 'null' description: >- For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart). example: Target service_level: type: - string - 'null' description: The type of shipping method requested by the customer. example: Standard shipping_method_id: type: - string - 'null' description: >- The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. May vary from the shipping methods returned at the package level. example: fedex_ground shipping_method_name: type: - string - 'null' description: The name of the shipping method used to ship the order. example: FedEx Ground carrier_id: type: - string - 'null' description: >- The ID of the carrier used to ship the order to the customer. May vary from the carriers returned at the package level. example: fedex carrier_name: type: - string - 'null' description: >- The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level. example: FedEx scac: type: - string - 'null' description: >- The Standard Carrier Alpha Code for the carrier used to ship the order. example: scac is_third_party_freight: type: - boolean - 'null' description: True if the order was shipped using a third party freight account. example: false third_party_freight_account_number: type: - string - 'null' description: The third party freight account number used to ship the order. example: '123456' first_party_freight_account_number: type: - string - 'null' description: The first party freight account number used to ship the order. example: '123456' invoice_currency_code: type: string description: >- The currency used for this order. If not provided explicitly, defaults to USD. example: USD total_price: type: - number - 'null' description: The total price a customer paid for the order. example: 13.49 total_tax: type: - number - 'null' description: The total tax on the order. example: 1.5 total_discount: type: - number - 'null' description: The total amount discounted from the order. example: 2.5 total_shipping: type: - number - 'null' description: The total shipping cost for the order incurred by the customer. example: 3.5 ship_to_address: $ref: '#/components/schemas/ShipToAddress' line_items: type: array description: List of the products included in the order. example: - product_id: product_id sku: sku quantity: 1 unit_price: 10.99 discount_amount: 1.5 items: $ref: '#/components/schemas/WmsOrderLineItem' tags: type: array description: >- A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`. example: - tag_0 items: type: string description: A tag associated with the order. example: tag_0 required_ship_date: type: - string - 'null' format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' saturday_delivery: type: - boolean - 'null' description: True if the order requires Saturday delivery. example: false signature_required: type: - boolean - 'null' description: True if the order requires a signature upon delivery. example: false international_duty_paid_by: type: - string - 'null' enum: - sender - recipient - third_party description: The party responsible for paying international duties. example: sender shipments: type: array description: List of the shipments sent out to the customer. example: [] items: $ref: '#/components/schemas/OrderShipment' external_system_url: type: - string - 'null' description: URL link to the order in the external system (WMS/Freight etc). example: https://example.com/order/123 trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} additional_fields: type: object description: Integration-specific fields example: key: value additionalProperties: {} trackstar_created_date: type: string format: date-time description: '' example: '2023-03-15T13:45:30Z' trackstar_updated_date: type: string format: date-time description: '' example: '2023-03-15T13:45:30Z' required: - additional_fields - carrier_id - carrier_name - channel_object - created_date - external_system_url - first_party_freight_account_number - id - international_duty_paid_by - invoice_currency_code - is_third_party_freight - line_items - order_number - raw_status - reference_id - required_ship_date - saturday_delivery - scac - service_level - ship_to_address - shipments - shipping_method_id - shipping_method_name - signature_required - status - tags - third_party_freight_account_number - total_discount - total_price - total_shipping - total_tax - trackstar_created_date - trackstar_tags - trackstar_updated_date - trading_partner - type - updated_date - warehouse_customer_id - warehouse_id additionalProperties: false title: CreateWmsOrderResponseDataSchema SandboxChannelIdSchema: type: object properties: channel_id: type: string description: The ID of the channel. example: channel_id required: - channel_id additionalProperties: false title: SandboxChannelIdSchema SandboxCreateOrderShipToAddress: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - postal_code additionalProperties: false title: SandboxCreateOrderShipToAddress WmsOrderCreateLineItemsandbox: type: object properties: sku: type: string enum: - N/A - Connect an account to see options description: '' example: sku quantity: type: integer description: '' example: 1 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemsandbox WmsOrderWriteLineItemactive-ants: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemactive-ants ShipToAddressActive-Ants: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - company - country - full_name - postal_code additionalProperties: false title: ShipToAddressActive-Ants ShipToAddressAdp: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - state additionalProperties: false title: ShipToAddressAdp WmsOrderCreateLineItemadp: type: object properties: sku: type: string maxLength: 48 description: SKU or product code example: sku quantity: type: integer description: Quantity to ship example: 0 uom: type: string maxLength: 3 description: Unit of measure example: CT required: - quantity - sku - uom additionalProperties: false title: WmsOrderCreateLineItemadp ShipToAddressAmphora: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: '+1234567890' email_address: type: string description: '' example: user@example.com required: - address1 - city - country - full_name - postal_code additionalProperties: false title: ShipToAddressAmphora WmsOrderCreateLineItemamphora: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku - unit_price additionalProperties: false title: WmsOrderCreateLineItemamphora AmplifierChannelIdSchema: type: object properties: channel_id: type: string description: The ID of the channel. example: channel_id required: - channel_id additionalProperties: false title: AmplifierChannelIdSchema ShipToAddressAmplifier: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressAmplifier BillToAddressAmplifier: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: BillToAddressAmplifier WmsOrderWriteLineItemamplifier: type: object properties: sku: type: string description: SKU of the item. example: sku quantity: type: integer description: Quantity of the item. example: 1 description: type: string description: Description of the item. example: Widget required: - description - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemamplifier ChannelIdSchema: type: object properties: channel_id: type: string description: The ID of the channel. example: channel_id required: - channel_id additionalProperties: false title: ChannelIdSchema ShipToAddressAms: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: 555-867-5309 email_address: type: string description: '' example: jdoe@example.com required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressAms BillToAddressAms: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: 555-867-5309 email_address: type: string description: '' example: jdoe@example.com required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: BillToAddressAms WmsOrderWriteLineItemams: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemams ShipToAddressAmware: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: 123-456-7890 email_address: type: string description: '' example: johndoe@example.com additionalProperties: false title: ShipToAddressAmware WmsOrderWriteLineItemamware: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemamware ShipToAddressAtomix: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States email_address: type: string description: '' example: customer@example.com phone_number: type: string description: '' example: phone_number required: - address1 - city - country - email_address - full_name - postal_code - state additionalProperties: false title: ShipToAddressAtomix WmsOrderWriteLineItematomix: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItematomix ShipToAddressBergen: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: Phone number for the shipping address. example: phone_number required: - address1 - city - country - full_name - state additionalProperties: false title: ShipToAddressBergen BillToAddressBergen: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - company - country - full_name - postal_code - state additionalProperties: false title: BillToAddressBergen WmsOrderWriteLineItembergen: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku - unit_price additionalProperties: false title: WmsOrderWriteLineItembergen ShipToAddressBest-Inc: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: 123-456-7890 email_address: type: string description: '' example: johndoe@example.com required: - address1 - city - country - full_name - phone_number - postal_code - state additionalProperties: false title: ShipToAddressBest-Inc WmsOrderWriteLineItembest-inc: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItembest-inc ShipToAddressBluebox: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressBluebox WmsOrderCreateLineItembluebox: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItembluebox CreateOrderShipToAddressBoxzooka: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: 123-456-7890 email_address: type: string description: '' example: johndoe@example.com required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: CreateOrderShipToAddressBoxzooka WmsOrderWriteLineItemboxzooka: type: object properties: sku: type: string description: '' example: sku name: type: string description: The name of the item, as it should appear on the packing slip. example: Crew Tee - XS / White quantity: type: integer description: '' example: 0 weight: type: number description: The weight of the line item, in pounds. example: 1.5 unit_price: type: number description: '' example: 0 required: - name - quantity - sku - weight additionalProperties: false title: WmsOrderWriteLineItemboxzooka ShipToAddressCamelot: type: object properties: full_name: type: string maxLength: 30 description: '' example: John Doe address1: type: string maxLength: 30 description: '' example: 123 Main St address2: type: string maxLength: 30 description: '' example: Apt 2 city: type: string maxLength: 30 description: '' example: San Francisco state: type: string maxLength: 30 description: '' example: CA postal_code: type: string maxLength: 30 description: '' example: '94105' country: type: string maxLength: 30 description: '' example: United States required: - address1 - address2 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressCamelot WmsOrderWriteLineItemcamelot: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemcamelot WmsOrderWriteLineItemcapacity: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemcapacity ShipToAddressCapacity: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - address2 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressCapacity ShipToAddressCarton-Cloud: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code additionalProperties: false title: ShipToAddressCarton-Cloud WmsOrderWriteLineItemcarton-cloud: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemcarton-cloud ClarusCreateOrderShipToAddressClarus: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States email_address: type: string description: '' example: customer@example.com phone_number: type: string description: '' example: '+441234567890' required: - address1 - city - full_name additionalProperties: false title: ClarusCreateOrderShipToAddressClarus WmsOrderCreateLineItemclarus: type: object properties: product_id: type: string description: The Clarus product id. Use this or `sku`. example: '108' sku: type: string description: >- The product SKU. Use this or `product_id`. Must match exactly one Clarus product. example: '40116' quantity: type: integer minimum: 1 description: '' example: 1 required: - quantity additionalProperties: false title: WmsOrderCreateLineItemclarus ControlportChannelIdSchema: type: object properties: channel_id: type: string pattern: ^(\d+_)?\d+$ description: The ID of the channel. example: '12345' required: - channel_id additionalProperties: false title: ControlportChannelIdSchema CreateOrderShipToAddressControlport: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: '+447712356789' email_address: type: string description: '' example: email_address required: - address1 - city - country - full_name - phone_number - postal_code additionalProperties: false title: CreateOrderShipToAddressControlport CreateOrderBillToAddressControlport: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: '+447712356789' email_address: type: string description: '' example: email_address required: - address1 - city - country - full_name - phone_number - postal_code additionalProperties: false title: CreateOrderBillToAddressControlport WmsOrderWriteLineItemcontrolport: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 1 unit_price: type: number description: '' example: 0 required: - quantity - sku - unit_price additionalProperties: false title: WmsOrderWriteLineItemcontrolport ShipToAddressDarwynn-Fulfillment: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: phone_number email_address: type: string description: '' example: email_address required: - address1 - address2 - city - country - email_address - full_name - phone_number - postal_code - state additionalProperties: false title: ShipToAddressDarwynn-Fulfillment WmsOrderWriteLineItemdarwynn-fulfillment: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemdarwynn-fulfillment WmsOrderWriteLineItemdcl: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 custom_field1: type: string description: Custom field 1. example: custom value custom_field2: type: string description: Custom field 2. example: custom value custom_field5: type: string description: Custom field 5. example: custom value required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemdcl ShipToAddressDcl: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - postal_code - state additionalProperties: false title: ShipToAddressDcl ShipToAddressDear-Systems: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressDear-Systems BillToAddressDear-Systems: type: object properties: address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - postal_code - state additionalProperties: false title: BillToAddressDear-Systems WmsOrderWriteLineItemdear-systems: type: object properties: product_id: type: string description: '' example: product_id quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 tax: type: number description: '' example: 0 required: - product_id - quantity - tax - unit_price additionalProperties: false title: WmsOrderWriteLineItemdear-systems ShipToAddressDelmarcargo: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code additionalProperties: false title: ShipToAddressDelmarcargo WmsOrderCreateLineItemdelmarcargo: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemdelmarcargo OrderShipToAddressCreateDeposco: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: 123-456-7890 required: - address1 - city - country - full_name additionalProperties: false title: OrderShipToAddressCreateDeposco WmsOrderWriteLineItemdeposco: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 notes: type: array description: List of notes for this line item example: - title: Note Title body: Note Body items: $ref: '#/components/schemas/LineItemNotes' required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemdeposco ChannelSchema: type: object properties: {} additionalProperties: false oneOf: - $ref: '#/components/schemas/ChannelId' - $ref: '#/components/schemas/ChannelName' discriminator: propertyName: type mapping: id: '#/components/schemas/ChannelId' name: '#/components/schemas/ChannelName' title: ChannelSchema Notes: type: object properties: title: type: string description: Title of the note example: title body: type: string description: Body of the note example: body required: - body - title additionalProperties: false title: Notes ShipToAddressDistribution-Management: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - postal_code - state additionalProperties: false title: ShipToAddressDistribution-Management WmsOrderWriteLineItemdistribution-management: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemdistribution-management ShipToAddressDotcom-Distribution: type: object properties: full_name: type: string maxLength: 40 description: '' example: John Doe company: type: string maxLength: 40 description: '' example: Company address1: type: string maxLength: 40 description: '' example: 123 Main St address2: type: string maxLength: 40 description: '' example: Apt 2 city: type: string maxLength: 40 description: '' example: San Francisco state: type: string maxLength: 40 description: '' example: CA postal_code: type: string maxLength: 40 description: '' example: '94105' country: type: string maxLength: 40 description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressDotcom-Distribution WmsOrderWriteLineItemdotcom-distribution: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemdotcom-distribution WmsOrderWriteLineItemelite-ops: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemelite-ops ShipToAddressElite-Ops: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressElite-Ops ShipToAddressEshipping: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code additionalProperties: false title: ShipToAddressEshipping WmsOrderWriteLineItemeshipping: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemeshipping ShipToAddressEvolve: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressEvolve WmsOrderCreateLineItemevolve: type: object properties: sku: type: string description: '' example: sku quantity: type: integer minimum: 1 description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemevolve ShipToAddressExtensiv: type: object properties: full_name: type: string company: type: string address1: type: string address2: type: string city: type: string state: type: string postal_code: type: string country: type: string email_address: type: string phone_number: type: string required: - address1 - city - country - postal_code additionalProperties: false title: ShipToAddressExtensiv WmsOrderWriteLineItemextensiv-3pl-central: type: object properties: product_id: type: string description: '' example: product_id sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 custom_fields: type: array description: List of the custom fields example: - name: CustomField value: CustomValue items: $ref: '#/components/schemas/CustomField' required: - quantity additionalProperties: false title: WmsOrderWriteLineItemextensiv-3pl-central CustomField: type: object properties: name: type: string description: Name of the custom field example: name value: type: string description: Value of the custom field example: value required: - name - value additionalProperties: false title: CustomField BillToAddressExtensiv: type: object properties: full_name: type: string company: type: string address1: type: string address2: type: string city: type: string state: type: string postal_code: type: string country: type: string retailer_id: type: integer description: Retailer ID to bill the order to example: 0 required: - address1 - city - country - postal_code - state additionalProperties: false title: BillToAddressExtensiv ShipToAddressFba: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressFba WmsOrderCreateLineItemfba: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemfba CreateOrderFedex-Fulfillment: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: phone_number email_address: type: string description: '' example: email_address store_number: type: string description: '' example: store_number required: - address1 - city - company - country - email_address - full_name - phone_number - postal_code - state additionalProperties: false title: CreateOrderFedex-Fulfillment WmsOrderWriteLineItemfedex-fulfillment: type: object properties: sku: type: string description: '' example: sku vendor_sku: type: string description: '' example: vendor_sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemfedex-fulfillment Fedex-FulfillmentChannelIdSchema: type: object properties: channel_id: type: string description: The ID of the channel. example: channel_id required: - channel_id additionalProperties: false title: Fedex-FulfillmentChannelIdSchema ShipToAddressFfe: type: object properties: company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States first_name: type: string description: The first name of the recipient. example: first_name last_name: type: string description: The last name of the recipient. example: last_name phone: type: string pattern: \d{3}-\d{3}-\d{4}$ description: The phone number of the customer. example: 111-111-1111 email: type: string pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$ description: The email address of the customer. example: johnsmith@gmail.com required: - address1 - city - company - country - first_name - last_name - postal_code - state additionalProperties: false title: ShipToAddressFfe WmsOrderCreateLineItemffe: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 external_id: type: string description: The retail item number for this line item example: retail item number required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemffe WmsOrderCreateLineItem: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItem ShipToAddressFlexport: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: The phone number. example: phone_number email_address: type: string description: The email address. example: email_address required: - address1 - city - country - full_name additionalProperties: false title: ShipToAddressFlexport WmsOrderWriteLineItemflexport: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 product_id: type: string description: '' example: product_id customs_unit_value: $ref: '#/components/schemas/CustomsUnitValue' required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemflexport Duties: type: object properties: merchant_of_record_provider: type: string enum: - PASSPORT - MARKETS_PRO - GLOBALE description: The merchant of record provider for the order. example: PASSPORT merchant_of_record_order_id: type: string description: The merchant order ID associated with the merchantOfRecordProvider. example: order_id merchant_of_record_account_id: type: string description: >- The merchant GUID associated with GLOBALE. Required for GLOBALE and MARKETS_PRO. example: account_id merchant_of_record_carrier_code: type: string description: >- The carrier code used by the carrier. Used for GLOBALE, MARKETS_PRO, and PASSPORT. example: carrier_code merchant_of_record_sku_map: type: array description: A list of DSKU to MSKU mappings. Required for PASSPORT. example: - dsku: dsku msku: msku quantity: 1 items: $ref: '#/components/schemas/DutiesMerchantOfRecordSKUMap' incoterm: type: string enum: - DDP - DDU - DAP description: The Incoterm for the order. example: DDP required: - incoterm - merchant_of_record_order_id - merchant_of_record_provider - merchant_of_record_sku_map additionalProperties: false title: Duties FlowspaceCreateOrderShipToAddressFlowspace: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: 123-456-7890 email_address: type: string description: '' example: jane@example.com required: - address1 - city - country - full_name - postal_code additionalProperties: false title: FlowspaceCreateOrderShipToAddressFlowspace WmsOrderCreateLineItemflowspace: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemflowspace FlowspaceCreateOrderPallet: type: object properties: length: type: integer description: Pallet length in inches example: 0 width: type: integer description: Pallet width in inches example: 0 height: type: integer description: Pallet height in inches example: 0 weight: type: integer description: Pallet weight in pounds example: 0 number_of_pallets: type: integer description: Number of pallets with these dimensions example: 0 required: - height - length - number_of_pallets - weight - width additionalProperties: false title: FlowspaceCreateOrderPallet FlowspaceCreateOrderAccessorialServices: type: object properties: liftgate_delivery: type: boolean description: '' example: true liftgate_pickup: type: boolean description: '' example: true inside_delivery: type: boolean description: '' example: true inside_pickup: type: boolean description: '' example: true limited_access_delivery: type: boolean description: '' example: true limited_access_pickup: type: boolean description: '' example: true residential_delivery: type: boolean description: '' example: true delivery_appointment: type: boolean description: '' example: true crossdock: type: boolean description: '' example: true construction_site_delivery: type: boolean description: '' example: true destination_exhibition_delivery: type: boolean description: '' example: true additionalProperties: false title: FlowspaceCreateOrderAccessorialServices FlowspaceCreateOrderChannelObject: type: object properties: channel_name: type: string description: The name of the channel. example: channel_name required: - channel_name additionalProperties: false title: FlowspaceCreateOrderChannelObject FulfillorShipToAddressFulfillor: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: '+1234567890' email_address: type: string description: '' example: customer@example.com required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: FulfillorShipToAddressFulfillor WmsOrderWriteLineItemfulfillor: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku - unit_price additionalProperties: false title: WmsOrderWriteLineItemfulfillor FulfilmentcrowdChannelSchema: type: object properties: {} additionalProperties: false oneOf: - $ref: '#/components/schemas/FulfilmentcrowdChannelId' - $ref: '#/components/schemas/FulfilmentcrowdChannelName' discriminator: propertyName: type mapping: id: '#/components/schemas/FulfilmentcrowdChannelId' name: '#/components/schemas/FulfilmentcrowdChannelName' title: FulfilmentcrowdChannelSchema WmsOrderWriteLineItemfulfilmentcrowd: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemfulfilmentcrowd CreateOrderShipToAddressFulfilmentcrowd: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States additionalProperties: false title: CreateOrderShipToAddressFulfilmentcrowd ShipToAddressG-Global: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - postal_code - state additionalProperties: false title: ShipToAddressG-Global WmsOrderWriteLineItemg-global: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemg-global WmsOrderWriteLineItemgobolt: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemgobolt ShipToAddressGobolt: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: phone_number email_address: type: string description: '' example: email_address required: - address1 - city - country - email_address - full_name - phone_number - postal_code additionalProperties: false title: ShipToAddressGobolt ShipToAddressGreenmark: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St city: type: string description: '' example: San Francisco postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: '+31612345678' email_address: type: string description: '' example: user@example.com required: - address1 - city - country - full_name - postal_code additionalProperties: false title: ShipToAddressGreenmark WmsOrderCreateLineItemgreenmark: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemgreenmark I-FulfilmentChannelIdSchema: type: object properties: channel_id: type: string enum: - N/A - Connect an account to see options description: The ID of the channel. example: channel_id required: - channel_id additionalProperties: false title: I-FulfilmentChannelIdSchema ShipToAddressI-Fulfilment: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: The phone number for the shipping address. example: phone_number email_address: type: string description: The email for the shipping address. example: email_address required: - address1 - city - country - email_address - full_name - phone_number - postal_code additionalProperties: false title: ShipToAddressI-Fulfilment WmsOrderCreateLineItemi-fulfilment: type: object properties: sku: type: string description: '' example: sku unit_price: type: number description: '' example: 0 quantity: type: integer description: '' example: 0 required: - quantity - sku - unit_price additionalProperties: false title: WmsOrderCreateLineItemi-fulfilment BillToAddressInfoplus: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - company - country - postal_code - state additionalProperties: false title: BillToAddressInfoplus ShipToAddressInfoplus: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - company - country - postal_code - state additionalProperties: false title: ShipToAddressInfoplus WmsOrderWriteLineIteminfoplus: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineIteminfoplus ShipToAddressJas: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: The phone number of the customer. example: 111-111-1111 required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressJas WmsOrderWriteLineItemjas: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku - unit_price additionalProperties: false title: WmsOrderWriteLineItemjas WmsOrderWriteLineItemjaygroup: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemjaygroup ShipToAddressJaygroup: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States email_address: type: string description: '' example: email_address phone_number: type: string description: '' example: phone_number required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressJaygroup WmsOrderWriteLineItemjazz-central: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku - unit_price additionalProperties: false title: WmsOrderWriteLineItemjazz-central ShipToAddressJazz-Central: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - postal_code - state additionalProperties: false title: ShipToAddressJazz-Central ShipToAddressLeanafy: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: 123-456-7890 phone_country_code: type: string default: '+1' description: '' example: '+1' email_address: type: string description: '' example: johndoe@example.com required: - address1 - address2 - city - company - country - email_address - full_name - phone_number - postal_code - state additionalProperties: false title: ShipToAddressLeanafy WmsOrderWriteLineItemleanafy: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemleanafy WmsOrderWriteLineItemlinnworks: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemlinnworks OrderShipToAddressLogicpod: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: 123-456-7890 email_address: type: string description: '' example: johndoe@example.com required: - address1 - city - country - email_address - full_name - phone_number - postal_code - state additionalProperties: false title: OrderShipToAddressLogicpod WmsOrderWriteLineItemlogicpod: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemlogicpod WmsOrderWriteLineItemlogiwa: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemlogiwa ShipToAddressLogiwa: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressLogiwa WmsOrderWriteLineItemlogiwa-io: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 pack_type: type: string description: 'The pack type of the line item (default: Each)' example: Each unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemlogiwa-io ShipToAddressLogiwa-Io: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - postal_code - state additionalProperties: false title: ShipToAddressLogiwa-Io CreateOrderShipToAddressLuminous: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: phone_number required: - address1 - city - country - full_name additionalProperties: false title: CreateOrderShipToAddressLuminous WmsOrderCreateLineItemluminous: type: object properties: product_id: type: integer description: '' example: 0 sku: type: string description: '' example: sku quantity: type: number minimum: 0.001 description: '' example: 2 unit_price: type: number description: '' example: 9.99 required: - quantity - unit_price additionalProperties: false title: WmsOrderCreateLineItemluminous LuxroutageShipToLuxroutage: type: object properties: company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States first_name: type: string description: '' example: first_name last_name: type: string description: '' example: last_name required: - address1 - address2 - city - company - country - first_name - last_name - postal_code - state additionalProperties: false title: LuxroutageShipToLuxroutage LuxroutageBillToLuxroutage: type: object properties: company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States first_name: type: string description: '' example: first_name last_name: type: string description: '' example: last_name required: - address1 - address2 - city - company - country - first_name - last_name - postal_code - state additionalProperties: false title: LuxroutageBillToLuxroutage WmsOrderWriteLineItemluxroutage: type: object properties: sku: type: string description: '' example: sku name: type: string description: The name of the product. example: name quantity: type: integer description: '' example: 0 required: - name - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemluxroutage ShipToAddressMabang: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: phone_number email_address: type: string description: '' example: email_address required: - address1 - city - country - full_name - phone_number additionalProperties: false title: ShipToAddressMabang WmsOrderWriteLineItemmabang: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemmabang WmsOrderWriteLineItemmai: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemmai ShipToAddressMai: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: 555-555-5555 email_address: type: string description: '' example: customer@example.com required: - address1 - city - country - email_address - full_name - phone_number - postal_code - state additionalProperties: false title: ShipToAddressMai ShipToAddressMainfreight: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressMainfreight WmsOrderCreateLineItemmainfreight: type: object properties: sku: type: string description: Warehouse stock code example: SKU123 quantity: type: integer description: Quantity to ship example: 1 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemmainfreight WmsOrderWriteLineItemmasonhub: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 passthrough_fields: type: object description: >- Use this object to pass fields directly to the underlying API. You will have to read the API's documentation to know what fields are available, and cannot override fields that are managed by Trackstar. example: custom_field_1: value1 custom_field_2: 123 additionalProperties: {} required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemmasonhub ShipToAddressMasonhub: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressMasonhub WmsOrderWriteLineItemmintsoft: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemmintsoft ShipToAddressMintsoft: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States email: type: string description: '' example: email phone_number: type: string description: '' example: phone_number required: - country - full_name additionalProperties: false title: ShipToAddressMintsoft ShipToAddressModa-Express: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressModa-Express WmsOrderCreateLineItemmoda-express: type: object properties: sku: type: string description: Warehouse stock code. example: sku quantity: type: integer minimum: 1 description: Quantity to ship. example: 1 unit_price: type: number minimum: 0 description: >- The price of the product in the currency specified by invoice_currency_code. example: 10.99 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemmoda-express ShipToAddressNext3Pl: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: Phone Number example: phone_number email_address: type: string description: Email Address example: email_address required: - address1 - city - company - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressNext3Pl WmsOrderWriteLineItemnext3pl: type: object properties: sku: type: string description: SKU example: sku sku_description: type: string description: SKU Description example: sku_description quantity: type: integer description: Quantity example: 0 unit_price: type: number description: Unit Price example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemnext3pl ShipToAddressNextsmartship: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: phone_number email_address: type: string description: '' example: email_address required: - address1 - city - country - full_name - phone_number - postal_code additionalProperties: false title: ShipToAddressNextsmartship WmsOrderWriteLineItemnextsmartship: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemnextsmartship ShipToAddressNFI: type: object properties: full_name: type: string company: type: string address1: type: string address2: type: string city: type: string state: type: string postal_code: type: string country: type: string phone_number: type: string description: The phone number of the customer. example: 111-111-1111 additionalProperties: false title: ShipToAddressNFI WmsOrderWriteLineItemnfi: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 country_of_origin: type: string description: '' example: country_of_origin required: - country_of_origin - quantity - sku - unit_price additionalProperties: false title: WmsOrderWriteLineItemnfi WmsOrderWriteLineItemnimble: type: object properties: sku: type: string description: SKU example: sku quantity: type: integer description: Quantity example: 1 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemnimble ShipToAddressNimble: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code additionalProperties: false title: ShipToAddressNimble ShipToAddressNlrp: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressNlrp WmsOrderWriteLineItemnlrp: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 description: type: string description: '' example: description unit_price: type: number description: '' example: 0 required: - quantity - sku - unit_price additionalProperties: false title: WmsOrderWriteLineItemnlrp ShipToAddressNpfulfilment: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: The phone number of the contact at the ship to address. example: '0399999999' email_address: type: string description: The email address of the contact at the ship to address. example: customer@example.com required: - address1 - city - country - full_name - phone_number - postal_code - state additionalProperties: false title: ShipToAddressNpfulfilment WmsOrderWriteLineItemnpfulfilment: type: object properties: sku: type: string description: '' example: sku quantity: type: integer minimum: 1 description: '' example: 0 unit_price: type: number minimum: 0 description: >- npf requires a sales price per product. Treated as GST-inclusive; npf's per-line GST is sent as 0. example: 0 barcode: type: string description: npf's printed barcode for the product, sent on the order line. example: barcode required: - quantity - sku - unit_price additionalProperties: false title: WmsOrderWriteLineItemnpfulfilment WmsOrderWriteLineItemnri: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemnri ShipToAddressNri: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: '1234567890' required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressNri BillToAddressNri: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: '1234567890' required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: BillToAddressNri ShipToAddressOia-Global: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: The phone number of the contact at the ship to address. example: 555-555-5555 required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressOia-Global WmsOrderWriteLineItemoia-global: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemoia-global WmsOrderWriteLineItemongoing: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemongoing ShipToAddressOngoing: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States customer_number: type: string description: '' example: customer_number required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressOngoing OrderWiseShipToAddressOrderwise: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: '01904202255' email_address: type: string description: '' example: user@example.com required: - address1 - city - country - full_name - postal_code additionalProperties: false title: OrderWiseShipToAddressOrderwise WmsOrderWriteLineItemorderwise: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 1 unit_price: type: number description: >- The price of the product in the currency specified by `invoice_currency_code`. example: 10.99 additionalProperties: false title: WmsOrderWriteLineItemorderwise ShipToAddressPackem: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressPackem WmsOrderWriteLineItempackem: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItempackem WmsOrderWriteLineItempackiyo: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItempackiyo ShipToAddressPackiyo: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressPackiyo addressPattern: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: addressPattern WmsOrderCreateLineItempattern: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItempattern OrderShipToAddressPicqer: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: The phone number. example: phone_number email_address: type: string description: The email address. example: email_address required: - address1 - city - country - full_name - postal_code additionalProperties: false title: OrderShipToAddressPicqer WmsOrderWriteLineItempicqer: type: object properties: sku: type: string description: '' example: sku quantity: type: integer minimum: 1 description: '' example: 0 unit_price: type: number minimum: 0 description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItempicqer shippingAddressPortless: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: The phone number. example: phone_number email_address: type: string description: The email address. example: email_address required: - address1 - city - country - full_name additionalProperties: false title: shippingAddressPortless WmsOrderCreateLineItemportless: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 discount_amount: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemportless ShipToAddressQls: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code additionalProperties: false title: ShipToAddressQls WmsOrderWriteLineItemqls: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemqls QuietOrderAddress: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States address3: type: string description: '' example: address3 phone_number: type: string description: '' example: phone_number email_address: type: string description: '' example: email_address required: - address1 - city - country - postal_code - state additionalProperties: false title: QuietOrderAddress WmsOrderWriteLineItemquiet: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemquiet CreateOrderShipToAddressSalesupply: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States email_address: type: string description: '' example: johndoe@example.com phone_number: type: string description: '' example: 123-456-7890 required: - address1 - city - country - full_name - postal_code additionalProperties: false title: CreateOrderShipToAddressSalesupply CreateOrderBillToAddressSalesupply: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States email_address: type: string description: '' example: johndoe@example.com phone_number: type: string description: '' example: 123-456-7890 required: - address1 - city - country - full_name - postal_code additionalProperties: false title: CreateOrderBillToAddressSalesupply WmsOrderCreateLineItemsalesupply: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemsalesupply SaleSupplyCreateOrderChannelObject: type: object properties: channel_name: type: string description: The name of the channel. example: channel_name required: - channel_name additionalProperties: false title: SaleSupplyCreateOrderChannelObject ShipToAddressShipbob: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States email_address: type: string description: '' example: johndoe@example.com phone_number: type: string description: '' example: 123-456-7890 required: - address1 - city - country - full_name - postal_code additionalProperties: false title: ShipToAddressShipbob WmsOrderWriteLineItemshipbob: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemshipbob ShipbobCreateOrderChannelObject: type: object properties: channel_name: type: string description: >- The name of the sales channel. One of: amazon, bigcommerce, ebay, faire, macy, magento, shein, shopify, squarespace, targetplus, temu, tiktok, unleashed, walmart, woocommerce. Case-insensitive. example: tiktok required: - channel_name additionalProperties: false title: ShipbobCreateOrderChannelObject ShipedgeChannelSchema: type: object properties: {} additionalProperties: false oneOf: - $ref: '#/components/schemas/ShipedgeChannelId' - $ref: '#/components/schemas/ShipedgeChannelName' discriminator: propertyName: type mapping: id: '#/components/schemas/ShipedgeChannelId' name: '#/components/schemas/ShipedgeChannelName' title: ShipedgeChannelSchema ShipToAddressShipedge: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressShipedge WmsOrderWriteLineItemshipedge: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemshipedge WmsOrderWriteLineItemshipfusion: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemshipfusion ShipToAddressShipfusion: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string pattern: \d{3}-\d{3}-\d{4}$ description: The phone number of the customer. example: 111-111-1111 email_address: type: string pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$ description: The email address of the customer. example: johnsmith@gmail.com required: - address1 - city - country - email_address - full_name - phone_number - postal_code - state additionalProperties: false title: ShipToAddressShipfusion ShipfusionCreateOrderChannelObject: type: object properties: channel_id: type: string pattern: ^\d+$ description: Shipfusion's numeric sales channel id. example: '1234' channel_name: type: string description: The sales channel name. example: tether additionalProperties: false title: ShipfusionCreateOrderChannelObject CreateOrderShipToAddressShiphero: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: 123-456-7890 email_address: type: string description: The email address of the customer example: janedoe@example.com required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: CreateOrderShipToAddressShiphero CreateOrderBillToAddressShiphero: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: 123-456-7890 email_address: type: string description: The email address of the customer example: janedoe@example.com required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: CreateOrderBillToAddressShiphero WmsOrderCreateLineItemshiphero: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 warehouse_id: type: string description: Warehouse ID to ship item from example: warehouse_id quantity_pending_fulfillment: type: integer description: Number of units on this line item still pending fulfillment. example: 0 required: - quantity - sku - unit_price additionalProperties: false title: WmsOrderCreateLineItemshiphero WholesaleShippingDetails: type: object properties: scac: type: string description: '' example: scac bill_of_lading: type: string description: '' example: bill_of_lading trailer_number: type: string description: '' example: trailer_number pro_number: type: string description: '' example: pro_number freighter: type: string description: '' example: freighter cost: type: number description: '' example: 0 gs1_company_prefix: type: string description: '' example: gs1_company_prefix carrier: type: string description: Overrides order-level shipping_carrier when set (per shiphero docs). example: carrier shipping_method: type: string description: Overrides order-level shipping_method when set (per shiphero docs). example: shipping_method additionalProperties: false title: WholesaleShippingDetails WmsOrderWriteLineItemshipmonk: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 name: type: string description: '' example: name unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemshipmonk CreateOrderShipToAddressShipmonk: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States email_address: type: string description: The email address of the customer. example: johndoe@example.com required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: CreateOrderShipToAddressShipmonk ShipmonkOrderCustomData: type: object properties: name: type: string description: Key of the custom data entry example: name value: type: string description: Value of the custom data entry example: value required: - name - value additionalProperties: false title: ShipmonkOrderCustomData ShipToAddressShipping-And-Handling: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States address3: type: string description: '' example: address3 phone: type: string description: The shipping address phone number. example: phone email: type: string description: The shipping address email address. example: email required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressShipping-And-Handling WmsOrderWriteLineItemshipping-and-handling: type: object properties: sku: type: string description: '' example: sku name: type: string description: '' example: name quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemshipping-and-handling WmsOrderCreateLineItemshipping-tree: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemshipping-tree ShipToAddressShipping-Tree: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States email_address: type: string description: '' example: email_address required: - address1 - city - country - email_address - full_name - postal_code additionalProperties: false title: ShipToAddressShipping-Tree CreateBillingAddressShipstation: type: object properties: full_name: type: string description: '' example: John Doe company: type: - string - 'null' description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: - string - 'null' description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: CreateBillingAddressShipstation CreateOrderShipToAddressShipstation: type: object properties: full_name: type: string description: '' example: John Doe company: type: - string - 'null' description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: - string - 'null' description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: CreateOrderShipToAddressShipstation WmsOrderCreateLineItemshipstation: type: object properties: quantity: type: integer description: The quantity of the item example: 0 sku: type: string description: The SKU of the item example: sku unit_price: type: number description: The unit price of the item example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemshipstation ShipToAddressShipstream: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - postal_code - state additionalProperties: false title: ShipToAddressShipstream WmsOrderWriteLineItemshipstream: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemshipstream ShipToAddressShipwire: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - address2 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressShipwire WmsOrderWriteLineItemshipwire: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemshipwire ShipToAddressSkusavvy: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressSkusavvy WmsOrderWriteLineItemskusavvy: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemskusavvy ShipToAddressSkuvault: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - postal_code - state additionalProperties: false title: ShipToAddressSkuvault WmsOrderWriteLineItemskuvault: type: object properties: sku: type: string description: >- If you pass in an AlternateSKU, SkuVault will redirect it to the Primary SKU. example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemskuvault ShipToAddressSmart-Warehousing: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string pattern: ^[1-9]-\d{3}-\d{3}-\d{4}$ description: The phone number of the customer. example: 1-111-111-1111 required: - address1 - city - country - full_name - phone_number - postal_code - state additionalProperties: false title: ShipToAddressSmart-Warehousing BillToAddressSmart-Warehousing: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string pattern: ^[1-9]-\d{3}-\d{3}-\d{4}$ description: The phone number of the customer. example: 1-111-111-1111 required: - address1 - city - country - full_name - phone_number - postal_code - state additionalProperties: false title: BillToAddressSmart-Warehousing WmsOrderWriteLineItemsmart-warehousing: type: object properties: sku: type: string description: sku example: sku quantity: type: integer description: quantity example: 2 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemsmart-warehousing WmsOrderWriteLineItemsojo: type: object properties: product_id: type: string description: The ID of the product to be ordered. example: product_id quantity: type: integer description: '' example: 0 required: - product_id - quantity additionalProperties: false title: WmsOrderWriteLineItemsojo ShipToAddressSojo: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressSojo ShipToAddressStar: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: '+1234567890' email_address: type: string description: '' example: user@example.com required: - address1 - city - country - full_name - postal_code additionalProperties: false title: ShipToAddressStar WmsOrderWriteLineItemstar: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemstar StatesShipToAddressStates-Logistics: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: - string - 'null' description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: StatesShipToAddressStates-Logistics WmsOrderWriteLineItemstates-logistics: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 lot_id: type: string description: The lot ID for the line item. example: lot_id required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemstates-logistics ShipToAddressStord: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States email_address: type: string description: '' example: johndoe@example.com phone_number: type: string description: '' example: 123-456-7890 required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressStord BillToAddressStord: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code additionalProperties: false title: BillToAddressStord WmsOrderWriteLineItemstord: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 lot_id: type: string description: '' example: lot_id unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemstord CreateOrderShipToAddressTlogistics: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - company - country - full_name - postal_code additionalProperties: false title: CreateOrderShipToAddressTlogistics WmsOrderWriteLineItemtlogistics: type: object properties: sku: type: string description: '' example: sku quantity: type: integer minimum: 1 description: '' example: 1 unit_price: type: number minimum: 0 description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemtlogistics TpsShipToAddressTps: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: +44 20 0000 0000 email_address: type: string description: '' example: ada@example.com required: - address1 - city - country - full_name additionalProperties: false title: TpsShipToAddressTps WmsOrderCreateLineItemtps: type: object properties: sku: type: string description: '' example: SKU-001 quantity: type: integer minimum: 1 description: '' example: 2 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemtps ShipToAddressUnis: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: phone_number email_address: type: string description: '' example: email_address required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressUnis WmsOrderWriteLineItemunis: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemunis ShipToAddressUnleashed: type: object properties: full_name: type: string description: '' example: John Doe address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - country additionalProperties: false title: ShipToAddressUnleashed WmsOrderCreateLineItemunleashed: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateLineItemunleashed ShipToAddressVeeqo: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States additionalProperties: false title: ShipToAddressVeeqo WmsOrderWriteLineItemveeqo: type: object properties: product_id: type: string description: '' example: product_id unit_price: type: number description: '' example: 0 quantity: type: integer description: '' example: 0 required: - product_id - quantity - unit_price additionalProperties: false title: WmsOrderWriteLineItemveeqo ShipToAddressVeracore: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States address3: type: string description: '' example: address3 email_address: type: string description: '' example: email_address required: - address1 - city - country - postal_code - state additionalProperties: false title: ShipToAddressVeracore WmsOrderLineItemveracore: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderLineItemveracore OrderShipToAddressWarehance: type: object properties: company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States first_name: type: string description: '' example: first_name last_name: type: string description: '' example: last_name required: - address1 - city - country - first_name - last_name - postal_code - state additionalProperties: false title: OrderShipToAddressWarehance WmsOrderWriteLineItemwarehance: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemwarehance WarehanceChannelIdSchema: type: object properties: channel_id: type: string description: The ID of the channel. example: channel_id required: - channel_id additionalProperties: false title: WarehanceChannelIdSchema ShipToAddressWhiplash: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressWhiplash WmsOrderWriteLineItemwhiplash: type: object properties: sku: type: string description: SKU of the item. example: sku quantity: type: integer description: Total quantity of the item. example: 2 unit_price: type: number default: 0 description: Price of the item. example: 2 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemwhiplash CreateOrderShipToAddressXorosoft: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: phone_number email: type: string description: '' example: email required: - address1 - city - company - country - full_name - phone_number - postal_code additionalProperties: false title: CreateOrderShipToAddressXorosoft WmsOrderWriteLineItemxorosoft: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 item_quality: type: string description: Item quality code that maps to Xorosoft example: XYZ-FRST unit_price: type: number description: '' example: 0 required: - item_quality - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemxorosoft OrderShipToAddressZenfulfillment: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: +49 30 1234567 email_address: type: string description: '' example: customer@example.com required: - address1 - city - country - full_name - postal_code additionalProperties: false title: OrderShipToAddressZenfulfillment OrderBillToAddressZenfulfillment: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: +49 30 1234567 required: - address1 - city - country - full_name - postal_code additionalProperties: false title: OrderBillToAddressZenfulfillment WmsOrderWriteLineItemzenfulfillment: type: object properties: product_id: type: string description: >- Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details. example: product_id sku: type: string description: '' example: sku quantity: type: integer description: '' example: 1 unit_price: type: number description: >- The price of the product in the currency specified by invoice_currency_code. example: 10.99 discount_amount: type: number description: The amount discounted from the product for this order. example: 1.5 required: - product_id - quantity additionalProperties: false title: WmsOrderWriteLineItemzenfulfillment ShipToAddressZenventory: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States required: - address1 - city - country - postal_code - state additionalProperties: false title: ShipToAddressZenventory WmsOrderWriteLineItemzenventory: type: object properties: sku: type: string description: SKU of the item. example: sku quantity: type: integer description: Total quantity of the item. example: 2 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemzenventory ShipToAddressZoho: type: object properties: full_name: type: string description: '' example: John Doe company: type: string description: '' example: Company address1: type: string description: '' example: 123 Main St address2: type: string description: '' example: Apt 2 city: type: string description: '' example: San Francisco state: type: string description: '' example: CA postal_code: type: string description: '' example: '94105' country: type: string description: '' example: United States phone_number: type: string description: '' example: phone_number email_address: type: string description: '' example: email_address required: - address1 - city - country - full_name - postal_code - state additionalProperties: false title: ShipToAddressZoho WmsOrderWriteLineItemzoho: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 unit_price: type: number description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderWriteLineItemzoho OrderChannel: type: object properties: channel_id: type: string description: The ID of the channel. example: channel_id channel_name: type: - string - 'null' description: The name of the channel. example: channel_name required: - channel_id - channel_name additionalProperties: false title: OrderChannel ShipToAddress: type: object properties: full_name: type: - string - 'null' description: '' example: John Doe company: type: - string - 'null' description: '' example: Company address1: type: - string - 'null' description: '' example: 123 Main St address2: type: - string - 'null' description: '' example: Apt 2 address3: type: - string - 'null' description: '' example: Floor 3 city: type: - string - 'null' description: '' example: New York state: type: - string - 'null' description: '' example: NY postal_code: type: - string - 'null' description: '' example: '10001' country: type: - string - 'null' description: '' example: United States phone_number: type: - string - 'null' description: '' example: 123-456-7890 email_address: type: - string - 'null' description: '' example: johndoe@example.com required: - address1 - address2 - address3 - city - company - country - email_address - full_name - phone_number - postal_code - state additionalProperties: false title: ShipToAddress WmsOrderLineItem: type: object properties: product_id: type: string description: >- Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details. example: product_id sku: type: - string - 'null' description: '' example: sku quantity: type: integer description: '' example: 1 unit_price: type: - number - 'null' description: >- The price of the product in the currency specified by `invoice_currency_code`. example: 10.99 discount_amount: type: - number - 'null' description: The amount discounted from the product for this order. example: 1.5 required: - discount_amount - product_id - quantity - sku - unit_price additionalProperties: false title: WmsOrderLineItem OrderShipment: type: object properties: shipment_id: type: string description: The ID of the shipment. example: shipment_id warehouse_id: type: string description: >- The warehouse this order was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id raw_status: type: - string - 'null' description: >- The raw status (if available) of the shipment returned directly from the WMS. example: raw_status status: type: string enum: - open - shipped - cancelled - other description: The status of the shipment. example: shipped shipped_date: type: - string - 'null' format: date-time description: The date the shipment was sent. example: '2022-05-06T01:02:03Z' line_items: type: array description: List of the inventory items listed in the shipment. items: $ref: '#/components/schemas/ShipmentLineItem' ship_to_address: $ref: '#/components/schemas/ShipToAddress' ship_from_address: $ref: '#/components/schemas/ShipFromAddress' packages: type: array description: A list of the packages included in the shipment. items: $ref: '#/components/schemas/Package' required: - line_items - packages - raw_status - ship_from_address - ship_to_address - shipment_id - shipped_date - status - warehouse_id additionalProperties: false title: OrderShipment LineItemNotes: type: object properties: title: type: string description: Title of the note example: title body: type: string description: Body of the note example: body additionalProperties: false title: LineItemNotes ChannelId: type: object properties: channel_id: type: string description: The ID of the channel. example: channel_id required: - channel_id additionalProperties: false title: ChannelId ChannelName: type: object properties: channel_name: type: string description: The name of the channel. example: channel_name required: - channel_name additionalProperties: false title: ChannelName CustomsUnitValue: type: object properties: amount: type: number description: The value of one unit of the line item. Must be greater than zero. example: 0 invoice_currency_code: type: string description: >- The three-letter code for the currency associated with the line item. example: invoice_currency_code currency_code: type: string description: use invoice_currency_code instead example: currency_code required: - amount additionalProperties: false title: CustomsUnitValue DutiesMerchantOfRecordSKUMap: type: object properties: dsku: type: string description: The DSKU for the order. example: dsku msku: type: string description: The MSKU for the order. example: msku quantity: type: integer description: The quantity for the order. example: 0 required: - dsku - msku - quantity additionalProperties: false title: DutiesMerchantOfRecordSKUMap FulfilmentcrowdChannelId: type: object properties: channel_id: type: string description: The ID of the channel. example: channel_id required: - channel_id additionalProperties: false title: FulfilmentcrowdChannelId FulfilmentcrowdChannelName: type: object properties: channel_name: type: string description: The name of the channel. example: channel_name required: - channel_name additionalProperties: false title: FulfilmentcrowdChannelName ShipedgeChannelId: type: object properties: channel_id: type: string description: The ID of the channel. example: channel_id required: - channel_id additionalProperties: false title: ShipedgeChannelId ShipedgeChannelName: type: object properties: channel_name: type: string description: The name of the channel. example: channel_name required: - channel_name additionalProperties: false title: ShipedgeChannelName ShipmentLineItem: type: object properties: inventory_item_id: type: string description: >- The ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details. example: inventory_item_id sku: type: - string - 'null' description: '' example: sku quantity: type: integer description: '' example: 0 parent_product_id: type: - string - 'null' description: >- The ID of the parent product if the line item is part of a kit. Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details. example: parent_product_id required: - inventory_item_id - parent_product_id - quantity - sku additionalProperties: false title: ShipmentLineItem ShipFromAddress: type: object properties: address1: type: - string - 'null' description: '' example: 123 Main St address2: type: - string - 'null' description: '' example: Apt 2 address3: type: - string - 'null' description: '' example: Floor 3 city: type: - string - 'null' description: '' example: New York state: type: - string - 'null' description: '' example: NY postal_code: type: - string - 'null' description: '' example: '10001' country: type: - string - 'null' description: '' example: United States required: - address1 - address2 - address3 - city - country - postal_code - state additionalProperties: false title: ShipFromAddress Package: type: object properties: package_id: type: string description: The ID of the package. example: package_id package_name: type: - string - 'null' description: The name of the package. (e.g. 12x9x4) example: package_name tracking_number: type: - string - 'null' description: The tracking number for the package. example: tracking_number tracking_url: type: - string - 'null' description: The URL for the tracking number. example: tracking_url shipping_method_id: type: - string - 'null' description: The ID of the shipping method returned at the package level. example: shipping_method_id shipping_method_name: type: - string - 'null' description: The name of the shipping method returned at the package level. example: Standard Shipping carrier_id: type: - string - 'null' description: The ID of the carrier used to ship the package. example: carrier_id carrier_name: type: - string - 'null' description: The name of the carrier used to ship the package. example: carrier_name scac: type: - string - 'null' description: >- The Standard Carrier Alpha Code for the carrier used to ship the package. example: scac bill_of_lading: type: - string - 'null' description: The bill of lading number associated with the package's shipment. example: bill_of_lading sscc: type: - string - 'null' description: The Serial Shipping Container Code (GS1) identifying the package. example: sscc pro_number: type: - string - 'null' description: >- The PRO (freight tracking) number associated with the package's shipment. example: pro_number shipping_cost: type: - number - 'null' description: The cost incurred by the warehouse to ship the package. example: 2.5 measurements: $ref: '#/components/schemas/PackageMeasurements' line_items: type: array description: A list of the inventory items included in the package. items: $ref: '#/components/schemas/PackageLineItem' required: - bill_of_lading - carrier_id - carrier_name - line_items - measurements - package_id - package_name - pro_number - scac - shipping_cost - shipping_method_id - shipping_method_name - sscc - tracking_number - tracking_url additionalProperties: false title: Package PackageMeasurements: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the package. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the package. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: PackageMeasurements PackageLineItem: type: object properties: inventory_item_id: type: string description: >- The ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details. example: inventory_item_id sku: type: - string - 'null' description: '' example: sku quantity: type: integer description: '' example: 0 lot_id: type: - string - 'null' description: The ID of the lot the inventory item was picked from. example: lot_id expiration_date: type: - string - 'null' format: date-time description: The expiration date of the lot the inventory item was picked from. example: '2023-03-15T13:45:30Z' parent_product_id: type: - string - 'null' description: >- The ID of the parent product if the line item is part of a kit. Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details. example: parent_product_id required: - expiration_date - inventory_item_id - lot_id - parent_product_id - quantity - sku additionalProperties: false title: PackageLineItem ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.