Create Inbound Shipment

POST

wms

inbound-shipments

curl --request POST \
  --url https://production.trackstarhq.com/wms/inbound-shipments \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '{
  "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
    }
  ],
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ]
}'

{
  "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": [],
    "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"
      }
    ]
  },
  "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>"

Body

application/json

supplier

string

Deprecated in favor of supplier_object

Example:

"supplier"

supplier_object

object

The supplier from which the shipment is being sent.

purchase_order_number

string

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

Example:

"po_number"

expected_arrival_date

string

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

object[]

List of line items included in the shipment.

Example:

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

trackstar_tags

any[] | null

A list of custom tags associated with the inbound_shipments. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]

Example:

["tag1", "tag2", { "tag3": "value3" }]

Response

200

application/json

Successful response

data

object

data.id

string

The unique ID of the inbound shipment.

Example:

"inbound_id"

data.warehouse_customer_id

string | null

The ID of the merchant/tenant/customer that owns the inbound shipment. Can be passed into the Warehouse Customer endpoint for more details.

Example:

"warehouse_customer_id"

data.created_date

string

The date the inbound shipment was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string

The date the inbound shipment was last updated.

Example:

"2022-01-02T05:05:05Z"

data.purchase_order_number

string | null

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

Example:

"po_number"

data.status

enum<string>

The status of the inbound shipment. See the inbound shipment information for more details.

Available options:

open,

in-transit,

receiving,

received,

cancelled,

other

Example:

"open"

data.raw_status

string | null

The raw status (if available) returned directly from the WMS.

Example:

"raw_status"

data.supplier

string | null

Deprecated in favor of supplier_object

Example:

"supplier"

data.supplier_object

object | null

data.expected_arrival_date

string | null

Date the shipment is expected to reach the warehouse.

Example:

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

data.warehouse_id

string | null

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

Example:

"warehouse_id123"

data.line_items

object[]

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"
  }
]

data.receipts

object[]

List of receiving events associated with the inbound shipment.

data.receipts.id

string

required

The unique ID of the receiving event.

Example:

"receipt_id"

data.receipts.arrived_date

string

required

Date the items arrived.

Example:

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

data.receipts.line_items

object[]

required

List of line items included in the receiving event.

Example:

[
  {
    "inventory_item_id": "item_id",
    "quantity": 1
  }
]

Example:

[]

data.ship_from_address

object

data.tracking_numbers

string[]

List of tracking numbers associated with the inbound shipment.

Tracking number

Example:

["tracking_number_1", "tracking_number_2"]

data.notes

string[]

List of notes associated with the inbound shipment.

Note

Example:

["note_1", "note_2"]

data.external_system_url

string | null

URL link to the inbound shipment in the external system (WMS/Freight etc).

Example:

"https://example.com/inboundshipment/123"

data.trackstar_tags

any[] | null

A list of custom tags associated with the inbound shipment. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]

Example:

["tag1", "tag2", { "tag3": "value3" }]

string

The ID of the object that has been created or modified

Example:

"id"

unused_fields

string[]

Unused fields

Get Inbound Shipment Update Inbound Shipment

curl --request POST \
  --url https://production.trackstarhq.com/wms/inbound-shipments \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '{
  "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
    }
  ],
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ]
}'

{
  "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": [],
    "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"
      }
    ]
  },
  "id": "id",
  "unused_fields": [
    ""
  ]
}

API Documentation

Headers

Body

Response