VTEX · Example Payload

Vtex Getgiftcardproviderbyid Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getgiftcardproviderbyid 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": "GetGiftCardProviderbyID",
  "method": "GET",
  "path": "/api/giftcardproviders/{giftCardProviderId}",
  "summary": "VTex Get GiftCard Provider by ID",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "GiftCardExample",
        "serviceUrl": "https://api.vtex.com.br/basedevmkp",
        "oauthProvider": "vtex",
        "caption": "My Updated Gift Card Provider",
        "preAuthEnabled": true,
        "cancelEnabled": true,
        "_self": {
          "href": "cosmet/giftcardproviders/GiftCardExample"
        }
      }
    }
  ]
}