Colecta

Contenidos

Cuando un vendedor solicita que recojan sus paquetes, el servicio del correo deberá contar con un endpoint de colecta donde Mercado Libre hará una solicitud POST.

Sin importar si la respuesta es satisfactoria o no, se espera que el servicio del correo devuelva un resultado de la solicitud de colecta de acuerdo a lo detallado en la sección Status Codes. En caso de error, se volverá a intentar la comunicación acorde al esquema de reintento definido en la integración.

Formato Request

POST service_url/book_pickup/booking_id

booking_id es el valor que utiliza Mercado Libre internamente como identificador de colecta. Representa un varchar con un máximo de 80 caracteres.

{
                  "carrier_id": 50401,
                  "site_id": "MLA",
                  "timeframe": {
                    "from": "2016-11-16T08:00:00.000-04:00",
                    "to": "2016-11-16T12:00:00.000-04:00"
                  },
                  "carrier_information": {
                    "contract": "000123ABC87",
                    "client_id": "432765637",
                    "account": "A432765637",
                    "password": "pa$word"
                  },
                  "shipment_information": {
                    "packages": [
                      {
                        "shipment_id": 123141251235,
                        "tracking_number": "1234NLUG123",
                        "dimensions": {
                          "height": 8,
                          "length": 25,
                          "width": 11,
                          "weight": 450
                        }
                      },
                      {
                        "shipment_id": 3288374823041,
                        "tracking_number": "NKNL12312lNM",
                        "dimensions": {
                          "height": 6,
                          "length": 12,
                          "width": 30,
                          "weight": 1000
                        }
                      }
                    ],
                    "contact": {
                      "email": "segundo@mercadolibre.com.ar",
                      "first_name": "John",
                      "last_name": "Doe",
                      "full_name": "John Doe",
                      "phone": {
                        "area_code": "11",
                        "extension": "",
                        "number": "9012345678"
                      },
                      "address": {
                        "street_name": "Calle Falsa",
                        "street_number": "1500",
                        "address_line": "Calle Falsa 1500",
                        "geolocation": {
                          "geolocation_type": "ROOFTOP",
                          "latitude": 123.123144,
                          "longitude": -12.898738
                        }
                        "zip_code": "39560000",
                        "city": {
                          "id": "CBA",
                          "name": "Cordoba"
                        },
                        "comment": "null",
                        "country": {
                          "id": "AR",
                          "name": "Argentina"
                        },
                        "municipality": {
                          "id": "null",
                          "name": "null"
                        },
                        "neighborhood": {
                          "id": "null",
                          "name": "Ciudad Empresaria"
                        },
                        "state": {
                          "id": "CBA",
                          "name": "Cordoba"
                        }
                      }
                    }
                  }
                }

Formato Response

Dentro del body, el sistema devolverá todos los datos resultantes de la cancelación, listados a continuación:

Status Codes

Ejemplos

Request:

POST https://carrierA/book_pickup/MzM3OTczMTM5fDIwMTgtMDctMjZ8MTc1MDA1NDA

{
                  'carrier_id': 12345,
                  'site_id': 'MLM',
                  'timeframe': {
                    'from': '2018-07-26T15:00:00-05:00',
                    'to': '2018-07-26T18:00:00-05:00'
                  },
                  'carrier_information': {
                    'contract': '1234567',
                    'password': '2h3j4jsj28wi',
                    'client_id': 'xxxxxxx'
                  },
                  'shipment_information': {
                    'packages': [
                      {
                        'shipment_id': 27655092054,
                        'tracking_number': 'ASDfgh123esd',
                        'dimensions': {
                          'height': 10.0,
                          'width': 10.0,
                          'length': 15.0,
                          'weight': 500.0
                        }
                      },
                      {
                        'shipment_id': 27655083639,
                        'tracking_number': ASDfgh123adf,
                        'dimensions': {
                          'height': 10.0,
                          'width': 10.0,
                          'length': 15.0,
                          'weight': 500.0
                        }
                      }
                    ],
                    'contact': {
                      'nickname': 'TESTMUK7QXY0',
                      'first_name': 'Test',
                      'last_name': 'Test',
                      'email': 'test.test@correo.com',
                      'phone': {
                        'area_code': '01',
                        'number': '01',
                        'extension': '01'
                      },
                      'address': {
                        'address_line': 'Testing Street 1450',
                        'street_name': 'Testing Street',
                        'street_number': '1450',
                        'comment': 'Referencia: The Testing Cavern',
                        'zip_code': '45200',
                        'city': {
                          'id': 'TUxNQ1pBUDM4NzE',
                          'name': 'Zapopan'
                        },
                        'state': {
                          'id': 'MX-JAL',
                          'name': 'Jalisco'
                        },
                        'country': {
                          'id': 'MX',
                          'name': 'Mexico'
                        },
                        'neighborhood': {
                          'id': '',
                          'name': 'The Neighborhood'
                        },
                        'municipality': {
                          'id': '',
                          'name': 'N/A'
                        },
                        'geolocation': {
                          'geolocation_type': 'APPROXIMATE',
                          'latitude': 20.6719563,
                          'longitude': -103.416501
                        }
                      },
                      'full_name': 'Test Test'
                    }
                  },
                  'test': true
                }

Response:

Booked (200 OK)

{
                  "status":"BOOKED",
                  "status_message":"",
                  "confirmation_code": "AD198312OK"
                }

Failed (400 FAILED)

{
                  "status":"FAILED",
                  "status_message":"Invalid pickup up date"
                }

Error (500 ERROR)

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