offers

View normalized Markdown

No description

graphql
offers(
  after: String
  availabilityMode: OfferAvailabilityModeEnum = EXACT
  before: String
  dates: [DateRange!]
  dows: [Int!]
  eventTemplates: [IdOrNumber!]
  excludeCompletedFixedEvents: Boolean = false
  first: Int
  hours4: [Int!]
  includeProductIds: Boolean
  includeQuota: Boolean = true
  last: Int
  offerableTypes: [OfferableTypeEnum!]
  posId: ID!
  quantity: Int
  savedFilterId: ID
  span: TsRange
  spanOperator: RangeOperatorEnum = OVERLAP
  tags: [ID!]
  text: String
): OfferableUnionConnection!

Arguments

offers.after · String scalar

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

offers.availabilityMode · OfferAvailabilityModeEnum enum

How availability of recurring offers is calculated.

offers.before · String scalar

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

offers.dates · [DateRange!] list scalar

Only offers on these dates. Offers without a date are always included.

offers.dows · [Int!] list scalar

Only offers on these weekdays in local time: 0 is Sunday, 6 is Saturday. Offers without a date are always included.

offers.eventTemplates · [IdOrNumber!] list scalar

Only offers of these event templates, by ID or number.

offers.excludeCompletedFixedEvents · Boolean scalar

Whether to leave out dated events that have already ended.

offers.first · Int scalar

Returns the first _n_ elements from the list.

offers.hours4 · [Int!] list scalar

Only offers starting in these four-hour blocks in local time, given as the block start: 0, 4, 8, 12, 16 or 20. Offers without a date are always included.

offers.includeProductIds · Boolean scalar

offers.includeQuota · Boolean scalar

Whether to calculate remaining places. Pass false for faster listings that do not show availability.

offers.last · Int scalar

Returns the last _n_ elements from the list.

offers.offerableTypes · [OfferableTypeEnum!] list enum

Only offers of these types.

offers.posId · ID! non-null scalar

For which POS should the quota information be calculated.

offers.quantity · Int scalar

offers.savedFilterId · ID scalar

offers.span · TsRange scalar

Only offers whose time span matches this range, compared with spanOperator.

offers.spanOperator · RangeOperatorEnum enum

How span is compared with offer time spans.

offers.tags · [ID!] list scalar

Only offers with these tags.

offers.text · String scalar

Free-text search across offers.

Type

OfferableUnionConnection object

The connection type for OfferableUnion.

Ready to Get Started?

Book a free demo or reach out — we’d love to hear from you.