Parameters
1 query
Query parameters
· 1idstringRequiredExternal address identifier.
Example
addr_abc123AddressgetBffAddressDetail
Response schema
1 status code documented
200SuccessAddress detail.
idstringRequiredUnique external address identifier.
Example
addr_abc123typestringOptionalAddress type: accounting, billing, deliveryGoods or deliveryInvoice.
Example
billingfirstNamestringOptionalFirst name.
Example
JanlastNamestringOptionalLast name.
Example
NovákcompanyNamestringOptionalCompany name.
Example
Acme s.r.o.companyRegistrationNumberstringOptionalCompany registration number (IČO).
Example
05103118taxIdentificationNumberstringOptionalTax identification number (DIČ).
Example
CZ9609040727streetAddressstringOptionalStreet and house number.
Example
Vodičkova 36citystringOptionalCity name.
Example
PrahacityPartstringOptionalCity part or district.
Example
Nové MěstostateRegionstringOptionalState or region.
Example
Středočeský krajpostalCodestringOptionalPostal / ZIP code.
Example
11000countrystringOptionalISO 3166-1 alpha-2 country code.
Example
CZnoticestringOptionalInternal note about the address.
frozenAtstringOptionalISO timestamp when this address was frozen into an immutable snapshot referenced by an order/invoice. When present, admin UI must hide the edit affordance and render a "Read-only snapshot" badge — the DB trigger rejects any mutation attempt anyway.
Response example
application/json{
"id": "addr_abc123",
"type": "billing",
"firstName": "Jan",
"lastName": "Novák",
"companyName": "Acme s.r.o.",
"companyRegistrationNumber": "05103118",
"taxIdentificationNumber": "CZ9609040727",
"streetAddress": "Vodičkova 36",
"city": "Praha",
"cityPart": "Nové Město",
"stateRegion": "Středočeský kraj",
"postalCode": "11000",
"country": "CZ",
"notice": "example_notice",
"frozenAt": "example_frozenAt"
}Request example
GET /bff/address/detail
curl -X GET "https://api.bizkithub.com/bff/address/detail?id=addr_abc123" \
-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.