VTEX · Example Payload

Vtex Updatetrackingstatus Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Updatetrackingstatus 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": "UpdateTrackingStatus",
  "method": "PUT",
  "path": "/api/oms/pvt/orders/{orderId}/invoice/{invoiceNumber}/tracking",
  "summary": "VTex Update order tracking status",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "isDelivered": false,
        "deliveredDate": "2022-10-01 21:15",
        "events": [
          {
            "city": "Rio de Janeiro",
            "state": "RJ",
            "description": "Coletado pela transportadora",
            "date": "2015-06-23"
          },
          {
            "city": "Sao Paulo",
            "state": "SP",
            "description": "A caminho de Curitiba",
            "date": "2015-06-24"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json; charset=utf-8",
      "example": {
        "date": "2017-03-29T18:04:31.0521233+00:00",
        "orderId": "v501245lspt-01",
        "receipt": "f67d33a8029c42ce9a8f07fc17f54449"
      }
    }
  ]
}