Skip to main content
When to use this. A SKU is one unique colour/size combination of a style: the level at which you assign barcodes, negotiate prices, and read resolved custom-field values. Use these endpoints to look up a style’s SKUs, or page across the SKUs of every style in the organisation. Creating and updating SKUs is not yet part of the public API. SKUs require the Barcodes module and are a designer-only surface.

The workflow

SKUs hang off a style that already has its colourways and size range set up, one SKU per colour/size combination you sell. You read them for one style, one at a time, or across the whole organisation. Each SKU comes back enriched with its nested colour and size, the style’s custom fields resolved to that coordinate, and the lowest applicable price rows.
1

List a style's SKUs

GET /api/styles/{styleId}/skus returns a paginated list of one style’s SKUs. Filter by state, colorId and sizeId; a state of deleted is treated as inactive, as a SKU has no stored deleted state.
2

Fetch a single SKU

GET /api/styles/{styleId}/skus/{skuId} returns one SKU, scoped to its style.
3

Page across the organisation

GET /api/skus pages through the SKUs of every style in the organisation.

Walkthrough

Read a single SKU on a style by its skuId.
The response wraps the SKU in the standard envelope. A read returns the SKU enriched: color and size as nested objects, customFields resolved to that coordinate, prices at the lowest applicable variant level, and properties flags such as barcodeAssigned.

Field reference

The fields that matter most when reading a SKU:

Roles & permissions

SKUs are a designer-only surface: supplier accounts receive 403. The caller’s organisation must have the Barcodes module enabled, and the user needs the barcodes permission at read level. Without the module the request is refused; without price access, prices comes back empty rather than failing.

When things go wrong

Errors use the standard envelope (status: "error", a code, and error.details[]). A style that does not exist returns 404; a style in another organisation returns 403; an unknown skuId under the style returns 404. See Errors & responses for the full list of codes and how to resolve them.

What to call next

Styles

The style, its colourways, and size range that SKUs hang off.

Size ranges

Manage the sizes a SKU’s nested size points at.

Colours

Manage the colour library a SKU’s nested color points at.

Style prices

The full price rows a SKU’s prices join back to: GET /api/styles/{styleId}/prices.