FUfulcrumpro
Shipments

Partially update a Shipment

Changed on
patch/api/shipments/{shipmentId}

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/shipments/{shipmentId}
  • Auth
    none declared

Path parameters

shipmentIdstring required

Request body

opstring
valueunknown
pathstring
fromstring

Source path — present for move/copy operations, absent otherwise.

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

customerAddressIdstring nullable

The id of the recipient address. A shipment addressed from one of the customer's addresses carries that address's id. Please reference /api/customers/{customerId}/addresses endpoint.

customFieldsobject nullable

Custom fields that have been defined on this entity.

externalReferencesobject nullable

The external references associated with this shipment

Changes

  • 48a5ec5e4598Revision changes
    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: application/problem+json)

  • d743ab8b105fRevision changes
    • breaking

      the / request property type changed from string to no type

    • info

      added the new optional request property /