Skip to content



This function is used in conjunction with an order workflow to manually mark an order as received. Because this is a module-level function, you’ll need to use the following format to whitelist the function:


Request Body Parameters#

Type Description
Function String For Module-level functions, this will always have the value of: “Module”
Module_Code String Module Code. Always “orderworkflow” for this function
Module_Function String Function to execute
Order_Ids Array Array of order ids you wish to mark as received/acknowledged

Response Parameters#

Type Description
success Boolean Boolean value indicating if the request was successful
processed Boolean Boolean value if function was processed

Example Request#

    "Store_code": "beta",
    "Function": "Module",
    "Module_Code": "orderworkflow",
    "Module_Function": "OrderList_Acknowledge",
    "Order_Ids": [200075, 200076]

Example Response#

    "success": 1,
    "processed": 1

Example Error Response#

This means that the request was successful but not processed. Typically, this means the Order_Ids parameter is missing or incorrect.

    "success": 1,
    "processed": 0

Error Responses#

Error Code Error Message Error Description
invalid_function Invalid Function Request syntax is incorrect. This is a module-level function, so “Module” needs to be passed in the Function Parameter.
invalid_module Invalid Module Request syntax is incorrect. This is a module-level function, so Module_Code parameter needs to be “orderworkflow”.