ModifierSets

Modifier Sets object

Get modifier sets

get
/v1/modifier-sets

This operation returns a list of modifier sets.

Note: This operation needs Authentication and supports the following JSON:API features:

  • Sparse fieldsets - supports all fields of modifier_set with fields query parameter.

Authorizations
AuthorizationstringRequired

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Query parameters
page[size]integer · int32 · min: 1 · max: 1000Optional

The number of resources to return in a single response.

page[before]string · min: 1 · max: 36Optional

Unique identifier.

Pattern: ^[a-zA-Z0-9-]+$
page[after]string · min: 1 · max: 36Optional

Unique identifier.

Pattern: ^[a-zA-Z0-9-]+$
Responses
chevron-right
200

Successful response with modifier sets data in JSON:API format.

application/vnd.api+json
get
/v1/modifier-sets

Get modifier set

get
/v1/modifier-sets/{id}

This operation returns a modifier set. Modifier sets are used to group modifiers together.

Note: This operation needs Authentication and supports the following JSON:API features:

  • Relationships - modifiers using include query parameter.

  • Sparse fieldsets - supports all fields of modifier_set with fields query parameter.

Authorizations
AuthorizationstringRequired

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Path parameters
idstring · uuid · min: 36 · max: 36Required

Universally unique ID UUID4.

Example: 7d7fc62f-ebc1-427c-a496-ab46a011c851
Query parameters
includestring[] · max: 1Optional

Include query parameter to allow the client to customize which related resource should be returned.

Responses
chevron-right
200

Successful response with modifier set data in JSON:API format.

application/vnd.api+json
get
/v1/modifier-sets/{id}

Last updated

Was this helpful?