Prices
Prices describe the amount of money required to purchase an item or items. The prices resource links prices to: items, cart line items and item definitions
Read Item Price
Read the unit price of an item. Each price is for one unit (quantity = 1).
Workflow
- Start with item
GETthe link with rel: price- Render the response
Response Fields
Type: prices.item-price
| Name | Description | Type |
|---|---|---|
list-price | The unit price of an item before catalog discounts are applied. | array |
currency | The price currency. | string |
amount | The decimal value of the price. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
purchase-price | The unit price of an item after catalog discounts are applied. | array |
currency | The price currency. | string |
amount | The decimal value of the price. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
Read Item Agreement Price
Read the up-front and recurring prices of an item. Each price is for one unit (quantity = 1).
Workflow
- Start with item
GETthe link with rel: agreementsGETthe link with rel: elementGETthe link with rel: price- Render the response
Response Fields
Type: prices.item-agreement-price"
| Name | Description | Type |
|---|---|---|
list-price | The unit price of an item before catalog discounts are applied. | array |
currency | The price currency. | string |
amount | The decimal value of the price. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
purchase-price | The unit price of an item after catalog discounts are applied. | array |
currency | The price currency. | string |
amount | The decimal value of the price. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
recurring-list-prices | The recurring prices for an item before catalog discounts are applied. | array |
billing-interval | An object containing billing interval details for this recurring list price. | object |
amount | The length of the billing interval, in units. | integer |
unit | The unit of measure for the billing interval. | string |
currency | The price currency. | string |
prices | The prices for this billing interval. There can be multiple because the price might change over time. | array |
amount | The decimal value of the price. | decimal |
display | Formatted currency string that can be displayed on the client application. | string |
estimated-price | Indicates if the price is an estimate that could change after purchase. | boolean |
rollover | Indicates if this price represents what the shopper might pay after the end of the agreement term. | boolean |
start | The first billing interval that this price applies to. | integer |
end | The last billing interval that this price applies to. | integer |
Read Cart Line Item Price
Read the unit price of a cart line item. The unit price of a cart line item is the price for one unit when a given quantity is purchased (the line item quantity).
Workflow
- Start with line-item
GETthe link with rel: price- Render the response
Response Fields
Type: prices.cart-line-item-price
| Name | Description | Type |
|---|---|---|
list-price | The unit price of an item in the shopper’s cart before shopping cart discounts are applied. | 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 | The unit price of an item in the shopper’s cart after shopping cart discounts are applied. This represents the price the shopper will actually pay for each unit. If no discounts have been applied, the list and purchase price will be the same. | 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 Lowest Price Of Item Options
Read the price of the item option with the lowest price. This link will only appear if the item has options.
Workflow
- Start with item-definition
GETthe link with rel: fromprice- Render the response
Response Fields
Type: prices.price-range
| Name | Description | Type |
|---|---|---|
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 Shipment Line Item Price
Retrieves the price of a shipment line item.
Workflow
- Start with shipment-line-item
GETthe link with rel: price- Render the response
Response Fields
Type: prices.shipment-line-item-price
| Name | Description | Type |
|---|---|---|
list-price | The price of a shipment line item before discounts are applied. | 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 | The price of a shipment line item after discounts are applied. If no discounts have been applied, the list and purchase price will be the same. | 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 |