Sitecore OrderCloud Documentation

docs

Portal Login

Get a list of promotion assignments.

GET

/promotions/assignments

200

Roles

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

FullAccessPromotionAdminPromotionReader

Parameters

NameTypeDescriptionPossible Values
buyerIDstringID of the buyer.---
promotionIDstringID of the promotion.---
userIDstringID of the user.---
userGroupIDstringID of the user group.---
levelstringLevel of the promotion assignment. Possible values: User, Group, Company.User, Group, Company
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.---

Response Body

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

Get a list of promotion assignments.

GET

/promotions/assignments

200

Roles

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

FullAccessPromotionAdminPromotionReader

Parameters

NameTypeDescriptionPossible Values
buyerIDstringID of the buyer.---
promotionIDstringID of the promotion.---
userIDstringID of the user.---
userGroupIDstringID of the user group.---
levelstringLevel of the promotion assignment. Possible values: User, Group, Company.User, Group, Company
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.---

Response Body

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

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

Contact Us
Privacy Policy
Sitecore