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

# Giftcard Hub 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

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

## Endpoints

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

### api
| Method | Path | Description |
|--------|------|-------------|
| GET | /api/giftcardproviders | List all gift card providers |
| GET | /api/giftcardproviders/{giftCardProviderId} | Get a gift card provider by ID |
| PUT | /api/giftcardproviders/{giftCardProviderId} | Create or update a gift card provider by ID |
| DELETE | /api/giftcardproviders/{giftCardProviderId} | Delete a gift card provider by ID |
| POST | /api/giftcardproviders/{giftCardProviderId}/giftcards | Create a gift card at a gift card provider |
| POST | /api/giftcardproviders/{giftCardProviderId}/giftcards/_search | Get a gift card from a gift card provider |
| GET | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId} | Get a gift card from a gift card provider by ID |
| GET | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions | List all gift card transactions |
| POST | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions | Create a gift card transaction |
| GET | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{transactionId} | Get a gift card transaction by ID |
| GET | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/authorization | Get a gift card transaction authorization |
| GET | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/settlements | List all gift card transactions settlements |
| POST | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/settlements | Settle a gift card transaction |
| GET | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/cancellations | List all gift card transactions cancellations |
| POST | /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/cancellations | Cancel a gift card transaction |

## Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all giftcardproviders?" -> GET /api/giftcardproviders
- "Get giftcardprovider details?" -> GET /api/giftcardproviders/{giftCardProviderId}
- "Update a giftcardprovider?" -> PUT /api/giftcardproviders/{giftCardProviderId}
- "Delete a giftcardprovider?" -> DELETE /api/giftcardproviders/{giftCardProviderId}
- "Create a giftcard?" -> POST /api/giftcardproviders/{giftCardProviderId}/giftcards
- "Create a _search?" -> POST /api/giftcardproviders/{giftCardProviderId}/giftcards/_search
- "Get giftcard details?" -> GET /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}
- "List all transactions?" -> GET /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions
- "Create a transaction?" -> POST /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions
- "Get transaction details?" -> GET /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{transactionId}
- "List all authorization?" -> GET /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/authorization
- "List all settlements?" -> GET /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/settlements
- "Create a settlement?" -> POST /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/settlements
- "List all cancellations?" -> GET /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/cancellations
- "Create a cancellation?" -> POST /api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}/transactions/{tId}/cancellations
- "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-hub-api -o references/api-spec.lap

# Search for related APIs
npx @lap-platform/lapsh search giftcard-hub-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)