Create an integration product mapping
curl --request POST \
--url https://clarus-api.com/api/integration_product_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_product_mappings",
"attributes": {
"product_id": 1024,
"integration_product_id": 778,
"mapping_fields": [
{
"sku": "EXT-SKU-99"
}
]
}
}
}
'import requests
url = "https://clarus-api.com/api/integration_product_mapping_groups/{mapping_group_id}/mappings"
payload = { "data": {
"type": "integration_product_mappings",
"attributes": {
"product_id": 1024,
"integration_product_id": 778,
"mapping_fields": [{ "sku": "EXT-SKU-99" }]
}
} }
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: 'integration_product_mappings',
attributes: {
product_id: 1024,
integration_product_id: 778,
mapping_fields: [{sku: 'EXT-SKU-99'}]
}
}
})
};
fetch('https://clarus-api.com/api/integration_product_mapping_groups/{mapping_group_id}/mappings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": 5
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Mappings
Create an integration product mapping
Create a integration product mapping within its mapping group, linking an external entity to internal records.
POST
/
api
/
integration_product_mapping_groups
/
{mapping_group_id}
/
mappings
Create an integration product mapping
curl --request POST \
--url https://clarus-api.com/api/integration_product_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_product_mappings",
"attributes": {
"product_id": 1024,
"integration_product_id": 778,
"mapping_fields": [
{
"sku": "EXT-SKU-99"
}
]
}
}
}
'import requests
url = "https://clarus-api.com/api/integration_product_mapping_groups/{mapping_group_id}/mappings"
payload = { "data": {
"type": "integration_product_mappings",
"attributes": {
"product_id": 1024,
"integration_product_id": 778,
"mapping_fields": [{ "sku": "EXT-SKU-99" }]
}
} }
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: 'integration_product_mappings',
attributes: {
product_id: 1024,
integration_product_id: 778,
mapping_fields: [{sku: 'EXT-SKU-99'}]
}
}
})
};
fetch('https://clarus-api.com/api/integration_product_mapping_groups/{mapping_group_id}/mappings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": 5
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Request Structure
{
"data": {
"type": "integration_product_mappings",
"attributes": {
"product_id": 1024,
"integration_product_id": 778,
"mapping_fields": [{ "sku": "EXT-SKU-99" }]
}
}
}
Authorizations
OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.
FlowAuthorization Code
- Authorization URL
- https://clarus-api.com/oauth/authorize
- Token URL
- https://clarus-api.com/oauth/token
FlowClient Credentials
- Token URL
- https://clarus-api.com/oauth/token
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Path Parameters
The integration product mapping group ID
Body
application/json
Show child attributes
Show child attributes
Response
Created successfully
Created record

