Listar pedidos

¿Para qué sirve?

Devuelve una lista de pedidos. Puedes filtrar por varios criterios. Todos los parámetros son opcionales — sin parámetros devuelve todos los pedidos.

Condiciones

  • Requiere autenticación.

Parámetros

Completá los campos en Query Params y/o Path Params según corresponda.

Guía rápida de parámetros

  • ids: Filtra por IDs de pedidos concretos (Cómo completarlo/obtenerlo: Los IDs que obtuviste al crear pedidos. Separa con comas: 1,2,3)
  • status_ids: Filtra por estado del pedido (Cómo completarlo/obtenerlo: Consulta al equipo los IDs de estado disponibles. Separa con comas)
  • shop_ids: Filtra pedidos de ciertas tiendas (Cómo completarlo/obtenerlo: Llama a GET /api/v1/client/shops → copia los "id" de las tiendas que quieras. Separa con comas)
  • payment_method_ids: Filtra por método de pago (Cómo completarlo/obtenerlo: Llama a GET /api/v1/client/payment-methods → copia los "id". Separa con comas)
  • courier_ids: Filtra por courier (Cómo completarlo/obtenerlo: Consulta al equipo los IDs de mensajeros disponibles. Separa con comas)
  • date[column]: Qué fecha usar para el filtro de fechas (Cómo completarlo/obtenerlo: Escribe uno de estos valores: order_created_at, processed_at, last_shipment_update)
  • date[start]: Fecha de inicio del rango (Cómo completarlo/obtenerlo: Formato: 2024-01-01)
  • date[end]: Fecha de fin del rango (Cómo completarlo/obtenerlo: Formato: 2024-01-31)
  • search: Búsqueda por texto (Cómo completarlo/obtenerlo: Escribe la referencia, ID o número de seguimiento que buscas)
  • product_ids: Filtra pedidos que contengan esos productos (Cómo completarlo/obtenerlo: Llama a GET /api/v1/client/products → copia los "id". Separa con comas)
  • sorting[column]: Por qué campo ordenar (Cómo completarlo/obtenerlo: Valores posibles: id, ref, order_created_at, processed_at, last_shipment_update)
  • sorting[direction]: Orden ascendente o descendente (Cómo completarlo/obtenerlo: Escribe: asc o desc)
  • per_page: Cuántos pedidos ver por página (Cómo completarlo/obtenerlo: Un número entero. Por defecto suele ser 15 o 25)
  • page: Qué página ver (Cómo completarlo/obtenerlo: Empieza en 1)

Respuesta esperada

HTTP 200 → Lista paginada de pedidos con datos de paginación

Language
Credentials
Basic
base64
:
Response
Click Try It! to start a request and see the response here!