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

V1 - List Order Items

Deprecated
GET
/v1/order-items
This endpoint retrieves order items within a specified time range, with pagination support. It returns a list of order items containing details such as the item name, quantity, price, discount, and total cost, along with order-related information like the order UUID, reference, and type. The response also includes pagination metadata.
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"]

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 '/v1/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'

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 {27}] 
required
createdAt
string 
required
storeUuid
string 
required
storeName
string 
required
provider
string 
required
brandName
string 
required
orderUuid
string 
required
orderTypeUuid
string 
required
orderTypeName
string 
required
orderReference
string 
required
sku
string 
required
productType
null 
required
productUuid
string  | null 
required
uuid
string 
required
itemName
string 
required
itemType
string 
required
parentUuid
string  | null 
required
quantity
integer 
required
unitCost
integer 
required
unitPrice
integer 
required
totalPrice
integer 
required
currencyCode
string 
required
discount
null 
required
total
integer 
required
itemStatus
string 
required
categoryUuid
string  | null 
required
categoryName
string  | null 
required
createdByUserUuid
string  | null 
required
datetime
string 
required
Example
{
    "pagination": {
        "next": 1,
        "previous": null,
        "count": 14,
        "current": 0,
        "pageSize": 10
    },
    "data": [
        {
            "createdAt": "2025-05-10T01:17:51Z",
            "storeUuid": "dd68ea6f-c87c-438a-abe6-4df2ad6a8b46",
            "storeName": "Pickup Coffee (Vallejo)",
            "provider": "PARROT",
            "brandName": "Pickup Coffee (Vallejo)",
            "orderUuid": "57d30311-db47-4e42-bbad-4e45427339bf",
            "orderTypeUuid": "f1597f47-d9e1-4f6b-be8a-7ab284f7d002",
            "orderTypeName": "Mostrador",
            "orderReference": "090525-P-0043",
            "sku": "AR-201701212906908",
            "productType": null,
            "productUuid": null,
            "uuid": "1fe07635-a092-4a2f-b3c7-6cee707c1809",
            "itemName": "Caliente Regular (350ml)",
            "itemType": "ADD_ON",
            "parentUuid": "7e5cfa29-c5c0-4c22-8660-63fd39794dcd",
            "quantity": 1.00,
            "unitCost": 4.00,
            "unitPrice": 4.00,
            "totalPrice": 4.00,
            "currencyCode": "MXN",
            "discount": null,
            "total": 4.00,
            "itemStatus": "ACTIVE",
            "categoryUuid": null,
            "categoryName": null,
            "createdByUserUuid": null
        },
        {
            "createdAt": "2025-05-10T01:17:51Z",
            "storeUuid": "dd68ea6f-c87c-438a-abe6-4df2ad6a8b46",
            "storeName": "Pickup Coffee (Vallejo)",
            "provider": "PARROT",
            "brandName": "Pickup Coffee (Vallejo)",
            "orderUuid": "57d30311-db47-4e42-bbad-4e45427339bf",
            "orderTypeUuid": "f1597f47-d9e1-4f6b-be8a-7ab284f7d002",
            "orderTypeName": "Mostrador",
            "orderReference": "090525-P-0043",
            "sku": "AR-1701323679110",
            "productType": null,
            "productUuid": null,
            "uuid": "608ee75a-8ad8-4a78-895d-36ac9cd3dbf5",
            "itemName": "Deslactosada",
            "itemType": "ADD_ON",
            "parentUuid": "d2434925-fb36-4490-b3d4-8d52c9fa54dd",
            "quantity": 1.00,
            "unitCost": 9.00,
            "unitPrice": 9.00,
            "totalPrice": 9.00,
            "currencyCode": "MXN",
            "discount": null,
            "total": 9.00,
            "itemStatus": "ACTIVE",
            "categoryUuid": null,
            "categoryName": null,
            "createdByUserUuid": null
        },
        {
            "createdAt": "2025-05-10T01:17:51Z",
            "storeUuid": "dd68ea6f-c87c-438a-abe6-4df2ad6a8b46",
            "storeName": "Pickup Coffee (Vallejo)",
            "provider": "PARROT",
            "brandName": "Pickup Coffee (Vallejo)",
            "orderUuid": "57d30311-db47-4e42-bbad-4e45427339bf",
            "orderTypeUuid": "f1597f47-d9e1-4f6b-be8a-7ab284f7d002",
            "orderTypeName": "Mostrador",
            "orderReference": "090525-P-0043",
            "sku": "AR-1701323679110",
            "productType": null,
            "productUuid": null,
            "uuid": "73d61ce9-837f-42fb-90b2-4cb448b18618",
            "itemName": "Deslactosada",
            "itemType": "ADD_ON",
            "parentUuid": "7e5cfa29-c5c0-4c22-8660-63fd39794dcd",
            "quantity": 1.00,
            "unitCost": 9.00,
            "unitPrice": 9.00,
            "totalPrice": 9.00,
            "currencyCode": "MXN",
            "discount": null,
            "total": 9.00,
            "itemStatus": "ACTIVE",
            "categoryUuid": null,
            "categoryName": null,
            "createdByUserUuid": null
        },
        {
            "createdAt": "2025-05-10T01:17:51Z",
            "storeUuid": "dd68ea6f-c87c-438a-abe6-4df2ad6a8b46",
            "storeName": "Pickup Coffee (Vallejo)",
            "provider": "PARROT",
            "brandName": "Pickup Coffee (Vallejo)",
            "orderUuid": "57d30311-db47-4e42-bbad-4e45427339bf",
            "orderTypeUuid": "f1597f47-d9e1-4f6b-be8a-7ab284f7d002",
            "orderTypeName": "Mostrador",
            "orderReference": "090525-P-0043",
            "sku": "AR-1701211254396",
            "productType": null,
            "productUuid": "88814641-99c9-4446-8eaa-8d9b7e3d1768",
            "uuid": "7e5cfa29-c5c0-4c22-8660-63fd39794dcd",
            "itemName": "Nutella® Latte",
            "itemType": "PRODUCT",
            "parentUuid": null,
            "quantity": 1.00,
            "unitCost": 43.00,
            "unitPrice": 43.00,
            "totalPrice": 56.00,
            "currencyCode": "MXN",
            "discount": null,
            "total": 56.00,
            "itemStatus": "ACTIVE",
            "categoryUuid": "140f40b7-8672-4074-9192-cdf4dab36b84",
            "categoryName": "Favoritos UP",
            "createdByUserUuid": "343de892-cbd9-418a-987e-65d2fcf6e633"
        },
        {
            "createdAt": "2025-05-10T01:17:51Z",
            "storeUuid": "dd68ea6f-c87c-438a-abe6-4df2ad6a8b46",
            "storeName": "Pickup Coffee (Vallejo)",
            "provider": "PARROT",
            "brandName": "Pickup Coffee (Vallejo)",
            "orderUuid": "57d30311-db47-4e42-bbad-4e45427339bf",
            "orderTypeUuid": "f1597f47-d9e1-4f6b-be8a-7ab284f7d002",
            "orderTypeName": "Mostrador",
            "orderReference": "090525-P-0043",
            "sku": "AR-201701212906908",
            "productType": null,
            "productUuid": null,
            "uuid": "925dc0a0-e661-467e-901b-9e7342e5daeb",
            "itemName": "Caliente Regular (350ml)",
            "itemType": "ADD_ON",
            "parentUuid": "d2434925-fb36-4490-b3d4-8d52c9fa54dd",
            "quantity": 1.00,
            "unitCost": 2.00,
            "unitPrice": 2.00,
            "totalPrice": 2.00,
            "currencyCode": "MXN",
            "discount": null,
            "total": 2.00,
            "itemStatus": "ACTIVE",
            "categoryUuid": null,
            "categoryName": null,
            "createdByUserUuid": null
        },
        {
            "createdAt": "2025-05-10T01:17:51Z",
            "storeUuid": "dd68ea6f-c87c-438a-abe6-4df2ad6a8b46",
            "storeName": "Pickup Coffee (Vallejo)",
            "provider": "PARROT",
            "brandName": "Pickup Coffee (Vallejo)",
            "orderUuid": "57d30311-db47-4e42-bbad-4e45427339bf",
            "orderTypeUuid": "f1597f47-d9e1-4f6b-be8a-7ab284f7d002",
            "orderTypeName": "Mostrador",
            "orderReference": "090525-P-0043",
            "sku": "AR-1701211254378",
            "productType": null,
            "productUuid": "69928a43-f8b1-4ca9-8f86-3bda92327fdb",
            "uuid": "d2434925-fb36-4490-b3d4-8d52c9fa54dd",
            "itemName": "Chocolate",
            "itemType": "PRODUCT",
            "parentUuid": null,
            "quantity": 1.00,
            "unitCost": 31.00,
            "unitPrice": 31.00,
            "totalPrice": 42.00,
            "currencyCode": "MXN",
            "discount": null,
            "total": 42.00,
            "itemStatus": "ACTIVE",
            "categoryUuid": "140f40b7-8672-4074-9192-cdf4dab36b84",
            "categoryName": "Favoritos UP",
            "createdByUserUuid": "343de892-cbd9-418a-987e-65d2fcf6e633"
        },
        {
            "createdAt": "2025-05-10T01:44:29Z",
            "storeUuid": "dd68ea6f-c87c-438a-abe6-4df2ad6a8b46",
            "storeName": "Pickup Coffee (Vallejo)",
            "provider": "PARROT",
            "brandName": "Pickup Coffee (Vallejo)",
            "orderUuid": "f585b486-9928-438b-b422-66a14ebe6625",
            "orderTypeUuid": "f1597f47-d9e1-4f6b-be8a-7ab284f7d002",
            "orderTypeName": "Mostrador",
            "orderReference": "090525-P-0044",
            "sku": "AR-1714657128533",
            "productType": null,
            "productUuid": "5eb9408b-4e17-47c6-b590-3c051f7c63a3",
            "uuid": "27ff370a-6de5-48d6-ad07-44f6e86b4921",
            "itemName": "Café del día",
            "itemType": "PRODUCT",
            "parentUuid": null,
            "quantity": 1.00,
            "unitCost": 13.00,
            "unitPrice": 13.00,
            "totalPrice": 13.00,
            "currencyCode": "MXN",
            "discount": null,
            "total": 13.00,
            "itemStatus": "ACTIVE",
            "categoryUuid": "7682c997-d640-4fe7-b7fe-7f6b7695cca7",
            "categoryName": "Clásicos",
            "createdByUserUuid": "343de892-cbd9-418a-987e-65d2fcf6e633"
        },
        {
            "createdAt": "2025-05-10T01:44:29Z",
            "storeUuid": "dd68ea6f-c87c-438a-abe6-4df2ad6a8b46",
            "storeName": "Pickup Coffee (Vallejo)",
            "provider": "PARROT",
            "brandName": "Pickup Coffee (Vallejo)",
            "orderUuid": "f585b486-9928-438b-b422-66a14ebe6625",
            "orderTypeUuid": "f1597f47-d9e1-4f6b-be8a-7ab284f7d002",
            "orderTypeName": "Mostrador",
            "orderReference": "090525-P-0044",
            "sku": "AR-1701317152621",
            "productType": null,
            "productUuid": null,
            "uuid": "82e622f0-c77a-4942-9244-8ce3e3517e9c",
            "itemName": "Caliente Chico (230ml)",
            "itemType": "ADD_ON",
            "parentUuid": "27ff370a-6de5-48d6-ad07-44f6e86b4921",
            "quantity": 1.00,
            "unitCost": 0.00,
            "unitPrice": 0.00,
            "totalPrice": 0.00,
            "currencyCode": "MXN",
            "discount": null,
            "total": 0.00,
            "itemStatus": "ACTIVE",
            "categoryUuid": null,
            "categoryName": null,
            "createdByUserUuid": null
        },
        {
            "createdAt": "2025-05-10T14:21:21Z",
            "storeUuid": "dd68ea6f-c87c-438a-abe6-4df2ad6a8b46",
            "storeName": "Pickup Coffee (Vallejo)",
            "provider": "PARROT",
            "brandName": "Pickup Coffee (Vallejo)",
            "orderUuid": "5bfbda8b-9e20-407f-bb07-079b53f90042",
            "orderTypeUuid": "f1597f47-d9e1-4f6b-be8a-7ab284f7d002",
            "orderTypeName": "Mostrador",
            "orderReference": "100525-P-0001",
            "sku": "AR-1732038499227",
            "productType": null,
            "productUuid": "9ffe1674-8085-4c04-9e47-34ff018c2597",
            "uuid": "46090f6b-36c9-4a88-8c1c-0766c8e1e7b8",
            "itemName": "Trenza",
            "itemType": "PRODUCT",
            "parentUuid": null,
            "quantity": 1.00,
            "unitCost": 39.00,
            "unitPrice": 39.00,
            "totalPrice": 39.00,
            "currencyCode": "MXN",
            "discount": null,
            "total": 39.00,
            "itemStatus": "ACTIVE",
            "categoryUuid": "cbd695f6-46f5-4fdb-a871-d7895e0aae2b",
            "categoryName": "Bites",
            "createdByUserUuid": "2da9440e-c936-4ab5-890d-2d1bda1e534a"
        },
        {
            "createdAt": "2025-05-10T14:21:21Z",
            "storeUuid": "dd68ea6f-c87c-438a-abe6-4df2ad6a8b46",
            "storeName": "Pickup Coffee (Vallejo)",
            "provider": "PARROT",
            "brandName": "Pickup Coffee (Vallejo)",
            "orderUuid": "5bfbda8b-9e20-407f-bb07-079b53f90042",
            "orderTypeUuid": "f1597f47-d9e1-4f6b-be8a-7ab284f7d002",
            "orderTypeName": "Mostrador",
            "orderReference": "100525-P-0001",
            "sku": "AR-1714077545885",
            "productType": null,
            "productUuid": null,
            "uuid": "c5995435-fad2-4878-b124-4dcfaa9e37db",
            "itemName": "Regular",
            "itemType": "ADD_ON",
            "parentUuid": "d68f21ba-316b-4fdb-af11-461b7eb7821d",
            "quantity": 1.00,
            "unitCost": 3.00,
            "unitPrice": 3.00,
            "totalPrice": 3.00,
            "currencyCode": "MXN",
            "discount": null,
            "total": 3.00,
            "itemStatus": "ACTIVE",
            "categoryUuid": null,
            "categoryName": null,
            "createdByUserUuid": null
        }
    ],
    "datetime": "2025-05-12T14:45:43-06:00"
}
Modified at 2025-07-01 15:49:27
Previous
List Orders
Next
V2 - List Order Items
Built with