Read style item lists

When to use this. The style item list is the bill-of-materials (BOM) for a style. Each entry links a reusable item from the item library to a specific style, recording how many units are needed, which size variant applies, and which item colour card aligns with each style colour. Use these endpoints to pull full item-level specification data for a style: for example to feed an ERP, drive a compliance check, or build a custom product sheet.

The workflow

A style item list is assembled in Delogue by designer users and then read by both internal tools and supplier integrations. The typical read path is:

Identify the style

Use GET /api/styles to find the style you need. Note its id: that becomes styleId in the steps below.

List all style items

GET /api/styles/{styleId}/items returns every item on the style’s BOM together with the full item library detail: category, composition, supplier, sizes, and properties such as mainItem or includedCostPrice.

Inspect a single style item

GET /api/styles/{styleId}/items/{styleItemId} fetches one style item record when you already know the styleItemId and need the complete detail without loading the full list.

Read colour card slots

GET /api/styles/{styleId}/items/{styleItemId}/colors returns each style colour column paired with the item colour card selected for it, including admin and supplier colour specs.

To search across styles instead of reading one style’s list, call GET /api/style-items. It returns style items from your whole organisation in the same shape, filtered by StyleId, ItemId, or Properties=mainItem: for example, ItemId lists every style that uses a given trim or fabric. Page through the results with pageSize (default 30, maximum 100) and pageNumber, or with the cursor from the previous page; a cursor cannot be combined with filters, sort, pageSize, or pageNumber. id is the only sortable column.

Walkthrough

Retrieve all items on style 10 to build a component specification list.

curl "https://service.my.delogue.com/api/styles/10/items" \
  -H "Accept: application/json" \
  -H "X-Auth-Token: Bearer YOUR_API_KEY"

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

{
  "status": "success",
  "code": "style_items_retrieved",
  "data": [
    {
      "id": 3,
      "styleId": 10,
      "description": "Placering",
      "position": 1,
      "quantity": 5.0,
      "state": "active",
      "itemSize": {
        "id": 1,
        "name": "24\"",
        "state": "active",
        "position": 0,
        "properties": [
          "default"
        ]
      },
      "item": {
        "id": 5,
        "name": "Riveted logo pushbutton",
        "customId": "KB201",
        "state": "active",
        "description": "Metal shank button with logo embossing",
        "brand": {
          "id": 4,
          "name": "Default Brand"
        },
        "organization": {
          "id": 9,
          "name": "Acme Fashion"
        },
        "supplier": {
          "id": 11,
          "name": "Button & Trim Co."
        },
        "companyContactPerson": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "name": "Jamie Rivera"
        },
        "categories": [
          {
            "id": 3,
            "name": "Button"
          }
        ],
        "parts": [
          {
            "id": 1,
            "name": "Base button",
            "value": 0.0,
            "materials": [
              {
                "id": 10,
                "name": "Zinc Alloy",
                "percentage": 100.0
              }
            ]
          },
          {
            "id": 2,
            "name": "Kids logo",
            "value": 0.0,
            "materials": []
          }
        ],
        "adminUnit": {
          "id": 2,
          "name": "Pieces",
          "customId": "PCS",
          "properties": []
        },
        "logo": {
          "id": "5c45cc58-6c16-439e-a82c-553a2ea509dd",
          "url": "https://cdn.delogue.com/items/5c45cc58-6c16-439e-a82c-553a2ea509dd.png"
        },
        "lastUpdated": "2024-03-15T10:22:00Z",
        "defaultQty": 1.0,
        "properties": []
      },
      "properties": [
        "mainItem"
      ]
    },
    {
      "id": 24,
      "styleId": 10,
      "position": 2,
      "quantity": 1.0,
      "state": "active",
      "item": {
        "id": 23,
        "name": "Coastal printed jersey",
        "customId": "acd 237",
        "state": "active",
        "description": "100% cotton jersey fabric with all-over print",
        "brand": {
          "id": 4,
          "name": "Default Brand"
        },
        "organization": {
          "id": 9,
          "name": "Acme Fashion"
        },
        "supplier": {
          "id": 12,
          "name": "Nordic Fabric Mill"
        },
        "categories": [
          {
            "id": 1,
            "name": "Fabric"
          }
        ],
        "parts": [
          {
            "id": 15,
            "name": "Shell",
            "value": 150.0,
            "unit": "g/m²",
            "materials": [
              {
                "id": 4,
                "name": "Cotton",
                "percentage": 100.0
              }
            ]
          }
        ],
        "adminUnit": {
          "id": 3,
          "name": "Metres",
          "customId": "M",
          "properties": [
            "fraction"
          ]
        },
        "lastUpdated": "2024-05-20T08:45:00Z",
        "deadline": "2024-08-01T00:00:00Z",
        "defaultQty": 1.5,
        "properties": [
          "readyForExport"
        ]
      },
      "properties": [
        "includedCostPrice"
      ]
    }
  ]
}

The response envelope contains every BOM row. Each entry carries the full item library record nested under item, so a single call gives you categories, parts, materials, supplier, and contact information without further lookups.

Field reference

Style item (BOM row)

