Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-02112393.9 KB
Gift Card

Create a gift card

Creates a gift card for a specific user.

⚠️ The redemptionCode field is auto-generated during gift card creation and cannot be set to an arbitrary value.

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
GiftCardGiftCardGift card full access

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 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.

post/giftcards

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

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

Response

OK

idstring required

Gift card identification.

redemptionTokenstring required

Gift card redemption token.

redemptionCodestring required

Gift card identification code used at checkout. Minimum of 6 characters.

balancenumber required

Gift card current balance (amount that is still available on the gift card to be used as a payment method for a purchase). For newly created gift cards, the balance will be 0.0.

relationNamestring required

A unique identifier for the relationship between the client and the store. This value must be different for each gift card, and we recommend generating it deterministically or at random, for example, using the profileId or a UUID.

emissionDatestring required

Gift card creation date. ISO 8601 format (YYYY-MM-DDThh:mm:ss.fff).

expiringDatestring required

Gift card expiration date. ISO 8601 format (YYYY-MM-DDThh:mm:ss.fff)

captionstring required

Field to be filled in if a loyalty program must be created for the Gift Card.

currencyCodestring

Currency code in ISO 4217.

All 11 operations