1. How to start using api
-
Get credentials (user, password and companyId) by creating a new "api-user" in your account settings. https://app.liefersoft.de/settings/program/platform/api
-
Get access token using login endpoint. The token is valid for 5 minutes.
-
Add access token to Authorization header for each request using plugin API
2. Platform order lifecycle
The Liefersoft platform provides two methods for tracking the status of an order. We recommend using our webhook option for status updates. This allows you to receive automatic notifications of any changes in order status, eliminating the need for frequent API calls.
Alternatively, you can retrieve the status of an order manually using the get-order endpoint. If you choose this method, please note that we recommend polling no more than every 2 minutes.
The Liefersoft platform contains CRUD endpoints for managing the webhooks.
ACCEPTED - immediately after the order has been successfully transferred to the platform
PROCESSING - when the regular order has been confirmed by the restaurant employee
CANCELED - when the order has been canceled by the restaurant employee
PROCESSED - when the order has been successfully processed.
PROCESSING_ERROR - when any internal error occurred
3. Authorization
3.1. Login
$ curl 'https://api.liefersoft.de/login' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-d '{"login":"some.user@example.com","password":"abc-123-pass","companyId":"71d53cad-7e6d-4912-96b3-3efb599f81be"}'POST /login HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 110
Host: api.liefersoft.de
{"login":"some.user@example.com","password":"abc-123-pass","companyId":"71d53cad-7e6d-4912-96b3-3efb599f81be"}| Path | Type | Description |
|---|---|---|
|
|
Plugin user login. Must not be empty. |
|
|
Current company applicationId. Must not be null. |
|
|
Generated password. Must not be empty. |
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1929
{"accessToken":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM"}| Path | Type | Description |
|---|---|---|
|
|
Jwt access token. Must not be empty. |
Note: Each integration works independently, which means you must configure webhooks separately for each integration (if supported). For example, if one company has three integrations, you will need to use unique credentials for each one to manage the connection, provide orders, and so on. If you need support for multiple companies, please contact your manager.
4. Order
4.1. Create order
$ curl 'https://api.liefersoft.de/orders' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM' \
-d '{"orderId":"123-444","preOrder":"2025-11-07T16:45:20.445932361Z","orderType":"DELIVERY","platformName":"Pizza Netz","customer":{"companyName":"Smith Ltd","name":"John Smith","street":"Main Street","streetNumber":"2","city":"Hamburg","postalCode":"21563","phoneNumber":"987368676","extraAddressInfo":"1st floor.","remark":"customer remark"},"deliveryCost":{"cost":1.5},"totalPrice":18.0,"totalDiscount":2.0,"payed":true,"tips":2.5,"paymentFee":0.0,"paymentMethod":"ONLINE","remark":"please call me before you come","items":[{"itemCode":"11b","quantity":2,"price":5.0,"initialPrice":5.0,"name":"Pizza Margarita","itemType":"MAIN_DISH","remark":"no chilly","category":"Pizza","taxData":{"type":"NORMAL","rate":19.0},"items":[]},{"itemCode":"c1l","quantity":2,"price":3.0,"initialPrice":3.0,"name":"Cola","itemType":"BEVERAGE","remark":"remark1","category":"Drink","taxData":{"type":"NORMAL","rate":19.0},"items":[]}]}'POST /orders HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM
Content-Length: 914
Host: api.liefersoft.de
{"orderId":"123-444","preOrder":"2025-11-07T16:45:20.445932361Z","orderType":"DELIVERY","platformName":"Pizza Netz","customer":{"companyName":"Smith Ltd","name":"John Smith","street":"Main Street","streetNumber":"2","city":"Hamburg","postalCode":"21563","phoneNumber":"987368676","extraAddressInfo":"1st floor.","remark":"customer remark"},"deliveryCost":{"cost":1.5},"totalPrice":18.0,"totalDiscount":2.0,"payed":true,"tips":2.5,"paymentFee":0.0,"paymentMethod":"ONLINE","remark":"please call me before you come","items":[{"itemCode":"11b","quantity":2,"price":5.0,"initialPrice":5.0,"name":"Pizza Margarita","itemType":"MAIN_DISH","remark":"no chilly","category":"Pizza","taxData":{"type":"NORMAL","rate":19.0},"items":[]},{"itemCode":"c1l","quantity":2,"price":3.0,"initialPrice":3.0,"name":"Cola","itemType":"BEVERAGE","remark":"remark1","category":"Drink","taxData":{"type":"NORMAL","rate":19.0},"items":[]}]}| Path | Type | Description |
|---|---|---|
|
|
Custom order id. Must not be empty. Size must be between 1 and 255 inclusive. |
|
|
Order type based on delivery type. Existing values: COUNTER, PICKUP, DELIVERY, RESTAURANT. Must not be null. |
|
|
Order total price including discounts and delivery costs without tips. Must be positive. |
|
|
Order total discount. Must be positive or zero. Default: 0. |
|
|
Order payment method type. Existing values: CASH, MEAL_VOUCHER, ONLINE, CREDIT_CARD_AT_DOORSTEP, EC_AT_DOORSTEP. Must not be null. |
|
|
Any general remarks about the order. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
The order has been paid already. |
|
|
The Tips additional to total price . Must be positive or zero. Default: 0. |
|
|
The payment fee value . Must be positive or zero. Default: 0. |
|
|
Delivery or pickup time ISO8601 (yyyy-MM-dd’T’HH:mm:ss.SSSX) requested by customer. This value must be less than 7 days from current time. Example: 2021-03-10T16:34:09Z, 2021-03-10T14:34:09+02:00. Default: null. |
|
|
The name of client/producer. ex. the_best_web_shop_ever |
|
|
Company name. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Name of customer. |
|
|
Customer street. |
|
|
Customer street number. |
|
|
Customer city. |
|
|
Customer postal code. Must match the regular expression |
|
|
Customer phone number. Must match the regular expression |
|
|
Customer additional address (delivery) information. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Any remark for customer eg. 1st floor, etc. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Order delivery costs. Must be positive or zero. |
|
|
List of included order items. Must not be empty. |
|
|
SKU or product identity in your system. Size must be between 1 and 36 inclusive. Default: null. |
|
|
Product type. MAIN_DISH - main dish, for example Pizza, Soup, Salad. Used to calculate taxes for the main dish. taxed with REDUCED_TAX (eg. 7% in Germany) TOPPING - An additive to the main dish, for example Cheese, Tomato, Sauce. Used to calculate taxes for the additive. taxed with REDUCED_TAX (eg. 7% in Germany) BEVERAGE - beverage. Used to calculate taxes for a beverage. BOTTLE_DEPOSIT - container from the beverage. Used to calculate taxes for bottle deposit. taxed with BOTTLE_DEPOSIT (eg. 19% in Germany) MENU - combo menu. Used to calculate taxes for the menu. If all products in this MENU have "initialPrice“, then the mix tax will be calculated. Example: For Main dishes and toppings "MAIN_DISH", "TOPPING" will taken the Reduced_tax (eg. 7% in Germany) and for beverages "BEVERAGE" will taken Normal_tax (eg. 19% in Germany) If at least one product in menu dosen’t have an initial price, then: if menu containt at least one BEVERAGE, then the whole menu is taxed with Normal_tax (eg. 19% in Germany). If no drink is in the order, than all menu is taxed with Reduced_tax (eg. 7% in Germany). . Existing values: TOPPING, MAIN_DISH, BEVERAGE, BOTTLE_DEPOSIT, MENU. |
|
|
Individual initial price of the product is used to calculate the tax for the MENU. If all products in this MENU have "initialPrice“, then the mix tax will be calculated. Example: For Main dishes and toppings "MAIN_DISH", "TOPPING" will taken the Reduced_tax (eg. 7% in germany) and for beverages "BEVERAGE" will taken Normal_tax (eg. 19% in Germany) If at least one product in menu dosen’t have an initial price, then: if menu containt at least one BEVERAGE, then the whole menu is taxed with Normal_tax (eg. 19% in germany). If no drink is in the order, than all menu is taxed with Reduced_tax (eg. 7% in Germany).. |
|
|
Count of ordered products. Should be whole numbers excluding zero |
|
|
Name of product. Must not be empty. |
|
|
Product individual price, exclude side dishes. Must be positive or zero. |
|
|
Product specific remarks. Size must be between 1 and 2147483647 inclusive. |
|
|
Product category name. Size must be between 1 and 2147483647 inclusive. |
|
|
List of subItems. |
|
|
Product tax data. |
|
|
Product tax type. Existing values: NORMAL, REDUCED. Must not be null. |
|
|
Product tax rate in percents. Must not be null. |
HTTP/1.1 202 Accepted
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 64
{"remoteResponse":{"id":"8c5cbd97-200f-4973-9c9d-68aa3e06303d"}}| Path | Type | Description |
|---|---|---|
|
|
The generated unique identity of order |
4.2. Get order
$ curl 'https://api.liefersoft.de/orders/bk5678-sa' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM'GET /orders/bk5678-sa HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM
Host: api.liefersoft.de| Parameter | Description |
|---|---|
|
The generated unique identifier of order |
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1147
{"orderId":"123-444","preOrder":"2019-08-10T18:40:00Z","orderType":"DELIVERY","platformName":"Pizza Netz","customer":{"companyName":"Smith Ltd","name":"John Smith","street":"Main Street","streetNumber":"2","city":"Hamburg","postalCode":"21563","phoneNumber":"987368676","extraAddressInfo":"1st floor.","remark":"customer remark"},"deliveryCost":{"cost":1.5},"totalPrice":15.5,"totalDiscount":2.0,"payed":true,"tips":2.5,"paymentFee":0.0,"paymentMethod":"ONLINE","remark":"please call me before you come","items":[{"itemCode":"11b","quantity":2,"price":5.0,"initialPrice":5.0,"name":"Pizza Margarita","itemType":"MAIN_DISH","remark":"no chilly","category":"Pizza","taxData":{"type":"NORMAL","rate":19.0},"items":[]},{"itemCode":"c1l","quantity":2,"price":3.0,"initialPrice":3.0,"name":"Cola","itemType":"BEVERAGE","remark":"remark1","category":"Drink","taxData":{"type":"NORMAL","rate":19.0},"items":[]}],"id":"bk5678-sa","platformStatus":"PROCESSED","estimatedProcessTimestamp":"2020-10-15T00:00:00Z","createdDate":"2020-10-11T00:00:00","modifiedDate":"2020-10-11T00:00:00","createdBy":"some.user@example.com","modifiedBy":"some.user@example.com"}| Path | Type | Description |
|---|---|---|
|
|
The unique technical identifier of order. Must not be empty. |
|
|
Custom unique technical identifier of order (ref id). Must not be empty. Size must be between 1 and 255 inclusive. |
|
|
The name of client/producer. ex. the_best_web_shop_ever |
|
|
Order type based on delivery type. Existing values: COUNTER, PICKUP, DELIVERY, RESTAURANT. Must not be null. |
|
|
Order total price including discounts and delivery costs. Must be positive. |
|
|
Order total discount. Must be positive or zero. Default: 0. |
|
|
Order payment method. Existing values: CASH, MEAL_VOUCHER, ONLINE, CREDIT_CARD_AT_DOORSTEP, EC_AT_DOORSTEP. Must not be null. |
|
|
Any general remarks about the order. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
The order has been paid already. |
|
|
The Tips additional to total price . Must be positive or zero. Default: 0. |
|
|
The payment fee value . Must be positive or zero. Default: 0. |
|
|
Delivery or pickup time ISO8601 (yyyy-MM-dd’T’HH:mm:ss.SSSX) requested by customer. This value must be less than 7 days from current time. Example: 2021-03-10T16:34:09Z, 2021-03-10T14:34:09+02:00. Default: null. |
|
|
Order platform status. Existing values: ACCEPTED, PROCESSING, PROCESSED, CANCELED, PROCESSING_ERROR. Must not be null. |
|
|
Order creation date. Must not be null. |
|
|
Order modification date. Must not be null. |
|
|
Order created by. Must not be empty. |
|
|
Order modification by. Must not be empty. |
|
|
Order estimated processing time. |
|
|
Company name. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Name of customer. |
|
|
Customer street. |
|
|
Customer street number. |
|
|
Customer city. |
|
|
Customer postal code. Must match the regular expression |
|
|
Customer phone number. Must match the regular expression |
|
|
Customer additional address (delivery) information. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Any remark for customer eg. 1st floor, etc. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Order delivery costs. Must be positive or zero. |
|
|
List of included order items. Must not be empty. |
|
|
SKU or product identity in your system. Size must be between 1 and 36 inclusive. Default: null. |
|
|
Product type. MAIN_DISH - main dish, for example Pizza, Soup, Salad. Used to calculate taxes for the main dish. taxed with REDUCED_TAX (eg. 7% in Germany) TOPPING - An additive to the main dish, for example Cheese, Tomato, Sauce. Used to calculate taxes for the additive. taxed with REDUCED_TAX (eg. 7% in Germany) BEVERAGE - beverage. Used to calculate taxes for a beverage. BOTTLE_DEPOSIT - container from the beverage. Used to calculate taxes for bottle deposit. taxed with BOTTLE_DEPOSIT (eg. 19% in Germany) MENU - combo menu. Used to calculate taxes for the menu. If all products in this MENU have "initialPrice“, then the mix tax will be calculated. Example: For Main dishes and toppings "MAIN_DISH", "TOPPING" will taken the Reduced_tax (eg. 7% in Germany) and for beverages "BEVERAGE" will taken Normal_tax (eg. 19% in Germany) If at least one product in menu dosen’t have an initial price, then: if menu containt at least one BEVERAGE, then the whole menu is taxed with Normal_tax (eg. 19% in Germany). If no drink is in the order, than all menu is taxed with Reduced_tax (eg. 7% in Germany). . Existing values: TOPPING, MAIN_DISH, BEVERAGE, BOTTLE_DEPOSIT, MENU. |
|
|
Individual initial price of the product is used to calculate the tax for the MENU. If all products in this MENU have "initialPrice“, then the mix tax will be calculated. Example: For Main dishes and toppings "MAIN_DISH", "TOPPING" will taken the Reduced_tax (eg. 7% in germany) and for beverages "BEVERAGE" will taken Normal_tax (eg. 19% in Germany) If at least one product in menu dosen’t have an initial price, then: if menu containt at least one BEVERAGE, then the whole menu is taxed with Normal_tax (eg. 19% in germany). If no drink is in the order, than all menu is taxed with Reduced_tax (eg. 7% in Germany).. |
|
|
Count of ordered products. Should be whole numbers excluding zero |
|
|
Name of product. Must not be empty. |
|
|
Product individual price, exclude side dishes. Must be positive or zero. |
|
|
Product specific remarks. Size must be between 1 and 2147483647 inclusive. |
|
|
Product category name. Size must be between 1 and 2147483647 inclusive. |
|
|
List of subItems. |
|
|
Product tax data. |
|
|
Product tax type. Existing values: NORMAL, REDUCED. Must not be null. |
|
|
Product tax rate in percents. Must not be null. |
4.3. Get all orders
$ curl 'https://api.liefersoft.de/orders?page=1&size=2' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM'GET /orders?page=1&size=2 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM
Host: api.liefersoft.de| Parameter | Description |
|---|---|
|
The page to retrieve |
|
The number of elements within a single page |
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Orders-Total: 1
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1147
[{"orderId":"123-444","preOrder":"2019-08-10T18:40:00Z","orderType":"DELIVERY","platformName":"Pizza Netz","customer":{"companyName":"Smith Ltd","name":"John Smith","street":"Main Street","streetNumber":"2","city":"Hamburg","postalCode":"21563","phoneNumber":"987368676","extraAddressInfo":"1st floor.","remark":"customer remark"},"deliveryCost":{"cost":1.5},"totalPrice":15.5,"totalDiscount":2.0,"payed":true,"tips":2.5,"paymentFee":0.0,"paymentMethod":"ONLINE","remark":"please call me before you come","items":[{"itemCode":"11b","quantity":2,"price":5.0,"initialPrice":5.0,"name":"Pizza Margarita","itemType":"MAIN_DISH","remark":"no chilly","category":"Pizza","taxData":{"type":"NORMAL","rate":19.0},"items":[]},{"itemCode":"c1l","quantity":2,"price":3.0,"initialPrice":3.0,"name":"Cola","itemType":"BEVERAGE","remark":"remark1","category":"Drink","taxData":{"type":"NORMAL","rate":19.0},"items":[]}],"id":"abc-456","platformStatus":"PROCESSED","estimatedProcessTimestamp":"2020-10-15T00:00:00Z","createdDate":"2020-10-11T00:00:00","modifiedDate":"2020-10-11T00:00:00","createdBy":"some.user@example.com","modifiedBy":"some.user@example.com"}]| Path | Type | Description |
|---|---|---|
|
|
The unique technical identifier of order. Must not be empty. |
|
|
Custom unique technical identifier of order (ref id). Must not be empty. Size must be between 1 and 255 inclusive. |
|
|
The name of client/producer. ex. the_best_web_shop_ever |
|
|
Order type based on delivery type. Existing values: COUNTER, PICKUP, DELIVERY, RESTAURANT. Must not be null. |
|
|
Order total price including discounts and delivery costs. Must be positive. |
|
|
Order total discount. Must be positive or zero. Default: 0. |
|
|
Order payment method. Existing values: CASH, MEAL_VOUCHER, ONLINE, CREDIT_CARD_AT_DOORSTEP, EC_AT_DOORSTEP. Must not be null. |
|
|
Any general remarks about the order. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
The order has been paid already. |
|
|
The Tips additional to total price . Must be positive or zero. Default: 0. |
|
|
The payment fee value . Must be positive or zero. Default: 0. |
|
|
Delivery or pickup time ISO8601 (yyyy-MM-dd’T’HH:mm:ss.SSSX) requested by customer. This value must be less than 7 days from current time. Example: 2021-03-10T16:34:09Z, 2021-03-10T14:34:09+02:00. Default: null. |
|
|
Order platform status. Existing values: ACCEPTED, PROCESSING, PROCESSED, CANCELED, PROCESSING_ERROR. Must not be null. |
|
|
Order creation date. Must not be null. |
|
|
Order modification date. Must not be null. |
|
|
Order created by. Must not be empty. |
|
|
Order modification by. Must not be empty. |
|
|
Order estimated processing time. |
|
|
Company name. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Name of customer. |
|
|
Customer street. |
|
|
Customer street number. |
|
|
Customer city. |
|
|
Customer postal code. Must match the regular expression |
|
|
Customer phone number. Must match the regular expression |
|
|
Customer additional address (delivery) information. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Any remark for customer eg. 1st floor, etc. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Order delivery costs. Must be positive or zero. |
|
|
List of included order items. Must not be empty. |
|
|
SKU or product identity in your system. Size must be between 1 and 36 inclusive. Default: null. |
|
|
Product type. MAIN_DISH - main dish, for example Pizza, Soup, Salad. Used to calculate taxes for the main dish. taxed with REDUCED_TAX (eg. 7% in Germany) TOPPING - An additive to the main dish, for example Cheese, Tomato, Sauce. Used to calculate taxes for the additive. taxed with REDUCED_TAX (eg. 7% in Germany) BEVERAGE - beverage. Used to calculate taxes for a beverage. BOTTLE_DEPOSIT - container from the beverage. Used to calculate taxes for bottle deposit. taxed with BOTTLE_DEPOSIT (eg. 19% in Germany) MENU - combo menu. Used to calculate taxes for the menu. If all products in this MENU have "initialPrice“, then the mix tax will be calculated. Example: For Main dishes and toppings "MAIN_DISH", "TOPPING" will taken the Reduced_tax (eg. 7% in Germany) and for beverages "BEVERAGE" will taken Normal_tax (eg. 19% in Germany) If at least one product in menu dosen’t have an initial price, then: if menu containt at least one BEVERAGE, then the whole menu is taxed with Normal_tax (eg. 19% in Germany). If no drink is in the order, than all menu is taxed with Reduced_tax (eg. 7% in Germany). . Existing values: TOPPING, MAIN_DISH, BEVERAGE, BOTTLE_DEPOSIT, MENU. |
|
|
Individual initial price of the product is used to calculate the tax for the MENU. If all products in this MENU have "initialPrice“, then the mix tax will be calculated. Example: For Main dishes and toppings "MAIN_DISH", "TOPPING" will taken the Reduced_tax (eg. 7% in germany) and for beverages "BEVERAGE" will taken Normal_tax (eg. 19% in Germany) If at least one product in menu dosen’t have an initial price, then: if menu containt at least one BEVERAGE, then the whole menu is taxed with Normal_tax (eg. 19% in germany). If no drink is in the order, than all menu is taxed with Reduced_tax (eg. 7% in Germany).. |
|
|
Count of ordered products. Should be whole numbers excluding zero |
|
|
Name of product. Must not be empty. |
|
|
Product individual price, exclude side dishes. Must be positive or zero. |
|
|
Product specific remarks. Size must be between 1 and 2147483647 inclusive. |
|
|
Product category name. Size must be between 1 and 2147483647 inclusive. |
|
|
List of subItems. |
|
|
Product tax data. |
|
|
Product tax type. Existing values: NORMAL, REDUCED. Must not be null. |
|
|
Product tax rate in percents. Must not be null. |
4.4. Get all orders by restarant id
$ curl 'https://api.liefersoft.de/restaurantId-123/orders?page=0&size=5' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM'GET /restaurantId-123/orders?page=0&size=5 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM
Host: api.liefersoft.de| Parameter | Description |
|---|---|
|
Internal unique restaurant identifier |
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1347
{"content":[{"orderId":"123-444","preOrder":"2019-08-10T18:40:00Z","orderType":"DELIVERY","platformName":"Pizza Netz","customer":{"companyName":"Smith Ltd","name":"John Smith","street":"Main Street","streetNumber":"2","city":"Hamburg","postalCode":"21563","phoneNumber":"987368676","extraAddressInfo":"1st floor.","remark":"customer remark"},"deliveryCost":{"cost":1.5},"totalPrice":15.5,"totalDiscount":2.0,"payed":true,"tips":2.5,"paymentFee":0.0,"paymentMethod":"ONLINE","remark":"please call me before you come","items":[{"itemCode":"11b","quantity":2,"price":5.0,"initialPrice":5.0,"name":"Pizza Margarita","itemType":"MAIN_DISH","remark":"no chilly","category":"Pizza","taxData":{"type":"NORMAL","rate":19.0},"items":[]},{"itemCode":"c1l","quantity":2,"price":3.0,"initialPrice":3.0,"name":"Cola","itemType":"BEVERAGE","remark":"remark1","category":"Drink","taxData":{"type":"NORMAL","rate":19.0},"items":[]}],"id":"abc-456","platformStatus":"PROCESSED","estimatedProcessTimestamp":"2020-10-15T00:00:00Z","createdDate":"2020-10-11T00:00:00","modifiedDate":"2020-10-11T00:00:00","createdBy":"some.user@example.com","modifiedBy":"some.user@example.com"}],"pageable":"INSTANCE","last":true,"totalPages":1,"totalElements":1,"size":1,"number":0,"sort":{"empty":true,"sorted":false,"unsorted":true},"first":true,"numberOfElements":1,"empty":false}| Path | Type | Description |
|---|---|---|
|
|
Pageable parameter, page number |
|
|
Pageable parameter, page size |
|
|
Pageable parameter, page isEmpty |
|
|
Pageable parameter, totalElements |
|
|
Pageable parameter, totalPages |
|
|
Pageable parameter, is page last |
|
|
Pageable parameter, numberOfElements |
|
|
Pageable parameter, is page first |
|
|
Pageable parameter, sort object |
|
|
Pageable parameter, is sorted |
|
|
Pageable parameter, is unsorted |
|
|
Pageable parameter, is empty |
|
|
Pageable parameter, object contain type |
|
|
The unique technical identifier of order. Must not be empty. |
|
|
Custom unique technical identifier of order (ref id). Must not be empty. Size must be between 1 and 255 inclusive. |
|
|
The name of client/producer. ex. the_best_web_shop_ever |
|
|
Order type based on delivery type. Existing values: COUNTER, PICKUP, DELIVERY, RESTAURANT. Must not be null. |
|
|
Order total price including discounts and delivery costs. Must be positive. |
|
|
Order total discount. Must be positive or zero. Default: 0. |
|
|
Order payment method. Existing values: CASH, MEAL_VOUCHER, ONLINE, CREDIT_CARD_AT_DOORSTEP, EC_AT_DOORSTEP. Must not be null. |
|
|
Any general remarks about the order. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
The order has been paid already. |
|
|
The Tips additional to total price . Must be positive or zero. Default: 0. |
|
|
The payment fee value . Must be positive or zero. Default: 0. |
|
|
Delivery or pickup time ISO8601 (yyyy-MM-dd’T’HH:mm:ss.SSSX) requested by customer. This value must be less than 7 days from current time. Example: 2021-03-10T16:34:09Z, 2021-03-10T14:34:09+02:00. Default: null. |
|
|
Order platform status. Existing values: ACCEPTED, PROCESSING, PROCESSED, CANCELED, PROCESSING_ERROR. Must not be null. |
|
|
Order creation date. Must not be null. |
|
|
Order modification date. Must not be null. |
|
|
Order created by. Must not be empty. |
|
|
Order modification by. Must not be empty. |
|
|
Order estimated processing time. |
|
|
Company name. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Name of customer. |
|
|
Customer street. |
|
|
Customer street number. |
|
|
Customer city. |
|
|
Customer postal code. Must match the regular expression |
|
|
Customer phone number. Must match the regular expression |
|
|
Customer additional address (delivery) information. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Any remark for customer eg. 1st floor, etc. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Order delivery costs. Must be positive or zero. |
|
|
List of included order items. Must not be empty. |
|
|
SKU or product identity in your system. Size must be between 1 and 36 inclusive. Default: null. |
|
|
Product type. MAIN_DISH - main dish, for example Pizza, Soup, Salad. Used to calculate taxes for the main dish. taxed with REDUCED_TAX (eg. 7% in Germany) TOPPING - An additive to the main dish, for example Cheese, Tomato, Sauce. Used to calculate taxes for the additive. taxed with REDUCED_TAX (eg. 7% in Germany) BEVERAGE - beverage. Used to calculate taxes for a beverage. BOTTLE_DEPOSIT - container from the beverage. Used to calculate taxes for bottle deposit. taxed with BOTTLE_DEPOSIT (eg. 19% in Germany) MENU - combo menu. Used to calculate taxes for the menu. If all products in this MENU have "initialPrice“, then the mix tax will be calculated. Example: For Main dishes and toppings "MAIN_DISH", "TOPPING" will taken the Reduced_tax (eg. 7% in Germany) and for beverages "BEVERAGE" will taken Normal_tax (eg. 19% in Germany) If at least one product in menu dosen’t have an initial price, then: if menu containt at least one BEVERAGE, then the whole menu is taxed with Normal_tax (eg. 19% in Germany). If no drink is in the order, than all menu is taxed with Reduced_tax (eg. 7% in Germany). . Existing values: TOPPING, MAIN_DISH, BEVERAGE, BOTTLE_DEPOSIT, MENU. |
|
|
Individual initial price of the product is used to calculate the tax for the MENU. If all products in this MENU have "initialPrice“, then the mix tax will be calculated. Example: For Main dishes and toppings "MAIN_DISH", "TOPPING" will taken the Reduced_tax (eg. 7% in germany) and for beverages "BEVERAGE" will taken Normal_tax (eg. 19% in Germany) If at least one product in menu dosen’t have an initial price, then: if menu containt at least one BEVERAGE, then the whole menu is taxed with Normal_tax (eg. 19% in germany). If no drink is in the order, than all menu is taxed with Reduced_tax (eg. 7% in Germany).. |
|
|
Count of ordered products. Should be whole numbers excluding zero |
|
|
Name of product. Must not be empty. |
|
|
Product individual price, exclude side dishes. Must be positive or zero. |
|
|
Product specific remarks. Size must be between 1 and 2147483647 inclusive. |
|
|
Product category name. Size must be between 1 and 2147483647 inclusive. |
|
|
List of subItems. |
|
|
Product tax data. |
|
|
Product tax type. Existing values: NORMAL, REDUCED. Must not be null. |
|
|
Product tax rate in percents. Must not be null. |
4.5. Get order by ref id
$ curl 'https://api.liefersoft.de/orders/bk5678-sa/ref' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM'GET /orders/bk5678-sa/ref HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM
Host: api.liefersoft.de| Parameter | Description |
|---|---|
|
The custom unique identifier of order |
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1147
{"orderId":"123-444","preOrder":"2019-08-10T18:40:00Z","orderType":"DELIVERY","platformName":"Pizza Netz","customer":{"companyName":"Smith Ltd","name":"John Smith","street":"Main Street","streetNumber":"2","city":"Hamburg","postalCode":"21563","phoneNumber":"987368676","extraAddressInfo":"1st floor.","remark":"customer remark"},"deliveryCost":{"cost":1.5},"totalPrice":15.5,"totalDiscount":2.0,"payed":true,"tips":2.5,"paymentFee":0.0,"paymentMethod":"ONLINE","remark":"please call me before you come","items":[{"itemCode":"11b","quantity":2,"price":5.0,"initialPrice":5.0,"name":"Pizza Margarita","itemType":"MAIN_DISH","remark":"no chilly","category":"Pizza","taxData":{"type":"NORMAL","rate":19.0},"items":[]},{"itemCode":"c1l","quantity":2,"price":3.0,"initialPrice":3.0,"name":"Cola","itemType":"BEVERAGE","remark":"remark1","category":"Drink","taxData":{"type":"NORMAL","rate":19.0},"items":[]}],"id":"bk5678-sa","platformStatus":"PROCESSED","estimatedProcessTimestamp":"2020-10-15T00:00:00Z","createdDate":"2020-10-11T00:00:00","modifiedDate":"2020-10-11T00:00:00","createdBy":"some.user@example.com","modifiedBy":"some.user@example.com"}| Path | Type | Description |
|---|---|---|
|
|
The unique technical identifier of order. Must not be empty. |
|
|
Custom unique technical identifier of order (ref id). Must not be empty. Size must be between 1 and 255 inclusive. |
|
|
The name of client/producer. ex. the_best_web_shop_ever |
|
|
Order type based on delivery type. Existing values: COUNTER, PICKUP, DELIVERY, RESTAURANT. Must not be null. |
|
|
Order total price including discounts and delivery costs. Must be positive. |
|
|
Order total discount. Must be positive or zero. Default: 0. |
|
|
Order payment method. Existing values: CASH, MEAL_VOUCHER, ONLINE, CREDIT_CARD_AT_DOORSTEP, EC_AT_DOORSTEP. Must not be null. |
|
|
Any general remarks about the order. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
The order has been paid already. |
|
|
The Tips additional to total price . Must be positive or zero. Default: 0. |
|
|
The payment fee value . Must be positive or zero. Default: 0. |
|
|
Delivery or pickup time ISO8601 (yyyy-MM-dd’T’HH:mm:ss.SSSX) requested by customer. This value must be less than 7 days from current time. Example: 2021-03-10T16:34:09Z, 2021-03-10T14:34:09+02:00. Default: null. |
|
|
Order platform status. Existing values: ACCEPTED, PROCESSING, PROCESSED, CANCELED, PROCESSING_ERROR. Must not be null. |
|
|
Order creation date. Must not be null. |
|
|
Order modification date. Must not be null. |
|
|
Order created by. Must not be empty. |
|
|
Order modification by. Must not be empty. |
|
|
Order estimated processing time. |
|
|
Company name. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Name of customer. |
|
|
Customer street. |
|
|
Customer street number. |
|
|
Customer city. |
|
|
Customer postal code. Must match the regular expression |
|
|
Customer phone number. Must match the regular expression |
|
|
Customer additional address (delivery) information. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Any remark for customer eg. 1st floor, etc. Size must be between 1 and 2147483647 inclusive. Default: null. |
|
|
Order delivery costs. Must be positive or zero. |
|
|
List of included order items. Must not be empty. |
|
|
SKU or product identity in your system. Size must be between 1 and 36 inclusive. Default: null. |
|
|
Product type. MAIN_DISH - main dish, for example Pizza, Soup, Salad. Used to calculate taxes for the main dish. taxed with REDUCED_TAX (eg. 7% in Germany) TOPPING - An additive to the main dish, for example Cheese, Tomato, Sauce. Used to calculate taxes for the additive. taxed with REDUCED_TAX (eg. 7% in Germany) BEVERAGE - beverage. Used to calculate taxes for a beverage. BOTTLE_DEPOSIT - container from the beverage. Used to calculate taxes for bottle deposit. taxed with BOTTLE_DEPOSIT (eg. 19% in Germany) MENU - combo menu. Used to calculate taxes for the menu. If all products in this MENU have "initialPrice“, then the mix tax will be calculated. Example: For Main dishes and toppings "MAIN_DISH", "TOPPING" will taken the Reduced_tax (eg. 7% in Germany) and for beverages "BEVERAGE" will taken Normal_tax (eg. 19% in Germany) If at least one product in menu dosen’t have an initial price, then: if menu containt at least one BEVERAGE, then the whole menu is taxed with Normal_tax (eg. 19% in Germany). If no drink is in the order, than all menu is taxed with Reduced_tax (eg. 7% in Germany). . Existing values: TOPPING, MAIN_DISH, BEVERAGE, BOTTLE_DEPOSIT, MENU. |
|
|
Individual initial price of the product is used to calculate the tax for the MENU. If all products in this MENU have "initialPrice“, then the mix tax will be calculated. Example: For Main dishes and toppings "MAIN_DISH", "TOPPING" will taken the Reduced_tax (eg. 7% in germany) and for beverages "BEVERAGE" will taken Normal_tax (eg. 19% in Germany) If at least one product in menu dosen’t have an initial price, then: if menu containt at least one BEVERAGE, then the whole menu is taxed with Normal_tax (eg. 19% in germany). If no drink is in the order, than all menu is taxed with Reduced_tax (eg. 7% in Germany).. |
|
|
Count of ordered products. Should be whole numbers excluding zero |
|
|
Name of product. Must not be empty. |
|
|
Product individual price, exclude side dishes. Must be positive or zero. |
|
|
Product specific remarks. Size must be between 1 and 2147483647 inclusive. |
|
|
Product category name. Size must be between 1 and 2147483647 inclusive. |
|
|
List of subItems. |
|
|
Product tax data. |
|
|
Product tax type. Existing values: NORMAL, REDUCED. Must not be null. |
|
|
Product tax rate in percents. Must not be null. |
5. Webhook configuration
5.1. Get all webhooks
$ curl 'https://api.liefersoft.de/webhooks' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM'HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 84
[{"id":"00000000-aaaa-aaaa-aaaa-000000000000","url":"https://callbackUrl.com/path"}]| Path | Type | Description |
|---|---|---|
|
|
The generated unique identifier of webhook. Must not be empty. |
|
|
Webhook url. Must not be empty. |
5.2. Create webhook
$ curl 'https://api.liefersoft.de/webhooks' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM' \
-d '{"secret": "12345678ABCDEFGH", "url": "https://callbackUrl.com/path"}'POST /webhooks HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM
Content-Length: 69
Host: api.liefersoft.de
{"secret": "12345678ABCDEFGH", "url": "https://callbackUrl.com/path"}| Path | Type | Description |
|---|---|---|
|
|
Secret. Must not be empty. Size must be between 16 and 1024 inclusive. |
|
|
Webhook url. Must match the regular expression |
{"secret": "12345678ABCDEFGH", "url": "https://callbackUrl.com/path"}HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 82
{"id":"00000000-aaaa-aaaa-aaaa-000000000000","url":"https://callbackUrl.com/path"}| Path | Type | Description |
|---|---|---|
|
|
The generated unique identifier of webhook. Must not be empty. |
|
|
Webhook url. Must not be empty. |
5.3. Update webhook
$ curl 'https://api.liefersoft.de/webhooks/00000000-aaaa-aaaa-aaaa-000000000000' -i -X PUT \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM' \
-d '{"secret": "12345678ABCDEFGH", "url": "https://callbackUrl.com/path"}'PUT /webhooks/00000000-aaaa-aaaa-aaaa-000000000000 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM
Content-Length: 69
Host: api.liefersoft.de
{"secret": "12345678ABCDEFGH", "url": "https://callbackUrl.com/path"}| Parameter | Description |
|---|---|
|
Webhook id |
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 82
{"id":"00000000-aaaa-aaaa-aaaa-000000000000","url":"https://callbackUrl.com/path"}| Path | Type | Description |
|---|---|---|
|
|
The generated unique identifier of webhook. Must not be empty. |
|
|
Webhook url. Must not be empty. |
5.4. Delete webhook
$ curl 'https://api.liefersoft.de/webhooks/00000000-aaaa-aaaa-aaaa-000000000000' -i -X DELETE \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTIyZjY1Yi05ODlmLTQ4OTgtYjc1OC1hMTZkMWE1YmE2ZjYiLCJleHAiOjE5MTc4MjA4MDAsImlhdCI6MTYwMzE5MDI4MCwiaXNzIjoiYWNtZS5jb20iLCJzdWIiOiI3N2UzNGQxMS0xZDcxLTQ5YTEtOTBlOC0zMWEyZTRkNjdhZDYiLCJqdGkiOiJjNmYzZWZlZC04ZmU2LTRjMzctYTVmOC0wZWU2NTk2ODg2NjIiLCJhdXRoZW50aWNhdGlvblR5cGUiOiJSRUZSRVNIX1RPS0VOIiwiZW1haWwiOiJzb21lLnVzZXJAZXhhbXBsZS5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwiYXBwbGljYXRpb25JZCI6ImQxMjJmNjViLTk4OWYtNDg5OC1iNzU4LWExNmQxYTViYTZmNiIsInJvbGVzIjpbXSwiY29tcGFueURhdGEiOnsibmFtZSI6IlZsYWQgOTkzIENvbXAiLCJpbmRleCI6IkQxLTc2MDIzIiwiY2l0eSI6Ijk3Iiwic3RyZWV0IjoiamoiLCJob3VzZSI6Ijg5NyIsInppcENvZGUiOiJpam9qIiwicGhvbmVQcmVmaXgiOiI4OTg3OSIsInBob25lTnVtYmVyIjoiOTg3OTgiLCJmYXgiOiI5ODc5ODciLCJ0YXhJZCI6Ijk4Nzk4NzkiLCJvcmRlcnNFbWFpbCI6InNvbWUudXNlckBleGFtcGxlLmNvbSIsIm93bmVyRnVsbE5hbWUiOiJWbGFkaXNsYXYiLCJvd25lckVtYWlsIjoic29tZS51c2VyQGV4YW1wbGUuY29tIiwib3duZXJQaG9uZU51bWJlciI6IjIzNDk3MjkzOTc4IiwibGF0aXR1ZGUiOjUuMjM0MiwibG9uZ2l0dWRlIjo0LjY1NTMsImNvdW50cnlOYW1lIjoiRGV1dHNjaGxhbmQiLCJjb3VudHJ5Q29kZSI6IkRFVSIsImN1cnJlbmN5IjoiRVVSIn0sImdyb3VwIjoiUExBVEZPUk1fQVBJIiwidGVuYW50SWQiOiI3MzcxMTZkOC04MWYxLTQxYmEtYmJiMy1jNGU2YzE1NWRiYzIifQ.K5-PMRbcojM6-wuO2EHshteN21HONM937Z7QdxRPx1qV05-16jW2HLDjFZGWvDllNd5wfFkponrsCwgOrmHwCOsNvSuqQe_0htl4bYTYwPQuRXEqDFo2Om7LhR-JK2D009RGF_JMheJ0jHFTXAAoSBOWlxjD6jB59bTtnPmCfReYqCIZ2uvDS2DWY0fuXjLrs0AC7am1nj9Nsl3NqZoYebUOe9TZaM2FBFsrVkXvBIhghZFcyPho8J4kEN7_ch2lEfQCwWFJ7300lEfZJ43Olsdj5quTFlockRzQzSVrNnFBNG1GsjZLCDJhjnoZAjHwR7bbAPOmrVVKTHN4kAdD6S12Gbsc9rujIlsAkI9rZ3Neqkk93QdwIUlQTdzGDkM3OunIU5t_YQHqt359dAYXdXOszZdb9fWNQR8_6-ewYdfaIa1BIrROcCsZ22F7x_We-SdTgdoaj7sJY_H6mofpFIQCop4qRG32vYLcK-8gyFXkLdYw5feIb4LbfdBijiCBL9zvx529OpTxCHYtr83GcT7GrgmhVFU5odfeBCWWsT5vm07_dXbzcliQF-EJijzFDSQgzzo4ibSkrTXjLdYKYalaD_Nu5UFU91eSiIcxIi8RyRHR6geR26bOzeK9G5IP8OQjyFtKwGwJI_V-rzK5oNTEt1SFmJFEltECOwMefzM'| Parameter | Description |
|---|---|
|
Webhook id |
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY6. Webhook order
6.1. Authenticating Webhooks
When a Webhook POST message is sent to your endpoint, it includes the header X-Signature-SHA256, which is a SHA-256 hash of the message payload generated using the signing key. You can use the following steps to verify the Webhook message:
Compute the SHA-256 HASH of the message utilizing your designated signing key. It is recommended to employ a standard HMAC function provided by your programming language.
It is crucial to ensure the integrity and authenticity of a message by verifying the correctness of the control signature before proceeding with any processing.
Below is an example of the data used to calculate the expected X-Signature-SHA256 signature, considering the signing key and the message payload:
secretKey: secret-123
json: {"eventId":"ev-123","webhookId":"wh-123","companyIndex":"AA-11111","restaurantId":"rest_1","eventType":"ORDER_CONFIRMED","order":{"orderId":"123-444","preOrder":"2019-08-10T18:40:00Z","orderType":"DELIVERY","platformName":"Pizza Netz","customer":{"companyName":"Smith Ltd","name":"John Smith","street":"Main Street","streetNumber":"2","city":"Hamburg","postalCode":"21563","phoneNumber":"987368676","extraAddressInfo":"1st floor.","remark":"customer remark"},"deliveryCost":{"cost":1.5},"totalPrice":15.5,"totalDiscount":2.0,"payed":true,"tips":2.5,"paymentFee":0.0,"paymentMethod":"ONLINE","remark":"please call me before you come","items":[{"itemCode":"11b","quantity":2,"price":5.0,"initialPrice":0.0,"name":"Pizza Margarita","remark":"no chilly","category":"Pizza","taxData":{"type":"NORMAL","rate":19.0},"items":[]},{"itemCode":"c1l","quantity":2,"price":3.0,"initialPrice":0.0,"name":"Cola","remark":"remark1","category":"Drink","taxData":{"type":"NORMAL","rate":19.0},"items":[]}],"id":"order-123","platformStatus":"PROCESSED","estimatedProcessTimestamp":"2020-10-15T00:00:00Z","createdDate":"2020-10-11T00:00:00","modifiedDate":"2020-10-11T00:00:00","createdBy":"some.user@example.com","modifiedBy":"some.user@example.com"}}
X-Signature-SHA256: uSh2b4x8pwcWQhJOLLT9OWvVRUSWxKCvS9Fg6oMxW0k=$ curl 'https://<YOUR_WEBHOOK_URI>' -i -X POST \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-Signature-SHA256: uSh2b4x8pwcWQhJOLLT9OWvVRUSWxKCvS9Fg6oMxW0k=' \
-d '{"eventId":"ev-123","webhookId":"wh-123","companyIndex":"AA-11111","restaurantId":"rest_1","eventType":"ORDER_CONFIRMED","order":{"orderId":"123-444","preOrder":"2019-08-10T18:40:00Z","orderType":"DELIVERY","platformName":"Pizza Netz","customer":{"companyName":"Smith Ltd","name":"John Smith","street":"Main Street","streetNumber":"2","city":"Hamburg","postalCode":"21563","phoneNumber":"987368676","extraAddressInfo":"1st floor.","remark":"customer remark"},"deliveryCost":{"cost":1.5},"totalPrice":15.5,"totalDiscount":2.0,"payed":true,"tips":2.5,"paymentFee":0.0,"paymentMethod":"ONLINE","remark":"please call me before you come","items":[{"itemCode":"11b","quantity":2,"price":5.0,"initialPrice":0.0,"name":"Pizza Margarita","remark":"no chilly","category":"Pizza","taxData":{"type":"NORMAL","rate":19.0},"items":[]},{"itemCode":"c1l","quantity":2,"price":3.0,"initialPrice":0.0,"name":"Cola","remark":"remark1","category":"Drink","taxData":{"type":"NORMAL","rate":19.0},"items":[]}],"id":"order-123","platformStatus":"PROCESSED","estimatedProcessTimestamp":"2020-10-15T00:00:00Z","createdDate":"2020-10-11T00:00:00","modifiedDate":"2020-10-11T00:00:00","createdBy":"some.user@example.com","modifiedBy":"some.user@example.com"}}'| Event type | Description |
|---|---|
|
Order has been confirmed successfully. |
|
Order has been processed. |
|
Order has been cancelled. |
| Path | Type | Description |
|---|---|---|
|
|
Event ID. |
|
|
Webhook ID. |
|
|
The unique identifier of company. |
|
|
The restaurant id through which the order was placed. |
|
|
The type of event that occurred. Example: "ORDER_CONFIRMED" or "ORDER_PROCESSED" or "ORDER_CANCELLED". |
|
|
An object containing details about the order. |
|
|
A unique identifier for the order, as provided when the order was created. |
|
|
The date and time when the order was placed in ISO 8601 format. This field is optional if the order is not a pre-order. |
|
|
The type of order (e.g., delivery, pickup). Example: "DELIVERY" or "PICKUP" or "COUNTER". |
|
|
The name of client/producer. ex. the_best_web_shop_ever |
|
|
An object containing details about the customer |
|
|
The name of the customer’s company. |
|
|
The name of the customer. |
|
|
The street name of the customer’s address. |
|
|
The street number of the customer’s address. |
|
|
The city of the customer’s address. |
|
|
The postal code of the customer’s address. |
|
|
The phone number of the customer. |
|
|
Additional information about the customer’s address. |
|
|
Any remarks or comments from the customer. |
|
|
An object containing details about the delivery cost. |
|
|
The cost of delivery. |
|
|
The total price of the order. |
|
|
The total discount applied to the order. |
|
|
Indicates whether the order has been paid. |
|
|
The amount of tips given. |
|
|
The fee for the payment method used. |
|
|
The method of payment used for the order. Example: "ONLINE" or "CASH" or "EC_AT_DOORSTEP. |
|
|
Any additional remarks or instructions for the order. |
|
|
An array of items included in the order. |
|
|
A code for the item. |
|
|
The quantity of the item ordered. |
|
|
The price of the item. |
|
|
The initial price of the item (if different from the final price). |
|
|
The regular price of the item (if applicable). |
|
|
The name of the item. |
|
|
The type of item. Example: "MAIN_DISH" or "TOPPING" or "BEVERAGE" or "BOTTLE_DEPOSIT". |
|
|
Any remarks or special instructions for the item. |
|
|
The category of the item. |
|
|
An object containing tax data for the item. |
|
|
The type of tax applied to the item. Example: "NORMAL" or "REDUCED". |
|
|
The tax rate applied to the item. |
|
|
An array of sub-items (if applicable). |
|
|
A unique identifier for the order, provided to them in the response when the order was created. |
|
|
The current status of the order on the platform. Example: "ACCEPTED", "PROCESSING", "PROCESSED", "CANCELED", "PROCESSING_ERROR". |
|
|
The estimated timestamp for when the order will be processed. |
|
|
The date and time when the order was created. |
|
|
The date and time when the order was last modified. |
|
|
The name of the user who created the order. |
|
|
The email of the user who last modified the order. |