Field	What it means at Delogue
`dateAdded`	Timestamp when the item was first added to the style. Omitted when it was not recorded.
`description`	Placement or usage note for this item on the style, e.g. ‘Front chest’ or ‘Sleeve hem’. Omitted when no placement has been specified.
`id`	Unique identifier of the style item (the junction record between a style and an item).
`item`	Full detail of the item from the item library.
`itemSize`	The specific item size selected for this style item. Omitted when no size is pinned.
`position`	1-based display order of this item within the style item list.
`properties`	Boolean flags encoded as strings. Possible values: ‘mainItem’ (this item is designated the main composition item for the style), ‘includedCostPrice’ (the item cost is included in the style cost price calculation).
`quantity`	Number of units of this item required per style unit.
`state`	Lifecycle state of the style item: active or deleted. Derived from IsDeleted on the junction record: there is no inactive state for style items.
`styleId`	Identifier of the parent style.

Item library detail (`item`)

Field	What it means at Delogue
`id`	Unique identifier of the item in the item library.
`name`	Display name, e.g. `Riveted logo pushbutton`.
`customId`	Customer-defined item number (maps to `UserDefinedId`).
`state`	`active` or `inactive`. Derived from `IsActive` on the item record.
`description`	Free-text description of the item.
`brand` / `organization`	Brand and designer organisation that own the item.
`supplier`	Primary supplier organisation. Omitted when none is assigned.
`companyContactPerson` / `supplierContactPerson`	Brand-side and supplier-side contact people.
`categories`	Item categories, e.g. Fabric, Button, Label.
`parts`	Quality card parts: each has a name, value, unit, and material composition list with percentages.
`adminUnit`	Measurement unit group for this item (e.g. Metres, Pieces).
`logo`	Thumbnail image `id` and pre-signed `url`. Omitted when no image has been uploaded.
`lastUpdated`	Timestamp of the most recent change to the item.
`deadline` / `etd`	Target completion deadline and estimated time of delivery. Omitted when not set.
`defaultQty`	Default quantity suggested when adding this item to a new style.
`physicalReferenceNumber`	Physical sample reference number. Omitted when not set.
`properties`	Flags: `readyForExport` (marked ready for ERP export), `updatedAfterLastExport` (changed since last export), `commented` (has unread comments).

Item size (`itemSize`)

Field	What it means at Delogue
`id`	Unique identifier of the item size.
`name`	Display name, e.g. `24"` or `150 g`.
`state`	`active`, `inactive`, or `deleted`.
`position`	Display order within the item’s size list.
`properties`	Flags: `default` (the item’s default size), `approved`, `commented`.

Colour card slot (`/colors` endpoint)

Field	What it means at Delogue
`id`	Unique identifier of the colour card slot (junction of style item and style colour).
`styleItemId`	Parent style item.
`state`	`active` or `deleted`.
`styleColor.id`	The style colour column this slot belongs to.
`styleColor.colorMaster`	The master colour (AdminColor) behind this style colour column: carries `name`, `colorReference` (e.g. a Pantone code), and optional `customId` / `customId2`.
`itemColor`	The item colour card selected for this style colour. Omitted when no colour combination has been assigned yet.
`itemColor.adminColor`	Admin-defined colour spec (from the first item part). Omitted when no spec exists.
`itemColor.supplierColor`	Supplier-defined colour spec including `rgb` hex, `colorReference`, and an `approved` flag.

Roles & permissions

You can read the item list of any style that belongs to your own organisation. A style owned by another organisation returns 403 authorization_error.style_access_denied on all three per-style endpoints, and because styles belong to the designer organisation, a supplier account receives the same 403, even for a style it collaborates on. GET /api/style-items only ever returns style items from your own organisation, and returns 403 when your account lacks read access to styles. Creating, updating, or removing items from a style item list is not yet available through the Delogue API; do it in Delogue Classic or Delogue 2.0.

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 for these endpoints:

HTTP	Code	Likely cause
404	`resource_error.style_not_found`	The `styleId` does not exist.
404	`resource_error.style_item_not_found`	The `styleItemId` does not exist on the given style.
401	`authorization_error.unauthenticated`	Missing or invalid `X-Auth-Token`.
403	`authorization_error.style_access_denied`	The style belongs to another organisation, or you are calling with a supplier account.

What to call next

Colours

Manage the master colour library that backs style colour columns.

Seasons

Look up the season a style belongs to before fetching its items.

Style categories

Filter styles by category before pulling their item lists.

Size ranges

Understand the size ranges that underpin item size variants.

Getting Started

Concepts

Guides

The workflow

Walkthrough

Field reference

Style item (BOM row)

Item library detail (`item`)

Item size (`itemSize`)

Colour card slot (`/colors` endpoint)

Roles & permissions

When things go wrong

What to call next

Colours

Seasons

Style categories

Size ranges

​The workflow

​Walkthrough

​Field reference

​Style item (BOM row)

​Item library detail (item)

​Item size (itemSize)

​Colour card slot (/colors endpoint)

​Roles & permissions

​When things go wrong

​What to call next

Colours

Seasons

Style categories

Size ranges

The workflow

Walkthrough

Field reference

Style item (BOM row)

Item library detail (`item`)

Item size (`itemSize`)

Colour card slot (`/colors` endpoint)

Roles & permissions

When things go wrong

What to call next