Search Coupons

1 min

POST

https://api.upstartcommerce.com/v1/promotion/coupon/search

This endpoint returns a paginated list of coupons which can be filtered by promotion id and coupon id.

Authorized permissions:

promotion.coupon.read

acceptstringGenerated from available response content types

x-upstart-tenantstringTenant identifier associated with the site this call is for.

bodyobject

200<p>Success-list of coupons returned.</p>

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

curl --request POST \
     --url https://api.upstartcommerce.com/v1/promotion/coupon/search \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "page": "",
     "pageSize": ""
     }'