Skip to main content

promotions

Accepts optional sorting and pagination arguments and returns the response containing single page of promotions, with additional technical information used for inter page navigation. NOTE: Max 9.999 results.

By default excludes DELETED Promotions. Might be changed if includeDeleted flag set to true.

If you query v1 model, businessUnitGroupIds filter parameter can be supplied. The filters businessUnitGroupId and businessUnitIds will be ignored if you query v1 model.

If you query v2 model, businessUnitGroupId and businessUnitIds filters can be supplied. The filter businessUnitGroupIds will be ignored if you query v2 model.

promotions(
first: Int
after: String
query: String
sort: SortingParamsInput
filter: FilteringParamsInput
searchTerm: String
): PromotionsConnection

Arguments

promotions.first ● Int scalar

Returns the first n elements from the list.

promotions.after ● String scalar

Returns the elements in the list that come after the specified cursor.

promotions.query ● String scalar

String value to search for. This property is deprecated, use instead.

promotions.sort ● SortingParamsInput input

Sorting options for the returned promotions.

promotions.filter ● FilteringParamsInput input

Filtering options for the returned promotions.

promotions.searchTerm ● String scalar

The search term to look for. Refer to this documentation article for more information about search term capabilities.

Type

PromotionsConnection object

A connection to a list of items.