Inbound shipment updated

Body

application/json

connection_id

string

required

Example:

"connection_id"

data

InboundShipmentSchema · object

required

Show child attributes

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<date-time>

The date the inbound shipment was created.

Example:

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

data.updated_date

string<date-time>

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

InboundShipmentSupplier · object

Show child attributes

data.supplier_object.supplier_id

string

required

The ID of the supplier.

Example:

"supplier_id"

data.supplier_object.supplier_name

string | null

required

The name of the supplier.

Example:

"supplier_name"

data.expected_arrival_date

string<date-time> | 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

WmsInboundShipmentLineItem · object[]

List of line items included in the shipment.

Show child attributes

data.line_items.inventory_item_id

string

required

Can be passed into the Inventory endpoint for more details.

Example:

"item_id"

data.line_items.sku

string | null

required

Example:

"sku"

data.line_items.expected_quantity

integer

required

Total quantity of the item expected to be received.

Example:

2

data.line_items.received_quantity

integer

required

Total quantity of the item that has been received.

Example:

1

data.line_items.unit_cost

number | null

required

The cost per product that is charged by the manufacturer.

Example:

1

data.line_items.external_id

string | null

required

An identifier from an external system. e.g. vendor sku, external id, reference number, etc..

Example:

"external_sku"

Example:

[
  {
    "inventory_item_id": "item_id",
    "sku": "sku",
    "expected_quantity": 2,
    "received_quantity": 1,
    "unit_cost": 1,
    "external_id": "external_sku"
  }
]

data.receipts

InboundReceipt · object[]

List of receiving events associated with the inbound shipment.

Show child attributes

data.receipts.id

string

required

The unique ID of the receiving event.

Example:

"receipt_id"

data.receipts.arrived_date

string<date-time>

required

Date the items arrived.

Example:

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

data.receipts.line_items

InboundReceiptLineItem · object[]

required

List of line items included in the receiving event.

Show child attributes

data.receipts.line_items.inventory_item_id

string

required

Can be passed into the Inventory endpoint for more details.

Example:

"item_id"

data.receipts.line_items.sku

string | null

required

Example:

"sku"

data.receipts.line_items.quantity

integer

required

Total quantity of the item that has been received.

Example:

1

Example:

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

Example:

[
  {
    "id": "receipt_id",
    "arrived_date": "2022-10-10T01:02:03Z",
    "line_items": [
      {
        "inventory_item_id": "item_id",
        "sku": "sku",
        "quantity": 1
      }
    ]
  }
]

data.ship_from_address

ShipFromAddress · object

Show child attributes

data.ship_from_address.address1

string | null

required

Example:

"123 Main St"

data.ship_from_address.address2

string | null

required

Example:

"Apt 2"

data.ship_from_address.address3

string | null

required

Example:

"Floor 3"

data.ship_from_address.city

string | null

required

Example:

"New York"

data.ship_from_address.state

string | null

required

Example:

"NY"

data.ship_from_address.postal_code

string | null

required

Example:

"10001"

data.ship_from_address.country

string | null

required

Example:

"United States"

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 resource. A tag can be either a string or a dictionary with one key-value pair.

Example:

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

data.additional_fields

object

Integration-specific fields

Show child attributes

data.additional_fields.{key}

any

Example:

{ "key": "value" }

event_type

string

required

Example:

"inbound-shipment.updated"

integration_name

string

required

Example:

"integration_name"

integration_type

string

required

Example:

"wms"

previous_attributes

InboundShipmentSchema · object

required

Show child attributes

previous_attributes.id

string

The unique ID of the inbound shipment.

Example:

"inbound_id"

previous_attributes.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"

previous_attributes.created_date

string<date-time>

The date the inbound shipment was created.

Example:

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

previous_attributes.updated_date

string<date-time>

The date the inbound shipment was last updated.

Example:

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

previous_attributes.purchase_order_number

string | null

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

Example:

"po_number"

previous_attributes.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"

previous_attributes.raw_status

string | null

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

Example:

