BizKitHub Developer Documentation

Parameters

2 query

Query parameters

· 2

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

Response schema

1 status code documented

200SuccessList of customer addresses.

itemsobject[]Required

Array of address objects.

Each array item:

idstringRequired

Address external identifier (core__address.external_id).

Example6IU2SWgP76FO2UXw

typestringOptional

Address type code. Common values: delivery, billing, contact, invoice.

Examplesdeliverybillingcontact

firstNamestringOptional

First name of the person.

lastNamestringOptional

Last name of the person.

companyNamestringOptional

Company name (for business addresses).

companyRegistrationNumberstringOptional

Company registration number (IČO in CZ, similar in other countries).

taxIdentificationNumberstringOptional

Tax identification number (DIČ in CZ, VAT ID in EU).

streetAddressstringOptional

Street name and house number.

citystringOptional

City name.

cityPartstringOptional

City district or part.

stateRegionstringOptional

State or region name.

postalCodestringOptional

Postal/ZIP code.

countrystringOptional

ISO 3166-1 alpha-2 country code.

ExamplesCZSKUS

noticestringOptional

Additional notes or delivery instructions.

defaultAddressbooleanRequired

True if this is the default address for the contact.

itemCountnumberRequired

Total number of addresses.

Response example

application/json

{
  "items": [
    {
      "id": "6IU2SWgP76FO2UXw",
      "type": "delivery",
      "firstName": "example_firstName",
      "lastName": "example_lastName",
      "companyName": "example_companyName",
      "companyRegistrationNumber": "example_companyRegistrationNumber",
      "taxIdentificationNumber": "example_taxIdentificationNumber",
      "streetAddress": "example_streetAddress",
      "city": "example_city",
      "cityPart": "example_cityPart",
      "stateRegion": "example_stateRegion",
      "postalCode": "example_postalCode",
      "country": "CZ",
      "notice": "example_notice",
      "defaultAddress": false
    }
  ],
  "itemCount": 0
}

/api/v1/address/list