Queries and mutations for managing Associate Roles in the platform.

Queries

Query Associate Roles

QUERYassociateRoles
Arguments
where​
String​
sort​
Array of String​
limit​
Int​
offset​
Int​

Get Associate Role

QUERYassociateRole
Arguments
id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Mutations

Create Associate Role

MUTATIONcreateAssociateRole
Arguments
draft​

Update Associate Role

MUTATIONupdateAssociateRole
Arguments
version​
Long​
actions​
Array of AssociateRoleUpdateAction​
id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Delete Associate Role

MUTATIONdeleteAssociateRole
Arguments
version​
Long​
personalDataErasure​
Boolean​
Default: false​
id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Output types

AssociateRole

key​
String​

User-defined unique and immutable identifier of the AssociateRole.

buyerAssignable​
Boolean​
Whether the AssociateRole can be assigned to an Associate by a buyer. If false, the AssociateRole can only be assigned using the general endpoint.
name​
String​

Name of the AssociateRole.

permissions​
Array of Permission​

List of Permissions for the AssociateRole.

Can be AcceptMyQuotes, AcceptOthersQuotes, AddChildUnits, CreateApprovalRules, CreateMyCarts, CreateMyOrdersFromMyCarts, CreateMyOrdersFromMyQuotes, CreateMyPaymentMethods, CreateMyQuoteRequestsFromMyCarts, CreateMyShoppingLists, CreateOrdersFromOthersCarts, CreateOrdersFromOthersQuotes, CreateOthersCarts, CreateOthersPaymentMethods, CreateOthersShoppingLists, CreateQuoteRequestsFromOthersCarts, DeclineMyQuotes, DeclineOthersQuotes, DeleteMyCarts, DeleteMyPaymentMethods, DeleteMyShoppingLists, DeleteOthersCarts, DeleteOthersPaymentMethods, DeleteOthersShoppingLists, ReassignMyQuotes, ReassignOthersQuotes, RenegotiateMyQuotes, RenegotiateOthersQuotes, UpdateApprovalFlows, UpdateApprovalRules, UpdateAssociates, UpdateBusinessUnitDetails, UpdateMyCarts, UpdateMyOrders, UpdateMyPaymentMethods, UpdateMyQuoteRequests, UpdateMyShoppingLists, UpdateOthersCarts, UpdateOthersOrders, UpdateOthersPaymentMethods, UpdateOthersQuoteRequests, UpdateOthersShoppingLists, UpdateParentUnit, ViewMyCarts, ViewMyOrders, ViewMyPaymentMethods, ViewMyQuoteRequests, ViewMyQuotes, ViewMyShoppingLists, ViewOthersCarts, ViewOthersOrders, ViewOthersPaymentMethods, ViewOthersQuoteRequests, ViewOthersQuotes, or ViewOthersShoppingLists​
custom​

Custom Fields of the AssociateRole.

id​
String​

Unique identifier of the AssociateRole.

version​
Long​

Current version of the AssociateRole.

createdAt​
DateTime​

Date and time (UTC) the AssociateRole was initially created.

lastModifiedAt​
DateTime​

Date and time (UTC) the AssociateRole was last updated.

createdBy​
Initiator​

IDs and references that created the AssociateRole.

lastModifiedBy​
Initiator​

IDs and references that last modified the AssociateRole.

Permission

AcceptMyQuotes
AcceptOthersQuotes
AddChildUnits
CreateApprovalRules
CreateMyCarts
CreateMyOrdersFromMyCarts
CreateMyOrdersFromMyQuotes
CreateMyPaymentMethods
CreateMyQuoteRequestsFromMyCarts
CreateMyShoppingLists
CreateOrdersFromOthersCarts
CreateOrdersFromOthersQuotes
CreateOthersCarts
CreateOthersPaymentMethods
CreateOthersShoppingLists
CreateQuoteRequestsFromOthersCarts
DeclineMyQuotes
DeclineOthersQuotes
DeleteMyCarts
DeleteMyPaymentMethods
DeleteMyShoppingLists
DeleteOthersCarts
DeleteOthersPaymentMethods
DeleteOthersShoppingLists
ReassignMyQuotes
ReassignOthersQuotes
RenegotiateMyQuotes
RenegotiateOthersQuotes
UpdateApprovalFlows
UpdateApprovalRules
UpdateAssociates
UpdateBusinessUnitDetails
UpdateMyCarts
UpdateMyOrders
UpdateMyPaymentMethods
UpdateMyQuoteRequests
UpdateMyShoppingLists
UpdateOthersCarts
UpdateOthersOrders
UpdateOthersPaymentMethods
UpdateOthersQuoteRequests
UpdateOthersShoppingLists
UpdateParentUnit
ViewMyCarts
ViewMyOrders
ViewMyPaymentMethods
ViewMyQuoteRequests
ViewMyQuotes
ViewMyShoppingLists
ViewOthersCarts
ViewOthersOrders
ViewOthersPaymentMethods
ViewOthersQuoteRequests
ViewOthersQuotes
ViewOthersShoppingLists

