Search Orders

post https://api.tiller.systems/orders/v3/orders/search

Retrieve orders using search parameters.

Responses

Response body

object

orders

array of objects

orders

object

externalId

string

Id mastered by the partner

displayName

string

currencyCode

string

required

3-letter currency code as defined by ISO-4217.

guestNumber

integer

Defaults to 1

partnerName

string

Name of the partner who originally created the order

comment

string

UUID V4 identifying the order

identifier

object

required

storeId

integer

The id of the store which made the order

status

string

IN_PROGRESS CLOSED DELETED CANCELED TRANSFERRED UNKNOWN

openingInformations

object

closingInformations

object | null

cancelingInformations

object | null

location

object

totalTaxIncludedAmount

integer

Amount value in cents

totalTaxAmount

integer | null

Amount value in cents

destinationOrderId

string | null

The ID of the order where the current order has been transfered

consumer

object | null

deliveryAddress

object | null

billingAddress

object | null

preparations

array of objects

Define the order of preparation of lines

preparations

object

externalId

string

The id mastered by the partner. It is mandatory in order to be able to associate it with lines created in the order. It's an UUID.

executionDate

date-time

The date when the preparation has been sent to be prepared

type

string

onDemand sequenced

string

The ID of the preparation

step

integer

This reflect the order on which preparations are sent

scheduleDate

date-time

The date when the preparation is scheduled to be prepared. Only for type = sequenced

itemLines

array of objects

itemLines

object

externalId

string

Id mastered by the partner

preparationId

string

UUID of the preparation

preparationExternalId

string

UUID of the preparation

priceBookId

integer

Id of the price book. If present, the product inherit varRate and unitPrice of the product from this price book

comment

string

required

UUID V4 identifying the line

sku

string

The sku assigned to this product

quantity

number

≥ 1

uom

string

List
- L = Liters
- cL = centiLiters
- kG = kiloGrams
- G = Grams
- M = Meters
- cM = centiMeters
- EA = Each

L cL kG G M cM EA

itemId

integer

Id identifying the item.

name

string

Name of the item

unitPrice

object | null

taxRate

number

Tax rate of the item.

destinationOrderId

string | null

The UUID V4 of the order where this line has been transfered to

status

string

required

The status of the line.

ACCEPTED DELETED CANCELED CANCELED_ORDER TRANSFERRED

optionLines

array of objects

optionLines

object

externalId

string

Id mastered by the partner

name

string

Name of the item

unitPrice

integer

Override the unit_price of the item identified by itemId. It has to be defined in cents

taxRate

number

Override the tax rate of the item identified by itemId.

string

UUID V4 identifying the option

itemId

number

Id identifying the option item.

sku

string

The sku assigned to this product

status

string

required

The status of the line.

ACCEPTED DELETED CANCELED CANCELED_ORDER TRANSFERRED

discount

object | null

Total discount of this line item in cents.

packageLines

array of objects

packageLines

object

externalId

string

Id mastered by the partner

packageId

integer

required

The id of the package in the catalog of the store.

quantity

integer

≥ 1

Defaults to 1

string

required

UUID V4 identifying the package

uom

string

Defaults to EA

List
- L = Liters
- cL = centiLiters
- kG = kiloGrams
- G = Grams
- M = Meters
- cM = centiMeters
- EA = Each

L cL kG G M cM EA

unitPrice

object

required

Override the unit_price of the item identified by itemId. It has to be defined in cents

destinationOrderId

string | null

The UUID V4 of the order where this line has been transfered to

status

string

required

The status of a package.

ACCEPTED DELETED DISSOCIATED CANCELED CANCELED_ORDER TRANSFERRED

itemLines

array of objects

itemLines

object

externalId

string

Id mastered by the partner

itemId

number

required

Id identifying the item.

string

required

UUID V4 identifying the line

status

string

required

The status of the line.

ACCEPTED DELETED CANCELED CANCELED_ORDER TRANSFERRED

preparationId

string

The preparation id on which this line will be associated

optionLines

array of objects

optionLines

object

externalId

string

Id mastered by the partner

string

UUID V4 identifying the option

status

string

The status of the line.

ACCEPTED DELETED CANCELED CANCELED_ORDER TRANSFERRED

itemId

number

Id identifying the option item.

discount

object | null

Total discount of this line item in cents.

payments

array of objects

list of all payments registered

payments

object

externalId

string

Id mastered by the partner

amount

integer

required

Payment amount value in cents, including tips

type

string

required

Payment method

reason

string | null

Message from payment gateway when a payment is refused

string

required

UUID V4 identifying the payment

date

date-time

destinationOrderId

string | null

The ID of the order where the current order has been transferred

status

string

required

The status of the payment.
- ACCEPTED means the payment has been applied to the order.
- REFUSED means the payment hasn't been validated and is not applied to the order.
- CANCELED means the payment has been removed from the order.
- TRANSFERRED means the payment has been switched to another order.

ACCEPTED REFUSED CANCELED TRANSFERRED

paymentDifference

object | null

discounts

array of objects or null

list of all discounts applied at the order level. These discount are cumulative. In cents

discounts

object | null

string

required

UUID V4 identifying the discount

externalId

string | null

Id mastered by the partner

discountId

integer

amount

integer

required

discount value in cents

name

string

required

discount name

destinationOrderId

string

The UUID V4 of the order where this line has been transfered to

status

string

required

The status of the line.

ACCEPTED DELETED CANCELED CANCELED_ORDER TRANSFERRED

failedOrders

array of objects

failedOrders

object

string

required

UUID V4 identifying the order

reason

string

required

The reason why the order failed to be retrieved. Some orders may be too old to be retrieved using this endpoint,
OLD_VERSION is returned in this case.

OLD_VERSION UNKNOWN

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://api.tiller.systems/orders/v3/orders/search?count=20' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

401Unauthorized

404Not Found

500Internal Server Error