BRIDGE API - REST - Cambio de Estado del Pedido
© 2024 Napse. Todos los derechos reservados.
| Painel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Este servicio permitirá cambiar de estado un pedido, desde una fuenta fuente externa.
- Se invoca de la siguiente manera: https://[direccion_ip]:[puerto]/order/change-status state/change - Ejemplo: https://200.100.100.100:8090/order/change-status/state/change
- Se invoca via vía POST.
| Informações | ||
|---|---|---|
| ||
|
...
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
| Bloco de código | ||
|---|---|---|
| ||
{
"orderState": "closed",
"internalNumber": "00001",
"newStatus "externalNumber": "PEYA_001230",
"channel": "cancelledPEYA",
"notes": "el pedido ha sido cancelado por el cliente"
} |
...
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. |
Ver cuadro de estados.
1021: el nuevo estado no puede ser idéntico al actual.
1023: no se puede cambiar de estado una orden enviada (env) o cerrada (clos)
| 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 |
| Informações | ||
|---|---|---|
| ||
Se debe enviar el internalNumber ó el externalNumber y channel (para poder determinar el pedido unívocamente) |
Respuesta del servicio:
| Bloco de código |
|---|
{
"ack": 0,
"message": "-",
}El cambio de estado para la orden: bridge0000000294 se ejecutó con éxito"
} |
| Informações | ||
|---|---|---|
| ||
|
| 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. |
- 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.
| 8 | cancelled | cancelado (estado final) | El pedido ha sido cancelado por el cliente o por la empresa. |