Registrar Evento

Registra un evento sobre una entidad logística (pedido, envío, ruta o solicitud de colecta). Las evidencias adjuntas se envían usando `multipart/form-data`; si no hay evidencias, basta con `application/json`.

Authorization

ClientId IntegrationAuth

X-Client-Id<token>

Identificador del cliente integrado, proporcionado por Dinet.

In: header

X-Integration-Auth<token>

Token de integración, proporcionado por Dinet.

In: header

Request Body

event_type_codestring

Requerido

Código del tipo de evento

Length1 <= length <= 20

Example"ENT_EXI"

entity_type_codestring

Requerido

Tipo de entidad sobre la que se registra el evento

Value in"PEDIDO" | "RUTA" | "ENVIO" | "SOLICITUD_COLECTA"

Example"ENVIO"

entity_codestring

Requerido

Código de negocio de la entidad

Length1 <= length <= 26

Example"ENV-000123"

entity_qualifiers

Opcional

Calificadores admitidos cuando el evento se registra sobre un pedido.

reason_codestring

Opcional

Código del motivo del evento, si aplica

Example"MOTIVO_RETRASO"

form

Opcional

Formulario dinámico con datos adicionales del evento. Su estructura es libre y depende de la configuración del tipo de evento.

Response Body

`application/json`

Request Body

JSONRequest

{
  "event_type_code": "ENT_EXI",
  "entity_type_code": "ENVIO",
  "entity_code": "ENV-000123",
  "reason_code": "MOTIVO_RETRASO",
  "form": {
    "observacion": "Entrega parcial",
    "motivo": "Cliente ausente"
  }
}

Response

JSONExample

{
  "transaction_id": "550e8400-e29b-41d4-a716-446655440000",
  "data": {
    "event_id": "01HQXK5V8RGDN3JFBX2QWERTY"
  }
}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`