VTvtex
Coupons

Get all coupons

Changed on

Check the Promotions onboarding guide for a journey-based overview of the Promotions documentation available in the Developer Portal.

Retrieves all coupons from an account.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
Rates and BenefitsPromotionsManage benefits and rates

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/rnb/pvt/coupon

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Headers

Content-Typestring required

Indicate the media type of the resource.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand

Response

OK

lastModifiedUtcstring

Date and time of the last update of the coupon in UTC format.

utmSourcestring

UTM source code.

utmCampaignstring

UTM campaign code.

couponCodestring

Coupon code.

isArchivedboolean

Defines if the coupon is archived (true) or not (false).

maxItemsPerClientinteger

Maximum items per client that the coupon can be applied.

expirationIntervalPerUsestring

Coupon expiration interval per use.

maxUsageinteger

Amount of times the coupon can be used.

groupingKeystring

If the coupon was created as a multiple coupon or using Generate coupons in bulk, this field returns the original couponCode informed.

Changes