VTEX · Schema

Label

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string Label ID.
name string Name of the label.
url string Label URL.
type string Label's type of file.
View JSON Schema on GitHub

JSON Schema

vtex-label-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Label",
  "title": "Label",
  "required": [
    "id",
    "name",
    "url",
    "type"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Label ID."
    },
    "name": {
      "type": "string",
      "description": "Name of the label."
    },
    "url": {
      "type": "string",
      "description": "Label URL."
    },
    "type": {
      "type": "string",
      "description": "Label's type of file."
    }
  },
  "example": {
    "id": "78c83922-d658-48bf-89d5-0658a6a94e27",
    "name": "Shipping label",
    "url": "https://sandbox-download.postmen.com/label/2024-03-09/258a26a4-45ae-49eb-b64d-929d3b81f46d-1709947994279763.pdf",
    "type": "PDF"
  }
}