Skip to main content
PUT
/
wms
/
inbound-shipments
/
{inbound_shipment_id}
Update Inbound Shipment
curl --request PUT \
  --url https://production.trackstarhq.com/wms/inbound-shipments/{inbound_shipment_id} \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '{
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ],
  "supplier": "supplier",
  "supplier_object": {
    "supplier_id": "supplier_id"
  },
  "purchase_order_number": "po_number",
  "expected_arrival_date": "2022-10-10T01:02:03Z",
  "warehouse_id": "warehouse_id123",
  "tracking_number": "tracking_number",
  "line_items": [
    {
      "sku": "",
      "expected_quantity": 0
    }
  ]
}'
{
  "data": {
    "id": "inbound_id",
    "warehouse_customer_id": "warehouse_customer_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "purchase_order_number": "po_number",
    "status": "open",
    "raw_status": "raw_status",
    "supplier": "supplier",
    "supplier_object": {},
    "expected_arrival_date": "2022-10-10T01:02:03Z",
    "warehouse_id": "warehouse_id123",
    "line_items": [
      {
        "inventory_item_id": "item_id",
        "sku": "sku",
        "expected_quantity": 2,
        "received_quantity": 1,
        "unit_cost": 1,
        "external_id": "external_sku"
      }
    ],
    "receipts": [
      {
        "id": "receipt_id",
        "arrived_date": "2022-10-10T01:02:03Z",
        "line_items": [
          {
            "inventory_item_id": "item_id",
            "sku": "sku",
            "quantity": 1
          }
        ]
      }
    ],
    "ship_from_address": {
      "address1": "123 Main St",
      "address2": "Apt 2",
      "address3": "Floor 3",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "United States"
    },
    "tracking_numbers": [
      "tracking_number_1",
      "tracking_number_2"
    ],
    "notes": [
      "note_1",
      "note_2"
    ],
    "external_system_url": "https://example.com/inboundshipment/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ],
    "additional_fields": {
      "key": "value"
    }
  },
  "id": "id",
  "unused_fields": [
    ""
  ]
}

Headers

​
x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

​
x-trackstar-access-token
string
required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Example:

"<x-trackstar-access-token>"

Path Parameters

​
inbound_shipment_id
string
required

Body

application/json
  • Base Schema
  • BlueBox (IDrive Fulfillment)
  • Cin7 Core (Dear Systems)
  • Deposco
  • Extensiv (3PL Central)
  • Infoplus
  • Cart.com (Jazz Central)
  • Logiwa
  • Logiwa IO
  • MasonHub
  • Ongoing WMS
  • Packiyo
  • WMS Sandbox
  • ShipBob
  • ShipHero
  • ShipMonk
  • ShipStream
  • Shipwire
  • SKUSavvy
  • Linnworks Core (SKUVault)
  • Sojo
  • Unleashed
  • Whiplash (Ryder)
​
trackstar_tags
any[] | null

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" }]
​
supplier
string

Deprecated in favor of supplier_object

Example:

"supplier"

​
supplier_object
object

The supplier from which the shipment is being sent.

  • SupplierId
  • SupplierName
​
purchase_order_number
string

The number of the purchase order associated with the inbound shipment.

Example:

"po_number"

​
expected_arrival_date
string<date-time>

Date the shipment is expected to reach the warehouse.

Example:

"2022-10-10T01:02:03Z"

​
warehouse_id
string

ID of the warehouse that will be receiving the shipment. Can be passed into the Warehouse endpoint for more details.

Example:

"warehouse_id123"

​
tracking_number
string

Tracking number associated with the inbound shipment.

Example:

"tracking_number"

​
line_items
UpdateInboundShipmentLineItemSchema · object[]

List of line items included in the shipment.

Example:
[{ "sku": "", "expected_quantity": 0 }]

Response

Successful response

​
data
object
​
id
string

The ID of the object that has been created or modified

Example:

"id"

​
unused_fields
string[]

Unused fields

⌘I