Update Container Allocation

patch

https://api.freight.fyi/api/v2/container_allocations/update/{uuid}

Partially update one of your container allocations in place, for example the quantity_received and cartons_received your warehouse counted. Fields not sent stay unchanged and an explicit null clears a field. The allocation keeps its uuid, and its links (container, distribution center allocation) are left as they are. Sending uuid, a link field, source, an audit field or custom_columns is a 422, and a uuid that is unknown or not yours is a 404. Datetimes are stored in UTC. A PATCH that changes nothing writes nothing. Where an automated receiving feed (the Maersk decon integration) maintains cartons_received, cartons_on_floor and fcr_date, its next update may supersede a PATCH of those fields. The response is the allocation as GET /{uuid} returns it.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

string

required

Body Params

Partial update: omitted fields stay as they are and an explicit null clears one. The uuid, the links
(container, distribution center allocation), the source and audit fields and custom columns are not patchable:
sending one is a 422.

cartons

Number of cartons allocated to the container.

cartons_received

Cartons Maersk received at the decon, from the 944 warehouse receipt. For tenants on an automated receiving feed (the Maersk decon integration) the feed recomputes this field, so a PATCH may be superseded.

cartons_on_floor

Cartons received at the decon and not yet loaded onto an outbound trailer. For tenants on an automated receiving feed (the Maersk decon integration) the feed recomputes this field, so a PATCH may be superseded.

quantity

Quantity of units allocated to the container.

quantity_received

Units received at the container's destination (e.g. a Maersk decon 944).

weight

Weight allocated to the container.

volume

Volume allocated to the container.

cost

Cost of the goods allocated to the container.

retail_value

Retail value of the goods allocated.

fcr_number

length ≤ 45

Forwarder's Cargo Receipt number.

fcr_date

Forwarder's Cargo Receipt date. Stored in UTC: a value with an offset is converted, one without is stored as sent. For tenants on an automated receiving feed (the Maersk decon integration) the feed recomputes this field, so a PATCH may be superseded.

latest_update_dt

When the allocation was last updated. Stored in UTC: a value with an offset is converted, one without is stored as sent.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error