"Order N Pay" Method

Summary

This method allows the integrator to request to get a list of open orders

Request/Response Payload Models

Enumeration Values

GetOpenOrders (Websocket Message)

Message: OrderNPayWebsocketRequest, Payload: OrderNPayGetOpenOrdersRequest

{
    "RequestID": "593c1c6d-4c8f-4507-96e0-b6a0b5e8071f",
    "ProviderID": 12345,
    "ProviderName": "Example Provider",
    "DeviceID": "DeviceABC123",
    "UserIdentifier": "f9248a0f-ba0c-4c80-b9f2-fe020b456ce4",
    "MessageType": 1,
    "Payload": {
        "ServiceModeEntityID": "",
        "UserOrdersOnly": false
    }
}

On success, the POS responds with

Message: OrderNPayWebsocketResponse, Payload: OrderNPayGetOpenOrdersResponse

{
    "RequestID": "593c1c6d-4c8f-4507-96e0-b6a0b5e8071f",
    "ResultCode": 0,
    "ErrorMessage": null,
    "MessageType": 1,
    "Payload": {
        "Orders": [{
                "SalesTransactionID": "1121008e-2769-46e2-918d-65e0291621a1",
                "ServiceModePrefix": "TBL",
                "ServiceModeEntityID": "1",
                "OrderNumberOpened": "S1000001",
                "OwnedBy_UserID": "f9248a0f-ba0c-4c80-b9f2-fe020b456ce4",
                "CurrencyCode": "GBP",
                "Amount": 5.0,
                "AmountOwing": 5.0,
                "InUse": false,
                "InUseByTerminalDisplayID": null,
                "InUseByUserName": null
            }, {
                "SalesTransactionID": "af7c2c30-7434-44f6-aa3c-372f3446749d",
                "ServiceModePrefix": "TBL",
                "ServiceModeEntityID": "1",
                "OrderNumberOpened": "S1000003",
                "OwnedBy_UserID": "f9248a0f-ba0c-4c80-b9f2-fe020b456ce4",
                "CurrencyCode": "GBP",
                "Amount": 20.0,
                "AmountOwing": 20.0,
                "InUse": false,
                "InUseByTerminalDisplayID": null,
                "InUseByUserName": null
            }, {
                "SalesTransactionID": "1b707032-9626-4168-bd5a-d1ca797d4a46",
                "ServiceModePrefix": "TBL",
                "ServiceModeEntityID": "2",
                "OrderNumberOpened": "S1000002",
                "OwnedBy_UserID": "2a064175-61b7-419a-b96e-93563258f6f3",
                "CurrencyCode": "GBP",
                "Amount": 10.0,
                "AmountOwing": 10.0,
                "InUse": false,
                "InUseByTerminalDisplayID": null,
                "InUseByUserName": null
            }
        ],
        "UserOrdersOnly": false
    }
}

On failure such as an invalid user id, the POS may respond with

Message: OrderNPayWebsocketResponse, Payload: null

{
    "RequestID": "593c1c6d-4c8f-4507-96e0-b6a0b5e8071f",
    "ResultCode": 4,
    "ErrorMessage": "No user was found matching the specified logon!",
    "MessageType": 0,
    "Payload": null
}