The Velocity API lets you integrate directly with your Velocity tenant from your own code. It exposes the same endpoints that power the Velocity Zapier integration, so anything you can automate through Zapier you can also build against directly over HTTP.
If you haven't already, please ask your Velocity account manager to enable the integration for your tenant. The API uses the same access as the Zapier app.
Full API Reference
Complete, interactive reference documentation for every endpoint, including request and response schemas and live examples, is hosted separately:
velocity-api-docs.medshift.com
Base URL
All requests are made to your tenant's subdomain:
https://{tenant}.api.velocity.medshift.com/integrations/zapierReplace {tenant} with your subdomain. If your Velocity URL is example.velocity.medshift.com, your tenant is example and your base URL is https://example.api.velocity.medshift.com/integrations/zapier.
Authentication
The API authenticates with an API key sent in the X-API-Key header on every request. This is the same key used by the Zapier integration, available from Velocity Settings > Integrations.
X-API-Key: your-api-key
Treat your API key like a password. Keep it secret, never expose it in client-side code, and rotate it from the Integrations settings page if it is ever compromised.
What's Available
The API is organized by resource and currently supports version v1. Available resources include:
Customers: create, retrieve, update, list, and approve or unapprove customers, plus their addresses, attachments, ownerships, commission overrides, and terms
Organizations: create, retrieve, update, delete, and list organizations, plus their attachments and terms
Orders: retrieve, update, list, and approve or unapprove orders, plus order attachments and refunds
External Orders: create orders that originate outside Velocity
Reps and Sales Teams: manage reps, view sales teams and their hierarchy
Commission Programs, Customer Ownerships, and Commission Overrides
Custom Fields and Labels for customers, orders, organizations, and reps
Customer Groups, Payouts, and Shipments
Webhooks: create and delete webhook subscriptions to receive events
See the full reference for the complete list of endpoints, parameters, and schemas.
Prefer No Code?
If you'd rather build integrations without writing code, the same capabilities are available through our Zapier integration, which connects Velocity to thousands of apps using triggers and actions.