CartConfig

When available, this will return all essential information about the cart. When the cart is also set in the response, the cart_config contains information about the cart in the response, not in the request.

Field Type Description
target_price Bool A boolean value
prices CartPrices Prices
payment PaymentConfig Information about the allowed payment methods and messages that should get displayed on the payment page.
takeout TakeoutConfig Information needed in the takeout flow
delivery DeliveryConfig Information needed in the delivery flow
latch LatchConfig Information needed in the latch flow
checkout_method_messages [String] Array of String
warranty Bool A boolean value
discounts [Discount] Array of Discount
allow_combined_cart Bool A boolean value
invoice InvoiceConfig Information about invoices
allow_discount_codes Bool A boolean value
allow_comments Bool A boolean value
allow_order_comments Bool A boolean value
allow_product_comments Bool A boolean value
note_from_customer String A String value
invoice_cost_obsolete_price Price
invoice_cost_obsolete_price_enable Bool A boolean value
allow_delivery_comment Bool A boolean value

Examples

Request

When used inside a request.

Example 1

{
    "target_price": false,
    "prices": {
        "price": {
            "value": 14,
            "currency": "EUR"
        },
        "discount": {
            "value": 16,
            "currency": "EUR"
        },
        "warranty": {
            "value": 12,
            "currency": "EUR"
        },
        "delivery_cost": {
            "value": 16,
            "currency": "EUR"
        },
        "invoice_cost": {
            "value": 10,
            "currency": "EUR"
        },
        "sms_cost": {
            "value": 15,
            "currency": "EUR"
        },
        "transaction_cost": {
            "value": 17,
            "currency": "EUR"
        },
        "price_to_pay": {
            "value": 12,
            "currency": "EUR"
        },
        "price_with_discount": {
            "value": 14,
            "currency": "EUR"
        }
    },
    "payment": {
        "methods": [
            "point_of_sale",
            "paid_in_shop",
            "bank_transfer",
            "ideal",
            "bancontact",
            "sofort",
            "giropay",
            "creditcard",
            "cartes_bancaires",
            "paypal",
            "eps_uberweisung",
            "apple_pay",
            "google_pay",
            "payconiq",
            "monizze",
            "edenred",
            "webpay",
            "credomatic",
            "satispay",
            "stripe_card_visa_mc",
            "stripe_card_amex",
            "stripe_apple_pay",
            "stripe_google_pay",
            "payu_romania_visa",
            "payu_romania_mc",
            "payu_romania_visa_electron",
            "payu_romania_maestro",
            "payu_brazil_amex",
            "payu_brazil_boleto_bancario",
            "payu_brazil_diners",
            "payu_brazil_elo",
            "payu_brazil_hipercard",
            "payu_brazil_mc",
            "payu_brazil_visa",
            "payu_sp_maestro",
            "payu_sp_mc",
            "payu_sp_pbl",
            "payu_sp_visa",
            "payu_sp_blik",
            "payu_iyzico_amex",
            "payu_iyzico_mc",
            "payu_iyzico_troy",
            "payu_iyzico_visa",
            "pesopay_gcash",
            "pesopay_visa",
            "pesopay_mc",
            "redsys_bizum",
            "sibs_id"
        ],
        "messages": [
            "...",
            "...",
            "..."
        ]
    },
    "takeout": {
        "allowed": true,
        "use_intervals": true
    },
    "delivery": {
        "allowed": true,
        "use_intervals": false,
        "messages": [
            "...",
            "...",
            "..."
        ]
    },
    "latch": {
        "allowed": false,
        "latches": [
            {
                "id": 10,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE"
                },
                "name": "..."
            },
            {
                "id": 16,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE"
                },
                "name": "..."
            },
            {
                "id": 12,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE"
                },
                "name": "..."
            }
        ]
    },
    "checkout_method_messages": [
        "...",
        "...",
        "..."
    ],
    "warranty": true,
    "discounts": [
        {
            "name": "...",
            "description": "...",
            "percentage": 9.67,
            "fixed": 10,
            "type": "first-order",
            "code": "...",
            "minimum_order_price": 9.67,
            "maximum_discount_price": 9.67
        },
        {
            "name": "...",
            "description": "...",
            "percentage": 9.67,
            "fixed": 11,
            "type": "first-order",
            "code": "...",
            "minimum_order_price": 9.67,
            "maximum_discount_price": 9.67
        },
        {
            "name": "...",
            "description": "...",
            "percentage": 9.67,
            "fixed": 17,
            "type": "first-order",
            "code": "...",
            "minimum_order_price": 9.67,
            "maximum_discount_price": 9.67
        }
    ],
    "allow_combined_cart": false,
    "invoice": {
        "messages": [
            "...",
            "...",
            "..."
        ]
    },
    "allow_discount_codes": false,
    "allow_comments": false,
    "allow_order_comments": true,
    "allow_product_comments": false,
    "note_from_customer": "...",
    "invoice_cost_obsolete_price": {
        "value": 18,
        "currency": "EUR"
    },
    "invoice_cost_obsolete_price_enable": false,
    "allow_delivery_comment": true
}

