Este servicio permitirá cambiar de estado un pedido, desde una fuenta externa.
- Se invoca de la siguiente manera: https://[direccion_ip]:[puerto]/order/state/:orderState - Ejemplo: https://200.100.100.100:8090/order/state/confirmed
- Se invoca via POST.
Parámetros enviados por URL
| Campo | Tipo | Descripción | Requerido | Ejemplos | Validación (código) | |
| orderState | String | Codigo del estado al cual pasa la orden | SI | Ver cuadro de estados. | 1040: el nuevo estado es requerido. |
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.
Ejemplo del JSON a enviar:
{
"internalNumber": "00001",
"notes": "el pedido ha sido cancelado por el cliente"
}
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 | 000001 | 991: el código de orden es requerido. | |
| notes | String | Observaciones sobre el cambio de estado | NO | El cliente canceló la orden |
Respuesta del servicio:
{
"ack": 0,
"message": "-",
}
Estados de un pedido:
| Estado | Nombre | Descripción |
|---|---|---|
| open | Abierto | El pedido ha ingresado a Bridge, aún no se ha tratado |
| cancelled | Cancelado | El pedido ha sido cancelado por el cliente o por la empresa. |
| rejected | Rechazado | El pedido se rechaza, debido a errores en su estructura o inconsistencias. |
| paused | Pausado | El pedido se pausa por alguna razón. |
| negotiation | En proceso de negociación | Por algún faltante, se deberá negociar con el cliente como completar el pedido. |
| inproc | En proceso de surtido | El pedido se encuentra en proceso de surtido |
| complete | El pedido se ha surtido | El pedido se ha surtido. |
| transit | En proceso de envío | El pedido se ha enviado al cliente. |
| closed | Cerrado | El pedido se ha cerrado con éxito. |
- ack es el código de respuesta, en caso de ser un error, mirar tabla a continuación.
- message: descripción del error en caso de existir.
| Código de Error | Descripción |
|---|---|
| 0 | La operación se ha ejecutado con éxito. |
| 9999 | Error desconocido |