Create a carrier
curl --request POST \
--url https://clarus-api.com/api/carriers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "carriers",
"attributes": {
"code": "DHL",
"name": "DHL Express",
"description": "DHL international courier",
"active": true
}
}
}
'import requests
url = "https://clarus-api.com/api/carriers"
payload = { "data": {
"type": "carriers",
"attributes": {
"code": "DHL",
"name": "DHL Express",
"description": "DHL international courier",
"active": True
}
} }
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: 'carriers',
attributes: {
code: 'DHL',
name: 'DHL Express',
description: 'DHL international courier',
active: true
}
}
})
};
fetch('https://clarus-api.com/api/carriers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "5",
"type": "carriers",
"attributes": {
"code": "DHL",
"name": "DHL Express",
"description": "DHL international courier",
"active": true
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Carriers
Create a carrier
Create a shipping carrier (e.g. DHL, DPD, Royal Mail) for use on shipments and goods out orders.
POST
/
api
/
carriers
Create a carrier
curl --request POST \
--url https://clarus-api.com/api/carriers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "carriers",
"attributes": {
"code": "DHL",
"name": "DHL Express",
"description": "DHL international courier",
"active": true
}
}
}
'import requests
url = "https://clarus-api.com/api/carriers"
payload = { "data": {
"type": "carriers",
"attributes": {
"code": "DHL",
"name": "DHL Express",
"description": "DHL international courier",
"active": True
}
} }
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: 'carriers',
attributes: {
code: 'DHL',
name: 'DHL Express',
description: 'DHL international courier',
active: true
}
}
})
};
fetch('https://clarus-api.com/api/carriers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "5",
"type": "carriers",
"attributes": {
"code": "DHL",
"name": "DHL Express",
"description": "DHL international courier",
"active": true
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Request Structure
{
"data": {
"type": "carriers",
"attributes": {
"code": "DHL",
"name": "DHL Express",
"active": true
}
}
}
Key Fields
| Field | Required | Description |
|---|---|---|
code | Yes | Unique carrier code (max 50) |
name | Yes | Carrier display name (max 50) |
description | No | Carrier description |
active | No | Whether the carrier is active |
carrier_authentication | No | Provider-specific credentials object |
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
Carrier created successfully
Show child attributes
Show child attributes
⌘I

