Get Orders By Store ID

Method : POST

URL: https://open.revenuemonster.my/v3/service

Sandbox URL: https://sb-open.revenuemonster.my/v3/service

note
  • Get orders by storeId.

Request Parameters#

note
  • Current type in paymentStatus will be :-

    • "PROGRESSING" , "FINDING_COURIER" , "SHIPPING" , "COMPLETED" , "REJECTED"
  • Current type in deliveryStatus will be :-

    • "EMPTY"
    • "WAITING_FOR_PAYMENT"
    • "WAIT_FOR_CONFIRMATION"
    • "CANCELLED"
    • "PROGRESSING"
    • "WAITING_FOR_COURIER"
    • "FINDING_COURIER"
    • "SHIPPING"
    • "COMPLETED"
    • "DELAYED"
    • "REJECTED"
  • Current type in type will be :-

    • "DINEIN" , "DELIVERY" , "PICKUP", "DRIVE_THRU"
ParameterTypeDescriptionExample
serviceStringalacarte service"alacarte"
versionStringCurrently only support 'v1""v1"
functionStringFunction that provide by alacarte"get.store.orders"
requestObjectRefer to explanation below(Refer to explanation below)
ParameterTypeRequiredDescriptionExample
storeIdStringYesID of the Store that Create from RM"2808912573238362402"
cursorStringOptionalFilter by cursor""
paymentStatusArrayOptionalFilter by Payment Status["COMPLETED"]
startOrderAtDateTimeOptionalFilter by Start Order At"2020-09-22T02:00:00.000Z"
endOrderAtDateTimeOptionalFilter by End Order At"2020-09-22T02:00:00.000Z"
startDeliveryAtDateTimeOptionalFilter by Start Delivery At"2020-09-22T02:00:00.000Z"
endDeliveryAtDateTimeOptionalFilter by End Delivery At"2020-09-22T02:00:00.000Z"
typeArrayOptionalFilter by Type["DINEIN","DELIVERY"]
deliveryStatusArrayOptionalFilter by Delivery Status["WAIT_FOR_CONFIRMATION","FINDING_COURIER"]
sortArrayOptionalFilter by Sort "deliveryAt" or "orderAt" ("-" mean descending "+" mean ascending)["-deliveryAt"]

Optional

Example Request

curl --location --request POST 'https://sb-open.revenuemonster.my/v3/service' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjIwMTgtMDMtMTMiLCJ0eXAiOiJKV1QifQ.eyJhdWQiOlsiYXBpX2NsaWVudEBFaGNLQzA5QmRYUm9RMnhwWlc1MEVKTE42dFdBMG82MEx3Il0sImV4cCI6MTYwMzI1NDU2OSwiaWF0IjoxNjAwNjYyNTY5LCJpc3MiOiJodHRwczovL3NiLW9hdXRoLnJldmVudWVtb25zdGVyLm15IiwianRpIjoiRWh3S0VFOUJkWFJvUVdOalpYTnpWRzlyWlc0UTZNenR5b1RFckpzVyIsIm5iZiI6MTYwMDY2MjU2OSwic3ViIjoiRWhRS0NFMWxjbU5vWVc1MEVKWFZ6ZDN3cmFxVE9SSVFDZ1JWYzJWeUVJeUpxSXp2eU1QVmNRIn0.H3G6UDX7sR9EXtTMNs4Q2OHdhUGIhhCfdlAeOpywH4rDuVOcWXXwzF4Imbx8E7I10vFAJpwYZrEkCWCdCCw-WV11y9VT5kP6k75CeS-ZPMOLcKnC5iFT7vEi07r6ovwty9erlcZeXrtrmEIn3rnLva-dxSg3vZ2MyymoNDk-kV7ltXnkoWW4jtXRls6siLhxeY__8kXn2qa0ojVX4Nm6HmzN_vgi-RKSmToMgsdzTF94Y61QVBWhZfolD2-JpHx4qNlklcUdv8HOJ1QHHWpyoJytaJmvr3GJ5G399LbcTLwxB1p2qPg7z4hpoGNu4AP-ybRJVC3P9q9OscQYDNX-dA' \
--header 'X-Signature: sha256 Sty3LNcKA8+WlMHtAgIY+y1xbwnzKsN0UdyKaW+yYIgcTkBAtF7G5Lx251qQITURJ4wiXPDODxhs1nFVmBBing==' \
--header 'X-Nonce-Str: VYNknZohxwicZMaWbNdBKUrnrxDtaRhN' \
--header 'X-Timestamp: 1528450585' \
--data-raw '{
"service": alacarte",
"version": "v1",
"function": "get.store.orders",
"request": {
"storeId": "2808912573238362402",
"cursor": "",
"paymentStatus": ["COMPLETED"],
"startOrderAt": "2020-09-22T02:00:00.000Z",
"endOrderAt": "2020-09-22T02:00:00.000Z",
"startDeliveryAt": "2020-09-22T02:00:00.000Z",
"endDeliveryAt": "2020-09-22T02:00:00.000Z",
"type": ["DINEIN","DELIVERY"],
"deliveryStatus": ["WAIT_FOR_CONFIRMATION","FINDING_COURIER"],
"sort": ["-deliveryAt"]
}
}'

