atlas

Gets a promotion by its code

Gets a promotion by its code

get/atlas/v1/promotions/{code}

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/{code}
  • Auth: OAuth 2 (implicit, authorization URL "")

Path parameters

codestring required

code

Response

Promotion

codestring
createdAtstring
createdBystring
endAtstring

EndAt is null when the promotion is open-ended.

isActiveboolean

IsActive is whether the promotion is currently active (now within its window).

namestring
startAtstring

Changes

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