Skip to main content
POST
/
api
/
integration_carrier_mapping_groups
/
{mapping_group_id}
/
mappings
Create an integration carrier mapping
curl --request POST \
  --url https://clarus-api.com/api/integration_carrier_mapping_groups/{mapping_group_id}/mappings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "integration_carrier_mappings",
    "attributes": {
      "carrier_id": 12,
      "carrier_service_id": 34,
      "integration_carrier_id": 901,
      "mapping_fields": [
        {
          "carrier_code_in_file": "DPD-NEXTDAY"
        }
      ]
    }
  }
}
'
{
  "id": 5
}

​
Request Structure

{
  "data": {
    "type": "integration_carrier_mappings",
    "attributes": {
      "carrier_id": 12,
      "carrier_service_id": 34,
      "integration_carrier_id": 901,
      "mapping_fields": [{ "carrier_code_in_file": "DPD-NEXTDAY" }]
    }
  }
}
Links an external carrier entity (integration_carrier_id) to an internal carrier + service. mapping_fields is an array of single-key {code: value} objects.

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.

Path Parameters

​
mapping_group_id
integer
required

The integration carrier mapping group ID

Body

application/json
​
data
object
required

Response

Created successfully

Created record