Skip to content
Bottle

Update a shop

PATCH
/shops/{id}
curl --request PATCH \
  --url https://example.com/shops/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "name": "example", "customerName": "example", "priceBasis": "shop", "syncOrderCompletion": true, "importOrdersAutomatically": true, "catalogueImportSettings": { "importImages": true, "importDescriptions": true, "importCylinderCharges": true, "suggestGasTypes": true, "reviewGasTypes": true }, "catalogueMain": true }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid

Example 

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

UUID v7

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
string
>= 1 characters <= 80 characters
customerName
string | null
>= 1 characters <= 80 characters
priceBasis

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
syncOrderCompletion
boolean
importOrdersAutomatically
boolean
catalogueImportSettings
object
importImages
required
boolean
importDescriptions
required
boolean
importCylinderCharges
required
boolean
suggestGasTypes
required
boolean
reviewGasTypes
required
boolean
catalogueMain
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Updated

Media typeapplication/json
object
id
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

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

403

Section titled “403”

Not allowed to manage shops, or asking for a key to do it

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

404

Section titled “404”

No such shop

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

409

Section titled “409”

Another connected shop of this business already has that name

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}