Skip to main content

Create Integration Instance

POST 
//:domain/api/woo-commerce

Create a new WooCommerce integration instance.

After creation, the response includes a redirect_url for OAuth authorization with WooCommerce.

Authentication: Requires Bearer token.

Request Body:

  • name (string, required) — Unique name for the integration instance
  • integration_id (integer, required) — ID of the WooCommerce integration record
  • connection_settings (object, optional) — WooCommerce API keys
    • key_id (integer) — WooCommerce key ID
    • user_id (string) — WooCommerce user ID
    • consumer_key (string) — WooCommerce consumer key
    • consumer_secret (string) — WooCommerce consumer secret
    • key_permissions (string) — Key permissions (e.g. 'read_write')
  • integration_settings (object, required) — Store configuration
    • url (string, required) — Store URL, must start with 'https://' and not end with '/'
    • start_date (string, required) — Date to begin syncing orders from
    • store_id (integer, required) — SKU.io store ID
    • auto_link_products (boolean, required) — Auto-link WooCommerce products to SKU.io products
    • auto_create_products (boolean, required) — Auto-create SKU.io products for unlinked WooCommerce products
    • sales_nominal_code_id (integer, optional) — Nominal code for sales revenue
    • cogs_nominal_code_id (integer, optional) — Nominal code for COGS
    • shipping_revenue_nominal_code_id (integer, optional) — Nominal code for shipping revenue
    • shipping_refund_nominal_code_id (integer, optional) — Nominal code for shipping refunds
    • sales_returns_allowances_nominal_code_id (integer, optional) — Nominal code for returns
    • sync_sales_order_invoices_to_accounting (boolean, optional, default: true)
    • sync_sales_credit_to_accounting (boolean, optional, default: true)
    • batch_period_sales_order_fulfillments (string, optional) — Batch period override for fulfillments
    • batch_period_customer_returns (string, optional) — Batch period override for returns
    • proforma_marketplace_cost_percentage (float, optional)
    • proforma_payment_cost_percentage (float, optional)
  • is_automatic_sync_enabled (boolean, optional, default: false)

Request​

Responses​

Created

Response Headers
    Content-Type