Sitecore OrderCloud Documentation

docs

Portal Login

Create a new supplier user.

POST

/suppliers/{supplierID}/users

201

Description

If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.

Roles

At least one of the roles below is required to access this endpoint.

FullAccessSupplierUserAdmin

Parameters

NameTypeDescriptionPossible Values
supplierIDRequiredstringID of the supplier.---

Request Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
UsernameRequiredstring---100 characters---

Passwordstringpassword------
FirstNameRequiredstring---100 characters---
LastNameRequiredstring---100 characters---
EmailRequiredstring---200 characters---
Phonestring---100 characters---
TermsAcceptedstringdate-time------
ActiveRequiredboolean---------

xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
CompanyIDRead Onlystring---------
Usernamestring---100 characters---

Passwordstringpassword------
FirstNamestring---100 characters---
LastNamestring---100 characters---
Emailstring---200 characters---
Phonestring---100 characters---
TermsAcceptedstringdate-time------
Activeboolean---------

xpobject---------
AvailableRolesRead Onlyarray---------

LocaleRead Onlyobject---------

DateCreatedRead Onlystringdate-time------
PasswordLastSetDateRead Onlystringdate-time------

Create a new supplier user.

POST

/suppliers/{supplierID}/users

201

Description

If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.

Roles

At least one of the roles below is required to access this endpoint.

FullAccessSupplierUserAdmin

Parameters

NameTypeDescriptionPossible Values
supplierIDRequiredstringID of the supplier.---

Request Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
UsernameRequiredstring---100 characters---

Passwordstringpassword------
FirstNameRequiredstring---100 characters---
LastNameRequiredstring---100 characters---
EmailRequiredstring---200 characters---
Phonestring---100 characters---
TermsAcceptedstringdate-time------
ActiveRequiredboolean---------

xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
CompanyIDRead Onlystring---------
Usernamestring---100 characters---

Passwordstringpassword------
FirstNamestring---100 characters---
LastNamestring---100 characters---
Emailstring---200 characters---
Phonestring---100 characters---
TermsAcceptedstringdate-time------
Activeboolean---------

xpobject---------
AvailableRolesRead Onlyarray---------

LocaleRead Onlyobject---------

DateCreatedRead Onlystringdate-time------
PasswordLastSetDateRead Onlystringdate-time------

Sitecore Logo

© Copyright 2024, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore