Skip to main content

Get Orders By Store ID

POST/v3/service
  • Get orders by storeId.

Request Parameters

  • 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"
serviceString

alacarte service

Example: "alacarte"

versionString

Currently only support 'v1"

Example: "v1"

functionString

Function that provide by alacarte

Example: "get.store.orders"

requestObject

Refer to explanation below

Example: (Refer to explanation below)

storeIdStringrequired

ID of the Store that Create from RM

Example: "2808912573238362402"

orderIdString

Filter by part of Order ID

Example: "610a61722c0efd453116420c"

shortOrderIdString

Filter by part of short order ID

Example: "jm9espv4"

cursorString

Filter by cursor

Example: ""

paymentStatusArray

Filter by Payment Status

Example: ["COMPLETED"]

startOrderAtDateTime

Filter by Start Order At

Example: "2020-09-22T02:00:00.000Z"

endOrderAtDateTime

Filter by End Order At

Example: "2020-09-22T02:00:00.000Z"

startDeliveryAtDateTime

Filter by Start Delivery At

Example: "2020-09-22T02:00:00.000Z"

endDeliveryAtDateTime

Filter by End Delivery At

Example: "2020-09-22T02:00:00.000Z"

typeArray

Filter by Type

Example: ["DINEIN","DELIVERY"]

deliveryStatusArray

Filter by Delivery Status

Example: ["WAIT_FOR_CONFIRMATION","FINDING_COURIER"]

sortArray

Filter by Sort "deliveryAt" or "orderAt" ("-" mean descending "+" mean ascending)

Example: ["-deliveryAt"]

Optional

Response Parameters

  • 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"
cursorString

Optional, if pagination exists.

Example: "3235"

countUint

Current page record

Example: 25

itemsArray

Refer to explanation below

Example: (Refer to explanation below)

Inside Items (parameter)

createdAtDateTime

Creation date time of store

Example: "2020-09-22T04:44:57.950398414Z"

customerObject

Refer to explanation below

Example: (Refer to explanation below)

deliveryObject

Refer to explanation below

Example: (Refer to explanation below)

deliveryAtString

When and what time the order deliver

Example: "2020-10-01T08:35:22.525Z"

driveThruObject

Refer to explanation below

Example: (Refer to explanation below)

itemsArray

Refer to explanation below

Example: (Refer to explanation below)

orderIdString

Order ID

Example: "5f7596e066ef1c1a4f9807f4"

paymentObject

Refer to explanation below

Example: (Refer to explanation below)

quantityUint

Quantity of the item

Example: 1

queueNoUint

Queue number of the item

Example: 0

stateString

State of the item

Example: "ACCEPTED"

statusString

Status of the item

Example: "EMPTY"

storeIdString

ID of the Store that Create from RM

Example: "10946114768247530"

tableObject

Refer to explanation below

Example: (Refer to explanation below)

typeString

Type of the item

Example: ""

updatedAtDateTime

Last update date time

Example: "2020-10-01T08:44:16.863Z"

Inside Customer (parameter)

countryCodeString

Country Code

Example: "60"

emailString

Customer Email

Example: "bassem@revenuemosnter.my"

nameString

Customer Name

Example: "Bassem AlSabbagh"

phoneNumberString

Customer contact number

Example: "1123621544"

idString

Customer ID

Example: "5f63082ae9c755d6ba3122ac"

Inside Delivery (parameter)

addressString

Refer to explanation below

Example: (Refer to explanation below)

courierString

Refer to explanation below

Example: (Refer to explanation below)

distanceInMeterInt

Delivery Distance (In Meter)

Example: 17446

idString

Customer contact number

Example: "5f815e2c3c6920f1233a540f"

methodString

Customer ID

Example: "OWN"

vendorIdString

Customer ID

Example: "5f815e2c3c6920f1233a540f"

Inside Address (parameter)

addressLine1String

AddressLine1

Example: ""

addressLine2String

AddressLine2

Example: ""

cityString

City

Example: ""

countryString

Country

Example: ""

latitudeFloat

