API Overview - Superior Van Partner API

What this covers

Use this section to understand how to authenticate, which base URL to call, and what to expect in responses. The OpenAPI file powers the endpoint examples in this docs site.

Base URLs

Environment	URL
Production	`https://api.superiorvan.com/v1`
Sandbox	`https://sandbox.superiorvan.com/v1`

Authentication

Every request must include your vendor API key:

POST /lead HTTP/1.1
Host: api.superiorvan.com
x-api-key: <your-api-key>
Content-Type: application/json

Requests without a valid API key return 403 Forbidden.

Error handling

The API response includes a statusCode field in the JSON response.

400 Bad Request - validation failed or a required field is missing.
403 Forbidden - missing or invalid x-api-key.
404 Not Found - the referenced lead cannot be found.
5xx - unexpected errors; retry with backoff or contact support.

Endpoints in this release

Create Lead - submit a JSON lead to Superior Van.
Get Lead - retrieve the current status for a submitted lead.