automaticDiscountNodes

query

Requires read_discounts access scope.

An access token is required to call this API. Refer to Authorization for more information about how to obtain the token.

List of automatic discounts.

Arguments

first ● Int

Returns the first n elements in the list.

last ● Int

Returns the last n elements in the list.

reverse ● Boolean

Whether to reverse the order of the list.

● true: reverse

● false: do not reverse

Default value: false

query ● String

Apply one or multiple filters to the query. Currently supported filter fields and selectable values:

status: Represents the activity status, with selectable

values: active (enabled), expired (expired), scheduled (upcoming)

type: Represents the type of discount, with selectable

values: fix_amount (reduce the amount), percentage (reduce percentage discount)

Example: To query for an active automatic discount event that reduces a fixed amount, use the following: query:"type:fix_amount AND status:active".

Valid sorting key set for automatic discount list query Selectable enumeration values:

after ● String

Returns elements following the specified cursor. The first argument must also be specified when using this argument.

before ● String

Returns elements preceding the specified cursor. The last argument must also be specified when using this argument.

Return

A list of edges

A list of the nodes contained in DiscountAutomaticNodeEdge.

pageInfo ● PageInfo!non-null

Information to aid in pagination.

Status and error codes

For detailed information about common codes, see Status and error codes.

Was this article helpful to you?

SHOPLINE

SHOPLINE

Legal

Privacy