Look up care instruction icons

When to use this. Care instruction icons are the reusable care symbols a brand maintains — wash, bleach, dry, iron and dry-clean instructions, grouped by labelling region (Europe, USA, or a custom region). These endpoints are read-only: you look icons up to display them or to reconcile them against a style’s care label. They are created and edited in the Delogue application, not through this API.

The workflow

An icon is a brand-level entry in the care-symbol library. The usual path is to list the library with filters, read a single icon when you need its full detail, and cross-reference the icons that appear on a style’s care instructions.

List the library

GET /api/care-instruction-icons with filters (region, icon type, state, text) to find the icons you need.

Read one icon

GET /api/care-instruction-icons/{id} for a single icon with its image URL and per-language texts.

See them on a style

Icons surface on a style’s care label via GET /api/styles/{styleId}/care-instructions.

Walkthrough

List the European care symbols and read one by id. The list is paginated — pass pageSize and pageNumber, or follow the opaque cursor for keyset pagination.

curl "https://service.my.delogue.com/api/care-instruction-icons" \
  -H "Accept: application/json" \
  -H "X-Auth-Token: Bearer YOUR_API_KEY"

const res = await fetch("https://service.my.delogue.com/api/care-instruction-icons", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-Auth-Token": "Bearer YOUR_API_KEY",
  },
});
const { data } = await res.json();

{
  "status": "success",
  "code": "care_instruction_icons_retrieved",
  "data": [
    {
      "id": 342,
      "customId": "WASH-30",
      "text": "Machine wash at 30°C",
      "iconResourceUrl": "https://service.my.delogue.com/files/care-icons/wash-30.svg",
      "region": "europe",
      "iconType": "wash_instruction",
      "state": "active",
      "translations": [
        {
          "id": 1201,
          "customId": "da",
          "languageId": 1,
          "text": "Maskinvask ved 30°C"
        }
      ]
    },
    {
      "id": 343,
      "customId": "DRY-FLAT",
      "text": "Dry flat in shade",
      "iconResourceUrl": null,
      "region": "custom",
      "iconType": null,
      "state": "active",
      "translations": []
    }
  ],
  "pagination": {
    "hasMore": true,
    "cursor": "eyJTaWduYXR1cmUiOiJjaWkxMjMifQ=="
  }
}

Each icon carries a region and, for Europe/USA icons, an iconType (wash_instruction, bleach_instruction, dry_instruction, iron_instruction, or dryclean_instruction). Custom-region icons have no fixed type, so their iconType is null.

Field reference

The fields that matter most when reading a care instruction icon:

Field	What it means at Delogue
`customId`	Customer-defined identifier of the icon. May be null.
`iconResourceUrl`	URL of the icon’s image resource, or null when no image is attached.
`iconType`	Category of care instruction: wash_instruction, bleach_instruction, dry_instruction, iron_instruction, or dryclean_instruction. Null for custom-region icons, which carry no fixed type.
`id`	Unique identifier of the care instruction icon.
`region`	Care-labelling region the icon belongs to: europe, usa, or custom. May be null.
`state`	Lifecycle state of the icon: active or inactive.
`text`	Display text describing the icon, e.g. the wash instruction. May be null.
`translations`	Per-language text for the icon. Populated only when the organization has the multiple-language module enabled; otherwise an empty list.

Roles & permissions

Reading care instruction icons requires the care_instructions permission (read level) on a designer (brand) account — typically CompanyAdmin or CompanyUser. The organisation must also have the Care Instructions module enabled. Per-language translations are returned only when the multiple-language module is enabled; otherwise the list is empty.

When things go wrong

Errors use the standard envelope (status: "error", a code, and error.details[]). Reading a {id} that belongs to another organisation returns 403; an id that exists nowhere returns 404. See Errors & responses for the full list of codes and how to resolve them.

What to call next

Care instructions

The care instructions these icons are attached to.

Style care instructions

Icons on a style’s care label: GET /api/styles/{styleId}/care-instructions.

Care instruction layers

The layered structure a care label is built from.

Authentication

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

Getting Started

Concepts

Guides

Look up care instruction icons

The workflow

Walkthrough

Field reference

Roles & permissions

When things go wrong

What to call next

Care instructions

Style care instructions

Care instruction layers

Authentication

​The workflow

​Walkthrough

​Field reference

​Roles & permissions

​When things go wrong

​What to call next

Care instructions

Style care instructions

Care instruction layers

Authentication

The workflow

Walkthrough

Field reference

Roles & permissions

When things go wrong

What to call next