POST
/shipping/v1/{shipment_id}/receiverSolicitar datos del receptor
El endpoint /shipping/v1/{shipment_id}/receiver te permite solicitar los datos de quien recibió el envío.
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.
Para ver los datos del receptor de la tarjeta, interactúa nuevamente con el endpoint Obtener envío y lee el campo received_by que se encuentra dentro de courier_additional_info.
Parámetros disponibles
Header Parameters
AuthorizationStringrequired
Path Parameters
shipment_idStringrequired
Detalle de respuestas
401
No autorizado
403
Acceso denegado
Ejemplo de código
curl -X POST "https://api.pomelo.la/shipping/v1/example_value/receiver" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY"Ejemplo de respuesta (200)Solicitud recibida
{
"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"
},
"request_status": "PENDING_UPDATE_ADDRESS"
}