VTEX · Example Payload

Vtex Listallgiftcards Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Listallgiftcards 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": "ListAllGiftCards",
  "method": "POST",
  "path": "/giftcards/_search",
  "summary": "VTex List all gift cards",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": "3ad63br54-988e-4a14-8b7f-31fc6a5b955c_24",
          "provider": "ProviderName",
          "balance": 5.9,
          "_self": {
            "href": "/gatewayqa/giftcards/3ad63br54-988e-4a14-8b7f-31fc6a5b955c_24"
          }
        }
      ]
    }
  ]
}