/shipping/v1/{shipment_id}Cambiar datos de envío
El endpoint /shipping/v1/{shipment_id} se utilizará para actualizar la dirección de entrega de un envío.
Consideraciones
Antes de crear una solicitud de cambio de domicilio, consulta el envío con el endpoint Obtener envío. Si el campo can_update_address es true, podrás solicitar el cambio de dirección. Si es false, el envío no permite actualizar la dirección en ese momento.
La disponibilidad puede depender de reglas de la transportadora y del estado actual del envío. No infieras esta posibilidad a partir de status o status_detail.
No podrás crear otra solicitud de cambio de domicilio para un envío mientras tenga una pendiente.
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:
- PENDING_UPDATE_ADDRESS: esperando la respuesta de la transportadora.
- CONFIRMED_UPDATE_ADDRESS: la transportadora nos confirmó el cambio de domicilio de envío.
- REJECTED_UPDATE_ADDRESS: la transportadora rechazó el cambio de domicilio de envío.
Si rechazan tu solicitud seguirás viendo el domicilio de envío original.
Parámetros disponibles
application/jsonDetalle de respuestas
{
"address": {
"street_name": "Libertador",
"street_number": "539",
"floor": "2",
"apartment": "B",
"city": "Buenos Aires",
"region": "Buenos Aires",
"country": "Argentina",
"zip_code": "5346",
"neighborhood": "example_value",
"additional_info": "Torre 2. Casa amarilla"
}
}curl -X PATCH "https://api.pomelo.la/shipping/v1/{shipment_id}" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-idempotency-key: fRwX12Dg3345AD" \
-d '{
"address": {
"street_name": "Libertador",
"street_number": "539",
"floor": "2",
"apartment": "B",
"city": "Buenos Aires",
"region": "Buenos Aires",
"country": "Argentina",
"zip_code": "5346",
"neighborhood": "example_value",
"additional_info": "Torre 2. Casa amarilla"
}
}'{
"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
}