Skip to main content
POST
/
api
/
collection_addresses
Create a collection address
curl --request POST \
  --url https://clarus-api.com/api/collection_addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "collection_addresses",
    "attributes": {
      "name": "Acme Supplies Depot",
      "code": "ACME-DEPOT",
      "address_1": "10 Industrial Way",
      "address_3": "Manchester",
      "postcode": "M1 2AB",
      "country_code": "GB",
      "supplier_id": 14
    }
  }
}
'
{
  "data": {
    "id": "920",
    "type": "collection_addresses",
    "attributes": {
      "name": "Acme Supplies Depot",
      "code": "ACME-DEPOT",
      "address_1": "10 Industrial Way",
      "address_3": "Manchester",
      "postcode": "M1 2AB",
      "country_code": "GB",
      "supplier_id": 14
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "collection_addresses",
    "attributes": {
      "name": "Acme Supplies Depot",
      "code": "ACME-DEPOT",
      "address_1": "10 Industrial Way",
      "address_3": "Manchester",
      "postcode": "M1 2AB",
      "country_code": "GB",
      "supplier_id": 14
    }
  }
}

​
Key Fields

FieldRequiredDescription
codeYesAddress code (max 50)
nameYesAddressee name
supplier_idNoSupplier this collection address belongs to
address_3NoTown/city (passed to couriers as the city)

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

Collection address created successfully

​
data
object