Connect Shopee, TikTok Shop, Lazada, or Shopify after a paid plan. Sandbox connections skip this page and use the mock adapter.
Shared flow
- Open Console, then Connections, then Connect live shop.
- Choose the platform.
- Finish that platform's OAuth screen. Ongapi never asks for the seller password.
- Orders from all four platforms land in one canonical model.
Programmatic connect (ISV)
Use a live API key and POST /v1/connections/authorize with JSON:
platform:shopee,tiktok_shop,lazada, orshopifyregion:MY,SG,TH,VN,PH, orIDreturn_url: HTTPS URL on your app (where Ongapi redirects after OAuth)shop_domain: required for Shopify (your-store.myshopify.com)
The response includes authorize_url and state. Send the seller to authorize_url.
After the seller approves, Ongapi redirects to your return_url with query parameters:
| Outcome | Query parameters |
|---|---|
| Success | connection_id, status=active |
| Failure | status=error, error (short code or message) |
Load platform, platform_shop_id, and status with GET /v1/connections/{connection_id}.
Test API keys (ong_test_…) always authorize the mock adapter, even if you pass a live platform name.
Shopify
Enter the shop domain before OAuth. Use the full your-store.myshopify.com host.
- Scope:
read_orders(last 60 days), plus fulfillment, location, and inventory scopes for ship and stock writes. Buyer name, phone, and shipping address stay empty until Shopify grants protected customer data access for the app. - Admin API version:
2026-10unlessSHOPIFY_API_VERSIONoverrides it.2025-01is no longer a supported Shopify version. - Webhooks registered on the app:
orders/createandorders/updated. - A fulfilled order is stored as
shipped. Ongapi does not map it tocompleted, because that would skip the legal steps after ready to ship. - Shopify has no marketplace AWB on
GET …/shipping-label(waybill_unavailable). Orderwaybill_urlis the fulfillment tracking link when Shopify sends one.platform_logisticsship mode returnscapability_unsupported.seller_trackingcreates a fulfillment. Warehouses and inventory use locations. Live calls need fulfillment and inventory scopes and may returncapability_unsupporteduntil the shop re-authorizes. See Orders and events.
Shopee, TikTok Shop, and Lazada
Pick a region instead of a shop domain: MY, SG, TH, VN, PH, or ID. Partner apps for Shopee, TikTok Shop, Lazada, and Shopify are enabled in production. On a paid plan, connect a live shop from Console.
Redirects
| Platform | What you register |
|---|---|
| Shopee | /oauth/shopee/callback |
| TikTok Shop | /oauth/tiktok_shop/callback |
| Lazada | /oauth/lazada/callback |
| Shopify | /oauth/shopify/callback |