Start connecting a WooCommerce shop from its own admin

POST

/shops/woocommerce/authorize

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

Answers with the shop’s own approval page to send the browser to. The shop owner signs in to their WordPress and approves read access; WooCommerce makes the key pair, posts it to Bottle and sends the browser back to the connections page. Nothing to copy. The shop must be reachable over https.

Authorizations

• sessionCookie
  shops:write
• apiKey
  shops:write

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 80 characters

url

required

string format: uri

Example^generated

{
  "name": "example",
  "url": "https://example.com"
}

Responses

200

Where to send the browser

Media typeapplication/json

object

authorizeUrl

required

string format: uri

Example^generated

{
  "authorizeUrl": "https://example.com"
}

401

Not signed in

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

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

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