Sitecore OrderCloud Documentation

docs

Portal Login

Get a single API client.

GET

/apiclients/{apiClientID}

200

Roles

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

FullAccessApiClientAdminApiClientReader

Parameters

NameTypeDescriptionPossible Values
apiClientIDRequiredstringID of the api client.---

Response Body

PropertyTypeFormatMax LengthPossible Values
IDRead Onlystring---------

ClientSecretstring---------

AccessTokenDurationintegerint32------
Activeboolean---------

AppNamestring---------
RefreshTokenDurationintegerint32------
DefaultContextUserNamestring---------

xpobject---------
AllowAnyBuyerboolean---------

AllowAnySupplierboolean---------

AllowSellerboolean---------

IsAnonBuyerboolean---------

AssignedBuyerCountRead Onlyintegerint32------
AssignedSupplierCountRead Onlyintegerint32------
OrderCheckoutIntegrationEventIDstring---------

OrderCheckoutIntegrationEventNameRead Onlystring---------
OrderReturnIntegrationEventIDstring---------

OrderReturnIntegrationEventNameRead Onlystring---------
AddToCartIntegrationEventIDstring---------

AddToCartIntegrationEventNameRead Onlystring---------
MinimumRequiredRolesarray---------
MinimumRequiredCustomRolesarray---------
MaximumGrantedRolesarray---------
MaximumGrantedCustomRolesarray---------

Get a single API client.

GET

/apiclients/{apiClientID}

200

Roles

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

FullAccessApiClientAdminApiClientReader

Parameters

NameTypeDescriptionPossible Values
apiClientIDRequiredstringID of the api client.---

Response Body

PropertyTypeFormatMax LengthPossible Values
IDRead Onlystring---------

ClientSecretstring---------

AccessTokenDurationintegerint32------
Activeboolean---------

AppNamestring---------
RefreshTokenDurationintegerint32------
DefaultContextUserNamestring---------

xpobject---------
AllowAnyBuyerboolean---------

AllowAnySupplierboolean---------

AllowSellerboolean---------

IsAnonBuyerboolean---------

AssignedBuyerCountRead Onlyintegerint32------
AssignedSupplierCountRead Onlyintegerint32------
OrderCheckoutIntegrationEventIDstring---------

OrderCheckoutIntegrationEventNameRead Onlystring---------
OrderReturnIntegrationEventIDstring---------

OrderReturnIntegrationEventNameRead Onlystring---------
AddToCartIntegrationEventIDstring---------

AddToCartIntegrationEventNameRead Onlystring---------
MinimumRequiredRolesarray---------
MinimumRequiredCustomRolesarray---------
MaximumGrantedRolesarray---------
MaximumGrantedCustomRolesarray---------
Sitecore Logo

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

Contact Us
Privacy Policy
Sitecore