BizKitHub
DocsAPI ReferenceOrder/api/v1/shop/order/list
getOrderPublic API v1

/api/v1/shop/order/list

Lists orders of the organisation that owns the API key, newest change first (updatedDate desc). Never returns orders of another organisation. formData is not part of the list; load it per order via GET /order/detail-full.

ordergetApiV1ShopOrderList

Parameters

9 query

Query parameters

· 9
apiKeystringOptional

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
groupCodestringOptional

Order group code.

Examplenabidky
assigneeEmailstringOptional

E-mail of the assignee (assignee at creation). Case-insensitive exact match.

customerEmailstringOptional

E-mail of the customer. Case-insensitive.

statusCodestringOptional

Only these status codes (comma-separated).

Examplenabidka-odeslana,nabidka-prijata
excludeStatusCodestringOptional

Hide these status codes (comma-separated).

Examplenabidka-nahrazena
tagstringOptional

Tag filter key:value, comma-separated for several (the order must carry all of them). Normalised like on write, so the casing does not matter.

Examplenabidka:NAB-2026-0987
pagestringOptional
Default: 1
Example1
limitstringOptional

Page size, at most 100.

Default: 20
Example20

Response schema

1 status code documented

200Success
countnumberRequired

Items on this page.

totalCountnumberRequired

All orders matching the filters.

pagenumberRequired
limitnumberRequired
itemsobject[]Required
Each array item:
idstringRequired

Order number.

Example26000005
hashstringRequired

Unique order hash.

ExampleDIeJ1W5NBF0KEXtamL9zpx5Hk3s79008
kindstringRequired

Order kind (commerce | registration).

Examplecommerce
statusobjectRequired
codestringRequired

Organisation-defined status code.

Examplenabidka-odeslana
labelstringRequired

Status name shown in the administration.

ExampleNabídka odeslána
typestringRequired

Status type: new | processing | done | storno.

Examplenew
groupobjectRequired
codestringRequired
Examplenabidky
namestringRequired
ExampleNabídky
customerobject | nullRequired
One of 2:
Variant 1
cuRefNostringRequired
ExampleA1b2C3d4E5f6G7h8
namestring | nullRequired
One of 2:
Variant 1
string
ExampleJan Novák
Variant 2
null
companyNamestring | nullRequired
One of 2:
Variant 1
string
ExampleDivadlo J. K. Tyla
Variant 2
null
emailstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
phonestring | nullRequired
One of 2:
Variant 1
string
Example+420777123456
Variant 2
null
Variant 2
null
priceobjectRequired
withVatnumberRequired

Order total including VAT.

Example121000
withoutVatnumberRequired

Order total excluding VAT, computed per item from its own VAT rate.

Example100000
currencystringRequired
ExampleCZK
isPaidbooleanRequired
payDatestring | nullRequired
One of 2:
Variant 1
stringdate-time
Variant 2
null
insertedDatestringRequireddate-time
updatedDatestringRequireddate-time
assigneeobject | nullRequired
One of 2:
Variant 1
cuRefNostringRequired

Contact reference number (16 chars).

ExampleA1b2C3d4E5f6G7h8
emailstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
namestring | nullRequired
One of 2:
Variant 1
string
ExamplePetr Hlavatý
Variant 2
null
Variant 2
null
tagsobject[]Required

Tags as stored (keys snake_case, values lower-cased).

Each array item:
codestringRequired
Examplenabidka:nab-2026-0987
keystringRequired
Examplenabidka
valuestringRequired
Examplenab-2026-0987
parentHashstring | nullRequired
One of 2:
Variant 1
string

Hash of the parent order (parentId at creation), e.g. the previous version of an offer.

ExampleN34N21Zs0my8w1Li1BKpiBzhuuhknTqQ
Variant 2
null
shipNotBeforestring | nullRequired
One of 2:
Variant 1
stringdate

Postponed shipping: the order must not ship before this day (Europe/Prague calendar day). null = ship as usual.

Example2026-12-15
Variant 2
null

Response example

application/json
{
  "count": 0,
  "totalCount": 0,
  "page": 0,
  "limit": 0,
  "items": [
    {
      "id": "26000005",
      "hash": "DIeJ1W5NBF0KEXtamL9zpx5Hk3s79008",
      "kind": "commerce",
      "status": {
        "code": "nabidka-odeslana",
        "label": "Nabídka odeslána",
        "type": "new"
      },
      "group": {
        "code": "nabidky",
        "name": "Nabídky"
      },
      "price": {
        "withVat": 121000,
        "withoutVat": 100000,
        "currency": "CZK"
      },
      "isPaid": false,
      "insertedDate": "example_insertedDate",
      "updatedDate": "example_updatedDate",
      "tags": [
        {
          "code": "nabidka:nab-2026-0987",
          "key": "nabidka",
          "value": "nab-2026-0987"
        }
      ]
    }
  ]
}

Request example

GET /api/v1/shop/order/list

get
curl -X GET "https://api.bizkithub.com/api/v1/shop/order/list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&groupCode=nabidky&assigneeEmail=petrhlavaty%40divadelnisluzby.cz&customerEmail=jan%40example.com&statusCode=nabidka-odeslana%2Cnabidka-prijata&excludeStatusCode=nabidka-nahrazena&tag=nabidka%3ANAB-2026-0987&page=1&limit=20" \
  -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