Docs API Reference Order/api/v1/shop/order/create

postOrderPublic API v1

/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.

orderpostApiV1ShopOrderCreate

Parameters

1 query · 25 body

26 total

Query · 1

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

Body · 25

customerobjectRequired19 fields

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.

issuerCustomerobject19 fields

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.

copyCustomersstring[]

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

cartIdstring

itemsobject[]Required12 fields

orderGroupIdstring

Organisation defined order group code.

kind"commerce" | "registration"

Behavioral category of the order. Decides which automatic workflows apply:

commerce (default): standard order; invoice/receipt is auto-issued by the status rule engine when the chosen status configures it. The customer receives the standard order-status notification.
registration: order represents a sign-up for an event / form-style admission. No tax document is ever auto-issued (manual admin action via BFF can still issue one). The status rule engine will NOT auto-fire mark_as_paid / create_invoice / create_receipt for this order. The customer receives a registration-confirmation email when the per-group or kind-specific notification template is configured (falls back to standard order-status template if not). Typically combined with all items priced at 0 and a dedicated organisation-defined order group for pairing.

Values: commerceregistration

Default: commerce

localestring

Communication locale code used to filter content.

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

Length: 2–2

currencystring

Currency code. Format: 3-letter uppercase code (e.g. CZK).
Supported values: CZK, EUR, USD.

salenumber

Absolute value in order-defined currency.

voucherListstring[]

List of voucher codes to apply to the order.

paymentMethod"credits" | "money"

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.

Values: creditsmoney

Default: credits

deliveryPricenumber

Absolute value in order-defined currency.

paymentPricenumber

Absolute value in order-defined currency.

expirationDatestring

Format: date-time

dueDatestring

Format: date-time

internalNoticestring

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

publicNoticestring

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

tagsobject

returnUrlstring

notificationUrlstring

formDataobject2 fields

forceIgnoreNegativeCreditBalanceboolean

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

Default: false

forceIssueInvoiceboolean

Default: false

parentIdstring

Hash of the parent order. The parent order must belong to the same organisation.

Length: 32–32

Request

POST /api/v1/shop/order/create

post

curl -X POST "https://api.bizkithub.com/api/v1/shop/order/create?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "customer": {
    "email": "jan@barasek.com",
    "name": "Jan Barášek",
    "firstName": "Jan",
    "lastName": "Barášek",
    "phone": "+420 777123456",
    "companyName": "BizKitHub",
    "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": [
      "string"
    ],
    "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": "BizKitHub",
    "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": [
      "string"
    ],
    "customerRealIp": "1.1.1.1",
    "referralId": "1cGIHvFoQDGLAbcA"
  },
  "copyCustomers": [
    "janbarasek@gmail.com"
  ],
  "cartId": "b411056d304d9y6mHe2SoMFBL2Apxfnb",
  "items": [
    {
      "label": "Cheese burger",
      "price": 0,
      "vat": 0,
      "count": 0,
      "sale": 10,
      "unit": "ks",
      "productCode": "burger",
      "variantCode": "cheese-burger",
      "eventCode": "2WRp6X5rSqQa321EjHB2mxZz74u74H84",
      "creditAmount": 100,
      "specialActions": "create-voucher:fixed:500;add-credit:15",
      "branch": "gymroom-plzen"
    }
  ],
  "orderGroupId": "branch-vinohrady",
  "kind": "commerce",
  "locale": "cs",
  "currency": "CZK",
  "sale": 0,
  "voucherList": [
    "SUMMER-15"
  ],
  "paymentMethod": "credits",
  "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": {},
  "returnUrl": "https://gymroom.cz/rezervace/dekujeme",
  "notificationUrl": "example_notificationUrl",
  "formData": {
    "code": "example_code",
    "data": {}
  },
  "forceIgnoreNegativeCreditBalance": false,
  "forceIssueInvoice": false,
  "parentId": "sSO98YxzR4KJiOu66Jn6K3wRwa4FPI7S"
}'

Response

JSON payload

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

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key