Manage colors

When to use this. Colours are reusable library entities for a brand: you create them once, optionally organise them into colour groups, and then reference them as colourways on items and styles. Use these endpoints to build and maintain that library.

The workflow

A colour is a brand-level record in the colour library. The usual path is to (optionally) set up colour groups for organisation, create the colours, then reference them from items and styles further along the product lifecycle.

Group (optional)

POST /api/color-groups to create groups (e.g. “Blues”, “Core”) you’ll file colours under.

Create colours

POST /api/colors with the colour details, attaching colorGroupIds to file them.

Find colours

GET /api/colors with filters (name, reference, state, group) to look colours up later.

Reference on products

Colours surface as colourways on items and style-items — see GET /api/items/{itemId}/colors and GET /api/styles/{styleId}/items/{styleItemId}/colors.

Walkthrough

Create a colour and file it under a colour group. The body is an array — one or many colours are created in a single all-or-nothing transaction.

curl -X POST "https://service.my.delogue.com/api/colors" \
  -H "Accept: application/json" \
  -H "X-Auth-Token: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "name": "Sky Blue",
    "userDefinedId": "SB-01",
    "userDefinedId2": null,
    "colorReference": "14-4318 TCX",
    "colorNote": "Spring palette",
    "state": "active",
    "colorGroupIds": [
      12
    ],
    "languageIds": [
      1
    ]
  }
]'

const res = await fetch("https://service.my.delogue.com/api/colors", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "X-Auth-Token": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify([
  {
    "name": "Sky Blue",
    "userDefinedId": "SB-01",
    "userDefinedId2": null,
    "colorReference": "14-4318 TCX",
    "colorNote": "Spring palette",
    "state": "active",
    "colorGroupIds": [
      12
    ],
    "languageIds": [
      1
    ]
  }
]),
});
const { data } = await res.json();

{
  "status": "success",
  "code": "colors_created",
  "data": [
    {
      "id": 2579,
      "name": "Sky Blue",
      "userDefinedId": "SB-01",
      "userDefinedId2": null,
      "colorReference": "14-4318 TCX",
      "state": "active",
      "colorNote": "Spring palette",
      "colorGroups": [
        {
          "id": 12,
          "name": "Greens",
          "userDefinedId": "GRN",
          "state": "active"
        }
      ],
      "languageNames": [],
      "properties": []
    }
  ]
}

The response wraps the created colours in the standard envelope. Hold onto each id — items and styles reference colours by it.

Field reference

The fields that matter most when creating or updating a colour:

Field	What it means at Delogue
`colorGroupIds`	IDs of the color groups to associate with the new color.
`colorNote`	Free-text note describing the color.
`colorReference`	Color reference code, e.g. a Pantone code.
`languageIds`	IDs of the languages to link the color to. The translated text per language is managed by a separate endpoint.
`name`	Display name of the color. Required.
`state`	Initial lifecycle state. Defaults to active.
`userDefinedId`	Customer-defined identifier (ID1).
`userDefinedId2`	Secondary customer-defined identifier (ID2).

Roles & permissions

Managing the colour library requires the colors permission on a designer (brand) account — typically CompanyAdmin or CompanyUser. Supplier accounts collaborate on styles but do not manage a brand’s colour library.

When things go wrong

Errors use the standard envelope (status: "error", a code, and error.details[]). See Errors & responses for the full list of codes and how to resolve them.

What to call next

Colour groups

Organise colours into groups for filtering and reuse.

Item colours

See which colours are used on an item: GET /api/items/{itemId}/colors.

Style-item colours

Colours on a style’s items: GET /api/styles/{styleId}/items/{styleItemId}/colors.

Authentication

How to get and send your X-Auth-Token API key.

Getting Started

Concepts

Guides

The workflow

Walkthrough

Field reference

Roles & permissions

When things go wrong

What to call next

Colour groups

Item colours

Style-item colours

Authentication

​The workflow

​Walkthrough

​Field reference

​Roles & permissions

​When things go wrong

​What to call next

Colour groups

Item colours

Style-item colours

Authentication

The workflow

Walkthrough

Field reference

Roles & permissions

When things go wrong

What to call next