---
title: "Retrieves the collection of CustomerOrder resources."
method: GET
path: "/customer-orders"
tags: ["Customer Order"]
---

# Retrieves the collection of CustomerOrder resources.

`GET /customer-orders`

## Request

- Base URL: `http://localhost:8000/api/shop`
- URL: `http://localhost:8000/api/shop/customer-orders`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bagisto/apis/bagisto-shop-api/docs/customer-orders/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the collection of CustomerOrder resources.

## Query parameters

- `page` integer
- `per_page` integer

## Headers

- `X-STOREFRONT-KEY` string, required
- `X-Locale` string
- `X-Channel` string
- `X-Currency` string

## Response `200`

CustomerOrder collection

- CustomerOrderCustomerOrderListDto[]
  - `id` integer, nullable
  - `incrementId` string, nullable
  - `status` string, nullable
  - `channelName` string, nullable
  - `customerEmail` string, nullable
  - `customerFirstName` string, nullable
  - `customerLastName` string, nullable
  - `shippingMethod` string, nullable
  - `shippingTitle` string, nullable
  - `couponCode` string, nullable
  - `totalItemCount` integer, nullable
  - `totalQtyOrdered` integer, nullable
  - `grandTotal` number, nullable
  - `baseGrandTotal` number, nullable
  - `subTotal` number, nullable
  - `baseSubTotal` number, nullable
  - `taxAmount` number, nullable
  - `shippingAmount` number, nullable
  - `discountAmount` number, nullable
  - `baseCurrencyCode` string, nullable
  - `orderCurrencyCode` string, nullable
  - `createdAt` string, nullable
  - `updatedAt` string, nullable

---

[API](https://skmtc.dev/bagisto/apis/bagisto-shop-api.md) - [All operations](https://skmtc.dev/bagisto/apis/bagisto-shop-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bagisto/apis/bagisto-shop-api/revisions/f619df36bf29?raw)