vtex.local – Giftcard-API

OpenAPI apis-guru

ℹ️ Onboarding guide

Check the new . We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.

The Gift Card is a payment method configured as a cash value associated with a client. It is used to grant a discount on the value of the order at the store.

⚠ A Gift Card works as a payment method, not a promotion.

Homepage: https://api.apis.guru/v2/specs/vtex.local:Giftcard-API/1.0.json
Provider: vtex.local:Giftcard-API / Giftcard-API
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/vtex.local/Giftcard-API/1.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/vtex.local/Giftcard-API/1.0/openapi.yaml

Tools (13)

Extracted live via the executor SDK.

giftCard.createGiftCard

Creates a GiftCard for a specific user
giftCard.getGiftCardbyId

Returns associated data for a specified giftcardId.
giftCard.getGiftCardusingJson

Returns the giftcards based on the cart data.
transaction.cancelGiftCardTransaction

Creates a cancellation in the transaction. Cancel a item reservation or create a refund.
transaction.createGiftCardTransaction

Register a new giftcard transaction and authorize the item reservation.
transaction.getGiftCardTransactionbyId
transaction.getGiftCardTransactions

Returns all transaction of a giftcard.
transaction.getTransactionAuthorizations

Returns the giftcard transaction authorizations.
transaction.getTransactionCancellations

Returns the giftcard transaction cancellations.
transaction.getTransactionSettlements

Returns the giftcard transaction settlements.
transaction.settleGiftCardTransaction

Creates a giftcard transaction settlement.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools