Load a storage unit onto a load

curl --request POST \
  --url https://clarus-api.com/api/load_tasks/{id}/load_storage_unit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "load_id": 14,
  "load_drop_id": 27
}
'

{
  "error": "<string>"
}

Loads

Load a storage unit onto a load

Complete a load task by recording that its storage unit has been physically loaded onto the supplied load (or load drop). Validates the load’s status, the load drop’s status, and — when loading validation settings are enabled — any configured pick list / booking date / delivery address checks. The task transitions to COMPLETED, the load and load drop counters are incremented, and a load transaction is recorded. This endpoint does NOT use JSON:API format.

POST

api

load_tasks

{id}

load_storage_unit

Load a storage unit onto a load

curl --request POST \
  --url https://clarus-api.com/api/load_tasks/{id}/load_storage_unit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "load_id": 14,
  "load_drop_id": 27
}
'

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

X-Clarus-Subdomain

string

header

required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

integer

required

The unique identifier of the load task

Body

application/json

load_id

integer

Load to load onto. Required unless the task already has a load assigned.

load_drop_id

integer

Load drop within the load. Required unless the task already has a load drop assigned.

Response

Operation completed successfully with no content to return

⌘I