Gift Card

Create a gift card

Changed on Sep 27, 2023

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:

Product	Category	Resource
GiftCard	GiftCard	Gift 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

Request

Base URL
https://apiexamples.vtexcommercestable.com.br/api
URL
https://apiexamples.vtexcommercestable.com.br/api/giftcards
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

Type of the content being sent.

Acceptstring required

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

Request body

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.

expiringDatestring required

It must be in the format YYYY-MM-DDThh:mm:ss.fff (ISO 8601 format).

captionstring required

Field to be filled in if a loyalty program must be created for the gift card.

profileIdstring required

Client ID. You can use the customer's registered email or the userId parameter which can be found in the Master Data.

currencyCodestring

Currency code in ISO 4217.

restrictedToOwnerboolean

The gift card can only be used for a specified client's ID.

multipleCreditsboolean

The gift card balance can be changed.

multipleRedemptionsboolean

The gift card can be used to make new purchases until its value is completely used.

Example request

{
  "relationName": "e58ed763-928c-4155-bee9-fdbaaadc15f3",
  "expiringDate": "2020-09-01T13:15:30Z",
  "caption": "rewards program",
  "profileId": "92de2449-0e02-4ca9-a4aa-a09cc9d8f7ff",
  "currencyCode": "USD"
}

Response

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

emissionDatestring required

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