---
title: "Receive Inbound Shipment"
method: PUT
path: "/wms/inbound-shipments/{inbound_shipment_id}/receive"
tags: ["wms", "Inbound Shipments"]
---

# Receive Inbound Shipment

`PUT /wms/inbound-shipments/{inbound_shipment_id}/receive`

## Request

- Base URL: `https://production.trackstarhq.com`
- URL: `https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id}/receive`
- Auth: none required

Receive an inbound shipment for the WMS connection with the associated inbound shipment id.

## Path parameters

- `inbound_shipment_id` string, required

## Headers

- `x-trackstar-api-key` string, required
- `x-trackstar-access-token` string, required
- `Idempotency-Key` string

## Request body

- union
  - object
    - `trackstar_tags` unknown[], nullable: A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.
      - unknown
    - `line_items` WmsInboundShipmentCreateReceiptLineItemsandbox[], required: List of line items included in the shipment.
      - `sku` 'N/A - Connect an account to see options', required
      - `quantity` integer, required
  - object
  - object
    - `line_items` WmsInboundShipmentCreateReceiptLineItemluminous[], required: List of line items included in the shipment.
      - `sku` string, required
      - `quantity` integer, required: Total quantity of the item that has been received.
    - `warehouse_location_id` string, required: Location where the item is being received.
    - `warehouse_id` string, required: 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.
  - object
    - `line_items` WmsInboundShipmentWriteLineItemskuvaultReceipt[], required: List of line items included in the shipment.
      - `sku` string, required: If you pass in an AlternateSKU, SkuVault will redirect it to the Primary SKU.
      - `quantity` integer, required
    - `supplier_object` union, required
      - object
        - `supplier_id` string, required: The ID of the supplier.
      - object
        - `supplier_name` string, required: The name of the supplier. If supplier ID is provided, that will take precedence over this.
    - `warehouse_location_id` string: Location where the items are being received.
    - `warehouse_id` string: 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.

## Response `200`

Successful response

- WmsCreateReceiptInboundShipmentResponse
  - `data` ReceiveInboundShipmentResponseDataSchema
    - `id` string, required: The unique ID of the inbound shipment.
    - `warehouse_customer_id` string, nullable, required: 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.
    - `created_date` string, date-time, required: The date the inbound shipment was created.
    - `updated_date` string, date-time, required: The date the inbound shipment was last updated.
    - `purchase_order_number` string, nullable, required: The number of the purchase order associated with the inbound shipment.
    - `status` 'open' | 'in-transit' | 'receiving' | 'received' | 'cancelled' | 'other', required: The status of the inbound shipment. See the [inbound shipment information](info) for more details.
    - `raw_status` string, nullable, required: The raw status (if available) returned directly from the WMS.
    - `supplier_object` InboundShipmentSupplier, required
      - `supplier_id` string, required: The ID of the supplier.
      - `supplier_name` string, nullable, required: The name of the supplier.
    - `expected_arrival_date` string, date-time, nullable, required: Date the shipment is expected to reach the warehouse.
    - `warehouse_id` string, nullable, required: 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.
    - `line_items` WmsInboundShipmentLineItem[], required: List of line items included in the shipment.
      - `inventory_item_id` string, required: Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.
      - `sku` string, nullable, required
      - `expected_quantity` integer, required: Total quantity of the item expected to be received.
      - `received_quantity` integer, required: Total quantity of the item that has been received.
      - `unit_cost` number, nullable, required: The cost per product that is charged by the manufacturer.
      - `external_id` string, nullable, required: An identifier from an external system. e.g. vendor sku, external id, reference number, etc..
    - `receipts` InboundReceipt[], required: List of receiving events associated with the inbound shipment.
      - `id` string, required: The unique ID of the receiving event.
      - `arrived_date` string, date-time, required: Date the items arrived.
      - `line_items` InboundReceiptLineItem[], required: List of line items included in the receiving event.
        - `inventory_item_id` string, required: Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details.
        - `sku` string, nullable, required
        - `quantity` integer, required: Total quantity of the item that has been received.
        - `lot_id` string, nullable, required: The ID of the lot the items belong to.
        - `expiration_date` string, date-time, nullable, required: The expiration date of the lot the items belong to.
    - `ship_from_address` ShipFromAddress, required
      - `address1` string, nullable, required
      - `address2` string, nullable, required
      - `address3` string, nullable, required
      - `city` string, nullable, required
      - `state` string, nullable, required
      - `postal_code` string, nullable, required
      - `country` string, nullable, required
    - `tracking_numbers` string[], required: List of tracking numbers associated with the inbound shipment.
    - `notes` string[], required: List of notes associated with the inbound shipment.
    - `external_system_url` string, nullable, required: URL link to the inbound shipment in the external system (WMS/Freight etc).
    - `trackstar_tags` unknown[], nullable, required: A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair.
      - unknown
    - `additional_fields` object, required: Integration-specific fields
    - `trackstar_created_date` string, date-time, required
    - `trackstar_updated_date` string, date-time, required
  - `id` string, required: The ID of the object that has been created or modified
  - `unused_fields` string[], required: Unused fields

## Other responses

- `404`: Not found
- `422`: Validation error

## Changes

- **2026-11-03** `f9f948f2a7b3`: 1 breaking, 5 info
  - removed `#/components/schemas/CreateReceiptSchema--Base__Schema--` from the request body `oneOf` list
  - added the new optional `header` request parameter `Idempotency-Key`
  - added `#/components/schemas/CreateReceiptwmsInboundShipment--Luminous--` to the request body `oneOf` list
  - added `id, name` discriminator mapping keys to the `oneOf[subschema #4: Linnworks Core (SKUVault)]/supplier_object` request property
  - …2 more

[Operation history](https://skmtc.dev/trackstarhq/apis/trackstar-api/changes/wms/inbound-shipments/:inbound_shipment_id/receive/put.md)

---

[API](https://skmtc.dev/trackstarhq/apis/trackstar-api.md) - [All operations](https://skmtc.dev/trackstarhq/apis/trackstar-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trackstarhq/apis/trackstar-api/revisions/08647f790594?raw)