VTEX · Schema

Note

Notes with delivery information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
type string Type of note.
date string Date of creation of the note in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.
content string Content of the note.
author string Author of the note.
View JSON Schema on GitHub

JSON Schema

vtex-note-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Note",
  "title": "Note",
  "required": [
    "type",
    "date",
    "content",
    "author"
  ],
  "type": "object",
  "description": "Notes with delivery information.",
  "properties": {
    "type": {
      "type": "string",
      "description": "Type of note."
    },
    "date": {
      "type": "string",
      "description": "Date of creation of the note in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`."
    },
    "content": {
      "type": "string",
      "description": "Content of the note."
    },
    "author": {
      "type": "string",
      "description": "Author of the note."
    }
  },
  "example": {
    "type": "COMMENT",
    "date": "2024-03-09T01:43:16.280Z",
    "content": "Tracking Number: 10001709948594168",
    "author": "afterShip"
  }
}