start_channel_connect
Begin connecting a sales channel or fulfillment provider by returning an authorization URL to give the user, then keep polling connection status until it reports connected.
Instructions
Begin a browser-based connection (Printful, Shopify, TikTok Shop, Fourthwall). Shopify additionally requires shop_url, the merchant myshopify domain — ask for it before calling. Returns an authorization URL to give the user. THE CONNECTION IS NOT FINISHED WHEN THIS RETURNS. You must keep polling check_connection_status (passing the same provider_uuid) until it reports connected, then tell the user. The browser tab where they authorize is NOT this conversation and cannot report back to you, so polling is the only way you or they will learn it worked. Poll every few seconds, up to about two minutes, and if it has not landed by then ask whether they finished authorizing rather than giving up silently. If they need to create an upstream account first, let them, then call this again for a fresh link.
[#6d4006]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | Which family this provider belongs to (from list_connectable_providers.family). | |
| shop_url | No | Required for Shopify only: the merchant's myshopify domain, e.g. your-store.myshopify.com. Ask the user for it; it is the domain in their Shopify admin URL, not their custom storefront domain. Omit for every other provider. | |
| workspace | No | Workspace uuid the store lives in (agency accounts) — use the store's workspace.uuid from list_my_stores. Omit only for single-workspace accounts; omitting it on a multi-workspace account targets the Default workspace and the call will fail to find a store that lives elsewhere. | |
| store_name | No | Name for a NEW store, when connecting fulfillment without an existing store_uuid. | |
| store_uuid | No | Store to attach to. Required for sales_channel. For fulfillment, omit it together with store_name to create a new store. | |
| callback_url | No | OMIT THIS. The platform fills in the callback registered with the provider, and for Shopify that registered URL is the only one that works — anything else is refused, either by us or by Shopify with an error naming neither what was sent nor what was wanted. Set it only if you have been given a specific URL to use. | |
| provider_uuid | Yes | Provider uuid (from list_connectable_providers). |