---
title: "List orders"
method: GET
path: "/orders/"
tags: ["Procurement"]
---

# List orders

`GET /orders/`

## Query parameters

- `page` integer
- `page_size` integer
- `ordering` string
- `status` 'draft' | 'finalized' | 'cancelled'
- `tax_agency` string

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Response `200`

Paginated order list.

- object
  - `count` integer, required — Total number of items matching the filter.
  - `next` string, uri, nullable — URL of the next page, or `null` if last page.
  - `previous` string, uri, nullable — URL of the previous page, or `null` if first page.
  - `results` Order[], required — The items in the current page.
    - `id` integer
    - `customer` string, required — Customer ID.
    - `document` integer, required — Order document type.
    - `number` integer, nullable
    - `date` string, date, required
    - `shipping_type` '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9', required — Shipping classification: `1` venta, `2` ventas por efectuar, `3` consignaciones, `4` entrega gratuita, `5` traslados internos, `6` otros traslados, `7` guía de devolución, `8` traslado para exportación, `9` venta para exportación.
    - `address` string, nullable
    - `state` integer, nullable
    - `carrier_id` string, nullable
    - `carrier_name` string, nullable
    - `licence_plate` string, nullable
    - `note` string, nullable
    - `amount` integer, nullable
    - `exempt` integer, nullable
    - `tax` integer, nullable
    - `tax_percent` number, nullable
    - `total` integer, nullable
    - `status` 'draft' | 'finalized' | 'cancelled'
    - `biller_status` string
    - `tax_agency` object
    - `local_file` string, uri, nullable
    - `imported` boolean
    - `test_mode` boolean
    - `lines` OrderLine[], required
      - `id` integer
      - `name` string, required
      - `description` string, nullable
      - `amount` integer, required
      - `quantity` number, required
      - `exempt` boolean
      - `tax` integer, nullable
      - `tax_percent` number, nullable
      - `total` integer
    - `references` OrderReference[]
      - `date` string, date, required
      - `document` string, required
      - `description` string, nullable
      - `serial` string, required
    - `created` string, date-time
    - `updated` string, date-time

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/revisions/70cbc827dc7b/schema)