Skip to main content

Get Promotion

GET 

/promotions/:promotionId

Read one promotion with what can be done with it now: whether it can be joined, what an edit may change, the statuses it can move to, and whether enrolling takes stock or leaving takes a reason. Requires promotions.read.

Request and response fields at a glance
  • Path parameters: promotionId (integer, required).
  • Query parameters: brandId (integer, required).
  • 200 response (application/json): promotionId (integer, required), origin (string, required), kind (string, required), subKind (string or null, required), name (string or null, required), nativeTypeName (string, required), status (string, required), startsAt (string or null, required), endsAt (string or null, required), canJoin (boolean, required), joinBlock (string or null, required), familyKey (string or null, required), usage (object or null, required), portalUrl (string or null, required), editableFields (array, required), deadlines (object, required), fundingModel (string, required), marketplaceSharePct (number or null, required), budget (number or null, required), budgetSpent (number or null, required), terms (object or null, required), listings (object, required), brandId (integer, required), saleChannel (object, required), capturedAt (string or null, required), isStockRequired (boolean, required), isLeaveReasonRequired (boolean, required), statusActions (array, required), creatable (object or null, required).

Request​