"Order N Pay" Method

Summary

This method allows the integrator to get the full details of a specific order

Request/Response Payload Models

Enumeration Values

GetOrder (Websocket Message)

Message: OrderNPayWebsocketRequest, Payload: OrderNPayGetOrderRequest

{
    "RequestID": "2bd187d7-8b34-4821-b8bf-d23c6325780a",
    "ProviderID": 90210,
    "ProviderName": "UnitTests",
    "DeviceID": "DeviceABC123",
    "UserIdentifier": "f9248a0f-ba0c-4c80-b9f2-fe020b456ce4",
    "MessageType": 2,
    "Payload": {
        "SalesTransactionID": "9caa19ce-8518-43fc-896f-7132d5ed431b"
    }
}

On success, the POS responds with

Message: OrderNPayWebsocketResponse, Payload: OrderNPayGetOrderResponse

{
    "RequestID": "2bd187d7-8b34-4821-b8bf-d23c6325780a",
    "ResultCode": 0,
    "ErrorMessage": null,
    "MessageType": 2,
    "Payload": {
        "Order": {
            "SalesTransactionID": "9caa19ce-8518-43fc-896f-7132d5ed431b",
            "ServiceModePrefix": "TBL",
            "ServiceModeEntityID": "10",
            "OrderNumberOpened": "PSVR0001",
            "OwnedBy_UserID": "f9248a0f-ba0c-4c80-b9f2-fe020b456ce4",
            "OwnedBy_UserName": "PayAtTable User",
            "CurrencyCode": "GBP",
            "Amount": 41.35,
            "AmountOwing": 48.99,
            "IsClosed": false,
            "RemainingServiceChargeAmount": 7.64,
            "Products": [{
                    "ProviderProductID": null,
                    "ProductType": 0,
                    "PLUIdentifier": "483928fa-8795-4a17-a480-f7c5322bdc1f",
                    "SalesModifierIdentifier": null,
                    "Name": "Corona",
                    "SalesModifierName": null,
                    "Quantity": 1,
                    "Price": 5.0,
                    "TotalAmount": 5.0,
                    "ChildProducts": null,
                    "Adjustment": null
                }, {
                    "ProviderProductID": null,
                    "ProductType": 0,
                    "PLUIdentifier": "cc0c93fd-7268-4252-b792-171a37e32696",
                    "SalesModifierIdentifier": null,
                    "Name": "Crown Lager",
                    "SalesModifierName": null,
                    "Quantity": 2,
                    "Price": 5.0,
                    "TotalAmount": 10.0,
                    "ChildProducts": null,
                    "Adjustment": null
                }, {
                    "ProviderProductID": null,
                    "ProductType": 0,
                    "PLUIdentifier": "a76288d0-fd2a-4c13-ab29-996acdf55499",
                    "SalesModifierIdentifier": null,
                    "Name": "Carlsberg",
                    "SalesModifierName": null,
                    "Quantity": 1,
                    "Price": 5.0,
                    "TotalAmount": 5.0,
                    "ChildProducts": null,
                    "Adjustment": null
                }, {
                    "ProviderProductID": null,
                    "ProductType": 0,
                    "PLUIdentifier": "a9cc9a46-9a4d-445a-a248-838e188970c4",
                    "SalesModifierIdentifier": null,
                    "Name": "T-Bone Steak",
                    "SalesModifierName": null,
                    "Quantity": 1,
                    "Price": 29.95,
                    "TotalAmount": 29.95,
                    "ChildProducts": [{
                            "ProviderProductID": null,
                            "ProductType": 0,
                            "PLUIdentifier": "ca68658f-7d6a-443e-9944-1c1e66c95b2f",
                            "SalesModifierIdentifier": null,
                            "Name": "Medium",
                            "SalesModifierName": null,
                            "Quantity": 1,
                            "Price": 0.0,
                            "TotalAmount": 0.0
                        }, {
                            "ProviderProductID": null,
                            "ProductType": 0,
                            "PLUIdentifier": "b554e4cf-aac5-442f-94d2-59153d1a42f7",
                            "SalesModifierIdentifier": null,
                            "Name": "Pepper Sauce",
                            "SalesModifierName": null,
                            "Quantity": 1,
                            "Price": 0.0,
                            "TotalAmount": 0.0
                        }, {
                            "ProviderProductID": null,
                            "ProductType": 0,
                            "PLUIdentifier": "711336b0-262c-4701-bea8-c554fc5ebd72",
                            "SalesModifierIdentifier": null,
                            "Name": "Side Salad",
                            "SalesModifierName": null,
                            "Quantity": 1,
                            "Price": 1.0,
                            "TotalAmount": 1.0
                        }, {
                            "ProviderProductID": null,
                            "ProductType": 0,
                            "PLUIdentifier": "57fd9855-c860-4330-8476-4933d96dbfbc",
                            "SalesModifierIdentifier": null,
                            "Name": "Balsamic",
                            "SalesModifierName": null,
                            "Quantity": 1,
                            "Price": 0.0,
                            "TotalAmount": 0.0
                        }
                    ],
                    "Adjustment": null
                }
            ],
            "Payments": [],
            "Adjustments": [{
                    "ProviderAdjustmentID": null,
                    "AdjustmentID": "3b1e6e04-9a29-41a1-a55e-5ec284a8c8be",
                    "Amount": -5.0,
                    "Name": "3 Beers for $10"
                }, {
                    "ProviderAdjustmentID": null,
                    "AdjustmentID": "f43fadb5-a26b-423c-942c-017c23384501",
                    "Amount": -4.6,
                    "Name": "10% Discount"
                }
            ],
            "Notes": [],
            "Taxes": [{
                    "Name": "VAT",
                    "Amount": 3.76,
                    "TaxRate": 10.0,
                    "IsAddOnTax": false
                }
            ]
        }
    }
}

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

Message: OrderNPayWebsocketResponse, Payload: null

{
    "RequestID": "2bd187d7-8b34-4821-b8bf-d23c6325780a",
    "ResultCode": 4,
    "ErrorMessage": "The specified order does not exist!",
    "MessageType": 2,
    "Payload": null
}