Skip to main content
POST
/
api
/
external_entities
Create an external entity
curl --request POST \
  --url https://clarus-api.com/api/external_entities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "external_entities",
    "attributes": {
      "entity_type": "product",
      "code": "SHOP-SKU-1",
      "description": "Red Widget",
      "external_system_reference1": "gid://shopify/Product/123",
      "integration_id": 12
    }
  }
}
'
{
  "id": 501,
  "entity_type": "product",
  "code": "SHOP-SKU-1",
  "description": "Red Widget",
  "external_system_reference1": "gid://shopify/Product/123",
  "external_system_reference2": null,
  "external_system_reference3": null,
  "integration_id": 12
}

​
Request Structure

{
  "data": {
    "type": "external_entities",
    "attributes": {
      "entity_type": "product",
      "code": "SHOP-SKU-1",
      "external_system_reference1": "gid://shopify/Product/123",
      "integration_id": 12
    }
  }
}

​
Key Fields

FieldRequiredDescription
entity_typeYescarrier, product, shipping_rate, or warehouse
codeYesDisplay code (e.g. external SKU)
external_system_reference1YesPrimary external system identifier
integration_idNoOwning integration
An ExternalEntity bridges an item in an external system (e.g. a Shopify product) to ClarusWMS. It is then linked to an internal entity via a mapping (see the Mappings endpoints).

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

Created record