VTEX · Example Payload

Vtex Newnote Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Newnote 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": "NewNote",
  "method": "POST",
  "path": "/notes",
  "summary": "VTex Create Note",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "id": "A08CDB2519AC4FA49EB6099CF72C3642",
        "domain": "oms",
        "owner": "c97ef6c8491a439f927cf9918644329f",
        "target": {
          "id": "v964735bdev-01",
          "type": "order",
          "url": "https://basedevmkp.vtexcommercebeta.com.br/admin/checkout/#/orders/v964741bdev-01"
        },
        "description": "The order's ID in the marketplace is 786-09",
        "creationDate": "2022-01-11T15:49:17.8785392Z",
        "lastUpdate": "2022-01-11T15:49:17.8785392Z",
        "createdBy": {
          "id": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
          "name": "pedro.costa@vtex.com.br",
          "email": "pedro.costa@vtex.com.br",
          "key": null
        }
      }
    }
  ]
}