/api/v1/shop/order/create
Create a new order. After create a order, please redirect customer to links.orderPageLink.
postApiV1ShopOrderCreateQuery Parameters
Body
customerobjectLink order to customer account. When account does not exist, system will create new automatically.
copyCustomersarrayList of alternative e-mails of customers for e-mail copy.
cartIdstringExample: "b411056d304d9y6mHe2SoMFBL2Apxfnb"itemsarrayorderGroupIdstringOrganisation defined order group code.
Example: "branch-vinohrady"localestringCommunication locale for notifications and payment gateway.
Example: "cs"currencystringMain currency used for all items and payments in this order.
Example: "CZK"salenumberAbsolute value in order-defined currency.
paymentMethodstringdeliveryPricenumberAbsolute value in order-defined currency.
paymentPricenumberAbsolute value in order-defined currency.
expirationDatestringExample: "2024-05-01T10:00:00.000Z"dueDatestringExample: "2024-05-01T10:00:00.000Z"internalNoticestringYour internal notice for organisation members. Customer should never see this notice.
publicNoticestringPublic notice defined by customer in cart. This notice can be displayed in e-mail and order detail page.
tagsobjectreturnUrlstringExample: "https://gymroom.cz/rezervace/dekujeme"notificationUrlstringformDataobjectforceIgnoreNegativeCreditBalancebooleanMark the order as paid immediately. The customer can go into negative credit. Payment will not be processed.
Responses
No description
https://bizkithub.comExample 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": "Česká republika",
"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,
"deliveryPrice": 1,
"paymentPrice": 1,
"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
})
})Example 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.