Orders

GET/v1/orders

List unconfirmed orders

This endpoint allows you to retrieve a list of all unconfirmed orders. By default, a maximum of ten orders is returned.

Optional query parameters

Name
limit
Type
integer
Description
Limit the number of orders returned. By default the limit is 10. The maximum number of orders that can be returned for each request is 100. Invalid values will be return the default of 10 orders.
Example: /v1/orders?limit=5
Name
shop
Type
integer
Description
Get orders for a particular shop. By default orders from all shops are returned. Invalid values will return orders for all shops.
Example: /v1/orders?limit=25&shop=2

Request

GET

/v1/orders

curl -G https://api.kaddy.cloud/v1/orders \
  -H "Authorization: Bearer {token}" \
  -H "X-Tenant: {tenant ID}" \
  -H "Accept: application/json"

Response


[
    {
        "id": "988a7773-8234-4b44-9a2d-8ea2e2eb1ae7",
        "payment_reference": "tr_9HbgUZNeRe",
        "payment_method": "bancontact",
        "payed_at": "2023-04-20 00:19:51",
        "total": "24.30",
        "order_type": "pick_up",
        "order_date": "2023-04-26",
        "order_time": "09:00:00",
        "remarks": null,
        "shop": {
            "id": "1",
            "name": "Acme",
            "address": "Rue du Stade 20",
            "postal_code": "6500",
            "city": "Beaumont",
            "country": "BE",
        },
        "client": {
            "id": "b80cedcb-6de6-4f21-a2ef-a53cbc47832a",
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "mobile_phone": "+32476456271",
            "phone": null
        },
        "order_lines": [
            {
                "product": "Pain multigrain 400 gr",
                "plu_code": "3456",
                "qty": 2,
                "unit": "st",
                "total": "4.00",
                "options": [],
                "extras": []
            },
            {
                "product": "Ciabatta jambon & fromage",
                "plu_code": "8765",
                "qty": 1,
                "unit": "st",
                "total": "4.80",
                "options": [
                    {
                        "name": "Pain sans gluten",
                        "plu_code": "4567",
                        "qty": 1,
                        "total": "0.50",
                        "meta": null
                    }
                ],
                "extras": []
            },
            {
                "product": "Tarte aux fruits",
                "plu_code": "8543",
                "qty": ,
                "unit": "st",
                "total": "12.50",
                "options": [
                    {
                        "name": "Texte sur plaquette en chocolat",
                        "plu_code": "2315",
                        "qty": 1,
                        "total": "2.50",
                        "meta": "Happy Birthday"
                    }
                ],
                "extras": []
            }
        ]
    },
    {
      "id": "139ecf70-a3e7-4ac8-b8ff-65b5535a246e"
      // ...
  }
]

POST/v1/orders/{id}/confirm

Confirm an order

This endpoint allows you to confirm an order. Confirmed orders will not be returned again when calling the list orders endpoint.

Required attributes

Name
id
Type
string
Description
The unique identifier for the order

Request

POST

/v1/orders/{id}/confirm

curl https://api.kaddy.cloud/v1/orders/{id}/confirm \
  -H "Authorization: Bearer {token}" \
  -H "X-Tenant: {tenant ID}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

Response

{
    "success": true
}

GET/v1/orders/{id}

Get an order

This endpoint allows you to get an individual order regardless of whether it is confirmed or not.

Required attributes

Name
id
Type
string
Description
The unique identifier for the order

Request

GET

/v1/orders/{id}

curl -G https://api.kaddy.cloud/v1/orders/{id} \
  -H "Authorization: Bearer {token}" \
  -H "X-Tenant: {tenant ID}" \
  -H "Accept: application/json"

Response


{
    "id": "988a7773-8234-4b44-9a2d-8ea2e2eb1ae7",
    "payment_reference": "tr_9HbgUZNeRe",
    "payment_method": "bancontact",
    "payed_at": "2023-04-20 00:19:51",
    "total": "24.30",
    "order_type": "pick_up",
    "order_date": "2023-04-26",
    "order_time": "09:00:00",
    "remarks": null,
    "shop": {
        "id": "1",
        "name": "Acme",
        "address": "Rue du Stade 20",
        "postal_code": "6500",
        "city": "Beaumont",
        "country": "BE",
    },
    "client": {
        "id": "b80cedcb-6de6-4f21-a2ef-a53cbc47832a",
        "first_name": "John",
        "last_name": "Doe",
        "email": "[email protected]",
        "mobile_phone": "+32476456271",
        "phone": null
    },
    "order_lines": [
        {
            "product": "Pain multigrain 400 gr",
            "plu_code": "3456",
            "qty": 2,
            "unit": "st",
            "total": "4.00",
            "options": [],
            "extras": []
        },
        {
            "product": "Ciabatta jambon & fromage",
            "plu_code": "8765",
            "qty": 1,
            "unit": "st",
            "total": "4.80",
            "options": [
                {
                    "name": "Pain sans gluten",
                    "plu_code": "4567",
                    "qty": 1,
                    "total": "0.50",
                    "meta": null
                }
            ],
            "extras": []
        },
        {
            "product": "Tarte aux fruits",
            "plu_code": "8543",
            "qty": ,
            "unit": "st",
            "total": "12.50",
            "options": [
                {
                    "name": "Texte sur plaquette en chocolat",
                    "plu_code": "2315",
                    "qty": 1,
                    "total": "2.50",
                    "meta": "Happy Birthday"
                }
            ],
            "extras": []
        }
    ]
}

