Skip to content
Bottle

Connect a shop

POST
/shops
curl --request POST \
  --url https://example.com/shops \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "source": "woocommerce", "consumerKey": "example", "consumerSecret": "example", "name": "example", "url": "https://example.com" }'

WooCommerce takes a consumer key and secret generated under Settings, Advanced, REST API. Shopify takes the access token from a custom app made in the shop admin. Read-only credentials are enough, and worth preferring. Connecting the same address again replaces the credentials rather than adding a second connection.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
One of:
object
source
required
string
Allowed values: woocommerce
consumerKey
required
string
>= 1 characters
consumerSecret
required
string
>= 1 characters
name
required
string
>= 1 characters <= 80 characters
url
required
string format: uri

Responses

Section titled “Responses”

201

Section titled “201”

Connected

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
source
required
string
Allowed values: woocommerce shopify
name
required
string
url
required
string
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",
  "url": "https://acmegas.co.uk"
}

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"
}

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"
    }
  ]
}