Skip to main content
Version: 8.7.x

Availabilities

Display the item and line item’s availability. The availability identifies the item’s purchasability. For example, in Self-Managed Commerce Engine the following states are available:

  • ALWAYS
  • NOT_AVAILABLE
  • AVAILABLE_FOR_BACK_ORDER
  • AVAILABLE_FOR_PRE_ORDER

Read Cart Line Item Availability​

Read a line item’s availability. The availability rule identifies the purchasable state of the item(s) in the line item.

Workflow​

  1. Start with line-item
  2. GET the link with rel: availability
  3. Render the response

Response Fields​

Type: availabilities.availability​

NameDescriptionType
stateThe state of availability for an item or line item. In Self-Managed Commerce Engine, the states are: AVAILABLE, NOT_AVAILABLE, AVAILABLE_FOR_BACK_ORDER, AVAILABLE_FOR_PRE_ORDERstring
release-dateOptional property. This is the date the item becomes available for purchase. In Self-Managed Commerce Engine, release-date is only visible when the item is available for pre-order.object
  valueThe millisecond value of the date in Epoch time.long
  display-valueThe formatted date value to display on the client application.string

Read Item Availability​

Read an item’s availability. The availability rule identifies the item’s purchasability.

Workflow​

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

Response Fields​

Type: availabilities.availability​

NameDescriptionType
stateThe state of availability for an item or line item. In Self-Managed Commerce Engine, the states are: AVAILABLE, NOT_AVAILABLE, AVAILABLE_FOR_BACK_ORDER, AVAILABLE_FOR_PRE_ORDERstring
release-dateOptional property. This is the date the item becomes available for purchase. In Self-Managed Commerce Engine, release-date is only visible when the item is available for pre-order.object
  valueThe millisecond value of the date in Epoch time.long
  display-valueThe formatted date value to display on the client application.string