VTEX · Example Payload

Vtex Newtask Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Newtask 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": "NewTask",
  "method": "POST",
  "path": "/tasks",
  "summary": "VTex Create Task",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "target": [
          {
            "id": "633730670642-01",
            "type": "order",
            "url": "https://recorrenciaqa.vtexcommercebeta.com.br/admin/checkout/orders/633730670642-01"
          }
        ],
        "domain": "oms",
        "context": "Marketplace",
        "name": "pricing",
        "priority": "Critical",
        "surrogateKey": "505224-0",
        "description": "Ajudar na doc API para lancar no postman",
        "dueDate": "2016-03-01",
        "assignee": {
          "id": null,
          "name": null,
          "email": "frederico.santos@vtex.com.br"
        },
        "followers": [
          {
            "id": null,
            "name": null,
            "email": "alan.dantas@vtex.com.br"
          }
        ],
        "parentTaskId": null
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {}
    }
  ]
}