atlas

Lists promotions

Lists promotions with optional filters and cursor pagination

get/atlas/v1/promotions

Request

  • Base URL: https://api.beamcheckout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.beamcheckout.com/atlas/v1/promotions
  • Auth: OAuth 2 (implicit, authorization URL "")

Query parameters

code_iprefixstring

filter by code prefix (case-insensitive)

discountType_instring[]

filter by discount types

isActiveboolean

filter by current validity (true = active now, false = inactive)

limitinteger

page size

afterCursorstring

cursor for the next page

beforeCursorstring

cursor for the previous page

Response

PromotionList

endCursorstring
hasNextPageboolean
hasPrevPageboolean
startCursorstring

Changes

No recorded changes to this operation across all 1 revision of this API.