Response

When returned in a response.

Example 1

{
    "target_price": false,
    "prices": {
        "price": {
            "value": 18,
            "currency": "EUR"
        },
        "discount": {
            "value": 13,
            "currency": "EUR"
        },
        "warranty": {
            "value": 13,
            "currency": "EUR"
        },
        "delivery_cost": {
            "value": 12,
            "currency": "EUR"
        },
        "invoice_cost": {
            "value": 17,
            "currency": "EUR"
        },
        "sms_cost": {
            "value": 11,
            "currency": "EUR"
        },
        "transaction_cost": {
            "value": 16,
            "currency": "EUR"
        },
        "price_to_pay": {
            "value": 10,
            "currency": "EUR"
        },
        "price_with_discount": {
            "value": 10,
            "currency": "EUR"
        }
    },
    "payment": {
        "methods": [
            "point_of_sale",
            "paid_in_shop",
            "bank_transfer",
            "ideal",
            "bancontact",
            "sofort",
            "giropay",
            "creditcard",
            "cartes_bancaires",
            "paypal",
            "eps_uberweisung",
            "apple_pay",
            "google_pay",
            "payconiq",
            "monizze",
            "edenred",
            "webpay",
            "credomatic",
            "satispay",
            "stripe_card_visa_mc",
            "stripe_card_amex",
            "stripe_apple_pay",
            "stripe_google_pay",
            "payu_romania_visa",
            "payu_romania_mc",
            "payu_romania_visa_electron",
            "payu_romania_maestro",
            "payu_brazil_amex",
            "payu_brazil_boleto_bancario",
            "payu_brazil_diners",
            "payu_brazil_elo",
            "payu_brazil_hipercard",
            "payu_brazil_mc",
            "payu_brazil_visa",
            "payu_sp_maestro",
            "payu_sp_mc",
            "payu_sp_pbl",
            "payu_sp_visa",
            "payu_sp_blik",
            "payu_iyzico_amex",
            "payu_iyzico_mc",
            "payu_iyzico_troy",
            "payu_iyzico_visa",
            "pesopay_gcash",
            "pesopay_visa",
            "pesopay_mc",
            "redsys_bizum",
            "sibs_id"
        ],
        "messages": [
            "...",
            "...",
            "..."
        ]
    },
    "takeout": {
        "allowed": false,
        "use_intervals": true
    },
    "delivery": {
        "allowed": true,
        "use_intervals": true,
        "messages": [
            "...",
            "...",
            "..."
        ]
    },
    "latch": {
        "allowed": true,
        "latches": [
            {
                "id": 16,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "name": "..."
            },
            {
                "id": 14,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "name": "..."
            },
            {
                "id": 18,
                "address": {
                    "street": "Sint-Denijslaan",
                    "nr": "96",
                    "zipcode": "9000",
                    "city": "Gent",
                    "country": "BE",
                    "position": {
                        "latitude": 1.54361,
                        "longitude": 0.45645
                    }
                },
                "name": "..."
            }
        ]
    },
    "checkout_method_messages": [
        "...",
        "...",
        "..."
    ],
    "warranty": true,
    "discounts": [
        {
            "name": "...",
            "description": "...",
            "percentage": 9.67,
            "fixed": 10,
            "type": "first-order",
            "code": "...",
            "minimum_order_price": 9.67,
            "maximum_discount_price": 9.67
        },
        {
            "name": "...",
            "description": "...",
            "percentage": 9.67,
            "fixed": 18,
            "type": "first-order",
            "code": "...",
            "minimum_order_price": 9.67,
            "maximum_discount_price": 9.67
        },
        {
            "name": "...",
            "description": "...",
            "percentage": 9.67,
            "fixed": 10,
            "type": "first-order",
            "code": "...",
            "minimum_order_price": 9.67,
            "maximum_discount_price": 9.67
        }
    ],
    "allow_combined_cart": false,
    "invoice": {
        "messages": [
            "...",
            "...",
            "..."
        ]
    },
    "allow_discount_codes": false,
    "allow_comments": false,
    "allow_order_comments": false,
    "allow_product_comments": false,
    "note_from_customer": "...",
    "invoice_cost_obsolete_price": {
        "value": 17,
        "currency": "EUR"
    },
    "invoice_cost_obsolete_price_enable": false,
    "allow_delivery_comment": true
}
This is a development version Do not use this version in production
1.10.0 development