VTEX · Example Payload

Vtex Getdocument Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Getdocument 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": "Getdocument",
  "method": "GET",
  "path": "/api/dataentities/{dataEntityName}/documents/{id}",
  "summary": "VTex Get document",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "b818cbda-e489-11e6-94f4-0ac138d2d42e",
        "accountId": "14af940d-9300-4279-9355-61d44c2ff879",
        "accountName": "apiexamples",
        "dataEntityId": "Newsletter"
      }
    }
  ]
}