Skip to main content
POST
Connect WooCommerce

Authorizations

Authorization
string
header
required

Store-scoped API key. Prefix with sk_live_. Example: Authorization: Bearer sk_live_EXAMPLE_DO_NOT_USE

Body

application/json
webhook_url
string<uri>
required

Required. URL on your WordPress site that receives payment updates from Meum. Usually: https://your-store.com/wp-json/meum/v1/webhook

Example:

"https://shop.example.com/wp-json/meum/v1/webhook"

site_url
string<uri>
required

Required. Your store's public homepage URL (used to identify this WooCommerce site).

Example:

"https://shop.example.com"

plugin_version
string

Optional. Meum WooCommerce plugin version (e.g. "1.2.0"). Helps support diagnose issues.

Example:

"1.2.0"

wordpress_version
string

Optional. WordPress version (e.g. "6.5"). Omit if unknown.

Example:

"6.5"

woocommerce_version
string

Optional. WooCommerce version (e.g. "8.9"). Omit if unknown.

Example:

"8.9"

Response

WooCommerce connected

Credentials returned after a successful WooCommerce connection handshake.

store_id
string<uuid>

Meum store UUID linked to this site.

store_name
string

Store display name in Meum.

Example:

"Demo Store"

integration_id
string<uuid>

Integration UUID for this WooCommerce installation.

installation_id
string

Unique installation identifier for support and rotation.

Example:

"inst_a1b2c3d4e5f678901234"

site_url
string<uri>

Connected storefront URL.

api_key
string

Merchant API key for server-side calls (sk_live_...). Store securely.

Example:

"sk_live_EXAMPLE_DO_NOT_USE"

webhook_secret
string

Secret for verifying inbound webhooks from Meum to WordPress.

Example:

"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"

webhook_url
string<uri>

Registered webhook destination on the WordPress site.

webhook_id
string<uuid>

Meum webhook endpoint UUID for this integration.

status
string

Connection status (for example ACTIVE).

Example:

"ACTIVE"

credentials_rotated
boolean

True when this response re-issued credentials for an existing installation.

payout_configured
boolean

False until a payout wallet is configured for the store.

checkout_base_url
string<uri>

Base URL for hosted checkout links.

Example:

"https://pay.meum.io"

warning
string

Present when payout wallet is not configured; payments may be blocked until resolved.