VTEX · Schema

SupplierRequest

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
Name	string	Supplier Name.
CorporateName	string	Supplier Corporate Name.
StateInscription	string	State Inscription.
Cnpj	string	Corporate legal ID.
Phone	string	Supplier Phone.
CellPhone	string	Supplier Cellphone.
CorportePhone	string	Supplier Corporate Phone.
Email	string	Supplier email.
IsActive	boolean	Defines if the Supplier is active (`true`) or not (`false`).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SupplierRequest",
  "title": "SupplierRequest",
  "type": "object",
  "required": [
    "Name",
    "CorporateName",
    "StateInscription",
    "Cnpj",
    "Phone",
    "CellPhone",
    "CorportePhone",
    "Email",
    "IsActive"
  ],
  "properties": {
    "Name": {
      "type": "string",
      "description": "Supplier Name.",
      "example": "Supplier"
    },
    "CorporateName": {
      "type": "string",
      "description": "Supplier Corporate Name.",
      "example": "TopStore"
    },
    "StateInscription": {
      "type": "string",
      "description": "State Inscription.",
      "example": "123456"
    },
    "Cnpj": {
      "type": "string",
      "description": "Corporate legal ID.",
      "example": "33304981001272"
    },
    "Phone": {
      "type": "string",
      "description": "Supplier Phone.",
      "example": "3333333333"
    },
    "CellPhone": {
      "type": "string",
      "description": "Supplier Cellphone.",
      "example": "4444444444"
    },
    "CorportePhone": {
      "type": "string",
      "description": "Supplier Corporate Phone.",
      "example": "5555555555"
    },
    "Email": {
      "type": "string",
      "description": "Supplier email.",
      "example": "[email protected]"
    },
    "IsActive": {
      "type": "boolean",
      "description": "Defines if the Supplier is active (`true`) or not (`false`).",
      "example": false
    }
  }
}