Referencia · OpenAPI
El contrato público, dentro del portal.
Este índice se genera desde el mismo OpenAPI que alimenta el cliente TypeScript. Si una operación no aparece aquí ni en el contrato descargable, no forma parte de la API pública.
Versión0.1.0
Rutas públicas31
Operaciones34
Descargar OpenAPI JSONServicio y disponibilidad
GET/Identificar el servicio
- Autenticación
- No requerida
- Respuestas declaradas
- 200
- operationId
service_info__get
GET/health/liveComprobar que el proceso está vivo
- Autenticación
- No requerida
- Respuestas declaradas
- 200
- operationId
liveness_health_live_get
GET/health/readyComprobar que el proceso está listo
- Autenticación
- No requerida
- Respuestas declaradas
- 200, 503
- operationId
readiness_health_ready_get
Catálogo del cliente
GET/v1/articlesListar artículos canónicos disponibles
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403
- operationId
list_articles_v1_articles_get
GET/v1/carrier-connectionsListar conexiones disponibles
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403
- operationId
list_connections_v1_carrier_connections_get
GET/v1/carrier-connections/{connection_id}/articlesListar artículos y restricciones de una conexión
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 422
- operationId
list_connection_articles_v1_carrier_connections__connection_id__articles_get
GET/v1/carrier-connections/{connection_id}/originsListar códigos de origen configurados para una conexión
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 422
- operationId
list_connection_origins_v1_carrier_connections__connection_id__origins_get
GET/v1/carriersListar transportistas integrados
- Autenticación
- No requerida
- Respuestas declaradas
- 200
- operationId
list_public_carriers_v1_carriers_get
Envíos y seguimiento
POST/v1/shipmentsCrear un envío
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 201, 401, 403, 404, 409, 422, 503
- operationId
create_shipment_v1_shipments_post
GET/v1/shipments/{shipment_id}Consultar un envío
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 422
- operationId
get_shipment_v1_shipments__shipment_id__get
GET/v1/shipments/{shipment_id}/incident-policyConsultar qué incidencias pueden reportarse para un envío
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 422
- operationId
get_incident_reporting_policy_v1_shipments__shipment_id__incident_policy_get
GET/v1/shipments/{shipment_id}/incidentsListar las incidencias de un envío
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 422
- operationId
list_incidents_v1_shipments__shipment_id__incidents_get
POST/v1/shipments/{shipment_id}/incidentsReportar una incidencia al transportista
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 201, 401, 403, 404, 409, 422, 503
- operationId
report_incident_v1_shipments__shipment_id__incidents_post
GET/v1/shipments/{shipment_id}/incidents/{incident_id}Consultar una incidencia de un envío
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 422
- operationId
get_incident_v1_shipments__shipment_id__incidents__incident_id__get
POST/v1/shipments/{shipment_id}/label-recoveryRecuperar una etiqueta diferida
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 409, 422, 503
- operationId
recover_shipment_label_v1_shipments__shipment_id__label_recovery_post
GET/v1/shipments/{shipment_id}/modification-policyConsultar qué puede modificarse en un envío
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 422
- operationId
get_shipment_modification_policy_v1_shipments__shipment_id__modification_policy_get
POST/v1/shipments/{shipment_id}/modificationsModificar campos admitidos de un envío
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 201, 401, 403, 404, 409, 422, 503
- operationId
modify_shipment_v1_shipments__shipment_id__modifications_post
GET/v1/shipments/{shipment_id}/reverse-logisticsListar las operaciones de logística inversa de un envío
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 422
- operationId
list_reverse_logistics_v1_shipments__shipment_id__reverse_logistics_get
POST/v1/shipments/{shipment_id}/reverse-logisticsCrear una operación de logística inversa
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 201, 401, 403, 404, 409, 422, 503
- operationId
create_reverse_logistics_v1_shipments__shipment_id__reverse_logistics_post
GET/v1/shipments/{shipment_id}/reverse-logistics-policyConsultar la disponibilidad de logística inversa
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 422
- operationId
get_reverse_logistics_policy_v1_shipments__shipment_id__reverse_logistics_policy_get
GET/v1/shipments/{shipment_id}/tracking-eventsConsultar el historial de seguimiento
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 422
- operationId
list_tracking_events_v1_shipments__shipment_id__tracking_events_get
Puntos de entrega y recogida
GET/v1/carrier-connections/{connection_id}/pudo-pointsBuscar puntos de entrega o recogida
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 422, 503
- operationId
search_pudo_points_v1_carrier_connections__connection_id__pudo_points_get
Webhooks
GET/v1/webhook-subscriptionsList Subscriptions
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200
- operationId
list_subscriptions_v1_webhook_subscriptions_get
POST/v1/webhook-subscriptionsCreate Subscription
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 201, 401, 403, 422
- operationId
create_subscription_v1_webhook_subscriptions_post
GET/v1/webhook-subscriptions/deliveriesList Deliveries
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 422
- operationId
list_deliveries_v1_webhook_subscriptions_deliveries_get
POST/v1/webhook-subscriptions/deliveries/{delivery_id}/retryRetry Delivery
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 202, 422
- operationId
retry_delivery_v1_webhook_subscriptions_deliveries__delivery_id__retry_post
PATCH/v1/webhook-subscriptions/{subscription_id}Update Subscription
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 422
- operationId
update_subscription_v1_webhook_subscriptions__subscription_id__patch
carrier-credentials
PUT/v1/carrier-connections/{connection_id}/credentials/mensaglobalRegistrar o rotar la API key de MensaGlobal de una conexión propia
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 409, 422, 503
- operationId
register_mensaglobal_key_v1_carrier_connections__connection_id__credentials_mensaglobal_put
POST/v1/carrier-connections/{connection_id}/service-proposalsDeclarar los códigos de servicio pactados para MensaGlobal
- Autenticación
- Bearer obligatoria
- Respuestas declaradas
- 200, 401, 403, 404, 409, 422
- operationId
propose_mensaglobal_services_v1_carrier_connections__connection_id__service_proposals_post
ecomm-integration
GET/v1/integrations/ecomm/workspaces/{workspace_id}Consultar el estado técnico de un workspace Ecomm
- Autenticación
- No requerida
- Respuestas declaradas
- 200, 422
- operationId
get_workspace_state_v1_integrations_ecomm_workspaces__workspace_id__get
PUT/v1/integrations/ecomm/workspaces/{workspace_id}/logistics-credentials/{external_issuance_id}Emitir o rotar la credencial logística MensaGlobal de un workspace
- Autenticación
- No requerida
- Respuestas declaradas
- 201, 422
- operationId
issue_logistics_credential_v1_integrations_ecomm_workspaces__workspace_id__logistics_credentials__external_issuance_id__put
PUT/v1/integrations/ecomm/workspaces/{workspace_id}/management-credentials/{external_issuance_id}Emitir o rotar la credencial de gestión MensaGlobal de un workspace
- Autenticación
- No requerida
- Respuestas declaradas
- 201, 422
- operationId
issue_management_credential_v1_integrations_ecomm_workspaces__workspace_id__management_credentials__external_issuance_id__put
PUT/v1/integrations/ecomm/workspaces/{workspace_id}/mensaglobal-connections/{external_integration_id}Crear o recuperar la conexión MensaGlobal de un workspace Ecomm
- Autenticación
- No requerida
- Respuestas declaradas
- 200, 422
- operationId
provision_connection_v1_integrations_ecomm_workspaces__workspace_id__mensaglobal_connections__external_integration_id__put
PUT/v1/integrations/ecomm/workspaces/{workspace_id}/statusSuspender o reactivar el vínculo de un workspace Ecomm
- Autenticación
- No requerida
- Respuestas declaradas
- 200, 422
- operationId
set_workspace_status_v1_integrations_ecomm_workspaces__workspace_id__status_put