Offers
Offer is any tangible or non-tangible collection of items for sale in a store. An offer represents a product or product bundle and is a collection of items. The offer resource returns all associated items, offer codes, availabilities, price ranges, and lists of constituents in the offer.
Read Offer Availability
Retrieve the availability status of the offer.
Workflow
- Start with offer
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 Offer Definition
Provide the offer attributes.
Workflow
- Start with offer
GET
the link with rel: definition- Render the response
Response Fields
Type: offerdefinitions.offer-definition
Name | Description | Type |
---|---|---|
display-name | The localized name of the offer, intended for display in the client application. | string |
details | The product attributes of the offer. | 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 Offer Code
Retrieve the unique code associated with the offer.
Workflow
- Start with offer
GET
the link with rel: code- Render the response
Response Fields
Type: elasticpath.offers.code
Name | Description | Type |
---|---|---|
code | The offer code. | string |
Read Offer Items
Retrieve all items in an offer.
Workflow
- Start with offer
GET
the link with rel: items- Render the response
Read Offer Price Range
Retrieve the list price range and the purchase price range defined for the offer.
Workflow
- Start with offer
GET
the link with rel: pricerange- Render the response
Response Fields
Type: elasticpath.prices.offer-price-range
Name | Description | Type |
---|---|---|
list-price-range | The range of unit prices for the offer before applying discounts. | object |
from-price | The starting or the minimum price. | array |
currency | The currency the cost is in. | string |
amount | The decimal value of the cost. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
to-price | The maximum price. | array |
currency | The currency the cost is in. | string |
amount | The decimal value of the cost. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
purchase-price-range | The range of sale prices for the offer. | object |
from-price | The starting or the minimum price. | array |
currency | The currency the cost is in. | string |
amount | The decimal value of the cost. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
to-price | The maximum price. | array |
currency | The currency the cost is in. | string |
amount | The decimal value of the cost. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
Read Offer Components
Retrieve all constituents in the offer if the offer is a bundle.
Workflow
- Start with offer
GET
the link with rel: components- Render the response
Lookup Offer By Code
Look up an offer by product code.
Workflow
- Start with lookups
GET
the link with rel: offerlookupform- Fill out the form
POST
the form using the link with rel: offerlookupaction
Lookup Batch Offers
Look up a batch of offers with a list of codes.
Workflow
- Start with lookups
GET
the link with rel: batchofferslookupform- Fill out the form
POST
the form using the link with rel: batchofferslookupaction