Download OpenAPI specification:
API for partner integrators to programmatically create and manage user accounts on the uShip platform.
| Environment | URL | Description |
|---|---|---|
| Sandbox | https://api-partners.ushipsandbox.com |
Test environment for development |
| Production | https://api-partners.uship.com |
Live production environment |
Note: This API uses a partner-specific subdomain (
api-partners) unlike other uShip APIs.
All API requests require Bearer token authentication.
Authorization: Bearer <your_api_key>
| Guide | Description |
|---|---|
| Sandbox Testing Guide | Comprehensive sandbox testing documentation |
| uShip DeveloperHub | Integration guides and tutorials |
For questions or assistance, contact: apisupport@uship.com
Create and manage user accounts. Users created through this API are associated with your integrator account.
Endpoint to register a new user as an integrator
required | object Required. Registration Data |
| thirdPartyIntegratorId required | integer Required. Third party integrator Id (provided by uShip) |
| paymentData | null Payment data (currently not used) |
{- "registrationData": {
- "user": {
- "emailAddress": "john.doe@example.com",
- "userName": "johndoe123",
- "password": "SecureP@ssw0rd!",
- "userType": "Shipper",
- "firstName": "John",
- "lastName": "Doe",
- "homePhone": "512-555-0123",
- "shipperType": "Individual"
}, - "userPreferences": {
- "timeZone": "America/Chicago"
}
}, - "thirdPartyIntegratorId": 1,
- "paymentData": null
}{- "apiKey": "abc123def456ghi789jkl012mno345",
- "userGeneratedId": "30450164"
}