/api/v1/shop/order/create

Create a new order. After create a order, please redirect customer to links.orderPageLink.

customer is the payer; issuerCustomer (optional) is the issuer — if omitted, the issuer is the organisation.

post

Tags:order

Operation ID: postApiV1ShopOrderCreate

Query Parameters

apiKeystring

required

Your BizKitHub API key (passed as GET parameter)

Get API Key →

Body

customerobject

required

Paying customer (payer). This customer pays the order and is used as the primary billing entity. If the specified customer account does not exist, the system will automatically create a new customer and link it to the order.

issuerCustomerobject

optional

Order issuer. The party that issues the order (e.g. delegated purchase or invoicing). Use only when the order is issued by a specific customer. For common e-shop orders, this field should be omitted — the issuer is the organisation by default. If the specified customer does not exist, the system will automatically create one.

copyCustomersarray

optional

List of alternative e-mails of customers for e-mail copy.

cartIdstring

optional

Example: "b411056d304d9y6mHe2SoMFBL2Apxfnb"

itemsarray

required

orderGroupIdstring

optional

Organisation defined order group code.

Example: "branch-vinohrady"

localestring

optional

Communication locale code used to filter content.

Supported locales: cs, en, fr, it, pl, de, sk, sv, es, zh, ja, uk, da.

Example: "cs"

currencystring

optional

Main currency used for all items and payments in this order.

Example: "CZK"

salenumber

optional

Absolute value in order-defined currency.

voucherListarray

optional

List of voucher codes to apply to the order.

paymentMethodstring

optional

Payment strategy.

credits (default): Uses customer credits first, remaining amount is paid with money.
money: Forces full payment with money only; customer credits are ignored.

deliveryPricenumber

optional

Absolute value in order-defined currency.

Example: 10

paymentPricenumber

optional

Absolute value in order-defined currency.

Example: 0

expirationDatestring

optional

Example: "2024-05-01T10:00:00.000Z"

dueDatestring

optional

Example: "2024-05-01T10:00:00.000Z"

internalNoticestring

optional

Your internal notice for organisation members. Customer should never see this notice.

publicNoticestring

optional

Public notice defined by customer in cart. This notice can be displayed in e-mail and order detail page.

tagsobject

optional

returnUrlstring

optional

Example: "https://gymroom.cz/rezervace/dekujeme"

notificationUrlstring

optional

formDataobject

optional

forceIgnoreNegativeCreditBalanceboolean

optional

Mark the order as paid immediately. The customer can go into negative credit. Payment will not be processed.

forceIssueInvoiceboolean

optional

Responses

200

No description

Base URL:

https://bizkithub.com

Example Request

fetch('https://bizkithub.com/api/v1/shop/order/create?apiKey=YOUR_API_KEY', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
        "customer": {
            "email": "jan@barasek.com",
            "name": "Jan Barášek",
            "firstName": "Jan",
            "lastName": "Barášek",
            "phone": "+420 777123456",
            "companyName": "BRJ",
            "companyRegistrationNumber": "05103118",
            "taxIdentificationNumber": "CZ9609040727",
            "streetAddress": "R. Novotného 1505",
            "city": "Kladno",
            "cityPart": "Kročehlavy",
            "stateRegion": "Středočeský kraj",
            "postalCode": "272 01",
            "country": "CZ",
            "newsletter": false,
            "primaryLocale": "cs",
            "groups": [],
            "customerRealIp": "1.1.1.1",
            "referralId": "1cGIHvFoQDGLAbcA"
        },
        "issuerCustomer": {
            "email": "jan@barasek.com",
            "name": "Jan Barášek",
            "firstName": "Jan",
            "lastName": "Barášek",
            "phone": "+420 777123456",
            "companyName": "BRJ",
            "companyRegistrationNumber": "05103118",
            "taxIdentificationNumber": "CZ9609040727",
            "streetAddress": "R. Novotného 1505",
            "city": "Kladno",
            "cityPart": "Kročehlavy",
            "stateRegion": "Středočeský kraj",
            "postalCode": "272 01",
            "country": "CZ",
            "newsletter": false,
            "primaryLocale": "cs",
            "groups": [],
            "customerRealIp": "1.1.1.1",
            "referralId": "1cGIHvFoQDGLAbcA"
        },
        "copyCustomers": [
            "janbarasek@gmail.com"
        ],
        "cartId": "b411056d304d9y6mHe2SoMFBL2Apxfnb",
        "items": [],
        "orderGroupId": "branch-vinohrady",
        "locale": "cs",
        "currency": "CZK",
        "sale": 1,
        "voucherList": [
            "SUMMER-15"
        ],
        "paymentMethod": "example_paymentMethod",
        "deliveryPrice": 10,
        "paymentPrice": 0,
        "expirationDate": "2024-05-01T10:00:00.000Z",
        "dueDate": "2024-05-01T10:00:00.000Z",
        "internalNotice": "example_internalNotice",
        "publicNotice": "example_publicNotice",
        "tags": null,
        "returnUrl": "https://gymroom.cz/rezervace/dekujeme",
        "notificationUrl": "example_notificationUrl",
        "formData": {
            "code": "example_code",
            "data": null
        },
        "forceIgnoreNegativeCreditBalance": false,
        "forceIssueInvoice": false
    })
})

Example Response

HTTP 200Success Response

{
  "orderNumber": "25000087",
  "hash": "sSO98YxzR4KJiOu66Jn6K3wRwa4FPI7S",
  "links": {
    "orderPageLink": "https://brj.app/order?hash=sSO98YxzR4KJiOu66Jn6K3wRwa4FPI7S",
    "payLink": "https://brj.app/order/pay?hash=sSO98YxzR4KJiOu66Jn6K3wRwa4FPI7S"
  }
}

🔑 API Key Required

All BizKitHub API endpoints require authentication using an API key. The API key must be passed as a GET parameter in the URL for all requests.

Get API Key →API Overview →

Back to API Documentation

Last updated: January 2, 2026