VTEX · Example Payload

Vtex Creategiftcard Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Creategiftcard 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": "CreateGiftCard",
  "method": "POST",
  "path": "/giftcards",
  "summary": "VTex Create a gift card",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "954",
        "redemptionToken": "32ScL57220Vapb8pc50HJ3mWH1cl1L8x",
        "redemptionCode": "***********ASDQ",
        "balance": 0,
        "relationName": "cardName",
        "emissionDate": "2014-04-24T20:22:58.163",
        "expiringDate": "2016-01-01T00:00:00",
        "caption": "Programa Vtex Fidelidade",
        "currencyCode": "USD",
        "transactions": {
          "href": "cards/954/transactions"
        }
      }
    }
  ]
}