Create Orders

What is needed to create orders?

When developing an integration, we provide access to a test customer account. The account will contain customer locations that are configured with a channel. The channels are a link between orders created online and the customer location.

To create orders, you need:

  • Channel link ID: This is the unique identifier of the channel in the customer location.
  • Channel name: This is a scope we provide that permits access to the dispatch order endpoint (the channel name is case-sensitive).

How should the dispatch delivery order be configured?

Include the Channel Link ID and Channel Name in the Dispatch Delivery Order endpoint as follows:

For further reference on how to work with this endpoint, view the documentation here.

Other Info

You can view the sample format of dispatching an order in our API Docs

It also includes variations, such as:

  • Tax-inclusive and tax-exclusive orders
  • Order cancellations
  • Eat-in orders (with table number)


Authorization error

If you are getting the below response, the issue is with the ChannelName (scope), check that it is being included, and note that it is also case sensitive.

{"code":"Authorization error","description":"you're not allowed to send in orders"}

Orders not appearing, although showing 200 OK

Check your pickupTime as this is the date range selector format. If you use the sample date "2020-03-09T17:17:38Z", you need to select March 9th 2020 to see your order.
Also, ensure you use a unique order ID, as orders with duplicate IDs will not be viewable in the system and are hidden as duplicates.

Orders are failing

Check the order failure message. You can view this by going to the Orders page of your test customer account. If you are shown an invalid PLU error, use the correct PLUs for your products.