Set up automatic shop order imports

POST

/shops/{id}/order-sync/setup

const url = 'https://example.com/shops/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/order-sync/setup';
const options = {
  method: 'POST',
  headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/shops/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/order-sync/setup \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Authorizations

sessionCookie
shops:write
apiKey
shops:write

Parameters

Path Parameters

required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

200

Order feed status

application/json

object

required

UUID v7

string format: uuid

source

required

string

Allowed values: woocommerce shopify

name

required

string

customerName

string | null

url

required

string

priceBasis

required

Shop: read the shop’s own setting (WooCommerce prices include tax, Shopify taxes included), and the business’s pricesIncludeVat when it will not say. inc: every price from this shop includes VAT. ex: none of them do.

string

Allowed values: shop inc ex

catalogueImportSettings

object

importImages

required

boolean

importDescriptions

required

boolean

importCylinderCharges

required

boolean

suggestGasTypes

required

boolean

reviewGasTypes

required

boolean

syncOrderCompletion

boolean

catalogueMain

boolean

importOrdersAutomatically

required

boolean

orderSyncStatus

required

Setup_required: order feed still needs authenticating; receiving: it has received or reconciled orders; error: the latest attempt failed; off: automatic order import is switched off.

string

Allowed values: setup_required receiving error off

orderSyncStartedAt

required

string | null format: date-time

lastOrderSyncAt

required

string | null format: date-time

lastOrderSyncError

required

string | null

lastPulledAt

required

string | null format: date-time

lastError

required

string | null

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "source": "woocommerce",
  "name": "Main shop",
  "customerName": "Thameside Trade Gas",
  "url": "https://acmegas.co.uk",
  "priceBasis": "shop",
  "orderSyncStatus": "setup_required"
}

401

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Only an owner or admin can manage order imports

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Shop not found

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

503

Order worker temporarily unavailable

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}