AssociateRoleQueryResult

offset​
Int​
count​
Int​
total​
Long​
exists​
Boolean​
results​
Array of AssociateRole​

Input types

AssociateRoleDraft

key​
String​

User-defined unique and immutable identifier for the AssociateRole.

name​
String​

Name of the AssociateRole.

buyerAssignable​
Boolean​
Whether the AssociateRole can be assigned to an Associate by a buyer.
permissions​
Array of Permission​

List of Permissions for the AssociateRole.

Can be AcceptMyQuotes, AcceptOthersQuotes, AddChildUnits, CreateApprovalRules, CreateMyCarts, CreateMyOrdersFromMyCarts, CreateMyOrdersFromMyQuotes, CreateMyPaymentMethods, CreateMyQuoteRequestsFromMyCarts, CreateMyShoppingLists, CreateOrdersFromOthersCarts, CreateOrdersFromOthersQuotes, CreateOthersCarts, CreateOthersPaymentMethods, CreateOthersShoppingLists, CreateQuoteRequestsFromOthersCarts, DeclineMyQuotes, DeclineOthersQuotes, DeleteMyCarts, DeleteMyPaymentMethods, DeleteMyShoppingLists, DeleteOthersCarts, DeleteOthersPaymentMethods, DeleteOthersShoppingLists, ReassignMyQuotes, ReassignOthersQuotes, RenegotiateMyQuotes, RenegotiateOthersQuotes, UpdateApprovalFlows, UpdateApprovalRules, UpdateAssociates, UpdateBusinessUnitDetails, UpdateMyCarts, UpdateMyOrders, UpdateMyPaymentMethods, UpdateMyQuoteRequests, UpdateMyShoppingLists, UpdateOthersCarts, UpdateOthersOrders, UpdateOthersPaymentMethods, UpdateOthersQuoteRequests, UpdateOthersShoppingLists, UpdateParentUnit, ViewMyCarts, ViewMyOrders, ViewMyPaymentMethods, ViewMyQuoteRequests, ViewMyQuotes, ViewMyShoppingLists, ViewOthersCarts, ViewOthersOrders, ViewOthersPaymentMethods, ViewOthersQuoteRequests, ViewOthersQuotes, or ViewOthersShoppingLists​
custom​

Custom Fields for the AssociateRole.

Permission

AcceptMyQuotes
AcceptOthersQuotes
AddChildUnits
CreateApprovalRules
CreateMyCarts
CreateMyOrdersFromMyCarts
CreateMyOrdersFromMyQuotes
CreateMyPaymentMethods
CreateMyQuoteRequestsFromMyCarts
CreateMyShoppingLists
CreateOrdersFromOthersCarts
CreateOrdersFromOthersQuotes
CreateOthersCarts
CreateOthersPaymentMethods
CreateOthersShoppingLists
CreateQuoteRequestsFromOthersCarts
DeclineMyQuotes
DeclineOthersQuotes
DeleteMyCarts
DeleteMyPaymentMethods
DeleteMyShoppingLists
DeleteOthersCarts
DeleteOthersPaymentMethods
DeleteOthersShoppingLists
ReassignMyQuotes
ReassignOthersQuotes
RenegotiateMyQuotes
RenegotiateOthersQuotes
UpdateApprovalFlows
UpdateApprovalRules
UpdateAssociates
UpdateBusinessUnitDetails
UpdateMyCarts
UpdateMyOrders
UpdateMyPaymentMethods
UpdateMyQuoteRequests
UpdateMyShoppingLists
UpdateOthersCarts
UpdateOthersOrders
UpdateOthersPaymentMethods
UpdateOthersQuoteRequests
UpdateOthersShoppingLists
UpdateParentUnit
ViewMyCarts
ViewMyOrders
ViewMyPaymentMethods
ViewMyQuoteRequests
ViewMyQuotes
ViewMyShoppingLists
ViewOthersCarts
ViewOthersOrders
ViewOthersPaymentMethods
ViewOthersQuoteRequests
ViewOthersQuotes
ViewOthersShoppingLists

