Ryde Developers
English Panel ryde.us.com

Transporte

Entrega paquetes a Ryde para que los reparta. Esta es la superficie que un operador logístico o un marketplace integra una vez y luego olvida: consulta si un código postal tiene cobertura, envía un manifiesto de hasta 500 paquetes en una sola solicitud y sigue cada uno por su número de rastreo de Ryde hasta que se entregue, se rechace o se devuelva. Cada paquete responde con el mismo vocabulario de siete estados que espera un agregador de rastreo, así que el flujo que construyas aquí es el que tus clientes ya saben leer. El acceso requiere una organización transportista aprobada con un Acuerdo de Transporte de Ryde firmado; los precios vienen de la tarifa de ese acuerdo, no de una cotización por solicitud.

Versión de la API v1 · Ver como Markdown

Entrega paquetes a Ryde para que los reparta. Esta es la superficie que un operador logístico o un marketplace integra una vez y luego olvida: consulta si un código postal tiene cobertura, envía un manifiesto de hasta 500 paquetes en una sola solicitud y sigue cada uno por su número de rastreo de Ryde hasta que se entregue, se rechace o se devuelva. Cada paquete responde con el mismo vocabulario de siete estados que espera un agregador de rastreo, así que el flujo que construyas aquí es el que tus clientes ya saben leer. El acceso requiere una organización transportista aprobada con un Acuerdo de Transporte de Ryde firmado; los precios vienen de la tarifa de ese acuerdo, no de una cotización por solicitud.

Ciclo de vida

  CREATED               (we have the parcel's details, not the parcel)
     |
  AT HUB / SORTED       (it is at the depot it will be collected from)
     |
  COLLECTED             (a courier has it in hand, scanned at the depot)
     |
  OUT FOR DELIVERY      (the run has started; the recipient is told)
     |
  DELIVERED  <----+     (photo and recipient name are the proof)
     |            |
  ATTEMPTED ------+     (nobody home, refused, cannot reach the door;
     |                   it goes back on a later run)
  RETURNED TO HUB
     |
  RETURNED TO SHIPPER   (attempts exhausted, or you asked for it back)

  You may CANCEL at any point before a parcel is delivered or returned
  — including while it is already on a van.

Operaciones

GET /v1/coverage

Beta Requiere acuerdo de transporte Compatible con sandbox

Consulta si Ryde entrega en un código postal o un punto, y con qué niveles de servicio.

Operacióncheck_coverage
Alcancecoverage.read
DerechoRequiere acuerdo de transporte
IdempotenciaNo requerida
Herramienta MCPcheck_coverage

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/coverage' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/rates

Beta Requiere acuerdo de transporte Compatible con sandbox

Cotiza un paquete a una dirección con tu tarifa contratada, por nivel de servicio. No crea nada.

Operaciónquote_rates
Alcancecoverage.read
DerechoRequiere acuerdo de transporte
IdempotenciaNo requerida
Herramienta MCPquote_rates

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/rates' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

POST /v1/shipments

Beta Requiere acuerdo de transporte Compatible con sandbox

Entrega a Ryde un paquete para repartir. Devuelve su número de rastreo de Ryde.

Operacióncreate_shipment
Alcanceshipments.create
DerechoRequiere acuerdo de transporte
IdempotenciaCompatible
Herramienta MCPcreate_shipment

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/shipments' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

POST /v1/shipments/batch

Beta Requiere acuerdo de transporte Compatible con sandbox

Entrega a Ryde un manifiesto de hasta 500 paquetes en una sola solicitud. Cada fila informa creado, duplicado o rechazado con su motivo.

Operacióncreate_shipments_batch
Alcanceshipments.create
DerechoRequiere acuerdo de transporte
IdempotenciaCompatible
Herramienta MCPcreate_shipments_batch

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/shipments/batch' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

GET /v1/shipments/{tracking_number}

Beta Requiere acuerdo de transporte Compatible con sandbox

El estado actual de un paquete, con su historial de escaneos y la prueba de entrega una vez entregado.

Operaciónget_shipment
Alcanceshipments.read
DerechoRequiere acuerdo de transporte
IdempotenciaNo requerida
Herramienta MCPget_shipment

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/shipments/$tracking_number' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/shipments

Beta Requiere acuerdo de transporte Compatible con sandbox

Tus paquetes, del más reciente al más antiguo, filtrables por estado y fecha.

Operaciónlist_shipments
Alcanceshipments.read
DerechoRequiere acuerdo de transporte
IdempotenciaNo requerida
Herramienta MCPlist_shipments

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/shipments' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

POST /v1/shipments/{tracking_number}/cancel

Beta Requiere acuerdo de transporte Compatible con sandbox

Cancela un paquete que entregaste a Ryde, en cualquier momento antes de que se entregue o se devuelva.

Operacióncancel_shipment
Alcanceshipments.manage
DerechoRequiere acuerdo de transporte
IdempotenciaCompatible
Herramienta MCPcancel_shipment

Solicitud de ejemplo

curl -sX POST 'https://sandbox-api.ryde.us.com/v1/shipments/$tracking_number/cancel' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{ … }'

GET /v1/shipments/{tracking_number}/events

Beta Requiere acuerdo de transporte Compatible con sandbox

Todos los eventos registrados de un paquete, del más antiguo al más reciente: dónde se escaneó, cuándo y por qué falló un intento.

Operaciónlist_shipment_events
Alcanceshipments.read
DerechoRequiere acuerdo de transporte
IdempotenciaNo requerida
Herramienta MCPlist_shipment_events

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/shipments/$tracking_number/events' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"

GET /v1/hubs

Beta Requiere acuerdo de transporte Compatible con sandbox

Los depósitos desde donde se recogen tus paquetes.

Operaciónlist_hubs
Alcancecoverage.read
DerechoRequiere acuerdo de transporte
IdempotenciaNo requerida
Herramienta MCPlist_hubs

Solicitud de ejemplo

curl -s 'https://sandbox-api.ryde.us.com/v1/hubs' \
  -H "Authorization: Bearer $RYDE_ACCESS_TOKEN"