Properties

Name
id
Type
string
Description
Unique identifier for the order
Example: f58eadfb-d456-478c-aff1-e67012a7c509
Name
payment_reference
Type
string
Description
The payment reference from the payment provider Mollie
Example: tr_jUYtrDEqNj
Name
payment_method
Type
string
Description
The payment method
Possible values are: creditcard, bancontact, belfius, kbc, inghomepay, ...
Example: bancontact
Name
payed_at
Type
timestamp
Description
Timestamp of payment
Example: 2023-02-20 17:33:58
Name
total
Type
string
Description
The total amount paid in Euro
Example: 8.80
Name
order_type
Type
string
Description
The order type
Possible values are: pick_up, delivery, pick_up_coolbox
Example: pick_up
Name
order_date
Type
string
Description
The date when the order will be picked-up or delivered
Example: 2023-02-23
Name
order_time
Type
string
Description
The date when the order will be picked-up or delivered
Example: 08:40:00
Name
order_number
Type
string
Description
Order number for the day. Starts at zero every day per order type, i.e. pick-up and delivery can both have order_number 1.
Example: 1
Name
delivery_address
Type
array
Description
The delivery address in case of a delivery order type
- Name
  street
  Type
  string
  Description
  Street
  Example: Rue de la frête
- Name
  number
  Type
  string
  Description
  House number
  Example: 20
- Name
  bus
  Type
  string
  Description
  Bus
  Example: 3
- Name
  postal_code
  Type
  string
  Description
  Postal code
  Example: 1367
- Name
  city
  Type
  string
  Description
  City
  Example: Ramillies
- Name
  country
  Type
  string
  Description
  2-letter country Alpha-2 code
  Example: BE
- Name
  distance
  Type
  string
  Description
  Delivery distance in meters from the shop to the delivery address
  Example: 4678
Name
delivery_cost
Type
string
Description
The delivery cost in case of a delivery order type
Name
service_cost
Type
string
Description
Service costs
Name
remarks
Type
string
Description
Remarks concerning the order.
Name
shop
Type
array
Description
The shop details
- Name
  id
  Type
  integer
  Description
  Shop ID
  Example: 1
- Name
  name
  Type
  string
  Description
  Shop name
  Example: Acme
- Name
  address
  Type
  string
  Description
  Shop address
  Example: Rue de la frête 20
- Name
  postal_code
  Type
  string
  Description
  Shop postal code
  Example: 1367
- Name
  city
  Type
  string
  Description
  Shop city
  Example: Ramillies
- Name
  country
  Type
  string
  Description
  Shop 2-letter country Alpha-2 code
  Example: BE
Name
client
Type
array
Description
The client details
- Name
  id
  Type
  integer
  Description
  Client ID
  Example: 24
- Name
  first_name
  Type
  string
  Description
  First name
  Example: John
- Name
  last_name
  Type
  string
  Description
  Last name
  Example: Doe
- Name
  email
  Type
  string
  Description
  Email address
  Example: [email protected]
- Name
  mobile_phone
  Type
  string
  Description
  Mobile phone number
  Example: +32476253627
- Name
  phone
  Type
  string
  Description
  Phone number
  Example: +3215627382
Name
order_lines
Type
array
Description
The order lines
- Name
  product
  Type
  string
  Description
  Product name
  Example: Pain Multigrains
- Name
  plu_code
  Type
  string
  Description
  Product PLU code
  Example: 4536
- Name
  qty
  Type
  integer
  Description
  Quantity
  Example: 1
- Name
  unit
  Type
  string
  Description
  Product unit
  Possible values are: st, gr, kg, pers
  Example: kg
- Name
  total
  Type
  string
  Description
  Orderline total in Euro
  Example: 10.40
- Name
  options
  Type
  string
  Description
  The orderline product options
  Name
  name
  Type
  string
  Description
  Option name
  Example: Non Coupé
  Name
  plu_code
  Type
  string
  Description
  Option PLU code
  Example: 27483
  Name
  qty
  Type
  integer
  Description
  Option quantity
  Example: 2
  Name
  total
  Type
  string
  Description
  Option total in Euro
  Example: 4.60
  Name
  type
  Type
  string
  Description
  Option meta information, for example the text on a textplate
  Possible values are: default, text
  Example: default
  Name
  meta
  Type
  string
  Description
  Option meta information, for example the text for an option with type text (on a textplate)
  Example: Happy Birthday
- Name
  extras
  Type
  string
  Description
  The orderline product extras
  Name
  name
  Type
  string
  Description
  Extra name
  Example: Whole lobster
  Name
  plu_code
  Type
  string
  Description
  Extra PLU code
  Example: 3526
  Name
  qty
  Type
  integer
  Description
  Quantity
  Example: 4
  Name
  total
  Type
  string
  Description
  Extra total in Euro
  Example: 12.80
  Name
  unit
  Type
  string
  Description
  Extra unit
  Possible values are: st, gr, kg, pers Example: st