> ## 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. # Create Inbound Shipment > Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint. ## OpenAPI ````yaml post /wms/inbound-shipments 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/inbound-shipments: post: tags: - wms - Inbound Shipments summary: Create Inbound Shipment description: >- Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint. operationId: post_wms_create_inbound_shipment 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatewmsInboundShipmentInputSchema' responses: '200': content: application/json: schema: $ref: '#/components/schemas/wmsCreateInboundShipmentResponse' description: Successful response '422': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: Validation error components: schemas: CreatewmsInboundShipmentInputSchema: type: object properties: {} additionalProperties: false oneOf: - $ref: '#/components/schemas/CreateInboundShipmentSchema--Base__Schema--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Active__Ants--' - $ref: >- #/components/schemas/CreatewmsInboundShipment--A.__Duie__Pyle__-_ADP_--- - $ref: '#/components/schemas/CreatewmsInboundShipment--Amphora--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Amplifier--' - $ref: '#/components/schemas/CreatewmsInboundShipment--AMS--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Bergen--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Bigblue--' - $ref: >- #/components/schemas/CreatewmsInboundShipment--BlueBox__-_IDrive__Fulfillment_--- - $ref: '#/components/schemas/CreatewmsInboundShipment--Camelot--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Canary7--' - $ref: '#/components/schemas/CreatewmsInboundShipment--CartonCloud--' - $ref: '#/components/schemas/CreatewmsInboundShipment--DCL--' - $ref: >- #/components/schemas/CreatewmsInboundShipment--Cin7__Core__-_Dear__Systems_--- - $ref: '#/components/schemas/CreatewmsInboundShipment--Deposco--' - $ref: >- #/components/schemas/CreatewmsInboundShipment--Distribution__Management-- - $ref: >- #/components/schemas/CreatewmsInboundShipment--Dotcom__Distribution-- - $ref: '#/components/schemas/CreatewmsInboundShipment--eShipping--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Evolve--' - $ref: >- #/components/schemas/CreatewmsInboundShipment--Extensiv__-_3PL__Central_--- - $ref: '#/components/schemas/CreatewmsInboundShipment--Finale--' - $ref: >- #/components/schemas/CreatewmsInboundShipment--Flexport__-_Deliverr_--- - $ref: '#/components/schemas/CreatewmsInboundShipment--Flowspace--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Fulfillor--' - $ref: '#/components/schemas/CreatewmsInboundShipment--fulfilmentcrowd--' - $ref: '#/components/schemas/CreatewmsInboundShipment--G__Global--' - $ref: '#/components/schemas/CreatewmsInboundShipment--GoBolt--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Helm__WMS--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Hive--' - $ref: '#/components/schemas/CreatewmsInboundShipment--I-Fulfilment--' - $ref: '#/components/schemas/CreatewmsInboundShipment--iCreate--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Infoplus--' - $ref: '#/components/schemas/CreatewmsInboundShipment--JAS--' - $ref: >- #/components/schemas/CreatewmsInboundShipment--Cart.com__-_Jazz__Central_--- - $ref: '#/components/schemas/CreatewmsInboundShipment--Leanware--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Lineage--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Linnworks--' - $ref: >- #/components/schemas/CreatewmsInboundShipment--Quickbox__-_LogicPod_--- - $ref: '#/components/schemas/CreatewmsInboundShipment--Logiwa--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Logiwa__IO--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Luxroutage__LRI--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Mainfreight--' - $ref: '#/components/schemas/CreatewmsInboundShipment--MasonHub--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Mintsoft--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Monta--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Nimble--' - $ref: '#/components/schemas/CreatewmsInboundShipment--NLRP--' - $ref: '#/components/schemas/CreatewmsInboundShipment--NRI--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Ongoing__WMS--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Packiyo--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Peoplevox--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Picqer--' - $ref: '#/components/schemas/CreatewmsInboundShipment--PostNord--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Pulpo__WMS--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Quiet__Platforms--' - $ref: '#/components/schemas/CreatewmsInboundShipment--RJW--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Salesupply--' - $ref: '#/components/schemas/CreatewmsInboundShipment--WMS__Sandbox--' - $ref: '#/components/schemas/CreatewmsInboundShipment--ShipBob--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Shipedge--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Shipfusion--' - $ref: '#/components/schemas/CreatewmsInboundShipment--ShipHero--' - $ref: '#/components/schemas/CreatewmsInboundShipment--ShipMonk--' - $ref: '#/components/schemas/CreatewmsInboundShipment--ShippingTree--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Shippingbo--' - $ref: '#/components/schemas/CreatewmsInboundShipment--ShipStream--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Shipwire--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Skulabs--' - $ref: '#/components/schemas/CreatewmsInboundShipment--SKUSavvy--' - $ref: >- #/components/schemas/CreatewmsInboundShipment--Linnworks__Core__-_SKUVault_--- - $ref: '#/components/schemas/CreatewmsInboundShipment--Smart__Warehousing--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Sojo--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Star__WMS--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Stockhub--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Stord--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Unleashed--' - $ref: '#/components/schemas/CreatewmsInboundShipment--VeraCore--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Warehance--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Whiplash__-_Ryder_---' - $ref: '#/components/schemas/CreatewmsInboundShipment--XB__Fulfillment--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Zenventory--' - $ref: '#/components/schemas/CreatewmsInboundShipment--Zoho--' title: CreatewmsInboundShipmentInputSchema wmsCreateInboundShipmentResponse: type: object properties: data: $ref: '#/components/schemas/CreateInboundShipmentResponseDataSchema' 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: '' required: - id - unused_fields additionalProperties: false title: wmsCreateInboundShipmentResponse ValidationError: properties: error: type: string detail: type: object properties: : type: object properties: : type: array items: type: string required: - error type: object title: ValidationError CreateInboundShipmentSchema--Base__Schema--: 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: {} supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/CreateInboundShipmentLineItemSchema' required: - expected_arrival_date - line_items - purchase_order_number - supplier_object - tracking_number - warehouse_id additionalProperties: false title: Base Schema CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemactive-ants' required: - expected_arrival_date - line_items - purchase_order_number - warehouse_id additionalProperties: false title: Active Ants CreatewmsInboundShipment--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: {} purchase_order_number: type: string maxLength: 22 description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' ship_from_address: $ref: '#/components/schemas/ShipFromAddressAdp' notes: type: array description: List of notes associated with the inbound shipment. example: - note_1 - note_2 items: type: string description: Note example: note carrier: type: string maxLength: 30 description: Carrier name line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 uom: CT items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemadp' required: - line_items - purchase_order_number additionalProperties: false title: A. Duie Pyle (ADP) CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemamphora' required: - expected_arrival_date - line_items - warehouse_id additionalProperties: false title: Amphora CreatewmsInboundShipment--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: {} supplier_object: $ref: '#/components/schemas/SupplierIdSchema' description: The supplier from which the shipment is being sent. expected_arrival_date: type: string format: date description: Date the shipment is expected to reach the warehouse. example: '2022-10-10' account_user_id: type: string description: GUID creating_user_id: type: string description: GUID. May be the same as account_user_id. supplier_user_id: type: string description: GUID purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemamplifier' required: - account_user_id - creating_user_id - expected_arrival_date - line_items - supplier_object - supplier_user_id additionalProperties: false title: Amplifier CreatewmsInboundShipment--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: {} expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' container_number: type: string description: The container number of incoming inventory. example: container_number email: type: string description: The email address to receive any errors and updates. example: receiving@client.com line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemams' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. Can only contain uppercase letters or numbers. example: po_number required: - container_number - expected_arrival_date - line_items - purchase_order_number - warehouse_id additionalProperties: false title: AMS CreatewmsInboundShipment--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: {} expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItembergen' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number carrier_id: type: string description: The carrier of the inbound shipment. example: UPS ship_from_address: $ref: '#/components/schemas/ShipFromAddressBergen' required: - carrier_id - line_items - ship_from_address - warehouse_id additionalProperties: false title: Bergen CreatewmsInboundShipment--Bigblue--: 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: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/SupplierIdSchema' description: The supplier from which the shipment is being sent. expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' carrier_name: type: string description: Name of the carrier example: carrier expected_box_count: type: integer description: Number of boxes expected in the shipment example: 1 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItembigblue' required: - carrier_name - expected_arrival_date - expected_box_count - line_items - purchase_order_number - supplier_object - warehouse_id additionalProperties: false title: Bigblue CreatewmsInboundShipment--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: {} expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 ship_from_address: $ref: '#/components/schemas/ShipFromAddressBluebox' line_items: type: array description: List of line items included in the shipment. example: - sku: null gtin: gtin expected_quantity: 0 unit_cost: 1 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItembluebox' purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number carton_count: type: integer description: The number of cartons that are being shipped in the shipment example: 1 required: - line_items - purchase_order_number - warehouse_id additionalProperties: false title: BlueBox (IDrive Fulfillment) CreatewmsInboundShipment--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: {} purchase_order_number: type: string maxLength: 30 description: '' ship_from_address: $ref: '#/components/schemas/ShipFromAddressCamelot' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemcamelot' required: - line_items - purchase_order_number - ship_from_address additionalProperties: false title: Camelot CreatewmsInboundShipment--Canary7--: 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: {} expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemcanary' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. warehouse_customer_id: type: - string - 'null' default: N/A - Connect an account to see options enum: - N/A - Connect an account to see options description: >- The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id required: - expected_arrival_date - line_items - purchase_order_number - supplier_object - warehouse_id additionalProperties: false title: Canary7 CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the inbound shipment. 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: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 expected_arrival_date: type: string format: date-time description: Expected arrival date (YYYY-MM-DD) line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemcarton-cloud' required: - line_items - purchase_order_number - warehouse_customer_id additionalProperties: false title: CartonCloud CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string enum: - FR - LA - LN - YK - EX - EU - KY description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemdcl' required: - expected_arrival_date - line_items - purchase_order_number additionalProperties: false title: DCL CreatewmsInboundShipment--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: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. approach: type: string enum: - STOCK - INVOICE description: >- How you want to process the incoming order. Either authorize the stock first, or pay the invoice first. line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 unit_cost: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemdear-systems' required: - approach - line_items - supplier_object - warehouse_id additionalProperties: false title: Cin7 Core (Dear Systems) CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 received_quantity: 0 unit_cost: 0 inbound_lpn: null items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemdeposco' order_source: type: string description: Name of the external system from which the inbound originated. example: my_system custom_attribute_1: type: string description: Custom attribute 1 example: Custom attribute 1 required: - line_items - purchase_order_number additionalProperties: false title: Deposco CreatewmsInboundShipment--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: {} warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: >- #/components/schemas/WmsInboundShipmentWriteLineItemdistribution-management required: - line_items - purchase_order_number - warehouse_id additionalProperties: false title: Distribution Management CreatewmsInboundShipment--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: {} purchase_order_number: type: string maxLength: 20 description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: >- #/components/schemas/WmsInboundShipmentWriteLineItemdotcom-distribution required: - expected_arrival_date - line_items - purchase_order_number additionalProperties: false title: Dotcom Distribution CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string enum: - N/A - Connect an account to see options description: Facility code to receive into line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemeshipping' reference: type: string description: Reference number for the inbound shipment. required: - line_items - purchase_order_number - reference - warehouse_id additionalProperties: false title: eShipping CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemevolve' required: - expected_arrival_date - line_items - purchase_order_number additionalProperties: false title: Evolve CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the inbound shipment. 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: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 external_id: null warehouse_location_id: null lot_number: null items: $ref: >- #/components/schemas/WmsInboundShipmentCreateLineItemextensiv-3pl-central tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' notes: type: array description: List of notes associated with the inbound shipment. example: - note_1 - note_2 items: type: string description: Note example: note required: - line_items - purchase_order_number - warehouse_id additionalProperties: false title: Extensiv (3PL Central) CreatewmsInboundShipment--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: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemfinale' supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' required: - line_items - warehouse_id additionalProperties: false title: Finale CreatewmsInboundShipment--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_from_address: $ref: '#/components/schemas/ShipFromAddressFlexport' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemflexport' required: - line_items - ship_from_address additionalProperties: false title: Flexport (Deliverr) CreatewmsInboundShipment--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 inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 ship_from_address: $ref: '#/components/schemas/ShipFromAddressFlowspace' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemflowspace' tracking_numbers: type: array description: Tracking numbers for the inbound parcels example: - tracking_number_1 items: type: string description: Tracking number needs_transportation: type: string description: 'Whether Flowspace should arrange transportation (default: false)' product_arrival_type: type: string enum: - palletized - parcel_shipment - 20_ft_container - 40_ft_container - 40_ft_hc_container - 45_ft_hc_container description: >- How the product is arriving at the warehouse. Defaults to parcel_shipment carrier_id: type: string description: >- Carrier performing the delivery (required if needs_transportation is true) required: - line_items - purchase_order_number - ship_from_address - warehouse_id additionalProperties: false title: Flowspace CreatewmsInboundShipment--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: {} warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' carrier_id: type: string description: Shipping carrier code (e.g. OTHER, FEDEX, UPS). example: OTHER shipping_method_id: type: string description: Shipping method code (e.g. ShMthFTL, ShMthGround). example: ShMthFTL ship_from_address: $ref: '#/components/schemas/FulfillorInboundShipFromAddressFulfillor' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemfulfillor' tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number required: - carrier_id - line_items - purchase_order_number - ship_from_address - shipping_method_id - warehouse_id additionalProperties: false title: Fulfillor CreatewmsInboundShipment--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: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 currency_code: type: string default: USD enum: - USD description: >- The currency used for this inbound shipment. If not provided explicitly, defaults to USD. example: USD line_items: type: array description: List of line items included in the shipment. example: - sku: null quantity: 0 items: $ref: >- #/components/schemas/WmsInboundShipmentWriteLineItemfulfilmentcrowd supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' required: - line_items - warehouse_id additionalProperties: false title: fulfilmentcrowd CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemg-global' transportation_document: type: string description: transportation_document ship_date: type: string format: date-time description: ship_date example: '2022-10-10T01:02:03Z' container: type: string description: container custom_fields: type: array description: List of the custom fields example: - name: CustomField value: CustomValue items: $ref: '#/components/schemas/CustomField' required: - expected_arrival_date - line_items - purchase_order_number additionalProperties: false title: G Global CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 expected_arrival_date: type: string format: date description: Date the shipment is expected to reach the warehouse. example: '2022-10-10' shipment_type: type: string default: parcel enum: - parcel - pallet - floor_loaded - container - drop_off description: The shipment type for your inbound, defaults to parcel box_packing_option: type: string default: multiple_sku_per_box enum: - one_sku_per_box - multiple_sku_per_box description: Box packing option, defaults to multiple_sku_per_box box_expected_quantity: type: integer default: 1 description: Expected number of boxes, defaults to 1 example: 0 pallet_packing_option: type: string default: multiple_sku_per_pallet enum: - one_sku_per_pallet - multiple_sku_per_pallet description: >- Pallet packing option, defaults to multiple_sku_per_pallet if shipment_type is pallet container_size: type: string enum: - 20_ft - 40_ft description: Container size, required for container shipments pallet_expected_quantity: type: integer default: 1 description: Expected number of pallets, defaults to 1 if shipment_type is pallet example: 0 reference_number: type: string description: '' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemgobolt' required: - expected_arrival_date - line_items - warehouse_id additionalProperties: false title: GoBolt CreatewmsInboundShipment--Helm__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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemhelm-wms' required: - expected_arrival_date - line_items - purchase_order_number - supplier_object additionalProperties: false title: Helm WMS CreatewmsInboundShipment--Hive--: 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: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. delivery_option: type: string enum: - courier - dropoff - hive_freight - postal description: Delivery method for the shipment example: courier line_items: type: array description: List of line items included in the shipment. example: - inventory_item_id: null expected_quantity: 0 unit_cost: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemhive' required: - delivery_option - expected_arrival_date - line_items - warehouse_id additionalProperties: false title: Hive CreatewmsInboundShipment--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: {} warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 channel_id: type: string enum: - N/A - Connect an account to see options description: The product channel for the purchase order. supplier_object: $ref: '#/components/schemas/SupplierIdSchema' description: The supplier from which the shipment is being sent. currency_code: type: string default: USD pattern: ^[A-Z]{3}$ description: Currency code. shipping_method: type: string enum: - air - sea - road description: Method of shipment travel. expected_delivery_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' expected_pallets: type: integer minimum: 0 description: Expected number of pallets. example: 0 expected_cartons: type: integer minimum: 0 description: Expected number of cartons. example: 0 shipping_company: type: string description: Shipping company name. tracking_number: type: string description: Tracking number. line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemi-fulfilment' required: - channel_id - expected_cartons - expected_delivery_date - expected_pallets - line_items - shipping_method - supplier_object - warehouse_id additionalProperties: false title: I-Fulfilment CreatewmsInboundShipment--iCreate--: 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: {} supplier_object: $ref: '#/components/schemas/SupplierIdSchema' description: The supplier from which the shipment is being sent. purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date description: Date the shipment is expected to reach the warehouse. example: '2022-10-10' ordered_by: type: string description: The name of the person who ordered the shipment. line_items: type: array description: List of line items included in the shipment. example: - inventory_item_id: inventory_item_id expected_quantity: 0 unit_cost: 0 tracking_number: tracking_number carrier: null items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemicreate' required: - expected_arrival_date - line_items - ordered_by - purchase_order_number - supplier_object additionalProperties: false title: iCreate CreatewmsInboundShipment--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 inbound shipment. 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 purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. type: type: string enum: - Kit - Normal - Transfer description: Type of inbound shipment line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 unit_cost: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineIteminfoplus' required: - line_items - purchase_order_number - supplier_object - type - warehouse_id additionalProperties: false title: Infoplus CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/SupplierIdSchema' description: The supplier from which the shipment is being sent. expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number ship_from_address: $ref: '#/components/schemas/ShipFromAddressJas' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 unit_cost: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemjas' required: - line_items - purchase_order_number - supplier_object additionalProperties: false title: JAS CreatewmsInboundShipment--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: {} expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 reference_number: type: string description: '' line_items: type: array description: List of line items included in the shipment. example: - sku: sku expected_quantity: 1 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemjazz-central' required: - expected_arrival_date - line_items - warehouse_id additionalProperties: false title: Cart.com (Jazz Central) CreatewmsInboundShipment--Leanware--: 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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemleanware' required: - line_items - purchase_order_number additionalProperties: false title: Leanware CreatewmsInboundShipment--Lineage--: 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: {} purchase_order_number: type: string maxLength: 16 description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string description: ID of the Lineage warehouse receiving the shipment. ship_from_address: $ref: '#/components/schemas/ShipFromAddressLineage' ship_to_address: $ref: '#/components/schemas/ShipToAddressLineage' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemlineage' required: - line_items - purchase_order_number - ship_from_address - ship_to_address - warehouse_id additionalProperties: false title: Lineage CreatewmsInboundShipment--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: {} warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItem' required: - expected_arrival_date - line_items - purchase_order_number additionalProperties: false title: Linnworks CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 ship_to_address: $ref: '#/components/schemas/InboundShipToAddressLogicpod' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemlogicpod' created_by: type: string description: Who created this inbound required: - created_by - expected_arrival_date - line_items - purchase_order_number - ship_to_address - supplier_object - warehouse_id additionalProperties: false title: Quickbox (LogicPod) CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 location_code: null license_plate_code: null items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemlogiwa' notes: type: array description: List of notes associated with the inbound shipment. example: - note_1 - note_2 items: type: string description: Note example: note inbound_type: type: string default: Purchase Order description: The type of inbound shipment. Defaults to 'Purchase Order'. required: - line_items - purchase_order_number - supplier_object - warehouse_id additionalProperties: false title: Logiwa CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 pack_type: Each items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemlogiwa-io' required: - line_items - purchase_order_number - supplier_object - warehouse_id additionalProperties: false title: Logiwa IO CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/SupplierIdSchema' description: The supplier from which the shipment is being sent. line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemluxroutage' required: - line_items - purchase_order_number - supplier_object additionalProperties: false title: Luxroutage LRI CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' notes: type: array description: List of notes associated with the inbound shipment. example: - note_1 - note_2 items: type: string description: Note example: note ship_from_address: $ref: '#/components/schemas/ShipFromAddressMainfreight' line_items: type: array description: List of line items included in the shipment. example: - sku: SKU123 expected_quantity: 1 expiration_date: '2022-10-10T01:02:03Z' items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemmainfreight' required: - expected_arrival_date - line_items - purchase_order_number - warehouse_id additionalProperties: false title: Mainfreight CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 box_ids: null items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemmasonhub' tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number comments: type: string description: Free-form comments about the inbound shipment. example: These shipments are often not labeled. box_ids: type: array description: List of box IDs associated with the inbound shipment. example: - box_1 - box_2 items: type: string description: Box ID example: box_1 customer_identifier: type: string description: >- Customer-supplied identifier for the inbound shipment. If omitted, one is generated. example: shipment32432 required: - expected_arrival_date - line_items - purchase_order_number - supplier_object - warehouse_id additionalProperties: false title: MasonHub CreatewmsInboundShipment--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: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' quantity: type: integer description: '' example: 0 package_type: type: string enum: - Carton - TwentyFtContainer - Pallet - FortyFtContainer - FortyFtContainerHC - FortyFiveFtContainer - FortyFiveFtContainerHC description: The type of package that the shipment is in line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemmintsoft' required: - expected_arrival_date - line_items - package_type - purchase_order_number - warehouse_id additionalProperties: false title: Mintsoft CreatewmsInboundShipment--Monta--: 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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemmonta' required: - expected_arrival_date - line_items - purchase_order_number additionalProperties: false title: Monta CreatewmsInboundShipment--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 line items included in the shipment. example: - sku: null vendor_sku: TA30144X01MC expected_quantity: 1 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemnimble' warehouse_id: type: string enum: - N/A - Connect an account to see options description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 supplier_first_name: type: string description: Supplier first name example: John supplier_last_name: type: string description: Supplier last name example: Doe supplier_city: type: string description: Supplier city example: San Francisco supplier_state: type: string description: Supplier state example: CA supplier_country: type: string description: Supplier country example: US supplier_phone: type: string description: Supplier phone example: '1234567890' supplier_street_line1: type: string description: Supplier street line 1 example: 123 Main St supplier_street_line2: type: string description: Supplier street line 2 example: Apt 1 tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' reference_id: type: string description: Reference ID example: '123456789' required: - line_items - warehouse_id additionalProperties: false title: Nimble CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. terms: type: string description: '' example: Prepaid line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 unit_cost: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemnlrp' expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 required: - expected_arrival_date - line_items - purchase_order_number - supplier_object - terms additionalProperties: false title: NLRP CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemnri' country_code: type: string description: Country code of origin for the shipment. client_reference_number_2: type: string description: Optional internal ID for the inbound shipment. required: - country_code - expected_arrival_date - line_items - purchase_order_number - warehouse_id additionalProperties: false title: NRI CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemongoing' required: - line_items - purchase_order_number - supplier_object - warehouse_id additionalProperties: false title: Ongoing WMS CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItempackiyo' expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' notes: type: array description: List of notes associated with the inbound shipment. example: - note_1 - note_2 items: type: string description: Note example: note tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number required: - line_items - purchase_order_number - warehouse_id additionalProperties: false title: Packiyo CreatewmsInboundShipment--Peoplevox--: 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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 unit_cost: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItempeoplevox' expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. required: - line_items - purchase_order_number - supplier_object - warehouse_id additionalProperties: false title: Peoplevox CreatewmsInboundShipment--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: {} expected_arrival_date: type: string format: date description: Date the shipment is expected to reach the warehouse. example: '2022-10-10' supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 unit_cost: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItempicqer' required: - expected_arrival_date - line_items - supplier_object - warehouse_id additionalProperties: false title: Picqer CreatewmsInboundShipment--PostNord--: 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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date description: Date the shipment is expected to reach the warehouse. example: '2022-10-10' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 external_id: null items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItempostnord' supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. required: - line_items - purchase_order_number additionalProperties: false title: PostNord CreatewmsInboundShipment--Pulpo__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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItempulpo' supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id required: - expected_arrival_date - line_items - purchase_order_number - warehouse_customer_id - warehouse_id additionalProperties: false title: Pulpo WMS CreatewmsInboundShipment--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: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/SupplierIdSchema' description: The supplier from which the shipment is being sent. line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 unit_cost: 0 description: null items: $ref: '#/components/schemas/WmsInboundShipmentLineItemquiet' note: type: string description: '' required: - line_items - note - purchase_order_number - tracking_number - warehouse_id additionalProperties: false title: Quiet Platforms CreatewmsInboundShipment--RJW--: 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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string description: ID of the RJW warehouse receiving the shipment. carrier_scac: type: string description: Carrier SCAC code; defaults to RJWI when omitted. ship_from_address: $ref: '#/components/schemas/ShipFromAddressRjw' ship_to_address: $ref: '#/components/schemas/ShipToAddressRjw' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 lot_number: null items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemrjw' required: - line_items - purchase_order_number - ship_from_address - ship_to_address - warehouse_id additionalProperties: false title: RJW CreatewmsInboundShipment--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: {} warehouse_id: type: string default: N/A - Connect an account to see options enum: - N/A - Connect an account to see options description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemsalesupply' ship_to_address: $ref: '#/components/schemas/CreateInboundShipmentShipToAddressSalesupply' bill_to_address: $ref: '#/components/schemas/CreateInboundShipmentBillToAddressSalesupply' invoice_currency_code: type: string default: USD enum: - USD description: Currency code for the purchase order notes: type: array description: List of notes associated with the inbound shipment. example: - note_1 - note_2 items: type: string description: Note example: note required: - bill_to_address - expected_arrival_date - line_items - notes - purchase_order_number - ship_to_address additionalProperties: false title: Salesupply CreatewmsInboundShipment--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: {} supplier_object: $ref: '#/components/schemas/SupplierIdSchema' description: The supplier from which the shipment is being sent. purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_90531 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string enum: - N/A - Connect an account to see options description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 1 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemsandbox' required: - expected_arrival_date - line_items - purchase_order_number - supplier_object - tracking_number - warehouse_id additionalProperties: false title: WMS Sandbox CreatewmsInboundShipment--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: {} warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details.. ShipBob may reroute this to a regional Hub before going to the specified warehouse. example: warehouse_id123 package_type: type: string enum: - Package - Pallet - FloorLoadedContainer description: Type of package box_packaging_type: type: string enum: - EverythingInOneBox - OneSkuPerBox - MultipleSkusPerBox description: Type of packaging for the boxes expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 boxes: type: array description: List of boxes in the shipment items: $ref: '#/components/schemas/Box' required: - box_packaging_type - boxes - expected_arrival_date - package_type - warehouse_id additionalProperties: false title: ShipBob CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string description: Date the shipment is expected to reach the warehouse. example: '2022-10-10' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemshipedge' required: - expected_arrival_date - line_items - purchase_order_number additionalProperties: false title: Shipedge CreatewmsInboundShipment--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: {} warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemshipfusion' expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number required: - line_items - warehouse_id additionalProperties: false title: Shipfusion CreatewmsInboundShipment--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 inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. Use this when you are a 3PL acting on behalf of one of your customers. example: warehouse_customer_id warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' shipping_price: type: number description: Price of the shipment. example: 0 tax: type: number description: Tax on the purchase order. example: 0 line_items: type: array description: List of line items included in the shipment. example: - sku: sku expected_quantity: 1 expected_weight: 1 expected_weight_unit: lb unit_cost: 1 external_id: external_id items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemshiphero' tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number packing_note: type: string description: Packing note required: - expected_arrival_date - line_items - purchase_order_number - shipping_price - warehouse_id additionalProperties: false title: ShipHero CreatewmsInboundShipment--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: {} warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' handling_unit_type: type: string enum: - small_boxes - single_sku_pallet - mixed_sku_pallet - container_20_palletized - container_20_non_palletized - container_40_palletized - container_40_non_palletized - container_53_palletized - container_53_non_palletized - unknown description: Unit handling type for inbound shipment. handling_unit_quantity: type: integer description: Number of handling units. example: 0 bol_number: type: string description: Bill of lading number for the inbound shipment. notes: type: array description: List of notes associated with the inbound shipment. example: - note_1 - note_2 items: type: string description: Note example: note tracking_numbers: type: array description: Tracking numbers for the inbound shipment. example: - tracking_number_1 - tracking_number_2 items: type: string description: Tracking number example: tracking_number line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 lot_id: null lot_expiration_date: null items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemshipmonk' required: - expected_arrival_date - handling_unit_quantity - handling_unit_type - supplier_object - warehouse_id additionalProperties: false title: ShipMonk CreatewmsInboundShipment--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 line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemshipping-tree' purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number required: - expected_arrival_date - line_items - supplier_object - tracking_number additionalProperties: false title: ShippingTree CreatewmsInboundShipment--Shippingbo--: 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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 supplier_object: $ref: '#/components/schemas/SupplierIdSchema' description: The supplier from which the shipment is being sent. expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemshippingbo' required: - line_items - purchase_order_number - supplier_object additionalProperties: false title: Shippingbo CreatewmsInboundShipment--ShipStream--: 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: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. status: type: string enum: - open - in-transit - receiving - received - cancelled - other description: >- The status of the inbound shipment. See the [inbound shipment information](info) for more details. example: open expected_arrival_date: type: string format: date description: Date the shipment is expected to reach the warehouse. example: '2022-10-10' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemshipstream' tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number required: - expected_arrival_date - line_items - status - supplier_object - warehouse_id additionalProperties: false title: ShipStream CreatewmsInboundShipment--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: {} expected_arrival_date: type: string format: date description: Date the shipment is expected to reach the warehouse. example: '2024-01-01' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemshipwire' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 arrangement_type: type: string default: none enum: - none - overseas description: >- This tells ShipWire what further actions to take once the ASN is created. ship_from_address: $ref: '#/components/schemas/ShipFromAddressShipwire' tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number required: - line_items - warehouse_id additionalProperties: false title: Shipwire CreatewmsInboundShipment--Skulabs--: 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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 store_id: type: string description: '' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 unit_cost: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemskulabs' supplier_object: $ref: '#/components/schemas/SupplierIdSchema' description: The supplier from which the shipment is being sent. total_tax: type: number description: Total tax on the purchase order. example: 0 total_shipping: type: number description: Total shipping cost on the purchase order. example: 0 total_discount: type: number description: Total discount on the purchase order. example: 0 required: - line_items - store_id - supplier_object - warehouse_id additionalProperties: false title: Skulabs CreatewmsInboundShipment--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: {} supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 expected_arrival_date: type: string format: date description: Date the shipment is expected to reach the warehouse. example: '2022-10-10' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 unit_cost: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemskusavvy' required: - line_items - supplier_object - warehouse_id additionalProperties: false title: SKUSavvy CreatewmsInboundShipment--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: {} supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 unit_cost: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemskuvault' tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number required: - line_items - supplier_object additionalProperties: false title: Linnworks Core (SKUVault) CreatewmsInboundShipment--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: Customer defined reference associated with the receipt. example: reference_id purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' return_type: type: string enum: - Railcar - LTL - TL - Small Parcel - 40 Ft. Container - 20 Ft. Container description: The type of receipt being created. example: Railcar line_items: type: array description: List of line items included in the shipment. example: - sku: sku expected_quantity: 2 items: $ref: >- #/components/schemas/WmsInboundShipmentWriteLineItemsmart-warehousing tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number required: - expected_arrival_date - line_items - reference_id - return_type additionalProperties: false title: Smart Warehousing CreatewmsInboundShipment--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: {} warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 expected_arrival_date: type: string format: date description: Date the shipment is expected to reach the warehouse. example: '2022-10-10' purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 line_items: type: array description: List of line items included in the shipment. example: - inventory_item_id: null quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemsojo' required: - expected_arrival_date - line_items - purchase_order_number - warehouse_id additionalProperties: false title: Sojo CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date description: Date the shipment is expected to reach the warehouse. example: '2022-10-10' warehouse_id: type: string enum: - N/A - Connect an account to see options description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number container_type: type: string enum: - express - box - pallet - container_20gp - container_20hq - container_40gp - container_40hq - container_45gp - container_53hq - other - platform_pickup - third_party_freight - self_shipped description: Arrival mode of the shipment at the warehouse. example: express boxes: type: array description: >- Box types in the shipment. Each entry is a stack of identically-packed cartons. items: $ref: '#/components/schemas/StarBox' required: - boxes - container_type - purchase_order_number - warehouse_id additionalProperties: false title: Star WMS CreatewmsInboundShipment--Stockhub--: 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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemstockhub' required: - expected_arrival_date - line_items - purchase_order_number additionalProperties: false title: Stockhub CreatewmsInboundShipment--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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string enum: - N/A - Connect an account to see options description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemstord' required: - expected_arrival_date - line_items - purchase_order_number - supplier_object - warehouse_id additionalProperties: false title: Stord CreatewmsInboundShipment--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: {} supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 unit_cost: 0 items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemunleashed' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 purchase_order_number: type: string maxLength: 15 description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date description: Date the shipment is expected to reach the warehouse. example: '2022-10-10' required: - line_items - supplier_object additionalProperties: false title: Unleashed CreatewmsInboundShipment--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: {} supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemveracore' notes: type: string description: Notes associated with the inbound shipment. example: notes required: - expected_arrival_date - line_items - purchase_order_number - supplier_object - warehouse_id additionalProperties: false title: VeraCore CreatewmsInboundShipment--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: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number line_items: type: array description: List of line items included in the shipment. example: - expected_quantity: 0 inventory_item_id: '12345' items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemwarehance' required: - line_items - warehouse_id additionalProperties: false title: Warehance CreatewmsInboundShipment--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: {} supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 2 lot_number: null expiration_date: null items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItemwhiplash' tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number required: - expected_arrival_date - line_items - supplier_object - warehouse_id additionalProperties: false title: Whiplash (Ryder) CreatewmsInboundShipment--XB__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: {} purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 expected_arrival_date: type: string format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' contact_country: type: string description: Country of origin of the shipment example: US origin_type: type: string enum: - Supplier - Manufacturer - Warehouse - Store - Customer description: '' line_items: type: array description: List of line items included in the shipment. example: - sku: test_sku_1 expected_quantity: 1 duty_class: DOMESTIC manufacturer_id: US7891011121314 country_of_origin: US items: $ref: '#/components/schemas/WmsInboundShipmentCreateLineItem' required: - contact_country - expected_arrival_date - line_items - origin_type - purchase_order_number additionalProperties: false title: XB Fulfillment CreatewmsInboundShipment--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: {} supplier_object: $ref: '#/components/schemas/WriteSupplierSchema' description: The supplier from which the shipment is being sent. warehouse_id: type: string description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 unit_cost: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemzenventory' ship_method: type: string description: Shipping method for the inbound shipment. example: ship_method required: - line_items - supplier_object additionalProperties: false title: Zenventory CreatewmsInboundShipment--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: {} supplier_object: $ref: '#/components/schemas/SupplierIdSchema' description: The supplier from which the shipment is being sent. purchase_order_number: type: string description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 warehouse_id: type: string description: '' line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemzoho' required: - line_items - supplier_object additionalProperties: false title: Zoho CreateInboundShipmentResponseDataSchema: type: object properties: id: type: string description: The unique ID of the inbound shipment. example: inbound_id warehouse_customer_id: type: - string - 'null' description: >- The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. example: warehouse_customer_id created_date: type: string format: date-time description: The date the inbound shipment was created. example: '2022-01-01T00:00:00Z' updated_date: type: string format: date-time description: The date the inbound shipment was last updated. example: '2022-01-02T05:05:05Z' purchase_order_number: type: - string - 'null' description: >- The number of the purchase order associated with the inbound shipment. example: po_number_123 status: type: string enum: - open - in-transit - receiving - received - cancelled - other description: >- The status of the inbound shipment. See the [inbound shipment 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 supplier_object: anyOf: - $ref: '#/components/schemas/InboundShipmentSupplier' - type: 'null' expected_arrival_date: type: - string - 'null' format: date-time description: Date the shipment is expected to reach the warehouse. example: '2022-10-10T01:02:03Z' warehouse_id: type: - string - 'null' description: >- ID of the warehouse that will be receiving the shipment. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id123 line_items: type: array description: List of line items included in the shipment. example: - inventory_item_id: item_id sku: sku expected_quantity: 2 received_quantity: 1 unit_cost: 1 external_id: external_sku items: $ref: '#/components/schemas/WmsInboundShipmentLineItem' receipts: type: array description: List of receiving events associated with the inbound shipment. example: [] items: $ref: '#/components/schemas/InboundReceipt' ship_from_address: $ref: '#/components/schemas/ShipFromAddress' tracking_numbers: type: array description: List of tracking numbers associated with the inbound shipment. example: - tracking_number_1 - tracking_number_2 items: type: string description: Tracking number example: tracking_number notes: type: array description: List of notes associated with the inbound shipment. example: - note_1 - note_2 items: type: string description: Note example: note external_system_url: type: - string - 'null' description: >- URL link to the inbound shipment in the external system (WMS/Freight etc). example: https://example.com/inboundshipment/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: '' trackstar_updated_date: type: string format: date-time description: '' required: - additional_fields - created_date - expected_arrival_date - external_system_url - id - line_items - notes - purchase_order_number - raw_status - receipts - ship_from_address - status - supplier_object - tracking_numbers - trackstar_created_date - trackstar_tags - trackstar_updated_date - updated_date - warehouse_customer_id - warehouse_id additionalProperties: false title: CreateInboundShipmentResponseDataSchema WriteSupplierSchema: type: object properties: {} additionalProperties: false oneOf: - $ref: '#/components/schemas/SupplierId' - $ref: '#/components/schemas/WriteSupplierName' discriminator: propertyName: type mapping: id: $ref: '#/components/schemas/SupplierId' name: $ref: '#/components/schemas/WriteSupplierName' title: WriteSupplierSchema CreateInboundShipmentLineItemSchema: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: CreateInboundShipmentLineItemSchema WmsInboundShipmentWriteLineItemactive-ants: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemactive-ants ShipFromAddressAdp: 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: ShipFromAddressAdp WmsInboundShipmentCreateLineItemadp: type: object properties: sku: type: string maxLength: 48 description: SKU or product code expected_quantity: type: integer description: Expected quantity example: 0 uom: type: string maxLength: 3 description: Unit of measure example: CT required: - expected_quantity - sku - uom additionalProperties: false title: WmsInboundShipmentCreateLineItemadp WmsInboundShipmentCreateLineItemamphora: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemamphora SupplierIdSchema: type: object properties: supplier_id: type: string description: The ID of the supplier. example: supplier_id required: - supplier_id additionalProperties: false title: SupplierIdSchema WmsInboundShipmentCreateLineItemamplifier: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemamplifier WmsInboundShipmentWriteLineItemams: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemams WmsInboundShipmentWriteLineItembergen: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItembergen ShipFromAddressBergen: 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 required: - address1 - city - company - country - state additionalProperties: false title: ShipFromAddressBergen WmsInboundShipmentCreateLineItembigblue: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItembigblue ShipFromAddressBluebox: 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: ShipFromAddressBluebox WmsInboundShipmentCreateLineItembluebox: type: object properties: sku: type: string description: '' gtin: type: string description: The Global Trade Item Number of the product. i.e. UPC, EAN, or ISBN. example: gtin expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: The cost per product that is charged by the manufacturer example: 1 required: - expected_quantity - gtin - sku additionalProperties: false title: WmsInboundShipmentCreateLineItembluebox ShipFromAddressCamelot: 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 - city - country - postal_code - state additionalProperties: false title: ShipFromAddressCamelot WmsInboundShipmentWriteLineItemcamelot: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemcamelot WmsInboundShipmentWriteLineItemcanary: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemcanary WmsInboundShipmentCreateLineItemcarton-cloud: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemcarton-cloud WmsInboundShipmentWriteLineItemdcl: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemdcl WmsInboundShipmentCreateLineItemdear-systems: type: object properties: sku: type: string description: '' expected_quantity: type: integer minimum: 1 description: '' example: 0 unit_cost: type: number description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemdear-systems WmsInboundShipmentCreateLineItemdeposco: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 received_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 inbound_lpn: type: string description: '' required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemdeposco WmsInboundShipmentWriteLineItemdistribution-management: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemdistribution-management WmsInboundShipmentWriteLineItemdotcom-distribution: type: object properties: sku: type: string maxLength: 20 description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemdotcom-distribution WmsInboundShipmentCreateLineItemeshipping: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemeshipping WmsInboundShipmentCreateLineItemevolve: type: object properties: sku: type: string description: '' expected_quantity: type: integer minimum: 1 description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemevolve WmsInboundShipmentCreateLineItemextensiv-3pl-central: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 external_id: type: - string - 'null' description: '' warehouse_location_id: type: - string - 'null' description: '' lot_number: type: - string - 'null' description: '' required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemextensiv-3pl-central WmsInboundShipmentCreateLineItemfinale: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemfinale ShipFromAddressFlexport: 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: ShipFromAddressFlexport WmsInboundShipmentWriteLineItemflexport: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemflexport ShipFromAddressFlowspace: 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: ShipFromAddressFlowspace WmsInboundShipmentCreateLineItemflowspace: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemflowspace FulfillorInboundShipFromAddressFulfillor: 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: '+14045551212' required: - address1 - city - country - phone_number - postal_code - state additionalProperties: false title: FulfillorInboundShipFromAddressFulfillor WmsInboundShipmentWriteLineItemfulfillor: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemfulfillor WmsInboundShipmentWriteLineItemfulfilmentcrowd: type: object properties: sku: type: string description: '' quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemfulfilmentcrowd WmsInboundShipmentWriteLineItemg-global: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemg-global CustomField: type: object properties: name: type: string description: Name of the custom field value: type: string description: Value of the custom field required: - name - value additionalProperties: false title: CustomField WmsInboundShipmentCreateLineItemgobolt: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemgobolt WmsInboundShipmentCreateLineItemhelm-wms: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemhelm-wms WmsInboundShipmentCreateLineItemhive: type: object properties: inventory_item_id: type: string description: '' expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 required: - expected_quantity - inventory_item_id additionalProperties: false title: WmsInboundShipmentCreateLineItemhive WmsInboundShipmentCreateLineItemi-fulfilment: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemi-fulfilment WmsInboundShipmentWriteLineItemicreate: type: object properties: inventory_item_id: type: string description: The unique ID of the inventory item. example: inventory_item_id expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 tracking_number: type: string description: Tracking number associated with the inbound shipment. example: tracking_number carrier: type: string description: The carrier of the shipment. required: - carrier - expected_quantity - inventory_item_id - tracking_number - unit_cost additionalProperties: false title: WmsInboundShipmentWriteLineItemicreate WmsInboundShipmentCreateLineIteminfoplus: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineIteminfoplus ShipFromAddressJas: 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: ShipFromAddressJas WmsInboundShipmentWriteLineItemjas: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemjas WmsInboundShipmentCreateLineItemjazz-central: type: object properties: sku: type: string description: sku example: sku expected_quantity: type: integer description: The expected quantity of the product. example: 1 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemjazz-central WmsInboundShipmentWriteLineItemleanware: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemleanware ShipFromAddressLineage: 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: ShipFromAddressLineage ShipToAddressLineage: 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: ShipToAddressLineage WmsInboundShipmentCreateLineItemlineage: type: object properties: sku: type: string description: Vendor item code (SKU). expected_quantity: type: integer description: Expected quantity. example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemlineage WmsInboundShipmentWriteLineItem: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItem InboundShipToAddressLogicpod: 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: '' email_address: type: string description: '' example: johndoe@example.com required: - address1 - city - country - email_address - full_name - postal_code - state additionalProperties: false title: InboundShipToAddressLogicpod WmsInboundShipmentCreateLineItemlogicpod: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemlogicpod WmsInboundShipmentWriteLineItemlogiwa: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 location_code: type: string description: The location code for the item license_plate_code: type: string description: The license plate code for the item required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemlogiwa WmsInboundShipmentCreateLineItemlogiwa-io: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 pack_type: type: string description: 'The pack type of the line item (default: Each)' example: Each required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemlogiwa-io WmsInboundShipmentWriteLineItemluxroutage: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemluxroutage ShipFromAddressMainfreight: 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: ShipFromAddressMainfreight WmsInboundShipmentCreateLineItemmainfreight: type: object properties: sku: type: string description: Warehouse stock code example: SKU123 expected_quantity: type: integer description: Expected quantity example: 1 expiration_date: type: string format: date-time description: Expiration date for the line in ISO 8601 format. example: '2022-10-10T01:02:03Z' required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemmainfreight WmsInboundShipmentCreateLineItemmasonhub: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 box_ids: type: array description: List of box IDs associated with the line item. Not required. items: type: string description: Box ID example: box_1 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemmasonhub WmsInboundShipmentWriteLineItemmintsoft: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemmintsoft WmsInboundShipmentWriteLineItemmonta: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemmonta WmsInboundShipmentWriteLineItemnimble: type: object properties: sku: type: string description: Required vendor_sku: type: string description: Vendor SKU example: TA30144X01MC expected_quantity: type: integer description: Expected quantity example: 1 required: - expected_quantity additionalProperties: false title: WmsInboundShipmentWriteLineItemnimble WmsInboundShipmentWriteLineItemnlrp: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 required: - expected_quantity - sku - unit_cost additionalProperties: false title: WmsInboundShipmentWriteLineItemnlrp WmsInboundShipmentWriteLineItemnri: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemnri WmsInboundShipmentCreateLineItemongoing: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemongoing WmsInboundShipmentCreateLineItempackiyo: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItempackiyo WmsInboundShipmentWriteLineItempeoplevox: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItempeoplevox WmsInboundShipmentWriteLineItempicqer: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 required: - expected_quantity - sku - unit_cost additionalProperties: false title: WmsInboundShipmentWriteLineItempicqer WmsInboundShipmentWriteLineItempostnord: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 external_id: type: string description: '' required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItempostnord WmsInboundShipmentWriteLineItempulpo: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItempulpo WmsInboundShipmentLineItemquiet: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 description: type: string description: '' required: - description - expected_quantity - sku - unit_cost additionalProperties: false title: WmsInboundShipmentLineItemquiet ShipFromAddressRjw: 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: ShipFromAddressRjw ShipToAddressRjw: 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: ShipToAddressRjw WmsInboundShipmentCreateLineItemrjw: type: object properties: sku: type: string description: Vendor item code (SKU). expected_quantity: type: integer description: Expected quantity. example: 0 lot_number: type: string description: Lot number; emitted as the W04*LT qualifier. Defaults to NONE. required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemrjw WmsInboundShipmentWriteLineItemsalesupply: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemsalesupply CreateInboundShipmentShipToAddressSalesupply: 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: - city - country - postal_code additionalProperties: false title: CreateInboundShipmentShipToAddressSalesupply CreateInboundShipmentBillToAddressSalesupply: 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: - city - country - postal_code additionalProperties: false title: CreateInboundShipmentBillToAddressSalesupply WmsInboundShipmentWriteLineItemsandbox: type: object properties: sku: type: string enum: - N/A - Connect an account to see options description: '' expected_quantity: type: integer description: '' example: 1 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemsandbox Box: type: object properties: tracking_number: type: string description: Tracking number of the box line_items: type: array description: List of line items included in the shipment. example: - inventory_item_id: null sku: null expected_quantity: 0 lot_id: null lot_expiration_date: null items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemshipbob' required: - line_items - tracking_number additionalProperties: false title: Box WmsInboundShipmentWriteLineItemshipedge: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemshipedge WmsInboundShipmentWriteLineItemshipfusion: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemshipfusion WmsInboundShipmentCreateLineItemshiphero: type: object properties: sku: type: string description: '' example: sku expected_quantity: type: integer description: The number of units expected to be received example: 1 expected_weight: type: number description: Expected weight example: 1 expected_weight_unit: type: string enum: - kg - oz - lb description: The unit of measurement for the weight of the line item. example: lb unit_cost: type: number description: Cost of the product (USD). example: 1 external_id: type: - string - 'null' default: null description: The external ID of the product. Only applied if supplier is provided example: external_id required: - expected_quantity - expected_weight - sku - unit_cost additionalProperties: false title: WmsInboundShipmentCreateLineItemshiphero WmsInboundShipmentCreateLineItemshipmonk: type: object properties: sku: type: string description: '' expected_quantity: type: - integer - 'null' description: '' example: 0 lot_id: type: string description: Lot number of the items in the box. lot_expiration_date: type: string format: date-time description: Lot expiration date for the items in the box. required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemshipmonk WmsInboundShipmentCreateLineItemshipping-tree: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemshipping-tree WmsInboundShipmentWriteLineItemshippingbo: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemshippingbo WmsInboundShipmentCreateLineItemshipstream: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemshipstream WmsInboundShipmentWriteLineItemshipwire: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemshipwire ShipFromAddressShipwire: 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 - address2 - city - country - postal_code - state additionalProperties: false title: ShipFromAddressShipwire WmsInboundShipmentWriteLineItemskulabs: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 required: - expected_quantity - sku - unit_cost additionalProperties: false title: WmsInboundShipmentWriteLineItemskulabs WmsInboundShipmentWriteLineItemskusavvy: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemskusavvy WmsInboundShipmentCreateLineItemskuvault: type: object properties: sku: type: string description: >- If you pass in an AlternateSKU, SkuVault will redirect it to the Primary SKU. expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemskuvault WmsInboundShipmentWriteLineItemsmart-warehousing: type: object properties: sku: type: string description: sku example: sku expected_quantity: type: integer description: Total quantity of the item expected to be received example: 2 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemsmart-warehousing WmsInboundShipmentCreateLineItemsojo: type: object properties: inventory_item_id: type: string description: '' quantity: type: integer description: '' example: 0 required: - inventory_item_id - quantity additionalProperties: false title: WmsInboundShipmentCreateLineItemsojo StarBox: type: object properties: carton_count: type: integer default: 1 description: Number of identical cartons of this box type. example: 1 length: type: number description: Carton length in cm. example: 30 width: type: number description: Carton width in cm. example: 20 height: type: number description: Carton height in cm. example: 15 weight: type: number description: Carton weight in kg. example: 5 line_items: type: array description: List of line items included in the shipment. example: - sku: null expected_quantity: 0 items: $ref: '#/components/schemas/WmsInboundShipmentWriteLineItemstar' required: - height - length - line_items - weight - width additionalProperties: false title: StarBox WmsInboundShipmentCreateLineItemstockhub: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemstockhub WmsInboundShipmentWriteLineItemstord: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemstord WmsInboundShipmentCreateLineItemunleashed: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemunleashed WmsInboundShipmentWriteLineItemveracore: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemveracore WmsInboundShipmentCreateLineItemwarehance: type: object properties: expected_quantity: type: integer description: '' example: 0 inventory_item_id: type: string description: The product ID in Warehance. example: '12345' required: - expected_quantity - inventory_item_id additionalProperties: false title: WmsInboundShipmentCreateLineItemwarehance WmsInboundShipmentCreateLineItemwhiplash: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: Total quantity of the item expected to be received. example: 2 lot_number: type: string description: Lot number for the items. expiration_date: type: string description: Expiration date for the lot in ISO format. required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentCreateLineItemwhiplash WmsInboundShipmentCreateLineItem: type: object properties: sku: type: string description: Sku example: test_sku_1 expected_quantity: type: integer description: Expected quantity example: 1 duty_class: type: string description: Determinate if the inventory already paid duties expected values example: DOMESTIC manufacturer_id: type: string minLength: 15 maxLength: 15 description: >- ID for the vendor where the inventory was manufacured. This is a 15 Char starting with Country ISO 2 example: US7891011121314 country_of_origin: type: string description: Country of origin of the inventory example: US required: - duty_class - expected_quantity - manufacturer_id - sku additionalProperties: false title: WmsInboundShipmentCreateLineItem WmsInboundShipmentWriteLineItemzenventory: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 unit_cost: type: number description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemzenventory WmsInboundShipmentWriteLineItemzoho: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemzoho InboundShipmentSupplier: type: object properties: supplier_id: type: string description: The ID of the supplier. example: supplier_id supplier_name: type: - string - 'null' description: The name of the supplier. example: supplier_name required: - supplier_id - supplier_name additionalProperties: false title: InboundShipmentSupplier WmsInboundShipmentLineItem: type: object properties: inventory_item_id: type: string description: >- Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details. example: item_id sku: type: - string - 'null' description: '' example: sku expected_quantity: type: integer description: Total quantity of the item expected to be received. example: 2 received_quantity: type: integer description: Total quantity of the item that has been received. example: 1 unit_cost: type: - number - 'null' description: The cost per product that is charged by the manufacturer. example: 1 external_id: type: - string - 'null' description: >- An identifier from an external system. e.g. vendor sku, external id, reference number, etc.. example: external_sku required: - expected_quantity - external_id - inventory_item_id - received_quantity - sku - unit_cost additionalProperties: false title: WmsInboundShipmentLineItem InboundReceipt: type: object properties: id: type: string description: The unique ID of the receiving event. example: receipt_id arrived_date: type: string format: date-time description: Date the items arrived. example: '2022-10-10T01:02:03Z' line_items: type: array description: List of line items included in the receiving event. example: - inventory_item_id: item_id sku: sku quantity: 1 items: $ref: '#/components/schemas/InboundReceiptLineItem' required: - arrived_date - id - line_items additionalProperties: false title: InboundReceipt 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 SupplierId: type: object properties: supplier_id: type: string description: The ID of the supplier. example: supplier_id required: - supplier_id additionalProperties: false title: SupplierId WriteSupplierName: type: object properties: supplier_name: type: string description: >- The name of the supplier. If supplier ID is provided, that will take precedence over this. example: supplier_name required: - supplier_name additionalProperties: false title: WriteSupplierName WmsInboundShipmentWriteLineItemshipbob: type: object properties: inventory_item_id: type: string description: '' sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 lot_id: type: string description: Lot number of the items in the box lot_expiration_date: type: string format: date-time description: Lot expiration date for the items in the box required: - expected_quantity additionalProperties: false title: WmsInboundShipmentWriteLineItemshipbob WmsInboundShipmentWriteLineItemstar: type: object properties: sku: type: string description: '' expected_quantity: type: integer description: '' example: 0 required: - expected_quantity - sku additionalProperties: false title: WmsInboundShipmentWriteLineItemstar InboundReceiptLineItem: type: object properties: inventory_item_id: type: string description: >- Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details. example: item_id sku: type: - string - 'null' description: '' example: sku quantity: type: integer description: Total quantity of the item that has been received. example: 1 required: - inventory_item_id - quantity - sku additionalProperties: false title: InboundReceiptLineItem ````