Envíos y etiquetas
Cotiza, crea, actualiza y compra la etiqueta de un envío, y cancélala antes de la recogida.
Una etiqueta se compra por pasos: creas un envío, eliges una de sus tarifas y la compras. Hasta que compras, no se cobra nada y el envío todavía puede cambiar.
Cotiza antes de crear
Para mostrar precios antes de guardar nada, envía el envío que crearías al endpoint de tarifas. Responde con cada servicio disponible y su precio.
Crea el envío
accountId acepta el uid de la cuenta, su número de cuenta (CU…) o su número de cuenta externo. Pon en externalReferenceCode tu propio número de pedido para relacionar el envío con tu pedido.
La respuesta es el objeto Envío. Su parcel_rates lista los servicios con los que se puede enviar; cada tarifa tiene un uid.
Actualízalo
PATCH cambia solo los campos que envías. Envía el sender, el recipient o los parcels completos cuando cambies uno de ellos. Las tarifas se calculan de nuevo, así que lee las nuevas parcel_rates de la respuesta: un uid de tarifa anterior puede dejar de valer.
Compra la etiqueta
Para cada envío, manda su uid como shipmentId y el uid de la tarifa elegida como rateId, agrupados según cómo llegan los paquetes al transportista:
dropoff: los llevas tú a un punto de entrega.pickup: el transportista los recoge; envíapickupDateypickupTime.
Cómo se paga
La compra se registra en tu billetera de WeShipYou. Primero se usa tu saldo; solo el resto se cobra a paymentMethod, que es "credit_line" (cuentas con línea de crédito) o una tarjeta guardada como { "paymentMethodId": "pm_…" }. Puedes omitir paymentMethod cuando el saldo lo cubre todo.
Cómo leer la respuesta
La respuesta tiene una entrada por lote: fulfilled cuando se compraron todas las etiquetas del lote, rejected con un reason si no. Lee cada envío (GET /shipments/{shipmentId}) para obtener su número de rastreo en label.trackingNumber.
Cancelar una etiqueta
Una etiqueta que el transportista todavía no recogió se puede cancelar con su número de rastreo. Lo que pagaste por ella se acredita de vuelta en tu billetera de WeShipYou. Un 409 significa que el envío cambió de estado mientras se cancelaba: léelo de nuevo y reintenta si todavía se puede cancelar.
Eliminar un envío
Un envío que todavía no tiene etiqueta (estado created) se puede eliminar. Para cancelar uno cuya etiqueta ya está comprada, cancela la etiqueta.