Lectronz API Reference, Version 1

Product Option Choices

JSON product option choice representation

The product option choice object represents a single choice for a product option. If the product option choice has a stock limit, the stock_available property will be present. Setting the stock_available property to null indicates that the product option choice has unlimited stock.

This object has the following properties:

idinteger

Unique identifier for this choice.

namestring

Name of this choice.

pricenumber

Price added or subtracted to the product price when this choice is selected.

stock_availablenumber, optional

Optional. Stock available for this choice.

skustring, optional

Optional unique identifier used by the seller to track inventory. Only provided if present.

weightnumber

Weight added by this choice.

display_ordernumber, optional

Ranking order of the choice as presented to the customer (lower goes first).

Get a product option choice.

Get details of a product option choice. See the choices property of the product object for the identifiers of the product option choices.

Request

GET/api/v1/product_option_choices/{id}

Response body (object)

JSON product option choice representation

details
idinteger

Unique identifier for this choice.

namestring

Name of this choice.

pricenumber

Price added or subtracted to the product price when this choice is selected.

stock_availablenumber, optional

Optional. Stock available for this choice.

skustring, optional

Optional unique identifier used by the seller to track inventory. Only provided if present.

weightnumber

Weight added by this choice.

display_ordernumber, optional

Ranking order of the choice as presented to the customer (lower goes first).

Update a product option choice.

Update the stock available for a product option choice. This API call is currently limited to updating the value of the stock_available property of a product option choice.

Request

PATCH/api/v1/product_option_choices/{id}

Request body (object)

Request Body

details
stock_availablenumber

Number of units of the product option choice available for sale. Set it to null to indicate that the product option choice has unlimited stock.

Response body (object)

JSON product option choice representation

details
idinteger

Unique identifier for this choice.

namestring

Name of this choice.

pricenumber

Price added or subtracted to the product price when this choice is selected.

stock_availablenumber, optional

Optional. Stock available for this choice.

skustring, optional

Optional unique identifier used by the seller to track inventory. Only provided if present.

weightnumber

Weight added by this choice.

display_ordernumber, optional

Ranking order of the choice as presented to the customer (lower goes first).