Address latitude (In Meter)

Example: 0

longitudeFloat

Address longitude (In Meter)

Example: 0

nameString

Customer Name

Example: ""

postCodeString

Customer Remark

Example: ""

remarkString

Customer Remark

Example: ""

stateString

Address State

Example: ""

unitString

Address Unit

Example: ""

Inside Courier (parameter)

  • If Courier don't have name and phone will display as null
idString

Courier ID

Example: ""

latitudeFloat

Address latitude (In Meter)

Example: 0

longitudeFloat

Address longitude (In Meter)

Example: 0

nameString

Courier Name

Example: "Testing123"

phoneString

Courier Contact Number

Example: "163698122"

photoURLString

Courier Image

Example: ""

surnameString

Courier Surname

Example: ""

Inside Drive Thru (parameter)

  • If not Drive Thru will display null
vehicleDescriptionString

Vehicle description

Example: ""

vehicleNoString

Vehicle Number

Example: "TLA3202"

Inside Items (parameter)

descriptionString

Item description

Example: "got Nasi gt lemak"

imageUrlArray

Item Image

Example: []

itemIdString

Item ID

Example: "5f69a41f212de28db36031d6"

nameString

Item Name

Example: "Nasi lemak & Lemak"

preferencesArray

Refer to the Preferences parameter

Example: (Refer to the Preferences parameter)

priceObject

Refer to the Price parameter

Example: ( Refer to the Price parameter)

quantityUint

Item Quantity

Example: 1

remarkString

Customer Remark

Example: ""

sidesArray

Refer to the Sides parameter

Example: ( Refer to the Sides parameter)

Inside Preferences (parameter)

  • Will display Empty Array when don't have preferences
idString

Preferences ID

Example: "5f698149585d7cc1ae35a38d"

nameString

Preferences name

Example: "Sweetness"

minChoiceUint

Set minimum choice

Example: 1

maxChoiceUint

Set maximum choice

Example: 3

labelsArray

Refer to explanation below

Example: (Refer to explanation below)

Inside Labels (parameter)

idString

Label ID

Example: "5f698149585d7cc1ae35a38e"

nameString

Label name

Example: "Basic"

Inside Sides (parameter)

  • Will display Empty Array when don't have sides
idString

Side ID

Example: ""

nameString

Side Name

Example: "test"

sideItemsArray

Refer to the SideItems parameter

Example: Refer to the SideItems parameter

Inside SideItems (parameter)

idString

Side ID

Example: "5f7b4195021ba83f52a02551"

nameString

Side Name

Example: "Hainan Chicken Rice"

priceObject

Refer to the Price parameter

Example: Refer to the Price parameter

Inside Payment (parameter)

Current type in Payment will be :-

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

deliveryFeeObject

Refer to the Price parameter

Example: ( Refer to the Price parameter)

roundingObject

Refer to the Price parameter

Example: ( Refer to the Price parameter)

serviceFeeObject

Refer to the Price parameter

Example: ( Refer to the Price parameter)

serviceTaxObject

Refer to the Price parameter

Example: ( Refer to the Price parameter)

statusString

Payment Status

Example: "NOTPAID"

subTotalObject

Refer to the Price parameter

Example: ( Refer to the Price parameter)

totalAfterRoundingObject

Refer to the Price parameter

Example: ( Refer to the Price parameter)

totalBeforeRoundingObject

Refer to the Price parameter

Example: ( Refer to the Price parameter)

Inside Price (parameter)

Only serviceFee and serviceTax have percentage

amountUint

Amount in cent (min RM 0.10 10 = RM 0.10)

Example: 100

currencyTypeString

Current only support Ringgit Malaysia

Example: "MYR"

percentageUint

precentage will be divide 100 eg: 1300/100

Example: 1300

Inside Table (parameter)

idString

Table ID

Example: "5e86af7ef9e6794801df3302"

isAvailableBool

Vehicle Number

Example: true

isDefaultBool

Vehicle Number

Example: true

nameString

Table Name

Example: "Default Table"

Last updated on by Aiman Danish