AssociateRoleUpdateAction

addPermission​
changeBuyerAssignable​
removePermission​
setCustomField​
setCustomType​
setName​
setPermissions​

Update actions

Add Permission

Adding a Permission to an AssociateRole generates an AssociateRolePermissionAdded Message.
permission​
Permission​

Permission to be added to the AssociateRole.

Can be AcceptMyQuotes, AcceptOthersQuotes, AddChildUnits, CreateApprovalRules, CreateMyCarts, CreateMyOrdersFromMyCarts, CreateMyOrdersFromMyQuotes, CreateMyPaymentMethods, CreateMyQuoteRequestsFromMyCarts, CreateMyShoppingLists, CreateOrdersFromOthersCarts, CreateOrdersFromOthersQuotes, CreateOthersCarts, CreateOthersPaymentMethods, CreateOthersShoppingLists, CreateQuoteRequestsFromOthersCarts, DeclineMyQuotes, DeclineOthersQuotes, DeleteMyCarts, DeleteMyPaymentMethods, DeleteMyShoppingLists, DeleteOthersCarts, DeleteOthersPaymentMethods, DeleteOthersShoppingLists, ReassignMyQuotes, ReassignOthersQuotes, RenegotiateMyQuotes, RenegotiateOthersQuotes, UpdateApprovalFlows, UpdateApprovalRules, UpdateAssociates, UpdateBusinessUnitDetails, UpdateMyCarts, UpdateMyOrders, UpdateMyPaymentMethods, UpdateMyQuoteRequests, UpdateMyShoppingLists, UpdateOthersCarts, UpdateOthersOrders, UpdateOthersPaymentMethods, UpdateOthersQuoteRequests, UpdateOthersShoppingLists, UpdateParentUnit, ViewMyCarts, ViewMyOrders, ViewMyPaymentMethods, ViewMyQuoteRequests, ViewMyQuotes, ViewMyShoppingLists, ViewOthersCarts, ViewOthersOrders, ViewOthersPaymentMethods, ViewOthersQuoteRequests, ViewOthersQuotes, or ViewOthersShoppingLists​

Permission

AcceptMyQuotes
AcceptOthersQuotes
AddChildUnits
CreateApprovalRules
CreateMyCarts
CreateMyOrdersFromMyCarts
CreateMyOrdersFromMyQuotes
CreateMyPaymentMethods
CreateMyQuoteRequestsFromMyCarts
CreateMyShoppingLists
CreateOrdersFromOthersCarts
CreateOrdersFromOthersQuotes
CreateOthersCarts
CreateOthersPaymentMethods
CreateOthersShoppingLists
CreateQuoteRequestsFromOthersCarts
DeclineMyQuotes
DeclineOthersQuotes
DeleteMyCarts
DeleteMyPaymentMethods
DeleteMyShoppingLists
DeleteOthersCarts
DeleteOthersPaymentMethods
DeleteOthersShoppingLists
ReassignMyQuotes
ReassignOthersQuotes
RenegotiateMyQuotes
RenegotiateOthersQuotes
UpdateApprovalFlows
UpdateApprovalRules
UpdateAssociates
UpdateBusinessUnitDetails
UpdateMyCarts
UpdateMyOrders
UpdateMyPaymentMethods
UpdateMyQuoteRequests
UpdateMyShoppingLists
UpdateOthersCarts
UpdateOthersOrders
UpdateOthersPaymentMethods
UpdateOthersQuoteRequests
UpdateOthersShoppingLists
UpdateParentUnit
ViewMyCarts
ViewMyOrders
ViewMyPaymentMethods
ViewMyQuoteRequests
ViewMyQuotes
ViewMyShoppingLists
ViewOthersCarts
ViewOthersOrders
ViewOthersPaymentMethods
ViewOthersQuoteRequests
ViewOthersQuotes
ViewOthersShoppingLists

