Get Orders By Store ID
List all orders for a store with filters for payment status, type, delivery status, and date ranges.
When to Use
▾
Use this endpoint when:
- Building an orders dashboard
- Filtering orders by status, type, or date
- Running reports across delivery / dine-in / pickup / drive-thru
How to Use
▾
/v3/servicePOST function: "get.store.orders" with the storeId and optional filter fields. Supports pagination via cursor.
Request Parameters
▾
alacarte service
Example: "alacarte"
Currently only support v1
Example: "v1"
Function provided by alacarte
Example: "get.store.orders"
Request body
Store ID
Example: "2808912573238362402"
Filter by part of Order ID
Example: "610a61722c0efd453116420c"
Filter by part of short order ID
Example: "jm9espv4"
Pagination cursor
Example: ""
Filter by payment status. Values: PROGRESSING, FINDING_COURIER, SHIPPING, COMPLETED, REJECTED
Example: ["COMPLETED"]
Filter from order start date
Example: "2020-09-22T02:00:00.000Z"
Filter to order end date
Example: "2020-09-22T02:00:00.000Z"
Filter from delivery start date
Example: "2020-09-22T02:00:00.000Z"
Filter to delivery end date
Example: "2020-09-22T02:00:00.000Z"
Filter by order type. Values: DINEIN, DELIVERY, PICKUP, DRIVE_THRU
Example: ["DINEIN","DELIVERY"]
Filter by delivery status. Values: EMPTY, WAITING_FOR_PAYMENT, WAIT_FOR_CONFIRMATION, CANCELLED, PROGRESSING, WAITING_FOR_COURIER, FINDING_COURIER, SHIPPING, COMPLETED, DELAYED, REJECTED
Example: ["WAIT_FOR_CONFIRMATION","FINDING_COURIER"]
Sort field. Use - prefix for descending, + for ascending. e.g. -deliveryAt, +orderAt
Example: ["-deliveryAt"]
Response Parameters
▾
Optional, if pagination exists.
Example: "3235"
Current page record
Example: 25
List of orders
Creation date time of store
Example: "2020-09-22T04:44:57.950398414Z"
Customer info
Country Code
Example: "60"
Customer Email
Example: "[email protected]"
Customer ID
Example: "5f63082ae9c755d6ba3122ac"
Customer Name
Example: "Bassem AlSabbagh"
Customer contact number
Example: "1123621544"
Delivery info (null if not delivery)
When and what time the order deliver
Example: "2020-10-01T08:35:22.525Z"
Drive thru info (null if not drive thru)
Order items
Item description
Example: "got Nasi gt lemak"
Item Image
Example: []
Item ID
Example: "5f69a41f212de28db36031d6"
Item Name
Example: "Nasi lemak & Lemak"
Item preferences
Preferences ID
Example: "5f698149585d7cc1ae35a38d"
Preferences name
Example: "Sweetness"
Preference labels
Label ID
Example: "5f698149585d7cc1ae35a38e"
Label name
Example: "Basic"
Item price
Amount in cent
Example: 100
Currency type
Example: "MYR"
Item Quantity
Example: 1
Customer Remark
Example: ""
Item sides
Side ID
Example: ""
Side Name
Example: "test"
Side items
Side Item ID
Example: "5f7b4195021ba83f52a02551"
Side Item Name
Example: "Hainan Chicken Rice"
Side item price
Amount in cent
Example: 100
Currency type
Example: "MYR"
Order ID
Example: "5f7596e066ef1c1a4f9807f4"
Payment info
Delivery fee
Amount in cent
Example: 0
Currency type
Example: "MYR"
Rounding amount
Amount in cent
Example: 0
Currency type
Example: "MYR"
Service fee
Amount in cent
Example: 0
Currency type
Example: "MYR"
Percentage (divide by 100)
Example: 0
Service tax
Amount in cent
Example: 0
Currency type
Example: "MYR"
Percentage (divide by 100)
Example: 0
Payment Status (PAID, NOTPAID, PENDING, REFUNDED)
Example: "NOTPAID"
Sub total
Amount in cent
Example: 200
Currency type
Example: "MYR"
Total after rounding
Amount in cent
Example: 200
Currency type
Example: "MYR"
Total before rounding
Amount in cent
Example: 200
Currency type
Example: "MYR"
Quantity of the item
Example: 1
Queue number of the item
Example: 0
Order state. Values: ACCEPTED, REJECTED, CANCELED, REFUNDED
Example: "ACCEPTED"
Delivery status. Values: EMPTY, WAITING_FOR_PAYMENT, WAIT_FOR_CONFIRMATION, CANCELLED, PROGRESSING, WAITING_FOR_COURIER, FINDING_COURIER, SHIPPING, COMPLETED, DELAYED, REJECTED
Example: "EMPTY"
ID of the Store that Create from RM
Example: "10946114768247530"
Table info
Table ID
Example: "5e86af7ef9e6794801df3302"
Table is active
Example: true
Is default table
Example: false
Table Name
Example: "Table A1"
Order type. Values: DINEIN, DELIVERY, PICKUP, DRIVE_THRU
Example: ""
Last update date time
Example: "2020-10-01T08:44:16.863Z"