Force a manual update of an order's payment status

POST /orders/@id/exchange

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

URL parameters

Replace the @ keywords in the URL with their corresponding value.

A dictionary with fields

Field Type Description
id Int An integer value

Example request 1

POST /orders/12/exchange HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5

Response

Field Type Description
id Int Id of the product
status String String enumarion of 'PENDING', 'HAS_READ', 'APPROVED', 'DECLINED', 'REMOVED', 'DELETED_BY_SHOP', 'COLLECTED'
valid Bool Is true when the order is completed or paid and visible for the shop.
order_nr Int Unique number on a yearly basis and per shop. Visible for the shop and users. Only available for valid orders.
prices CartPrices Prices
payment_method String String enumarion of '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'
checkout OrderCheckout
shop Shop.simple
created_at Timestamp Time when the order was created, measured in the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT).
joyn Joyn? Nullable. Contains the amount of points that can get saved with Joyn + a link to collect the points.
payment_status String? Nullable. String enumarion of 'pending', 'canceled', 'timeout', 'declined', 'refunded', 'paid'
products [CartItem.order] Array of CartItem.order
currency Currency 3 letter ISO 4217 currency name (string)
bank_transfer Dictionary A dictionary with fields
external_order_nr String External order nr assigned by a POS or other 3rd party software
shop_uses_external_order_nrs Bool Whether or not the shop assigns external order nrs to orders
invoice Dictionary? Nullable. A dictionary with fields
referenceCode String? Nullable. An optional reference code that can be used by the customer to identify the invoice.
warranty Dictionary? Nullable. A dictionary with fields

Example response 1

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 35946

