v50

latestOpenAPI 3.0.0raw.githubusercontent.com2025-09-22312710.8 KB

Coupons

Get archived coupon by coupon code

Retrieves a specific archived coupon by its coupon code.

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:

Product	Category	Resource
Rates and Benefits	Promotions	Manage 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/archive/coupon/{couponCode}

Path parameters

couponCodestring required

Example:promo10

Coupon Code

Headers

Content-Typestring required

Describes the type of the content being sent.

Acceptstring required

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

Response

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.