Create an inbound shipment

Create an inbound shipment

POST /api/v1/inbound-shipments

cURL

curl --silent --show-error --fail-with-body --request POST \
  --url 'https://api.stateset.com/api/v1/inbound-shipments' \
  --header "Authorization: Bearer $STATESET_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "carrier": "UPS",
  "items": [
    {
      "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity_expected": "string",
      "sku": "SKU-TENT-2P-GRN"
    }
  ],
  "notes": "Two-person tent, green — replacement for damaged pole set.",
  "purchase_order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "supplier_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tracking_number": "1Z999AA10123456784",
  "warehouse_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

201

{
  "carrier": "UPS",
  "created_at": "2026-08-31T14:22:05Z",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity_expected": "string",
      "quantity_received": "string",
      "sku": "SKU-TENT-2P-GRN"
    }
  ],
  "number": "ORD-10042",
  "status": "pending",
  "supplier_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tracking_number": "1Z999AA10123456784"
}

Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.

Request body

CreateInboundShipmentRequest

carrier · string,null

items · CreateInboundShipmentItemRequest[] · required

Show CreateInboundShipmentItemRequest

product_id · string · required

quantity_expected · string · required

Expected quantity as a string.

sku · string · required

notes · string,null

purchase_order_id · string,null

supplier_id · string · required

tracking_number · string,null

warehouse_id · string,null

Response

InboundShipmentResponse

carrier · string,null

created_at · string · required

id · string · required

items · InboundShipmentItemResponse[] · required

Show InboundShipmentItemResponse

id · string · required

product_id · string · required

quantity_expected · string · required

quantity_received · string · required

sku · string · required

number · string · required

status · string · required

supplier_id · string · required

tracking_number · string,null

Status codes

Code	Meaning
201	—
400	—

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.

cURL

curl --silent --show-error --fail-with-body --request POST \
  --url 'https://api.stateset.com/api/v1/inbound-shipments' \
  --header "Authorization: Bearer $STATESET_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "carrier": "UPS",
  "items": [
    {
      "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity_expected": "string",
      "sku": "SKU-TENT-2P-GRN"
    }
  ],
  "notes": "Two-person tent, green — replacement for damaged pole set.",
  "purchase_order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "supplier_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tracking_number": "1Z999AA10123456784",
  "warehouse_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

201

{
  "carrier": "UPS",
  "created_at": "2026-08-31T14:22:05Z",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity_expected": "string",
      "quantity_received": "string",
      "sku": "SKU-TENT-2P-GRN"
    }
  ],
  "number": "ORD-10042",
  "status": "pending",
  "supplier_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tracking_number": "1Z999AA10123456784"
}