Update an integration carrier mapping
curl --request PATCH \
--url https://clarus-api.com/api/integration_carrier_mapping_groups/{mapping_group_id}/mappings/{id} \
--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"
}
]
}
}
}
'import requests
url = "https://clarus-api.com/api/integration_carrier_mapping_groups/{mapping_group_id}/mappings/{id}"
payload = { "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" }]
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'}]
}
}
})
};
fetch('https://clarus-api.com/api/integration_carrier_mapping_groups/{mapping_group_id}/mappings/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Mappings
Update an integration carrier mapping
Update an existing integration carrier mapping. Returns 204 No Content on success.
PATCH
/
api
/
integration_carrier_mapping_groups
/
{mapping_group_id}
/
mappings
/
{id}
Update an integration carrier mapping
curl --request PATCH \
--url https://clarus-api.com/api/integration_carrier_mapping_groups/{mapping_group_id}/mappings/{id} \
--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"
}
]
}
}
}
'import requests
url = "https://clarus-api.com/api/integration_carrier_mapping_groups/{mapping_group_id}/mappings/{id}"
payload = { "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" }]
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'}]
}
}
})
};
fetch('https://clarus-api.com/api/integration_carrier_mapping_groups/{mapping_group_id}/mappings/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}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.
Path Parameters
The integration carrier mapping group ID
The mapping ID
Body
application/json
Show child attributes
Show child attributes
Response
Operation completed successfully with no content to return
⌘I

