Skip to main content
POST
/
api
/
carrier_services
Create a carrier service
curl --request POST \
  --url https://clarus-api.com/api/carrier_services \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "carrier_services",
    "attributes": {
      "code": "RM1CLS",
      "name": "Royal Mail 1st Class",
      "carrier_id": 57,
      "is_default": true,
      "active": true
    }
  }
}
'
{
  "id": 1,
  "code": "RM1CLS",
  "name": "Royal Mail 1st Class",
  "active": true,
  "is_default": true,
  "carrier_id": 57
}

​
Request Structure

{
  "data": {
    "type": "carrier_services",
    "attributes": {
      "code": "RM1CLS",
      "name": "Royal Mail 1st Class",
      "carrier_id": 57,
      "is_default": true,
      "active": true
    }
  }
}

​
Key Fields

FieldRequiredDescription
codeYesService code (max 30)
nameYesService name (max 50)
carrier_idYesParent carrier
is_defaultYesDefault-service flag
activeYesActive flag

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

Created successfully

The response is of type object.