"raw_status"

previous_attributes.supplier

string | null

Deprecated in favor of supplier_object

Example:

"supplier"

previous_attributes.supplier_object

InboundShipmentSupplier · object

Show child attributes

previous_attributes.supplier_object.supplier_id

string

required

The ID of the supplier.

Example:

"supplier_id"

previous_attributes.supplier_object.supplier_name

string | null

required

The name of the supplier.

Example:

"supplier_name"

previous_attributes.expected_arrival_date

string<date-time> | null

Date the shipment is expected to reach the warehouse.

Example:

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

previous_attributes.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"

previous_attributes.line_items

WmsInboundShipmentLineItem · object[]

List of line items included in the shipment.

Show child attributes

previous_attributes.line_items.inventory_item_id

string

required

Can be passed into the Inventory endpoint for more details.

Example:

"item_id"

previous_attributes.line_items.sku

string | null

required

Example:

"sku"

previous_attributes.line_items.expected_quantity

integer

required

Total quantity of the item expected to be received.

Example:

2

previous_attributes.line_items.received_quantity

integer

required

Total quantity of the item that has been received.

Example:

1

previous_attributes.line_items.unit_cost

number | null

required

The cost per product that is charged by the manufacturer.

Example:

1

previous_attributes.line_items.external_id

string | null

required

An identifier from an external system. e.g. vendor sku, external id, reference number, etc..

Example:

"external_sku"

Example:

[
  {
    "inventory_item_id": "item_id",
    "sku": "sku",
    "expected_quantity": 2,
    "received_quantity": 1,
    "unit_cost": 1,
    "external_id": "external_sku"
  }
]

previous_attributes.receipts

InboundReceipt · object[]

List of receiving events associated with the inbound shipment.

Show child attributes

previous_attributes.receipts.id

string

required

The unique ID of the receiving event.

Example:

"receipt_id"

previous_attributes.receipts.arrived_date

string<date-time>

required

Date the items arrived.

Example:

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

previous_attributes.receipts.line_items

InboundReceiptLineItem · object[]

required

List of line items included in the receiving event.

Show child attributes

previous_attributes.receipts.line_items.inventory_item_id

string

required

Can be passed into the Inventory endpoint for more details.

Example:

"item_id"

previous_attributes.receipts.line_items.sku

string | null

required

Example:

"sku"

previous_attributes.receipts.line_items.quantity

integer

required

Total quantity of the item that has been received.

Example:

1

Example:

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

Example:

[
  {
    "id": "receipt_id",
    "arrived_date": "2022-10-10T01:02:03Z",
    "line_items": [
      {
        "inventory_item_id": "item_id",
        "sku": "sku",
        "quantity": 1
      }
    ]
  }
]

previous_attributes.ship_from_address

ShipFromAddress · object

Show child attributes

previous_attributes.ship_from_address.address1

string | null

required

Example:

"123 Main St"

previous_attributes.ship_from_address.address2

string | null

required

Example:

"Apt 2"

previous_attributes.ship_from_address.address3

string | null

required

Example:

"Floor 3"

previous_attributes.ship_from_address.city

string | null

required

Example:

"New York"

previous_attributes.ship_from_address.state

string | null

required

Example:

"NY"

previous_attributes.ship_from_address.postal_code

string | null

required

Example:

"10001"

previous_attributes.ship_from_address.country

string | null

required

Example:

"United States"

previous_attributes.tracking_numbers

string[]

List of tracking numbers associated with the inbound shipment.

Tracking number

Example:

["tracking_number_1", "tracking_number_2"]

previous_attributes.notes

string[]

List of notes associated with the inbound shipment.

Note

Example:

["note_1", "note_2"]

previous_attributes.external_system_url

string | null

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

Example:

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

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

previous_attributes.additional_fields

object

Integration-specific fields

Show child attributes

previous_attributes.additional_fields.{key}

any

Example:

{ "key": "value" }

Response

200

Success

Home

How-To Guides

Use Cases

Inbound shipment updated

Body

Response