Open Inventory / Docs
EndpointsIntegrationsIntegrationsWoocommerce

Connect or replace a WooCommerce store

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

PUT
/integrations/woocommerce

Tests the credentials against WooCommerce REST API v3 before encrypting and storing them. Requires webhooks.manage.

Authorization

adminSession
cookieauthjs.session-token<token>

Authenticated Auth.js browser session cookie; each operation declares its required permission. Not restricted to administrators. HTTPS deployments use the secure-prefixed cookie variant.

Header Parameters

X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Request Body

application/json
  1. body
storeUrl*string

Public HTTPS WooCommerce store URL, optionally including a WordPress subdirectory. Query strings and fragments are rejected.

Formaturi
Length1 <= length <= 2048
consumerKey*string
Match^ck_
Length8 <= length <= 200
consumerSecret*string
Match^cs_
Length8 <= length <= 200

Response Body

Connection tested and stored

application/json
  1. response
connection*
test*
Example Request
curl -X PUT 'https://inventory.example.com/api/v1/integrations/woocommerce' \  -H 'Content-Type: application/json' \  -d '{  "storeUrl": "https://shop.example.com",  "consumerKey": "stringst",  "consumerSecret": "stringst"}'
Example Response
{  "connection": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "storeUrl": "http://example.com",    "consumerKeyHint": "ck_1234…cdef",    "status": "connected",    "syncEnabled": true,    "lastCheckedAt": "2019-08-24T14:15:22Z",    "lastSuccessAt": "2019-08-24T14:15:22Z",    "lastError": "string",    "lastWebhookAt": "2019-08-24T14:15:22Z",    "lastSyncAt": "2019-08-24T14:15:22Z",    "lastSyncError": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "test": {    "productCount": 0,    "checkedAt": "2019-08-24T14:15:22Z"  }}

Enable or disable WooCommerce order synchronization PATCH

Creates or removes signed order.created and order.updated webhooks in WooCommerce. Enabling requires a public HTTPS AUTH_URL and a Consumer Key with write access.

Import recent WooCommerce orders, reconcile one order, or retry issues POST

Fetches canonical order and refund data from WooCommerce, projects the customer and sales order into Inventory, maps exact item or variant SKUs, and writes idempotent issue or return stock movements. Set window to last-7-days for a read-only WooCommerce import based on order creation time. Omitting both fields retries up to 20 recorded orders with issues.