Refund Order
Refund a paid à la carte order back to the customer. The order's payment status moves to REFUNDED.
When to Use
▾
Use this endpoint when:
- Customer requests a refund for a paid order
- Reversing an order due to fulfillment issues
How to Use
▾
/v3/servicePOST function: "refund.store.order" with storeId and orderId.
Request Parameters
▾
alacarte service
Example: "alacarte"
Currently only support 'v1"
Example: "v1"
Function that provide by alacarte
Example: "refund.store.order"
Request body
Order Id
Example: "25f6984d6585d7cc1ae35a39c"
Response Parameters
▾
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
Delivery address
AddressLine1
Example: ""
AddressLine2
Example: ""
City
Example: ""
Country
Example: ""
Address latitude (In Meter)
Example: 0
Address longitude (In Meter)
Example: 0
Customer Name
Example: ""
Post code
Example: ""
Customer Remark
Example: ""
Address State
Example: ""
Address Unit
Example: ""
Courier info
Courier ID
Example: ""
Address latitude (In Meter)
Example: 0
Address longitude (In Meter)
Example: 0
Courier Name
Example: "Testing123"
Courier Contact Number
Example: "163698122"
Courier Image
Example: ""
Courier Surname
Example: ""
Delivery Distance (In Meter)
Example: 17446
Delivery ID
Example: "5f815e2c3c6920f1233a540f"
Delivery method
Example: "OWN"
Vendor ID
Example: "5f815e2c3c6920f1233a540f"
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 (empty array when none)
Item price
Amount in cent (min RM 0.10 10 = RM 0.10)
Example: 100
Current only support Ringgit Malaysia
Example: "MYR"
Item Quantity
Example: 1
Customer Remark
Example: ""
Item sides (empty array when none)
Order ID
Example: "5f7596e066ef1c1a4f9807f4"
Payment info
Delivery fee
Amount in cent
Example: 0
Currency type
Example: "MYR"
Rounding amount
Amount in cent
Example: -2
Currency type
Example: "MYR"
Service fee
Amount in cent
Example: 63
Currency type
Example: "MYR"
Percentage (divide by 100)
Example: 600
Service tax
Amount in cent
Example: 74
Currency type
Example: "MYR"
Percentage (divide by 100)
Example: 700
Payment Status (PAID, NOTPAID, PENDING, REFUNDED)
Example: "REFUNDED"
Sub total
Amount in cent
Example: 1050
Currency type
Example: "MYR"
Total after rounding
Amount in cent
Example: 1185
Currency type
Example: "MYR"
Total before rounding
Amount in cent
Example: 1187
Currency type
Example: "MYR"
Quantity of the item
Example: 1
Queue number of the item
Example: 0
State of the item (ACCEPTED, REJECTED, CANCELED, REFUNDED)
Example: "REFUNDED"
Order status. One of: `EMPTY`, `WAITING_FOR_PAYMENT`, `WAIT_FOR_CONFIRMATION`, `CANCELLED`, `PROGRESSING`, `WAITING_FOR_COURIER`, `FINDING_COURIER`, `SHIPPING`, `COMPLETED`, `DELAYED`, `REJECTED`
Example: "CANCELLED"
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: true
Table Name
Example: "Default Table"
Type (DINEIN, DELIVERY, PICKUP, DRIVE_THRU)
Example: "DELIVERY"
Last update date time
Example: "2020-10-01T08:44:16.863Z"