Sitecore OrderCloud Documentation

docs

Portal login

Specs

Specs are used to capture user input when adding a Product to an Order. At its simplest, a spec is a name/value pair. A spec value may have a price markup or markdown associated with it. In more advanced scenarios, specs can drive the product SKU. For example, a product may be available in 3 colors and 3 sizes and therefore have a total of 9 SKUs. **The OrderCloud platform will choose the correct SKU based on the user-selected color and size specs**.

Specs.List

Get a list of specs.

get

v1/specs

Specs.Create

Create a new spec.

post

v1/specs

Specs.ListProductAssignments

Get a list of spec product assignments.

get

v1/specs/productassignments

Specs.SaveProductAssignment

Create or update a spec product assignment.

post

v1/specs/productassignments

Specs.Get

Get a single spec.

get

v1/specs/{specID}

Specs.Save

Create or update a spec.

put

v1/specs/{specID}

Specs.Delete

Delete a spec.

delete

v1/specs/{specID}

Specs.Patch

Partially update a spec.

patch

v1/specs/{specID}

Specs.ListOptions

Get a list of spec options.

get

v1/specs/{specID}/options

Specs.CreateOption

Create a new spec option.

post

v1/specs/{specID}/options

Specs.GetOption

Get a single spec option.

get

v1/specs/{specID}/options/{optionID}

Specs.SaveOption

Create or update a spec option.

put

v1/specs/{specID}/options/{optionID}

Specs.DeleteOption

Delete a spec option.

delete

v1/specs/{specID}/options/{optionID}

Specs.PatchOption

Partially update a spec option.

patch

v1/specs/{specID}/options/{optionID}

Specs.DeleteProductAssignment

Delete a spec product assignment.

delete

v1/specs/{specID}/productassignments/{productID}

Sitecore Logo

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

Contact Us
Privacy Policy
Sitecore