VTEX · Schema

CreatelabelsRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string Label ID.
url string Label URL.
name string Label name.
type string Label type.
View JSON Schema on GitHub

JSON Schema

vtex-createlabelsrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreatelabelsRequest",
  "title": "CreatelabelsRequest",
  "required": [
    "id",
    "url",
    "name",
    "type"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Label ID."
    },
    "url": {
      "type": "string",
      "description": "Label URL."
    },
    "name": {
      "type": "string",
      "description": "Label name."
    },
    "type": {
      "type": "string",
      "description": "Label type."
    }
  },
  "example": {
    "id": "JADF8ADF89-7AD7AF-78ADFASDF",
    "url": "http://s3://mybucket-alpha/orc/2013-10-04-custdata/label-pickup.pdf",
    "name": "Delivery label",
    "type": "PDF"
  }
}