Skip to main content

Update Order Status

Update the delivery status of an existing order — move it through PROGRESSING, FINDING_COURIER, SHIPPING, COMPLETED, or REJECTED.

When to Use

Use this endpoint when:

  • Restaurant accepts and starts preparing an order (PROGRESSING)
  • Courier dispatch and shipping events
  • Marking the order completed or rejected

How to Use

Endpoint
POST/v3/service

POST function: "update.order.status" with storeId, orderId, and the new status.

note

Valid status values: PROGRESSING, FINDING_COURIER, SHIPPING, COMPLETED, REJECTED.


Request Parameters

serviceSTRING

alacarte service

Example: "alacarte"

versionSTRING

Currently only support 'v1"

Example: "v1"

functionSTRING

Function that provide by alacarte

Example: "update.order.status"

requestOBJECT

Request body

storeIdSTRING

ID of the Store that Create from RM

Example: "2808912573238362402"

orderIdSTRING

Order Id

Example: "25f6984d6585d7cc1ae35a39c"

statusSTRING

Order Status

Example: "PROGRESSING"

Response Parameters

createdAtDATETIME

Creation date time of store

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

customerOBJECT

Customer info

countryCodeSTRING

Country Code

Example: "60"

emailSTRING

Customer Email

Example: "[email protected]"

idSTRING

Customer ID

Example: "5f63082ae9c755d6ba3122ac"

nameSTRING

Customer Name

Example: "Bassem AlSabbagh"

phoneNumberSTRING

Customer contact number

Example: "1123621544"

deliveryOBJECT

Delivery info

addressOBJECT

Delivery address

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

Post code

Example: ""

remarkSTRING

Customer Remark

Example: ""

stateSTRING

Address State

Example: ""

unitSTRING

Address Unit

Example: ""

courierOBJECT

Courier info (null if none)

distanceInMeterINTEGER

Delivery Distance (In Meter)

Example: 17446

idSTRING

Delivery ID

Example: "5f815e2c3c6920f1233a540f"

methodSTRING

Delivery method

Example: "OWN"

vendorIdSTRING

Vendor ID

Example: "5f815e2c3c6920f1233a540f"

deliveryAtSTRING

When and what time the order deliver

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

driveThruOBJECT

Drive thru info (null if not drive thru)

itemsARRAY

Order items

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

Item preferences (empty array when none)

priceOBJECT

Item price

amountINTEGER

Amount in cent

Example: 500

currencyTypeSTRING

Currency type

Example: "MYR"

quantityINTEGER

Item Quantity

Example: 1

remarkSTRING

Customer Remark

Example: ""

sidesARRAY

Item sides

idSTRING

Side ID

Example: ""

nameSTRING

Side Name

Example: "test"

sideItemsARRAY

Side items

idSTRING

Side Item ID

Example: "5f7b4195021ba83f52a02551"

nameSTRING

Side Item Name

Example: "Hainan Chicken Rice"

priceOBJECT

Side item price

amountINTEGER

Amount in cent

Example: 500

currencyTypeSTRING

Currency type

Example: "MYR"

orderIdSTRING

Order ID

Example: "5f7596e066ef1c1a4f9807f4"

paymentOBJECT

Payment info

deliveryFeeOBJECT

Delivery fee

amountINTEGER

Amount in cent

Example: 100

currencyTypeSTRING

Currency type

Example: "MYR"

roundingOBJECT

Rounding amount

amountINTEGER

Amount in cent

Example: 0

currencyTypeSTRING

Currency type

Example: "MYR"

serviceFeeOBJECT

Service fee

amountINTEGER

Amount in cent

Example: 90

currencyTypeSTRING

Currency type

Example: "MYR"

percentageINTEGER

Percentage (divide by 100)

Example: 600

serviceTaxOBJECT

Service tax

amountINTEGER

Amount in cent

Example: 105

currencyTypeSTRING

Currency type

Example: "MYR"

percentageINTEGER

Percentage (divide by 100)

Example: 700

statusSTRING

Payment Status (PAID, NOTPAID, PENDING, REFUNDED)

Example: "PAID"

subTotalOBJECT

Sub total

amountINTEGER

Amount in cent

Example: 1500

currencyTypeSTRING

Currency type

Example: "MYR"

totalAfterRoundingOBJECT

Total after rounding

amountINTEGER

Amount in cent

Example: 1795

currencyTypeSTRING

Currency type

Example: "MYR"

totalBeforeRoundingOBJECT

Total before rounding

amountINTEGER

Amount in cent

Example: 1795

currencyTypeSTRING

Currency type

Example: "MYR"

quantityINTEGER

Quantity of the item

Example: 1

queueNoINTEGER

Queue number of the item

Example: 0

stateSTRING

State of the item (ACCEPTED, REJECTED, CANCELED, REFUNDED)

Example: "ACCEPTED"

statusSTRING

Order status. One of: `EMPTY`, `WAITING_FOR_PAYMENT`, `WAIT_FOR_CONFIRMATION`, `CANCELLED`, `PROGRESSING`, `WAITING_FOR_COURIER`, `FINDING_COURIER`, `SHIPPING`, `COMPLETED`, `DELAYED`, `REJECTED`

Example: "EMPTY"

storeIdSTRING

ID of the Store that Create from RM

Example: "10946114768247530"

tableOBJECT

Table info

idSTRING

Table ID

Example: "5e86af7ef9e6794801df3302"

isActiveBOOLEAN

Table is active

Example: true

isDefaultBOOLEAN

Is default table

Example: true

nameSTRING

Table Name

Example: "Default Table"

typeSTRING

Type (DINEIN, DELIVERY, PICKUP, DRIVE_THRU)

Example: "DELIVERY"

updatedAtDATETIME

Last update date time

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