SelectedAddress

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SelectedAddress",
  "title": "SelectedAddress",
  "description": "List with the delivery addresses selected for the order. We currently only support a single delivery address.",
  "required": [
    "addressType",
    "addressId",
    "receiverName",
    "postalCode",
    "country"
  ],
  "type": "object",
  "properties": {
    "addressType": {
      "type": "string",
      "title": "addressType",
      "description": "String with the address type. The field supports the values: `residential`, `commercial`, `pickup`.",
      "example": "commercial"
    },
    "addressId": {
      "type": "string",
      "title": "addressId",
      "description": "String with the address identifier. Optional for `delivery` type orders, and required for `pickup-in-point` orders.",
      "example": "1"
    },
    "receiverName": {
      "type": "string",
      "title": "receiverName",
      "description": "String with the name of the person responsible for receiving the order.",
      "example": "Yennefer of Vengerberg"
    },
    "postalCode": {
      "type": "string",
      "title": "postalCode",
      "description": "String with the address' postal code.",
      "example": "81020-235"
    },
    "city": {
      "type": "string",
      "title": "city",
      "description": "String with the city\u2019s name.",
      "example": "City"
    },
    "state": {
      "type": "string",
      "title": "state",
      "description": "String with the state's name, filled in with two letter code.",
      "example": "RJ"
    },
    "country": {
      "type": "string",
      "title": "country",
      "description": "String with the state's name, filled in with three letter code.",
      "example": "BRA"
    },
    "street": {
      "type": "string",
      "title": "street",
      "description": "String with the street's name.",
      "example": "The Witcher Avenue"
    },
    "number": {
      "type": "string",
      "title": "The number",
      "description": "String with the street's number.",
      "example": "1986"
    },
    "neighborhood": {
      "type": "string",
      "title": "The neighborhood schema",
      "description": "String with the neighborhood's name.",
      "example": "Neighborhood's name"
    },
    "complement": {
      "type": "string",
      "title": "complement",
      "description": "String with the address' complement, like building name, or extra number.",
      "example": "Complement to address"
    },
    "geoCoordinates": {
      "$ref": "#/components/schemas/GeoCoordinates"
    }
  }
}