List modifiers

Returns a paginated list of the modifiers belonging to the authenticated merchant’s store, each one including its options.

Authentication

Merchant API key in x-api-key (alias x-account-api-key).
Requires Merchant.product.read.

Query params (`FilterModifierDto` extends `PaginationDto`)

page (default 1) and per_page (default 10). Set per_page=0 to return every record.
name — case-insensitive contains filter on the modifier name.
sort — ordering over the allowed fields createdAt, name (e.g. sort=name:asc).

Response

Envelope with _metadata (page, per_page, total_page, total_count) and records, where each record embeds its options array.

Notas: Handler: modifierService.findAll. Results are always scoped to the caller’s storeId. per_page=0 disables pagination (_metadata.per_page then equals total_count).

## List modifiers Returns a paginated list of the modifiers belonging to the authenticated merchant's store, each one including its `options`. ### Authentication - Merchant API key in **`x-api-key`** (alias `x-account-api-key`). - Requires **`Merchant.product.read`**. ### Query params (`FilterModifierDto` extends `PaginationDto`) - `page` (default 1) and `per_page` (default 10). Set `per_page=0` to return every record. - `name` — case-insensitive `contains` filter on the modifier name. - `sort` — ordering over the allowed fields `createdAt`, `name` (e.g. `sort=name:asc`). ### Response Envelope with `_metadata` (page, per_page, total_page, total_count) and `records`, where each record embeds its `options` array. --- **Notas:** Handler: modifierService.findAll. Results are always scoped to the caller's storeId. per_page=0 disables pagination (_metadata.per_page then equals total_count).

Authentication

x-api-keystring

API Key authentication via header

Query parameters

pageintegerOptionalDefaults to 1

Page number to return.

per_pageintegerOptionalDefaults to 10

Number of records per page.

namestringOptional

Exact match on the modifier name.

sortstringOptional

Sort by one or more fields, comma-separated.

Allowed fields: createdAt, name

Formats: field (ascending by default), +field, -field, field:asc, field:desc (| also works as the separator).

Sort by one or more fields, comma-separated. **Allowed fields:** `createdAt`, `name` **Formats:** `field` (ascending by default), `+field`, `-field`, `field:asc`, `field:desc` (`|` also works as the separator).

List modifiers

Returns a paginated list of the modifiers belonging to the authenticated merchant’s store, each one including its options.

Authentication

Merchant API key in x-api-key (alias x-account-api-key).
Requires Merchant.product.read.

Query params (`FilterModifierDto` extends `PaginationDto`)

page (default 1) and per_page (default 10). Set per_page=0 to return every record.
name — case-insensitive contains filter on the modifier name.
sort — ordering over the allowed fields createdAt, name (e.g. sort=name:asc).

Response

Envelope with _metadata (page, per_page, total_page, total_count) and records, where each record embeds its options array.

Notas: Handler: modifierService.findAll. Results are always scoped to the caller’s storeId. per_page=0 disables pagination (_metadata.per_page then equals total_count).

$	curl -G https://api.md.tiankii.com/v1/product-modifiers \
>	-H "x-application-account-id: acct_3f9a21c7" \
>	-H "x-api-key: <apiKey>" \
>	-d name=Size \
>	-d sort=-createdAt

List modifiers

Authentication

Query params (FilterModifierDto extends PaginationDto)

Response

Authentication

Headers

Query parameters

List modifiers

Authentication

Query params (FilterModifierDto extends PaginationDto)

Response

Query params (`FilterModifierDto` extends `PaginationDto`)

Query params (`FilterModifierDto` extends `PaginationDto`)