Órdenes: Listar

Permite obtener la información histórica de las órdenes cargadas en Fenicio.

MétodoURL

GET

/API_V1/ordenes

Request

Se deberá realizar una consulta GET a la URL correspondiente, incluyendo los parámetros que se deseen.

Parámetros

ClaveTipoDescripción

pag

Int(3)

El número de la página que se quiere recuperar.

  • min: 1

  • max: null

  • default: 1

tot

Int(3)

Cantidad de ítems por página.

  • min: 1

  • max: 500

  • default: 50

fDesde

Fecha desde la cual se quiere recuperar las órdenes.

fHasta

Fecha hasta la cual se quiere recuperar las órdenes.

estado

Estado de las órdenes que se desean recuperar.

estadoEntrega

Estado de entrega de las órdenes que se desean recuperar.

cliente

String

Permite filtrar en base a algún dato del cliente (nombre, apellido, email, número de documento o teléfono).

incluirAtributosProducto

0 | 1

Indica si se desea incluir los atributos de cada producto existente en las órdenes. (Siendo 0 = falso y 1 = verdadero).

Ejemplo

https://example.com/API_V1/ordenes?estado=CANCELADA&fHasta=2021-12-22

Response

ClaveTipoDescripción

error

Boolean

Valor booleano que indica si se generó algún error en la consulta.

msj

String

Mensaje descriptivo sobre la consulta realizada.

totAbs

Int

Cantidad absoluta (no por página) de órdenes recuperadas.

ordenes

List<Orden>

Lista con las órdenes recuperadas.

Ejemplo

{
  "error": false,
  "msj": "",
  "totAbs": 841,
  "ordenes": [
    {
      // Objeto Orden
    },
    {
      // Objeto Orden
    }
    // Etc..
  ]
}|

Última actualización