Retrieve all orders

Returns 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
MASTER_CLIENT_APPROVAL: 8
UNSERVICEABLE: 9
PAUSED: 10
READY_TO_RESUME: 11
INCOMPLETE: 12
LATE_TECH: 13
PENDING_SHIPPING: 14
PENDING_APPROVAL: 15

Getting cancelled orders

GET /api/partners/orders?order_by=cancelled_at&sort=ASC&from=MM-DD-YYYY

Returns only cancelled orders, sorted by cancellation time with the oldest first. from and to filter by cancellation date.

If has_more is true, repeat the same request with cursor set to the cursor value from the previous response. Continue until has_more is false.

Save the last cursor you receive. For your next sync, send the same request with that cursor and you'll get only orders cancelled since then. You don't need from again.

Pass cursor back exactly as you received it, and keep the other parameters the same.

limit sets the page size (default 50).

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Bodyapplication/json

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",
            "purchase_order_id": "string",
            "purchase_order_source": "string"
        }
    ],
    "cursor": 0,
    "has_more": true
}

🟠400Error response

🟠404Error response

Possible order statuses:#

Getting cancelled orders#

Request

Request Code Samples

Responses

Possible order statuses:

Getting cancelled orders