Sitecore OrderCloud Documentation

docs

Portal Login

Update an API client.

PUT

/apiclients/{apiClientID}

200

Description

If an object with the same ID already exists, it will be overwritten.

Roles

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

FullAccessApiClientAdmin

Parameters

NameTypeDescriptionPossible Values
apiClientIDRequiredstringID of the api client.---

Request Body

PropertyTypeFormatMax LengthPossible Values
ClientSecretstring---------

AccessTokenDurationRequiredintegerint32------
Activeboolean---------

AppNameRequiredstring---------
RefreshTokenDurationintegerint32------
DefaultContextUserNamestring---------

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

AllowAnySupplierboolean---------

AllowSellerboolean---------

IsAnonBuyerboolean---------

OrderCheckoutIntegrationEventIDstring---------

OrderReturnIntegrationEventIDstring---------

AddToCartIntegrationEventIDstring---------

MinimumRequiredRolesarray---------
MinimumRequiredCustomRolesarray---------
MaximumGrantedRolesarray---------
MaximumGrantedCustomRolesarray---------

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---------

Update an API client.

PUT

/apiclients/{apiClientID}

200

Description

If an object with the same ID already exists, it will be overwritten.

Roles

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

FullAccessApiClientAdmin

Parameters

NameTypeDescriptionPossible Values
apiClientIDRequiredstringID of the api client.---

Request Body

PropertyTypeFormatMax LengthPossible Values
ClientSecretstring---------

AccessTokenDurationRequiredintegerint32------
Activeboolean---------

AppNameRequiredstring---------
RefreshTokenDurationintegerint32------
DefaultContextUserNamestring---------

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

AllowAnySupplierboolean---------

AllowSellerboolean---------

IsAnonBuyerboolean---------

OrderCheckoutIntegrationEventIDstring---------

OrderReturnIntegrationEventIDstring---------

AddToCartIntegrationEventIDstring---------

MinimumRequiredRolesarray---------
MinimumRequiredCustomRolesarray---------
MaximumGrantedRolesarray---------
MaximumGrantedCustomRolesarray---------

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