UpdateTrackingStatusRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateTrackingStatusRequest",
  "title": "UpdateTrackingStatusRequest",
  "required": [
    "isDelivered",
    "deliveredDate",
    "events"
  ],
  "type": "object",
  "properties": {
    "isDelivered": {
      "type": "boolean",
      "description": "When set as `true`, it means the order got to its final shipping address, whether by delivery or pickup shipping type. When set as `false`, the order is still in transit to its shipping address.",
      "example": false
    },
    "deliveredDate": {
      "type": "string",
      "nullable": true,
      "description": "Date and time of when the package was delivered. Note that it is different from the tracking date parameter. The `deliveredDate` format is `yyyy-mm-dd hh:mm`.",
      "example": "2022-10-01 21:15"
    },
    "events": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Event"
      },
      "description": "Array containing events information."
    }
  },
  "example": {
    "isDelivered": false,
    "deliveredDate": null,
    "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"
      }
    ]
  }
}