Itemdefinitions

An item definition describes the item. The item’s name, media assets (pictures of the item), options, components, from price, and details describing the item’s characteristics are all part of the item definitions. Not every item definition contains assets, options, components, etc. What is available on the item definition depends on the item and how your storefront has implemented Cortex API. Some resources may be customized for your implementation, so more, or even less details may exist.

Read Item Definition

Read the item definition from the item.

Workflow

1. Start with item
2. GET the link with rel: definition
3. Render the response

Response Fields

Type: itemdefinitions.item-definition

Name	Description	Type
display-name	The localized name of the item definition, intended for display in the client application.	string
details	The details of the item definition.	array
display-name	The formatted string to display on the client.	string
name	The name used by the Cortex system.	string
display-value	The formatted string to display on the client.	string
value	The raw value.	any

Read Item Definition Option

Read the item definition option from the list of available options.

Workflow

1. Start with item-definition
2. GET the link with rel: options
3. GET the link with rel: element
4. Render the response

Response Fields

Type: itemdefinitions.item-definition-option

Name	Description	Type
display-name	The localized name of the item definition option, intended for display in the client application.	string
name	The name of the item definition option.	string

Read Item Definition Option Value

Read the item definition option value.

Workflow

1. Start with item-definition-option
2. GET the link with rel: value
3. Render the response

Response Fields

Type: itemdefinitions.item-definition-option-value

Name	Description	Type
display-name	The localized name of the item definition option value, intended for display in the client application.	string
name	The name of the item definition option value.	string

Read Item Definition Component

Read the item definition component from the list of available components.

Workflow

1. Start with item-definition
2. GET the link with rel: components
3. GET the link with rel: element
4. Render the response

Response Fields

Type: itemdefinitions.item-definition-component

Name	Description	Type
display-name	The localized name of the item definition component, intended for display in the client application.	string
details	The details of the item definition component.	array
display-name	The formatted string to display on the client.	string
name	The name used by the Cortex system.	string
display-value	The formatted string to display on the client.	string
value	The raw value.	any
quantity	The quantity of components.	integer

Read Nested Item Definition Components

Read an single nested item definition component.

Workflow

1. Start with item-definition-component
2. GET the link with rel: components
3. GET the link with rel: element
4. Render the response

Response Fields

Type: itemdefinitions.item-definition-component

Name	Description	Type
display-name	The localized name of the item definition component, intended for display in the client application.	string
details	The details of the item definition component.	array
display-name	The formatted string to display on the client.	string
name	The name used by the Cortex system.	string
display-value	The formatted string to display on the client.	string
value	The raw value.	any
quantity	The quantity of components.	integer

Read Item Definition Component To Standalone Item

Read the component’s stand alone item. Some components can be purchased separately.

Workflow

1. Start with item-definition-component
2. GET the link with rel: standaloneitem
3. Render the response