Response Parameters#

note
  • Current type in Status will be :-

    • "EMPTY"
    • "WAITING_FOR_PAYMENT"
    • "WAIT_FOR_CONFIRMATION"
    • "CANCELLED"
    • "PROGRESSING"
    • "WAITING_FOR_COURIER"
    • "FINDING_COURIER"
    • "SHIPPING"
    • "COMPLETED"
    • "DELAYED"
    • "REJECTED"
  • Current type in State will be :-

    • "ACCEPTED" , "REJECTED" , "CANCELED" , "REFUNDED"
  • Current type in Type will be :-

    • "DINEIN" , "DELIVERY" , "PICKUP", "DRIVE_THRU"
ParameterTypeDescriptionExample
cursorStringOptional, if pagination exists."3235"
countUintCurrent page record25
itemsArrayRefer to explanation below(Refer to explanation below)

Inside Items (parameter)#

ParameterTypeDescriptionExample
createdAtDateTimeCreation date time of store"2020-09-22T04:44:57.950398414Z"
customerObjectRefer to explanation below(Refer to explanation below)
deliveryObjectRefer to explanation below(Refer to explanation below)
deliveryAtStringWhen and what time the order deliver"2020-10-01T08:35:22.525Z"
driveThruObjectRefer to explanation below(Refer to explanation below)
itemsArrayRefer to explanation below(Refer to explanation below)
orderIdStringOrder ID"5f7596e066ef1c1a4f9807f4"
paymentObjectRefer to explanation below(Refer to explanation below)
quantityUintQuantity of the item1
queueNoUintQueue number of the item0
stateStringState of the item"ACCEPTED"
statusStringStatus of the item"EMPTY"
storeIdStringID of the Store that Create from RM"10946114768247530"
tableObjectRefer to explanation below(Refer to explanation below)
typeStringType of the item""
updatedAtDateTimeLast update date time"2020-10-01T08:44:16.863Z"

Inside Customer (parameter)#

ParameterTypeDescriptionExample
countryCodeStringCountry Code"60"
emailStringCustomer Email"bassem@revenuemosnter.my"
nameStringCustomer Name"Bassem AlSabbagh"
phoneNumberStringCustomer contact number"1123621544"
idStringCustomer ID"5f63082ae9c755d6ba3122ac"

Inside Delivery (parameter)#

ParameterTypeDescriptionExample
addressStringRefer to explanation below(Refer to explanation below)
courierStringRefer to explanation below(Refer to explanation below)
distanceInMeterIntDelivery Distance (In Meter)17446
idStringCustomer contact number"5f815e2c3c6920f1233a540f"
methodStringCustomer ID"OWN"
vendorIdStringCustomer ID"5f815e2c3c6920f1233a540f"

Inside Address (parameter)#

ParameterTypeDescriptionExample
addressLine1StringAddressLine1""
addressLine2StringAddressLine2""
cityStringCity""
countryStringCountry""
latitudeIntAddress latitude (In Meter)0
longitudeIntAddress longitude (In Meter)0
nameStringCustomer Name""
postCodeStringCustomer Remark""
remarkStringCustomer Remark""
stateStringAddress State""
unitStringAddress Unit""

Inside Courier (parameter)#

note
  • If Courier don't have name and phone will display as null
ParameterTypeDescriptionExample
idStringCourier ID""
latitudeIntAddress latitude (In Meter)0
longitudeIntAddress longitude (In Meter)0
nameStringCourier Name"Testing123"
phoneStringCourier Contact Number"163698122"
photoURLStringCourier Image""
surnameStringCourier Surname""

Inside Drive Thru (parameter)#

note
  • If not Drive Thru will display null
ParameterTypeDescriptionExample
vehicleDescriptionStringVehicle description""
vehicleNoStringVehicle Number"TLA3202"

Inside Items (parameter)#

ParameterTypeDescriptionExample
descriptionStringItem description"got Nasi gt lemak"
imageUrlArrayItem Image[]
itemIdStringItem ID"5f69a41f212de28db36031d6"
nameStringItem Name"Nasi lemak & Lemak"
preferencesArrayRefer to the Preferences parameter(Refer to the Preferences parameter)
priceObjectRefer to the Price parameter( Refer to the Price parameter)
quantityUintItem Quantity1
remarkStringCustomer Remark""
sidesArrayRefer to the Sides parameter( Refer to the Sides parameter)

Inside Preferences (parameter)#

