Sign in
latestOpenAPI 3.0.42026-08-234704621.6 MB

a41e60b375bc

Shipments

Get a specific shipment. Includes the scheduled ship by date and, once shipped, the actual shipped date.

get/api/shipments/{shipmentId}

Path parameters

shipmentIdstring required

Response

The shipment for the given id

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