Licitadores - Servicio de código postal

El Servicio de códigos postales es un servicio de solo lectura. Este servicio se puede utilizar para recuperar identificadores de códigos postales registrados en Xandr con fines de segmentación geográfica al configurar una línea de pedido o para configurar informes que admitan esa dimensión. El principal caso de uso del servicio de códigos postales es mantener su base de datos de códigos postales actualizada con la de Xandr. Para acceder a los cambios realizados en la base de datos de Xandr desde la última llamada que realizó al servicio, asegúrese de usar el campo en la min_last_modified llamada.

Advertencia

Debido a la gran cantidad de llamadas GET que necesitaría realizar para obtener una lista completa de códigos postales (como resultado de la paginación), le recomendamos lo siguiente:

  • crear una caché y rellenarla con una llamada GET para todos los objetos del servicio
  • después, para las siguientes llamadas GET, use el filtro para obtener actualizaciones (una vez por hora o una vez al día, ya que los min_last_modified códigos postales se actualizan con poca frecuencia)

Solo debe omitir el min_last_modified filtro si está consultando este servicio por primera vez.

API de REST

Método HTTP Endpoint Description
GET https://api.adnxs.com/postal-code Ver todos los códigos postales
GET https://api.adnxs.com/postal-code?country_code=COUNTRY_CODE Ver los códigos postales de un determinado país o región
GET https://api.adnxs.com/postal-code/meta Descubra por qué campos puede filtrar y ordenar

Campos JSON

Campo Tipo (longitud) Descripción
active booleano Designa si el código postal está activo. Si true, el código postal está activo y disponible para la segmentación. Si false, no hay datos de ubicación geográfica para el código postal, por lo que no es posible realizar la segmentación.
code string El código postal puede tener cadenas alfanuméricas de hasta 14 caracteres y puede contener un espacio o guión.
country_code string El código ISO Alpha-2 del país o región al que pertenece la ciudad. Puede usar el Servicio de país para recuperar una lista completa de los códigos de país.
country_id string El Id. del país o región.
country_name string Nombre del país o región al que pertenece la ciudad. Puede usar el Servicio de país o región para obtener una lista completa de nombres de países.
id Entero El identificador del código postal.
last_modified marca de tiempo La fecha y hora en que se modificó por última vez el código postal.

Ejemplos

Ver todos los códigos postales en Canadá

$ curl -b cookies -c cookies -X GET  'https://api.adnxs.com/postal-code?country_code=CA'
{
        "response": {
        "status": "OK",
        "count": 44101,
        "start_element": null,
        "num_elements": null,
        "postal_codes": [
            {
                "id": 119892,
                "code": "A09 0A1",
                "country_id": "41",
                "country_code": "CA",
                "country_name": "Canada"
            },
            {
                "id": 119893,
                "code": "A0A 0B3",
                "country_id": "41",
                "country_code": "CA",
                "country_name": "Canada"
            },
            {
                "id": 119894,
                "code": "A0A 0C3",
                "country_id": "41",
                "country_code": "CA",
                "country_name": "Canada"
            },
            ...
      ]
   }
}

Ver código postal por id. de código postal

$ curl -b cookies -c cookies  'https://api.adnxs.com/postal-code?id=10'
      
{
    "response": {
        "status": "OK",
        "count": 1,
        "start_element": null,
        "num_elements": null,
        "postal_code": {
            "id": 10,
            "code": "00021",
            "country_id": "113",
            "country_code": "IT",
            "country_name": "Italy"
        }
    }
}

Ver todos los códigos postales desde la última modificación

$ curl -b cookies -c cookies -X GET  'https://api.adnxs.com/postal-code?min_last_modified=2017-06-28+15:02:37
{
    "response": {
        "status": "OK",
        "count": 8735,
        "start_element": null,
        "num_elements": null,
        "postal_codes": [{
            "id": 322567,
            "code": "2645-018",
            "active": true,
            "country_id": "186",
            "country_code": "PT",
            "country_name": "Portugal",
            "last_modified": "2017-06-26 15:39:18"
         },
         {
            "id": 322568,
            "code": "BS5 7XA",
            "active": true,
            "country_id": "80",
            "country_code": "GB",
            "country_name": "United Kingdom",
            "last_modified": "2017-06-26 15:39:18"
         },
         {
            "id": 322569,
            "code": "DE7 8HB",
            "active": true,
            "country_id": "80",
            "country_code": "GB",
            "country_name": "United Kingdom",
            "last_modified": "2017-06-26 15:39:18"
      },
      ...
    ]
  }
}
  • Last updated on