VTEX · Example Payload

Vtex Searchgiftcardsfromcartdata Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Searchgiftcardsfromcartdata 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": "SearchGiftCardsfromcartdata",
  "method": "POST",
  "path": "/giftcards/_search",
  "summary": "VTex List all gift cards",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "items": [
          {
            "id": "589",
            "_self": {
              "href": "cards/589"
            }
          },
          {
            "id": "590",
            "_self": {
              "href": "cards/590"
            }
          },
          {
            "id": "591",
            "_self": {
              "href": "cards/591"
            }
          },
          {
            "id": "592",
            "_self": {
              "href": "cards/592"
            }
          }
        ],
        "paging": {
          "page": 0,
          "perPage": 10,
          "total": 4,
          "pages": 1
        }
      }
    }
  ]
}