BRIDGE API - REST - Consulta de solicitud de cambio de estado del pedido
Este servicio permitirá consultar en que estado se encuentra una solicitud de cambio de estado un pedido, desde una fuente externa que se realizó previamente
- Se invoca de la siguiente manera: https://[direccion_ip]:[puerto]/order/state/change/status - Ejemplo: https://200.100.100.100:8090/order/state/change/status
- Se invoca vía GET.
Tener en cuenta:
- Primero se debe invocar al servicio de autenticación para obtener un token.
- Cuando se llama a cualquier servicio este token se envía como un parámetro más de la llamada en el header (x-access-token).
- Si al llamar al servicio el token expiró, se recibirá respuesta de token inválido y se deberá volver a pedir uno nuevo.
JSON ejemplo
{ "internalNumber": "bridge0000000567" }
Descripción de los campos:
Importante: los campos que poseen este ícono
, son valores tipificados que deben respetar los valores expuestos por BRIDGE en sus servicios.Campo | Tipo | Descripción | Requerido | Ejemplos | Validación (código) |
---|---|---|---|---|---|
internalNumber | String | Código de la orden interna asignado por BRIDGE. Este código se retorna al momento de la creación de la orden. | SI | bridge000001 |
Respuesta del servicio:
Cambio de estado = ok
{ "ack": 0, "stateChangeStatus": "ok", "msg": "" }
- ack es el código de respuesta, en caso de ser un error, mirar tabla a continuación.
- stateChageStatus: ok, error o pending (si es “ok”: el cambio de estado fue procesado exitosamente. Si es “error”: en el mensaje descriptivo se indicará el motivo. Si es “pending”: el cambio de estado aún no fue procesado en la tienda)
msg: descripción del error en caso de existir.
Cambio de estado con error
{ "ack": 0, "stateChangeStatus": "error", "msg": "[{\"ack\":999,\"message\":\"FinalOrderState created no existe\",\"additional\":\"Error: FinalOrderState created no existe\\n at C:\\\\NAPSE\\\\BRIDGE75\\\\TIENDA1\\\\bridgeapi\\\\dist\\\\services\\\\order\\\\orderWorkflow.service.js:80:15\\n at Generator.next (<anonymous>)\\n at fulfilled (C:\\\\NAPSE\\\\BRIDGE75\\\\TIENDA1\\\\bridgeapi\\\\dist\\\\services\\\\order\\\\orderWorkflow.service.js:24:58)\\n at runMicrotasks (<anonymous>)\\n at processTicksAndRejections (internal/process/task_queues.js:95:5)\"}]" }
Código de Error | Descripción |
---|---|
0 | La operación se ha ejecutado con éxito. |
9999 | Error desconocido |