---
title: "Get orders"
method: GET
path: "/api/orders"
tags: ["Pedidos"]
---

# Get orders

`GET /api/orders`

## Query parameters

- `id` integer — The ID of the order to filter orders by.
- `order_id` integer — The ID of the order to filter orders by.
- `pdv_id` integer — The ID of the PDV to filter orders by.
- `payment_method` integer — The ID of the payment method to filter orders by.
- `status` integer — The ID of the status to filter orders by.
- `delivery` boolean — Specifies if only delivery orders should be returned to filter orders by.
- `userId` integer — The ID of the user to filter orders by.
- `dates` string[]

## Response `200`

- object
  - `data` object[]
    - `id` string
    - `user_name` string
    - `user_cpf` string
    - `user_cep` string
    - `created_at` string
    - `time_to_pay` string
    - `status_pedido` string
    - `pdv_id` string
    - `pdv_description` string
    - `delivery` string
    - `paid_at` string
    - `payment_method` string
    - `itens` object
      - `data` object[]
        - `code` string
        - `description` string
        - `value` string
        - `total_value` string
        - `delivery` string
        - `unit` string
        - `amount` string
  - `links` object
    - `first` string
    - `last` string
    - `prev` string
    - `next` string
  - `meta` object
    - `current_page` string
    - `from` string
    - `last_page` string
    - `links` object[]
      - `url` string
      - `label` string
      - `active` string
    - `path` string
    - `per_page` string
    - `to` string
    - `total` string

## Other responses

- `401` — Unauthorized
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.dev/beepayapp/apis/beepay.md) · [All operations](https://skmtc.dev/beepayapp/apis/beepay/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/beepayapp/beepay/revisions/787a925e98a0/schema)