Sitecore API catalog/OrderCloud/
/
Retrieve a spec

Retrieve a spec

Request

Only available to Buyer Users.

Security
OAuth2(Required scopes: FullAccessOrderContributorShopper)
Path
productIDstringrequired

ID of the product.

specIDstringrequired

ID of the spec.

Query
catalogIDstring

ID of the catalog.

curl -i -X GET \
  'https://api.ordercloud.io/v1/me/products/{productID}/specs/{specID}?catalogID=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Only available to Buyer Users.

Bodyapplication/json
OwnerIDstring

ID of the organization that owns the spec. Only the marketplace owner can override the OwnerID on create.

Example:""
IDstring, <= 100 characters
Example:""
ListOrderinteger, (int32)
Example:1
Namestring
Example:""
DefaultValuestring, <= 2000 characters

If no value is passed in the line item spec, this value will be used.

Example:""
Requiredboolean
Example:false
AllowOpenTextboolean

For spec options that are not pre-defined, such as FirstName for a business card.

Example:false
DefaultOptionIDstring

This property can only be written to after both the spec and options have been created. If no Spec.OptionID is passed in the line item spec, this option will be used.

Example:""
DefinesVariantboolean

If true, each unique combinations of this spec's options should map to a unique product variant.

Example:false
xpobject
Example:
{}
OptionCountinteger, (int32)read-only
Example:0
OptionsArray of objects(SpecOption)read-only
Example:
[
  {
    "ID": "",
    "Value": "",
    "ListOrder": 1,
    "IsOpenText": false,
    "PriceMarkupType": "NoMarkup",
    "PriceMarkup": 0,
    "xp": {}
  }
]
Response
{
  "OwnerID": "",
  "ID": "",
  "ListOrder": 1,
  "Name": "",
  "DefaultValue": "",
  "Required": false,
  "AllowOpenText": false,
  "DefaultOptionID": "",
  "DefinesVariant": false,
  "xp": {},
  "OptionCount": 0,
  "Options": [
    { … }
  ]
}