BizKitHub
DocsAPI ReferenceOrder/bff/order/create
postOrderAdmin BFF

/bff/order/create

Creates a new order from admin panel (POS mode). By default creates a draft/cart that can be edited before confirmation. Set startAsCart=false to create a confirmed order immediately.

OrderpostBffOrderCreate

Parameters

JSON body

Request body

application/json
orderGroupIdstringOptional

Order group code (e.g., "default", "eshop").

customerobjectOptional

Customer information for the order.

emailstringRequired

Contact email address.

The system validates the input as a standard email address and automatically applies normalization and canonicalization.

All API responses return the normalized form, and each email address is unique per organisation within the system.

Phone-only contacts: Since 2026-06-10 a contact may exist without an e-mail when it was registered only by phone (e.g. imports of phone-only records). Responses that expose such contacts use API_EMAIL_NULLABLE instead, where this field can be null. Endpoints that accept e-mail as input still require a valid value here — phone-only creation goes through admin-only import / BFF flows.

Examplejan@barasek.com
firstNamestringOptional

Customer first name.

lastNamestringOptional

Customer last name.

phonestringOptional

Customer phone number.

companyNamestringOptional

Company name for B2B orders.

companyRegistrationNumberstringOptional

Company registration number (IČO).

taxIdentificationNumberstringOptional

Tax ID (DIČ).

streetAddressstringOptional

Street address.

citystringOptional

City.

postalCodestringOptional

Postal/ZIP code.

countrystringOptional

Country code (e.g., "CZ", "SK").

itemsobject[]Optional

List of order items.

Each array item:

Order item.

labelstringRequired

Item label/name displayed on invoice.

pricenumberOptional

Unit price including VAT.

vatnumberOptional

VAT rate in percent (e.g., 21).

countnumberOptional

Quantity. Defaults to 1.

salenumberOptional

Discount amount per item.

unitstringOptional

Unit of measure (e.g., "ks", "hod").

productCodestringOptional

Product code to link item to product.

variantCodestringOptional

Product variant code.

eventCodestringOptional

Calendar event code for event tickets.

creditAmountnumberOptional

Credit amount if item adds credit.

localestringOptional

Communication locale code — controls the language of textual data (product names, descriptions, articles, storefront UI, transactional e-mails).

Preferred format: BCP 47 language tag — language[-Script][-REGION]. Use the full tag whenever the script or region matters:

  • en-GB vs. en-US (British vs. American spelling)
  • pt-PT vs. pt-BR (European vs. Brazilian Portuguese)
  • zh-Hans vs. zh-Hant (Simplified vs. Traditional Chinese)
  • sr-Latn vs. sr-Cyrl (Latin vs. Cyrillic Serbian)

Backwards-compatible fallback: the bare two-letter ISO 639-1 code (cs, en, pl, …) is accepted indefinitely — legacy clients that only send the language subtag continue to work unchanged.

Resolution algorithm (server-side): the input is resolved against the supported locale list via the [RFC 4647 Lookup] progressive-fallback strategy — trailing subtags are stripped one by one until a supported locale is found. Example: en-GB-oxendict → en-GB → en (matched). If no subtag combination is supported, the request is rejected.

Currently supported locales: cs, en, fr, it, pl, de, sk, sv, es, zh, ja, uk, da, hu, ro, nl, pt, fi, nb, hr. Region-specific variants (e.g. en-GB, pt-BR) are accepted and resolved to their base language when the exact variant is not registered separately.

Length: 2–35
Examplescsenen-GBpt-BRzh-Hans
currencystringOptional

Currency code (e.g., "CZK", "EUR"). Defaults to organisation currency.

salenumberOptional

Global discount amount for the entire order.

paymentMethod"credits" | "money"Optional

Payment method: "credits" for credit balance, "money" for standard payment.

deliveryPricenumberOptional

Delivery/shipping price.

paymentPricenumberOptional

Payment processing fee.

internalNoticestringOptional

Internal note visible only to staff.

publicNoticestringOptional

Public note visible to customer.

tagsobjectOptional

Tags to attach to the order.

ignoreNotificationbooleanOptional

Skip sending order confirmation email. Defaults to true.

startAsCartbooleanOptional

Create order as draft/cart (true) or as new order (false). Defaults to false.

preventAutoPaymentbooleanOptional

Prevent automatic marking as paid when order price is 0. Defaults to true.

Response schema

1 status code documented

200SuccessOrder created successfully.
successbooleanRequired
Default: true
hashstringRequired

Order hash for subsequent operations.

orderNumberstringRequired

Human-readable order number.

Response example

application/json
{
  "success": true,
  "hash": "example_hash",
  "orderNumber": "example_orderNumber"
}

Request example

POST /bff/order/create

post
curl -X POST "https://api.bizkithub.com/bff/order/create" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "orderGroupId": "example_orderGroupId",
  "customer": {
    "email": "jan@barasek.com",
    "firstName": "example_firstName",
    "lastName": "example_lastName",
    "phone": "example_phone",
    "companyName": "example_companyName",
    "companyRegistrationNumber": "example_companyRegistrationNumber",
    "taxIdentificationNumber": "example_taxIdentificationNumber",
    "streetAddress": "example_streetAddress",
    "city": "example_city",
    "postalCode": "example_postalCode",
    "country": "example_country"
  },
  "items": [
    {
      "label": "example_label",
      "price": 0,
      "vat": 0,
      "count": 0,
      "sale": 0,
      "unit": "example_unit",
      "productCode": "example_productCode",
      "variantCode": "example_variantCode",
      "eventCode": "example_eventCode",
      "creditAmount": 0
    }
  ],
  "locale": "cs",
  "currency": "example_currency",
  "sale": 0,
  "deliveryPrice": 0,
  "paymentPrice": 0,
  "internalNotice": "example_internalNotice",
  "publicNotice": "example_publicNotice",
  "tags": {},
  "ignoreNotification": false,
  "startAsCart": false,
  "preventAutoPayment": false
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key