Display settings on store items
What's new
Store items take a new optional, nullable display_settings object that controls how the item's
card is laid out in the store. For now it holds one field, placement, which sets where the card
sits in the store grid:
inline: in the flow of the category at its position. An offer card is as wide as a featured cardfull_width: across the whole row of the grid, or the whole slider
Impact
You can make a single store item span the full row of the grid or slider through the API, without changing the layout of the rest of the store.
Changes
| Resource | Change |
|---|---|
| create_store_item | Added optional display_settings to the request and response |
| batch_create_store_item | Added optional display_settings to the request |
| bulk_update_store_items | Added optional display_settings to the request and response |
| update_store_item | Added optional display_settings to the request and response |
| get_store_items | Added display_settings to the response |
| get_all_store_items | Added display_settings to the response |
| Components | Added the StoreItemDisplaySettings and StoreCardPlacement schemas |
Upgrade
- No action is required. The field is optional and can be left out.
- If you store or compare store items on your side, expect
display_settingsin responses from now on.
Need help?
Contact our integration team at [email protected]