CartItem.cart

Request

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
option_ids [Int] Array of Int
uploads [CartUploadWithOptionSet] Optional. Array of CartUploadWithOptionSet
code String Optional. A String value

Response

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.
shop Shop.simple
options [Option.detailed] Array of Option.detailed
uploads [CartUploadWithOptionSet] Optional. Array of CartUploadWithOptionSet
code String Optional. A String value

Examples

Request

When used inside a request.

Example 1

{
    "amount": 11,
    "persons": 15,
    "gram": 14,
    "comment": "...",
    "product_id": 18,
    "product_price_id": 11,
    "shop_id": 18,
    "option_ids": [
        17,
        16,
        13
    ],
    "uploads": [
        {
            "upload": {
                "id": 15,
                "url": "https://example.com"
            },
            "optionset_id": 11
        },
        {
            "upload": {
                "id": 17,
                "url": "https://example.com"
            },
            "optionset_id": 17
        },
        {
            "upload": {
                "id": 10,
                "url": "https://example.com"
            },
            "optionset_id": 18
        }
    ],
    "code": "..."
}

Response

When returned in a response.

Example 1

{
    "amount": 15,
    "persons": 13,
    "gram": 18,
    "comment": "...",
    "product": {
        "id": 12,
        "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
                    }
                ],
                "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": false
            }
        ],
        "price_type": "PER_UNIT",
        "target_price": true,
        "price": 18
    },
    "product_price": {
        "id": 12,
        "name": "...",
        "price": 14
    },
    "calculated_prices": {
        "unit_price": 17,
        "price": 10
    },
    "discount_prices": {
        "unit_price": 10,
        "price": 13
    },
    "shop": {
        "id": 13,
        "name": "Jazmin Koepp Sr.",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE",
            "position": {
                "latitude": 1.54361,
                "longitude": 0.45645
            }
        }
    },
    "options": [
        {
            "id": 18,
            "name": "...",
            "price_change": 19,
            "optionset": {
                "id": 14,
                "name": "...",
                "allow_attachment": true
            }
        },
        {
            "id": 16,
            "name": "...",
            "price_change": 14,
            "optionset": {
                "id": 11,
                "name": "...",
                "allow_attachment": true
            }
        },
        {
            "id": 11,
            "name": "...",
            "price_change": 16,
            "optionset": {
                "id": 10,
                "name": "...",
                "allow_attachment": false
            }
        }
    ],
    "uploads": [
        {
            "upload": {
                "id": 17,
                "url": "https://example.com"
            },
            "optionset_id": 11
        },
        {
            "upload": {
                "id": 15,
                "url": "https://example.com"
            },
            "optionset_id": 17
        },
        {
            "upload": {
                "id": 15,
                "url": "https://example.com"
            },
            "optionset_id": 16
        }
    ],
    "code": "..."
}
Version update available Please adjust your integration to the latest stable version (1.9.0)
0.3.0 stable