DoctorX Public API
Version 1.0.0
The DoctorX Public API lets an external system manage a seller's marketplace catalog and orders across TikTok Shop, eBay, Etsy and Amazon.
Base URL
https://api.doctorx.vn/api/public/v1Get an API key
- Sign in to the DoctorX dashboard as an admin of the workspace. Keys belong to one workspace, and only its admins can create them. The workspace's plan must include the Developer API; below it, every request is refused with
plan_upgrade_required. - Open Settings → Integrations → API keys and choose Create key.
- Select only the scopes your integration needs (see Scopes). You can also limit the key to some shops, give it an expiry, and register a webhook endpoint in the same step.
- Copy the key when it is shown. It is shown once: a lost key is rotated, never recovered.
Make your first request
Export the key as DOCTORX_API_KEY, then list the shops it can reach (the key needs the authorize:read scope): List connected shops.
curl -X GET 'https://api.doctorx.vn/api/public/v1/authorize/shops' \
-H "Authorization: Bearer $DOCTORX_API_KEY"API reference
Authorize
Connected shops, grant health, and channel capabilities.
Templates
Listing templates and live marketplace taxonomy.
Products
Products, variants, per-shop listings and publishing.
Orders
Orders, line items, returns and tracking.
Webhooks
Event subscriptions, deliveries and signature verification.
Changes (polling)
Incremental sync feeds for partners without webhooks.
eBay
eBay business policies, inventory locations, marketplaces, item conditions and shipping services.
Etsy
Etsy shipping, return and processing profiles, shop sections, personalization templates and carriers.
Amazon
Amazon marketplace selection, content and bullet templates, publish defaults, product types, stock and review requests.
Finance
Payouts, the funds summary, marketplace ledger entries and profit and loss.
Analytics
Cross-shop sales, top products and shops, geography and revenue series.
