When to use this. A style relation links one style to a related style within a brand’s
collection — for example a carry-over or a variant of an existing style. These endpoints are
read-only: you resolve the relation set on a style, or list every relation across the
organisation. Relations are created and edited in the Delogue application, not through this API.
The workflow
There are two ways in. When you already hold a style, read its relation directly. When you are reconciling relations in bulk, list them across the organisation and filter.1
Resolve one style's relation
GET /api/styles/{styleId}/related-style returns the related style, or a payload with only
styleId set when the style has no relation.2
List across the organisation
GET /api/style-relations lists every related-style link, filterable by styleId or
relatedStyleId.3
Open the related style
Follow
relatedStyleId to the style itself with GET /api/styles/{id}.Walkthrough
List the relations across the organisation, then resolve a single style’s relation by id. The list is paginated — passpageSize and pageNumber, or follow the opaque cursor for keyset
pagination.
styleId while relatedStyleId, relatedStyleNumber and relatedStyleName are
null. Treat that as “no relation”, not an error.
Field reference
The fields returned on a style relation:Roles & permissions
Reading style relations requires thestyles permission (read level), and the organisation
must have the Relation of Styles module enabled. Both designer and supplier accounts may
read — CompanyAdmin, CompanyUser, SupplierAdmin, and SupplierUser. Supplier callers see
relations only for the styles their organisation actually supplies.
When things go wrong
Errors use the standard envelope (status: "error", a code, and error.details[]). On the
style-scoped read, a styleId that belongs to another organisation returns 403; a styleId
that exists nowhere returns 404. See Errors & responses for the full
list of codes and how to resolve them.
What to call next
Styles
Create and maintain the styles that relations link together.
Get a style
Follow a relation to its target:
GET /api/styles/{id}.Authentication
How to get and send your
X-Auth-Token API key.