VTEX · Example Payload

Vtex Getgiftcardfromgiftcardprovider Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getgiftcardfromgiftcardprovider 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": "GetGiftCardfromGiftCardProvider",
  "method": "POST",
  "path": "/api/giftcardproviders/{giftCardProviderId}/giftcards/_search",
  "summary": "VTex Get GiftCard from GiftCard Provider",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": "262498",
          "provider": "GiftCardExample",
          "balance": 45.5,
          "_self": {
            "href": "cosmet/giftcardproviders/GiftCardExample/giftcards/262498"
          }
        }
      ]
    }
  ]
}