Change Buyer Assignable

Changing the buyerAssignable value of an AssociateRole generates an AssociateRoleBuyerAssignableChanged Message.
buyerAssignable​
Boolean​
The new value of the buyerAssignable field of the AssociateRole.

Remove Permission

Removing a Permission from an AssociateRole generates an AssociateRolePermissionRemoved Message.
permission​
Permission​

Permission to be removed from the AssociateRole.

Can be AcceptMyQuotes, AcceptOthersQuotes, AddChildUnits, CreateApprovalRules, CreateMyCarts, CreateMyOrdersFromMyCarts, CreateMyOrdersFromMyQuotes, CreateMyPaymentMethods, CreateMyQuoteRequestsFromMyCarts, CreateMyShoppingLists, CreateOrdersFromOthersCarts, CreateOrdersFromOthersQuotes, CreateOthersCarts, CreateOthersPaymentMethods, CreateOthersShoppingLists, CreateQuoteRequestsFromOthersCarts, DeclineMyQuotes, DeclineOthersQuotes, DeleteMyCarts, DeleteMyPaymentMethods, DeleteMyShoppingLists, DeleteOthersCarts, DeleteOthersPaymentMethods, DeleteOthersShoppingLists, ReassignMyQuotes, ReassignOthersQuotes, RenegotiateMyQuotes, RenegotiateOthersQuotes, UpdateApprovalFlows, UpdateApprovalRules, UpdateAssociates, UpdateBusinessUnitDetails, UpdateMyCarts, UpdateMyOrders, UpdateMyPaymentMethods, UpdateMyQuoteRequests, UpdateMyShoppingLists, UpdateOthersCarts, UpdateOthersOrders, UpdateOthersPaymentMethods, UpdateOthersQuoteRequests, UpdateOthersShoppingLists, UpdateParentUnit, ViewMyCarts, ViewMyOrders, ViewMyPaymentMethods, ViewMyQuoteRequests, ViewMyQuotes, ViewMyShoppingLists, ViewOthersCarts, ViewOthersOrders, ViewOthersPaymentMethods, ViewOthersQuoteRequests, ViewOthersQuotes, or ViewOthersShoppingLists​

Permission

AcceptMyQuotes
AcceptOthersQuotes
AddChildUnits
CreateApprovalRules
CreateMyCarts
CreateMyOrdersFromMyCarts
CreateMyOrdersFromMyQuotes
CreateMyPaymentMethods
CreateMyQuoteRequestsFromMyCarts
CreateMyShoppingLists
CreateOrdersFromOthersCarts
CreateOrdersFromOthersQuotes
CreateOthersCarts
CreateOthersPaymentMethods
CreateOthersShoppingLists
CreateQuoteRequestsFromOthersCarts
DeclineMyQuotes
DeclineOthersQuotes
DeleteMyCarts
DeleteMyPaymentMethods
DeleteMyShoppingLists
DeleteOthersCarts
DeleteOthersPaymentMethods
DeleteOthersShoppingLists
ReassignMyQuotes
ReassignOthersQuotes
RenegotiateMyQuotes
RenegotiateOthersQuotes
UpdateApprovalFlows
UpdateApprovalRules
UpdateAssociates
UpdateBusinessUnitDetails
UpdateMyCarts
UpdateMyOrders
UpdateMyPaymentMethods
UpdateMyQuoteRequests
UpdateMyShoppingLists
UpdateOthersCarts
UpdateOthersOrders
UpdateOthersPaymentMethods
UpdateOthersQuoteRequests
UpdateOthersShoppingLists
UpdateParentUnit
ViewMyCarts
ViewMyOrders
ViewMyPaymentMethods
ViewMyQuoteRequests
ViewMyQuotes
ViewMyShoppingLists
ViewOthersCarts
ViewOthersOrders
ViewOthersPaymentMethods
ViewOthersQuoteRequests
ViewOthersQuotes
ViewOthersShoppingLists

Set Custom Field

