Integrator Users API 1.0.0

API for integrators to manage users

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	Registration Data
user	object	User Data
emailAddress	string	Email address of the user
userName	string	Username
password	string	Password
userType	string	Type of user
firstName	string	First name of the user
lastName	string	Last name of the user
homePhone	string	Home phone number of the user
shipperType	string	Type of shipper
userPreferences	object	User Preferences
timeZone	string	Time zone of the user
thirdPartyIntegratorId	integer	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": "{string}",      "userName": "{string}",      "password": "{string}",      "userType": "{string}",      "firstName": "{string}",      "lastName": "{string}",      "homePhone": "{string}",      "shipperType": "{string}"    },    "userPreferences": {      "timeZone": "{string}"    }  },  "thirdPartyIntegratorId": "{integer}",  "paymentData": "{null}"}'
Copy

Responses

201

User created successfully

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

400

Bad Request

409

Conflict

500

Internal Server Error

Response

xxxxxxxxxx
 
{ "apiKey": "{string}", "userGeneratedId": "{string}"}
Copy