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.

Either businessUnitGroupId or businessUnitId argument must be provided.

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

Arguments

promotions.businessUnitGroupId ● String scalar

The ID of the business unit group to narrow the search down.

promotions.businessUnitId ● String scalar

The ID of the business unit to narrow the search down.

promotions.searchTerm ● String scalar

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

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.sort ● SortingParamsInput input

Sorting options for the returned promotions.

promotions.filter ● FilteringParamsInput input

Filtering options for the returned promotions.

Type

PromotionsConnection object

A connection to a list of items.