Skip to main content
POST
/
api
/
barcode_formats
Create a barcode format
curl --request POST \
  --url https://clarus-api.com/api/barcode_formats \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "barcode_formats",
    "attributes": {
      "code": "EAN13",
      "name": "EAN-13 Retail Barcode",
      "is_default": true
    }
  }
}
'
{
  "id": 1,
  "code": "EAN13",
  "name": "EAN-13 Retail Barcode",
  "is_default": true
}

​
Request Structure

{
  "data": {
    "type": "barcode_formats",
    "attributes": {
      "code": "EAN13",
      "name": "EAN-13 Retail Barcode",
      "is_default": true
    }
  }
}
FieldRequiredDescription
codeYesUnique code
nameYesName
is_defaultNoDefault flag (exactly one default; the first format created is forced default; cannot be unset to false directly)

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.