Sign in
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 application 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 app 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. For newly created gift cards, the balance will be 0.0.

relationNamestring required

Field to be filled in when it is not necessary to use a loyalty program for the gift card. Note that a new relationNamevalue is required for each new gift card to be created.

emissionDatestring required

Gift card creation date.

expiringDatestring required

Gift card expiration date.

captionstring required

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

currencyCodestring

Currency code in ISO 4217.

Changes