Retrieve all orders
GET/api/partners/ordersReturns a list of all orders for the client.
Possible order statuses:
PENDING: 0
SEARCHING: 1
ASSIGNED: 2
COMPLETED: 3
CANCELLED: 4
PAID: 5
ABANDONED: 6
CANCELLED_BY_GEEK: 7
MASTER_CLIENT_APPROVAL: 8
UNSERVICEABLE: 9
PAUSED: 10
READY_TO_RESUME: 11
INCOMPLETE: 12
LATE_TECH: 13
PENDING_SHIPPING: 14
PENDING_APPROVAL: 15
Request
Query Params
tags[]
array[string]
optional
tag
Example:
["tag_1"]
from
string <date>
optional
Example:
09-25-2024
to
string <date>
optional
Example:
09-25-2024
client_id
integer
optional
If sent it will return orders beloging to the client
limit
integer
optional
cursor
integer
optional
status
array[string]
optional
status
Example:
["1"]
order_by
enum<string>
optional
Allowed values:
created_atappointment
sort
enum<string>
optional
Allowed values:
ASCDESC
Request samples
Responses
OK(200)
Error response(400)
Error response(404)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
status
string
required
orders
array [object {27}]
required
id
integer
required
status
string
required
client_id
integer
required
client_name
string
required
email
string
required
phone
object
required
address
string
required
service_description
string
required
events
array[string]
required
created_at
object
required
updated_at
object
required
tags
array[string]
required
token
string
required
status_label
enum<string>
required
Allowed values:
ErrorPendingEn RouteConfirmedJob StartedCompletedCancelledUnserviceableAction Required
client_city
string | null
required
client_state
string | null
required
client_street
string | null
required
client_zip
string | null
required
client_availability_ranges
array [object {4}]
required
skus
array [object {5}]
required
finish_order_url
string
required
order_summary_url
string
required
shipping_type
null
required
availability
array [object {2}] | null
required
consolidated_availability
object | null
required
appointment_start
string | null
required
appointment_start_date_time
string | null
required
cursor
integer | null
required
has_more
boolean
required
Example
{
"status": "string",
"orders": [
{
"id": 0,
"status": "string",
"client_id": 0,
"client_name": "string",
"email": "string",
"phone": {
"value": "string",
"formatted": "string"
},
"address": "string",
"service_description": "string",
"events": [
"string"
],
"created_at": {
"integer": 0,
"iso": "string",
"iso_short": "string"
},
"updated_at": {
"integer": 0,
"iso": "string",
"iso_short": "string"
},
"tags": [
"string"
],
"token": "string",
"status_label": "Error",
"client_city": "string",
"client_state": "string",
"client_street": "string",
"client_zip": "string",
"client_availability_ranges": [
{
"id": 0,
"from_datetime": {
"integer": 0,
"iso": "string",
"iso_short": "string"
},
"to_datetime": {
"integer": 0,
"iso": "string",
"iso_short": "string"
},
"range_mode": true
}
],
"skus": [
{
"id": 0,
"name": "string",
"sku_icon": {
"medium": "string",
"medium_retina": "string",
"thumb": "string",
"original": "string"
},
"hero_image": {
"medium": "string",
"medium_retina": "string",
"thumb": "string",
"original": "string"
},
"hero_mobile_image": {
"medium": "string",
"medium_retina": "string",
"thumb": "string",
"original": "string"
}
}
],
"finish_order_url": "string",
"order_summary_url": "string",
"shipping_type": null,
"availability": [
{
"value": "string",
"display": "string"
}
],
"consolidated_availability": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"appointment_start": "string",
"appointment_start_date_time": "string"
}
],
"cursor": 0,
"has_more": true
}Last modified: 11 days ago