VTEX · Schema

CreatenotesRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
type string Note's type.
note string Note's text.
author string Note's author.
View JSON Schema on GitHub

JSON Schema

vtex-createnotesrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreatenotesRequest",
  "title": "CreatenotesRequest",
  "required": [
    "type",
    "note",
    "author"
  ],
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Note's type."
    },
    "note": {
      "type": "string",
      "description": "Note's text."
    },
    "author": {
      "type": "string",
      "description": "Note's author."
    }
  },
  "example": {
    "type": "ERROR",
    "note": "The package takes time to be shipped",
    "author": "Oscar Rojas"
  }
}