Download OpenAPI specification:
API for integrators to register and manage users within the uShip platform. This API is designed for partners who need to create user accounts programmatically.
Always test your integration in sandbox before deploying to production.
https://api-partners.ushipsandbox.comhttps://api-partners.uship.comNote: This API uses a partner-specific subdomain (api-partners) and requires separate API keys for sandbox and production.
This API uses Bearer token authentication. To obtain partner API credentials:
Authorization header: Authorization: Bearer <Your API Key>For detailed sandbox testing guidance, see our Sandbox Guide.
For integration guides and tutorials, visit uShip DeveloperHub.
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": "Example value",
- "userName": "Example value",
- "password": "Example value",
- "userType": "Example value",
- "firstName": "Example value",
- "lastName": "Example value",
- "homePhone": "Example value",
- "shipperType": "Example value"
}, - "userPreferences": {
- "timeZone": "Example value"
}
}, - "thirdPartyIntegratorId": 1,
- "paymentData": null
}{- "apiKey": "Example value",
- "userGeneratedId": "Example value"
}