Login
Exchange your identity (username, email, organisation name) and your organisation’s API credential (client_id + client_secret) for a bearer token valid for 10 days. The credential is issued per organisation by Vortex IQ — contact support to have one provisioned. The organisation must have Store Migration enabled and at least 2 connected BigCommerce stores (a migration needs a source and a destination). Rate limited to 10 requests per minute.
Body
Your name as registered on your Vortex IQ account (first name, last name, or full name — case-insensitive).
"Jane Merchant"
The email of your Vortex IQ user.
"jane@example.com"
Your organisation's name exactly as registered (case-insensitive). Your user must belong to this organisation.
"Example Retail Ltd"
Your organisation's API client id, issued by Vortex IQ.
"viq_bcmig_Ab12Cd34Ef56Gh78Ij90Kl12"
Your organisation's API client secret. Shown once at issue time; keep it server-side.
"<client-secret>"
Response
Authenticated. Send access_token as Authorization: Bearer <token> on every subsequent call.
The BigCommerce stores connected to your organisation. Use these store hashes on the migration endpoints.
"Bearer"
The bearer token (JWT). Treat it as a secret.
Token lifetime in seconds (864000 = 10 days).
864000
Absolute expiry time (ISO 8601).