ArticleChoiceOption

An object representing an article-choice option. Every choice option belongs to an ArticleChoice.

Properties

Property Description
uid A unique identifier of the choice option.
name An object with language codes as the properties and the name of the choice option in each language as the values.
price An object with currency codes as the properties and numeric values. This is how the price should be affected if the customer selects the option when ordering an article. A value can be positive or negative and it can also be ommitted in which case selecting this option does not affect the price of the article. This is visible to administrators only. For end users, see choiceOptionPrices in Article.
weight A numeric value, positive or negative, specifying how the weight of the article is increased or decreased when the customer selects the option when ordering an article. This is visible to administrators only.

Methods

get

Fetches an article-choice-option object.

Parameters

Parameter Description
uid The unique identifier of an article-choice option.
query Which info to return. See Query language.

Example

Request:

API Console
ArticleChoiceOption.get(55071624, true)
Response
(code)
{
  "name": {
    "sv": "40,5"
  },
  "uid": 55071624,
  "weight": 0
}

getSchema

Fetches the JSON Schema which can be used for client-side validation.

Parameters

The unique identifier of an article-choice option or null for a new article-choice option.