CartItemSuggestionGroup

Groups CartItemSuggestions with a title

Field Type Description
name String Name of the group
suggestions [CartItemSuggestion] Array of CartItemSuggestion

Examples

Request

When used inside a request.

Example 1

{
    "name": "string",
    "suggestions": [
        {
            "name": "string",
            "description": "string",
            "image": {
                "resolutions": [
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    }
                ],
                "white_background": true
            },
            "price_change": {
                "value": 12,
                "currency": "EUR"
            },
            "price_change_without_discount": {
                "value": 12,
                "currency": "EUR"
            },
            "item": {
                "amount": 12,
                "persons": 12,
                "gram": 12,
                "comment": "string",
                "product_id": 12,
                "product_price_id": 12,
                "shop_id": 12,
                "options": [
                    {
                        "option_id": 12,
                        "upload_id": 12
                    },
                    {
                        "option_id": 12,
                        "upload_id": 12
                    },
                    {
                        "option_id": 12,
                        "upload_id": 12
                    }
                ]
            }
        },
        {
            "name": "string",
            "description": "string",
            "image": {
                "resolutions": [
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    }
                ],
                "white_background": true
            },
            "price_change": {
                "value": 12,
                "currency": "EUR"
            },
            "price_change_without_discount": {
                "value": 12,
                "currency": "EUR"
            },
            "item": {
                "amount": 12,
                "persons": 12,
                "gram": 12,
                "comment": "string",
                "product_id": 12,
                "product_price_id": 12,
                "shop_id": 12,
                "options": [
                    {
                        "option_id": 12,
                        "upload_id": 12
                    },
                    {
                        "option_id": 12,
                        "upload_id": 12
                    },
                    {
                        "option_id": 12,
                        "upload_id": 12
                    }
                ]
            }
        },
        {
            "name": "string",
            "description": "string",
            "image": {
                "resolutions": [
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    }
                ],
                "white_background": true
            },
            "price_change": {
                "value": 12,
                "currency": "EUR"
            },
            "price_change_without_discount": {
                "value": 12,
                "currency": "EUR"
            },
            "item": {
                "amount": 12,
                "persons": 12,
                "gram": 12,
                "comment": "string",
                "product_id": 12,
                "product_price_id": 12,
                "shop_id": 12,
                "options": [
                    {
                        "option_id": 12,
                        "upload_id": 12
                    },
                    {
                        "option_id": 12,
                        "upload_id": 12
                    },
                    {
                        "option_id": 12,
                        "upload_id": 12
                    }
                ]
            }
        }
    ]
}

Response

When returned in a response.

Example 1

