Recipient Location

Representa la dirección del destinatario final del paquete/shipment, o en otras palabras, el dropoff. Se representa por medio de diversos campos que deben de ser proporcionados por separado. Esto último es necesario para facilitar que los servicios de geocoding puedan, de forma automatizada, proporcionar ayuda adicional para determinar la localización exacta, en caso de que sea necesario; de igual forma, facilitan la visualización de la información por parte del repartidor.

Existen dos maneras de enviar la dirección:

• Por componentes, al enviar los campos por separado: street, number, administrativeArea, subAdministrativeArea, neighborhood. Esta es la manera recomendada ya que es la más precisa para obtener la latitud y longitud de la dirección.
• En una sola línea con los componentes incluidos a través del campo fullAddress

Envio por componentes

Campo	Tipo de dato	Requerido	Default
street	String	Si
number	String	Si
intNumber	String	No
administrativeArea	String	Si
subAdministrativeArea	String	Si
country	ENUM	No	MX
neighborhood	String	Si
postalCode	String	Si
lat	float	No
lng	float	No
notes	String	No
reference	String	No

Envio por fullAddress

Campo	Tipo de dato	Requerido	Default
fullAddress	String	Si
country	ENUM	No	MX
postalCode	String	Si
lat	float	No
lng	float	No
notes	String	No
reference	String	No

Descripción de los campos

Street

Nombre de la calle de la dirección del destinatario final. Solo debe de ser el nombre, el número se suministra en el campo number.

Ejemplos:

    Avenida Paseo de la Reforma

Number

El número de la calle provista en el campo street.

Ejemplos:

    347

intNumber

Para el caso de México, corresponde al número interior. También se utiliza para proveer el número de unidad, torre, conjunto, departamento, etc.

Ejemplos:

    201A

administrativeArea

Para el caso de México, corresponde a la ciudad o el estado.

Ejemplos:

    Ciudad de México
    CDMX
    Estado de México

subAdministrativeArea

Para el caso de México, corresponde a la alcaldía o municipio.

Ejemplos:

    Cuauhtémoc
    Miguel Hidalgo

country

País de destino expresado acorde al estándar ISO 3166-1 alpha-2.

Referencias:

• iso.org

Ejemplos:

   MX

neighborhood

Para el caso de México, corresponde al nombre de la colonia.

Ejemplos:

    Roma Norte

postalCode

Código postal.

Referencias:

• codigos postales

Ejemplos:

   06500

Notas:

En la presente versión, el código postal es el parámetro utilizado para determinar la cobertura. No se valida que los demás campos de dirección correspondan a los códigos postales, por lo cual se recomienda que se verifique esto previo a la integración.

Los demás campos de location son suministrados al repartidor, por lo que es importante garantizar tu veracidad y precisión.

lat

Latitud representado con un valor numérico en grados. Las latitudes en el hemisferio norte se representan con valores positivos, y las latitudes en el hemisferio sur se representan con valores negativos.

Ejemplos:

   19.4326

lng

Longitud representado con un valor numérico en grados. Las longitudes al oeste del meridiano de Greenwich se representan con valores negativos. y las que se encuentran al este del meridiano de Greenwich se representan con valores positivos.

Ejemplos:

   -99.1332

notes

Notas que sean de utilidad para que el repartidor realice una entrega exitosa.

Ejemplos:

   Dejar el paquete en la recepción

reference

Ayuda adicional que facilite al repartidor localizar la dirección.

Ejemplos:

    Entre Río Nazas y Río Pánuco

fullAddress

Direccion con todos los campos incluidos en una sola linea.

Ejemplos:

    Calle de Durango Numero 179 Interior 120, Roma Norte, Cuauhtémoc, 06700, CDMX.

Ejemplos

Ejemplo en formato JSON que hace uso de todos los campos

{
  "street": "Calle de Durango",
  "number": "179",
  "intNumber": "120",
  "administrativeArea": "CDMX",
  "subAdministrativeArea": "Cuauhtémoc",
  "country": "MX",
  "neighborhood": "Roma Norte",
  "postalCode": "06700",
  "lat": 19.4202411,
  "lng": -99.1674268,
  "notes": "Dejar con el portero,",
  "reference": "Enfrente de Fuente de Cibeles"
}

Ejemplo en formato JSON que hace uso solo de los campos requeridos

{
  "street": "Av. Paseo de la Reforma",
  "number": "350",
  "administrativeArea": "Ciudad de México",
  "subAdministrativeArea": "Cuauhtémoc",
  "neighborhood": "Juárez",
  "postalCode": "06600"
}

Ejemplo en formato JSON con fullAddress que hace uso de todos los campos

{
  "fullAddress": "Calle de Durango Numero 179 Interior 120, Roma Norte, Cuauhtémoc, 06700, CDMX",
  "country": "MX",
  "postalCode": "06700",
  "lat": 19.4202411,
  "lng": -99.1674268,
  "notes": "Dejar con el portero,",
  "reference": "Enfrente de Fuente de Cibeles"
}

Ejemplo en formato JSON con fullAddress que hace uso solo de los campos requeridos

{
  "fullAddress": "Calle de Durango Numero 179 Interior 120, Roma Norte, Cuauhtémoc, 06700, CDMX",
  "postalCode": "06700"
}