---
title: "Get Orders"
method: GET
path: "/v1/orders"
---

# Get Orders

`GET /v1/orders`

Get and filter the orders

## Query parameters

- `perPage` integer
- `version` '1.0' | '2.0'
- `keywords` string
- `statuses[]` 'completed' | 'sent' | 'draft' | 'expired' | 'canceled'
- `dateFrom` string
- `dateTo` string
- `with` string

## Headers

- `X-BUSINESS-API-KEY` string, required

## Response `200`

200

- object
  - `id` string
  - `order_display_number` integer
  - `business_id` string
  - `channel` string
  - `version` string
  - `customer_id` unknown
  - `business_customer_id` unknown
  - `customer` unknown
  - `customer_pickup` boolean
  - `currency` string
  - `order_discount_name` unknown
  - `status` string
  - `remark` string
  - `created_at` string
  - `updated_at` string
  - `closed_at` unknown
  - `location_id` unknown
  - `location` unknown
  - `business_user_id` string
  - `slot_date` unknown
  - `slot_time` unknown
  - `messages` unknown
  - `products` unknown[]
    - unknown
  - `charges` unknown[]
    - unknown
  - `line_items` unknown[]
    - unknown
  - `order_form` object
    - `membership_id` object, required
      - `type` string, required
      - `title` string, required
      - `deleted` boolean, required
      - `include` boolean, required
      - `required` boolean, required
  - `order_form_response` unknown[]
    - unknown
  - `coupon` unknown
  - `payment_status` unknown
  - `fulfilment_status` string
  - `line_items_total` integer
  - `order_discount_amount` integer
  - `line_item_discount_amount` integer
  - `line_item_tax_amount` integer
  - `additional_discount_amount` integer
  - `total_discount_amount` integer
  - `line_item_price` integer
  - `shipping_amount` integer
  - `total_coupon_amount` integer
  - `amount` integer
  - `subtotal` integer

---

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