Skip to main content
POST
/
api
/
public
/
v1
/
promotions
/
list
curl --request POST \
  --url https://app.localhost:3000/api/public/v1/promotions/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "storeId": "store_123",
  "pagination": {
    "page": 1,
    "pageSize": 20
  }
}
'
{
  "items": [
    {
      "id": "promo_123",
      "name": "Summer Sale",
      "code": "SUMMER20",
      "enabled": true,
      "automatic": false,
      "usageLimit": 100,
      "usageCount": 42,
      "startDate": "2025-06-01T00:00:00.000Z",
      "endDate": "2025-08-31T23:59:59.000Z"
    }
  ],
  "total": 1,
  "pageCount": 1
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
storeId
string
required

The store ID to list promotions for

​
search
string

Search term to filter promotions

​
sortBy
object

Sorting configuration

​
pagination
object

Pagination configuration

​
filters
object

Advanced filters

Response

Successful response

​
items
object[]
​
total
number
​
pageCount
number
​
options
object