Parrot External API
  1. Orders
Parrot External API
  • Home
  • Changelog
  • Authentication and Usage
  • Endpoints
    • Inventory Management
      • List Suppliers
      • List Supplies
    • Orders
      • List Orders
        GET
      • V1 - List Order Items
        GET
      • V2 - List Order Items
        GET
      • List Product Types
        GET
    • Discounts
      • List Discounts
      • List Discount Usages
    • List All Stores
      GET
    • List Order Invoices
      GET
    • List Order Payments
      GET
    • List Cashier Sessions
      GET
    • List Store Users
      GET
  1. Orders

List Orders

GET
/v1/orders
This endpoint retrieves orders within a specified time range, with pagination support.
Note: startTimestamp and endTimestamp must be at most 48 hours apart.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/orders?startTimestamp=2024-03-27T19:00:00-06:00&endTimestamp=2024-03-28T19:00:00-06:00&pageSize=100&page=0&storeUUID=a2f09385-7f1b-436c-9baa-bb9cf1174c25&storeUUID=206b8416-c3c8-4053-9bdf-a11f3ddd7da1&sort=updatedAt' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK
application/json
Body

Example
{
    "pagination": {
        "next": 1,
        "previous": null,
        "count": 27,
        "current": 0,
        "pageSize": 4
    },
    "data": [
        {
            "createdAt": "2025-05-25T06:00:02Z",
            "updatedAt": "2025-05-25T06:07:46Z",
            "uuid": "8ad16958-586f-456f-b831-a922fe769fc1",
            "status": "FINISHED",
            "provider": "PARROT",
            "storeUuid": "d472f6fd-fa54-4654-a59b-6694557bae44",
            "storeName": "Parrot Café",
            "providerOrderId": null,
            "orderType": "DINE_IN",
            "orderTypeNameUuid": "cc440b54-242b-418e-867f-ce57fb098104",
            "orderTypeName": "Comer Aqui",
            "totalPrice": "577.00",
            "total": "0.00",
            "brandName": "Parrot Café",
            "invoicingCode": "8AD25052569FC1",
            "invoicingExpiresAt": "2025-06-01T05:59:59Z",
            "totalDiscounts": "577.00",
            "orderDiscount": "577.00",
            "totalServiceCharges": "0.00",
            "tableUuid": "5449459a-80d8-4246-ad57-e5dc6abeb915",
            "tableName": "DJ",
            "customersCount": 5,
            "orderReference": "250525-P-0001",
            "totalTaxes": "0.00",
            "finishedAt": "2025-05-25T06:07:46Z",
            "createdByUserUuid": "808e3681-2825-4997-a414-bcc7f9f21584",
            "orderName": ""
        },
        {
            "createdAt": "2025-05-25T06:49:36Z",
            "updatedAt": "2025-05-25T06:55:27Z",
            "uuid": "6621afc9-76e3-479c-9e5d-0f56c431fc7f",
            "status": "FINISHED",
            "provider": "PARROT",
            "storeUuid": "d472f6fd-fa54-4654-a59b-6694557bae44",
            "storeName": "Parrot Café",
            "providerOrderId": null,
            "orderType": "DINE_IN",
            "orderTypeNameUuid": "cc440b54-242b-418e-867f-ce57fb098104",
            "orderTypeName": "Comer Aqui",
            "totalPrice": "150.00",
            "total": "150.00",
            "brandName": "Parrot Café",
            "invoicingCode": "6622505251FC7F",
            "invoicingExpiresAt": "2025-06-01T05:59:59Z",
            "totalDiscounts": "0.00",
            "orderDiscount": null,
            "totalServiceCharges": "0.00",
            "tableUuid": "3e0a8ff9-782d-4060-acb4-e15983f48ec0",
            "tableName": "REA4",
            "customersCount": 1,
            "orderReference": "250525-P-0002",
            "totalTaxes": "20.69",
            "finishedAt": "2025-05-25T06:55:27Z",
            "createdByUserUuid": "808e3681-2825-4997-a414-bcc7f9f21584",
            "orderName": ""
        },
        {
            "createdAt": "2025-05-25T20:04:30Z",
            "updatedAt": "2025-05-25T20:47:58Z",
            "uuid": "fe9f1e43-41c4-433f-b965-4081ffece6a4",
            "status": "FINISHED",
            "provider": "PARROT",
            "storeUuid": "d472f6fd-fa54-4654-a59b-6694557bae44",
            "storeName": "Parrot Café",
            "providerOrderId": null,
            "orderType": "DINE_IN",
            "orderTypeNameUuid": "cc440b54-242b-418e-867f-ce57fb098104",
            "orderTypeName": "Comer Aqui",
            "totalPrice": "623.00",
            "total": "623.00",
            "brandName": "Parrot Café",
            "invoicingCode": "FE9250525CE6A4",
            "invoicingExpiresAt": "2025-06-01T05:59:59Z",
            "totalDiscounts": "0.00",
            "orderDiscount": null,
            "totalServiceCharges": "0.00",
            "tableUuid": "ff493316-faea-4f15-8abb-2990542122d5",
            "tableName": "53",
            "customersCount": 1,
            "orderReference": "250525-P-0012",
            "totalTaxes": "85.93",
            "finishedAt": "2025-05-25T20:47:58Z",
            "createdByUserUuid": "ecd73019-8788-4750-a174-d129d907b382",
            "orderName": ""
        },
        {
            "createdAt": "2025-05-25T19:49:52Z",
            "updatedAt": "2025-05-25T21:11:38Z",
            "uuid": "b3dfdb0e-adb3-45ac-a80d-cae27e2b6c87",
            "status": "FINISHED",
            "provider": "PARROT",
            "storeUuid": "d472f6fd-fa54-4654-a59b-6694557bae44",
            "storeName": "Parrot Café",
            "providerOrderId": null,
            "orderType": "DINE_IN",
            "orderTypeNameUuid": "cc440b54-242b-418e-867f-ce57fb098104",
            "orderTypeName": "Comer Aqui",
            "totalPrice": "2420.00",
            "total": "2420.00",
            "brandName": "Parrot Café",
            "invoicingCode": "B3D250525B6C87",
            "invoicingExpiresAt": "2025-06-01T05:59:59Z",
            "totalDiscounts": "0.00",
            "orderDiscount": null,
            "totalServiceCharges": "0.00",
            "tableUuid": "cc70b636-41c0-444a-9d56-121cb0293001",
            "tableName": "14",
            "customersCount": 2,
            "orderReference": "250525-P-0007",
            "totalTaxes": "333.79",
            "finishedAt": "2025-05-25T21:11:38Z",
            "createdByUserUuid": "c67c44f6-6c65-40a2-91e0-167c02ed2e41",
            "orderName": ""
        }
    ],
    "datetime": "2025-08-25T18:00:00-06:00"
}
Modified at 2025-08-25 23:56:14
Previous
List Supplies
Next
V1 - List Order Items
Built with