Skip to main content
POST
/
api
/
load_drops
Create a load drop
curl --request POST \
  --url https://clarus-api.com/api/load_drops \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "load_drops",
    "attributes": {
      "load_id": 88,
      "delivery_address_id": 771,
      "expected_storage_unit_quantity": 3
    }
  }
}
'
{
  "data": {
    "id": "412",
    "type": "load_drops",
    "attributes": {
      "load_id": 88,
      "delivery_address_id": 771,
      "sequence": 1,
      "status": "pending",
      "expected_storage_unit_quantity": 3
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "load_drops",
    "attributes": {
      "load_id": 88,
      "delivery_address_id": 771,
      "expected_storage_unit_quantity": 3
    }
  }
}

​
Key Fields

FieldRequiredDescription
load_idYesParent load
delivery_address_idConditionalRequired when the load validates by delivery address
goods_out_idConditionalRequired when the load validates by sales order
expected_storage_unit_quantityNoExpected storage units (>= 0)
The load must be pending or open. The drop’s stop sequence is assigned automatically and can be changed via the sequence endpoint.

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 drop created successfully

​
data
object