Skip to main content
POST
/
api
/
alternative_code_types
Create an alternative code type
curl --request POST \
  --url https://clarus-api.com/api/alternative_code_types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "alternative_code_types",
    "attributes": {
      "code": "EAN13",
      "name": "EAN-13 Barcode",
      "description": "European Article Number used for retail barcodes"
    }
  }
}
'
{
  "data": {
    "id": "1",
    "type": "alternative_code_types",
    "attributes": {
      "code": "EAN13",
      "name": "EAN-13 Barcode",
      "description": "European Article Number used for retail barcodes",
      "system_type": false
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "alternative_code_types",
    "attributes": {
      "code": "EAN13",
      "name": "EAN-13 Barcode"
    }
  }
}
FieldRequiredDescription
codeYesUnique code (max 50)
nameYesName (max 50)
descriptionNoDescription (max 500)
System types (system_type: true, e.g. Customer/Supplier) are read-only and cannot be updated or deleted.

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.