API version

API reference / Connect an apideck-backed service

Connect an apideck-backed service

POST/connections/apideck/{service_id}/connect

Open an Apideck Vault session to connect one of the Apideck-backed services (BigCommerce, QuickBooks, Deel, Rippling, Gusto, WooCommerce, Amazon Seller Central, Etsy, Walmart, Magento, Shopware, Xero, NetSuite, Sage Intacct, Wix, Microsoft Dynamics 365 Business Central, DualEntry, Intuit Enterprise Suite). The returned token opens the Vault widget; complete the OAuth/credential flow there, then call the activate route with the resulting connectionId. shopId/shopUrl apply only to Shopware. A multi-org credential must send an Organization-Id, Connection-Id or Entity-Id selector, or gets a 400. Returns 503 if the Vault session call fails; retrying may succeed.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Path parameters

service_idApiDeckServiceEnumRequired

The Apideck service to connect.

Available options:bigcommercequickbooksdeelripplinggustowoocommerceamazon-seller-centraletsywalmartmagentoshopwarexeronetsuitesage-intacctwixmicrosoft-dynamics-365-business-centraldualentryintuit-enterprise-suite

Body

defaultCountryCountryCodeEnum

Default country for transactions imported through this connection.

Available options:AFAXALDZASADAOAIAQAGARAMAWAUATAZBSBHBDBBBYBEBZBJBMBTBOBQBABWBVBRIOBNBGBFBICVKHCMCAKYCFTDCLCNCXCCCOKMCGCDCKCRHRCUCWCYCZDKDJDMDOECEGSVGQEREESZETFKFOFJFIFRGFPFTFGAGMGEDEGHGIGRGLGDGPGUGTGGGNGWGYHTHMVAHNHKHUISINIDIRIQIEIMILITCIJMJPJEJOKZKEKIKPKRKWKGLALVLBLSLRLYLILTLUMOMGMWMYMVMLMTMHMQMRMUYTMXFMMDMCMNMEMSMAMZMMNANRNPNLNCNZNINENGNUNFMKMPNOOMPKPWPSPAPGPYPEPHPNPLPTPRQARERORURWBLSHKNLCMFPMVCWSSMSTSASNRSSCSLSGSXSKSISBSOZAGSSSESLKSDSRSJSECHSYTWTJTZTHTLTGTKTOTTTNTRTMTCTVUGUAAEGBUSUMUYUZVUVEVNVGVIWFEHYEZMZWXKZZ_EU

shopIdstring

Shopware only: the shop's Apideck shop id.

shopUrlstring

Shopware only: the shop's storefront URL.

Response

connectionIdstringRequired

The new connection's id, INACTIVE until Vault activation completes.

tokenstringRequired

Apideck Vault session token to open the connect widget.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

422

The request failed validation.

503

A service this request depends on was unavailable. Retry the request.

cURL

POST /connections/apideck/bigcommerce/connect

-H "Api-Key: ***"

-H "Api-Version: 2026-07-21"

{

"defaultCountry": "AF",

"shopId": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",

"shopUrl": "https://www.example.com"

}

Example request

https://api.trykintsugi.com/connections/apideck/bigcommerce/connect

Response

{

"connectionId": "conn_2mNpQr7Ls8f3k",

"token": "tok_2mNpQr7Ls8f3k"

}