VTEX · Example Payload

Vtex Getgiftcardfromgiftcardproviderbyid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getgiftcardfromgiftcardproviderbyid Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑
{
  "operationId": "GetGiftCardfromGiftCardProviderbyID",
  "method": "GET",
  "path": "/api/giftcardproviders/{giftCardProviderId}/giftcards/{giftCardId}",
  "summary": "VTex Get GiftCard from GiftCard Provider by ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "5",
        "redemptionToken": "32ScL57220Vapb8pc50HJ3mWH1cl1L8x",
        "redemptionCode": "***********ASDQ",
        "balance": 870,
        "emissionDate": "2014-04-24T20:22:58.163",
        "expiringDate": "2016-01-01T00:00:00",
        "currencyCode": "USD",
        "discount": false,
        "transactions": {
          "href": "cards/954/transactions"
        }
      }
    }
  ]
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This example
curl "https://apis.io/api/v1/examples/vtex-getgiftcardfromgiftcardproviderbyid-example"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.