Manage care instructions

When to use this. Care instructions are reusable library records for a brand: you create them once with a stable user-defined ID, optionally translate them into multiple languages, and then select them on styles to drive care label output. Use these endpoints to build and maintain that library. Multi-language support requires a Professional licence.

The workflow

A care instruction is an organisation-level record. The typical path is to create the instructions, keep them active for selection on styles, and retire or bulk-update them as your labelling requirements evolve.

Create instructions

POST /api/care-instructions with the default text and an optional user-defined ID. Pass an array: one or many instructions are created in a single all-or-nothing transaction.

Add translations (optional)

Include a languages array in the create body, or update an existing instruction via PUT /api/care-instructions/{id} with a replacement languages list. Requires a Professional licence and at least one language configured under Admin > General Settings.

Find instructions

GET /api/care-instructions with filters (text, userDefinedIds, state) to look up instructions for import verification or to drive a selection UI. GET /api/care-instructions/{id} returns a single instruction with its per-language texts.

Retire or bulk-manage

Use PUT /api/care-instructions/{id} to deactivate a single instruction, or PUT /api/care-instructions (bulk) to update text, user-defined IDs, states and translations, or hard-delete multiple instructions, in one transaction using state: "deleted" on those items. Position cannot be changed through these endpoints: leave position out of the body, because a non-null value is rejected.

Walkthrough

Create two care instructions in a single call: one with a Danish translation, one without. The body is an array so both are committed atomically.

curl -X POST "https://service.my.delogue.com/api/care-instructions" \
  -H "Accept: application/json" \
  -H "X-Auth-Token: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "userDefinedId": "KAF",
    "text": "Keep away from Fire",
    "isActive": true,
    "languages": [
      {
        "languageId": 1,
        "text": "Hold væk fra åben ild"
      }
    ]
  },
  {
    "userDefinedId": "DCSC",
    "text": "Dry Clean, Short Cycle",
    "isActive": true,
    "languages": null
  }
]'

const res = await fetch("https://service.my.delogue.com/api/care-instructions", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "X-Auth-Token": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify([
  {
    "userDefinedId": "KAF",
    "text": "Keep away from Fire",
    "isActive": true,
    "languages": [
      {
        "languageId": 1,
        "text": "Hold væk fra åben ild"
      }
    ]
  },
  {
    "userDefinedId": "DCSC",
    "text": "Dry Clean, Short Cycle",
    "isActive": true,
    "languages": null
  }
]),
});
const { data } = await res.json();

{
  "status": "success",
  "code": "care_instructions_created",
  "data": [
    {
      "id": 4160,
      "userDefinedId": "KAF",
      "text": "Keep away from Fire",
      "state": "active",
      "position": 1,
      "properties": [],
      "languages": [
        {
          "id": 5500,
          "languageId": 1,
          "text": "Hold væk fra åben ild"
        }
      ]
    },
    {
      "id": 4161,
      "userDefinedId": "DCSC",
      "text": "Dry Clean, Short Cycle",
      "state": "active",
      "position": 2,
      "properties": [],
      "languages": []
    }
  ]
}

The response wraps the created instructions in the standard envelope. Hold onto each id: styles reference care instructions by it when building care label output.

Field reference

The fields that matter most when creating or updating a care instruction:

Field	What it means at Delogue
`isActive`	Whether the instruction is active on creation. Defaults to true. Inactive instructions cannot be selected on styles.
`languages`	Initial per-language translations. Each entry pairs a languageId with its translated text. Null or omitted creates the instruction with no translations.
`text`	Default display text of the care instruction. Required.
`userDefinedId`	Customer-defined identifier for the care instruction. Must be unique within the organisation. Optional.

Roles & permissions

Creating, updating and deleting care instructions requires the care_instructions permission at write level, and the organisation must have the Care Instructions module enabled. In practice this means CompanyAdmin, or the Care Instruction Admin role held together with CompanyUser where flexible admin roles are enabled. The Care Instruction User role is not enough: it grants style-level access only, not management of the library. Reading a single instruction with GET /api/care-instructions/{id} needs only read-level care_instructions permission (in practice CompanyAdmin, CompanyUser or Care Instruction User) with the module enabled.

Multi-language translations require a Professional licence subscription. The languages field is accepted on all tiers but translation values are only surfaced where the feature is enabled.

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. Common cases:

409 Conflict on DELETE: the instruction is still referenced by one or more styles. Deactivate it with PUT /api/care-instructions/{id} (state: "inactive") instead of deleting it, or remove it from all styles first.
400 validation_error: text is missing on create, state: "deleted" was passed to the single-update endpoint, or an update carried a non-null position.
403 authorization_error: GET /api/care-instructions/{id}, PUT /api/care-instructions/{id} or an item in the bulk PUT names an id that belongs to another organisation.
404 resource_error: the id does not exist. DELETE also returns 404 for an id that belongs to another organisation.

What to call next

Colours

Build the colour library that care instructions sit alongside on a style.

Seasons

Create the seasons that styles, and their care instructions, are filed under.

Style categories

Organise styles by category before assigning care instructions.

Size ranges

Another style-level library entity: size ranges used alongside care labels.

Style care instructions

Read the care instructions assembled on a specific style.

Care instruction icons

Browse the care-symbol icon library referenced by care instructions.

Getting Started

Concepts

Guides

The workflow

Walkthrough

Field reference

Roles & permissions

When things go wrong

What to call next

Colours

Seasons

Style categories

Size ranges

Style care instructions

Care instruction icons

​The workflow

​Walkthrough

​Field reference

​Roles & permissions

​When things go wrong

​What to call next

Colours

Seasons

Style categories

Size ranges

Style care instructions

Care instruction icons

The workflow

Walkthrough

Field reference

Roles & permissions

When things go wrong

What to call next