Start connecting a WooCommerce shop from its own admin
POST
/shops/woocommerce/authorize
const url = 'https://example.com/shops/woocommerce/authorize';const options = { method: 'POST', headers: { cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>', 'Content-Type': 'application/json' }, body: '{"name":"example","url":"https://example.com","importOrdersAutomatically":true,"shopId":"019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"}'};
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/woocommerce/authorize \ --header 'Content-Type: application/json' \ --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \ --data '{ "name": "example", "url": "https://example.com", "importOrdersAutomatically": true, "shopId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" }'Answers with the shop’s WordPress approval page. Catalogue-only access asks for Read; importOrdersAutomatically explicitly asks for Read/Write to manage Bottle’s order webhooks. shopId upgrades an existing connection without disconnecting or changing its identity. WooCommerce delivers the keys directly to Bottle. The shop must be reachable over https.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
name
required
string
url
required
string format: uri
importOrdersAutomatically
boolean
shopId
UUID v7
string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8fResponses
Section titled “Responses”Where to send the browser
Media typeapplication/json
object
authorizeUrl
required
string format: uri
Example generated
{ "authorizeUrl": "https://example.com"}Not signed in
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}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"}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"}Validation failed
Media typeapplication/json
object
error
required
string
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{ "error": "validation", "issues": [ { "path": "email", "message": "Invalid email" } ]}