Endpoint - Add New User

Request

Post

AddNewUserRequest

Field NameTypeDescription
LinnworksUniqueIdentifierGUIDUniqueidentifer of the Linnworks customer's account. Will never change.
EmailStringEmail of the customer, subject to change.
AccountNameStringAccount name being integrated into the system. Will never change and on integration it is suggest that duplicates are checked for. Nb. Customers may expect to have multiple integrations of the same channel in Linnworks.

Sample

{
  "LinnworksUniqueIdentifier": "005d4263-5a0c-43ce-bdc5-526955604107",
  "Email": "[email protected]",
  "AccountName": "My Account name"
}

Response

AddNewUserResponse

Field NameTypeDescription
ErrorStringError string if there was an issue with the call.

null or Empty string are valid when no error
AuthorizationTokenStringIf successful the authorization token string of the customer. This will be used for all subsequent calls.
IsErrorBooleanIndicates if there is an error

Sample

{
  "AuthorizationToken": "a8e53e86eead4b69beaa0afcc29b67fb",
  "IsError": false,
  "ErrorMessage": null
}
{
  "AuthorizationToken": "",
  "IsError": true,
  "ErrorMessage": "An error to display to the user"
}