provider
inventory

Update Shipments

Update multiple shipments.

put/inventory/shipments/update

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

idstring

Unique identifier for the shipment

stockIdstring required

ID of the stock

supplierIdstring required

ID of the supplier

locationIdstring required

ID of the location where the shipment was delivered

lotNumberstring nullable

Optional lot number of the shipment

expiryDatestring date-time nullable

Optional expiry date of the shipment

skustring nullable

Optional SKU (Stock Keeping Unit)

quantitynumber required

Total quantity

remainingQuantitynumber required

Remaining quantity

costinteger nullable

Cost of the shipment in cents

createdDatestring date-time nullable

Date and time the shipment was created

notestring nullable

Optional note for inventory log when updating shipment

Response

Successful Response

idstring

Unique identifier for the shipment

stockIdstring required

ID of the stock

supplierIdstring required

ID of the supplier

locationIdstring required

ID of the location where the shipment was delivered

lotNumberstring nullable

Optional lot number of the shipment

expiryDatestring date-time nullable

Optional expiry date of the shipment

skustring nullable

Optional SKU (Stock Keeping Unit)

quantitynumber required

Total quantity

remainingQuantitynumber required

Remaining quantity

costinteger nullable

Cost of the shipment in cents

createdDatestring date-time nullable

Date and time the shipment was created

notestring nullable

Optional note for inventory log when updating shipment

locationNamestring nullable required

Get the location name from the related location object

Changes

No recorded changes to this endpoint across all 1 revision of this API.