Operar · Modificaciones
Pregunta primero; modifica sólo lo que la red admite.
La política se calcula para cada envío, conexión, ambiente y estado. No asumas que dos transportistas permiten los mismos cambios.
/v1/shipments/{shipment_id}/modification-policyConsulta la política actual
Haz esta consulta inmediatamente antes de mostrar o enviar un cambio. Revisa available, editable_fields, los estados admitidos y reason_code. La política puede cambiar cuando avanza el envío.
curl --request GET \
--url "$API_BASE_URL/v1/shipments/$SHIPMENT_ID/modification-policy" \
--header "Authorization: Bearer $SENDINGBAY_API_TOKEN"{
"shipment_id": "94fd60e9-3b61-4d2e-bf14-bebd25e3aab1",
"available": true,
"current_status": "created",
"editable_fields": ["external_reference", "package_weights_kg"],
"allowed_statuses": ["accepted", "created"],
"reason_code": null,
"conditions": ["No se puede cambiar la cantidad de bultos; solo su peso."]
}Cuando no esté disponible, reason_code será uno de: capability_not_enabled, carrier_not_implemented, shipment_snapshot_unavailable, status_not_editable o no_editable_fields.
/v1/shipments/{shipment_id}/modificationsAplica una modificación idempotente
Puedes enviar el destinatario completo, un peso por cada bulto existente o una nueva referencia externa, siempre que aparezcan eneditable_fields. No se permite agregar ni quitar bultos.
curl --request POST \
--url "$API_BASE_URL/v1/shipments/$SHIPMENT_ID/modifications" \
--header "Authorization: Bearer $SENDINGBAY_API_TOKEN" \
--header "Content-Type: application/json" \
--header "Idempotency-Key: correccion-pedido-1000-v1" \
--data '{
"external_reference": "ORDER-1000-CORRECTED",
"package_weights_kg": [1.5]
}'Evidencia disponible por red
| Red | Restricción conocida |
|---|---|
| Correos | Soporte confirmado por proveedor; campos y ventana dependen del producto y estado. |
| Sending | Soporte confirmado; alcance sujeto a la cuenta contratada. |
| GLS | Soporte parcial: solo se confirmó una modificación limitada de peso. |
| Ontime | Evidencia histórica parcial; requiere recertificación. |
Consulta también el catálogo vivo. Que el proveedor documente una operación no significa que el adaptador del Conector esté habilitado.