{
    "id": 19,
    "status": "PENDING",
    "valid": false,
    "order_nr": 15,
    "prices": {
        "price": {
            "value": 16,
            "currency": "EUR"
        },
        "discount": {
            "value": 11,
            "currency": "EUR"
        },
        "warranty": {
            "value": 16,
            "currency": "EUR"
        },
        "delivery_cost": {
            "value": 11,
            "currency": "EUR"
        },
        "invoice_cost": {
            "value": 15,
            "currency": "EUR"
        },
        "sms_cost": {
            "value": 14,
            "currency": "EUR"
        },
        "transaction_cost": {
            "value": 16,
            "currency": "EUR"
        },
        "price_to_pay": {
            "value": 18,
            "currency": "EUR"
        },
        "price_with_discount": {
            "value": 12,
            "currency": "EUR"
        }
    },
    "payment_method": "point_of_sale",
    "checkout": {
        "method": "delivery",
        "date": "2019-01-31",
        "time": "12:00",
        "end_time": "12:00",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE"
        },
        "notes": "...",
        "name": "...",
        "latch_id": 16,
        "comment": "...",
        "notification_method": "email"
    },
    "shop": {
        "id": 13,
        "name": "Miles Mraz",
        "address": {
            "street": "Sint-Denijslaan",
            "nr": "96",
            "zipcode": "9000",
            "city": "Gent",
            "country": "BE",
            "position": {
                "latitude": 1.54361,
                "longitude": 0.45645
            }
        },
        "allow_comments": true,
        "url": "...",
        "allow_order_comments": false,
        "allow_product_comments": false,
        "allow_order_messages": true,
        "global_discount_percentage": 14,
        "allow_orders": false,
        "currency": "EUR"
    },
    "created_at": 1657086110,
    "joyn": {
        "points": 12,
        "collect_url": "https://example.com",
        "qr_code_url": "https://example.com"
    },
    "payment_status": "pending",
    "products": [
        {
            "amount": 15,
            "persons": 15,
            "gram": 14,
            "comment": "...",
            "product": {
                "id": 15,
                "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": 18,
                        "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": 18,
                        "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": true,
                "price": {
                    "value": 13,
                    "currency": "EUR"
                },
                "only_order_in_store": true,
                "category": {
                    "id": 10,
                    "name": "..."
                },
                "origin": "...",
                "ingredients": "...",
                "nutrients": [
                    {
                        "type": "FAT",
                        "amount": 9.67,
                        "label": "..."
                    },
                    {
                        "type": "FAT",
                        "amount": 9.67,
                        "label": "..."
                    },
                    {
                        "type": "FAT",
                        "amount": 9.67,
                        "label": "..."
                    }
                ]
            },
            "product_price": {
                "id": 16,
                "name": "...",
                "price": {
                    "value": 12,
                    "currency": "EUR"
                }
            },
            "calculated_prices": {
                "unit_price": {
                    "value": 15,
                    "currency": "EUR"
                },
                "price": {
                    "value": 11,
                    "currency": "EUR"
                }
            },
            "discount_prices": {
                "unit_price": {
                    "value": 15,
                    "currency": "EUR"
                },
                "price": {
                    "value": 14,
                    "currency": "EUR"
                }
            },
            "amount_free": 15,
            "options": [
                {
                    "option": {
                        "id": 18,
                        "name": "...",
                        "price_change": {
                            "value": 19,
                            "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": 11,
                            "white_background": false
                        },
                        "require_image": false,
                        "code": "...",
                        "price_calculation": "PER_PIECE",
                        "optionset": {
                            "id": 15,
                            "name": "...",
                            "code": "...",
                            "multiple_choice": true,
                            "choose_amount": true,
                            "min_different_options": 15,
                            "max_different_options": 11,
                            "min_amount_options": 17,
                            "max_amount_options": 16
                        }
                    },
                    "upload": {
                        "id": 18,
                        "url": "https://example.com"
                    },
                    "amount": 17
                },
                {
                    "option": {
                        "id": 12,
                        "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": true,
                        "code": "...",
                        "price_calculation": "PER_PIECE",
                        "optionset": {
                            "id": 13,
                            "name": "...",
                            "code": "...",
                            "multiple_choice": true,
                            "choose_amount": false,
                            "min_different_options": 11,
                            "max_different_options": 14,
                            "min_amount_options": 13,
                            "max_amount_options": 11
                        }
                    },
                    "upload": {
                        "id": 15,
                        "url": "https://example.com"
                    },
                    "amount": 12
                },
                {
                    "option": {
                        "id": 19,
                        "name": "...",
                        "price_change": {
                            "value": 15,
                            "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": 17,
                            "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": 10,
                            "max_different_options": 11,
                            "min_amount_options": 19,
                            "max_amount_options": 13
                        }
                    },
                    "upload": {
                        "id": 15,
                        "url": "https://example.com"
                    },
                    "amount": 14
                }
            ]
        },
        {
            "amount": 13,
            "persons": 13,
            "gram": 17,
            "comment": "...",
            "product": {
                "id": 19,
                "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": 16,
                        "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": 16,
                        "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": 10,
                        "white_background": true
                    }
                ],
                "price_type": "PER_UNIT",
                "target_price": false,
                "price": {
                    "value": 12,
                    "currency": "EUR"
                },
                "only_order_in_store": true,
                "category": {
                    "id": 17,
                    "name": "..."
                },
                "origin": "...",
                "ingredients": "...",
                "nutrients": [
                    {
                        "type": "FAT",
                        "amount": 9.67,
                        "label": "..."
                    },
                    {
                        "type": "FAT",
                        "amount": 9.67,
                        "label": "..."
                    },
                    {
                        "type": "FAT",
                        "amount": 9.67,
                        "label": "..."
                    }
                ]
            },
            "product_price": {
                "id": 10,
                "name": "...",
                "price": {
                    "value": 15,
                    "currency": "EUR"
                }
            },
            "calculated_prices": {
                "unit_price": {
                    "value": 19,
                    "currency": "EUR"
                },
                "price": {
                    "value": 14,
                    "currency": "EUR"
                }
            },
            "discount_prices": {
                "unit_price": {
                    "value": 19,
                    "currency": "EUR"
                },
                "price": {
                    "value": 12,
                    "currency": "EUR"
                }
            },
            "amount_free": 14,
            "options": [
                {
                    "option": {
                        "id": 10,
                        "name": "...",
                        "price_change": {
                            "value": 18,
                            "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": 15,
                            "white_background": false
                        },
                        "require_image": true,
                        "code": "...",
                        "price_calculation": "PER_PIECE",
                        "optionset": {
                            "id": 15,
                            "name": "...",
                            "code": "...",
                            "multiple_choice": true,
                            "choose_amount": true,
                            "min_different_options": 12,
                            "max_different_options": 12,
                            "min_amount_options": 18,
                            "max_amount_options": 12
                        }
                    },
                    "upload": {
                        "id": 12,
                        "url": "https://example.com"
                    },
                    "amount": 12
                },
                {
                    "option": {
                        "id": 12,
                        "name": "...",
                        "price_change": {
                            "value": 15,
                            "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": 16,
                            "white_background": false
                        },
                        "require_image": false,
                        "code": "...",
                        "price_calculation": "PER_PIECE",
                        "optionset": {
                            "id": 16,
                            "name": "...",
                            "code": "...",
                            "multiple_choice": false,
                            "choose_amount": false,
                            "min_different_options": 16,
                            "max_different_options": 11,
                            "min_amount_options": 16,
                            "max_amount_options": 13
                        }
                    },
                    "upload": {
                        "id": 15,
                        "url": "https://example.com"
                    },
                    "amount": 10
                },
                {
                    "option": {
                        "id": 17,
                        "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": 14,
                            "white_background": true
                        },
                        "require_image": true,
                        "code": "...",
                        "price_calculation": "PER_PIECE",
                        "optionset": {
                            "id": 19,
                            "name": "...",
                            "code": "...",
                            "multiple_choice": false,
                            "choose_amount": true,
                            "min_different_options": 11,
                            "max_different_options": 12,
                            "min_amount_options": 11,
                            "max_amount_options": 11
                        }
                    },
                    "upload": {
                        "id": 13,
                        "url": "https://example.com"
                    },
                    "amount": 18
                }
            ]
        },
        {
            "amount": 18,
            "persons": 10,
            "gram": 19,
            "comment": "...",
            "product": {
                "id": 16,
                "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": 11,
                        "white_background": false
                    },
                    {
                        "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": 15,
                        "white_background": false
                    },
                    {
                        "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
                    }
                ],
                "price_type": "PER_UNIT",
                "target_price": true,
                "price": {
                    "value": 17,
                    "currency": "EUR"
                },
                "only_order_in_store": true,
                "category": {
                    "id": 12,
                    "name": "..."
                },
                "origin": "...",
                "ingredients": "...",
                "nutrients": [
                    {
                        "type": "FAT",
                        "amount": 9.67,
                        "label": "..."
                    },
                    {
                        "type": "FAT",
                        "amount": 9.67,
                        "label": "..."
                    },
                    {
                        "type": "FAT",
                        "amount": 9.67,
                        "label": "..."
                    }
                ]
            },
            "product_price": {
                "id": 16,
                "name": "...",
                "price": {
                    "value": 11,
                    "currency": "EUR"
                }
            },
            "calculated_prices": {
                "unit_price": {
                    "value": 17,
                    "currency": "EUR"
                },
                "price": {
                    "value": 18,
                    "currency": "EUR"
                }
            },
            "discount_prices": {
                "unit_price": {
                    "value": 15,
                    "currency": "EUR"
                },
                "price": {
                    "value": 14,
                    "currency": "EUR"
                }
            },
            "amount_free": 10,
            "options": [
                {
                    "option": {
                        "id": 17,
                        "name": "...",
                        "price_change": {
                            "value": 15,
                            "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": false
                        },
                        "require_image": true,
                        "code": "...",
                        "price_calculation": "PER_PIECE",
                        "optionset": {
                            "id": 17,
                            "name": "...",
                            "code": "...",
                            "multiple_choice": true,
                            "choose_amount": true,
                            "min_different_options": 14,
                            "max_different_options": 19,
                            "min_amount_options": 15,
                            "max_amount_options": 12
                        }
                    },
                    "upload": {
                        "id": 11,
                        "url": "https://example.com"
                    },
                    "amount": 16
                },
                {
                    "option": {
                        "id": 16,
                        "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": 18,
                            "white_background": true
                        },
                        "require_image": false,
                        "code": "...",
                        "price_calculation": "PER_PIECE",
                        "optionset": {
                            "id": 17,
                            "name": "...",
                            "code": "...",
                            "multiple_choice": true,
                            "choose_amount": true,
                            "min_different_options": 15,
                            "max_different_options": 13,
                            "min_amount_options": 11,
                            "max_amount_options": 18
                        }
                    },
                    "upload": {
                        "id": 18,
                        "url": "https://example.com"
                    },
                    "amount": 18
                },
                {
                    "option": {
                        "id": 12,
                        "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": 10,
                            "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": 17,
                            "max_different_options": 18,
                            "min_amount_options": 11,
                            "max_amount_options": 16
                        }
                    },
                    "upload": {
                        "id": 15,
                        "url": "https://example.com"
                    },
                    "amount": 19
                }
            ]
        }
    ],
    "currency": "EUR",
    "bank_transfer": {
        "reference": "...",
        "bank_accounts": [
            {
                "bank": "ING. Bank",
                "number": "BE283578529348"
            },
            {
                "bank": "ING. Bank",
                "number": "BE283578529348"
            },
            {
                "bank": "ING. Bank",
                "number": "BE283578529348"
            }
        ]
    },
    "external_order_nr": "...",
    "shop_uses_external_order_nrs": false,
    "invoice": {
        "company": {
            "name": "...",
            "vat": "BE0123.456.789",
            "address": {
                "street": "Sint-Denijslaan",
                "nr": "96",
                "zipcode": "9000",
                "city": "Gent",
                "country": "BE"
            }
        }
    },
    "referenceCode": "...",
    "warranty": {
        "bank": "..."
    }
}
This is a development version Do not use this version in production
1.10.0 development