Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.6 KB

OrderStateRequest.md

File metadata and controls

34 lines (22 loc) · 1.6 KB

OrderStateRequest

This request pushes the state of an order on GrabFood.

Properties

Name Type Description Notes
merchantID String The merchant's ID that is in GrabFood's database.
orderID String The order's ID that is returned from GrabFood. Refer to FAQs for more details about orderID and shortOrderNumber.
state StateEnum The current order state. For takeaway orders, only `DELIVERED` and `CANCELLED` states are pushed.
driverETA Integer The driver's estimated of arrival (ETA) in seconds when the state is `DRIVER_ALLOCATED`. [optional]
code String The current order's sub-state. This is in free text so you should only use for reference. Grab may use this for troubleshooting. If you want some analysis, kindly use `state` instead. [optional]
message String Additional information to explain the current order state. May be system status or human entered message. [optional]

Enum: StateEnum

Name Value
ACCEPTED "ACCEPTED"
DRIVER_ALLOCATED "DRIVER_ALLOCATED"
DRIVER_ARRIVED "DRIVER_ARRIVED"
COLLECTED "COLLECTED"
DELIVERED "DELIVERED"
FAILED "FAILED"
CANCELLED "CANCELLED"
UNKNOWN_DEFAULT_OPEN_API "unknown_default_open_api"