Sign in
Shipments

Partially update a Shipment

patch/api/shipments/{shipmentId}

Path parameters

shipmentIdstring required

Response

Shipment item

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

Changed in 2 of the 23 revisions of this API.12

  • d743ab8b105f11See the full diff
    • ▲

      the / request property type changed from string to no type

      request-property-type-changed

    • ○

      added the new optional request property /

      new-optional-request-property

  • c002514312371See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added