BRIDGE API - REST - Cambio de Estado del Pedido
© 2024 Napse. Todos los derechos reservados.
Este servicio permitirá cambiar de estado un pedido, desde una fuente externa.
- Se invoca de la siguiente manera: https://[direccion_ip]:[puerto]/order/state/change - Ejemplo: https://200.100.100.100:8090/order/state/change
- Se invoca vía POST.
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.
Este servicio de cambio de estado se podrá complementar con: BRIDGE API - REST - Consulta de solicitud de cambio de estado del pedido
De esta manera, luego del envío de un cambio de estado podrá consultarse si el mismo fue realizado o no con éxito. El motivo principal radica en que las solicitudes como el cambio de estado son enviados a BRIDGE API Central, pero quien realiza el cambio finalmente es BRIDGE API en la tienda (luego se replica su actualización a Central)
JSON ejemplo
{
"orderState": "closed",
"internalNumber": "00001",
"externalNumber": "PEYA_001230",
"channel": "PEYA",
"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) |
|---|---|---|---|---|---|
| orderState | String | Codigo del estado al cual pasa la orden | SI | Ver cuadro de estados. | 1040: el nuevo estado es requerido. |
| 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. | NO | bridge000001 | 991: el código de orden es requerido. |
| externalNumber | String | Nro de pedido externo | NO | PEYA_01230 | |
| channel | String | Código del canal | NO | PEYA | |
| notes | String | Observaciones sobre el cambio de estado | NO | El cliente canceló la orden |
Nota
Se debe enviar el internalNumber ó el externalNumber y channel (para poder determinar el pedido unívocamente)
Respuesta del servicio:
{
"ack": 0,
"message": "El cambio de estado para la orden: bridge0000000294 se ejecutó con éxito"
}
Nota
- 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 |
Estados de un pedido:
Estado | Nombre | Descripción | |
|---|---|---|---|
| 1 | open | abierto/creado | El pedido ha ingresado a Bridge, aún no se ha tratado
|
| 2 | confirmed | confirmado | El pedido tiene pagos asociados y se encuentra para surtir
|
| 3 | readyToPick | listo para surtir | El pedido cuenta con las actualizaciones de datos de envío
|
| 4 | inproc | surtiendo | El pedido se encuentra en proceso de surtido
|
| 5 | complete | completo | El pedido se ha surtido.
|
| 6 | transit | entregado | En proceso de envío
|
| 7 | closed | cerrado (estado final) | El pedido se ha cerrado con éxito. |
| 8 | cancelled | cancelado (estado final) | El pedido ha sido cancelado por el cliente o por la empresa. |