Skip to main content
↓ Download as Markdown

Registering external orders

The 'register' endpoint​

This endpoint can be used to register an order in Future Ordering that should not be sent to the POS using Future Ordering POS integrations, i.e. orders added to POS by a sales channel not placing orders via Future Ordering. This enables all orders to be handled by integrations with the Future Ordering platform, independently of which channel that send the order to the point of sale.

Examples of useful built-in Future Ordering functionlity are:

  • Order Status Board - all orders, independent of channel, will end up on the same order status board in the restaurant. Should be used together with "Set Order status as Ready For Pickup" endpoint described below.
  • Order Manager - a KDS application that can be used by the staff in the restaurant to handle orders.

Other valuable third party integrations can additionally enhance orders registered this way.

When the order is accepted the response header "Location" will contain the url to where the order can be fetched, for example: https://api-test.futureordering.com/orders/FyY2TVTCb1N.

Examples​

Register order with overall order information​

{
    "storeId": "101",
    "cultureCode": "sv-SE",
    "currencyIsoCode": "SEK",
    "orderTypeId": "eatIn",
    "collectionDetails": {
        "type": "driveThru"
    },
    "salesChannel": {
        "type": "external",
        "name": "posName"
    },
    "posData": {
        "orderName": "1044",
        "estimatedReadyTime": "2022-12-05T21:00:00+02:00",
        "datePlaced": "2022-12-05T21:00:00+02:00"
    },
    "orderRefsDict": {
        "posRef": "a_unique_reference"
    }
}

Register order with products.​

If the order contains products, it is also mandatory to set the properties "isAlreadyPaid" and "merchantId" since a generic payment always is created in our backend.

{
    "storeId": "101",
    "cultureCode": "sv-SE",
    "currencyIsoCode": "SEK",
    "orderTypeId": "eatIn",
    "collectionDetails": {
        "type": "driveThru"
    },
    "salesChannel": {
        "type": "external",
        "name": "posName",
        "additionalProperties": {
            "moduleName": "productionstatus",
            "moduleVersion": "1.1.0.3",
            "deviceId": "kZzC_DLrNEGo1rGUYH5kXg"
        },
        "merchantId": "dTBHAtRFDvPuFizWBNuSvcCgFd",
        "isAlreadyPaid": true,
        "products": [
            {
                "menuItemId": "70070016",
                "type": "product",
                "title": "Hamburger",
                "quantity": 1,
                "configItems": []
            }
        ],
        "posData": {
            "orderName": "1044",
            "estimatedReadyTime": "2022-12-05T21:00:00+02:00",
            "datePlaced": "2022-12-05T21:00:00+02:00"
        },
        "orderRefsDict": {
            "posRef": "a_unique_reference"
        }
    }
}