/shipping/v1/{shipment_id}/receiverSolicitar datos del receptor
El endpoint POST /shipping/v1/{shipment_id}/receiver te permite solicitarle a la transportadora los datos de quien recibió el envío (comprobante de entrega).
Consideraciones
No podrás crear una solicitud mientras haya una pendiente para ese mismo shipment_id.
Para consultar el estado de la solicitud, tendrás que interactuar con el endpoint Obtener envío. En el campo request_status verás uno de los siguientes valores:
- REQUESTED_RECEIVER_DATA: esperando que la transportadora nos comparta los datos del receptor del envío.
- GOT_RECEIVER_DATA: la transportadora nos compartió los datos del receptor del envío.
- MISSING_RECEIVER_DATA: la transportadora no pudo compartirnos los datos del receptor del envío.
Ten en cuenta que request_status indica el estado de una solicitud iniciada con este endpoint. Algunas transportadoras nos comparten el comprobante directamente vía webhook al momento de la entrega, sin necesidad de solicitarlo; en esos casos request_status puede no estar en GOT_RECEIVER_DATA aunque el comprobante esté disponible.
Cómo obtener el comprobante del receptor
Para saber si un envío tiene un comprobante disponible, consulta el endpoint Obtener envío y revisa el campo has_receiver_info. Cuando es true, el comprobante está disponible y podrás consultarlo con GET /shipping/v1/{shipment_id}/receiver.
El formato del comprobante depende de la transportadora y se indica en el campo receiver_data_type. Según su valor, el endpoint GET /shipping/v1/{shipment_id}/receiver devolverá el contenido en uno de los siguientes campos:
TEXT: el comprobante viene en el campotext.IMAGE_BASE64: el comprobante viene en el campoimage, codificado en Base64.HTML_BASE64: el comprobante viene en el campohtml, codificado en Base64. Debes decodificarlo para obtener el documento HTML original con la información de entrega.
Cada transportadora nos entrega la información en un formato distinto (texto, imagen o HTML), por lo que no exponemos un campo estructurado received_by de forma consistente para todas. Para obtener los datos del receptor, interpreta el contenido del comprobante (text, image o html) según el valor de receiver_data_type. El campo received_by dentro de courier_additional_info solo estará presente cuando la transportadora nos comparta ese dato de forma separada; en caso contrario vendrá vacío.
Parámetros disponibles
Detalle de respuestas
curl -X POST "https://api.pomelo.la/shipping/v1/example_value/receiver" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY"{
"id": "shi-23hJL4bm94q9BFEd2sGhBjY6xbH",
"external_tracking_id": "f923da123",
"status": "CREATED",
"status_detail": "CREATED",
"shipment_type": "SINGLE_CARD",
"affinity_group_id": "afg-20MpN8vmIPj77ujhb9cS8ctstN2",
"affinity_group_name": "Pomelo Nominate Basic Physical",
"courier": {
"company": "ANDREANI",
"tracking_url": "https://www.api.qa.com/#!/informacionEnvio/360000070874590"
},
"country_code": "ARG",
"created_at": "2020-07-10 15:00:00.000",
"batch": {
"id": "bch-23WEkAaZsqubbke9pYVAt9sG81e",
"quantity": 100,
"has_stock": true,
"status": "PENDING"
},
"address": {
"street_name": "Libertador",
"street_number": "539",
"floor": "2",
"apartment": "B",
"city": "Buenos Aires",
"region": "Buenos Aires",
"country": "Argentina",
"zip_code": "5346",
"neighborhood": "string",
"additional_info": "Torre 2. Casa amarilla"
},
"receiver": {
"full_name": "Gonzalo Iglesias",
"email": "[email protected]",
"document_type": "dni",
"document_number": "243432423",
"tax_identification_number": "38912151888",
"telephone_number": "53454342"
},
"user_id": "usr-20MpN8vmIPj77ujhb9cS8ctstN2",
"due_delivery_date": "2020-07-20T00:00:00.000Z",
"courier_additional_info": {
"status": "ENTREGA",
"status_detail": "ENTREGA CERTIFICADA",
"received_by": "Franco Iglesias"
},
"has_receiver_info": true,
"receiver_data_type": "HTML_BASE64",
"request_status": "PENDING_UPDATE_ADDRESS",
"can_update_address": true
}