Skip to main content
POST
Create a test order

Authorizations

Authorization
string
header
required

The store's API key (xfp_test_… on the sandbox, xfp_live_… on live). XFaster creates it and shows it once. An integrator key (one key for a POS company) also sends X-XFaster-Store.

Body

application/json
type
enum<string>
default:delivery
Available options:
delivery,
pickup
payment
enum<string>
default:cash
Available options:
cash,
card
items
integer
default:1
Required range: 1 <= x <= 10

Response

201 - application/json

The test order

id
integer
Example:

183761

number
string
Example:

"183761"

type
enum<string>
Available options:
delivery,
pickup
status
enum<string>
Available options:
new,
preparing,
ready,
picked_up,
delivered,
collected,
cancelled
placed_at
string<date-time>
scheduled_for
string<date-time> | null

Set for orders placed for later

prep_time_minutes
integer | null
ready_by
string<date-time> | null
customer
object
delivery
object | null
items
object[]
notes
object
totals
object

items + packaging + delivery_fee + tip - discount - coupon = total

payment
object
invoice
object
picking
enum<string> | null

Markets - lines are final once done

Available options:
picking,
done,
null
cancellation
object | null
updated_at
string<date-time>