VTEX · Schema

Timeline

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
id	string	Timeline ID.
date	string	Timeline actual date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.
createdAt	string	Order's creation date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.
updatedAt	string	Date of the order's last update in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.
type	string	Order status.
description	string	Description of the status.
author	string	Status author.
metaData	object	Metadata about the delivery information.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Timeline",
  "title": "Timeline",
  "required": [
    "id",
    "date",
    "createdAt",
    "updatedAt",
    "type",
    "description",
    "author",
    "metaData"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Timeline ID."
    },
    "date": {
      "type": "string",
      "description": "Timeline actual date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
    },
    "createdAt": {
      "type": "string",
      "description": "Order's creation date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
    },
    "updatedAt": {
      "type": "string",
      "description": "Date of the order's last update in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
    },
    "type": {
      "type": "string",
      "description": "Order status."
    },
    "description": {
      "type": "string",
      "description": "Description of the status."
    },
    "author": {
      "type": "string",
      "description": "Status author."
    },
    "metaData": {
      "$ref": "#/components/schemas/MetaData",
      "description": "Metadata about the delivery information."
    }
  },
  "example": {
    "id": "77263f59-0ac5-4b0c-bfe5-f17a1648474d",
    "date": "2024-03-09T01:33:14.917Z",
    "createdAt": "2024-03-09T01:33:14.917Z",
    "updatedAt": "2024-03-09T01:33:14.917Z",
    "type": "STATUS",
    "description": "Service pending in DEV",
    "author": "System",
    "metaData": {
      "shippingEstimatedDate": "2024-01-05T11:11:11.000Z",
      "metaData": null,
      "serviceId": "78c83922-d658-48bf-89d5-0658a6a94e27",
      "shippingPrice": 284.02,
      "status": "PENDING",
      "labels": [
        {
          "name": "Shipping label",
          "id": "78c83922-d658-48bf-89d5-0658a6a94e27",
          "type": "PDF",
          "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf"
        }
      ]
    }
  }
}