Sign in
Shipments

Update a specific shipment

put/api/shipments/{shipmentId}

Path parameters

shipmentIdstring required

Request body

shipByDatestring date-time nullable

Ship by date.

notesstring nullable

Shipment notes.

displayNotesToCustomerboolean

Whether or not to display the shipment notes on the pack list.

trackingNumberstring nullable

The tracking number for the shipment.

shippingMethodIdstring nullable

The shipping method identifier

shippedDatestring date-time nullable

The shipped date. Read-only: the value is accepted but not applied; the shipped date is set when the shipment ships.

shippedDateOverridestring date-time nullable

The actual ship date override. Takes precedence over the shipped date wherever a ship date is reported. Send the calendar date at midnight UTC (e.g. 2014-10-23T00:00:00Z); it is stored as sent and reports compare it as a date. Null clears it. On update, a value outside 2000-01-01 to 2099-12-31 is rejected; patch does not range-check.

shippingCostnumber double nullable

The shipment's cost. Read-only: the value is accepted but not applied.

Response

Shipment

idstring required

Unique id associated to this entity.

numberinteger required

Number

namestring required

Shipment Name

status'pending' | 'open' | 'shipped' | 'cancelled' required
packingStatus'notPacked' | 'partiallyPacked' | 'fullyPacked' | 'overPacked' required
trackingNumberstring nullable

Tracking number

shipByDatestring date-time nullable

Ship by date.

shippedDatestring date-time nullable

Shipped date.

shippedDateOverridestring date-time nullable

Shipped date override.

notesstring nullable

Shipment notes.

displayNotesToCustomerboolean

Whether to display the shipment notes on the pack list.

shippingCostnumber double nullable

The actual cost to ship as set on the shipment page

shippingChargenumber double nullable

The estimated cost to ship as set on the original shipment from the sales order page. It is charged to the customer via the Shipping/Handling line

customFieldsobject nullable

Custom fields that have been defined on this entity.

externalReferencesobject nullable

The external references associated with this shipment

Changes