Called to start an order at any point, optionally specify a member that this booking is on behalf of


  • Type=APIStartOrder
  • Payload (JSON encoded)
       Member (optional)
          MemberID (int) - Existing Member ID in the system
          MemberEmail (string) - Existing Member Email in the system (used in the example below)
          Member (array) - key/value pairs with the details of new member
  • OrderItems
  • HashString

The following example includes an array of all types of order item that can be requested, however you only need to include the type/items that you require.

If specifying the Member (or Purcahser) array then the JSON would look as follows (with only adding a simple physical item)

If using an Email for a Member/Purchaser already existing in the system then their details will be overridden
    "Member": [{
        "FirstName":"First Name",
        "LastName":"Last Name",
        "Job Title":"Job Title",
        "Custom_14" => "BookingLive",
        "Custom_15" => "Developer",
    "OrderItems": [{
        "ProductClassName": "ProductResource",
        "start_date": "2016-01-01 13:00:00",
        "end_date": "2016-02-01 13:00:00",
        "ProductID": "1",
        "ResourceID": "123"
    }, {
        "ProductID": "1",
        "ProductClassName": "ProductPhysicalItem",
        "Quantity": "1"
    }, {
        "ProductClassName": "ProductFixedEvent",
        "EventID": "123",
        "Quantity": "1"
    }, {
        "ProductClassName": "ProductTemplateEvents",
        "Availability[StartTime]": "13:20:00",
        "Availability[StartDate]": "2016-01-01",
        "Quantity__123": "1",
        "BookingType_ProductTemplateEvents": "0"


  • Quantity__123 - 123 is the product pricing ID


  • Reference - Reference of the Order started
  • Errors - if empty then it was all successful, else if there are errors there will be a code and a message per error and the order will be aborted so nothing has been "reserved".

All orders created have standard website behaviour applied ot them so they will be Pending until completed via the API and will be set to Aborted in the standard way along with all others. The standard is around 20 minutes from teh last action.