BizKitHub
DocsAPI ReferenceOrder/api/v1/shop/order/detail-full
getOrderPublic API v1

/api/v1/shop/order/detail-full

Full order detail for the organisation that owns the API key: the list fields plus formData exactly as submitted to POST /order/create, the internal notice and the items. Requires the API key; an order of another organisation returns 404. The public GET /order/detail (by hash, for customers) never returns formData.

ordergetApiV1ShopOrderDetail-full

Parameters

2 query

Query parameters

· 2
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
hashstringRequired

Order hash.

ExampleDIeJ1W5NBF0KEXtamL9zpx5Hk3s79008

Response schema

1 status code documented

200Success
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
formDataobject | nullRequired
One of 2:
Variant 1

The formData sent to POST /order/create, returned exactly as submitted. null when none was sent.

codestringRequired
Examplenabidkovac
dataobjectRequired
Variant 2
null
internalNoticestring | nullRequired
One of 2:
Variant 1
string

Organisation-internal note.

Variant 2
null
publicNoticestring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
dueDatestring | nullRequired
One of 2:
Variant 1
stringdate-time
Variant 2
null
expirationDatestring | nullRequired
One of 2:
Variant 1
stringdate-time
Variant 2
null
itemsobject[]Required
Each array item:
labelstringRequired
countnumberRequired
unitPriceWithVatnumberRequired
salenumberRequired

Discount per unit including VAT.

vatnumberRequired

VAT rate in percent.

isStornobooleanRequired

Response example

application/json
{
  "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"
    }
  ],
  "items": [
    {
      "label": "example_label",
      "count": 0,
      "unitPriceWithVat": 0,
      "sale": 0,
      "vat": 0,
      "isStorno": false
    }
  ]
}

Request example

GET /api/v1/shop/order/detail-full

get
curl -X GET "https://api.bizkithub.com/api/v1/shop/order/detail-full?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&hash=DIeJ1W5NBF0KEXtamL9zpx5Hk3s79008" \
  -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