Availabilities
Display the item and line item’s availability. The availability identifies the item’s purchasability. For example, in Elastic Path 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
- Start with line-item
GET
the link with rel: availability- Render the response
Response Fields
Type: availabilities.availability
Name | Description | Type |
---|---|---|
state | The state of availability for an item or line item. In Elastic Path Commerce Engine, the states are: AVAILABLE , NOT_AVAILABLE , AVAILABLE_FOR_BACK_ORDER , AVAILABLE_FOR_PRE_ORDER | string |
release-date | Optional property. This is the date the item becomes available for purchase. In Elastic Path Commerce Engine, release-date is only visible when the item is available for pre-order. | object |
value | The millisecond value of the date in Epoch time. | long |
display-value | The 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
- Start with item
GET
the link with rel: availability- Render the response
Response Fields
Type: availabilities.availability
Name | Description | Type |
---|---|---|
state | The state of availability for an item or line item. In Elastic Path Commerce Engine, the states are: AVAILABLE , NOT_AVAILABLE , AVAILABLE_FOR_BACK_ORDER , AVAILABLE_FOR_PRE_ORDER | string |
release-date | Optional property. This is the date the item becomes available for purchase. In Elastic Path Commerce Engine, release-date is only visible when the item is available for pre-order. | object |
value | The millisecond value of the date in Epoch time. | long |
display-value | The formatted date value to display on the client application. | string |