Notificaciones Push
Contenidos
Cuando tiene un cambio en la agencia, el servicio del correo deberá informar mediante una notificación push.
Formato Request
Se enviará un mensaje con la siguiente estructura:
POST 'https://api.mercadolibre.com/agencies/{country_id}/{agency_id}/push' \ --header 'Authorization: Bearer {accessToken}'| Nombre | Descripción |
|---|---|
| country_id | Código de país de acuerdo a la norma ISO 3166 Alpha-2. |
| agency_id | Identificador único de agencia. Permite sólo valores alfanuméricos (sin caracteres especiales ni espacios) Pattern: [A-Z][a-z][0-9]. |
| accessToken | Token de acceso liberado por el Mercado Libre al carrier. |
Los atributos del body se explican en la siguiente tabla:
| Nombre | Tipo de dato | Descripción | Tipo |
|---|---|---|---|
| agency_id | String | Identificador único de agencia. Permite sólo valores alfanuméricos (sin caracteres especiales ni espacios) Pattern: [A-Z][a-z][0-9]. No vacío. | Mandatorio |
| agency_name | String | Nombre de la agencia. | Mandatorio |
| business_name | String | Nombre empresarial de la agencia. | Opcional |
| agency_type | String | Tipo de agencia. Valores posibles place, agency y pickup_point. En general se utiliza agency, casos particulares serán pickup_point y place. | Opcional |
| is_movable | Boolean | Identificar si una agencia es un punto móvil o fijo. Valores: true ó false. Se puede marcar en true solo para agencias de tipo place. | Opcional |
| phone | String | Número telefónico de la agencia. | Opcional |
| location | Nodo | Contiene información relevante para su ubicación | |
| location.country_name | String | Nombre del país en el que opera. Valores Posibles: Argentina, Chile, Uruguay, Brasil, Peru, Colombia o Mexico. Es sensible a mayúsculas y minúsculas. | Mandatorio |
| location.state_name | String | Nombre del estado. | Mandatorio |
| location.city_name | String | Nombre de la ciudad. | Mandatorio |
| location.city_id | String | Id de la ciudad provisto por Mercado Libre. | Opcional |
| location.neighborhood_name | String | Barrio de la agencia. | Opcional |
| location.street_name | String | Nombre de la calle de la agencia. | Mandatorio |
| location.street_number | String | Número de calle de la agencia. Para calles sin número enviar "S/N". | Mandatorio |
| location.other_info | String | Información relevante para encontrar la agencia. | Opcional |
| location.zip_code | String | Código postal de la agencia. Valores posibles de longitud de Zip Codes: para Argentina 4, para Chile N/A, para Uruguay N/A, para Brasil 8, para Perú N/A, para Colombia N/A y para México 5. | Mandatorio sí el país utiliza códigos postales |
| location.geolocation | Nodo | Contiene información para la geolocalización | |
| location.geolocation.latitude | Double | Latitud. Ej: -34.611142. Presición mínima: 1 dígito. | Mandatorio |
| location.gelolocation.longitude | Double | Longitud. Ej: -58.520368. Presición mínima: 1 dígito. | Mandatorio |
| package_reception | Boolean | Indicador si la agencia puede recibir paquetes. | Mandatorio |
| pickup_availability | Boolean | Indicador si se permite el retiro de paquetes en la agencia (aplica solo para envíos a agencia). | Mandatorio |
| unlabeled_package_reception | Boolean | Indica si la agencia puede recibir paquetes de devoluciones sin etiqueta. | Opcional |
| open_hours | Nodo | Contiene información relativa a los horarios en que opera la agencia. | |
| open_hours.monday | Array | Array que contiene n nodos con dos claves from y to especificando horario de apertura y cierre, puede haber tantos horarios como trabaja la agencia. Valores válidos HH:mm ("00:00" valor mínimo y "23:59" valor máximo). El valor numérico del 'To' debe ser mayor al de 'From'. Para días sin apertura de la Agencia enviar array nulo. | Opcional |
| open_hours.tuesday | Array | Array que contiene n nodos con dos claves from y to especificando horario de apertura y cierre, puede haber tantos horarios como trabaja la agencia. Valores válidos HH:mm ("00:00" valor mínimo y "23:59" valor máximo). El valor numérico del 'To' debe ser mayor al de 'From'. Para días sin apertura de la Agencia enviar array nulo. | Opcional |
| open_hours.wednesday | Array | Array que contiene n nodos con dos claves from y to especificando horario de apertura y cierre, puede haber tantos horarios como trabaja la agencia. Valores válidos HH:mm ("00:00" valor mínimo y "23:59" valor máximo). El valor numérico del 'To' debe ser mayor al de 'From'. Para días sin apertura de la Agencia enviar array nulo. | Opcional |
| open_hours.thursday | Array | Array que contiene n nodos con dos claves from y to especificando horario de apertura y cierre, puede haber tantos horarios como trabaja la agencia. Valores válidos HH:mm ("00:00" valor mínimo y "23:59" valor máximo). El valor numérico del 'To' debe ser mayor al de 'From'. Para días sin apertura de la Agencia enviar array nulo. | Opcional |
| open_hours.friday | Array | Array que contiene n nodos con dos claves from y to especificando horario de apertura y cierre, puede haber tantos horarios como trabaja la agencia. Valores válidos HH:mm ("00:00" valor mínimo y "23:59" valor máximo). El valor numérico del 'To' debe ser mayor al de 'From'. Para días sin apertura de la Agencia enviar array nulo. | Opcional |
| open_hours.saturday | Array | Array que contiene n nodos con dos claves from y to especificando horario de apertura y cierre, puede haber tantos horarios como trabaja la agencia. Valores válidos HH:mm ("00:00" valor mínimo y "23:59" valor máximo). El valor numérico del 'To' debe ser mayor al de 'From'. Para días sin apertura de la Agencia enviar array nulo. | Opcional |
| open_hours.sunday | Array | Array que contiene n nodos con dos claves from y to especificando horario de apertura y cierre, puede haber tantos horarios como trabaja la agencia. Valores válidos HH:mm ("00:00" valor mínimo y "23:59" valor máximo). El valor numérico del 'To' debe ser mayor al de 'From'. Para días sin apertura de la Agencia enviar array nulo. | Opcional |
| open_hours.holidays | Array | Array que contiene n nodos con dos claves from y to especificando horario de apertura y cierre en días feriados, puede haber tantos horarios como trabaja la agencia. Valores válidos HH:mm ("00:00" valor mínimo y "23:59" valor máximo). El valor numérico del 'To' debe ser mayor al de 'From'. Para días sin apertura de la Agencia enviar array nulo. | Opcional |
| status | String | Estado actual de la agencia. Valores posibles ACTIVE,INACTIVE,ACTIVATION_PENDING. En el caso de que la Agencia este inactive, se podría no enviar. | Mandatorio |
| activation_date | Date (ISO 8601) | Fecha de Activación. Valores válidos: en UTC 2001-07-04T12:08:56.235Z o en hora local relativa 2001-07-04T12:08:56.235-07:00. | Opcional |
| deactivation_date | Date (ISO 8601) | Fecha de Desactivación. Valores válidos: en UTC 2001-07-04T12:08:56.235Z o en hora local relativa 2001-07-04T12:08:56.235-07:00. | Opcional |
| replacement_agency_id | String | Identificador único de la agencia que va a reemplazar a la agencia que contiene este campo. Permite sólo valores alfanuméricos (sin caracteres especiales ni espacios) Pattern: [A-Z][a-z][0-9]. No vacío. | Opcional |
| volumetric_capacity | Long | Capacidad diaria de la agencia para recibir paquetes en metros cúbicos. | Opcional |
| package_capacity | Long | Capacidad diaria de la agencia en cantidad de paquetes que puede recibir. | Mantadatorio si agency_type es PLACE |
| maximum_package_dimensions | Nodo | Contiene información sobre las dimensiones y peso máximo que la agencia puede manejar. | |
| maximum_package_dimensions.length | Long | Largo máximo soportado por paquete en centímetros. | Opcional |
| maximum_package_dimensions.height | Long | Alto máximo soportado por paquete en centímetros. | Opcional |
| maximum_package_dimensions.width | Long | Ancho máximo soportado por paquete en centímetros. | Opcional |
| maximum_package_dimensions.weight | Double | Peso máximo soportado por paquete en gramos. Ej: 15000.0 | Opcional |
| delivery_cell | Boolean | Identificar si una agencia posee el servicio de delivery cell. Valores: true ó false. Se puede marcar en true solo para agencias de tipo place. | Opcional |
| delivery_cell_capacity | Nodo | Contiene información relativa a las capacidades diarias del servicio de delivery cell de la agencia. Solo aplica si la agencia posee el servicio encendido. | Opcional |
| delivery_cell_capacity.monday.max_capacity | Long | Capacidad diaria de la agencia en cantidad de paquetes que puede recibir. | Opcional |
| delivery_cell_capacity.tuesday.max_capacity | Long | Capacidad diaria de la agencia en cantidad de paquetes que puede recibir. | Opcional |
| delivery_cell_capacity.wednesday.max_capacity | Long | Capacidad diaria de la agencia en cantidad de paquetes que puede recibir. | Opcional |
| delivery_cell_capacity.thursday.max_capacity | Long | Capacidad diaria de la agencia en cantidad de paquetes que puede recibir. | Opcional |
| delivery_cell_capacity.friday.max_capacity | Long | Capacidad diaria de la agencia en cantidad de paquetes que puede recibir. | Opcional |
| delivery_cell_capacity.saturday.max_capacity | Long | Capacidad diaria de la agencia en cantidad de paquetes que puede recibir. | Opcional |
| delivery_cell_capacity.sunday.max_capacity | Long | Capacidad diaria de la agencia en cantidad de paquetes que puede recibir. | Opcional |
Ejemplo
Body Request:
{
"agency_id": "AAFF29",
"agency_name": "AGENCIA PICK UP",
"business_name": "AGENCIA PICK UP",
"agency_type": "AGENCY",
"location": {
"country_name": "Argentina",
"state_name": "Córdoba",
"city_name": "Córdoba",
"city_id": "TUxBQ0NBUGNiZGQx",
"neighborhood_name": "",
"street_name": "Av. Colón",
"street_number": "176",
"other_info": "",
"zip_code": "5000",
"geolocation": {
"latitude": -10.4343768,
"longitude": -10.42437
}
},
"package_reception": true,
"pickup_availabilty": true,
"open_hours": {
"monday": [
{
"from": "00:00",
"to": "23:59"
}
],
"tuesday": [
{
"from": "08:00",
"to": "12:00"
},
{
"from": "14:00",
"to": "19:00"
}
],
"wednesday": [
{
"from": "08:00",
"to": "12:00"
},
{
"from": "14:00",
"to": "19:00"
}
],
"thursday": [
{
"from": "08:00",
"to": "12:00"
},
{
"from": "14:00",
"to": "19:00"
}
],
"friday": [
{
"from": "08:00",
"to": "12:00"
},
{
"from": "14:00",
"to": "19:00"
}
],
"saturday": [
{
"from": "08:00",
"to": "12:00"
},
{
"from": "14:00",
"to": "19:00"
}
],
"sunday": null,
"holidays": null
},
"delivery_cell": true,
"delivery_cell_capacity": {
"monday": {
"max_capacity": 20
},
"tuesday": {
"max_capacity": 20
},
"wednesday": {
"max_capacity": 20
},
"thursday": {
"max_capacity": 20
},
"friday": {
"max_capacity": 20
},
"saturday": {
"max_capacity": 0
},
"sunday": {
"max_capacity": 0
}
},
"status": "active",
"activation_date": "2017-08-15T12:10:32.000-04:00",
"deactivation_date": "2019-10-17T00:00:00.000-04:00",
"replacement_agency_id": "BB223",
"package_capacity": 3000,
"volumetric_capacity": 25000,
"maximum_package_dimensions": {
"length": 101,
"height": 101,
"width": 101,
"weight": 25000.0
}
}Response:
Satisfactioria (200 OK)
{
"status": "OK",
"message": "Pushed the changes to be processed"
}Failed (400 FAILED)
{
"status": "FAILED",
"message": "The country_id does not exists",
"error_code": "missing_country_id"
}Error (500 ERROR)
{
"status": "ERROR",
"message": "An unexpected error has occurred"
}