Recipient Location

It represents the address of the final recipient of the package/shipment, or in other words, the dropoff. It is represented by various fields that must be provided separately. The latter is necessary to make it easier for geocoding services to automatically provide additional help to determine the exact location, if necessary; In the same way, they facilitate the visualization of the information by the dealer.

There are two ways to send the address:

• By components, sending the fields separately: street, number, administrativeArea, subAdministrativeArea, neighborhood. This is the recommended way as it's the most precise method to obtain the latitude and longitude of the address.
• In a single line with components included through the fullAddress field.

By components

Field	Data type	Required	Default
street	String	Yes
number	String	Yes
intNumber	String	No
administrativeArea	String	Yes
subAdministrativeArea	String	Yes
country	ENUM	No	MX
neighborhood	String	Yes
postalCode	String	Yes
lat	float	No
lng	float	No
notes	String	No
reference	String	No

By fullAddress

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

Fields description

Street

Street name of the final consignee address. It should only be the name, the number is supplied in the number field.

Example:

Street name of the final recipient address. It should only be the name, the number is supplied in the number field.

Examples:

    Avenida Paseo de la Reforma

Number

The street number provided in the street field.

Example:

    347

intNumber

In the case of Mexico, it corresponds to the interior number. It is also used to provide the number of a unit, tower, complex, department, etc.

Example:

    201A

administrativeArea

In the case of Mexico, it corresponds to the city or state.

Example:

    Ciudad de México
    CDMX
    Estado de México

subAdministrativeArea

In the case of Mexico, it corresponds to the mayor's office or municipality.

Example:

    Cuauhtémoc
    Miguel Hidalgo

country

Country of destination expressed according to the ISO 3166-1 alpha-2 standard.

References:

• iso.org

Example:

   MX

neighborhood

In the case of Mexico, it corresponds to the name of the colony.

Example:

    Roma Norte

postalCode

Postal Code.

References:

• zip codes

Example:

   06500

Note:

In this version, the postal code is the parameter used to determine coverage. It is not validated that the other address fields correspond to postal codes, so it is recommended that this be verified prior to integration.

The other location fields are provided to the dealer, so it is important to guarantee their veracity and accuracy.

lat

Latitude represented as a numeric value in degrees. Latitudes in the Northern Hemisphere are represented with positive values, and latitudes in the Southern Hemisphere are represented with negative values.

Example:

   19.4326

lng

Longitude represented as a numeric value in degrees. Longitudes west of the Greenwich meridian are represented with negative values. and those that are to the east of the Greenwich meridian are represented with positive values.

Example:

   -99.1332

notes

Notes that are useful for the delivery person to make a successful delivery.

Example:

   Dejar el paquete en la recepción

reference

Additional help that makes it easier for the delivery person to locate the address.

Example:

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

fullAddress

Address with all the fields included in a single line.

Example:

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

Example

Example in JSON format that makes use of all the fields

{
  "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"
}

Example in JSON format that makes use of only the required fields

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

Example in JSON format with fullAddress making use of all fields

{
  "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"
}

Example in JSON format with fullAddress making use of only the required fields

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