Skip to main content
GET
Get brands

Headers

X-Delogue-Api
string

Query Parameters

Free-text search matching brands whose name contains this value.

Ids
integer<int64>[]

Filter to one or more brand identifiers.

Names
string[]

Filter to brands whose name exactly matches one of the supplied values. Matching is case-sensitive.

State
enum<string>

Filter to brands in the given lifecycle state. Lifecycle state of the brand. Inactive brands cannot be selected on new styles or items but remain visible on existing ones.

Available options:
active,
inactive,
deleted
Address
string

Filter to brands whose address contains this value.

ZipCode
string

Filter by exact postal or ZIP code.

City
string

Filter by exact city name.

StateOrProvince
string

Filter by exact state or province.

Country.Id

Filter by country identifier.

Country.Name
string

Filter by exact country name.

Country.Code
string

Filter by exact ISO country code, e.g. DK.

UserDefinedId
string

Filter by exact customer-defined brand identifier.

MarginFactorMin

Return only brands whose margin factor is greater than or equal to this value.

MarginFactorMax

Return only brands whose margin factor is less than or equal to this value.

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, Status, City, State, Country, UserDefinedId, LastUpdated.

pageSize

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

pageNumber

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

cursor
string

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.