VTEX · Example Payload

Vtex Listallgiftcardproviders Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Listallgiftcardproviders 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": "ListAllGiftCardProviders",
  "method": "GET",
  "path": "/api/giftcardproviders",
  "summary": "VTex List All GiftCard Providers",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": [
        {
          "id": "GiftCardExample",
          "serviceUrl": "https://api.vtex.com.br/basedevmkp",
          "oauthProvider": "vtex",
          "preAuthEnabled": true,
          "cancelEnabled": true,
          "_self": {
            "href": "cosmet/giftcardproviders/GiftCardExample"
          }
        },
        {
          "id": "GiftCardExample2",
          "serviceUrl": "https://giftcard--cosmetics2.myvtex.com/my-provider",
          "oauthProvider": "vtex",
          "caption": "My Updated Gift Card Provider",
          "preAuthEnabled": true,
          "cancelEnabled": true,
          "_self": {
            "href": "cosmet/giftcardproviders/GiftCardExample2"
          }
        }
      ]
    }
  ]
}