Skip to main content
GET
Get paginated list of styles

Headers

X-Delogue-Api
string

Query Parameters

Free-text search across style name, style number, and description.

id
integer<int64>[]

Filter to one or more style ids.

Name
string

Filter by style name using a partial match.

StyleNumber
string

Filter by style number, the customer-defined identifier of the style, using an exact or partial match.

description
string[]

Filter by description using a partial match. Repeat the parameter for multiple values.

state
string[]

Filter by lifecycle state. Repeat the parameter to match multiple states.

customid
string[]

Filter by the customer-defined style number. Repeat the parameter for multiple values.

ReadyForExport
boolean

When true, returns only styles marked ready for export to ERP or other integrated systems.

primary
boolean
brand.id
integer<int64>[]

Filter to styles belonging to any of these brand ids.

brand.name
string[]

Filter to styles belonging to brands with these names.

brand.contactpersonid
string<uuid>[]

Filter to styles whose brand contact person has any of these user ids in GUID form.

brand.customid
string[]

Filter to styles belonging to brands with these customer-defined ids.

brand.contactpersonname
string[]

Filter to styles whose brand contact person name matches any of these values.

supplier.id
integer<int64>[]

Filter to styles assigned to any of these supplier ids.

supplier.contactpersonid
string<uuid>[]

Filter to styles whose supplier contact person has any of these user ids in GUID form.

supplier.name
string[]

Filter to styles assigned to suppliers with these names.

supplier.customid
string[]

Filter to styles assigned to suppliers with these customer-defined ids.

supplier.contactperson.name
string[]

Filter to styles whose supplier contact person name matches any of these values.

season.id
integer<int64>[]

Filter to styles in any of these season ids.

season.name
string[]

Filter to styles in seasons with these names.

season.customid
string[]

Filter to styles in seasons with these customer-defined ids.

season.project
string[]

Filter to styles in seasons with these project names.

group.id
integer<int64>[]

Filter to styles belonging to any of these style group ids.

group.name
string[]

Filter to styles belonging to groups with these names.

group.customid
string[]

Filter to styles belonging to groups with these customer-defined ids.

category.id
integer<int64>[]

Filter to styles tagged with any of these style category ids.

category.name
string[]

Filter to styles tagged with categories having these names.

category.customid
string[]

Filter to styles tagged with categories having these customer-defined ids.

stylecolor.name
string[]

Filter to styles that have a color variant with any of these color names.

stylecolor.id
string[]

Filter to styles that have a color variant matching any of these primary color identifiers.

stylecolor.id2
string[]

Filter to styles that have a color variant matching any of these secondary color identifiers.

CustomFields
object[]

Filter by custom field values. Each entry identifies a custom field by id or userDefinedId together with a match value.

LastUpdated
string<date-time>[]

Filter by when the style was last updated. Provide one yyyy-MM-dd date to match that day onward, or two for an inclusive range.

StyleInfoUpdatedOn
string<date-time>[]

Filter by when the style's info fields were last updated. Provide one yyyy-MM-dd date to match that day onward, or two for an inclusive range.

sort
object[]

Repeat the parameter per sort column: sort[0].property=<column>&sort[0].order=Ascending|Descending, sort[1].... for a secondary column. order accepts asc, desc, ascending or descending (case-insensitive) and may also be spelled direction. Mutually exclusive with cursor. Sortable columns include: Id, Name, Number, State, Brand, BrandContactPerson, Supplier, SupplierContactPerson, Season, SeasonProjectName, Group, Description, ReadyForExport, LastUpdated, Category, StyleColor.

pageSize

Number of results to return per page. Defaults to 30, maximum 100.

pageNumber

The 1-based page number to return. Defaults to 1.

cursor
string

An opaque keyset pagination token. Mutually exclusive with the filter, sort, pageSize, and pageNumber parameters.

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
object[]
required

The page of results, always an array. An empty page is an empty array rather than null or an omitted field.

pagination
object
required

Paging metadata for this response, carrying whether more rows remain and the cursor used to request the next page.