Get list of orders V1
Get a list of orders ordered by created date from a location depending on the page parameters provided.
GET
/v1/orders/authorization<token>
To get an API key, please contact us. We'll be happy to help you.
In: header
Query Parameters
index?integer
Index of the page query parameter
Default
0Range
0 <= valuesize?integer
Number of record on a page query parameter (capped to 100)
Default
10Range
1 <= value <= 100since?string
Start date for date range (first day included). Accepts a date in the format ISO 8601 : YYYY-MM-DD
Match
^[0-9]{4}-(((0[13578]|(10|12))-(0[1-9]|[1-2][0-9]|3[0-1]))|(02-(0[1-9]|[1-2][0-9]))|((0[469]|11)-(0[1-9]|[1-2][0-9]|30)))$until?string
End date for date range (last day included). Accepts a date in the format ISO 8601 : YYYY-MM-DD
Match
^[0-9]{4}-(((0[13578]|(10|12))-(0[1-9]|[1-2][0-9]|3[0-1]))|(02-(0[1-9]|[1-2][0-9]))|((0[469]|11)-(0[1-9]|[1-2][0-9]|30)))$reportId?string
Report id query parameter
Format
uuidResponse Body
curl -X GET "https://api.pragma-project.dev/v1/orders/?index=0&size=10&since=string&until=string&reportId=497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"data": [
{
"id": "b3b4c5d6-e7f8-a9b0-c1d2-e3f4a5b6c7d8",
"deviceId": "a2049f39-026a-4c54-a411-8a1d9271804b",
"createdAt": {},
"updatedAt": {},
"locationId": "d6f5e4d3-c2b1-42a0-9c68-31a3b4d5e6f7",
"reportId": "9cad608b-48cc-40ed-ae8b-032ec54a0472",
"openedAt": {},
"closedAt": {},
"guests": 2,
"orderPlace": "Terrasse",
"orderNumber": "10",
"operatorId": "70c3d28a-1b3a-43f0-aa4f-5b78a932f7dc",
"operatorName": "Jane Doe",
"total": 20,
"totalTax": 1.82,
"totalDiscount": 5,
"customerId": "-Mkw59Hj9X7iGwz0Y866",
"isCanceled": false,
"isTransferred": false,
"transferReason": null,
"cancelReason": null,
"items": [
{
"description": "Coca Cola",
"quantity": 5,
"weight": null,
"unitPrice": 4,
"total": 20,
"category": "Eaux & sodas",
"subCategory": "Sodas",
"isCanceled": false,
"cancelReason": null,
"tier": "Normal",
"isTransferred": false,
"transferReason": null,
"discountsApplied": [],
"modifiers": [
{
"modifierGroupId": "a79a00cd-ed01-4a59-9025-d3e738316bd5",
"modifierId": "a3b4c5d6-e7f8-a9b0-c1d2-e3f4a5b6c7d8",
"name": "Supplément glaçons"
}
],
"stockImpactIndicator": true,
"tax": {
"taxName": "TVA 10%",
"taxRate": 0.1,
"taxAmount": 1.82,
"taxCatalogId": "a954f58c-8864-45cc-ada2-d7cc8476aade"
},
"itemCatalogId": "d7af5760-3e89-4a3d-a82a-ca802dadd5f7",
"isLoss": false,
"lossReason": null
},
{
"description": "Café Liegeois",
"quantity": 1,
"weight": null,
"unitPrice": 5,
"total": 0,
"category": "Boissons chaudes",
"subCategory": "Boissons chaudes",
"isCanceled": false,
"tier": "Normal",
"cancelReason": null,
"isTransferred": false,
"transferReason": null,
"discountsApplied": [
{
"discountName": "Offert client",
"discountValue": 5,
"discountCatalogId": "c8352cae-7dff-4ba6-9559-2d4b11be1403"
}
],
"tax": {
"taxName": "TVA 10%",
"taxAmount": 0,
"taxRate": 0.1,
"taxCatalogId": "a954f58c-8864-45cc-ada2-d7cc8476aade"
},
"itemCatalogId": "d7af5760-3e89-4a3d-a82a-ca802dadd5f7",
"isLoss": false,
"lossReason": null
}
],
"menus": [],
"payments": [
{
"paymentAmount": 20,
"paymentName": "Espèces",
"paymentCatalogId": "758941b8-351b-4506-bc7e-9b488c897c44"
}
],
"tips": null,
"channel": "unknown",
"serviceType": "delivery",
"isTraining": false,
"source": "unknown",
"externalLocationId": null,
"externalOrderId": null
}
],
"meta": {
"totalCount": 1,
"currentPageIndex": 0,
"totalPage": 1,
"pageSize": 10
},
"links": {
"self": "https://api.popina.com/v1/orders?since=2023-01-01T00:00:00Z&until=2023-12-31T23:59:59Z",
"first": "https://api.popina.com/v1/orders?since=2023-01-01T00:00:00Z&until=2023-12-31T23:59:59Z&index=0&size=10",
"last": "https://api.popina.com/v1/orders?since=2023-01-01T00:00:00Z&until=2023-12-31T23:59:59Z&index=3&size=10",
"next": "https://api.popina.com/v1/orders?since=2023-01-01T00:00:00Z&until=2023-12-31T23:59:59Z&index=1&size=10",
"prev": null
}
}