BizKitHub
DocsAPI ReferenceCustomer/api/v1/customer/order-list
getCustomerPublic API v1

/api/v1/customer/order-list

Returns a paginated list of orders for the customer identified by identityId, including order lines, status, prices, and linked calendar events.

customergetApiV1CustomerOrder-list

Parameters

3 query

Query parameters

· 3
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
identityIdstringRequired

Logged user identity (from your frontend cookies). Learn more

ExampleZ9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg
pagestringOptional

Page number (string, converted to number internally).

Default: 1
Example1

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired
ExamplesSO98YxzR4KJiOu66Jn6K3wRwa4FPI7S
orderNumberstringRequired
Example25000055
statusobjectRequired
labelstringRequired
ExampleStorno
codestringRequired
Examplestorno
backgroundColorstringRequired
Example#901020
textColorstringRequired
Example#fff
pricestringRequired
Example0 Kč
noticestringOptional
ExamplePlease reserve a trainer to me.
insertedDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Example2025-01-10T16:19:40.150Z
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
updatedDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Example2025-01-10T16:19:40.150Z
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
expirationDateDate | string | string | numberOptional
One of 4:
Variant 1
Date
Example2025-01-10T16:19:40.150Z
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
linesobject[]Required
Each array item:
idstringRequired
Example2d33677772eddbd4e869c6ed6bf6d9f3
labelstringRequired
ExampleJan Barášek GymRoom Vinohrady rezervace
countnumberRequired
Example1
stornobooleanRequired
Default: false
pricestringRequired
Example110 Kč
unitstringOptional
Exampleskshkg
vatnumberOptional
Example21
creditAmountnumberOptional
Example100
insertedDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Example2025-01-10T16:19:40.150Z
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
eventobjectOptional
idstringRequired
Example7lRIAiC69gZMfwsDbG3CJvQdqnY15XdS
calendarIdstringRequired
Example2WRp6X5rSqQa321EjHB2mxZz74u74H84
startTimeDate | string | string | numberRequired
One of 4:
Variant 1
Date
Example2025-01-10T16:19:40.150Z
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
endTimeDate | string | string | numberRequired
One of 4:
Variant 1
Date
Example2025-01-10T16:19:40.150Z
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
titlestringOptional
ExampleJan Barášek GymRoom Vinohrady rezervace
isAllDaybooleanRequired
Default: false
isBlockingbooleanRequired
Default: true
isStornobooleanRequired
Default: true

Response example

application/json
{
  "items": [
    {
      "id": "sSO98YxzR4KJiOu66Jn6K3wRwa4FPI7S",
      "orderNumber": "25000055",
      "status": {
        "label": "Storno",
        "code": "storno",
        "backgroundColor": "#901020",
        "textColor": "#fff"
      },
      "price": "0 Kč",
      "notice": "Please reserve a trainer to me.",
      "insertedDate": "2025-01-10T16:19:40.150Z",
      "updatedDate": "2025-01-10T16:19:40.150Z",
      "expirationDate": "2025-01-10T16:19:40.150Z",
      "lines": [
        {
          "id": "2d33677772eddbd4e869c6ed6bf6d9f3",
          "label": "Jan Barášek GymRoom Vinohrady rezervace",
          "count": 1,
          "storno": false,
          "price": "110 Kč",
          "unit": "ks",
          "vat": 21,
          "creditAmount": 100,
          "insertedDate": "2025-01-10T16:19:40.150Z",
          "event": {
            "id": "7lRIAiC69gZMfwsDbG3CJvQdqnY15XdS",
            "calendarId": "2WRp6X5rSqQa321EjHB2mxZz74u74H84",
            "startTime": "2025-01-10T16:19:40.150Z",
            "endTime": "2025-01-10T16:19:40.150Z",
            "title": "Jan Barášek GymRoom Vinohrady rezervace",
            "isAllDay": false,
            "isBlocking": true,
            "isStorno": true
          }
        }
      ]
    }
  ]
}

Request example

GET /api/v1/customer/order-list

get
curl -X GET "https://api.bizkithub.com/api/v1/customer/order-list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg&page=1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key