VTEX · Schema

requestUpdateTrackingStatus

Request body object used to update the tracking status of an order.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
isDelivered	boolean	Indicates if order has been delivered. `false` if it is in transit.
events	array	Array containing information on each tracking event received.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/requestUpdateTrackingStatus",
  "title": "requestUpdateTrackingStatus",
  "type": "object",
  "description": "Request body object used to update the tracking status of an order.",
  "required": [
    "isDelivered"
  ],
  "properties": {
    "isDelivered": {
      "type": "boolean",
      "description": "Indicates if order has been delivered. `false` if it is in transit.",
      "example": true
    },
    "events": {
      "type": "array",
      "description": "Array containing information on each tracking event received.",
      "items": {
        "type": "object",
        "description": "Description of tracking event fields.",
        "properties": {
          "city": {
            "type": "string",
            "description": "City where the event ocurred.",
            "example": "Rio de Janeiro"
          },
          "state": {
            "type": "string",
            "description": "State where the event ocurred.",
            "example": "Rio de Janeiro"
          },
          "description": {
            "type": "string",
            "description": "Description of the event.",
            "example": "Order delivered."
          },
          "date": {
            "type": "string",
            "description": "Date when event ocurred.",
            "example": "2021-03-16"
          }
        }
      }
    }
  }
}