Comment on page
Location
This data is requested for both pickup and delivery. It contains the information of the address where the packages are to be picked up/delivered.
This object is the same for pickup, but for delivery, it varies depending on the country you are in. For Brazil, it is recommended to use the address by components in the delivery to have a better geolocation of the delivery.
Property | Type | Description | Required | Constraint | Example value |
---|---|---|---|---|---|
warehouse | number | warehouse id | YES | - | "J. J. Pérez 90, La Calera, Calera, Valparaíso, Chile" |
{
"warehouse": 9
}
Property | Type | Description | Required | Constraint | Example value |
---|---|---|---|---|---|
address | string | Main direction | YES | - | "J. J. Pérez 90, La Calera, Calera, Valparaíso, Chile" |
instructions | string | Location details, e.g. apartment number, house description, etc. | NO | - | Dpt. 403 |
lat | number | Address latitude | NO | - | -32.7894065 |
lng | number | Longitude of the given address | NO | - | -71.1897235 |
{
"address": "J. J. Pérez 90, La Calera, Calera, Valparaíso, Chile",
"instructions": "Dpt. 403"
"lat": -32.7894065,
"lng": -71.1897235,
}
For Brazil, a special object is used to better geolocate the address by components. Here it depends on the zip (only available for Brazil).
Property | Type | Description | Required | Constraint | Example value |
---|---|---|---|---|---|
address.zipcode | string | Postal code belonging to the address | YES | Solo se aceptan números | "60348450" |
address.neighborhood | string | Name of the neighborhood of the address | YES | - | "VILA VELHA" |
address.streetName | string | Name of the main street of the address | YES | - | "RUA 24,656" |
address.state | string | Name of the state of the address | YES | - | "CE" |
address.country | string | Name of country of address | YES | - | "Brazil" |
address.city | string | Name of the city of the address | YES | - | "FORTALEZA" |
instructions | string | Location details, e.g. apartment number, house description, etc. | NO | - | "CONJ DOS BANCARIOS - REF.ENDERECO: PROX A UPA" |
{
"address": {
"zipcode": "60348450",
"neighborhood": "VILA VELHA",
"streetName": "RUA 24,656",
"state": "CE",
"country": "Brazil",
"city": "FORTALEZA"
},
"instructions": "CONJ DOS BANCARIOS - REF.ENDERECO: PROX A UPA"
}
Last modified 1mo ago