Notificaciones Pull

Contenidos

El Web Service del carrier debe proporcionar un endpoint HTTP REST contra el cuál Mercado Libre pueda consultar el estado actual de todas las agencias que el correo tiene disponibles por contrato.

POST service_url/agencies
Importante:
Para seguridad en agencias se utilizará OAuth 2.0

Formato Request

Dentro del body se enviará un objeto JSON con los campos listados a continuación:

NombreTipo de datoDescripciónTipo
country_idStringCódigo de país de acuerdo a la norma ISO 3166 Alpha-2.Mandatorio
carrier_informationNodoContiene elementos relevantes para el carrier.
carrier_information.userStringNombre de usuario para cuenta en el correo.Mandatorio
carrier_information.passwordStringPassword usuario para cuenta en el correo.Mandatorio

Formato Response

Se espera una lista de agencias habilitadas para Mercado Libre con sus correspondientes estados usando los siguientes campos:

NombreTipo de datoDescripciónTipo
agenciesNodoContiene una lista de agencias
agency_idStringIdentificador ú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_nameStringNombre de la agencia.Mandatorio
business_nameStringNombre empresarial de la agencia.Opcional
agency_typeStringTipo de agencia. Valores posibles place, agency y pickup_point. En general se utiliza agency, casos particulares serán pickup_point y place.Opcional
is_movableBooleanIdentificar 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
phoneStringNúmero telefónico de la agencia.Opcional
locationNodoContiene información relevante para su ubicación
location.country_nameStringNombre 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_nameStringNombre del estado.Mandatorio
location.city_nameStringNombre de la ciudad.Mandatorio
location.city_idStringId de la ciudad provisto por Mercado Libre.Opcional
location.neighborhood_nameStringBarrio de la agencia.Opcional
location.street_nameStringNombre de la calle de la agencia.Mandatorio
location.street_numberStringNúmero de calle de la agencia. Para calles sin número enviar "S/N".Mandatorio
location.other_infoStringInformación relevante para encontrar la agencia.Opcional
location.zip_codeStringCó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.geolocationNodoContiene información para la geolocalización
location.geolocation.latitudeDoubleLatitud. Ej: -34.611142. Presición mínima: 1 dígito.Mandatorio
location.gelolocation.longitudeDoubleLongitud. Ej: -58.520368. Presición mínima: 1 dígito. Mandatorio
package_receptionBooleanIndicador si la agencia puede recibir paquetes.Mandatorio
pickup_availabilityBooleanIndicador si se permite el retiro de paquetes en la agencia (aplica solo para envíos a agencia).Mandatorio
unlabeled_package_receptionBooleanIndica si la agencia puede recibir paquetes de devoluciones sin etiqueta.Opcional
open_hoursNodoContiene información relativa a los horarios en que opera la agencia.
open_hours.mondayArrayArray 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.tuesdayArrayArray 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.wednesdayArrayArray 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.thursdayArrayArray 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.fridayArrayArray 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.saturdayArrayArray 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.sundayArrayArray 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.holidaysArrayArray 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
statusStringEstado 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_dateDate (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_dateDate (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_idStringIdentificador ú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_capacityLongCapacidad diaria de la agencia para recibir paquetes en metros cúbicos.Opcional
package_capacityLongCapacidad diaria de la agencia en cantidad de paquetes que puede recibir.Mantadatorio si agency_type es PLACE
maximum_package_dimensionsNodoContiene información sobre las dimensiones y peso máximo que la agencia puede manejar.
maximum_package_dimensions.lengthLongLargo máximo soportado por paquete en centímetros.Opcional
maximum_package_dimensions.heightLongAlto máximo soportado por paquete en centímetros.Opcional
maximum_package_dimensions.widthLongAncho máximo soportado por paquete en centímetros.Opcional
maximum_package_dimensions.weightDoublePeso máximo soportado por paquete en gramos. Ej: 15000.0Opcional
delivery_cellBooleanIdentificar 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_capacityNodoContiene 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_capacityLongCapacidad diaria de la agencia en cantidad de paquetes que puede recibir.Opcional
delivery_cell_capacity.tuesday.max_capacityLongCapacidad diaria de la agencia en cantidad de paquetes que puede recibir.Opcional
delivery_cell_capacity.wednesday.max_capacityLongCapacidad diaria de la agencia en cantidad de paquetes que puede recibir.Opcional
delivery_cell_capacity.thursday.max_capacityLongCapacidad diaria de la agencia en cantidad de paquetes que puede recibir.Opcional
delivery_cell_capacity.friday.max_capacityLongCapacidad diaria de la agencia en cantidad de paquetes que puede recibir.Opcional
delivery_cell_capacity.saturday.max_capacityLongCapacidad diaria de la agencia en cantidad de paquetes que puede recibir.Opcional
delivery_cell_capacity.sunday.max_capacityLongCapacidad diaria de la agencia en cantidad de paquetes que puede recibir.Opcional

Ejemplos

Request:

{
  "country_id": "AR"
  "carrier_information": {
      "user": "",
      "password": ""
    }
  }
}

Response:

Response satisfactorio con open hours detallado:

{
    "agencies": [
        {
            "agency_id": "AAFF29",
            "agency_name": "AGENCIA PICK UP",
            "business_name": "AGENCIA PICK UP",
            "agency_type": "AGENCY",
            "is_movable": false
            "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": "09:00",
                        "to": "13:00"
                    },
                    {
                        "from": "15:00",
                        "to": "20: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 satisfactorio con open hours resumido:

{
    "agencies": [
        {
            "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
            }
        }
    ]
}

Failed (400 FAILED)

{
  "status":"FAILED",
  "status_message":"Invalid user"
}

Error (500 ERROR)

{
  "status":"ERROR",
  "status_message":"Internal error occurred"
}