Fields when send to the api inside a request.
| Field | Type | Description |
|---|---|---|
| amount | Int | An integer value |
| persons | Int | An integer value |
| gram | Int | An integer value |
| comment | String | A String value |
| product_id | Int | An integer value |
| product_price_id | Int? | Nullable. An integer value |
| shop_id | Int | An integer value |
| options | [CartItemOption] | Array of CartItemOption |
Fields when returned by the api in a response.
| Field | Type | Description |
|---|---|---|
| amount | Int | An integer value |
| persons | Int | An integer value |
| gram | Int | An integer value |
| comment | String | A String value |
| product | Product.simple | |
| product_price | ProductPrice.simple? | Nullable. |
| calculated_prices | CartItemPrices | |
| discount_prices | CartItemPrices? | Nullable. |
| amount_free | Int | Amount you receive for free on top of the chosen amount. If the price type of the product is in gram or persons, this amount is also in gram or persons. |
| shop | Shop.simple | |
| options | [CartItemOption] | Array of CartItemOption |
When used inside a request.
{
"amount": 15,
"persons": 12,
"gram": 17,
"comment": "...",
"product_id": 10,
"product_price_id": 19,
"shop_id": 15,
"options": [
{
"option_id": 14,
"upload_id": 16,
"amount": 10
},
{
"option_id": 11,
"upload_id": 18,
"amount": 19
},
{
"option_id": 16,
"upload_id": 18,
"amount": 11
}
]
}When returned in a response.
{
"amount": 11,
"persons": 13,
"gram": 11,
"comment": "...",
"product": {
"id": 11,
"name": "...",
"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
}
],
"file_id": 13,
"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
}
],
"file_id": 14,
"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
}
],
"file_id": 14,
"white_background": true
}
],
"price_type": "PER_UNIT",
"target_price": false,
"price": {
"value": 10,
"currency": "EUR"
},
"only_order_in_store": true,
"category": {
"id": 12,
"name": "..."
},
"origin": "...",
"ingredients": "..."
},
"product_price": {
"id": 17,
"name": "...",
"price": {
"value": 14,
"currency": "EUR"
}
},
"calculated_prices": {
"unit_price": {
"value": 13,
"currency": "EUR"
},
"price": {
"value": 12,
"currency": "EUR"
}
},
"discount_prices": {
"unit_price": {
"value": 16,
"currency": "EUR"
},
"price": {
"value": 16,
"currency": "EUR"
}
},
"amount_free": 10,
"shop": {
"id": 19,
"name": "Reggie Pfannerstill",
"address": {
"street": "Sint-Denijslaan",
"nr": "96",
"zipcode": "9000",
"city": "Gent",
"country": "BE",
"position": {
"latitude": 1.54361,
"longitude": 0.45645
}
},
"allow_comments": false,
"url": "...",
"allow_order_comments": false,
"allow_product_comments": false,
"allow_order_messages": true,
"global_discount_percentage": 15,
"allow_orders": false,
"currency": "EUR"
},
"options": [
{
"option": {
"id": 14,
"name": "...",
"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
}
],
"file_id": 13,
"white_background": true
},
"require_image": true,
"code": "...",
"price_calculation": "PER_PIECE",
"optionset": {
"id": 13,
"name": "...",
"code": "...",
"multiple_choice": false,
"choose_amount": true,
"min_different_options": 14,
"max_different_options": 17,
"min_amount_options": 11,
"max_amount_options": 14
}
},
"upload": {
"id": 19,
"url": "https://example.com"
},
"amount": 16
},
{
"option": {
"id": 14,
"name": "...",
"price_change": {
"value": 11,
"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
}
],
"file_id": 18,
"white_background": false
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE",
"optionset": {
"id": 11,
"name": "...",
"code": "...",
"multiple_choice": false,
"choose_amount": true,
"min_different_options": 15,
"max_different_options": 10,
"min_amount_options": 12,
"max_amount_options": 14
}
},
"upload": {
"id": 10,
"url": "https://example.com"
},
"amount": 17
},
{
"option": {
"id": 19,
"name": "...",
"price_change": {
"value": 16,
"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
}
],
"file_id": 10,
"white_background": true
},
"require_image": false,
"code": "...",
"price_calculation": "PER_PIECE",
"optionset": {
"id": 11,
"name": "...",
"code": "...",
"multiple_choice": false,
"choose_amount": false,
"min_different_options": 13,
"max_different_options": 18,
"min_amount_options": 11,
"max_amount_options": 19
}
},
"upload": {
"id": 17,
"url": "https://example.com"
},
"amount": 15
}
]
}