Request.
"Content-Type": "description"="application/x-www-form-urlencoded" "username": "API username" "password": "API password" "apikey": "apikey"
Error response
{
"message": "The error message.",
"code": [400, 401],
}
Success response
{
"status": true,
"token": "api_token"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Status Code | Description |
|---|---|
| 400 |
|
| 401 |
|
Success response
{
"status": true,
"message": "Message",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 10:50:10",
"brands": [
{
"brandId": "1",
"brandName": "Name",
"isActive": true,
"isDeleted": false,
"createdAt": "2016-04-05 11:07:35",
"updatedAt": "2016-04-06 14:28:54"
}
],
"totalCount": "10"
}
Error response
{
"status": false,
"message": "The error message.",
"code": 400
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Name | Information | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| fromDate |
|
||||||||
| offset |
|
||||||||
| limit |
|
||||||||
| sortOrder |
|
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body
{
"data": [
{
"brandId": 15,
"brandName": "New brand name",
"isActive": false
}
]
}
Success response
{
"status": true,
"code": 200,
"dateTimeBeforeQryExec": "2020-04-21 15:39:26",
"totalAffected": 1,
"data": [
{
"status": true,
"code": 200,
"brandData": {
"brandId": 15,
"brandName": "brand name",
"isActive": true,
"isDeleted": false,
"createdAt": "2020-04-21 15:39:26",
"updatedAt": "2020-04-21 15:39:26"
},
"validationMessage": []
}
]
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Response Format
<
pre> Success response { "status": true, "message": "Brand details retrieved successfully.", "code": 200, "dateTimeBeforeQryExec": "2017-01-21 10:50:10", "data": { "brandId": "1", "brandName": "Name", "isActive": true, "isDeleted": false, "createdAt": "2016-04-05 11:07:35", "updatedAt": "2016-04-06 14:28:54" } }
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| brandId | int | The brand ID |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message",
"code": 200,
"dateTimeBeforeQryExec": "2020-04-21 15:39:26",
"categories": [
{
"categoryId": 1,
"categoryName": "Category name",
"isActive": true,
"isDeleted": false,
"createdAt": "2016-04-05 11:04:49",
"updatedAt": "2017-10-31 10:06:20"
}
],
"total_count": "1"
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Name | Information | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| fromDate |
|
||||||||
| offset |
|
||||||||
| limit |
|
||||||||
| sortOrder |
|
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body
{
"data": [
{
"categoryId": 1,
"categoryName": "The category name",
"isActive": true
}
]
}
Validation error response
{
"status": true,
"code": 200,
"dateTimeBeforeQryExec": "2021-04-21 17:45:01",
"totalAffected": 0,
"data": [
{
"status": false,
"code": 422,
"categoryData": [{...}],
"validationMessage": [{
"code": 412,
"message": "Validation error"
}]
}
]
}
Success response
{
"status": true,
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 10:50:10",
"totalAffected": 1,
"data": [
{
"status": true,
"code": 200,
"categoryData": {
"categoryId": 198,
"categoryName": "The category name",
"isActive": true,
"isDeleted": false,
"createdAt": "2020-04-06 17:55:51",
"updatedAt": "2020-04-06 17:55:51"
},
"validationMessage": []
}
]
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 10:50:10",
"data": {
"categoryId": "1",
"categoryName": "category name",
"isActive": "1",
"isDeleted": "0",
"createdAt": "2016-04-05 11:04:49",
"updatedAt": "2017-10-31 10:06:20"
}
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| categoryId | int | The category ID |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 10:50:10",
"data": [
{
"customerId": "1",
"name": "Peter",
"address": "address",
"zip": "4631",
"location": "KRISTIANSAND S",
"phoneNumber": "12345678",
"email": "email@tellix.no",
"country": "Norge",
"isActive": true,
"isDeleted": false
}
],
"totalCount": "877"
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Name | Information | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| fromDate |
|
||||||||
| offset |
|
||||||||
| limit |
|
||||||||
| sortOrder |
|
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
{
"data": [
{
"customerName": "Name",
"country": "Norway",
"isActive": true
}
]
}
Validation error response
{
"status": true,
"code": 200,
"dateTimeBeforeQryExec": "2020-04-21 17:45:01",
"totalAffected": 0,
"data": [
{
"status": false,
"code": 422,
"categoryData": [{...}],
"validationMessage": [{
"code": 412,
"message": "Validation error"
}]
}
]
}
Success response
{
"status": true,
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"totalAffected": 1,
"data": [
{
"status": true,
"code": 200,
"customerData": {
"customerId": "912",
"customerName": "Name",
"isActive": true,
"isDeleted": false,
"createdAt": "2021-04-07 10:04:03",
"updatedAt": "2021-04-07 10:04:03"
},
"validationMessage": []
}
]
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body.
{
"data": {
"name": "New name",
"email": "email@email.com",
"country": "Norway",
"isActive": false,
"isDeleted": true
}
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| id | int | Customer Id |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 404 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 10:50:10",
"data": {
"customerId": "1",
"name": "Peter",
"address": "address",
"zip": "4631",
"location": "KRISTIANSAND S",
"phoneNumber": "12345678",
"email": "email@tellix.no",
"country": "Norge"
}
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| customerId | int | The Customer ID |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"departmentInfo":
{
"departmentId": "1",
"departmentName": "Name",
"departmentNumber": "1",
"companyName": "Demo1 avd. test",
"companyNumber": "NO 123 456 788",
"type": "standard",
"address": "Ensjøveien 14",
"zip": "0655",
"location": "OSLO",
"receiptZip": "0655",
"receiptLocation": "OSLO",
"phoneNumber": "21538000",
"email": "email@email.com",
"url": "http://www.tellix.no",
"photo": "photo file name",
"isActive": true,
"isDeleted": false,
"createdAt": "2016-04-05 09:39:30",
"updatedAt": "2021-12-10 09:48:33",
"departmentImage": "",
"departmentImageUrl": ""
}
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| departmentId | int | Department ID |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"departments": [
{
"departmentId": "1",
"departmentName": "Name",
"departmentNumber": "1",
"companyName": "Demo1 avd. test",
"companyNumber": "NO 123 456 788",
"type": "standard",
"address": "Ensjøveien 14",
"zip": "0655",
"location": "OSLO",
"receiptZip": "0655",
"receiptLocation": "OSLO",
"phoneNumber": "21538000",
"email": "email@email.com",
"url": "http://www.tellix.no",
"photo": "photo file name",
"isActive": true,
"isDeleted": false,
"createdAt": "2016-04-05 09:39:30",
"updatedAt": "2021-12-10 09:48:33",
"departmentImage": "",
"departmentImageUrl": ""
}
],
"totalCount": 1
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Name | Information | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| fromDate |
|
||||||||
| offset |
|
||||||||
| limit |
|
||||||||
| sortOrder |
|
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"data": [
{
"orderId": "8283",
"orderNumber": "10050221200004",
"departmentId": "1",
"departmentName": "Demo",
"isReturnOrder": false,
"isTakeAwayOrder": false,
"orderStatus": "Sent",
"totalPurchasePrice": "0",
"totalPriceExcludingVat": "271.2",
"totalPriceIncludingVat": "339",
"totalDiscount": "0",
"roundOffAmount": "0",
"totalPay": "339",
"vatAmount": "67.8",
"createdBy": "POSADMIN",
"reportingDate": "2022/03/21 15:25:41",
"orderDetails": [
{
"productId": 123,
"productName": "productName",
"productNumber": "12350",
"productExcludingVatPrice": 271.2,
"productIncludingVatPrice": 339.0,
"quantity": "1.0000",
"totalProductExcludingVatPrice": 271.2,
"totalProductIncludingVatPrice": 339.0,
"discount": 0.0,
"vatRatePercent": "25.00",
"totalVatAmount": 67.8
}
],
"paymentDetails": [
{
"paymentMethodName": "Faktura",
"amount": 339.0,
"paidAmount": 339.0,
"terminalOperator": ""
}
],
"giftCardInfo": [
{
"giftCardNumber": "1111111111111",
"title": "",
"amount": 50.0,
"expiryDate": "2023-03-18T14:34:40+01:00"
}
],
"creditNoteInfo": [
{
"creditNoteNumber": "22222222222222",
"title": "",
"amount": 229.0,
"expiryDate": "2020-08-12T13:32:03+02:00"
}
],
"voucherPrefillInfo": [
{
"prefillValue": 271.2
}
]
}
],
"totalCount": "1"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Name | Information | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| fromDate |
|
||||||||
| offset |
|
||||||||
| limit |
|
||||||||
| sortOrder |
|
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body.
{
"data": [
{
"orderData": {
"departmentId": 1,
"customerId": 3,
"comments": "order comment text",
"status": ""
},
"productData": [
{
"productId": 30336,
"quantity": 1,
"priceIncVat": 128,
"comments": "comment text",
"referenceComment": "text"
}
],
"paymentDetails": [
{
"paymentMethodId": 26,
"amountPaid": 10
}
]
}
]
}
Validation error response
{
"status": true,
"code": 200,
"dateTimeBeforeQryExec": "2020-04-21 17:45:01",
"totalAffected": 0,
"data": [
{
"status": false,
"code": 422,
"orderInfo": [{...}],
"validationMessage": [{
"code": 412,
"message": "Validation error"
}]
}
]
}
Success response
{
"status": true,
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"totalAffected": 1,
"data": [
{
"status": true,
"code": 200,
"orderInfo": {
"orderId": "98",
"departmentId": 1,
"orderNumber": "20220010000012",
"status": "Til behandling",
"createdAt": "2022-04-07 17:44:50",
"updatedAt": "2022-04-07 17:44:50"
},
"validationMessage": []
}
]
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| orderNumber | string | Order receipt number |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"data": {
"orderId": "96",
"receiptNumber": "20220010000010",
"departmentId": "1",
"isActive": true,
"isDeleted": false,
"createdAt": "2022-03-14 10:49:45",
"updatedAt": "2022-03-17 12:43:18",
"orderStatus": "Betalt",
"customer_info": {
"customerId": "182",
"name": "Name",
"address": "Ryensvingen",
"zip": "0680",
"location": "OSLO",
"country": 161,
"phoneNumber": "1234567",
"email": "email@email.no",
"isActive": true,
"isDeleted": false,
"createdAt": "2022-01-24 13:53:54",
"updatedAt": "2022-03-17 12:43:11",
"updatedBy": 1
},
"order_details": [
{
"orderId": "96",
"productId": "204",
"productName": "product name",
"productNumber": "109",
"priceIncVat": "36.88",
"quantity": "1",
"comments": "",
"referenceComment": ""
}
]
}
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| orderNumber | string | Order receipt number |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body.
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"data": {
@see Order object / "Get orders list"
},
"totalCount": 1
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| id | string | Order Id |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "",
"code": 200,
"dateTimeBeforeQryExec": "2025-01-27 12:13:13",
"totalCount": 1,
"data": [
{
"paymentMethodId": 8,
"paymentMethodName": "Kundekort",
"paymentMethodCode": "customer_voucher"
}
]
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
API V3: Request body.
{
"params": {
"OrderStatus": "int"
"limit": "int"
"offset": "int"
"orderby": "ASC or DESC" ("default":DESC)
}
}
API V3: Success response.
{
"status": true,
"message": "Product Orders fetched successfully",
"code": 200,
"products": [
{
"product_order_id": 38,
"department":
{
"department_id": 1,
"department_name": "Demo1 avd. Oslo",
"department_number": "1",
"company_name": "Demo1 avd. Oslo test",
"company_number": "NO 123 456 788",
"type": "standard",
"address": "Ensjøveien 14",
"zip": "0655",
"location": "OSLO",
"billing_address": "Ensjøveien 14",
"billing_zip": "0655",
"billing_location": "OSLO",
"receipt_zip": "0655",
"receipt_location": "OSLO",
"phone_number": "21538000",
"email": "support@tellix.no",
"url": "http://www.tellix.no",
"image": "83295d8a9adee301e166f84af509fcdf.png",
"receipt_text": "Foretaksregisteret",
"is_active": true,
"assign_products": false,
"is_deleted": false,
"created_at": "2016-04-05T09:39:30+02:00",
"updated_at": "2022-06-27T15:30:19+02:00",
"created_by": 1,
"updated_by": 1
},
"supplier": {
"supplier_id": 8,
"supplier_name": "Asco AS",
"is_active": true,
"is_deleted": false,
"created_at": "2021-01-13T09:06:12+01:00",
"updated_at": "2021-01-13T09:06:12+01:00",
"created_by": 21,
"updated_by": 21
{
"order_number": "38",
"order_status": 2,
"is_active": true,
"is_deleted": false,
"created_at": "2022-05-19T14:18:37+02:00",
"updated_at": "2022-05-19T14:18:47+02:00",
"created_by": 28,
"updated_by": 28
}
]
},
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | [v3] | string | API version |
| prefix | api |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
API V3: Request body.
{
"params": {
"stockDepartment": 2,
"fromDate": "YYYY-MM-DD"
}
}
API V3: Success response.
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"productDetails": [
{
"productId": "2202",
"productNumber": "159",
"stockQuantity": "0"
},
{
"productId": "40080",
"productNumber": "80083800000005",
"childProducts": [
{
"productId": "40081",
"productNumber": "80083800000009",
"stockQuantity": "0"
}
]
},
]
}
API V1: Request body.
{
"params": {
"stockDepartment": 2,
"fromDate": "2022-03-01 00:00:00",
"offset": 0,
"limit": 10
}
}
API V1: Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"productDetails": [
{
"productId": "40059",
"productNumber": "1239875",
"stockQuantity": "0",
"stockControl": true
}
],
"totalCount": 31
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | [v3|v2] | string | API version |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body without Product Order
{
"data": {
"department_id": "1",
"products":[{
"productId": "1337",
"productCount": "15"
},
{
"productId": "1337",
"productCount": "15"
}
]
}
}
Request body with Product Order
{
"data": {
"productOrderId": "1",
"departmentId": "1",
"products":[{
"productID": "1337",
"productCount": "11"
},
{
"productId": "41049",
"productCount": "11"
}
]
}
}
Success response
{
"status": true,
"message": "New receipt of good created successfully,
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| productId | required | int | The product Id. |
| productOrderId | optional | int | If getting products from product orders. |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body.
{
"data": {
"department_id": "2",
"product_id": "7269",
"adjust_stock_quantity": "-3"
}
}
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"stockQuantity": "86"
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| id | v3 | int | The product Id. |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"stockQuantity": 0
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| id | v3 | int | The product Id. |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body.
{
"data": {
"department_id": "2",
"product_id": "2216",
"stock_quantity": "11"
}
}
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"stockQuantity": "11"
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| id | v3 | int | The product Id. |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body.
{
"params": {
"stockDepartment": "1",
"productNumber": "2216",
"stockQuantity": "344"
}
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Enabled.
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
}
Disabled.
{
"status": false,
"message": "Message.",
"code": 422,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Status Code | Description |
|---|---|
| 200 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"data": [
{
"productId": "id",
"productName": "name text",
"productNumber": "11111111",
"barcode": "123123123123",
"description": "description text",
"brandId": null,
"brandName": null,
"vatRateId": "1",
"vatRatePercent": "25.00",
"takeawayVatRateId": null,
"takeawayVatRatePercent": null,
"costPrice": "18390",
"priceIncVat": "38998",
"takeawayPriceIncVat": null,
"isTakeaway": false,
"stockControl": true,
"isActive": true,
"isDeleted": false,
"createdAt": "2021-12-20 08:57:46",
"updatedAt": null,
"hasVariant": false,
"isCombo": false,
"hasConnected": false,
"childProductsOnReceipt": false,
"isOpenPrice": false,
"showOnWeb": true,
"printOnBong": false,
"productUnitId": "1",
"supplierProductNumber": "271249571A",
"category": {
"id": "category id",
"name": "category name text"
},
"variants": [],
"images": []
}
]
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Name | Information | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| fromDate |
|
||||||||
| offset |
|
||||||||
| limit |
|
||||||||
| orderBy |
|
||||||||
| sortBy |
|
||||||||
| departmentIds |
|
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body.
{
"data": [
{
"productName": "Api prod",
"productNumber": "api0000000001",
"categoryId": 1,
"priceIncVat": 100.28,
"barcode": "bar-api0000000001",
"brandId": null,
"description": "",
"costPrice": null,
"vatRatePercent": 25,
"isTakeaway": true,
"takeawayPriceIncVat": 70,
"takeawayVatRatePercent": 15,
"stockControl": false,
"isActive": true,
"showOnWeb": ture
}
]
}
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"data": [
{
"status": true,
"code": 200,
"productData": {
"productId": 40086,
"productName": "name text",
"productNumber": "1110000000001",
"barcode": "1110000000001",
"showOnWeb": true,
"isActive": true,
"isDeleted": false,
"createdAt": "2022-04-08 08:40:31",
"updatedAt": "2022-04-08 08:40:31"
},
"validationMessage": []
}
]
}
Validation error response
{
"status": true,
"code": 200,
"dateTimeBeforeQryExec": "2020-04-21 17:45:01",
"totalAffected": 0,
"data": [
{
"status": false,
"code": 422,
"productData": [{...}],
"validationMessage": [{
"code": 412,
"message": "Validation error"
}]
}
]
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body.
{
"data": {
"departmentId": 1,
"listName": "Varetelling 14-11-2022",
"products":[{
"productId":4,
"productCount": 20
},
{
"productId": 5,
"productCount": 5
}]
}
}
Success response
{
"status": true,
"message": "Product X , Y , Z has been added to varetelling 14.11.2022",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"stockQuantity": "11"
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| id | v3 | int | The product Id. |
| DepartmentId | v3 | int | The department id |
| listName | v3 | string | the name of the stockcount list |
| productId | v3 | int | ProductId |
| productCount | v3 | int | the counted numbers of selected product |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response without UUID parameter
[
{
"stockCountUUID": "rtghhtgwslwog0kw4gsgg4gs08g8owk",
"stockCountId": 1,
"stockCountName": "StockCount 1"
}
]
Success Response with UUID parameter
[
{
"ProductNumber": "1",
"productSku": "123456789",
"productName": Product 1
"productId": 1,
"previousQty": 5.0,
"productCount": 15.0
},
{
"ProductNumber": "2",
"productSku": "1234567891",
"productName": "Product 2",
"productId": 2,
"previousQty": 5.0,
"productCount": 15.0
},
{
"ProductNumber": "3",
"productName": "Product 3",
"productId": 3,
"previousQty": 20.0,
"productCount": 5.0
},
{
"ProductNumber": "4",
"productName": "Product 4",
"productId": 4,
"previousQty": 2.4,
"productCount": 20.0
}
]
Error response
{
"message": "The error message.",
"code": [400, 422],
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| departmentId | v3 | int | The department id |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| offset | integer | false | The index of the first user to return. Default is 0. | |
| limit | integer | false | The maximum number of users to return. Default is 10. | |
| stockCountUUID | string | false | If you wish to get products in the certain stockcount list, use stockcount UUID as a parameter |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body.
{
"data": {
"productName": "new product name",
"productNumber": "api0000000001",
"categoryId": 1,
"priceIncVat": 100.28,
"barcode": "bar-api0000000001",
"brandId": null,
"description": "",
"costPrice": null,
"vatRatePercent": 25,
"isTakeaway": true,
"takeawayPriceIncVat": 70,
"takeawayVatRatePercent": 15,
"stockControl": false,
"isActive": true
}
}
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| id | v3 | int | The product Id. |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
{
"data": {
"departmentId": 1,
"listName": "Varetelling 14-11-2022",
"products":[{
"productId":4,
"productCount": 20
},
{
"productId": 5,
"productCount": 5
}]
}
}
Success response
{
"status": true,
"message": "Product X , Y , Z has been added to varetelling 14.11.2022",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"stockQuantity": "11"
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| id | v3 | int | The product Id. |
| DepartmentId | v3 | int | The department id |
| listName | v3 | string | the name of the stockcount list |
| productId | v3 | int | ProductId |
| productCount | v3 | int | the counted numbers of selected product |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| stockCountUUID | string | true | Used for finding the stockcount you want to patch |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body.
{
"data": {
"product_id": "int",
"updated_at": "dateTime",
}
}
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"stockQuantity": "11"
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| id | v3 | int | The product Id. |
| updatedAt | v3 | DateTime | DateTime. |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body.
{
"data": [
{
"parentId": 10,
"productNumber": "123456789KC",
"barcode": "1233456789",
"isActive": true,
"showOnWeb": true,
"attributes": [
{
"variant-group": "Colors",
"variant-value": "Red"
},
{
"variant-group": "Size",
"variant-value": "Small"
}
],
"departments": [
{
"departmentId": "1",
"stockQuantity": "64",
"incPrice": "40.5",
"takeawayIncPrice": "0",
"isActive": true
}
]
}
]
}
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"data": [
{
"productId": 38961,
"productName": "Mitt kule produkt 3 Medium Sort"
}
],
"validationMessages": [],
"totalAffected": 1,
"totalFailedVariants": 0
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32",
"validationMessages": [
{
"message": "Variant combination already exists",
"productInRequest": 0
}
]
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| parentId | int | The parentId. | |
| productNumber | int | Productnumber for variant. | |
| attributes | array | The attributes for variant |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"data": {
"productId": "product Id",
"productName": "name text",
"productNumber": "8008378001347",
"barcode": "123442155",
"categoryId": "131",
"categoryName": "category name",
"vatRateId": "1",
"vatRatePercent": "25.00",
"takeawayVatRateId": "3",
"takeawayVatRatePercent": "13.00",
"priceIncVat": "389",
"takeawayPriceIncVat": "389",
"isTakeaway": true,
"stockControl": true,
"isActive": true,
"isDeleted": false,
"createdAt": "2018-12-04 11:13:59",
"updatedAt": "2020-11-03 10:26:02",
"supplierProductNumber": "271249571A",
"departments": [
{
"departmentId": "1",
"stockQuantity": "0",
"incPrice": "389",
"takeawayIncPrice": "389",
"isActive": true
}
]
}
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Discount report
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2020-01-21 06:50:10",
"data": [
{
"userId": "525",
"userName": "Employee Name",
"orderId": 31,
"orderNumber": "10001252400401",
"productId": "238",
"productNumber": "239203VREP",
"productName": "Product Name",
"quantity": "2,5",
"price": 1667.5,
"soldPrice": "1417.37",
"discount": "15",
"discountNok": "500.26",
}
],
"totalCount": "426"
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Name | Information | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| offset |
|
||||||||
| limit |
|
||||||||
| fromDate |
|
||||||||
| toDate |
|
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"data": [
{
"cashSettlementId": "525",
"posId": 50,
"posUserId": 1,
"cashSettlementNumber": 117,
"openingBalance": 0.0,
"calculatedCashBalance": 0.0,
"countedCash": 0.0,
"differenceInCashBalance": 0.0,
"cashWithdraw": 0.0,
"nightSafeCash": 0.0,
"remainingCash": 0.0,
"issuedGiftCards": 0.0,
"issuedGiftCardsTransactions": 0,
"issuedCreditNotes": 0.0,
"issuedCreditNotesTransactions": 0,
"prefillVouchersValue": 0.0,
"prefillVouchersTransactions": 0,
"signDate": "2022/03/21",
"signTime": "16:19:22",
"cashSettlementDate": "2022/03/21 16:19:14",
"comments": "",
"userName": "POS user name",
"totalRoundOff": "-0",
"sumTurnover": 271.2,
"sumVat": 67.8,
"sumReturnTurnover": 0.0,
"sumReturnVat": 0.0,
"IsZReport": true,
"createdDateTime": "2022/03/21 16:19:22",
"sumTerminal": 0.0,
"paymentMethodTurnover": [
{
"paymentType": "Faktura",
"numberOfTransactions": "1",
"amount": "339"
}
],
"terminalResponse": [],
"vatTurnover": [
{
"vatRateTitle": "25% MVA",
"vatRatePercent": "25",
"vat": "67.8",
"turnoverExclVat": "271.2",
"turnoverInclVat": "339"
}
],
"returnVatTurnover": [],
"categoryTurnover": [
{
"categoryName": "category name",
"vat": "67.8",
"vatRatePercent": "25",
"turnoverExclVat": "271.2",
"turnoverInclVat": "339",
"totalProducts": "1"
}
]
}
],
"totalCount": "426"
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| offset |
|
||||||
| limit |
|
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Response Format
Success response
{
"status": true,
"message": "Reports list retrieved successfully",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 10:50:10",
"data": [
{
"Name": "1",
"TotalSales": "30",
"TotalPriceExclVat": "49843",
"TotalPriceInclVat": "62272"
}
]
Error response
{
"status": false,
"message": "The error message.",
"code": 400
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Name | Information | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| fromDate |
|
||||||||
| toDate |
|
||||||||
| departmentId |
|
||||||||
| groupBy |
|
||||||||
| productId |
|
||||||||
| categoryId |
|
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"suppliers": [
{
"supplierId": 1,
"supplierName": "Name",
"isActive": true,
"isDeleted": false,
"createdAt": "2016-04-05 11:06:53",
"updatedAt": "2016-04-05 11:07:01"
}
],
"total_count": "14"
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Name | Information | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| fromDate |
|
||||||||
| offset |
|
||||||||
| limit |
|
||||||||
| sortOrder |
|
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Request body.
{
"data": [
{
"supplierId": [null|int],
"supplierName": "name text"
}
]
}
Validation error response
{
"status": true,
"code": 200,
"dateTimeBeforeQryExec": "2020-04-21 17:45:01",
"totalAffected": 0,
"data": [
{
"status": false,
"code": 422,
"categoryData": [{...}],
"validationMessage": [{
"code": 412,
"message": "Validation error"
}]
}
]
}
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"data": [
{
"status": true,
"code": 200,
"supplierData": {
"supplierId": 15,
"supplierName": "name text",
"isActive": true,
"isDeleted": false,
"createdAt": "2022-04-08 16:10:19",
"updatedAt": "2022-04-08 16:10:53"
},
"validationMessage": []
}
]
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| supplierId | int | Supplier Id |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"data": [
{
"supplierId": "1",
"supplierName": "Name",
"address": "1",
"isActive": "1",
"isDeleted": "0",
"createdAt": "2016-04-05 11:06:53",
"updatedAt": "2016-04-05 11:07:01"
}
]
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| supplierId | int | Supplier Id |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"variantGroups": [
{
"variantGroupId": "1",
"variantGroupName": "name text",
"isActive": true,
"isDeleted": false,
"createdAt": "2017-06-14 08:04:52",
"updatedAt": "2022-03-22 11:15:43",
"variantValues": [
{
"variantValueId": "1",
"variantValue": "50",
"isActive": "1",
"isDeleted": "0",
"createdAt": "2017-06-14 08:04:52",
"updatedAt": "2022-03-22 11:09:35"
}
]
}
],
"totalCount": 14
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Name | Information | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| offset |
|
||||||||
| limit |
|
||||||||
| fromDate |
|
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"data": {
"status": true,
"code": 200,
"message": "",
"variantGroup": {
"variantGroupId": ID,
"variantGroupName": "name text",
"isActive": true,
"createdAt": "2017-06-14 08:04:52",
"updatedAt": "2017-06-14 08:04:52"
}
}
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32",
"validationMessages": {
"[isActive]": "[property name]: Dette feltet mangler."
}
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"vatRates": [
{
"vatRateId": "2",
"vatRateTitle": "15%",
"vatRatePercent": "15.00",
"isDefault": false,
"isActive": true,
"isDeleted": false,
"createdAt": "2016-04-11 11:03:23",
"updatedAt": "2016-04-11 11:03:23"
}
],
"totalCount": 4
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Name | Information | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| fromDate |
|
||||||||
| offset |
|
||||||||
| limit |
|
||||||||
| sortOrder |
|
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"totalAffected": 1,
"data": [
{
"status": true,
"code": 200,
"vatRateData": {
"vatRateId": 5,
"vatRatePercent": "51.00",
"isActive": true,
"isDeleted": false,
"createdAt": "2022-04-14 11:10:03",
"updatedAt": "2022-04-14 11:10:50"
},
"validationMessage": []
}
]
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Success response
{
"status": true,
"message": "Message.",
"code": 200,
"dateTimeBeforeQryExec": "2017-01-21 06:50:10",
"data": {
"vatRateId": "3",
"vatRatePercent": "25.00",
"isDefault": "1",
"isActive": "1",
"isDeleted": "0",
"createdAt": "2016-04-11 11:03:23",
"updatedAt": "2016-04-11 11:03:23"
}
}
Error response
{
"status": false,
"message": "The error message.",
"code": [400, 422],
"dateTimeBeforeQryExec": "2017-04-26 14:25:32"
}
| Name | Requirement | Type | Description |
|---|---|---|---|
| version | v3 | string | API version |
| vatRateId | int | Vat rate Id |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| 422 |
|
Documentation auto-generated on Fri, 16 Jan 26 19:31:32 +0100