Saltar al contenido
DotPay Developers
DocumentaciónReferencia de API
Direcciones

Direcciones

Versión de API 0.0.1

Esquemas del objeto Dirección del núcleo y consulta de códigos postales de México.

Demostración pública con datos ficticios
Cualquier persona puede consultar o modificar los perfiles de comercios compartidos sin iniciar sesión. Los catálogos son de solo lectura. Usa únicamente datos ficticios, incluidos los contactos, los RFC y las direcciones.

Cada Dirección tiene un identificador estable. Usa la consulta por código postal para elegir una opción del catálogo. Luego envía esa opción junto con los datos de la calle a través del recurso que usa la dirección. En Comercios, la dirección forma parte del perfil fiscal. La guía de direcciones de México explica cómo elegir una coincidencia y resolver problemas de validación.

Dirección en la respuesta

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "country",
    "postal_code",
    "catalog_version",
    "entry_id",
    "state",
    "municipality",
    "city",
    "settlement",
    "street",
    "exterior_number",
    "interior_number"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "country": {
      "type": "string",
      "const": "MX"
    },
    "postal_code": {
      "type": "string",
      "pattern": "^[0-9]{5}$"
    },
    "catalog_version": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,99}$"
    },
    "entry_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,99}$"
    },
    "state": {
      "$ref": "#/components/schemas/GeographyLabel"
    },
    "municipality": {
      "$ref": "#/components/schemas/GeographyLabel"
    },
    "city": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/GeographyLabel"
        },
        {
          "type": "null"
        }
      ]
    },
    "settlement": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/GeographyLabel"
        },
        {
          "type": "null"
        }
      ]
    },
    "street": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "exterior_number": {
      "type": "string",
      "minLength": 1,
      "maxLength": 50,
      "description": "A string, including S/N for sin número."
    },
    "interior_number": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 50,
      "description": "Omit or use null or blank for an absent unit."
    }
  }
}

Dirección en la solicitud

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "country",
    "postal_code",
    "catalog_version",
    "entry_id",
    "street",
    "exterior_number"
  ],
  "properties": {
    "country": {
      "type": "string",
      "const": "MX"
    },
    "postal_code": {
      "type": "string",
      "pattern": "^[0-9]{5}$"
    },
    "catalog_version": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,99}$"
    },
    "entry_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,99}$"
    },
    "street": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    },
    "exterior_number": {
      "type": "string",
      "minLength": 1,
      "maxLength": 50,
      "description": "A string, including S/N for sin número."
    },
    "interior_number": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 50,
      "description": "Omit or use null or blank for an absent unit."
    }
  }
}

Operaciones

En esta página