---
title: "Inbound shipment created"
method: POST
path: "inbound-shipment.created"
---

# Inbound shipment created

`POST inbound-shipment.created` (webhook)

When an Inbound Shipment is created.

## Payload

- union
  - WmsInboundShipmentsCreatedFullWebhook
    - `connection_id` string, required
    - `data` WmsInboundShipmentApiItemSchema, required
      - `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
    - `event_type` 'inbound-shipment.created', required
    - `integration_name` string, required
    - `integration_type` string, required
  - WmsInboundShipmentsCreatedTruncatedWebhook
    - `connection_id` string, required
    - `data` WmsInboundShipmentsCreatedTruncatedData, required
      - `id` string: The record this event is about. Absent on connection webhooks, which carry dates rather than a row.
    - `event_type` 'inbound-shipment.created', required
    - `integration_name` string, required
    - `integration_type` string, required
    - `data_truncated` boolean, required: Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty.
    - `data_url` string, required: Called with your usual API key, it returns a download link for this event exactly as it would have been delivered.

## Acknowledgement `200`

Success

---

[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)