Sitecore OrderCloud Documentation

docs

Portal Login

Create or update a spec.

PUT

/specs/{specID}

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.

FullAccessProductAdmin

Parameters

NameTypeDescriptionPossible Values
specIDRequiredstringID of the spec.---

Request Body

PropertyTypeFormatMax LengthPossible Values
OwnerIDstring---------

IDstring---100 characters---
ListOrderintegerint32------
NameRequiredstring---------
DefaultValuestring---2000 characters---

Requiredboolean---------
AllowOpenTextboolean---------

DefaultOptionIDstring---------

DefinesVariantboolean---------

xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
OwnerIDstring---------

IDstring---100 characters---
ListOrderintegerint32------
Namestring---------
DefaultValuestring---2000 characters---

Requiredboolean---------
AllowOpenTextboolean---------

DefaultOptionIDstring---------

DefinesVariantboolean---------

xpobject---------
OptionCountRead Onlyintegerint32------
OptionsRead Onlyarray---------

Create or update a spec.

PUT

/specs/{specID}

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.

FullAccessProductAdmin

Parameters

NameTypeDescriptionPossible Values
specIDRequiredstringID of the spec.---

Request Body

PropertyTypeFormatMax LengthPossible Values
OwnerIDstring---------

IDstring---100 characters---
ListOrderintegerint32------
NameRequiredstring---------
DefaultValuestring---2000 characters---

Requiredboolean---------
AllowOpenTextboolean---------

DefaultOptionIDstring---------

DefinesVariantboolean---------

xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
OwnerIDstring---------

IDstring---100 characters---
ListOrderintegerint32------
Namestring---------
DefaultValuestring---2000 characters---

Requiredboolean---------
AllowOpenTextboolean---------

DefaultOptionIDstring---------

DefinesVariantboolean---------

xpobject---------
OptionCountRead Onlyintegerint32------
OptionsRead Onlyarray---------
Sitecore Logo

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

Contact Us
Privacy Policy
Sitecore