Skip to main content
API docs by Redocly

Order API (v1.0)

Download OpenAPI specification:Download

Order API

Get Orders

Query for a list of orders by business dates, limited to a 3 day range

query Parameters
businessDateFrom
string^[0-9]{4}$-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0...
businessDateTo
string^[0-9]{4}$-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0...
includeStageTimes
boolean

Include Order Stage Times (Default is false)

sourceReferenceId
string

Reference Id generated from the source order (ThirdPartyId), Requires service type

customerId
string

Unique Customer Id (Customer Key)

phoneNumber
string

Unique phone number (dashes will be removed)

serviceType
string

Service Type

header Parameters
X-Store
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "string",
  • "messagesDetails": [
    ]
}

Creates an Order item

Adds an item to the system

header Parameters
X-Store
required
string
X-ServiceType
required
string
Request Body schema: application/json

Order item to add

applyDefaultModifiers
boolean
Default: false

Default Modifiers will be added to the order if they do not have the modifier. Modifiers with 0 or any other quantity will not be changed.

required
object (OrderWithCreditCardPayments)

Defines the Order Object with Credit Card Payments

Responses

Request samples

Content type
application/json
{
  • "applyDefaultModifiers": false,
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get Order

By passing in the appropriate options, you can search for available Order in the system

path Parameters
id
required
string

Online Reference Number of the order (OLRefNum)

header Parameters
X-Store
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string",
  • "messagesDetails": [
    ]
}

Get Order Status

By passing in the appropriate options, you can search for available Order in the system

path Parameters
id
required
string

Online Reference Number of the order (OLRefNum)

header Parameters
X-Store
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Post Order Cancel

Cancel Order

path Parameters
id
required
string

Online Reference Number of the order (OLRefNum)

header Parameters
X-Store
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "messagesDetails": [
    ]
}

Apply a Credit Card Payment to an Order, if multiple credit cards then this endpoint must be called mulitple times

Apply Credit Card Payment

path Parameters
id
required
string

Online Reference Number of the order (OLRefNum)

header Parameters
X-Store
required
string
Request Body schema: application/json

Order item to add

required
object (CreditCardPayment)

Credit Card Payment Information

required
object (Transaction)

Transaction details - associated with payments for an order.

required
object or null (OrderPaymentMethod)

Details of card used to submit payment for an order

firstName
string or null
lastName
string or null

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "messagesDetails": [
    ]
}

Post Orders Cancel

Cancel Order

query Parameters
sourceReferenceId
required
string

Reference Id generated from the source order (ThirdPartyId)

header Parameters
X-Store
required
string
X-ServiceType
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "messagesDetails": [
    ]
}

Price Order

Accepts an order and calculates ALL price infomation based on the menu. An order object is returned. Any prices in the request will be lost.

header Parameters
X-Store
required
string
X-ServiceType
required
string
Request Body schema: application/json

Order item to add

applyDefaultModifiers
boolean
Default: false
required
object (Order)

Defines the Order Object

Responses

Request samples

Content type
application/json
{
  • "applyDefaultModifiers": false,
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}