Integrator Users API 1.0.0

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.

🏖️ Testing Environment

Always test your integration in sandbox before deploying to production.

🏖️ Sandbox (Recommended for Testing): https://api-partners.ushipsandbox.com
🚀 Production: https://api-partners.uship.com

Note: This API uses a partner-specific subdomain (api-partners) and requires separate API keys for sandbox and production.

Authentication

This API uses Bearer token authentication. To obtain partner API credentials:

Contact uShip Integration Team at apisupport@uship.com
Request partner API access for user management
Receive your API key for sandbox testing
Include in the Authorization header: Authorization: Bearer <Your API Key>

Getting Started

For detailed sandbox testing guidance, see our Sandbox Guide.

For integration guides and tutorials, visit uShip DeveloperHub.

Server

https://api-partners.uship.com

https://api-partners.ushipsandbox.com

Register a new user as an integrator

Endpoint to register a new user as an integrator

Auth

Request Body

IntegratorsUsersPostRequest	object
registrationData	object	Required. Registration Data
user	object	Required. User Data
emailAddress	string	Required. Email address of the user
userName	string	Required. Username
password	string	Required. Password
userType	string	Required. Type of user
firstName	string	Required. First name of the user
lastName	string	Required. Last name of the user
homePhone	string	Required. Home phone number of the user
shipperType	string	Required. Type of shipper
userPreferences	object	Required. User Preferences
timeZone	string	Required. Time zone of the user
thirdPartyIntegratorId	integer	Required. Third party integrator Id (provided by uShip)

POST /integrators/users

xxxxxxxxxx
 
curl --request POST \ --url 'https://api-partners.uship.com/integrators/users' \ --data '{  "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}"}'
Copy

Responses

201

User created successfully

IntegratorsUsersPost201Response	object
apiKey	string	Required. API key for the user
userGeneratedId	string	Required. User generated ID

400

Bad Request

409

Conflict

500

Internal Server Error

Response

xxxxxxxxxx
 
{ "apiKey": "Example value", "userGeneratedId": "Example value"}
Copy