name​
String​
Name of the Custom Field.
value​
String​
If value is absent or null, this field will be removed if it exists. Trying to remove a field that does not exist will fail with an InvalidOperationError error. If value is provided, it is set for the field defined by name.

Set Custom Type

fields​
Array of CustomFieldInput​
type​
typeKey​
String​
typeId​
String​

Set Name

Updating the name of an AssociateRole generates an AssociateRoleNameSet Message.
name​
String​
New name to set. If name is absent or null, the existing name, if any, will be removed.

Set Permissions

Updating the Permissions on an AssociateRole generates an AssociateRolePermissionsSet Message.
permissions​
Array of Permission​

Overrides the current list of Permissions for the AssociateRole.

Can be AcceptMyQuotes, AcceptOthersQuotes, AddChildUnits, CreateApprovalRules, CreateMyCarts, CreateMyOrdersFromMyCarts, CreateMyOrdersFromMyQuotes, CreateMyPaymentMethods, CreateMyQuoteRequestsFromMyCarts, CreateMyShoppingLists, CreateOrdersFromOthersCarts, CreateOrdersFromOthersQuotes, CreateOthersCarts, CreateOthersPaymentMethods, CreateOthersShoppingLists, CreateQuoteRequestsFromOthersCarts, DeclineMyQuotes, DeclineOthersQuotes, DeleteMyCarts, DeleteMyPaymentMethods, DeleteMyShoppingLists, DeleteOthersCarts, DeleteOthersPaymentMethods, DeleteOthersShoppingLists, ReassignMyQuotes, ReassignOthersQuotes, RenegotiateMyQuotes, RenegotiateOthersQuotes, UpdateApprovalFlows, UpdateApprovalRules, UpdateAssociates, UpdateBusinessUnitDetails, UpdateMyCarts, UpdateMyOrders, UpdateMyPaymentMethods, UpdateMyQuoteRequests, UpdateMyShoppingLists, UpdateOthersCarts, UpdateOthersOrders, UpdateOthersPaymentMethods, UpdateOthersQuoteRequests, UpdateOthersShoppingLists, UpdateParentUnit, ViewMyCarts, ViewMyOrders, ViewMyPaymentMethods, ViewMyQuoteRequests, ViewMyQuotes, ViewMyShoppingLists, ViewOthersCarts, ViewOthersOrders, ViewOthersPaymentMethods, ViewOthersQuoteRequests, ViewOthersQuotes, or ViewOthersShoppingLists​

Permission

AcceptMyQuotes
AcceptOthersQuotes
AddChildUnits
CreateApprovalRules
CreateMyCarts
CreateMyOrdersFromMyCarts
CreateMyOrdersFromMyQuotes
CreateMyPaymentMethods
CreateMyQuoteRequestsFromMyCarts
CreateMyShoppingLists
CreateOrdersFromOthersCarts
CreateOrdersFromOthersQuotes
CreateOthersCarts
CreateOthersPaymentMethods
CreateOthersShoppingLists
CreateQuoteRequestsFromOthersCarts
DeclineMyQuotes
DeclineOthersQuotes
DeleteMyCarts
DeleteMyPaymentMethods
DeleteMyShoppingLists
DeleteOthersCarts
DeleteOthersPaymentMethods
DeleteOthersShoppingLists
ReassignMyQuotes
ReassignOthersQuotes
RenegotiateMyQuotes
RenegotiateOthersQuotes
UpdateApprovalFlows
UpdateApprovalRules
UpdateAssociates
UpdateBusinessUnitDetails
UpdateMyCarts
UpdateMyOrders
UpdateMyPaymentMethods
UpdateMyQuoteRequests
UpdateMyShoppingLists
UpdateOthersCarts
UpdateOthersOrders
UpdateOthersPaymentMethods
UpdateOthersQuoteRequests
UpdateOthersShoppingLists
UpdateParentUnit
ViewMyCarts
ViewMyOrders
ViewMyPaymentMethods
ViewMyQuoteRequests
ViewMyQuotes
ViewMyShoppingLists
ViewOthersCarts
ViewOthersOrders
ViewOthersPaymentMethods
ViewOthersQuoteRequests
ViewOthersQuotes
ViewOthersShoppingLists