Get standard API order sync settings

GET

/api/v5/bookings/sync

Production

Returns the order-sync configuration for the key: which order statuses (pending, processing, on-hold, completed, cancelled, refunded, failed) are synced and whether multi-warehouse is enabled. Requires an API key.

Authorizations

ApiKeyAuth

Responses

200

Order sync settings

object

shipping_title

required

Any of:

string

enable_sync

Present and “disabled” when order syncing is turned off.

string

Allowed values: disabled

pending

“on” when orders with pending status are synced.

string

Allowed values: on

processing

“on” when orders with processing status are synced.

string

Allowed values: on

onhold

“on” when on-hold orders are synced.

string

Allowed values: on

completed

“on” when completed orders are synced.

string

Allowed values: on

cancelled

“on” when cancelled orders are synced.

string

Allowed values: on

refunded

“on” when refunded orders are synced.

string

Allowed values: on

failed

“on” when failed orders are synced.

string

Allowed values: on

multiwarehouse_enabled

required

Any of:

string
string

string

Allowed values: on

401

Missing or invalid API key

object

error

required

Human-readable settings error message.

string

404

API key not found

object

error

required

Human-readable settings error message.

string