Check Coupon Availability

1 min

GET

https://api.upstartcommerce.com/v1/promotion/coupon/{couponId}/check

This endpoint allows for the availability of a coupon to be verified before cart processing. This provides a shortcut so that the frontend does not need to insert coupons and wait for cart to process them.

Authorized permissions:

promotion.coupon.read

couponIdstringUnique identifier for coupon (coupon code).

timezoneIdstringTimezone id (tz database). If not specified - tenant's default timezone is used.

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

200Success-coupon available.

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

403An update to this resource requires the if-match and if-unmodified-since headers to be sent in order to process the request.

404The requested resource was not found in the NoChannel system.

410The requested resource is no longer available at the server and no forwarding address is known.

curl --request GET \
     --url https://api.upstartcommerce.com/v1/promotion/coupon/{couponId}/check \
     --header 'accept: application/json' \
     --header 'x-upstart-tenant: string'