List Orders

Listar Pedidos

Obtiene listado de pedidos en base a los parámetros enviados.

Nombre	Tipo y longitud o rango de dato	Descripción	Requerido	Default
HOST	URL	Se indicará de acuerdo el ambiente donde será consumido el servicio: Producción: https://api.next-cloud.mx Staging: https://stg-api.next-cloud.mx	Sí	N/A

Resource URL

GET HOST/v1/orders/?created_at_after=(date: created_at_after)&created_at_before=(date: created_at_before)&warehouse=(int: warehouse)&store=(int: store)&customer=(int: customer)

Parámetros:

• created_at_after (date) – (opcional) Fecha inicial del rango de creación (formato YYYY-MM-DD).

• created_at_before (date) – (opcional) Fecha final del rango de creación (formato YYYY-MM-DD).

• warehouse (int) – (opcional) Identificador del almacén. Ej: 1.

• store (int) – (opcional) Identificador de la tienda. Ej: 1.

• customer (int) – (opcional) Identificador del cliente. Ej: 1.

• page (int) – (optional) Identificador de la pagina consultada.

• page_size (int) – (opcional) Total de resultados por pagina (por defecto son 100).

Encabezados de solicitud:

• Authorization – Token del usuario.

• Content-Type – Define el formato en el que se envian los datos por el body.

Objeto JSON de respuesta:

• count (int) – Total de resultados obtenidos por la consulta.

• next (string) – Página siguiente de resultados.

• previous (string) – Página anterior de resultados.

• result (obj) – Objeto con resultados de la consulta.

Códigos de Status:

• 200 OK – Ningún error.

• 400 Bad Request – Algún parámetro es incorrecto.

• 401 Unauthorized – Token no válido o no enviado.

• 404 Not Found – El recurso no existe.

result object:

Objeto JSON de respuesta:

• id (int) – Identificador del pedido.

• document (string) – Clave del documento factura.

• folio (int) – Folio de la factura.

• serie (string) – Serie de factura.

• customer (int) – Identificador del cliente.

• status (string) – Clave de estado del pedido.

• warehouse (int) – Identificador del almacén.

• store (int) – Identificador de la tienda.

• total (float) – Total del pedido.

• created_at (date) – Fecha de creación del documento.

Example request

GET /v1/orders/?created_at_after=2025-01-01&created_at_before=2025-05-30&warehouse=1&store=1&customer=1 HTTP/1.1
Host: api.next-cloud.mx
Accept: application/json
Content-Type: application/json
Authorization: Token ( token del usuario )

Example Response

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
Allow: GET

{
	"count": 411449,
	"next": "http://api.next-cloud.mx/v1/orders/?created_at_after=2025-01-01&created_at_before=2025-07-01&warehouse=1&store=1&customer=1",
	"previous": null,
	"results": [
        {
            "id": 2059787,
            "document": "FACTC",
            "folio": 920,
            "serie": "X",
            "customer": 1124,
            "status": "F",
            "warehouse": 1,
            "store": 135,
            "total": "118.00",
            "created_at": "2025-01-02T16:43:50Z"
        },
        {
            "id": 2059788,
            "document": "PEDID",
            "folio": 2059788,
            "serie": "E",
            "customer": 10,
            "status": "PP",
            "warehouse": 8,
            "store": 135,
            "total": "0.00",
            "created_at": "2025-01-07T23:40:59Z"
        },
        {
            "id": 2059791,
            "document": "PEDID",
            "folio": 2059791,
            "serie": "E",
            "customer": 3,
            "status": "PA",
            "warehouse": 170,
            "store": 110,
            "total": "0.00",
            "created_at": "2025-01-07T23:53:33Z"
        }
	]
}