GET orders
Changed onDeprecated, see bookings
Request
- Base URLhttps://api.bookingexperts.com
- Auth
- API key in header X-API-KEY
- or OAuth 2Authorization code/oauth/authorizeToken URL/oauth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Administration ID
Query parameters
Page number
Page size
Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id, confirmed_at, created_at, updated_at
Fieldset. Specify a comma separated list of attributes to return
Includes list. Specify a comma separated list of resources to include.
Filter on ID
Filter on booker_desires_downpayment
Filter on after_payment_return_url
Filter on option_validity
Filter on remote_booking_nr
Filter on reference_nr
Filter on locale
Filter on memo
Filter on cancel_date
Filter on cancel_reason
Filter on state
Filter on token
Filter on confirmed_at
Filter on booking_nr
Filter on created_at
Filter on updated_at
Filter on customer. Specify a comma separated list of IDs to filter on.
Filter on owner. Specify a comma separated list of IDs to filter on.
Filter on traffic_source. Specify a comma separated list of IDs to filter on.
Filter on credit_cards. Specify a comma separated list of IDs to filter on.
Filter on security_deposits. Specify a comma separated list of IDs to filter on.
Filter on administration. Specify a comma separated list of IDs to filter on.
Filter on channel. Specify a comma separated list of IDs to filter on.
Filter on guest_invoice. Specify a comma separated list of IDs to filter on.
Filter on customer_invoice. Specify a comma separated list of IDs to filter on.
Filter on channel_invoice. Specify a comma separated list of IDs to filter on.
Filter on reservations. Specify a comma separated list of IDs to filter on.
Headers
Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.
Response
OrderCollectionResponse
Example response
{
"data": [
{
"id": "1",
"type": "order",
"attributes": {
"customer_desires_downpayment": true,
"booker_desires_downpayment": true,
"option_validity": 3,
"locale": "cs",
"currency": "EUR"
},
"relationships": {
"customer": {
"data": {
"type": "customer"
}
},
"owner": {
"data": {
"type": "owner"
}
},
"traffic_source": {
"data": {
"type": "traffic_source"
}
},
"conversation": {
"data": {
"type": "conversation"
}
},
"credit_cards": {
"data": [
{
"type": "credit_card"
}
]
},
"security_deposits": {
"data": [
{
"type": "security_deposit"
}
]
},
"administration": {
"data": {
"type": "administration"
}
},
"channel": {
"data": {
"type": "channel"
}
},
"guest_invoice": {
"data": {
"type": "invoice"
}
},
"customer_invoice": {
"data": {
"type": "invoice"
}
},
"channel_invoice": {
"data": {
"type": "invoice"
}
},
"reservations": {
"data": [
{
"type": "reservation"
}
]
},
"payments": {
"data": [
{
"type": "payment"
}
]
}
}
}
],
"included": [
{
"id": "1",
"type": "customer",
"attributes": {
"title": "mr",
"country_code": "NL",
"locale": "cs"
},
"relationships": {
"labels": {
"data": [
{
"type": "label"
}
]
}
}
}
]
}Changes
- warning
added the new
da-DKenum value to the///response property for the response status - warning
added the new
da-DKenum value to the///////response property for the response status - warning
added the new
da-DKenum value to the///////response property for the response status - warning
added the new
da-DKenum value to the///////response property for the response status - warning
added the new
en-GBenum value to the///response property for the response status - warning
added the new
en-GBenum value to the///////response property for the response status - warning
added the new
en-GBenum value to the///////response property for the response status - warning
added the new
en-GBenum value to the///////response property for the response status - warning
added the new
en-USenum value to the///response property for the response status - warning
added the new
en-USenum value to the///////response property for the response status - warning
added the new
en-USenum value to the///////response property for the response status - warning
added the new
en-USenum value to the///////response property for the response status - info
added the optional property
///to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
/////////to the response with the status - info
added the optional property
/////////to the response with the status - info
added the optional property
/////////to the response with the status - info
added the optional property
///////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
added the optional property
////////to the response with the status - info
response property
included/items/anyOf[Customer]/attributes/debtor_codedeprecated
- warning