---
title: "Get order list admin"
method: GET
path: "/ecommerce/orders/list/admin"
tags: ["🛒 Ecommerce"]
---

# Get order list admin

`GET /ecommerce/orders/list/admin`

The API allows users with the `ADMIN` role to fetch orders placed by users on an ecommerce site.

The API endpoint provides the ability to filter orders based on their status as well.

To filter by status, the client can pass an `order` query parameter in the URL, which can have one of the following values: `PENDING`, `DELIVERED`, or `CANCELLED`. This allows the admin user to retrieve specific sets of orders based on their status.

**NOTE:** This api returns data which is useful to show list view of the item.

This api does not contain complete details of the products ordered instead the count of the ordered products as generally UI will show the product details in the list format.

To get complete details of the order call `Get order by id` api.

## Query parameters

- `status` string
- `page` string
- `limit` string

## Response `200`

Get order list admin

- object
  - `data` object
    - `hasNextPage` boolean
    - `hasPrevPage` boolean
    - `limit` number
    - `nextPage` unknown
    - `orders` object[]
      - `__v` number
      - `_id` string
      - `address` object
        - `__v` number
        - `_id` string
        - `addressLine1` string
        - `addressLine2` string
        - `city` string
        - `country` string
        - `createdAt` string
        - `owner` string
        - `pincode` string
        - `state` string
        - `updatedAt` string
      - `coupon` object, nullable
      - `createdAt` string
      - `customer` object
        - `_id` string
        - `email` string
        - `username` string
      - `discountedOrderPrice` number
      - `isPaymentDone` boolean
      - `orderPrice` number
      - `paymentId` string
      - `paymentProvider` string
      - `status` string
      - `totalOrderItems` number
      - `updatedAt` string
    - `page` number
    - `prevPage` number
    - `serialNumberStartFrom` number
    - `totalOrders` number
    - `totalPages` number
  - `message` string
  - `statusCode` number
  - `success` boolean

---

[API](https://skmtc.net/hiteshchoudhary-ssesph/apis/freeapi.md) · [All operations](https://skmtc.net/hiteshchoudhary-ssesph/apis/freeapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hiteshchoudhary-ssesph/freeapi/versions/a9f3a290e4dc/schema)