Skip to main content
POST
/
api
/
loads
Create a load
curl --request POST \
  --url https://clarus-api.com/api/loads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "loads",
    "attributes": {
      "reference": "<string>",
      "warehouse_id": 123,
      "carrier_id": 123,
      "carrier_service_id": 123,
      "trailer_id": 123,
      "expected_date_of_dispatch": "2023-11-07T05:31:56Z",
      "external_system_reference1": "<string>",
      "external_system_reference2": "<string>",
      "external_system_reference3": "<string>",
      "string1": "<string>",
      "string2": "<string>",
      "string3": "<string>",
      "string4": "<string>",
      "string5": "<string>",
      "integer1": 123,
      "integer2": 123,
      "integer3": 123,
      "integer4": 123,
      "integer5": 123,
      "datetime1": "2023-11-07T05:31:56Z",
      "datetime2": "2023-11-07T05:31:56Z",
      "datetime3": "2023-11-07T05:31:56Z",
      "datetime4": "2023-11-07T05:31:56Z",
      "datetime5": "2023-11-07T05:31:56Z",
      "boolean1": true,
      "boolean2": true,
      "boolean3": true,
      "boolean4": true,
      "boolean5": true
    }
  }
}
'
{
  "data": {
    "id": 123,
    "type": "loads",
    "attributes": {
      "reference": "<string>",
      "warehouse_id": 123,
      "carrier_id": 123,
      "carrier_service_id": 123,
      "trailer_id": 123,
      "expected_date_of_dispatch": "2023-11-07T05:31:56Z",
      "external_system_reference1": "<string>",
      "external_system_reference2": "<string>",
      "external_system_reference3": "<string>",
      "string1": "<string>",
      "string2": "<string>",
      "string3": "<string>",
      "string4": "<string>",
      "string5": "<string>",
      "integer1": 123,
      "integer2": 123,
      "integer3": 123,
      "integer4": 123,
      "integer5": 123,
      "datetime1": "2023-11-07T05:31:56Z",
      "datetime2": "2023-11-07T05:31:56Z",
      "datetime3": "2023-11-07T05:31:56Z",
      "datetime4": "2023-11-07T05:31:56Z",
      "datetime5": "2023-11-07T05:31:56Z",
      "boolean1": true,
      "boolean2": true,
      "boolean3": true,
      "boolean4": true,
      "boolean5": true
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "loads",
    "attributes": {
      "reference": "LOAD-2024-001",
      "warehouse_id": 1,
      "carrier_id": 5,
      "trailer_id": 10,
      "expected_dispatch_date": "2024-01-20T14:00:00Z"
    }
  }
}

​
Key Fields

FieldRequiredDescription
referenceNoLoad reference number
warehouse_idYesWarehouse ID
carrier_idNoCarrier for transport
trailer_idNoTrailer/vehicle ID
expected_dispatch_dateNoPlanned dispatch date

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.

Body

application/json
​
data
object
required

Response

Load created successfully

​
data
object