note
  • Will display Empty Array when don't have preferences
ParameterTypeDescriptionExample
idStringPreferences ID"5f698149585d7cc1ae35a38d"
nameStringPreferences name"Sweetness"
minChoiceUintSet minimum choice1
maxChoiceUintSet maximum choice3
labelsArrayRefer to explanation below(Refer to explanation below)

Inside Labels (parameter)#

ParameterTypeDescriptionExample
idStringLabel ID"5f698149585d7cc1ae35a38e"
nameStringLabel name"Basic"

Inside Sides (parameter)#

note
  • Will display Empty Array when don't have sides
ParameterTypeDescriptionExample
idStringSide ID""
nameStringSide Name"test"
sideItemsArrayRefer to the SideItems parameterRefer to the SideItems parameter

Inside SideItems (parameter)#

ParameterTypeDescriptionExample
idStringSide ID"5f7b4195021ba83f52a02551"
nameStringSide Name"Hainan Chicken Rice"
priceObjectRefer to the Price parameterRefer to the Price parameter

Inside Payment (parameter)#

note

Current type in Payment will be :-

"PAID" , "NOTPAID" , "PENDING" , "REFUNDED"

ParameterTypeDescriptionExample
deliveryFeeObjectRefer to the Price parameter( Refer to the Price parameter)
roundingObjectRefer to the Price parameter( Refer to the Price parameter)
serviceFeeObjectRefer to the Price parameter( Refer to the Price parameter)
serviceTaxObjectRefer to the Price parameter( Refer to the Price parameter)
statusStringPayment Status"NOTPAID"
subTotalObjectRefer to the Price parameter( Refer to the Price parameter)
totalAfterRoundingObjectRefer to the Price parameter( Refer to the Price parameter)
totalBeforeRoundingObjectRefer to the Price parameter( Refer to the Price parameter)

Inside Price (parameter)#

note

Only serviceFee and serviceTax have percentage

ParameterTypeDescriptionExample
amountUintAmount in cent (min RM 0.10 10 = RM 0.10)100
currencyTypeStringCurrent only support Ringgit Malaysia"MYR"
percentageUintprecentage will be divide 100 eg: 1300/1001300

Inside Table (parameter)#

ParameterTypeDescriptionExample
idStringTable ID"5e86af7ef9e6794801df3302"
isAvailableBoolVehicle Numbertrue
isDefaultBoolVehicle Numbertrue
nameStringTable Name"Default Table"

Example Response

{
"count": 25,
"cursor": "3235",
"items": [
{
"createdAt": "2019-04-26T05:14:27.414Z",
"customer": {
"countryCode": "",
"email": "",
"id": "5cb8412365e8e5c23a16fc77",
"name": "",
"phoneNumber": ""
},
"delivery": null,
"deliveryAt": "0001-01-01T00:00:00Z",
"driveThru": null,
"items": [
{
"description": "Char Ho Fan is the best.",
"imageUrl": [
"https://d2wu471yepgs9e.cloudfront.net/menu-item/default/5caafa0f1d27bc1843ed6b6c.jpeg"
],
"itemId": "5cc26d323347c8c07b5f6ab2",
"name": "Char Ho Fan",
"preferences": [
{
"id": "",
"labels": [
{
"id": "5cc26d323347c8c07b5f6aa7",
"name": "Average"
}
],
"name": "Spicy Level"
}
],
"price": {
"amount": 100,
"currencyType": "MYR"
},
"quantity": 1,
"remark": "",
"sides": [
{
"id": "",
"name": "Type of Drink",
"sideItems": [
{
"id": "5cc26d323347c8c07b5f6ab0",
"name": "Char Ho Fan",
"price": {
"amount": 100,
"currencyType": "MYR"
}
}
]
}
]
}
],
"orderId": "5cc293b36ab3f021ecbc9639",
"payment": {
"deliveryFee": {
"amount": 0,
"currencyType": ""
},
"rounding": {
"amount": 0,
"currencyType": "MYR"
},
"serviceFee": {
"amount": 0,
"currencyType": "",
"percentage": 0
},
"serviceTax": {
"amount": 0,
"currencyType": "",
"percentage": 0
},
"status": "NOTPAID",
"subTotal": {
"amount": 200,
"currencyType": "MYR"
},
"totalAfterRounding": {
"amount": 200,
"currencyType": "MYR"
},
"totalBeforeRounding": {
"amount": 200,
"currencyType": "MYR"
}
},
"quantity": 2,
"queueNo": 0,
"state": "ACCEPTED",
"status": "EMPTY",
"storeId": "10946114768247530",
"table": {
"id": "5cbd816ced1c1a83b063ae8d",
"isActive": true,
"isDefault": false,
"name": "Table A1"
},
"type": "",
"updatedAt": "2019-06-10T09:16:12.073Z"
}
]
}