Create a marshalling log entry
Logistics module
POST/marshalling-logmarshallingLogEntries.create
A marshalling yard log entry: staging and release. Creates a marshalling log entry. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability logistics.yard.write.
- OAuth scopes: logistics.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: MarshallingLogEntryCreate
| Field | Type | Required | Description |
|---|---|---|---|
| entry | string | Yes | What happened in the yard.Constraints: length 1 to 1000 |
| logged_at | string (date-time) | No | When the event was logged. |
| project_id | string (uuid) | Yes | Identifier of the project whose yard the entry records. |
| shipment_id | string (uuid) | null | No | Identifier of the shipment concerned. |
| zone_id | string (uuid) | null | No | Identifier of the yard zone concerned. |
| urid | Urid | null | No |
{
"entry": "Staged in lane 2.",
"logged_at": "2026-10-08T14:30:00Z",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: MarshallingLogEntry
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the marshalling log entry. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| entry | string | Yes | What happened in the yard.Constraints: length 1 to 1000 |
| logged_at | string (date-time) | Yes | When the event was logged. |
| project_id | string (uuid) | Yes | Identifier of the project whose yard the entry records. |
| shipment_id | string (uuid) | null | Yes | Identifier of the shipment concerned. |
| zone_id | string (uuid) | null | Yes | Identifier of the yard zone concerned. |
| urid | Urid | null | Yes |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"entry": "Staged in lane 2.",
"logged_at": "2026-10-08T14:30:00Z",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"urid": "4000.01.01"
}Code samples
curl -X POST "$XOS_BASE_URL/marshalling-log" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"entry":"Staged in lane 2.","logged_at":"2026-10-08T14:30:00Z","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","shipment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data } = await xos.marshallingLogEntries.create({
"entry": "Staged in lane 2.",
"logged_at": "2026-10-08T14:30:00Z",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
});response = xos.marshalling_log_entries.create({"entry": "Staged in lane 2.", "logged_at": "2026-10-08T14:30:00Z", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})xos marshalling-log-entries create --data '{"entry":"Staged in lane 2.","logged_at":"2026-10-08T14:30:00Z","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","shipment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'