Skip to main content
When to use this. A care instruction layer names a physical layer of a garment: for example “Main”, “Lining”, or “Shell”. Layers are created once in Admin, given a stable user-defined ID, and then selected on styles to organise the composition of each layer’s materials and care icons. Use these endpoints to build and maintain that layer library. Multi-language translation of layer text requires a Professional licence.

​
The workflow

Layers sit one level above materials in the care instruction setup hierarchy: you create the layers, optionally translate them into working languages, and then select them on styles when defining each layer’s fibre composition and washing icons.
1

Create layers

POST /api/care-instruction-layers with the default text and an optional user-defined ID. The body is an array: one or many layers are created in a single all-or-nothing transaction.
2

Add translations (optional)

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

Find and list layers

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

Retire or bulk-manage

Use PUT /api/care-instruction-layers/{id} to deactivate a single layer, or PUT /api/care-instruction-layers (bulk) to update text, user-defined IDs, states and translations, or hard-delete multiple layers, in one transaction by setting 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 a “Lining” layer with a Norwegian translation in a single call.
The response wraps the created layers in the standard envelope. Hold onto each id: it is the stable reference used when updating or deactivating the layer later.

​
Field reference

​
Roles & permissions

Creating, updating and deleting care instruction layers 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 layer library. Reading a single layer with GET /api/care-instruction-layers/{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 layer is still referenced by one or more styles. Deactivate it with PUT /api/care-instruction-layers/{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-instruction-layers/{id}, PUT /api/care-instruction-layers/{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

Care instructions

Create the washing and handling instructions that sit within each layer on a style.

Colours

Build the colour library used alongside care instruction layers on styles.

Seasons

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

Style categories

Organise styles by category before assigning layers and care labels.