Sitecore OrderCloud Documentation

docs

Portal Login

Get a list of supplier user groups.

GET

/suppliers/{supplierID}/usergroups

200

Roles

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

FullAccessSupplierUserGroupAdminSupplierUserGroupReader

Parameters

NameTypeDescriptionPossible Values
supplierIDRequiredstringID of the supplier.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, Name, Description
sortByarrayComma-delimited list of fields to sort by.Name, ID, !Name, !ID
pageintegerPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.---
pageSizeintegerNumber of results to return per page. Default: 20, max: 100.---
filtersobjectAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'---

Response Body

PropertyTypeFormatMax LengthPossible Values
Itemsarray---------
Metaobject---------

Get a list of supplier user groups.

GET

/suppliers/{supplierID}/usergroups

200

Roles

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

FullAccessSupplierUserGroupAdminSupplierUserGroupReader

Parameters

NameTypeDescriptionPossible Values
supplierIDRequiredstringID of the supplier.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, Name, Description
sortByarrayComma-delimited list of fields to sort by.Name, ID, !Name, !ID
pageintegerPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.---
pageSizeintegerNumber of results to return per page. Default: 20, max: 100.---
filtersobjectAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'---

Response Body

PropertyTypeFormatMax LengthPossible Values
Itemsarray---------
Metaobject---------
Sitecore Logo

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

Contact Us
Privacy Policy
Sitecore