---
name: giftcard-api
description: "Giftcard API skill. Use when working with Giftcard for giftcards. Covers 11 endpoints."
version: 1.0.0
generator: lapsh
---

# Giftcard API
API version: 1.0

## Auth
ApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header

## Base URL
https://apiexamples.vtexcommercestable.com.br/api

## Setup
1. Set your API key in the appropriate header
2. GET /giftcards/{giftCardId}/transactions -- verify access
3. POST /giftcards -- create first giftcards

## Endpoints

11 endpoints across 1 groups. See references/api-spec.lap for full details.

### giftcards
| Method | Path | Description |
|--------|------|-------------|
| POST | /giftcards | Create a gift card |
| GET | /giftcards/{giftCardId} | Get a gift card by ID |
| POST | /giftcards/_search | List all gift cards |
| GET | /giftcards/{giftCardId}/transactions | List all gift card transactions |
| POST | /giftcards/{giftCardId}/transactions | Create a gift card transaction |
| GET | /giftcards/{giftCardId}/transactions/{transactionId} | Get a gift card transaction by ID |
| GET | /giftcards/{giftCardId}/transactions/{transactionId}/authorization | Get a gift card transaction authorization |
| GET | /giftcards/{giftCardId}/transactions/{transactionId}/cancellations | List all gift card transactions cancellations |
| POST | /giftcards/{giftCardId}/transactions/{transactionId}/cancellations | Cancel a gift card transaction |
| GET | /giftcards/{giftCardId}/transactions/{transactionId}/settlements | List all gift card transactions settlements |
| POST | /giftcards/{giftCardId}/transactions/{transactionId}/settlements | Settle a gift card transaction |

## Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Create a giftcard?" -> POST /giftcards
- "Get giftcard details?" -> GET /giftcards/{giftCardId}
- "Create a _search?" -> POST /giftcards/_search
- "List all transactions?" -> GET /giftcards/{giftCardId}/transactions
- "Create a transaction?" -> POST /giftcards/{giftCardId}/transactions
- "Get transaction details?" -> GET /giftcards/{giftCardId}/transactions/{transactionId}
- "List all authorization?" -> GET /giftcards/{giftCardId}/transactions/{transactionId}/authorization
- "List all cancellations?" -> GET /giftcards/{giftCardId}/transactions/{transactionId}/cancellations
- "Create a cancellation?" -> POST /giftcards/{giftCardId}/transactions/{transactionId}/cancellations
- "List all settlements?" -> GET /giftcards/{giftCardId}/transactions/{transactionId}/settlements
- "Create a settlement?" -> POST /giftcards/{giftCardId}/transactions/{transactionId}/settlements
- "How to authenticate?" -> See Auth section

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object

## CLI

```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get giftcard-api -o references/api-spec.lap

# Search for related APIs
npx @lap-platform/lapsh search giftcard-api
```

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)