API docs by RedoclyIntegrator Users API (1.0.0)
Download OpenAPI specification:Download
API for integrators to manage users
Register a new user as an integrator
Endpoint to register a new user as an integrator
Request Body schema: application/jsonrequired
required | object Registration Data |
| thirdPartyIntegratorId required | integer Third party integrator Id (provided by uShip) |
| paymentData | null Payment data (currently not used) |
Responses
Request samples
- Payload
Content type
application/json
{- "registrationData": {
- "user": {
- "emailAddress": "string",
- "userName": "string",
- "password": "string",
- "userType": "string",
- "firstName": "string",
- "lastName": "string",
- "homePhone": "string",
- "shipperType": "string"
}, - "userPreferences": {
- "timeZone": "string"
}
}, - "thirdPartyIntegratorId": 0,
- "paymentData": null
}Response samples
- 201
- 400
- 409
- 500
Content type
application/json
{- "apiKey": "string",
- "userGeneratedId": "string"
}