VTEX · Schema

State

Recipient's address state's information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
code string State's code, from the recipient's address.
name string State's name, from the recipient's address.
View JSON Schema on GitHub

JSON Schema

vtex-subregion1-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Subregion1",
  "title": "State",
  "description": "Recipient's address state's information.",
  "required": [
    "code",
    "name"
  ],
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "State's code, from the recipient's address.",
      "example": "SP"
    },
    "name": {
      "type": "string",
      "description": "State's name, from the recipient's address.",
      "example": "Sao Paulo"
    }
  },
  "example": {
    "code": "SP",
    "name": "SP"
  }
}