API Documentation

# Order API Resources v2.0

Each resource used in the Order API version 2.0 is listed below.

# OrderStatus

Represents the current status of the order.

Name Required Type Description
orderId true string The unique identifier for the order.
orderCode true string A code for the order that can be used in display scenarios. This value is not unique.
transactionId true string The transaction identifier for the order.
brandKey true string The brand the order is for.
restaurantKey true string The key for the restaurant that the order was placed against.
restaurantName true string The name of the restaurant that the order was placed against.
orderingChannel false string The ordering channel for the order.
fulfilmentChannel false string The fulfilment channel for the order.
currency true number The currency used on the order.
amount true number The order total in cents.
status true string Current status of the order. See the Order Status endpoint for more information.
statusReason true string The reason for the status. Used for troubleshooting and not meant for display to a customer.
createdOn true date-time The date and time in UTC that the order was created.
processedOn true date-time The date and time in UTC that the order status was last updated.
history true StatusUpdate[] The order status history.

# Sample

{
    "orderId": "06995e70-6349-4283-8894-fca42349e1ee",
    "orderCode": "9E1EE",
    "transactionId": "20220202-0013-0000-0290",
    "brandKey": "ROCO",
    "restaurantKey": 1352,
    "restaurantName": "Test RocoMamas",
    "orderingChannel": "Call and Order",
    "fulfilmentChannel": "Takeaway",
    "currency": "ZAR",
    "total": 8800,
    "status": "Accepted",
    "statusReason": "Restaurant accepted the order.",
    "createdOn": "2022-02-02T17:39:09.1905523+00:00",
    "processedOn": "2022-02-02T17:39:28.1676038+00:00",
    "history": [
    // Omitted for brevity.
    ]
}

# StatusUpdate

A representation of a payment status update for a payment.

Name Required Type Description
status true string The status of the order.
statusReason true string The reason for the status. Used for troubleshooting and not meant for display to a customer.
processedOn true date-time The date and time in UTC that the payment status was processed.

# Sample

{
    "status": "Processing",
    "statusReason": "Started processing order.",
    "processedOn": "2022-02-11T04:51:51.0607526+00:00"
}

← Get Order Status →