Update Inbound Shipment

Required permission: write_inbound_shipments

Update details of an existing inbound shipment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

The ID of the inbound shipment to update.

Body Params

An object containing the fields to update in the inbound shipment.

integer | null
≥ 1

The ID of the warehouse associated with this inbound shipment.

string | null

The reference number for the inbound shipment.

date-time | null

The expected date of the inbound shipment.

date-time | null

The date the inbound shipment was shipped.

string | null

The tracking number for the inbound shipment.

string | null

The URL for the tracking of the inbound shipment.

string | null

The new status of the inbound shipment. Value must match an existing inbound shipment status in your organization.

boolean | null

Whether the inbound shipment is closed. When set to true without a closed_date, the closed date is automatically set to the current time.

date-time | null

The date the inbound shipment was closed.

string | null

Notes visible to warehouse staff.

string | null

Internal notes for the inbound shipment.

tags
array of strings | null

This field is an upsert operation, and will replace the existing tags. Cannot be used together with 'add_tags' or 'remove_tags'.

tags
add_tags
array of strings | null

Tags to add to the inbound shipment. Cannot be used together with 'tags'.

add_tags
remove_tags
array of strings | null

Tags to remove from the inbound shipment. Cannot be used together with 'tags'.

remove_tags
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json