/shipping/v1/{shipment_id}/status

Actualizar estado del envío

El endpoint POST /shipping/v1/{shipment_id}/status te permite reportarnos el estado actual de un envío externo, es decir, un envío que no pasa por nuestra solución de logística (shipment_type EXTERNAL_SINGLE_CARD).

Consideraciones

Solo podrás actualizar envíos externos que te pertenezcan. Si el envío no es de tipo EXTERNAL_SINGLE_CARD o no te pertenece, rechazaremos la solicitud.

Puedes reportar cualquier combinación válida de status/status_detail del catálogo de estados, sin restricción sobre la transición (no es necesario respetar un orden o secuencia particular). Consulta el catálogo completo en la guía de envíos.

Cada actualización de estado dispara automáticamente la notificación (webhook) configurada para tu integración. También puedes consultar el estado actual en cualquier momento con el endpoint Obtener envío.

Parámetros disponibles

Header Parameters
AuthorizationString
Path Parameters
shipment_idString
Cuerpo de solicitud
application/json
statusstring
status_detailstring

Detalle de respuestas

401
No autorizado
403
Acceso denegado

Ejemplo de solicitud
{
  "status": "IN_TRANSIT",
  "status_detail": "DISTRIBUTION"
}
Ejemplo de código
curl -X POST "https://api.pomelo.la/shipping/v1/example_value/status" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "status": "IN_TRANSIT",
  "status_detail": "DISTRIBUTION"
}'
Ejemplo de respuesta (200)Estado actualizado
{
  "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
}

Pomelo AI

Asistente de inteligencia artificial para consultas sobre la API de Pomelo
¡Hola!¿Cómo puedo ayudarte hoy?