Create a crossdock
curl --request POST \
--url https://clarus-api.com/api/crossdocks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "crossdocks",
"attributes": {
"account_id": 7,
"reference": "XD-2026-0042",
"expected_date_of_receipt": "2026-06-20T09:00:00Z",
"inbound_method": "delivery",
"warehouse_id": 2
}
}
}
'import requests
url = "https://clarus-api.com/api/crossdocks"
payload = { "data": {
"type": "crossdocks",
"attributes": {
"account_id": 7,
"reference": "XD-2026-0042",
"expected_date_of_receipt": "2026-06-20T09:00:00Z",
"inbound_method": "delivery",
"warehouse_id": 2
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'crossdocks',
attributes: {
account_id: 7,
reference: 'XD-2026-0042',
expected_date_of_receipt: '2026-06-20T09:00:00Z',
inbound_method: 'delivery',
warehouse_id: 2
}
}
})
};
fetch('https://clarus-api.com/api/crossdocks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "1",
"type": "crossdocks",
"attributes": {
"id": "501",
"reference": "XD-2026-0042",
"status": "pending",
"inbound_method": "delivery",
"expected_date_of_receipt": "2026-06-20T09:00:00Z"
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Crossdocks
Create a crossdock
Create a crossdock.
POST
/
api
/
crossdocks
Create a crossdock
curl --request POST \
--url https://clarus-api.com/api/crossdocks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "crossdocks",
"attributes": {
"account_id": 7,
"reference": "XD-2026-0042",
"expected_date_of_receipt": "2026-06-20T09:00:00Z",
"inbound_method": "delivery",
"warehouse_id": 2
}
}
}
'import requests
url = "https://clarus-api.com/api/crossdocks"
payload = { "data": {
"type": "crossdocks",
"attributes": {
"account_id": 7,
"reference": "XD-2026-0042",
"expected_date_of_receipt": "2026-06-20T09:00:00Z",
"inbound_method": "delivery",
"warehouse_id": 2
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'crossdocks',
attributes: {
account_id: 7,
reference: 'XD-2026-0042',
expected_date_of_receipt: '2026-06-20T09:00:00Z',
inbound_method: 'delivery',
warehouse_id: 2
}
}
})
};
fetch('https://clarus-api.com/api/crossdocks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "1",
"type": "crossdocks",
"attributes": {
"id": "501",
"reference": "XD-2026-0042",
"status": "pending",
"inbound_method": "delivery",
"expected_date_of_receipt": "2026-06-20T09:00:00Z"
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Request Structure
{
"data": {
"type": "crossdocks",
"attributes": {
"account_id": 7,
"reference": "XD-2026-0042",
"expected_date_of_receipt": "2026-06-20T09:00:00Z",
"inbound_method": "delivery"
}
}
}
| Field | Required | Description |
|---|---|---|
account_id | Yes | Stock account |
reference | Yes | Crossdock reference |
expected_date_of_receipt | Yes | Expected receipt date/time |
inbound_method | No | delivery or collection |
status | No | pending, confirmed, received, completed |
string1–5, integer1–5, boolean1–5, datetime1–5) and a nested address are also accepted.Authorizations
OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Body
application/json
Show child attributes
Show child attributes
Response
Created successfully
The response is of type object.
⌘I

