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

V2 - List Order Items

Testing
GET
/v2/order-items
Retrieves order items 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
startTimestamp
string 
required
Example:
2024-03-27T19:00:00-06:00
endTimestamp
string 
required
Example:
2024-03-28T19:00:00-06:00
pageSize
integer 
optional
Example:
3
page
string 
optional
Example:
1
storeUUID
array[string]
optional
Example:
["a2f09385-7f1b-436c-9baa-bb9cf1174c25","206b8416-c3c8-4053-9bdf-a11f3ddd7da1"]
sort
enum<string> 
optional
The sorting of the items returned
Allowed values:
createdAt-createdAtupdatedAt-updatedAt
Default:
createdAt
Example:
-updatedAt

Request 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 '/v2/order-items?startTimestamp=2024-03-27T19:00:00-06:00&endTimestamp=2024-03-28T19:00:00-06:00&pageSize=3&page=1&storeUUID=a2f09385-7f1b-436c-9baa-bb9cf1174c25&storeUUID=206b8416-c3c8-4053-9bdf-a11f3ddd7da1&sort=-updatedAt'

Responses

🟢200OK
application/json
Body
pagination
object 
required
next
integer 
required
previous
null 
required
count
integer 
required
current
integer 
required
pageSize
integer 
required
data
array [object {21}] 
required
createdAt
integer 
required
storeUuid
string 
required
provider
string 
required
orderUuid
string 
required
orderTypeUuid
string  | null 
required
orderReference
string 
required
sku
string 
required
productTypeUuid
string 
required
uuid
string 
required
itemName
string 
required
quantity
integer 
required
unitPrice
integer 
required
totalPrice
integer 
required
Total price, including addons, before discounts
totalPrice = (unitPrice * quantity) + addonsTotalPrice
discount
integer 
required
total
integer 
required
Final price with order item discounts
total = (unitPrice * quantity) + addonsTotalPrice - discounts
Any discounts at the order level are not included in this calculation.
currencyCode
string 
required
itemStatus
string 
required
categoryUuid
string  | null 
required
productUuid
string 
required
createdByUserUuid
string  | null 
required
addons
array [object {9}] 
required
datetime
string 
required
Example
{
    "pagination": {
        "next": 1,
        "previous": null,
        "count": 18,
        "current": 0,
        "pageSize": 5
    },
    "data": [
        {
            "createdAt": "2025-05-25T15:01:46Z",
            "storeUuid": "8e56d234-ca79-414e-ae33-bf7fb58aa46c",
            "provider": "PARROT",
            "orderUuid": "7659df36-efd7-415d-af05-5a91b1c541bd",
            "orderTypeUuid": "66f47fcf-b63f-4ef5-8f63-20385d0aece1",
            "orderReference": "250525-P-0001",
            "sku": "AR-1736797713127",
            "productTypeUuid": "9270a316-6eb2-4fbd-b05a-a93020b3e3d7",
            "uuid": "53d34a66-724f-437f-a7b5-faeabd930e0c",
            "itemName": "Electrolit",
            "quantity": 1,
            "unitPrice": 35.00,
            "totalPrice": 35.00,
            "discount": 0,
            "total": 35.00,
            "currencyCode": "MXN",
            "itemStatus": "ACTIVE",
            "categoryUuid": "b61adfb9-4370-4703-b006-34b15c8ea94d",
            "productUuid": "ce1a0e9c-1e04-4053-9d42-90d1f6ddaec1",
            "createdByUserUuid": "932c4485-9dd4-48db-9296-57f1847741b3",
            "addons": [
                {
                    "currencyCode": "MXN",
                    "uuid": "99e1a120-3c15-4ddd-808d-41c44e72601f",
                    "sku": "AR-1737598735211",
                    "itemName": "Lima-limón",
                    "quantity": 1,
                    "unitPrice": 0.00,
                    "totalPrice": 0.00,
                    "itemStatus": "ACTIVE",
                    "parentUuid": "53d34a66-724f-437f-a7b5-faeabd930e0c"
                }
            ]
        },
        {
            "createdAt": "2025-05-25T15:37:56Z",
            "storeUuid": "8e56d234-ca79-414e-ae33-bf7fb58aa46c",
            "provider": "PARROT",
            "orderUuid": "89ec5e3c-3bcd-4caf-9194-789fb5b971bd",
            "orderTypeUuid": "66f47fcf-b63f-4ef5-8f63-20385d0aece1",
            "orderReference": "250525-P-0002",
            "sku": "AR-1729114576157",
            "productTypeUuid": "a80e1def-bae7-4e2e-9041-d9205600440f",
            "uuid": "8fa1f6cd-4dfb-4d2b-b6ec-f05a75dc5e96",
            "itemName": "Latte",
            "quantity": 1,
            "unitPrice": 60.00,
            "totalPrice": 60.00,
            "discount": 0,
            "total": 60.00,
            "currencyCode": "MXN",
            "itemStatus": "ACTIVE",
            "categoryUuid": "0409fb93-9809-4a0a-962e-382db0141be5",
            "productUuid": "779fc67e-1030-423b-8627-814677dd7cf9",
            "createdByUserUuid": "932c4485-9dd4-48db-9296-57f1847741b3",
            "addons": []
        },
        {
            "createdAt": "2025-05-25T16:19:30Z",
            "storeUuid": "8e56d234-ca79-414e-ae33-bf7fb58aa46c",
            "provider": "PARROT",
            "orderUuid": "0c749687-1e90-4870-8d7e-77cdc0b2c94e",
            "orderTypeUuid": "66f47fcf-b63f-4ef5-8f63-20385d0aece1",
            "orderReference": "250525-P-0003",
            "sku": "AR-1729114576170",
            "productTypeUuid": "a80e1def-bae7-4e2e-9041-d9205600440f",
            "uuid": "31c8dea5-adbe-49c2-b57c-d3e02b6787bd",
            "itemName": "Peanut Punch",
            "quantity": 1,
            "unitPrice": 115.00,
            "totalPrice": 115.00,
            "discount": 0,
            "total": 115.00,
            "currencyCode": "MXN",
            "itemStatus": "ACTIVE",
            "categoryUuid": "00de5123-a6af-422d-b6de-61182ceba02a",
            "productUuid": "fc1e07d5-dc3c-40b3-a0b7-1c4fe43f91b1",
            "createdByUserUuid": "932c4485-9dd4-48db-9296-57f1847741b3",
            "addons": [
                {
                    "currencyCode": "MXN",
                    "uuid": "97710bad-1c5b-458f-b58b-d09ae64b155c",
                    "sku": "AR-11729183219020",
                    "itemName": "No",
                    "quantity": 1,
                    "unitPrice": 0.00,
                    "totalPrice": 0.00,
                    "itemStatus": "ACTIVE",
                    "parentUuid": "31c8dea5-adbe-49c2-b57c-d3e02b6787bd"
                }
            ]
        },
        {
            "createdAt": "2025-05-25T16:51:20Z",
            "storeUuid": "8e56d234-ca79-414e-ae33-bf7fb58aa46c",
            "provider": "PARROT",
            "orderUuid": "c77c40fc-8ddb-41df-b4c1-7e60176a5cf5",
            "orderTypeUuid": "66f47fcf-b63f-4ef5-8f63-20385d0aece1",
            "orderReference": "250525-P-0004",
            "sku": "AR-1729114576163",
            "productTypeUuid": "a80e1def-bae7-4e2e-9041-d9205600440f",
            "uuid": "6b223a56-fc8b-477b-a615-da700f6d1b20",
            "itemName": "Frappé Clásico",
            "quantity": 1,
            "unitPrice": 75.00,
            "totalPrice": 75.00,
            "discount": 0,
            "total": 75.00,
            "currencyCode": "MXN",
            "itemStatus": "ACTIVE",
            "categoryUuid": "a10e2179-9972-4616-9362-e1495bb514b9",
            "productUuid": "3df78944-8c4f-41f7-b1da-736dc23ee6e1",
            "createdByUserUuid": "932c4485-9dd4-48db-9296-57f1847741b3",
            "addons": []
        },
        {
            "createdAt": "2025-05-25T16:51:20Z",
            "storeUuid": "8e56d234-ca79-414e-ae33-bf7fb58aa46c",
            "provider": "PARROT",
            "orderUuid": "c77c40fc-8ddb-41df-b4c1-7e60176a5cf5",
            "orderTypeUuid": "66f47fcf-b63f-4ef5-8f63-20385d0aece1",
            "orderReference": "250525-P-0004",
            "sku": "AR-1729114576163",
            "productTypeUuid": "a80e1def-bae7-4e2e-9041-d9205600440f",
            "uuid": "7b255ddb-8cbd-45c1-ab60-091f5bc744b6",
            "itemName": "Frappé Clásico",
            "quantity": 1,
            "unitPrice": 75.00,
            "totalPrice": 75.00,
            "discount": 0,
            "total": 75.00,
            "currencyCode": "MXN",
            "itemStatus": "ACTIVE",
            "categoryUuid": "a10e2179-9972-4616-9362-e1495bb514b9",
            "productUuid": "3df78944-8c4f-41f7-b1da-736dc23ee6e1",
            "createdByUserUuid": "932c4485-9dd4-48db-9296-57f1847741b3",
            "addons": []
        }
    ],
    "datetime": "2025-06-01T14:17:47-06:00"
}
Modified at 2025-06-16 23:36:46
Previous
V1 - List Order Items
Next
List Product Types
Built with