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

# List orders

`GET /orders`

## Request

- Base URL: `https://gorest.co.in/public/v3`
- URL: `https://gorest.co.in/public/v3/orders`
- Auth: one of:
  - none
  - HTTP bearer

## Query parameters

- `page[size]` integer
- `page[after]` string
- `page[number]` integer
- `page[count]` boolean
- `filter` object
  - `status` string
  - `user_id` string, uuid
- `sort` 'created_at' | '-created_at' | 'total_minor' | '-total_minor'
- `fields` object
  - `orders` string
- `include` string

## Headers

- `If-None-Match` string

## Response `200`

One page of orders.

- OrderList
  - `data` Order[], required
    - `cart_id` string, uuid, nullable: The cart it was placed from; null once that cart is deleted.
    - `created_at` string, date-time
    - `currency` string
    - `id` string, uuid, required
    - `items` OrderItem[]: The lines, oldest first.
      - `created_at` string, date-time
      - `currency` string
      - `id` string, uuid, required
      - `line_total_minor` integer
      - `name` string
      - `order_id` string, uuid
      - `product_id` string, uuid, nullable: Null once the product is deleted.
      - `quantity` integer
      - `read_only` boolean: True for sample data (the seed); it cannot be changed.
      - `sku` string
      - `unit_price_minor` integer
    - `read_only` boolean: True for sample data (the seed); it cannot be changed.
    - `status` 'pending' | 'paid' | 'fulfilled' | 'cancelled' | 'refunded': pending to paid or cancelled; paid to fulfilled or refunded; fulfilled to refunded. A cancel puts the stock back.
    - `total_minor` integer: The sum of the lines.
    - `updated_at` string, date-time
    - `user` NullableUser: Every field is present unless `fields[users]` asks for fewer.
      - `created_at` string, date-time
      - `email` string, email
      - `id` string, uuid, required
      - `name` string
      - `read_only` boolean: True for sample data (the seed); it cannot be changed.
      - `status` 'active' | 'inactive'
      - `updated_at` string, date-time
    - `user_id` string, uuid, nullable: The cart's user; null once that user is deleted.
  - `meta` ListMeta, required
    - `has_more` boolean, required: More items follow this page.
    - `next_cursor` string, nullable, required: Send as `page[after]` for the next page; null on the last page and with offset paging.
    - `total` integer, nullable, required: All matching items; only with `page[number]` or `page[count]=true`, else null.

## Other responses

- `304`: Not changed since the ETag in `If-None-Match`; no body.
- `400`: A parameter is wrong, unknown or out of range.
- `401`: No token, or the token is wrong, expired or revoked.
- `403`: The token lacks the scope this operation needs.
- `429`: Over the rate limit; wait `Retry-After` seconds.
- `500`: Something failed on the server.

---

[API](https://skmtc.dev/gorest/apis/gorest-api-v3.md) - [All operations](https://skmtc.dev/gorest/apis/gorest-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/gorest/apis/gorest-api-v3/revisions/89aa429755a6?raw)