Skip to main content
POST
/
api
/
public
/
v1
/
offers
/
list
List offers
curl --request POST \
  --url http://app.localhost:3000/api/public/v1/offers/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "storeId": "<string>",
  "search": "<string>",
  "enabled": true,
  "limit": 20,
  "offset": 0
}
'
{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
storeId
string
required
type
enum<string>
Available options:
orderbump,
upsell
enabled
boolean
limit
number
default:20
Required range: 1 <= x <= 100
offset
number
default:0
Required range: x >= 0

Response

Successful response