docs
  1. Admin Api
  2. Resources
  3. Promotions
  4. Get A Promotion By Id

Get a promotion by ID

Get a promotion

Path Parameters

ParameterDetails
promotionId
  • required
  • MinLength: 24
  • MaxLength: 24
string
Example:
645e0c241a93369ff53f26e0

Query Parameters

ParameterDetails
with
Array of strings
string
Enum:
customData

Responses

200
A single promotion
application/json
Success
id
string
Example:
645e0c241a93369ff53f26e0
version
string
Example:
645e0c241a93369ff53f26e0
namerequired
string
Example:
Christmas Promotion
object
Example:
{
  "de_DE": "Weihnachtsaktion",
  "en_US": "Christmas promotion"
}
statusrequired
string
Example:
active
activationTyperequired
string
Example:
code
levelrequired
string
required
object
companyIdsrequired
Array of integer
required
object
object
object
required
object
required
Array of object
itemSetIds
Array of string
priority
integer
Example:
1
object
Example:
{
  "legalText": "Supported neglected met she therefore unwilling discovery remainder. Way sentiments two indulgence uncommonly own."
}
Array of object
object
401
Unauthorized
application/json
Error
403
Forbidden
application/json
Error
500
Service unavailable error
application/json
Error
GET/promotions/{promotionId}

Request samples

Response samples

200
Promotion:
Content type: application/json
Provide Feedback