Skip to main content
POST
/
api
/
public
/
v1
/
promotions
/
getById
Get promotion by ID
curl --request POST \
  --url https://app.localhost:3000/api/public/v1/promotions/getById \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "promo_123",
  "storeId": "store_123"
}
'
{
  "id": "promo_123",
  "name": "Summer Sale 20% Off",
  "code": "SUMMER20",
  "enabled": true,
  "automatic": false,
  "usageLimit": 100,
  "usageCount": 42,
  "startDate": "2025-06-01T00:00:00.000Z",
  "endDate": "2025-08-31T23:59:59.000Z",
  "ruleOperator": "AND",
  "combinesWithOrderLevelDiscounts": false,
  "combinesWithLineItemDiscounts": false,
  "combinesWithShippingDiscounts": false,
  "forceCombine": false,
  "rules": [],
  "actions": [
    {
      "type": "OrderAdjustment",
      "adjustmentType": "percentage",
      "adjustmentPercentage": 20
    }
  ]
}

Authorizations

Authorization
string
header
required

Enter your API key as: Bearer your-api-key

Body

application/json
id
string
required

The promotion ID

storeId
string
required

The store ID the promotion belongs to

Response

Successful response

id
string
storeId
string
accountId
string
name
string
code
string | null
enabled
boolean
automatic
boolean
usageLimit
number | null
usageCount
number
startDate
string<date-time> | null
endDate
string<date-time> | null
ruleOperator
enum<string>
Available options:
AND,
OR
combinesWithOrderLevelDiscounts
boolean
combinesWithLineItemDiscounts
boolean
combinesWithShippingDiscounts
boolean
forceCombine
boolean
rules
object[]
actions
object[]
createdAt
string<date-time>
updatedAt
string<date-time>