Integrator Users API 1.0.0

API for partner integrators to programmatically create and manage user accounts on the uShip platform.

Getting Started

Base URLs

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.

Authentication

All API requests require Bearer token authentication.

Obtaining Your API Key

Contact the uShip Integration Team at apisupport@uship.com
Request partner API access for user management
Receive your API key for sandbox testing
Include in all requests:

Authorization: Bearer <your_api_key>

Integration Guides

Guide	Description
Sandbox Testing Guide	Comprehensive sandbox testing documentation
uShip DeveloperHub	Integration guides and tutorials

Support

For questions or assistance, contact: apisupport@uship.com

Server

https://api-partners.uship.com

Production

https://api-partners.ushipsandbox.com

Sandbox (Testing)

Users

Create and manage user accounts. Users created through this API are associated with your integrator account.

POST

/integrators/users

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": "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}"}'
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": "abc123def456ghi789jkl012mno345", "userGeneratedId": "30450164"}
Copy