The Velocity API lets you work with your reps, teams, ownerships, and commissions from your own code, instead of through the app in Shopify Admin. Use it to sync reps from an HR system, push ownerships from a CRM, or pull commission data into payroll.
api-docs.velocity.shop
The reference is the full documentation: every endpoint with its parameters and responses, worked guides, an OpenAPI specification for generating a client, and its own changelog. This page covers what you need before you start.
Availability
API access is part of the Premium plan. You can see your current plan, and change it, under Pricing in the Velocity app.
Getting an API key
In the Velocity app, open Settings and find the Integration Settings card. Enter a name for the integration, then select Generate API key.
Name keys after the system that will use them, such as the payroll export or the CRM sync, so they are easy to tell apart later.
API keys are shared by every staff member on the store, and they carry full access to your Velocity data. Treat one like a password: keep it out of client-side code, and generate a separate key per integration so you can revoke one without breaking the others.
Base URL and authentication
All requests go to:
https://api.velocity.shop
Authenticate by sending your key as a bearer token in the Authorization header on every request:
Authorization: Bearer your-token
What you can do with it
The API covers reps and their Rep Portal accounts, teams and their hierarchies, ownerships, and calculated commissions. See the reference for the endpoints under each.
A few things worth knowing when planning an integration:
Reps can be enabled and disabled in bulk through the API, which the app itself does not offer.
List endpoints are paginated with
limitandoffset. The default page size is 20 and the maximum is 100.Each token is limited to 60 requests per minute. Going over that returns
429 Too Many Requests.
For what these concepts mean in the product, rather than how to call them, see How Commission Is Assigned.
Reporting without the API
If you only need commission data for reporting, you may not need the API at all. Velocity writes commission details to every order as Shopify metafields, which you can use directly in Shopify's own report builder. See Metafield Reporting.