Create a customer
curl --request POST \
--url https://clarus-api.com/api/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "customers",
"attributes": {
"code": "ACME",
"name": "Acme Retail Ltd",
"shelf_life_min": 30,
"shelf_life_max": 365
}
}
}
'import requests
url = "https://clarus-api.com/api/customers"
payload = { "data": {
"type": "customers",
"attributes": {
"code": "ACME",
"name": "Acme Retail Ltd",
"shelf_life_min": 30,
"shelf_life_max": 365
}
} }
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: 'customers',
attributes: {code: 'ACME', name: 'Acme Retail Ltd', shelf_life_min: 30, shelf_life_max: 365}
}
})
};
fetch('https://clarus-api.com/api/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "1",
"type": "customers",
"attributes": {
"code": "ACME",
"name": "Acme Retail Ltd",
"external_system_reference1": null,
"external_system_reference2": null,
"external_system_reference3": null,
"shelf_life_min": 30,
"shelf_life_max": 365
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Customers
Create a customer
Create a customer.
POST
/
api
/
customers
Create a customer
curl --request POST \
--url https://clarus-api.com/api/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "customers",
"attributes": {
"code": "ACME",
"name": "Acme Retail Ltd",
"shelf_life_min": 30,
"shelf_life_max": 365
}
}
}
'import requests
url = "https://clarus-api.com/api/customers"
payload = { "data": {
"type": "customers",
"attributes": {
"code": "ACME",
"name": "Acme Retail Ltd",
"shelf_life_min": 30,
"shelf_life_max": 365
}
} }
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: 'customers',
attributes: {code: 'ACME', name: 'Acme Retail Ltd', shelf_life_min: 30, shelf_life_max: 365}
}
})
};
fetch('https://clarus-api.com/api/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": "1",
"type": "customers",
"attributes": {
"code": "ACME",
"name": "Acme Retail Ltd",
"external_system_reference1": null,
"external_system_reference2": null,
"external_system_reference3": null,
"shelf_life_min": 30,
"shelf_life_max": 365
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Request Structure
{
"data": {
"type": "customers",
"attributes": {
"code": "ACME",
"name": "Acme Retail Ltd",
"shelf_life_min": 30,
"shelf_life_max": 365
}
}
}
| Field | Required | Description |
|---|---|---|
code | Yes | Unique customer code |
name | Yes | Customer name |
shelf_life_min / shelf_life_max | No | Shelf-life bounds in days |
address | No | Nested address (town/city in address_3) |
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