{
    "name": "string",
    "suggestions": [
        {
            "name": "string",
            "description": "string",
            "image": {
                "resolutions": [
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    }
                ],
                "white_background": true
            },
            "price_change": {
                "value": 12,
                "currency": "EUR"
            },
            "price_change_without_discount": {
                "value": 12,
                "currency": "EUR"
            },
            "item": {
                "amount": 12,
                "persons": 12,
                "gram": 12,
                "comment": "string",
                "product": {
                    "id": 12,
                    "name": "string",
                    "images": [
                        {
                            "resolutions": [
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                }
                            ],
                            "white_background": true
                        },
                        {
                            "resolutions": [
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                }
                            ],
                            "white_background": true
                        },
                        {
                            "resolutions": [
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                }
                            ],
                            "white_background": true
                        }
                    ],
                    "price_type": "PER_UNIT",
                    "target_price": true,
                    "price": {
                        "value": 12,
                        "currency": "EUR"
                    }
                },
                "product_price": {
                    "id": 12,
                    "name": "string",
                    "price": {
                        "value": 12,
                        "currency": "EUR"
                    }
                },
                "calculated_prices": {
                    "unit_price": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "price": {
                        "value": 12,
                        "currency": "EUR"
                    }
                },
                "discount_prices": {
                    "unit_price": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "price": {
                        "value": 12,
                        "currency": "EUR"
                    }
                },
                "amount_free": 12,
                "shop": {
                    "id": 229,
                    "name": "The Grateful Bread",
                    "address": {
                        "street": "Van Dammering",
                        "nr": "64",
                        "zipcode": "5070",
                        "city": "Saint-Ghislain",
                        "country": "BE",
                        "position": {
                            "latitude": 51.260197,
                            "longitude": 4.402771
                        }
                    },
                    "allow_comments": true,
                    "currency": "EUR"
                },
                "options": [
                    {
                        "option": {
                            "id": 12,
                            "name": "string",
                            "price_change": {
                                "value": 12,
                                "currency": "EUR"
                            },
                            "image": {
                                "resolutions": [
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    }
                                ],
                                "white_background": true
                            },
                            "require_image": true,
                            "code": "string",
                            "optionset": {
                                "id": 12,
                                "name": "string",
                                "code": "string"
                            }
                        },
                        "upload": {
                            "id": 12,
                            "url": "https://example.com"
                        }
                    },
                    {
                        "option": {
                            "id": 12,
                            "name": "string",
                            "price_change": {
                                "value": 12,
                                "currency": "EUR"
                            },
                            "image": {
                                "resolutions": [
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    }
                                ],
                                "white_background": true
                            },
                            "require_image": true,
                            "code": "string",
                            "optionset": {
                                "id": 12,
                                "name": "string",
                                "code": "string"
                            }
                        },
                        "upload": {
                            "id": 12,
                            "url": "https://example.com"
                        }
                    },
                    {
                        "option": {
                            "id": 12,
                            "name": "string",
                            "price_change": {
                                "value": 12,
                                "currency": "EUR"
                            },
                            "image": {
                                "resolutions": [
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    }
                                ],
                                "white_background": true
                            },
                            "require_image": true,
                            "code": "string",
                            "optionset": {
                                "id": 12,
                                "name": "string",
                                "code": "string"
                            }
                        },
                        "upload": {
                            "id": 12,
                            "url": "https://example.com"
                        }
                    }
                ]
            }
        },
        {
            "name": "string",
            "description": "string",
            "image": {
                "resolutions": [
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    }
                ],
                "white_background": true
            },
            "price_change": {
                "value": 12,
                "currency": "EUR"
            },
            "price_change_without_discount": {
                "value": 12,
                "currency": "EUR"
            },
            "item": {
                "amount": 12,
                "persons": 12,
                "gram": 12,
                "comment": "string",
                "product": {
                    "id": 12,
                    "name": "string",
                    "images": [
                        {
                            "resolutions": [
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                }
                            ],
                            "white_background": true
                        },
                        {
                            "resolutions": [
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                }
                            ],
                            "white_background": true
                        },
                        {
                            "resolutions": [
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                }
                            ],
                            "white_background": true
                        }
                    ],
                    "price_type": "PER_UNIT",
                    "target_price": true,
                    "price": {
                        "value": 12,
                        "currency": "EUR"
                    }
                },
                "product_price": {
                    "id": 12,
                    "name": "string",
                    "price": {
                        "value": 12,
                        "currency": "EUR"
                    }
                },
                "calculated_prices": {
                    "unit_price": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "price": {
                        "value": 12,
                        "currency": "EUR"
                    }
                },
                "discount_prices": {
                    "unit_price": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "price": {
                        "value": 12,
                        "currency": "EUR"
                    }
                },
                "amount_free": 12,
                "shop": {
                    "id": 229,
                    "name": "The Grateful Bread",
                    "address": {
                        "street": "Van Dammering",
                        "nr": "64",
                        "zipcode": "5070",
                        "city": "Saint-Ghislain",
                        "country": "BE",
                        "position": {
                            "latitude": 51.260197,
                            "longitude": 4.402771
                        }
                    },
                    "allow_comments": true,
                    "currency": "EUR"
                },
                "options": [
                    {
                        "option": {
                            "id": 12,
                            "name": "string",
                            "price_change": {
                                "value": 12,
                                "currency": "EUR"
                            },
                            "image": {
                                "resolutions": [
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    }
                                ],
                                "white_background": true
                            },
                            "require_image": true,
                            "code": "string",
                            "optionset": {
                                "id": 12,
                                "name": "string",
                                "code": "string"
                            }
                        },
                        "upload": {
                            "id": 12,
                            "url": "https://example.com"
                        }
                    },
                    {
                        "option": {
                            "id": 12,
                            "name": "string",
                            "price_change": {
                                "value": 12,
                                "currency": "EUR"
                            },
                            "image": {
                                "resolutions": [
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    }
                                ],
                                "white_background": true
                            },
                            "require_image": true,
                            "code": "string",
                            "optionset": {
                                "id": 12,
                                "name": "string",
                                "code": "string"
                            }
                        },
                        "upload": {
                            "id": 12,
                            "url": "https://example.com"
                        }
                    },
                    {
                        "option": {
                            "id": 12,
                            "name": "string",
                            "price_change": {
                                "value": 12,
                                "currency": "EUR"
                            },
                            "image": {
                                "resolutions": [
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    }
                                ],
                                "white_background": true
                            },
                            "require_image": true,
                            "code": "string",
                            "optionset": {
                                "id": 12,
                                "name": "string",
                                "code": "string"
                            }
                        },
                        "upload": {
                            "id": 12,
                            "url": "https://example.com"
                        }
                    }
                ]
            }
        },
        {
            "name": "string",
            "description": "string",
            "image": {
                "resolutions": [
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    },
                    {
                        "src": "https://example.com",
                        "width": 600,
                        "height": 350
                    }
                ],
                "white_background": true
            },
            "price_change": {
                "value": 12,
                "currency": "EUR"
            },
            "price_change_without_discount": {
                "value": 12,
                "currency": "EUR"
            },
            "item": {
                "amount": 12,
                "persons": 12,
                "gram": 12,
                "comment": "string",
                "product": {
                    "id": 12,
                    "name": "string",
                    "images": [
                        {
                            "resolutions": [
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                }
                            ],
                            "white_background": true
                        },
                        {
                            "resolutions": [
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                }
                            ],
                            "white_background": true
                        },
                        {
                            "resolutions": [
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                },
                                {
                                    "src": "https://example.com",
                                    "width": 600,
                                    "height": 350
                                }
                            ],
                            "white_background": true
                        }
                    ],
                    "price_type": "PER_UNIT",
                    "target_price": true,
                    "price": {
                        "value": 12,
                        "currency": "EUR"
                    }
                },
                "product_price": {
                    "id": 12,
                    "name": "string",
                    "price": {
                        "value": 12,
                        "currency": "EUR"
                    }
                },
                "calculated_prices": {
                    "unit_price": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "price": {
                        "value": 12,
                        "currency": "EUR"
                    }
                },
                "discount_prices": {
                    "unit_price": {
                        "value": 12,
                        "currency": "EUR"
                    },
                    "price": {
                        "value": 12,
                        "currency": "EUR"
                    }
                },
                "amount_free": 12,
                "shop": {
                    "id": 229,
                    "name": "The Grateful Bread",
                    "address": {
                        "street": "Van Dammering",
                        "nr": "64",
                        "zipcode": "5070",
                        "city": "Saint-Ghislain",
                        "country": "BE",
                        "position": {
                            "latitude": 51.260197,
                            "longitude": 4.402771
                        }
                    },
                    "allow_comments": true,
                    "currency": "EUR"
                },
                "options": [
                    {
                        "option": {
                            "id": 12,
                            "name": "string",
                            "price_change": {
                                "value": 12,
                                "currency": "EUR"
                            },
                            "image": {
                                "resolutions": [
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    }
                                ],
                                "white_background": true
                            },
                            "require_image": true,
                            "code": "string",
                            "optionset": {
                                "id": 12,
                                "name": "string",
                                "code": "string"
                            }
                        },
                        "upload": {
                            "id": 12,
                            "url": "https://example.com"
                        }
                    },
                    {
                        "option": {
                            "id": 12,
                            "name": "string",
                            "price_change": {
                                "value": 12,
                                "currency": "EUR"
                            },
                            "image": {
                                "resolutions": [
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    }
                                ],
                                "white_background": true
                            },
                            "require_image": true,
                            "code": "string",
                            "optionset": {
                                "id": 12,
                                "name": "string",
                                "code": "string"
                            }
                        },
                        "upload": {
                            "id": 12,
                            "url": "https://example.com"
                        }
                    },
                    {
                        "option": {
                            "id": 12,
                            "name": "string",
                            "price_change": {
                                "value": 12,
                                "currency": "EUR"
                            },
                            "image": {
                                "resolutions": [
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    },
                                    {
                                        "src": "https://example.com",
                                        "width": 600,
                                        "height": 350
                                    }
                                ],
                                "white_background": true
                            },
                            "require_image": true,
                            "code": "string",
                            "optionset": {
                                "id": 12,
                                "name": "string",
                                "code": "string"
                            }
                        },
                        "upload": {
                            "id": 12,
                            "url": "https://example.com"
                        }
                    }
                ]
            }
        }
    ]
}
1.5.0 stable