Introduction Api V1
This documentation aims to provide all the information you need to work with our API.
Base URL
https://posapis.comAuthenticating requests
This API is not authenticated.
Endpoints
Returns authenticated users details.
This API is used to login in order to use the APIs.
It must be given two Identifiers: username and password.
The API will return an Authentication token that needs to be used to access needed APIs.
The authentication token returned by this API will expire after 1 hour.
After the token expires, you will need to log in again to obtain a new token.
Example request:
curl --request POST \
"https://posapis.com/api/v1/login?username=example@bimpos.com&password=Ex@mple" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
const url = new URL(
"https://posapis.com/api/v1/login?username=example@bimpos.com&password=Ex@mple"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
Log the user out (Invalidate the token).
This endpoint logs the user out of the system. Upon successful logout, the user's authentication token will be invalidated, preventing any further access to protected resources using that token.
Example request:
curl --request POST \
"https://posapis.com/api/v1/logout" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/logout"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response :
Request failed with error:
Refresh a token.
This endpoint is designed to securely refresh authentication tokens for users. It ensures that users maintain continuous access to the application without the need to re-authenticate frequently.
Example request:
curl --request POST \
"https://posapis.com/api/v1/refresh" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/refresh"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
Get the authenticated User.
Example request:
curl --request POST \
"https://posapis.com/api/v1/signup" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/signup"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
GET Update ID(s)
This API will list all the update ids related to the logged in user. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/updateid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/updateid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 50
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"updateid": 0
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 50
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Branch(s)
- This API lists all branches related to the logged-in user, so an authentication token is required to use this API.
- It can accept an optional Branch ID to fetch a specific branch. If the Branch ID is not provided, the API will display all branches.
Response Details
- Branches with an isactive value of 0 are not currently active and should not be considered open or operational.
- Each branch includes an array of cities it covers for delivery, listed under the 'cities' field.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/branches/branchid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/branches/branchid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 50
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"id": 1,
"name": "burgerr",
"address": "fanar",
"phone": "81659104",
"email": "charbe.eid@bimpos.com",
"longitude": "0.000000",
"latitude": "0.000000",
"clientid": "BIM111",
"picpath": null,
"isactive": 1,
"openinghours": "12 till 23",
"picture": null,
"acceptsdelivery": 1,
"acceptstakeaway": 1,
"deliveryhours": null,
"created_at": "2022-04-12 11:46:35",
"updated_at": "2022-06-10 12:00:42",
"cities": [
{
"id": 10003,
"name": "adonis",
"citycode": 10002,
"countrycode": 10001,
"zipcode": 0,
"isactive": 1,
"clientid": "BIM111",
"versionid": 1,
"created_at": "2021-12-09 16:19:19",
"updated_at": null
},
{
"id": 10180,
"name": "Dora",
"citycode": 10003,
"countrycode": 10001,
"zipcode": 0,
"isactive": 1,
"clientid": "BIM111",
"versionid": 1,
"created_at": "2021-12-09 16:23:58",
"updated_at": null
},
{
"id": 10231,
"name": "Mkaless",
"citycode": 10003,
"countrycode": 10001,
"zipcode": 0,
"isactive": 1,
"clientid": "BIM111",
"versionid": 1,
"created_at": "2021-12-09 16:25:19",
"updated_at": null
},
{
"id": 10860,
"name": "North ",
"citycode": 10006,
"countrycode": 10001,
"zipcode": 0,
"isactive": 1,
"clientid": "BIM111",
"versionid": 1,
"created_at": "2021-12-09 16:25:55",
"updated_at": null
},
{
"id": 10002,
"name": "Adma ",
"citycode": 10002,
"countrycode": 10001,
"zipcode": 0,
"isactive": 1,
"clientid": "BIM111",
"versionid": 1,
"created_at": "2021-12-09 16:19:17",
"updated_at": null
}
]
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 50
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Gallery(s)
This API allows you to retrieve Galleries associated with the logged-in user.
Each gallery contains a collection of photos.
You can specify a Gallery ID to fetch a specific Gallery, although this parameter is optional.
Please note that an authentication token is required to access the API.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/galleries/galleryid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/galleries/galleryid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 36
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"galleries": [
{
"id": 1000,
"name": "Cakes",
"isactive": 1,
"versionid": 1,
"clientid": "BIM111",
"created_at": "2022-04-02 06:16:57",
"updated_at": null,
"gallery_photos": [
{
"gallery_photo_id": 1000,
"galleryid": 1000,
"title": "yumy cake",
"descript": "chocolate",
"refnum": "EAS123",
"minorderqty": 1,
"price": 150000,
"isactive": 1,
"versionid": 1,
"picpath": "https://posapis.com/BIM111/gallery/Cakes/BIM11162bc3d457431e.jpg",
"created_at": "2022-06-29 11:53:41",
"updated_at": null
}
]
}
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 36
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Department(s)
This API will list all Departments related to the logged in user. It can be given a Department ID to fetch a specific Department. The API requires an Authentication token.
Each department in the response contains an 'isactive' field. A value of 0 indicates that the department is currently closed.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/departments/departmentid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/departments/departmentid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 34
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"departments": [
{
"id": 1001,
"name": "dev",
"email": "dev@store.com",
"mobile": "04111111",
"isactive": 1,
"versionid": 1,
"clientid": "BIM111",
"created_at": "2022-06-29 12:00:30",
"updated_at": null
}
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 34
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Department(s) Feedback
API Description:
This API retrieves a list of departments along with their respective feedbacks that are related to the logged-in user. Each department has a collection of feedback entries.
Functionality:
- List Departments with Feedbacks: This API endpoint lists all departments related to the logged-in user. Each department is accompanied by a list of feedback entries associated with it.
- Fetch Feedbacks for a Specific Department: By providing a departmentid parameter in the request, you can fetch all feedbacks for a specific department.
Authentication:
This API requires an authentication token (Authorization: Bearer your_auth_token) to be included in the headers of the HTTP request.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/department/feedbacks/:departmentid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/department/feedbacks/:departmentid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 35
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"departments": [
{
"id": 1001,
"name": "dev",
"email": "dev@store.com",
"mobile": "04111111",
"isactive": 1,
"versionid": 1,
"clientid": "BIM111",
"created_at": "2022-06-29 12:00:30",
"updated_at": null,
"feedbacks": [
{
"id": 1001,
"departmentid": 1001,
"mobile": "04111112",
"msg": "The work is perfect",
"type": 1,
"isactive": 1,
"versionid": 1,
"clientid": "BIM111",
"created_at": "2022-06-30 12:47:44",
"updated_at": null
}
]
}
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 35
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Web Content(s)
This API will list all Web Contents related to the logged in user. It can be given a Content ID to fetch a specific Web Content. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/contents/:contentid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/contents/:contentid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 33
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"contents": [
{
"id": 1000,
"pagetitle": "About Us",
"pageurl": "https://bimpos.com/aboutus.html",
"isactive": 1,
"versionid": 3,
"clientid": "BIM111",
"created_at": "2022-06-30 12:52:39",
"updated_at": "2022-06-30 15:52:39"
}
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 33
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Charge(s)
This API will list all Charges related to the logged in user. It can be given a Charge ID to fetch a specific Charge. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/charges/:chargeid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/charges/:chargeid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 51
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"id": 1002,
"descript": "any: \rescription",
"tax1": 1,
"tax2": 0,
"tax3": 0,
"isactive": 1,
"sdate": 1,
"edate": 2,
"byamount": 0,
"bypercent": 0,
"setamount": 2.5,
"openpercent": 0,
"openamount": 0,
"typ": 0,
"customschedule": 1,
"branchid": 1,
"autoadd": 1,
"appliedontaxex": 0,
"clientid": "BIM111",
"created_at": "2021-11-18 10:44:11",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 51
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Update(s)
This API will list all Updates conserning the changed data in products APIs, related to the logged in user. It can be given a Update ID to fetch a specific Update. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/updates/:updateid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/updates/:updateid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 44
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Branch Setting(s)
This API will list all Branch Settings, related to the logged in user. It can be given a Setting ID to fetch a specific Branch Setting. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/branch/settings/:settingid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/branch/settings/:settingid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 45
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"branch_settings": [
{
"settingkey": "ACCTMASK",
"clientid": "BIM111",
"stringvalue": "#/#/#/#/#/###/#",
"numvalue": 0,
"doublevalue": 0,
"boolvalue": 0,
"created_at": "2021-12-17 14:23:48",
"updated_at": "2021-12-20 11:41:37"
}
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 45
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET App Setting(s)
API Description:
This API endpoint retrieves all application settings related to the authenticated user.
Optionally, you can provide a specific Setting ID to fetch details for that particular setting.
The request requires an authentication token.
Response:
The response is a JSON object containing an array named appSettings.
Each entry in this array represents a specific app setting related to the authenticated user,
including configuration details like currency, display preferences, app version info, and catalog IDs.
Additionally, each setting includes metadata such as its ID, status, client ID, and timestamps for creation and updates.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/app/settings/:settingid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/app/settings/:settingid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 32
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"appSettings": [
{
"id": 1000,
"currency": "LBP",
"showRemarksOnQuestions": 1,
"showRemarksOnAllItems": 1,
"mobilePrefix": "03",
"androidMaintenanceMode": 0,
"androidMinVersion": "1.0.0",
"androidCurVersion": "1.0.1",
"iosMinVersion": "1.0.0",
"iosCurVersion": "1.0.1",
"moneyFormat": "##/##",
"phoneMask": "(##)-(######)",
"showBigCategory": 1,
"orderMenuCatalogId": 1,
"galleryCatalogId": 1,
"productCatalogId": 1,
"isactive": 1,
"versionid": 1,
"clientid": "BIM111",
"created_at": "2022-06-30 13:14:30",
"updated_at": null
}
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 32
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Aggregators
This API will list all Aggregators, based on the source ID provided.
It must be given a Source ID to fetch specific Aggrigators.
The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/aggregators/:sourceid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/aggregators/:sourceid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 32
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"id": 726,
"integratorId": 8,
"channelId": 1,
"channelName": "Careem",
"created_at": "2023-04-24T08:38:53.000000Z",
"updated_at": null
},
{
"id": 729,
"integratorId": 8,
"channelId": 2,
"channelName": "Deliveroo",
"created_at": "2023-04-24T11:42:35.000000Z",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 32
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Currency Type(s)
This API will list all Currency Types related to the logged in user.
It can be given a Currency Type ID to fetch a specific Currency Type.
The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/currencytypes/:currencytypeid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/currencytypes/:currencytypeid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"id": 1000,
"description": "cash",
"is_active": 1,
"client_id": "BIM111",
"created_at": "2023-01-27 16:46:40",
"updated_at": null
},
{
"id": 1001,
"description": null,
"is_active": 1,
"client_id": "BIM111",
"created_at": "2023-02-08 17:59:19",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Currency(s)
This API will list all Currencies related to the logged in user.
It can be given a Currency ID to fetch a specific Currency.
The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/currencies/:currencyid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/currencies/:currencyid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"id": 1000,
"description": "LBP",
"long_description": "Lebanese Pounds",
"change1": 100000,
"change2": 100000,
"change3": 100000,
"change4": 50000,
"change5": 50000,
"change6": 100000,
"change7": 100000,
"change8": 100000,
"change9": 50000,
"change10": 50000,
"is_default": 0,
"conversion": "1.000000000000",
"conversion2": 16000,
"is_active": 1,
"is_second_currency": 0,
"hide_changes": 0,
"decimals": 1,
"accounting_code": null,
"currency_mask": null,
"show_in_pos": 1,
"show_in_calc": 1,
"read_only": 0,
"sequence": 1,
"show_credit_card_form": 1,
"show_check_form": 1,
"show_in_bo": 1,
"goes_to_bank": 1,
"type": 100,
"currency_type": 100,
"is_gift_voucher": 1,
"caption": null,
"client_id": "BIM111",
"created_at": "2023-01-27 14:37:09",
"updated_at": null
},
{
"id": 1001,
"description": "USD",
"long_description": "US Dollars",
"change1": 100000,
"change2": 100000,
"change3": 100000,
"change4": 50000,
"change5": 50000,
"change6": 100000,
"change7": 100000,
"change8": 100000,
"change9": 50000,
"change10": 50000,
"is_default": 1,
"conversion": "15000.000000000000",
"conversion2": 1,
"is_active": 1,
"is_second_currency": 1,
"hide_changes": 0,
"decimals": 1,
"accounting_code": null,
"currency_mask": null,
"show_in_pos": 1,
"show_in_calc": 1,
"read_only": 0,
"sequence": 1,
"show_credit_card_form": 1,
"show_check_form": 1,
"show_in_bo": 1,
"goes_to_bank": 1,
"type": 100,
"currency_type": 100,
"is_gift_voucher": 1,
"caption": null,
"client_id": "BIM111",
"created_at": "2023-01-27 14:37:09",
"updated_at": null
},
{
"id": 1002,
"description": "USDF",
"long_description": "Lebanese Pounds",
"change1": 100000,
"change2": 100000,
"change3": 100000,
"change4": 50000,
"change5": 50000,
"change6": 100000,
"change7": 100000,
"change8": 100000,
"change9": 50000,
"change10": 50000,
"is_default": 0,
"conversion": "60000.000000000000",
"conversion2": 4,
"is_active": 1,
"is_second_currency": 0,
"hide_changes": 0,
"decimals": 1,
"accounting_code": null,
"currency_mask": null,
"show_in_pos": 1,
"show_in_calc": 1,
"read_only": 0,
"sequence": 1,
"show_credit_card_form": 1,
"show_check_form": 1,
"show_in_bo": 1,
"goes_to_bank": 1,
"type": 100,
"currency_type": 100,
"is_gift_voucher": 1,
"caption": null,
"client_id": "BIM111",
"created_at": "2023-01-27 14:37:09",
"updated_at": null
},
{
"id": 14,
"description": "د.إ",
"long_description": "درهم إماراتي",
"change1": 0,
"change2": 0,
"change3": 0,
"change4": 0,
"change5": 0,
"change6": 0,
"change7": 0,
"change8": 0,
"change9": 0,
"change10": 0,
"is_default": 0,
"conversion": "1.000000000000",
"conversion2": 1.25e-5,
"is_active": 1,
"is_second_currency": null,
"hide_changes": 1,
"decimals": 0,
"accounting_code": null,
"currency_mask": "###,##0.00",
"show_in_pos": 1,
"show_in_calc": 1,
"read_only": 0,
"sequence": 20,
"show_credit_card_form": 0,
"show_check_form": 0,
"show_in_bo": 1,
"goes_to_bank": 0,
"type": 0,
"currency_type": 1,
"is_gift_voucher": 0,
"caption": null,
"client_id": "BIM111",
"created_at": "2023-03-11 22:06:03",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Price List(s)
This API will list all Price Lists related to the logged in user.
It can be given a Price List ID to fetch a specific Price List.
The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/pricelists/:pricelistid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/pricelists/:pricelistid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"id": 1,
"currency_id": 1001,
"description": "price list description",
"is_active": 1,
"is_tax_excluded": 1,
"client_id": "BIM111",
"created_at": "2023-01-27 16:01:00",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Price List Detail(s)
Overview:
This API retrieves all Price List Details associated with the authenticated user. You can also fetch a specific Price List Detail by providing its ID.
Authentication:
The API requires an authentication token to be included in the request headers. Ensure that you have a valid token before making requests.
Response:
The response is an array of Price List Details. Each Price List Detail includes various attributes, as shown in the example.
Each pricelistdetail in the response is associated with a specific pricelist identified by the price_list_id field.
This ensures that all details are linked to their respective price lists, allowing for organized and structured data retrieval.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/pricelistdetails/:pricelistdetailid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/pricelistdetails/:pricelistdetailid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"id": 1000,
"price_list_id": 1000,
"product_number": 3000,
"price": 5,
"is_active": 1,
"client_id": "BIM111",
"created_at": "2023-01-27 16:11:02",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Price List Branch(s)
Description:
This API retrieves a list of all Price List Branches associated with the logged-in user.
Optionally, a specific Price List Branch ID can be provided to fetch details for that particular branch.
The API requires an authentication token to be included in the request headers.
Response:
The response is a JSON array of objects, where each object contains details about a Price List Branch.
Each price_list_branch_id in the response is associated with a specific price_list_id.
Therefore, each Price List Branch is directly related to a specific Price List.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/pricelistbranches/:pricelistbranchid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/pricelistbranches/:pricelistbranchid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"price_list_branch_id": 1000,
"price_list_id": 1,
"branch_id": 1001,
"is_active": 1,
"version_id": 8,
"client_id": "BIM111",
"created_at": "2023-03-29T12:11:58.000000Z",
"updated_at": "2023-03-29T12:11:58.000000Z"
},
{
"price_list_branch_id": 1001,
"price_list_id": 1,
"branch_id": 1001,
"is_active": 1,
"version_id": 1,
"client_id": "BIM111",
"created_at": "2023-03-29T12:11:58.000000Z",
"updated_at": "2023-03-29T12:11:58.000000Z"
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Parent(s)
This API will list all Parents related to the logged in user. It can be given a Parent ID to fetch a specific Parent. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/parents/:parentid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/parents/:parentid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"id": 1,
"descript": "Deliverect",
"versionid": 3,
"isactive": 1,
"created_at": "2021-12-09 16:17:39",
"updated_at": "2022-04-05 09:56:31"
},
{
"id": 2,
"descript": "DEVS",
"versionid": 1,
"isactive": 1,
"created_at": "2022-03-31 06:21:15",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Category(s)
This API will list all Categories related to the logged in user. It can be given a Category ID to fetch a specific Category. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/categories/:catid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/categories/:catid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 57
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"catid": 1,
"menuid": 1,
"parentid": 1,
"catname": "",
"descript": "Platters",
"descript2": "",
"picpath": "https://posapis.com/BIM111/categories/original/BIM111624c06b69f48c.jpg",
"picture": "https://posapis.com/BIM111/categories/original/BIM111624c06b69f48c.jpg",
"thumb_picture": null,
"headerpicpath": null,
"footerpicpath": null,
"bgpicpath": null,
"seq": 1,
"versionid": 6,
"isactive": 1,
"created_at": "2021-12-10 08:08:09",
"updated_at": "2022-04-05 12:07:02"
},
{
"catid": 2,
"menuid": 1,
"parentid": 1,
"catname": "",
"descript": "Burger Sandwiches",
"descript2": "",
"picpath": "https://posapis.com/BIM111/categories/original/BIM111624c06b7d3cb3.jpg",
"picture": "https://posapis.com/BIM111/categories/original/BIM111624c06b7d3cb3.jpg",
"thumb_picture": null,
"headerpicpath": null,
"footerpicpath": null,
"bgpicpath": null,
"seq": 2,
"versionid": 4,
"isactive": 1,
"created_at": "2021-12-10 08:08:10",
"updated_at": "2022-04-05 12:07:03"
},
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 57
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET List Categories With Parent ID
This API will list all Categories related to a certain Parent to the logged in user. It mustgiven a Parent ID to fetch a list of categories for the specified parent. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/parents/:parentid/categories" \
--header "Content-Type: application/json" \
--header "Accept: application/json"\
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/parents/:parentid/categories"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 52
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"catid": 1,
"menuid": 1,
"parentid": 1,
"catname": "",
"descript": "Platters",
"descript2": "",
"picpath": "https://posapis.com/BIM111/categories/original/BIM111624c06b69f48c.jpg",
"picture": "https://posapis.com/BIM111/categories/original/BIM111624c06b69f48c.jpg",
"thumb_picture": null,
"headerpicpath": null,
"footerpicpath": null,
"bgpicpath": null,
"seq": 1,
"versionid": 6,
"isactive": 1,
"created_at": "2021-12-10 08:08:09",
"updated_at": "2022-04-05 12:07:02"
},
{
"catid": 2,
"menuid": 1,
"parentid": 1,
"catname": "",
"descript": "Burger Sandwiches",
"descript2": "",
"picpath": "https://posapis.com/BIM111/categories/original/BIM111624c06b7d3cb3.jpg",
"picture": "https://posapis.com/BIM111/categories/original/BIM111624c06b7d3cb3.jpg",
"thumb_picture": null,
"headerpicpath": null,
"footerpicpath": null,
"bgpicpath": null,
"seq": 2,
"versionid": 4,
"isactive": 1,
"created_at": "2021-12-10 08:08:10",
"updated_at": "2022-04-05 12:07:03"
},
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 52
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Question Detail(s)
This API will list all Question Detail related to the logged in user. It can be given a Question Detail ID to fetch a specific Currency Type. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/questiondetails/:questionid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/questiondetails/:questionid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"id": 1,
"headerid": null,
"prodnum": null,
"sequenceorder": null,
"weight": null,
"clientid": "TRA111",
"created_at": "2023-11-23T10:18:59.000000Z",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Question Group Detail(s)
This API will list all Question Group Detail related to the logged in user. It can be given a Question Group Detail ID to fetch a specific Currency Type. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/questiongroup/details/:questionid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/questiongroup/details/:questionid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"uniqueid": 1,
"qgid": 1,
"headerid": 1,
"seq": null,
"conceptid": null,
"clientid": "TRA111",
"created_at": "2023-11-23T10:32:44.000000Z",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Question Group Header(s)
This API will list all Question Group Header related to the logged in user. It can be given a Question Group Header ID to fetch a specific Currency Type. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/questiongroup/headers/:questionid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/questiongroup/headers/:questionid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"id": 1,
"descript": "descrip",
"isactive": 0,
"conceptid": null,
"clientid": "TRA111",
"created_at": "2023-11-23T10:37:12.000000Z",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Question Header(s)
This API will list all Question Header related to the logged in user. It can be given a Question Header ID to fetch a specific Currency Type. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/questionheaders/:questionid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/questionheaders/:questionid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"id": 1,
"descript": "descript",
"isactive": 1,
"required": 1,
"min": null,
"max": null,
"conceptid": null,
"fontsize": null,
"cols": null,
"searchable": null,
"backcolor": null,
"forecolor": null,
"enablesameitemordering": null,
"clientid": "TRA111",
"created_at": "2023-11-23T10:44:56.000000Z",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 53
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Product(s)
Descriprion:
This API endpoint retrieves a list of products associated with the logged-in user.
It fetches all products from the Head Office that are available for the user to view.
The endpoint requires an authentication token to ensure that only authorized users can access the product information.
No additional parameters are required for this endpoint.
Response:
- The response is a JSON object containing a list of products. Each product object includes various details such as descriptions, pricing, and stock information.
-
The stocks array provides detailed information about the availability of the product across different branches.
Each stock object includes:
- prodnum: The product number, linking the stock information to the specific product.
- branchid: The ID of the branch where the stock is located. This helps identify which branch has the product available.
- stock: The quantity of the product available at the specified branch. This field indicates how much stock is currently on hand.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/products" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/products"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
.
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 55
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"products": [
{
"prodnum": 17,
"catid": 1,
"descript": "Moulokieh CB",
"descript2": null,
"prodinfo": "Mloukhiyeh, Chicken, Onion, Corriander, Garlic\nWhite Rice",
"prodinfo2": "",
"price": 33000,
"pid": 1,
"SKUID1": 2,
"SKUID2" : 23,
"thumb_picture": null,
"brand": "",
"country_of_origin": null,
"weight": null,
"weight_unit": null,
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"ModifiersGroupID": 0,
"ComboGroupID": 17,
"versionid": 3,
"isactive": 1,
"created_at": "2021-12-10 08:08:12",
"updated_at": "2022-04-05 11:56:23",
"product_picture": null,
"title": null,
"tags": "",
"stocks": [
{
"prodnum": 17,
"branchid": 1,
"variation1": 0,
"variation2": 0,
"stock": 20,
"stock_updated_at": "2022-06-30 16:29:31"
}
]
},
{
"prodnum": 19,
"catid": 1,
"descript": "Fasoulia Bi Lahme (Combo)",
"descript2": null,
"prodinfo": "Tomato Sauce, Fasoliya, Beef meat",
"prodinfo2": "",
"price": 33000,
"pid": 1,
"SKUID1": 2,
"SKUID2" : 23,
"thumb_picture": null,
"brand": "",
"country_of_origin": null,
"weight": null,
"weight_unit": null,
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"ModifiersGroupID": 0,
"ComboGroupID": 19,
"versionid": 3,
"isactive": 1,
"created_at": "2021-12-10 08:08:14",
"updated_at": "2022-04-05 11:56:24",
"product_picture": null,
"title": null,
"tags": "",
"stocks": [
{
"prodnum": 19,
"branchid": 1,
"variation1": 0,
"variation2": 0,
"stock": 20,
"stock_updated_at": "2022-06-30 16:30:12"
}
]
},
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 55
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET A Product
This API will list A Products related to the logged in user. It must be given a Product ID to fetch a specific Product. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/product/:prodnum" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/product/:prodnum"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 56
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"products": [
{
"prodnum": 17,
"catid": 1,
"descript": "Moulokieh CB",
"descript2": null,
"prodinfo": "Mloukhiyeh, Chicken, Onion, Corriander, Garlic\nWhite Rice",
"prodinfo2": "",
"price": 33000,
"pid": 1,
"SKUID1": 2,
"SKUID2" : 23,
"thumb_picture": null,
"brand": "",
"country_of_origin": null,
"weight": null,
"weight_unit": null,
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"ModifiersGroupID": 0,
"ComboGroupID": 17,
"versionid": 3,
"isactive": 1,
"created_at": "2021-12-10 08:08:12",
"updated_at": "2022-04-05 11:56:23",
"product_picture": null,
"title": null,
"tags": "",
"stocks": [
{
"prodnum": 17,
"branchid": 1,
"variation1": 0,
"variation2": 0,
"stock": 20,
"stock_updated_at": "2022-06-30 16:29:31"
}
]
}
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 56
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET A Product By Category
This API will list A Product by Product ID and Category ID related to the logged in user. It must be given a Product ID and a Category ID to fetch a specific Product. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/product/:productid/category/:categoryid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/product/:productid/category/:categoryid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 56
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"products": [
{
"prodnum": 17,
"catid": 1,
"descript": "Moulokieh CB",
"descript2": null,
"prodinfo": "Mloukhiyeh, Chicken, Onion, Corriander, Garlic\nWhite Rice",
"prodinfo2": "",
"price": 33000,
"pid": 1,
"thumb_picture": null,
"brand": "",
"country_of_origin": null,
"weight": null,
"weight_unit": null,
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"ModifiersGroupID": 0,
"ComboGroupID": 17,
"versionid": 3,
"isactive": 1,
"created_at": "2021-12-10 08:08:12",
"updated_at": "2022-04-05 11:56:23",
"product_picture": null,
"title": null,
"tags": "",
"stocks": [
{
"prodnum": 17,
"branchid": 1,
"variation1": 0,
"variation2": 0,
"stock": 20,
"stock_updated_at": "2022-06-30 16:29:31"
}
]
}
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 56
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Product Stock(s)
This API will list all Product Stocks related to the logged in user. It can be given a Product ID to fetch a specific Product Stock. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/productstock/:prodnum" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/productstock/:prodnum"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 54
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"prodnum": 17,
"product_name": "Moulokieh CB",
"stock": 20,
"variation1": 0,
"variation2": 0,
"clientid": "BIM111",
"versionid": 9
},
{
"prodnum": 19,
"product_name": "Fasoulia Bi Lahme (Combo)",
"stock": 20,
"variation1": 0,
"variation2": 0,
"clientid": "BIM111",
"versionid": 4
},
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 54
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Question(s)
This API will list all Questions related to the logged in user. It can be given a Question ID to fetch a specific Question. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/questions/:questionid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/questions/:questionid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 39
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"qgid": 1,
"descript": "BREAKFAST",
"questionheaders": [
{
"qhid": 1,
"qhdescript": "BREAKFAST Question 1",
"min": 0,
"max": 2,
"required": 0,
"seq": 1,
"items": [
{
"prodnum": 742,
"catid": 0,
"descript": ".. EGGS",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 2,
"isactive": 1,
"created_at": "2022-03-07 15:16:09",
"updated_at": "2022-03-07 17:22:23"
},
{
"prodnum": 743,
"catid": 0,
"descript": "..SUNNY SIDE.",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 3,
"isactive": 1,
"created_at": "2022-03-07 15:16:16",
"updated_at": "2022-03-07 17:22:25"
},
{
"prodnum": 744,
"catid": 0,
"descript": "..MEDIUM",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 3,
"isactive": 1,
"created_at": "2022-03-07 15:16:19",
"updated_at": "2022-03-07 17:22:26"
},
{
"prodnum": 745,
"catid": 0,
"descript": "..HARD EGGS",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 3,
"isactive": 1,
"created_at": "2022-03-07 15:16:22",
"updated_at": "2022-03-07 17:22:28"
},
{
"prodnum": 746,
"catid": 0,
"descript": "..SCRAMBLED",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 3,
"isactive": 1,
"created_at": "2022-03-07 15:16:26",
"updated_at": "2022-03-07 17:22:29"
},
{
"prodnum": 747,
"catid": 0,
"descript": "..NO EGG",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 3,
"isactive": 1,
"created_at": "2022-03-07 15:16:29",
"updated_at": "2022-03-07 17:22:31"
},
{
"prodnum": 771,
"catid": 0,
"descript": "BOERWORS",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 2,
"isactive": 1,
"created_at": "2022-03-07 15:18:53",
"updated_at": "2022-03-07 17:23:09"
},
{
"prodnum": 772,
"catid": 0,
"descript": "DHANIA SUASAGE",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 3,
"isactive": 1,
"created_at": "2022-03-07 15:19:58",
"updated_at": "2022-03-07 17:23:10"
}
]
},
{
"qhid": 28,
"qhdescript": "BREAKFAST Question 2",
"min": 0,
"max": 1,
"required": 0,
"seq": 2,
"items": [
{
"prodnum": 873,
"catid": 0,
"descript": "BACON",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 2,
"isactive": 1,
"created_at": "2022-03-07 15:20:05",
"updated_at": "2022-03-07 17:22:19"
},
{
"prodnum": 872,
"catid": 0,
"descript": "POLONY.",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 2,
"isactive": 1,
"created_at": "2022-03-07 15:20:01",
"updated_at": "2022-03-07 17:22:17"
}
]
}
]
},
{
"qgid": 2,
"descript": "KIDS MENU ",
"questionheaders": [
{
"qhid": 2,
"qhdescript": "KIDS MENU Question 1",
"min": 1,
"max": 1,
"required": 1,
"seq": 1,
"items": [
{
"prodnum": 749,
"catid": 0,
"descript": "WITH GARNISH ",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 3,
"isactive": 1,
"created_at": "2022-03-07 15:16:32",
"updated_at": "2022-03-07 17:22:34"
},
{
"prodnum": 748,
"catid": 0,
"descript": "NO GARNISH",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 3,
"isactive": 1,
"created_at": "2022-03-07 15:16:35",
"updated_at": "2022-03-07 17:22:32"
}
]
}
]
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 39
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Combo(s)
This API will list all Combos related to the logged in user. It can be given a Combo ID to fetch a specific Combo. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/combos/:comboid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/combos/:comboid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 37
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"combogroupid": 4,
"comboPrice": 0,
"headers": [
{
"comboid": 29,
"seq": 1,
"descript": "Beverages (Cater Plus)",
"min": 0,
"max": 1,
"required": 0,
"items": [
{
"prodnum": 399,
"catid": 0,
"descript": "Diet Pepsi (Free)",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "0",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 1,
"isactive": 1,
"created_at": "2021-12-09 21:15:44",
"updated_at": null
},
{
"prodnum": 401,
"catid": 0,
"descript": "Diet Seven Up (Free)",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "0",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 1,
"isactive": 1,
"created_at": "2021-12-09 21:15:50",
"updated_at": null
},
{
"prodnum": 402,
"catid": 0,
"descript": "Mirinda (Free)",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "0",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 1,
"isactive": 1,
"created_at": "2021-12-09 21:15:47",
"updated_at": null
},
{
"prodnum": 398,
"catid": 0,
"descript": "Pepsi (Free)",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "0",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 1,
"isactive": 1,
"created_at": "2021-12-09 21:15:45",
"updated_at": null
},
{
"prodnum": 400,
"catid": 0,
"descript": "Seven Up (Free) ",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "0",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 1,
"isactive": 1,
"created_at": "2021-12-09 21:15:52",
"updated_at": null
},
{
"prodnum": 403,
"catid": 0,
"descript": "Water Small (Free) ",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 7,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "0",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 1,
"isactive": 1,
"created_at": "2021-12-09 21:15:49",
"updated_at": null
},
{
"prodnum": 496,
"catid": 0,
"descript": "Lemon Ice Tea - Lipton (Free)",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "0",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 1,
"isactive": 1,
"created_at": "2021-12-09 21:17:03",
"updated_at": null
},
{
"prodnum": 1302,
"catid": 0,
"descript": "Lemon Ice Tea Diet - Lipton (Free) ",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "0",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 1,
"isactive": 1,
"created_at": "2021-12-09 21:17:04",
"updated_at": null
},
{
"prodnum": 497,
"catid": 0,
"descript": "Peach Ice Tea- Lipton (Free) ",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "0",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 1,
"isactive": 1,
"created_at": "2021-12-09 21:17:06",
"updated_at": null
},
{
"prodnum": 1301,
"catid": 0,
"descript": "Peach Ice Tea Diet - Lipton (Free) ",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "0",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 1,
"isactive": 1,
"created_at": "2021-12-09 21:17:07",
"updated_at": null
},
{
"prodnum": 1303,
"catid": 0,
"descript": "Fruit Ice Tea - Lipton (Free)",
"descript2": null,
"prodinfo": "",
"prodinfo2": "",
"price": 0,
"picpath": null,
"picture": null,
"groupid": 0,
"stock": null,
"enabled": 1,
"pid": 1,
"clientid": "BIM111",
"thumb_picture": null,
"brand": "",
"refcode1": "",
"refcode2": "0",
"istaxable1": 1,
"istaxable2": 0,
"istaxable3": 0,
"versionid": 1,
"isactive": 1,
"created_at": "2021-12-09 21:17:09",
"updated_at": null
}
]
}
]
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 37
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
POST Product Stock
This API will insert or update Product Stocks related to a specific branch and related to the logged in user. It must be given a Product number to post for a specific Product Stock. It must be given to variables, variation1 and variation2. It must be given a data json as Query Parameter that contains the Branch ID and the Stock amount. It can be given an isactive field in the data json that can only take 1 and 0 as values. If isactive is not given by default it will contain a value of 1. If given isactive equals to 1, the data will be inserted or updated, while if the isactive equals to 0, the available stock will be deleted. The API requires an Authentication token.
Example request:
curl --request POST \
"https://posapis.com/api/v1/product/:prodnum/:variation1/:variation2/stock?data={"branchid": 1, "stock":2, "isactive": 1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/product/:prodnum/:variation1/:variation2/stock?data={"branchid": 1, "stock":2, "isactive": 1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Product Stocks
This API will insert or update Product Stocks related to a specific branch and related to the logged in user. It must be given a Product number to post for a specific Product Stock. It must be given to variables, variation1 and variation2. It must be given a data json array as Query Parameter that contains the Branch ID and the Stock amount. It can be given an isactive field in the data json that can only take 1 and 0 as values. If isactive is not given by default it will contain a value of 1. If given isactive equals to 1, the data will be inserted or updated, while if the isactive equals to 0, the available stock will be deleted. This API can be given many branches to manipulate its product stocks. The API requires an Authentication token.
Example request:
curl --request POST \
"https://posapis.com/api/v1/product/:prodnum/:variation1/:variation2/stocks?data=[{"branchid": 1001, "stock":21, "isactive":1},{"branchid": 1, "stock":2, "isactive":1}]" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/product/:prodnum/:variation1/:variation2/stocks?data=[{"branchid": 1001, "stock":21, "isactive":1},{"branchid": 1, "stock":2, "isactive":1}]"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Order
This API is used to add an Order. This API can be given a member picture in request body. It must be given a data json that contains several Identifiers listed in the tables bellow. The API requires an Authentication token.
Order
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| branchid | integer | The Branch ID | Yes | |
| orderid | integer | The the Order number (ID) | Yes | |
| sourceid | integer | The the Order source number (ID) | No | |
| status | integer | The the Order Status ID | No | |
| ordertype | integer | The the Order Type | Yes | |
| orderdate | integer | The the Order Date | 20220622 | Yes |
| paymenttype | integer | The Order payment type | Yes | |
| note | string | The Order note / message / remark | No | |
| ispaid | integer | If the Order had been paid | (1 - 0) | No |
| deliveryCost | integer | The Order delivery cost | No | |
| serviceCharge | integer | The Order service charge amount | No | |
| totalDiscountAmount | double | The Order total discount amount | No | |
| member | The Order member | Yes |
Member
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| posreference | integer | The Order Member POS Reference ID | Yes | |
| membername | string | The Order Member name | Yes | |
| mobile | string | The Order Member mobile number | +9613123123 | Yes |
| mobilevalidated | integer | If Order Member mobile number validated | (1 - 0) | No |
| string | The Order Member email address | Yes | ||
| address | The Order Member Address | Yes |
The Member identifier contains several member identifiers. The Member posreference value should be a 0 if the member is a new member, after the order is posted successfully the API will list the new member hsmemberid in the response, this hsmemberid needs to be send as a posreference next time that same member places an order.
Address
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| posreference | integer | The Order Member Address POS Reference ID | Yes | |
| description | string | The Order Member Address description / name | Yes | |
| addresstype | integer | The Order Member Address type | Yes | |
| phone | string | If Order Member Address phone number | +9614123123 | No |
| geolong | double | The Order Member Address map geolong | Yes | |
| geolat | double | The Order Member Address map geolat | Yes | |
| citycode | integer | The Order Member Address city code (ID) | Yes | |
| street | string | The Order Member Address street description / name | Yes | |
| bldg | string | The Order Member Address building name / number | Yes | |
| floor | string | The Order Member Address floor name / number | Yes | |
| directions | string | The Order Member Address directions | No |
The Address identifier contains several address identifiers. The Address posreference value should be a 0 if the address is a new address, after the order is posted successfully the API will list the new address hsaddressid in the response, this hsaddressid needs to be send as a posreference next time that same address places an order.
Items
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| productcode | integer | The Order Item product code / number | Yes | |
| productqty | integer | The Order Item Quantity | Yes | |
| productprice | double | The Order Item price | Yes | |
| remark | string | The Order Item remark / essage | No | |
| modifiers | The Order Item modifiers | No | ||
| ComboProductCode | Integer | The Order Item Combo product code | No |
Modifiers
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| modifiercode | integer | The Order Item Modifier code / number | Yes | |
| modifierqty | integer | The Order Item Modifiers Quantity | Yes | |
| modifierprice | double | The Order Item Modifiers price | Yes | |
| modifiers_description | string | The Order Item Modifiers description / name | Yes |
Example request:
curl --request POST \
"https://posapis.com/api/v1/orders?data={
"order":
{
"branchid":1,
"orderid":951753852456,
"sourceid":2,
"status":1,
"ordertype":1,
"table_id":1,
"orderdate":20220506,
"ordertime":"2022-05-06%2012:31:55",
"paymenttype":0,
"note": "",
"ispaid": 0,
"deliveryCost": 10,
"serviceCharge": 5,
"totalDiscountAmount": 0,
"additional_info": {
"channel_id": 1,
"channel_name": "Talabat",
"channel_order_id": "123er456776",
"channel_order_display_id" : 333,
}
"member":
{
"posreference":"24",
"membername":"Elie%20el%20Haddad",
"mobile":"03123123",
"mobilevalidated":1,
"email":"atest@email.com",
"address":
{
"posreference":0,
"description":"Dora",
"addresstype":1,
"phone":"04123123",
"geolong":35.593402862549,
"geolat":33.94938659668,
"citycode":20021,
"street":"any%20street",
"bldg":"any%20building",
"floor":"any%20floor",
"directions":"any%20directions"
}
},
"items":[
{
"productcode":2010198,
"productqty":1,
"productprice":37000,
"comboproductcode": 2,
"modifiers":[
{
"modifiercode":1010200,
"modifierqty":1,
"modifierprice":0,
"modifiers_description":"Add%20Tomatos"
}]
}]
}
}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
-d '
{
"member_picture":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCBYWFRgVFRYYGBgZGhgYGhoaGBoYGhoYGRgZGhkYGBocIS4lHB4rIRgYJjgmKy8xNTU1GiQ7QDs0Py40NTEBDAwMEA8QHxISHzYrJCs0NDQ2NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NP/AABEIALEBHQMBIgACEQEDEQH/xAAbAAACAwEBAQAAAAAAAAAAAAAAAwECBAUGB//EADcQAAEDAgMEBwcEAwEBAAAAAAEAAhEDIQQxQRJRYXEFIoGRodHwExQyUpKxwQZi4fEVQlPScv/EABkBAAMBAQEAAAAAAAAAAAAAAAABAgMEBf/EACwRAAICAQMEAgEDBAMAAAAAAAABAhEDEiExBBNBUSJhFAWRoTJScbEVI0L/2gAMAwEAAhEDEQA/APk7HkKTddDE4RwzZxtosREZhaRaZrLHKLpjKMQWnXLmoZSkwhhByV2knKx+6Y1ToYykW3JieI+yl1PkfBVBn4s+OfeqvaQbFTTNdktlsDsODoezRZn0SOS3Uq0WcVocA4WcORgdx1RbXIu3GStHJa46qWs1WmtRM6dhCU0kWKswcXF7jHw6DHBMp4abyAN5Sp5KWAzIlDXo0TV7oa8SCBp4rC9q6LGA5G/JIfQ370kE4t7mWmbgrY+iYDtCkBkFb6dduyWOyN2ncdRyICb2FjinakZDVgRqqHepqNl3enMp9XthMVNuhuHEgjh9rpFSlErTRYZAGYV6jbmRmM+EKeGbuGqJjeAWi94hKYmPbuShmqRg+RxbISH5LRQ3KjmICStWZoUtKlzVaiLpoyrcs9iWm1ClwmN8lXhVIsmOCoQgllWNlONhxVqdM6epQ9kZoCnyJ2ZXRwrdmDlDT3mViYbi0J768tPOB5+t6lo0xtRdisRUtzJKzhspr22VC+ECbt2x9LE//XerVXg/CRxCyFpCsUqK7kqpgQdO5Wa7fPYfV0MfG9PaDpPggUVfBQGTme1MLDrMqvs0xr5sUGiXsKbNCh9CMrp4Yr1WWSs10bGUPjMFLiTmtIw8iRnulVbRIKdohwkJLCteEws5plslJdIAGYRdlxgk7YjEU4mNLJLHRc33z9wukzDyJ8FerhWhs6apX4L7TfyRzHtmIBSnMK1NaWktMx6utFPDg+rp2Z6GxGEw03Pj+EVeo4gQW6RxWvEv2LN1Ejgk4dm3DctB36+KF7KcUviuS+Ad1w6MuJATcUQSdmYmZ1J3clbF0dgtYPiHWd3WH3U0qUtzUOuTojFpPGc19O8jJKqMvOi14lkGAmUWAsdO+fAKr2Od47k0c9lrpjBmrGiRpZMowqZCi06ZhqtVaITsQEptgmjCaqRR5V2NtKXEpz8oTJW+4oqoCsQiEyRzK2zlnP8ASS90qitCQ7b2GtbAJPD8lUpNJ9ZBXdkeyO7NSynnpYd5QUo7g9s5fwqupN3qzWyLaLPUF1DLapXRZpBzQ1sZ5KjXJrSmSnZaoyDmDxCdQeBPFKdUJzv91QEoLtJ2jTYqfZpTXLbMtGUxeJ8Qk9jWNS5IL7QqG6q8qKTusPylQ3LemOpMvErVTpzbsCzuN7eu1DahzufW5SbQaTovXZBTKDbHRWcdrPNXbSIhKzRQ+VrgWx5aR6Kq55JI0OSaWg2hTVplsW7B6sqsHF19FsNhdpwDrcSlVz1zaAIHZknsrSImCr1Ke11t4AKm3e5pojKNRMNSnrE8VTDvjn5Lc2j1SLpDcMJmfyqTMpYmmmjVtbbQ8i4seSpQpEEgH1uTMNUDCfsZvvhanNnZLcjmdfFS3Wx0RimrfPk5tTDEyddyUxuy6H2BWikNp0HMTP8ACdicM0kcu1O62Zjo1fKJzsSCLC4GXJKc3KE/EsLbbsuSja6sd38KlwYyjcnZnq0ZWSqxb3TEHJZnMvG9UjnyRRFLDHYL9xhKcF38Rhtils/NB8FxHNRGWovNh7VJ80KDNyoWLbh2XMgwB/SzVDeVV7nM47WZyFYNV2slMdCZCRVomTyTqTNqeJvyCgU56rc/AJ9KWsjODpBsolwb44778CGVNm28Ge63csVXNNe8pClLyTkn4RMK7UNfwV7HKy0IRCArbBzQ22iB0WDMitFOkY/Pkq0HgWcJB8NxCY9kQM84P54JM2gklZWq0gXCSuuwNAG2C5pAAu3OL9maw1cLbaZlzB7LclKZc8flFGOyWu0W9FYQ/SEymb28k3EITrY2GrujjPkujhX7QEi4y/sLlUXda9wtzSBkBOhG71vWconbhnvbYpzyx9xacluZsuIG0AIi+fIDVYcW+4Ov3VsNsky4kEaIa2HGdSa8WajhQDInfY7lVlcNgd40g9is/FAWBz++47lUYfbEgiRmLb7mNVPjc2bV/wDXyPxDBBdOYEW1WbAQSY+IafcrXSZsjZsQQdAI4G8arDQGy8jI9yIu00GS006/yPq4UuLjFxr+EYdhbZ3wkgZgjxAWzDMqEmfhIMfdPexpbtG32nhGShy8GkcSfyWzODiGw8GYz9eK2UsUS6NkOmxMRA8lTpHDnMDL1mtWApPDCNppyyLT9iVo2nGzmhFrK4rbyczGM0HoLO+p1Y3Lo4ylHA68iubs804vYyzQakwgkC8+CRk5vAhdLDt/aO1Z6jOsTG5WnZlLG1TOx0z8AjcPsvPQu7jXl9Np5flYAyBkssWyOnrVrmmvSMmLeG9Rp1vzWEhPrsMqtNi6I7I8uduVAynZVcxPcICqXQpciu2qFUmEEE2BMKcTVnLkqPfPNUIQlfInLStKEuVS1Nc1UTZg0GypATIRCZekqCU3bnNV2VOygFaL20Tmu0y/PYs4amAlOi0xjgQLGw0U0sURbSe5UVdhFWPU07RqrxmBnrkeazVGa5qwUtQo0DlZFFxC1NxQ7fys5CqGFDimOMpR4N7XbQkdyq52+345LK0kJ9N5m90tNGiyWJqOIMSt+AxhabZ3y9ZrNXZJS29U2II4T+QhxUkKOSUJWmelw+JY8hsgOOUTE7oO9JxWAghxPVO65jgFhwZBEQJ0Pkus/FBrNg3zkk3jgR3LCUXGWx6kc8ckPkZamIa1o2STE9Uk98q1F7Hi7iCZsJ3G4hcvEEE2SGPLTIJC07aaOZ9W1LdbHUrYgjqPJ78tL8IW3A4ZrmSx/W4W3Lg1qjndZxJJzJzWjo/EPBhsj1qlKHx2FDqE8ltWju1MLLZdncTbMZgrF/jTsywbV9/krux2w0iZJ32HmfBIw3TGwbcsrd0idfNYKEuUdks+JtJmJ8ixBBCGmRG7Vegq0m1ADsQ46iYjtXMfhC3lv0vxCtSTVcMl4ZJ6k7RDX7TA2NfBQ9jTLZyFtxWh9HYYSTEWB/1M8ZWGmwzwA2ieHohKNU6DInaTXJgriVncYK0vMmdJy1WSsVpq2PPnCnZBeozU06ZJTH0ozU6tx6JNWI2VVyc5ij2cK9Rk4GchV2E5yqk5NkaUO9kj2a6LaKt7unqNe0c0UlPsl0hhke7J60HZZzgxWFNb/d1YYdPWHaZgFNW9ktwoJgoI1AsTOcKSkUV0hh1PuyNY+yzm+xU+yXTGGVK1MNBccgjWDxNI53s0tz2tN3AHmsOJ6WcbNEDfmew6aLnc/Xkk5nPKS8Hcd0gwTJJPAZ9qw1OkifhaAONysJQBKzc2S3KRqZ0nUbdpA7B+VZvSdWSdqZEXAI7jrxWZlOVYU1Dmy0pey4x1T5u8DyVv8i+ZtyhK9kqbF4nfdNTZLizfR6S0eO0eS3YbHtNgY52XAMKZ9Z+CpTYlKUWemY7buDteKv7A7l5nD13sIcwwdDHgZtqvQdFdKe0dsvADt8xO6xVa2b45xk6lydTBYtzLZjcd26d67NJ7HnaEbQFzkbb/ALrluwyGAjf65LKSUt0enizSx7PdD+mPgERbOxE7rb1zqg2aY/cJJIP4H9ruUXCNtxkyTFp9ZJOPYwiRBi45m8d5WKco7V5Ox6J27V0eXfszYgc8+1ILSStmOgWhIZRfnEDfl/a1Ujzp4/lX+h9IbAmLpQpOcZTKYMyT6+/gmkk2vHAR4lJPctxuKXgzvpBuqzVHhaX0zy8UsUb3t23WiZzzi3skZQDuRslazASS/gnZi4Ud9tNXFJaNlTsrLUdyghApKfZJwarhqNRagjOKSu2jwTw1XAS1DUEZ/YqzaK0tamMYpcylBGdtFMGHWlrE9rVLmWoIwjDLifqp2zRjq9Yxcwcr7I1PmvVEwvK9Pfp99auHtMtLYMkAN2cgLTB5HNOMt9zm6mLUGoq2zx+Hwxde0cTF+e+yZRYzUuDp5ZSYJmxy3ZFauk8D7J4puc0/CS1pLiAZsLC+val1nNIDAwNdIlxcbCLB2QGWtxs929njaWnTA4VjgAw9Yi4uTaSdLADfw5qHYIzAEkSS0dYgDMyNFamS34JB/wBoc0tIbcFrpN87SbHNdDD4oH4g5pEbAAEEQ6DcHhbmokzaEbMWHwpMQRfwJyHct2H6P3tJMGwtkBe+k9326PR+GL9Gw1rczNtk2zGecZz49xnR7/jYNjasAJECBHP4Z5lc0stHp4+mi1bPGP6PNyAdkXJ2dNYE3A81kfhSSRmYJO4EaSLaL2uK6LIGwQ0EyQ42jZEQDlmAZ4Ea24VYhjusIEva7YJGrZGZjRXDJZlmwUrRx24DqzaIkkG+UxB/E6JVZrLAbjJ62+06kxeFuxOKcZaxpaJOySYcQCT14sdLZTvXPewRtAi1+sQHOP8AtA3LdM8+UaKtpNcSB1RBPWNgb9WQLm40UYZxp1GmQC065RkZibZpteq1zSQxrMo2Ztv2gT4xokMY55a1rS5xMDiTkBuVGfnY+i0GbYBtGc/ynCnFgEnoHAGjRa1xJPxEWs43IEaLqGmLGFg57ntxTcU2qZlo9HvdeICd/j2jN0nmAuoKrS2BGWtrrlVqD3T1h2GR2rKeWR1YMGN7tnPxODpzMSRkFz8SJMQLabuZ/C6xwQbm6eMEfiFndhWDJze4z4LOMnZ3SUHGlRxXUyTb+ezcmNovyA7V1BTYLZ8gf7TWPj4WHuAWus5Hj32TOSOjnu3+uKYOhjqO9dhtcjTxS34l5y8AUd30S+mvdo5NTooDOO7zWV2EbuHgunXFQ/6nwXOqUHk7u1aRn9nLlwNcI64cpleE96qf9H/W7zUjF1P+j/rPmt+19nAut+j3YhWBXgxi3/8AR/1O81b3p/zv+t3ml2/sv836PdgqweF4MYp/zv8Ard5qRiX/ADv+t3mjtD/N+j37CnsXzwYh/wA7/rd5qwxD/nf9bvNLsP2Uut+j6QxqcGBfNRXf87/qPmrtqv8And9R80n0z9lLrE/H8n0F6GNXhGPf8zu8+a0sL/mPeUuw/ZrHOpeD1GM6EpVCS5jdoiC4CHZRmM7b1iH6bpANbsu6uR2iZMRJGRPrKy5jWP8AmPemtpu3+KFCS8hohJ20b3/ppgpvawvbtCSAA6S24EHPIDMTfhHIf+nKzGF52SwS4j4SBAvs5DlP+q3sDt571ppk6lTKL9lx6aN2tg6F6LrAy0EECciDBGWVtc4FivpP6XdSDIcGhwEdYCwGdoXi8LUO8rL+pulHsbT2XEElwnWLLklFxkmi8+LVCr2O50/gzUqEUQWjrDaghuzNxIF9LLxVfoGs98NaTeCXAsDYgTLoBi/wz8NpsvYVa5iATAEDkFzaz37z3nzRjjLk0WD4KLZyKH6KJM1avyyGNBNhbrOFgN0aDs6I/R+HgjZMER8V4mY2s8+KW+q/53fUfNZamJrfO/6nf+l06ZvyYvpYR8WdSn+ksPLTsDqggXJEHfe54rczomnT+BjG62AGeeS8q7E1v+j/AK3f+kh+Lr/9H/W7zR2ZvyJaIO1H+D2fsQodTC8JUxtb/o/63eazux1b/o/63+aa6eXsmXUQXhnv3uDbysr8WPmjsC8G/GVTnUf9bvNKdianzv8Ard5pS6SUuWEOvxw/8s9y7Ez/ALHu8gkHEfu8P5XiTianzv8Aqd5qhxD/AJ3/AFHzS/DkvJT/AFWH9rPctxQ+Zx7R+ApdigPUnxXhTin/ADv+p3mqHFVPnd9TvNH4r9h/ysa/pf7nvPfkt+P9SvCnEv8Anf8AUfNUOIf87vqKa6T7Il+qx/tf7ns62M4jvWN2KHzeC8v7d/zO+o+ar7R3zO7yrXT15MZfqSfgqFMKFIXWeSiQFZVBUhyVDsuFYBLBVgUykxjVdqUHepVw/imUmaGlXZPoFZw/l4JjXIKUjWx/b23Wui/1M/lc9lQ8fBOY/meTWpNG0MlHTY/1AT2v59xXOZWA1AH/AMO7paQE1lad08HEHsErNxOmOV2dAVFZlWDmufUxTGi7ha157sly6/TbQYaJ46LKS9G/5EY8s9pQrrhfrKv1Kd7hztP2/wABcF/T9T/WB4rHice98BztqL9qzUHdsjL1kJQcY3Z9OZidoTI71V7vVl89o9O1miA4HmN3anU/1LVB60EbhLfFJQaNl12Jrez2VUrFUqLk0v1Gx1nDZ4mT9k/31jh1XDvgd+0FrFeyZdRCX9LNLn+rpFR/PtCQ+tH9eZSn1OA7gPwtlE5pZmTVqcvXasz3H1J/Cl7z6ySHv9StEjmlOwcfWSU8qC/klufx7kGTkSVUqC5UJQQ2SVUhBKjaSJsiFBCklVKAIUFShBBEqVUKQgCVYFVVTWASboBoUwsrq53KheTqp1Idm0vAzKj3hu/wWFCNTHZu96bxR7435SsKEamLUzeOkP2nvTWdKftP1fwuWgJamNSaOqelz8veR+AFnr9IvdbIbhksiEm2y9Un5Jc8nMkolQhImywcjaVVCVD1DNtVLlCECthKljiLgwoQmBqp9IPaIBHaAr/5R+4ePmsSqU7YOUvZvPSJ+Ud5VPfv2rGhO2LUzZ77+1R72Nx8FkQjUxWzZ7yDvUio06rEhPUws3SFBWNryMimNrHVCkgseoVG1AVZWnYglRKCoQBQ1FBqpaFnqYEucTmoQhSAIQhAAhCEACEIQAIQhAEypVUIHZZChSgoEShQlQEoUKJTE2WUKEIFZJKhCECBCEIAEIQgAQhCABCEIAFIcVCEAXFRT7RLQnqYAhCEgBCEIAEIQgAQhCABCEIAEIQgAQhCAJClCEFIFCEIGBUIQglghCECBCEIAEIQgAQhCABCEIAEIQgAQhCABCEIA//Z"
}
'
const url = new URL(
"https://posapis.com/api/v1/orders?data={
"order":
{
"branchid":1,
"orderid":951753852456,
"sourceid":2,
"status":1,
"ordertype":1,
"orderdate":20220506,
"ordertime":"2022-05-06%2012:31:55",
"paymenttype":0,
"note": "",
"ispaid": 0,
"deliveryCost": 10,
"serviceCharge": 5,
"totalDiscountAmount": 0,
"member":
{
"posreference":"24",
"membername":"Elie%20el%20Haddad",
"mobile":"03123123",
"mobilevalidated":1,
"email":"atest@email.com",
"address":
{
"posreference":0,
"description":"Dora",
"addresstype":1,
"phone":"04123123",
"geolong":35.593402862549,
"geolat":33.94938659668,
"citycode":20021,
"street":"any%20street",
"bldg":"any%20building",
"floor":"any%20floor",
"directions":"any%20directions"
}
},
"items":[
{
"productcode":2010198,
"productqty":1,
"productprice":37000,
"comboproductcode": 2,
"modifiers":[
{
"modifiercode":1010200,
"modifierqty":1,
"modifierprice":0,
"modifiers_description":"Add%20Tomatos"
}]
}]
}
}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const body = {
"member_picture":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCBYWFRgVFRYYGBgZGhgYGhoaGBoYGhoYGRgZGhkYGBocIS4lHB4rIRgYJjgmKy8xNTU1GiQ7QDs0Py40NTEBDAwMEA8QHxISHzYrJCs0NDQ2NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NP/AABEIALEBHQMBIgACEQEDEQH/xAAbAAACAwEBAQAAAAAAAAAAAAAAAwECBAUGB//EADcQAAEDAgMEBwcEAwEBAAAAAAEAAhEDIQQxQRJRYXEFIoGRodHwExQyUpKxwQZi4fEVQlPScv/EABkBAAMBAQEAAAAAAAAAAAAAAAABAgMEBf/EACwRAAICAQMEAgEDBAMAAAAAAAABAhEDEiExBBNBUSJhFAWRoTJScbEVI0L/2gAMAwEAAhEDEQA/APk7HkKTddDE4RwzZxtosREZhaRaZrLHKLpjKMQWnXLmoZSkwhhByV2knKx+6Y1ToYykW3JieI+yl1PkfBVBn4s+OfeqvaQbFTTNdktlsDsODoezRZn0SOS3Uq0WcVocA4WcORgdx1RbXIu3GStHJa46qWs1WmtRM6dhCU0kWKswcXF7jHw6DHBMp4abyAN5Sp5KWAzIlDXo0TV7oa8SCBp4rC9q6LGA5G/JIfQ370kE4t7mWmbgrY+iYDtCkBkFb6dduyWOyN2ncdRyICb2FjinakZDVgRqqHepqNl3enMp9XthMVNuhuHEgjh9rpFSlErTRYZAGYV6jbmRmM+EKeGbuGqJjeAWi94hKYmPbuShmqRg+RxbISH5LRQ3KjmICStWZoUtKlzVaiLpoyrcs9iWm1ClwmN8lXhVIsmOCoQgllWNlONhxVqdM6epQ9kZoCnyJ2ZXRwrdmDlDT3mViYbi0J768tPOB5+t6lo0xtRdisRUtzJKzhspr22VC+ECbt2x9LE//XerVXg/CRxCyFpCsUqK7kqpgQdO5Wa7fPYfV0MfG9PaDpPggUVfBQGTme1MLDrMqvs0xr5sUGiXsKbNCh9CMrp4Yr1WWSs10bGUPjMFLiTmtIw8iRnulVbRIKdohwkJLCteEws5plslJdIAGYRdlxgk7YjEU4mNLJLHRc33z9wukzDyJ8FerhWhs6apX4L7TfyRzHtmIBSnMK1NaWktMx6utFPDg+rp2Z6GxGEw03Pj+EVeo4gQW6RxWvEv2LN1Ejgk4dm3DctB36+KF7KcUviuS+Ad1w6MuJATcUQSdmYmZ1J3clbF0dgtYPiHWd3WH3U0qUtzUOuTojFpPGc19O8jJKqMvOi14lkGAmUWAsdO+fAKr2Od47k0c9lrpjBmrGiRpZMowqZCi06ZhqtVaITsQEptgmjCaqRR5V2NtKXEpz8oTJW+4oqoCsQiEyRzK2zlnP8ASS90qitCQ7b2GtbAJPD8lUpNJ9ZBXdkeyO7NSynnpYd5QUo7g9s5fwqupN3qzWyLaLPUF1DLapXRZpBzQ1sZ5KjXJrSmSnZaoyDmDxCdQeBPFKdUJzv91QEoLtJ2jTYqfZpTXLbMtGUxeJ8Qk9jWNS5IL7QqG6q8qKTusPylQ3LemOpMvErVTpzbsCzuN7eu1DahzufW5SbQaTovXZBTKDbHRWcdrPNXbSIhKzRQ+VrgWx5aR6Kq55JI0OSaWg2hTVplsW7B6sqsHF19FsNhdpwDrcSlVz1zaAIHZknsrSImCr1Ke11t4AKm3e5pojKNRMNSnrE8VTDvjn5Lc2j1SLpDcMJmfyqTMpYmmmjVtbbQ8i4seSpQpEEgH1uTMNUDCfsZvvhanNnZLcjmdfFS3Wx0RimrfPk5tTDEyddyUxuy6H2BWikNp0HMTP8ACdicM0kcu1O62Zjo1fKJzsSCLC4GXJKc3KE/EsLbbsuSja6sd38KlwYyjcnZnq0ZWSqxb3TEHJZnMvG9UjnyRRFLDHYL9xhKcF38Rhtils/NB8FxHNRGWovNh7VJ80KDNyoWLbh2XMgwB/SzVDeVV7nM47WZyFYNV2slMdCZCRVomTyTqTNqeJvyCgU56rc/AJ9KWsjODpBsolwb44778CGVNm28Ge63csVXNNe8pClLyTkn4RMK7UNfwV7HKy0IRCArbBzQ22iB0WDMitFOkY/Pkq0HgWcJB8NxCY9kQM84P54JM2gklZWq0gXCSuuwNAG2C5pAAu3OL9maw1cLbaZlzB7LclKZc8flFGOyWu0W9FYQ/SEymb28k3EITrY2GrujjPkujhX7QEi4y/sLlUXda9wtzSBkBOhG71vWconbhnvbYpzyx9xacluZsuIG0AIi+fIDVYcW+4Ov3VsNsky4kEaIa2HGdSa8WajhQDInfY7lVlcNgd40g9is/FAWBz++47lUYfbEgiRmLb7mNVPjc2bV/wDXyPxDBBdOYEW1WbAQSY+IafcrXSZsjZsQQdAI4G8arDQGy8jI9yIu00GS006/yPq4UuLjFxr+EYdhbZ3wkgZgjxAWzDMqEmfhIMfdPexpbtG32nhGShy8GkcSfyWzODiGw8GYz9eK2UsUS6NkOmxMRA8lTpHDnMDL1mtWApPDCNppyyLT9iVo2nGzmhFrK4rbyczGM0HoLO+p1Y3Lo4ylHA68iubs804vYyzQakwgkC8+CRk5vAhdLDt/aO1Z6jOsTG5WnZlLG1TOx0z8AjcPsvPQu7jXl9Np5flYAyBkssWyOnrVrmmvSMmLeG9Rp1vzWEhPrsMqtNi6I7I8uduVAynZVcxPcICqXQpciu2qFUmEEE2BMKcTVnLkqPfPNUIQlfInLStKEuVS1Nc1UTZg0GypATIRCZekqCU3bnNV2VOygFaL20Tmu0y/PYs4amAlOi0xjgQLGw0U0sURbSe5UVdhFWPU07RqrxmBnrkeazVGa5qwUtQo0DlZFFxC1NxQ7fys5CqGFDimOMpR4N7XbQkdyq52+345LK0kJ9N5m90tNGiyWJqOIMSt+AxhabZ3y9ZrNXZJS29U2II4T+QhxUkKOSUJWmelw+JY8hsgOOUTE7oO9JxWAghxPVO65jgFhwZBEQJ0Pkus/FBrNg3zkk3jgR3LCUXGWx6kc8ckPkZamIa1o2STE9Uk98q1F7Hi7iCZsJ3G4hcvEEE2SGPLTIJC07aaOZ9W1LdbHUrYgjqPJ78tL8IW3A4ZrmSx/W4W3Lg1qjndZxJJzJzWjo/EPBhsj1qlKHx2FDqE8ltWju1MLLZdncTbMZgrF/jTsywbV9/krux2w0iZJ32HmfBIw3TGwbcsrd0idfNYKEuUdks+JtJmJ8ixBBCGmRG7Vegq0m1ADsQ46iYjtXMfhC3lv0vxCtSTVcMl4ZJ6k7RDX7TA2NfBQ9jTLZyFtxWh9HYYSTEWB/1M8ZWGmwzwA2ieHohKNU6DInaTXJgriVncYK0vMmdJy1WSsVpq2PPnCnZBeozU06ZJTH0ozU6tx6JNWI2VVyc5ij2cK9Rk4GchV2E5yqk5NkaUO9kj2a6LaKt7unqNe0c0UlPsl0hhke7J60HZZzgxWFNb/d1YYdPWHaZgFNW9ktwoJgoI1AsTOcKSkUV0hh1PuyNY+yzm+xU+yXTGGVK1MNBccgjWDxNI53s0tz2tN3AHmsOJ6WcbNEDfmew6aLnc/Xkk5nPKS8Hcd0gwTJJPAZ9qw1OkifhaAONysJQBKzc2S3KRqZ0nUbdpA7B+VZvSdWSdqZEXAI7jrxWZlOVYU1Dmy0pey4x1T5u8DyVv8i+ZtyhK9kqbF4nfdNTZLizfR6S0eO0eS3YbHtNgY52XAMKZ9Z+CpTYlKUWemY7buDteKv7A7l5nD13sIcwwdDHgZtqvQdFdKe0dsvADt8xO6xVa2b45xk6lydTBYtzLZjcd26d67NJ7HnaEbQFzkbb/ALrluwyGAjf65LKSUt0enizSx7PdD+mPgERbOxE7rb1zqg2aY/cJJIP4H9ruUXCNtxkyTFp9ZJOPYwiRBi45m8d5WKco7V5Ox6J27V0eXfszYgc8+1ILSStmOgWhIZRfnEDfl/a1Ujzp4/lX+h9IbAmLpQpOcZTKYMyT6+/gmkk2vHAR4lJPctxuKXgzvpBuqzVHhaX0zy8UsUb3t23WiZzzi3skZQDuRslazASS/gnZi4Ud9tNXFJaNlTsrLUdyghApKfZJwarhqNRagjOKSu2jwTw1XAS1DUEZ/YqzaK0tamMYpcylBGdtFMGHWlrE9rVLmWoIwjDLifqp2zRjq9Yxcwcr7I1PmvVEwvK9Pfp99auHtMtLYMkAN2cgLTB5HNOMt9zm6mLUGoq2zx+Hwxde0cTF+e+yZRYzUuDp5ZSYJmxy3ZFauk8D7J4puc0/CS1pLiAZsLC+val1nNIDAwNdIlxcbCLB2QGWtxs929njaWnTA4VjgAw9Yi4uTaSdLADfw5qHYIzAEkSS0dYgDMyNFamS34JB/wBoc0tIbcFrpN87SbHNdDD4oH4g5pEbAAEEQ6DcHhbmokzaEbMWHwpMQRfwJyHct2H6P3tJMGwtkBe+k9326PR+GL9Gw1rczNtk2zGecZz49xnR7/jYNjasAJECBHP4Z5lc0stHp4+mi1bPGP6PNyAdkXJ2dNYE3A81kfhSSRmYJO4EaSLaL2uK6LIGwQ0EyQ42jZEQDlmAZ4Ea24VYhjusIEva7YJGrZGZjRXDJZlmwUrRx24DqzaIkkG+UxB/E6JVZrLAbjJ62+06kxeFuxOKcZaxpaJOySYcQCT14sdLZTvXPewRtAi1+sQHOP8AtA3LdM8+UaKtpNcSB1RBPWNgb9WQLm40UYZxp1GmQC065RkZibZpteq1zSQxrMo2Ztv2gT4xokMY55a1rS5xMDiTkBuVGfnY+i0GbYBtGc/ynCnFgEnoHAGjRa1xJPxEWs43IEaLqGmLGFg57ntxTcU2qZlo9HvdeICd/j2jN0nmAuoKrS2BGWtrrlVqD3T1h2GR2rKeWR1YMGN7tnPxODpzMSRkFz8SJMQLabuZ/C6xwQbm6eMEfiFndhWDJze4z4LOMnZ3SUHGlRxXUyTb+ezcmNovyA7V1BTYLZ8gf7TWPj4WHuAWus5Hj32TOSOjnu3+uKYOhjqO9dhtcjTxS34l5y8AUd30S+mvdo5NTooDOO7zWV2EbuHgunXFQ/6nwXOqUHk7u1aRn9nLlwNcI64cpleE96qf9H/W7zUjF1P+j/rPmt+19nAut+j3YhWBXgxi3/8AR/1O81b3p/zv+t3ml2/sv836PdgqweF4MYp/zv8Ard5qRiX/ADv+t3mjtD/N+j37CnsXzwYh/wA7/rd5qwxD/nf9bvNLsP2Uut+j6QxqcGBfNRXf87/qPmrtqv8And9R80n0z9lLrE/H8n0F6GNXhGPf8zu8+a0sL/mPeUuw/ZrHOpeD1GM6EpVCS5jdoiC4CHZRmM7b1iH6bpANbsu6uR2iZMRJGRPrKy5jWP8AmPemtpu3+KFCS8hohJ20b3/ppgpvawvbtCSAA6S24EHPIDMTfhHIf+nKzGF52SwS4j4SBAvs5DlP+q3sDt571ppk6lTKL9lx6aN2tg6F6LrAy0EECciDBGWVtc4FivpP6XdSDIcGhwEdYCwGdoXi8LUO8rL+pulHsbT2XEElwnWLLklFxkmi8+LVCr2O50/gzUqEUQWjrDaghuzNxIF9LLxVfoGs98NaTeCXAsDYgTLoBi/wz8NpsvYVa5iATAEDkFzaz37z3nzRjjLk0WD4KLZyKH6KJM1avyyGNBNhbrOFgN0aDs6I/R+HgjZMER8V4mY2s8+KW+q/53fUfNZamJrfO/6nf+l06ZvyYvpYR8WdSn+ksPLTsDqggXJEHfe54rczomnT+BjG62AGeeS8q7E1v+j/AK3f+kh+Lr/9H/W7zR2ZvyJaIO1H+D2fsQodTC8JUxtb/o/63eazux1b/o/63+aa6eXsmXUQXhnv3uDbysr8WPmjsC8G/GVTnUf9bvNKdianzv8Ard5pS6SUuWEOvxw/8s9y7Ez/ALHu8gkHEfu8P5XiTianzv8Aqd5qhxD/AJ3/AFHzS/DkvJT/AFWH9rPctxQ+Zx7R+ApdigPUnxXhTin/ADv+p3mqHFVPnd9TvNH4r9h/ysa/pf7nvPfkt+P9SvCnEv8Anf8AUfNUOIf87vqKa6T7Il+qx/tf7ns62M4jvWN2KHzeC8v7d/zO+o+ar7R3zO7yrXT15MZfqSfgqFMKFIXWeSiQFZVBUhyVDsuFYBLBVgUykxjVdqUHepVw/imUmaGlXZPoFZw/l4JjXIKUjWx/b23Wui/1M/lc9lQ8fBOY/meTWpNG0MlHTY/1AT2v59xXOZWA1AH/AMO7paQE1lad08HEHsErNxOmOV2dAVFZlWDmufUxTGi7ha157sly6/TbQYaJ46LKS9G/5EY8s9pQrrhfrKv1Kd7hztP2/wABcF/T9T/WB4rHice98BztqL9qzUHdsjL1kJQcY3Z9OZidoTI71V7vVl89o9O1miA4HmN3anU/1LVB60EbhLfFJQaNl12Jrez2VUrFUqLk0v1Gx1nDZ4mT9k/31jh1XDvgd+0FrFeyZdRCX9LNLn+rpFR/PtCQ+tH9eZSn1OA7gPwtlE5pZmTVqcvXasz3H1J/Cl7z6ySHv9StEjmlOwcfWSU8qC/klufx7kGTkSVUqC5UJQQ2SVUhBKjaSJsiFBCklVKAIUFShBBEqVUKQgCVYFVVTWASboBoUwsrq53KheTqp1Idm0vAzKj3hu/wWFCNTHZu96bxR7435SsKEamLUzeOkP2nvTWdKftP1fwuWgJamNSaOqelz8veR+AFnr9IvdbIbhksiEm2y9Un5Jc8nMkolQhImywcjaVVCVD1DNtVLlCECthKljiLgwoQmBqp9IPaIBHaAr/5R+4ePmsSqU7YOUvZvPSJ+Ud5VPfv2rGhO2LUzZ77+1R72Nx8FkQjUxWzZ7yDvUio06rEhPUws3SFBWNryMimNrHVCkgseoVG1AVZWnYglRKCoQBQ1FBqpaFnqYEucTmoQhSAIQhAAhCEACEIQAIQhAEypVUIHZZChSgoEShQlQEoUKJTE2WUKEIFZJKhCECBCEIAEIQgAQhCABCEIAFIcVCEAXFRT7RLQnqYAhCEgBCEIAEIQgAQhCABCEIAEIQgAQhCAJClCEFIFCEIGBUIQglghCECBCEIAEIQgAQhCABCEIAEIQgAQhCABCEIA//Z"
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 37
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"MESSAGE": {
"orderid": 714,
"hsaddressid": 258,
"hsmemberid": 47
},
"STATUS": "success"
}
Received response:
Request failed with error:
GET Order Count
This API will list the orders count related to the logged in user if the user is not a Head Office. While if the logged in user is a Head Office, this API will list the order count of all the branches. This API will only display the amount of orders with status equal 1, that is equivalent to status "Order Saved/Received by posapis.com". The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/orders/count" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/orders/count"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 43
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Store Order Count
This API will list all the orders count related to all branches. This API will only display the amount of orders with status equal 1, that is equivalent to status "Order Saved/Received by posapis.com". The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/all/orders/count" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/all/orders/count"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 43
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Order(s)
This API will list all Orders related to the logged in user. It can be given an Order ID to fetch a specific Order. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/orders/:orderid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/orders/:orderid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 42
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"orders": [
{
"orderid": 714,
"deviceid": "",
"sourceid": 7,
"postransact": 0,
"status": 1,
"ordertype": 1,
"paymenttype": 0,
"amount": "331000.00",
"total_discount_amount": "0",
"taxex": "0.00",
"tax": "0.00",
"paid": "0.00",
"paid_by_source": 0,
"balance": "331000.00",
"delivery_cost": 0,
"service_charge": 0,
"orderdate": 20220223,
"ordertime": "2022-02-23 03:56:00",
"branchid": 1,
"hoclientid": "BIM111",
"member_reference": 0,
"address_reference": 0,
"hsmemberid": 47,
"hsaddressid": 258,
"note": "",
"additional_info": {
"channel_id": 0,
"channel_name": "",
"channel_order_id": "",
"channel_order_display_id": ""
},
"member": {
"memberid": 0,
"membername": "Elie el Haddad",
"mobile": "03123123",
"mobilevalidated": 1,
"dateofbirth": "2022/04/28",
"email": "null",
"picpath": "https://posapis.com/BIM111/members/Elie el Haddad/BIM11162bda81a7d946.jpg"
},
"address": {
"addressid": 0,
"descript": "No description",
"addresstype": 0,
"geolong": "0.000000",
"geolat": "0.000000",
"citycode": 0,
"street": "street 1",
"bldg": "bldg 1",
"floor": "2",
"directions": null
},
"phones": [],
"items": [
{
"transact": 714,
"itemid": 1617,
"productcode": 2297,
"productqty": 1,
"productprice": "165000.00",
"combo_product_code": 0,
"remark": "",
"modifiers": []
},
{
"transact": 714,
"itemid": 1618,
"productcode": 2297,
"productqty": 1,
"productprice": "166000.00",
"combo_product_code": 0,
"remark": "",
"modifiers": []
}
]
}
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 42
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET All Orders
This API will list all Orders for all branches related to the Head Office ONLY. It can be given an Order ID to fetch a specific Order. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/all/orders/:orderid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/all/orders/:orderid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 41
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"orders": [
{
"orderid": 286,
"deviceid": "",
"sourceid": 5,
"postransact": 0,
"status": 1,
"ordertype": 2,
"paymenttype": 0,
"amount": "24000.00",
"total_discount_amount": "0",
"taxex": "0.00",
"tax": "0.00",
"paid": "0.00",
"paid_by_source": 1,
"balance": "24000.00",
"delivery_cost": 0,
"service_charge": 0,
"orderdate": 20220228,
"ordertime": "2022-02-28 17:15:30",
"branchid": 18,
"hoclientid": "BIM111",
"member_reference": 0,
"address_reference": 0,
"hsmemberid": 20,
"hsaddressid": 201,
"note": "This is a test order",
"additional_info": {
"channel_id": 1,
"channel_name": "DELIVERECT",
"channel_order_id": "TEST1646061074",
"channel_order_display_id": "T061074"
},
"member": {
"memberid": 20,
"membername": "",
"mobile": "",
"mobilevalidated": 1,
"dateofbirth": null,
"email": "",
"picpath": null
},
"address": {
"addressid": 201,
"descript": "deliverect",
"addresstype": 1,
"geolong": null,
"geolat": null,
"citycode": 0,
"street": "The Krook 4",
"bldg": "",
"floor": "",
"directions": null
},
"phones": [],
"items": [
{
"transact": 286,
"itemid": 805,
"productcode": 1335,
"productqty": 1,
"productprice": "24000.00",
"combo_product_code": 0,
"remark": "",
"modifiers": []
}
]
},
{
"orderid": 287,
"deviceid": "",
"sourceid": 5,
"postransact": 0,
"status": 1,
"ordertype": 2,
"paymenttype": 0,
"amount": "24000.00",
"total_discount_amount": "0",
"taxex": "0.00",
"tax": "0.00",
"paid": "0.00",
"paid_by_source": 1,
"balance": "24000.00",
"delivery_cost": 0,
"service_charge": 0,
"orderdate": 20220228,
"ordertime": "2022-02-28 17:26:30",
"branchid": 18,
"hoclientid": "BIM111",
"member_reference": 0,
"address_reference": 0,
"hsmemberid": 20,
"hsaddressid": 201,
"note": "This is a test order",
"additional_info": {
"channel_id": 1,
"channel_name": "DELIVERECT",
"channel_order_id": "TEST1646061944",
"channel_order_display_id": "T061944"
},
"member": {
"memberid": 20,
"membername": "",
"mobile": "",
"mobilevalidated": 1,
"dateofbirth": null,
"email": "",
"picpath": null
},
"address": {
"addressid": 201,
"descript": "deliverect",
"addresstype": 1,
"geolong": null,
"geolat": null,
"citycode": 0,
"street": "The Krook 4",
"bldg": "",
"floor": "",
"directions": null
},
"phones": [],
"items": [
{
"transact": 287,
"itemid": 806,
"productcode": 1335,
"productqty": 1,
"productprice": "24000.00",
"combo_product_code": 0,
"remark": "",
"modifiers": []
}
]
}
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 41
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Order Status
This API will fetch the order status for a logged-in user, requiring an authentication token. To get the order status, please provide the Order ID.
Status Values
| Identifier | Description |
|---|---|
| 1 | Order Saved/Received by posapis.com |
| 2 | Order Received by Restaurant |
| 3 | Order Invoiced |
| 4 | Delivering |
| 5 | Delivered |
| 6 | Pending Accept |
| 7 | Ordered Prepared and Ready for Delivery/Pickup |
| 10 | Order Finalized, no Tracking info available |
| 11 | Order Cancelled |
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/order/:orderid/status" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/order/:orderid/status"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 40
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"status": 1,
"status_description": "Order Saved/Received by posapis.com",
"orderid": "714"
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 40
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
POST Payment
This API is used to add a Payment. It requires an Authentication token.
Meeting the following requirements is mandatory:
- The majority of fields in the JSON request are filled out as they are required.
-
For each item and each modifier:
- The price should align with the product's cost for the item in the order.
- The quantity should match the same value in the order.
- The total cost must be the result of multiplying the unit price by the corresponding quantity.
- For items that have modifiers, ensure that all modifiers are included, excluding those with a price of 0, which can be absent.
- If any of the previously mentioned requirements is not correctly applied, the payment for the related order will result in failure.
Example request:
curl --request POST \
"https://posapis.com/api/v1/table/payment" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
-d '
[
{
"orderid":157,
"source_payment_transact":157,
"tableid":1,
"branchid":5,
"paymenttype":0,
"serviceCharge":0,
"totalDiscountAmount":0,
"totalPaidAmount":0,
"sourceid":0,
"items":
[
{
"itemid":435,
"productqty":1,
"productprice":17.75,
"paidproductprice":17.75,
"totalproductprice":17.75,
"modifiers":[]
}
]
},
{
"orderid":156,
"source_payment_transact":157,
"tableid":1,
"branchid":5,
"paymenttype":0,
"serviceCharge":0,
"totalDiscountAmount":0,
"totalPaidAmount":0,
"sourceid":0,
"items":
[
{
"itemid":430,
"productqty":5,
"productprice":0.03,
"paidproductprice":0.03,
"totalproductprice":0.15,
"modifiers":[]
}
]
}
]
'
const url = new URL(
"https://posapis.com/api/v1/table/payment"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const body = {
[
{
"orderid":157,
"source_payment_transact":157,
"tableid":1,
"branchid":5,
"paymenttype":0,
"serviceCharge":0,
"totalDiscountAmount":0,
"totalPaidAmount":0,
"sourceid":0,
"items":
[
{
"itemid":435,
"productqty":1,
"productprice":17.75,
"paidproductprice":17.75,
"totalproductprice":17.75,
"modifiers":[]
}
]
},
{
"orderid":156,
"source_payment_transact":157,
"tableid":1,
"branchid":5,
"paymenttype":0,
"serviceCharge":0,
"totalDiscountAmount":0,
"totalPaidAmount":0,
"sourceid":0,
"items":
[
{
"itemid":430,
"productqty":5,
"productprice":0.03,
"paidproductprice":0.03,
"totalproductprice":0.15,
"modifiers":[]
}
]
}
]
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 37
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"failedOrders": [
{
"orderId": 156,
"message": "This order failed to be paid",
"failedItems": [
{
"itemId": 430,
"reason": "This item had already been paid"
}
]
}
],
"paidOrders": [
{
"orderId": 157,
"message": "Paid Successfully.",
"paidItems": [
{
"itemId": 435,
"message": "Item's payment is done."
}
]
}
],
"totalPAidAmount": "17.75",
"message": "Payment Verified",
"status": "success"
}
Received response:
Request failed with error:
Get Table Invoice
This API will list all Orders related to the logged in user.
It requires two parameters: 'tableid' and 'type'.
Additionally, access to this API mandates an authentication token.
It's important to note that orders with a status of 1 or 11 should be excluded.
Here, a status of 1 denotes that the order is merely saved and received by POS,
while a status of 11 signifies that the order has been cancelled.
Type Details
| Type | Type meaning | What items should we get? |
|---|---|---|
| 0 | unpaid items | |
| 1 | Payment received by posapis.com | (unpaid items) and ( items where payment status is 1 ) |
| 6 | Payment received by Restaurant | (unpaid items) and ( items where payment status is 6 ) |
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/table/:tableid/invoice/:type" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/table/:tableid/invoice/:type"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 42
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"orders": [
{
"orderid": 156,
"deviceid": null,
"sourceid": 13,
"postransact": 200,
"status": 5,
"ordertype": 1,
"amount": "2.72",
"total_discount_amount": "0.00",
"taxex": "0.00",
"tax": "0.00",
"paid": "0.00",
"paid_by_source": null,
"balance": "2.72",
"delivery_cost": null,
"service_charge": "0.00",
"orderdate": 1696280400,
"ordertime": "2023-10-03 15:29:47",
"paymenttype": 0,
"table_id": "3",
"branchid": 5,
"hoclientid": "BIM111",
"member_reference": 1,
"address_reference": 0,
"hsmemberid": 1,
"hsaddressid": 1,
"note": "0",
"member": {
"memberid": 1,
"hsmemberid": 1,
"membername": "Roy",
"mobile": "855893332214",
"mobilevalidated": 1,
"dateofbirth": "15/08/2003",
"email": "roy.haj@bimpos.com",
"picpath": null
},
"items": [
{
"orderid": 156,
"itemid": 429,
"productcode": 2184,
"productqty": 1,
"productprice": "2.67",
"combo_product_code": null,
"remark": null,
"invoiceid": null,
"modifiers": [
{
"orderid": 156,
"itemid": 430,
"productcode": 2093,
"productqty": 1,
"productprice": "0.03"
}
]
}
]
},
{
"orderid": 157,
"deviceid": null,
"sourceid": 13,
"postransact": 200,
"status": 6,
"ordertype": 1,
"amount": "2.72",
"total_discount_amount": "0.00",
"taxex": "0.00",
"tax": "0.00",
"paid": "0.00",
"paid_by_source": null,
"balance": "2.72",
"delivery_cost": null,
"service_charge": "0.00",
"orderdate": 1696280400,
"ordertime": "2023-10-03 15:29:47",
"paymenttype": 0,
"table_id": "3",
"branchid": 5,
"hoclientid": "BIM111",
"member_reference": 1,
"address_reference": 0,
"hsmemberid": 1,
"hsaddressid": 1,
"note": "0",
"member": {
"memberid": 1,
"hsmemberid": 1,
"membername": "Roy",
"mobile": "855893332214",
"mobilevalidated": 1,
"dateofbirth": "15/08/2003",
"email": "roy.haj@bimpos.com",
"picpath": null
},
"items": [
{
"orderid": 157,
"itemid": 431,
"productcode": 2093,
"productqty": 1,
"productprice": "12.50",
"combo_product_code": null,
"remark": null,
"invoiceid": 3,
"payment_status": "6",
"modifiers": [
{
"orderid": 157,
"itemid": 432,
"productcode": 0,
"productqty": 1,
"productprice": "8.50",
"payment_status": "6"
},
{
"orderid": 157,
"itemid": 433,
"productcode": 0,
"productqty": 1,
"productprice": "6.20",
"payment_status": "6"
}
]
},
{
"orderid": 157,
"itemid": 434,
"productcode": 0,
"productqty": 1,
"productprice": "10.00",
"combo_product_code": null,
"remark": null,
"invoiceid": 3,
"payment_status": "6",
"modifiers": []
},
{
"orderid": 157,
"itemid": 435,
"productcode": 0,
"productqty": 1,
"productprice": "17.75",
"combo_product_code": null,
"remark": null,
"invoiceid": null,
"modifiers": []
}
]
}
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 42
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
POST Action
This API is used to add an Action. It must be given a data json that contains several Identifiers listed in the tables bellow. The API requires an Authentication token.
Action
| Identifier | Value Type | Description | Value(s) Examples | Required |
|---|---|---|---|---|
| Table ID | Integer | The Table ID | Yes | |
| Order ID | integer | The Order number (ID) | If type = 1 | |
| Status | integer | The Action Status | Yes | |
| POS Status | Integer | The Action POS Status | Yes | |
| Type | integer | The Action Type | Yes |
Type
| Type | Description |
|---|---|
| 1 | Get Check |
| 2 | Get Waiter |
| 3 | Get Manager |
Status
| Status | Description |
|---|---|
| 0 | Not Active |
| 1 | Active |
Example request:
curl --request POST \
"https://posapis.com/api/v1/actions" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
-d '
[
{
"ORDERID": "1",
"TABLEID": 123,
"TYPE": 1,
"STATUS": 0,
"POSSTATUS": 0
}
]
'
const url = new URL(
"https://posapis.com/api/v1/actions
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const body = {
[
"ORDERID": "1",
"TABLEID": 123,
"TYPE": 1,
"STATUS": 0,
"POSSTATUS": 0
]
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 37
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
'message' =>'Actions inserted successfully!',
'failed Items' => [],
'status' =>'success',
}
Received response:
Request failed with error:
GET Action
This API will list the actions related to the logged in user. While if the logged in user is a Head Office, this API will list the actions of all the branches. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/actions" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/actions"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 43
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Region(s)
This API will list all Regions related to a logged in user. It can be given a Region ID to fetch a specific Region. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/regions/:regionid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/regions/:regionid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 49
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"id": 10001,
"name": "Dubai",
"phonecode": "0",
"isactive": 1,
"created_at": "2021-12-09 16:30:31",
"updated_at": "2022-03-07 17:05:40"
},
{
"id": 10002,
"name": "Keserwan District ",
"phonecode": "0",
"isactive": 1,
"created_at": "2021-12-09 16:30:33",
"updated_at": null
},
{
"id": 10003,
"name": "Maten District",
"phonecode": "0",
"isactive": 1,
"created_at": "2021-12-09 16:30:34",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 49
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET City(s)
This API will list all Cities related to a logged in user. It can be given a City ID to fetch a specific City. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/cities/:cityid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/cities/:cityid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 47
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"citycode": 10001,
"name": "Dubai",
"regioncode": 10001,
"countrycode": 10001,
"zipcode": 0,
"isactive": 1,
"created_at": "2022-03-07 15:05:39",
"updated_at": null
},
{
"citycode": 10002,
"name": "Adma ",
"regioncode": 10002,
"countrycode": 10001,
"zipcode": 0,
"isactive": 1,
"created_at": "2021-12-09 16:19:17",
"updated_at": null
},
{
"citycode": 10003,
"name": "adonis",
"regioncode": 10002,
"countrycode": 10001,
"zipcode": 0,
"isactive": 1,
"created_at": "2021-12-09 16:19:19",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 47
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Country(s)
This API will list all Countries related to a logged in user. It can be given a Country ID to fetch a specific Country. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/countries/:countryid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/countries/:countryid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 46
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"id": 10001,
"name": "Lebanon",
"phonecode": "961",
"phonelength": 10,
"phonemask": "(##) (######)",
"smscodestart": "03,70,71,76,78,79,81",
"isactive": 1,
"created_at": "2021-12-09 20:33:24",
"updated_at": "2022-06-25 10:55:53"
},
{
"id": 10002,
"name": "UAE",
"phonecode": "971",
"phonelength": 10,
"phonemask": "##########",
"smscodestart": "05",
"isactive": 1,
"created_at": "2021-12-09 20:33:26",
"updated_at": null
},
{
"id": 10003,
"name": "Nigeria",
"phonecode": "234",
"phonelength": 11,
"phonemask": "###########",
"smscodestart": "08,09,07",
"isactive": 1,
"created_at": "2021-12-09 20:33:27",
"updated_at": null
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 46
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Branch Cities
This API will list all Cities related to the giving Bracnh ID for a logged in user. It must be given a Branch ID to fetch the specific Cities related the a certain Branch. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/branch/:branchid/cities" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/branch/:branchid/cities"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 48
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"branchid": 1,
"branchName": "burgerr",
"cities": [
{
"id": 10003,
"name": "adonis",
"citycode": 10002,
"countrycode": 10001,
"zipcode": 0,
"isactive": 1,
"clientid": "BIM111",
"versionid": 1,
"created_at": "2021-12-09 16:19:19",
"updated_at": null
},
{
"id": 10180,
"name": "Dora",
"citycode": 10003,
"countrycode": 10001,
"zipcode": 0,
"isactive": 1,
"clientid": "BIM111",
"versionid": 1,
"created_at": "2021-12-09 16:23:58",
"updated_at": null
},
{
"id": 10231,
"name": "Mkaless",
"citycode": 10003,
"countrycode": 10001,
"zipcode": 0,
"isactive": 1,
"clientid": "BIM111",
"versionid": 1,
"created_at": "2021-12-09 16:25:19",
"updated_at": null
},
{
"id": 10860,
"name": "North ",
"citycode": 10006,
"countrycode": 10001,
"zipcode": 0,
"isactive": 1,
"clientid": "BIM111",
"versionid": 1,
"created_at": "2021-12-09 16:25:55",
"updated_at": null
},
{
"id": 10002,
"name": "Adma ",
"citycode": 10002,
"countrycode": 10001,
"zipcode": 0,
"isactive": 1,
"clientid": "BIM111",
"versionid": 1,
"created_at": "2021-12-09 16:19:17",
"updated_at": null
}
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 48
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Floor(s)
This API will list all Floors related to a logged in user. It can be given a Floor ID to fetch a specific Floor. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/floors/:floorid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/floors/:floorid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 48
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"floor_id": 1,
"floor_name": "First Floor",
"is_default": 1,
"background_color": 1,
"floor_width": 20,
"floor_height": 20,
"branch_id": 1001,
"concept_id": 1,
"client_id": "BIM111",
"headoffice_client_id": "BIM111",
"is_active": 1,
"created_at": "2023-03-14T11:51:52.000000Z",
"updated_at": "2023-03-14T11:51:52.000000Z"
},
{
"floor_id": 2,
"floor_name": "Second Floor",
"is_default": 1,
"background_color": 1,
"floor_width": 20,
"floor_height": 20,
"branch_id": 1001,
"concept_id": 1,
"client_id": "BIM111",
"headoffice_client_id": "BIM111",
"is_active": 1,
"created_at": "2023-03-14T12:04:05.000000Z",
"updated_at": "2023-03-14T12:04:05.000000Z"
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 48
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Section(s)
This API will list all Sections related to a logged in user. It can be given a Section ID to fetch a specific Section. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/sections/:sectionid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/sections/:sectionid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 48
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"section_id": 1,
"floor_id": 1,
"section_name": "section A",
"section_type": 1,
"section_top": 1,
"section_width": 1,
"section_height": 1,
"section_shape_style": 1,
"section_fill_style": 1,
"section_fill_color": 1,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"client_id": "BIM111",
"headoffice_client_id": "BIM111",
"is_active": 1,
"created_at": "2023-03-14T11:52:23.000000Z",
"updated_at": "2023-03-14T11:52:23.000000Z"
},
{
"section_id": 2,
"floor_id": 1,
"section_name": "section B",
"section_type": 1,
"section_top": 1,
"section_width": 1,
"section_height": 1,
"section_shape_style": 1,
"section_fill_style": 1,
"section_fill_color": 1,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"client_id": "BIM111",
"headoffice_client_id": "BIM111",
"is_active": 1,
"created_at": "2023-03-14T11:52:23.000000Z",
"updated_at": "2023-03-14T11:52:23.000000Z"
},
{
"section_id": 3,
"floor_id": 2,
"section_name": "section A",
"section_type": 1,
"section_top": 1,
"section_width": 1,
"section_height": 1,
"section_shape_style": 1,
"section_fill_style": 1,
"section_fill_color": 1,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"client_id": "BIM111",
"headoffice_client_id": "BIM111",
"is_active": 1,
"created_at": "2023-03-14T12:04:56.000000Z",
"updated_at": "2023-03-14T12:04:56.000000Z"
},
{
"section_id": 4,
"floor_id": 2,
"section_name": "section B",
"section_type": 1,
"section_top": 1,
"section_width": 1,
"section_height": 1,
"section_shape_style": 1,
"section_fill_style": 1,
"section_fill_color": 1,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"client_id": "BIM111",
"headoffice_client_id": "BIM111",
"is_active": 1,
"created_at": "2023-03-14T12:04:56.000000Z",
"updated_at": "2023-03-14T12:04:56.000000Z"
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 48
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Sections By Floor Id
This API will list all Sections By a specific floor id related to a logged in user. It must be given a Floor ID to fetch all section related to a specific floor. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/floors/:floorid/sections" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/floors/:floorid/sections"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 48
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"section_id": 3,
"floor_id": 2,
"section_name": "section A",
"section_type": 1,
"section_top": 1,
"section_width": 1,
"section_height": 1,
"section_shape_style": 1,
"section_fill_style": 1,
"section_fill_color": 1,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"client_id": "XXX003",
"headoffice_client_id": "BIM111",
"is_active": 1,
"created_at": "2023-03-14T12:04:56.000000Z",
"updated_at": "2023-03-14T12:04:56.000000Z"
},
{
"section_id": 4,
"floor_id": 2,
"section_name": "section B",
"section_type": 1,
"section_top": 1,
"section_width": 1,
"section_height": 1,
"section_shape_style": 1,
"section_fill_style": 1,
"section_fill_color": 1,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"client_id": "XXX003",
"headoffice_client_id": "BIM111",
"is_active": 1,
"created_at": "2023-03-14T12:04:56.000000Z",
"updated_at": "2023-03-14T12:04:56.000000Z"
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 48
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Tables By Section Id
This API will list all Tables By a specific section id related to a logged in user. It must be given a section ID to fetch all tables related to a specific section. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/sections/:sectionid/tables" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/sections/:sectionid/tables"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 48
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"table_id": 10,
"section_id": 4,
"table_name": "table1",
"table_index": 1,
"table_type": 1,
"table_top": 1,
"table_left": 1,
"table_width": 1,
"table_height": 1,
"table_shape_style": 1,
"table_fill_style": 1,
"table_fill_color": 1,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"client_id": "XXX003",
"headoffice_client_id": "BIM111",
"version_id": 1,
"is_active": 1,
"created_at": "2023-03-14T12:06:29.000000Z",
"updated_at": "2023-03-14T12:06:29.000000Z"
},
{
"table_id": 11,
"section_id": 4,
"table_name": "table2",
"table_index": 1,
"table_type": 1,
"table_top": 1,
"table_left": 1,
"table_width": 1,
"table_height": 1,
"table_shape_style": 1,
"table_fill_style": 1,
"table_fill_color": 1,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"client_id": "XXX003",
"headoffice_client_id": "BIM111",
"version_id": 1,
"is_active": 1,
"created_at": "2023-03-14T12:06:29.000000Z",
"updated_at": "2023-03-14T12:06:29.000000Z"
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 48
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
GET Tables By Floor Id
This API will list all Tables By a specific floor id related to a logged in user. It must be given a floor ID to fetch all tables related to a specific floor. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/floors/:floorid/tables" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/floors/:floorid/tables"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 48
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
[
{
"table_id": 7,
"section_id": 3,
"table_name": "table1",
"table_index": 1,
"table_type": 1,
"table_top": 1,
"table_left": 1,
"table_width": 1,
"table_height": 1,
"table_shape_style": 1,
"table_fill_style": 1,
"table_fill_color": 1,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"client_id": "XXX003",
"headoffice_client_id": "XXX001",
"version_id": 1,
"is_active": 1,
"created_at": "2023-03-14T12:06:29.000000Z",
"updated_at": "2023-03-14T12:06:29.000000Z"
},
{
"table_id": 8,
"section_id": 3,
"table_name": "table2",
"table_index": 1,
"table_type": 1,
"table_top": 1,
"table_left": 1,
"table_width": 1,
"table_height": 1,
"table_shape_style": 1,
"table_fill_style": 1,
"table_fill_color": 1,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"client_id": "XXX003",
"headoffice_client_id": "XXX001",
"version_id": 1,
"is_active": 1,
"created_at": "2023-03-14T12:06:29.000000Z",
"updated_at": "2023-03-14T12:06:29.000000Z"
}
]
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 48
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
POST Push Menu to Deliverect
If your account is linked to a Deliverect account, this API will allow you to push your menu (Categories, products, modifiers, and combos) to your Deliverect account. The API requires an Authentication token.
POST Push Menu To Shopify
If your account is linked to a Shopify account, this API will allow you to push your menu (Categories, and products) to your Shopify account. It must be given a Type that must contain one on the values in the bellow table. Note that the Types must be send by order. The API requires an Authentication token.
| Type | Description |
|---|---|
| 1 | Push Categories |
| 2 | Push Products, Tags, and Stock |
POST Void Item To E-menus
If your account is integrated in E-menus, this API will allow you to push your voided Item to your E-menus account. The API requires an Authentication token.
| Identifier | Value Type | Description |
|---|---|---|
| posDetailId | Integer | The E-menus Item ID |
Example request:
curl --request POST \
"https://posapis.com/api/v1/items/void" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
-d '
[
{
"posDetailId" : 2246
},
{
"posDetailId" : 150
}
]
'
const url = new URL(
"https://posapis.com/api/v1/items/void"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const body = {
[
{
"posDetailId" : 2246
},
{
"posDetailId" : 2093
}
]
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Push Item Order To E-menus
If your account is integrated in E-menus, this API will allow you to push your Ordered Items to your E-menus account. The API requires an Authentication token.
| Identifier | Value Type | Description | Required | |
|---|---|---|---|---|
| orderid | Integer | The Item ID | Yes | |
| tableid | Integer | The table id | Yes | |
| seatnumber | String | The seat number | Yes | |
| branchid | Integer | The Branch ID | Yes | |
| paymenttype | Integer | The payment type | Yes | |
| note | String | The Note | Yes | |
| serviceCharge | Decimal | The Service Charge | Yes | |
| totalDiscountAmount | Decimal | The Discount Amount | Yes | |
| member | data | Member Info | No | |
| posreference | Integer | The POS Reference | Yes | |
| membername | String | The Member Name | Yes | |
| mobile | String | The Email | Yes | |
| String | The Discount Amount | No | ||
| dateofbirth | String | Date Of Birth | Yes | |
| items | Array | Items Info | Yes | |
| posdetailid | Integer | POS ID | Yes | |
| productcode | Integer | Product Number | Yes | |
| productqty | Integer | Product Quantity | Yes | |
| productprice | String | Product Price | Yes | |
| posdetailid | Integer | POS ID | Yes | |
| suniqueid | Integer | Product Number | Yes | |
| luniqueid | Integer | Product Number | Yes |
Example request:
curl --request POST \
"https://posapis.com/api/v1/order/items" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
-d '
[
{
"orderid":300,
"tableid":"1",
"seatnumber":2,
"branchid":5,
"paymenttype":0,
"note":0,
"serviceCharge":0,
"totalDiscountAmount":0,
"member":[{
"posreference":1,
"membername":"Marc",
"mobile":"71987040",
"email":"marc.boutros@bimpos.com",
"dateofbirth":"5/12/2000"
}],
"items":
[
{
"posdetailid":2246,
"productcode":2246,
"productqty":2,
"productprice":0.01,
"suniqueid": 2
},
{
"posdetailid":2184,
"productcode":2184,
"productqty":1,
"productprice":2.67,
"luniqueid": 1
},
{
"posdetailid":2093,
"productcode":2093,
"productqty":1,
"productprice":0.03
}
]
}
]
'
const url = new URL(
"https://posapis.com/api/v1/order/items"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const body = {
[
{
"orderid":300,
"tableid":"1",
"seatnumber":2,
"branchid":5,
"paymenttype":0,
"note":0,
"serviceCharge":0,
"totalDiscountAmount":0,
"member":[{
"posreference":1,
"membername":"Marc",
"mobile":"71987040",
"email":"marc.boutros@bimpos.com",
"dateofbirth":"5/12/2000"
}],
"items":
[
{
"posdetailid":2246,
"productcode":2246,
"productqty":2,
"productprice":0.01
"sproductcode": 2,
"lproductcode": 1
},
{
"posdetailid":2184,
"productcode":2184,
"productqty":1,
"productprice":2.67
},
{
"posdetailid":2093,
"productcode":2093,
"productqty":1,
"productprice":0.03
}
]
}
]
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
Update Items Status To E-menus
If your account is integrated in E-menus, this API will allow you to update your item status in your E-menus account. The API requires an Authentication token.
| Identifier | Value Type | Description | Required |
|---|---|---|---|
| success | String | Success message | Yes |
| status | Integer | The Item Status | Yes |
| items | Array | Items Info | Yes |
| itemid | Integer | The Item ID | Yes |
| posdetailid | Integer | The POS ID | Yes |
Example request:
curl --request POST \
"https://posapis.com/api/v1/items/status" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"\
-d '
[
{
"success":"hello",
"status":500,
"items":[{"itemid":10,"posdetailid":800}]
},
{
"success":"hello",
"status":100,
"items":[{"itemid":10,"posdetailid":300}]
}
]
'
const url = new URL(
"https://posapis.com/api/v1/items/status"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const body = {
[
{
"success":"hello",
"status":500,
"items":[{"itemid":10,"posdetailid":800}]
},
{
"success":"hello",
"status":100,
"items":[{"itemid":10,"posdetailid":300}]
}
]
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST SKU Family
This API will allow you to insert, update or delete SKU family fields. The API requires an Authentication token.
| Identifier | Value Type | Required |
|---|---|---|
| SKUID | integer | Yes |
| DESCRIPT | string | Yes |
| MASK | string | no |
| LEVEL | integer | No |
| ISACTIVE | boolean | Yes |
| UNIT | integer | No |
Example request:
curl --request POST \
"https://posapis.com/api/v1/sku/family" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
-d '
[
{
"SKUID": 1,
"DESCRIPT": "SKU Family 1",
"MASK": "Mask1",
"LEVEL": 1,
"ISACTIVE": 1,
"UNIT": 2
},
{
"SKUID": 2,
"DESCRIPT": "SKU Family 2",
"MASK": "Mask2",
"LEVEL": 2,
"ISACTIVE": 0,
"UNIT": 3
},
{
"SKUID": 3,
"DESCRIPT": "SKU Family 3",
"MASK": null,
"LEVEL": null,
"ISACTIVE": 0,
"UNIT": null
}
]
'
const url = new URL(
"https://posapis.com/api/v1/sku/family"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const body = {
[
{
"SKUID": 1,
"DESCRIPT": "SKU Family 1",
"MASK": "Mask1",
"LEVEL": 1,
"ISACTIVE": 1,
"UNIT": 2
},
{
"SKUID": 2,
"DESCRIPT": "SKU Family 2",
"MASK": "Mask2",
"LEVEL": 2,
"ISACTIVE": 0,
"UNIT": 3
},
{
"SKUID": 3,
"DESCRIPT": "SKU Family 3",
"MASK": null,
"LEVEL": null,
"ISACTIVE": 0,
"UNIT": null
}
]
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST SKU Details
This API will allow you to insert,update or delete your SKU details. The API requires an Authentication token.
| Identifier | Value Type | Required |
|---|---|---|
| SKUDETAILSID | Integer | Yes |
| DESCRIPT | string | Yes |
| BARCODEADDON | string | No |
| LEVEL | Integer | No |
| MASK | string | No |
| SHORTDESCRIPT | string | No |
| RECIPEYIELD | numeric | No |
| RECIPEUNIT | Integer | No |
| RECIPEUNITCONVERSION | numeric | No |
| PARENTRECIPEUSAGEQTY | numeric | No |
| PARENTRECIPEUSAGEUNIT | Integer | No |
| PARENTRECIPEUNITCONVERSION | numeric | No |
| SKUID | Integer | Yes |
| ISACTIVE | boolean | yes |
Example request:
curl --request POST \
"https://posapis.com/api/v1/sku/details" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
-d '
[
{
"SKUDETAILSID": 1,
"DESCRIPT": "SKU DETAIL 1",
"BARCODEADDON":"" ,
"LEVEL": 1 ,
"MASK": "" ,
"SHORTDESCRIPT": "" ,
"RECIPEYIELD": null,
"RECIPEUNIT": null,
"RECIPEUNITCONVERSION":null ,
"PARENTRECIPEUSAGEQTY":null ,
"PARENTRECIPEUSAGEUNIT":null ,
"PARENTRECIPEUNITCONVERSION":null ,
"SKUID":1,
"ISACTIVE": 1
},
{
"SKUDETAILSID": 2,
"DESCRIPT": "SKU DETAIL 2",
"BARCODEADDON":"" ,
"LEVEL": 1 ,
"MASK": "" ,
"SHORTDESCRIPT": "" ,
"RECIPEYIELD":null ,
"RECIPEUNIT":null ,
"RECIPEUNITCONVERSION":null ,
"PARENTRECIPEUSAGEQTY":null ,
"PARENTRECIPEUSAGEUNIT":null ,
"PARENTRECIPEUNITCONVERSION": null ,
"SKUID":1,
"ISACTIVE": 1
}
]
'
const url = new URL(
"https://posapis.com/api/v1/sku/details"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const body = {
[
{
"ID": 1,
"TBLNUM": 101,
"SEATNUM": 4,
"SEATDESCRIPT": "Comfortable corner seat",
"NUMOFCUSTOMERS": 2
},
{
"ID": 2,
"TBLNUM": 102,
"SEATNUM": 3,
"SEATDESCRIPT": "Booth seating",
"NUMOFCUSTOMERS": 4
},
{
"ID": 3,
"TBLNUM": 103,
"SEATNUM": 2,
"SEATDESCRIPT": "Barstool seating",
"NUMOFCUSTOMERS": 1
}
]
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Mobile Device
This API will insert a new Mobile Device, and send a verification code by SMS to the mobile given in the data json. It must be given a data json that contain several Identifiers that are listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description |
|---|---|---|
| deviceIdentifier | integer | The device Charge Detail section ID> |
| deviceOS | string | The device operating system |
| deviceAppId | integer | The device application ID |
| deviceAppVersion | string | The device application version |
| mobile | string | The device mobile number that will recieve the SMS varification code |
Example request:
curl --request POST \
"https://posapis.com/api/v1/devices?data={"deviceIdentifier": "ABC123","deviceOS": "android", "deviceAppId":1, "deviceAppVersion": "1.0.1", "mobile": "03123123"} " \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/devices?data={"deviceIdentifier": "ABC123","deviceOS": "android", "deviceAppId":1, "deviceAppVersion": "1.0.1", "mobile": "03123123"} "
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
PUT Mobile Device
This API is used to verify the mobile number posted by the POST Mobile Device API. It must be given several Identifiers that are listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description |
|---|---|---|
| deviceIdentifier | string | The device ID (Same ID listed in POST Mobile Device) |
| mobile | string | The device mobile number that recieved the SMS varification code |
| validationCode | string | The device verification code sent to the listed mobile number |
Example request:
curl --request PUT \
"https://posapis.com/api/v1/devices?data={"deviceIdentifier": "ABC123", "mobile":"03123123", "validationCode": "65780"}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/devices?data={"deviceIdentifier": "ABC123", "mobile":"03123123", "validationCode": "65780"}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Floors
This API is used to add or update Floors. It must be given a json of data that contains several Identifiers that are listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | |
|---|---|---|---|
| id | integer | The floor ID | |
| description | string | The floor name / description | |
| is_default | integer | 1 for true and 0 for false | |
| background_color | integer | ||
| is_active | integer | 1 for true and 0 for false | |
| floor_width | integer | The floor's width | |
| floor_height | integer | The floor's height | |
| branch_id | integer | The branch id | |
| concept_id | integer | The concept id |
Example request:
curl --request POST \
"https://posapis.com/api/v1/floors" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}" \
--data '[
{
"id": 1,
"description": "Second Floor",
"is_default": 1,
"background_color": 1,
"is_active": 1,
"floor_width": 20,
"floor_height": 20,
"branch_id": 1001,
"concept_id": 1
}
]'
const url = new URL(
"https://posapis.com/api/v1/floors"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const data = [{
"id": 1,
"description": "Second Floor",
"is_default": 1,
"background_color": 1,
"is_active": 1,
"floor_width": 20,
"floor_height": 20,
"branch_id": 1001,
"concept_id": 1
}];
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(data)
}).then(response => response.json());
Received response:
Request failed with error:
POST Sections
This API is used to add or update Sections. It must be given a json of data that contains several Identifiers that are listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | |
|---|---|---|---|
| section_id | integer | The section ID | |
| section_type | integer | The section type | |
| section_left | integer | The section left size | |
| section_top | integer | The section top size | |
| section_width | integer | The section width | |
| section_height | integer | The section height | |
| section_name | string | The section name | |
| section_shapestyle | integer | The section shape style | |
| section_fillstyle | integer | The section fill style | |
| section_fillcolor | integer | The section fill color | |
| section_floor_id | integer | The section floor id | |
| font_name | string | The section font name | |
| font_bold | integer | If section font is bold | |
| font_italic | integer | If section font is italic | |
| font_size | integer | The section font size | |
| font_strike_through | integer | The section font strike | |
| font_underline | integer | If section font is underlined | |
| font_color | integer | The section font color | |
| is_active | integer | 1 for true and 0 for false |
Example request:
curl --request POST \
"https://posapis.com/api/v1/sections" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}" \
--data '[
{
"section_id" : 3,
"section_type" : 1,
"section_left" : 1,
"section_top": 1,
"section_width" : 1,
"section_height" : 1,
"section_name": "section A",
"section_shapestyle" : 1,
"section_fillstyle" : 1,
"section_fillcolor" : 1,
"section_floor_id" : 2,
"font_name" : "Times New Roman",
"font_bold" : 1,
"font_italic": 0,
"font_size" : "13.5",
"font_strike_through" : 1,
"font_underline" : 0,
"font_color" : 54365,
"is_active" : 1
},
{
"section_id" : 4,
"section_type" : 1,
"section_left" : 1,
"section_top": 1,
"section_width" : 1,
"section_height" : 1,
"section_name": "section B",
"section_shapestyle" : 1,
"section_fillstyle" : 1,
"section_fillcolor" : 1,
"section_floor_id" : 2,
"font_name" : "Times New Roman",
"font_bold" : 1,
"font_italic": 0,
"font_size" : "13.5",
"font_strike_through" : 1,
"font_underline" : 0,
"font_color" : 54365,
"is_active" : 1
}
]'
const url = new URL(
"https://posapis.com/api/v1/sections"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const data = [{
"section_id" : 3,
"section_type" : 1,
"section_left" : 1,
"section_top": 1,
"section_width" : 1,
"section_height" : 1,
"section_name": "section A",
"section_shapestyle" : 1,
"section_fillstyle" : 1,
"section_fillcolor" : 1,
"section_floor_id" : 2,
"font_name" : "Times New Roman",
"font_bold" : 1,
"font_italic": 0,
"font_size" : "13.5",
"font_strike_through" : 1,
"font_underline" : 0,
"font_color" : 54365,
"is_active" : 1
},
{
"section_id" : 4,
"section_type" : 1,
"section_left" : 1,
"section_top": 1,
"section_width" : 1,
"section_height" : 1,
"section_name": "section B",
"section_shapestyle" : 1,
"section_fillstyle" : 1,
"section_fillcolor" : 1,
"section_floor_id" : 2,
"font_name" : "Times New Roman",
"font_bold" : 1,
"font_italic": 0,
"font_size" : "13.5",
"font_strike_through" : 1,
"font_underline" : 0,
"font_color" : 54365,
"is_active" : 1
}
];
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(data)
}).then(response => response.json());
Received response:
Request failed with error:
PUT Tables
This API is used to update the status of the table. It must be given a json of data that contains table id. The API requires an Authentication token.
| Identifier | Value Type | Description |
|---|---|---|
| tableid | integer | The table id |
Example request:
curl --request PUT \
"https://posapis.com/api/v1/tables" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}" \
--data '[
{
"tableid": 3
}
]'
const url = new URL(
"https://posapis.com/api/v1/tables"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const data = [
{
"tablenumer": 3
}
];
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(data)
}).then(response => response.json());
Received response:
Request failed with error:
POST Tables
This API is used to add or update Tables. It must be given a json of data that contains several Identifiers that are listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | Description |
|---|---|---|
| table_id | integer | The table ID |
| table_index | integer | The table index |
| table_type | integer | The table type |
| table_left | integer | The table left size |
| table_top | integer | The table top size |
| table_width | integer | The table width |
| table_height | integer | The table height |
| table_name | string | The table name |
| table_shapestyle | integer | The table shape style |
| table_fillstyle | integer | The table fill style |
| table_fillcolor | integer | The table fill color |
| section_id | integer | The section ID |
| font_name | string | The font name |
| font_bold | integer | If font is bold |
| font_italic | integer | If font is italic |
| font_size | numeric | The font size |
| font_strike_through | integer | If font has strike-through |
| font_underline | integer | If font is underlined |
| font_color | integer | The font color |
| is_active | integer | 1 for true and 0 for false |
Example request:
curl --request POST \
"https://posapis.com/api/v1/tables" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}" \
--data '[
{
"table_id": 3,
"table_index": 1,
"table_type": 1,
"table_left": 1,
"table_top": 1,
"table_width": 1,
"table_height": 1,
"table_name": "section A",
"table_shapestyle": 1,
"table_fillstyle": 1,
"table_fillcolor": 1,
"section_id": 2,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"is_active": 1
},
{
"table_id": 4,
"table_index": 1,
"table_type": 1,
"table_left": 1,
"table_top": 1,
"table_width": 1,
"table_height": 1,
"table_name": "section B",
"table_shapestyle": 1,
"table_fillstyle": 1,
"table_fillcolor": 1,
"section_id": 2,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"is_active": 1
}
]'
const url = new URL(
"https://posapis.com/api/v1/tables"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const data = [
{
"table_id": 3,
"table_index": 1,
"table_type": 1,
"table_left": 1,
"table_top": 1,
"table_width": 1,
"table_height": 1,
"table_name": "section A",
"table_shapestyle": 1,
"table_fillstyle": 1,
"table_fillcolor": 1,
"section_id": 2,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"is_active": 1
},
{
"table_id": 4,
"table_index": 1,
"table_type": 1,
"table_left": 1,
"table_top": 1,
"table_width": 1,
"table_height": 1,
"table_name": "section B",
"table_shapestyle": 1,
"table_fillstyle": 1,
"table_fillcolor": 1,
"section_id": 2,
"font_name": "Times New Roman",
"font_bold": 1,
"font_italic": 0,
"font_size": 13.5,
"font_strike_through": 1,
"font_underline": 0,
"font_color": 54365,
"is_active": 1
}
];
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(data)
}).then(response => response.json());
Received response:
Request failed with error:
POST Price List Branches
This API is used to add or update Price List Branches. It must be given a json of data that contains several Identifiers that are listed in the table bellow. If "is_active" is set to 0 the Price List Branch will be deleted. The API requires an Authentication token.
| Identifier | Value Type | description | |
|---|---|---|---|
| id | integer | The Price List Branch ID | |
| price_list_id | integer | The Price List ID | |
| branch_id | integer | The Branch ID | |
| is_active | integer | 1 for true and 0 for false and delete |
Example request:
curl --request POST \
"https://posapis.com/api/v1/pricelistbranches" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}" \
--data '[
{
"id": 1000,
"price_list_id": 1,
"branch_id": 1001,
"is_active": 1
},
{
"id": 1001,
"price_list_id": 1,
"branch_id": 1001,
"is_active": 1
}
]'
const url = new URL(
"https://posapis.com/api/v1/pricelistbranches"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const data = [{
"id": 1000,
"price_list_id": 1,
"branch_id": 1001,
"is_active": 1
},
{
"id": 1001,
"price_list_id": 1,
"branch_id": 1001,
"is_active": 1
}
];
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(data)
}).then(response => response.json());
Received response:
Request failed with error:
POST Currency Types
This API is used to add or update Currency Types. It must be given a json of data that contains several Identifiers that are listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | |
|---|---|---|---|
| id | integer | The Currency Type ID | |
| description | string | The Currency Type description | |
| is_active | integer | 1 for true and 0 for false |
Example request:
curl --request POST \
"https://posapis.com/api/v1/currencytypes" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}" \
--data '[
{
"id": 1,
"description": "",
"is_active": 1
},
{
"id": 2,
"description": "",
"is_active": 1
}
]'
const url = new URL(
"https://posapis.com/api/v1/currencytypes"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const data = [{
"id": 1,
"description": "",
"is_active": 1
},
{
"id": 2,
"description": "",
"is_active": 1
}
];
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(data)
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Currency Types
This API is used to delete a Currency Type. It must be given a Currency Type ID to delete that specific Currency Type. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/currencytypes/:currencytypeid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/currencytypes/:currencytypeid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Currencies
This API is used to add or update Currencies. It must be given a json of data that contains several Identifiers that are listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | |
|---|---|---|---|
| id | integer | The Currency ID | |
| description | string | The Currency description | |
| conversion | double | The Currency conversion rate | |
| conversion2 | double | The Currency second conversion rate | |
| is_default | integer | 1 for true and 0 for false | |
| is_active | integer | 1 for true and 0 for false |
Example request:
curl --request POST \
"https://posapis.com/api/v1/currencies" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}" \
--data '[
{
"id":1,
"description":"description",
"is_active":1,
"change1":0,
"change2":0,
"change3":0,
"change4":0,
"change5":0,
"change6":0,
"change7":0,
"change8":0,
"change9":0,
"change10":0,
"is_default":0,
"conversion":1,
"conversion2":0.0000125,
"is_second_currency":0,
"hide_changes":1,
"decimals":0,
"accounting_code":"",
"currency_mask":"%23%23%23%2C%23%230.00",
"show_in_pos":1,
"show_in_calc":1,
"show_in_bo":1,
"read_only":0,
"sequence":20,
"show_credit_card_form":0,
"show_check_form":0,
"goes_to_bank":0,
"type":0,
"currency_type":1,
"is_gift_voucher":0,
"caption":"",
"long_description":"A long description"
}
]'
const url = new URL(
"https://posapis.com/api/v1/currencies"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const data = [{
"id":1,
"description":"description",
"is_active":1,
"change1":0,
"change2":0,
"change3":0,
"change4":0,
"change5":0,
"change6":0,
"change7":0,
"change8":0,
"change9":0,
"change10":0,
"is_default":0,
"conversion":1,
"conversion2":0.0000125,
"is_second_currency":0,
"hide_changes":1,
"decimals":0,
"accounting_code":"",
"currency_mask":"%23%23%23%2C%23%230.00",
"show_in_pos":1,
"show_in_calc":1,
"show_in_bo":1,
"read_only":0,
"sequence":20,
"show_credit_card_form":0,
"show_check_form":0,
"goes_to_bank":0,
"type":0,
"currency_type":1,
"is_gift_voucher":0,
"caption":"",
"long_description":"A long description"
}
];
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(data)
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Currencies
This API is used to delete a Currencies. It must be given a Currency ID to delete that specific Currency. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/currencytypes/:currencytypeid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/currencytypes/:currencytypeid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Price Lists
This API is used to add or update Price Lists. It must be given a json of data that contains several Identifiers that are listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | |
|---|---|---|---|
| id | integer | The Currency ID | |
| currency_id | integer | The Currency ID | |
| description | string | The Price List description | |
| is_taxable | integer | 1 for true and 0 for false | |
| is_active | integer | 1 for true and 0 for false |
Example request:
curl --request POST \
"https://posapis.com/api/v1/pricelists" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}" \
--data '[
{
"id": 1,
"currency_id": 1,
"description": "price list description",
"is_active": 1,
"is_taxable": 1
}
]'
const url = new URL(
"https://posapis.com/api/v1/pricelists"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const data = [{
"id": 1,
"currency_id": 1,
"description": "price list description",
"is_active": 1,
"is_taxable": 1
}
];
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(data)
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Price Lists
This API is used to delete a Price Lists. It must be given a Price List ID to delete that specific Price List. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/pricelists/:pricelistid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/pricelists/:pricelistid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Price List Details
This API is used to add or update Price List Details. It must be given a json of data that contains several Identifiers that are listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | |
|---|---|---|---|
| id | integer | The Currency ID | |
| price_list_id | integer | The Price List ID | |
| product_number | integer | The Product id | |
| price | double | The Price List Price | |
| is_active | integer | 1 for true and 0 for false |
Example request:
curl --request POST \
"https://posapis.com/api/v1/pricelistdetails" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}" \
--data '[
{
"id": 1000,
"price_list_id": 1000,
"product_number": 1000,
"price": 50000,
"is_active": 1
}
]'
const url = new URL(
"https://posapis.com/api/v1/pricelists"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const data = [{
"id": 1000,
"price_list_id": 1000,
"product_number": 1000,
"price": 50000,
"is_active": 1
}
];
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(data)
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Price List Details
This API is used to delete a Price List Details. It must be given a Price List Detail ID to delete that specific Price List Detail. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/pricelistdetails/:pricelistdetailid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/pricelistdetails/:pricelistdetailid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
PUT Payment Status
This API is used to update a Payment Header's Status and Payment Details Status. It must be given a Invoice ID to update that specific Invoice. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| INVOICEID | integer | The invoice ID | Yes | |
| TABLEID | integer | The table id | Yes | |
| STATUS | integer | The Status to be updated | Yes |
Example request:
curl --request PUT \
"https://posapis.com/api/v1/table/payment/status" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
-d '
[
{
"INVOICEID":21,
"TABLEID":176,
"STATUS":10
}
]
'
const url = new URL(
"https://posapis.com/api/v1/table/payment/status"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const body = {
[
{
"INVOICEID":21,
"TABLEID":176,
"STATUS":10
}
]
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
GET Payment(s)
This API will list all the Payments related to the logged in user. It can be given a Invoice ID to fetch a specific Payment. The API requires an Authentication token.
Example request:
curl --request GET \
--get "https://posapis.com/api/v1/table/payments" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/table/payments"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());
Example response (200):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 50
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"payments": [
{
"INVOICEID": 123,
"TABLEID": 456,
"TRANSACT": 12345,
"STATUS": 1,
"BRANCHID": 789,
"CLIENTID": "BIM111",
"HOCLIENTID": "BIM111",
"SOURCEID": 101,
"PAIDAMOUNT": 500,
"CREATED_AT": "2024-02-07 06:23:10",
"UPDATED_AT": "2024-02-13 08:24:14",
"items": [
{
"ID": 2,
"ITEMID": 2,
"INVOICEID": 123,
"SOURCEID": 102,
"PRODUCTCODE": 678,
"PRODUCTQTY": 15,
"PRODUCTPRICE": 40,
"LPRODNUM": 0,
"SPRODNUM": 0,
"CLIENTID": "BIM111",
"STATUS": 1,
"PAIDAMOUNT": 150,
"POSDETAILID": 1,
"LITEMID": 0,
"CREATED_AT": "2024-02-08 01:20:04",
"UPDATED_AT": "2024-02-13 08:24:14",
"modifiers": [
{
"ID": 1,
"ITEMID": 1,
"INVOICEID": 123,
"SOURCEID": 101,
"PRODUCTCODE": 567,
"PRODUCTQTY": 10,
"PRODUCTPRICE": 30,
"LPRODNUM": 2,
"SPRODNUM": 3,
"CLIENTID": "BIM111",
"STATUS": 1,
"PAIDAMOUNT": 100,
"POSDETAILID": 0,
"LITEMID": 2,
"CREATED_AT": "2024-02-07 06:44:59",
"UPDATED_AT": "2024-02-13 08:24:14"
}
],
"combos": []
},
{
"ID": 3,
"ITEMID": 3,
"INVOICEID": 123,
"SOURCEID": 103,
"PRODUCTCODE": 789,
"PRODUCTQTY": 20,
"PRODUCTPRICE": 50,
"LPRODNUM": 0,
"SPRODNUM": 0,
"CLIENTID": "BIM111",
"STATUS": 1,
"PAIDAMOUNT": 200,
"POSDETAILID": 2,
"LITEMID": 0,
"CREATED_AT": "2024-02-08 01:20:04",
"UPDATED_AT": "2024-02-13 08:24:14",
"modifiers": [],
"combos": [
{
"ID": 1,
"ITEMID": 1,
"INVOICEID": 123,
"SOURCEID": 101,
"PRODUCTCODE": 567,
"PRODUCTQTY": 10,
"PRODUCTPRICE": 30,
"LPRODNUM": 2,
"SPRODNUM": 3,
"CLIENTID": "BIM111",
"STATUS": 1,
"PAIDAMOUNT": 100,
"POSDETAILID": 0,
"LITEMID": 2,
"CREATED_AT": "2024-02-07 06:44:59",
"UPDATED_AT": "2024-02-13 08:24:14"
}
]
}
]
}
]
}
Example response (401):
Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 50
content-security-policy: frame-ancestors https://*.myshopify.com https://admin.shopify.com
permissions-policy: accelerometer=(self), ambient-light-sensor=(self), autoplay=(self), battery=(self), camera=(self), cross-origin-isolated=(self), display-capture=(self), document-domain=*, encrypted-media=(self), execution-while-not-rendered=*, execution-while-out-of-viewport=*, fullscreen=(self), geolocation=(self), gyroscope=(self), magnetometer=(self), microphone=(self), midi=(self), navigation-override=(self), payment=(self), picture-in-picture=*, publickey-credentials-get=(self), screen-wake-lock=(self), sync-xhr=*, usb=(self), web-share=(self), xr-spatial-tracking=(self)
x-content-type-options: nosniff
x-download-options: noopen
x-frame-options: allow-from https://*.myshopify.com; allow-from https://admin.shopify.com
x-permitted-cross-domain-policies: none
x-xss-protection: 1; mode=block
referrer-policy: no-referrer
access-control-allow-origin: *
{
"message": "Please, attach a Bearer Token to your request",
"status": "fail",
"success": false
}
Received response:
Request failed with error:
POST Menus
This API is used to add or update a menu. It must be given a data json that contains several Identifiers that are listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| menuid | integer | The menu ID | Yes | |
| descript | string | The menu discription / name | Yes | |
| seq | integer | The menu sequence | Yes | |
| conceptid | integer | The menu concept ID | Default NULL | |
| customurl | string | The menu custom url link | Default NULL | |
| isactive | integer | If the menu is an active menu or not | 1 active, 0 if exist delete | Default 1 |
DELETE Menu
This API is used to delete a Menu. It must be given a Menu ID to delete that specific Menu. The API requires an Authentication token.
POST Parents
This API is used to add or update a Parent. A Parent is a Parent Category that contains several categories. It must be given a data json that contains several Identifiers that are listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The parent ID | Yes | |
| descript | string | The parent discription / name | Yes | |
| isactive | integer | If the Parent is an active Parent or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/parents?data={"id": 1000,"descript": "Food", "isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}" \
const url = new URL(
"https://posapis.com/api/v1/parents?data={"id": 1000,"descript": "Food", "isactive":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Parent
This API is used to delete a Parent. It must be given a Parent ID to delete that specific Parent. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/parent/:parentid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/parent/:parentid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Category
This API is used to add or update a Category. A Category contains several Products and is related to a certain parent. It must be given a data json that contains several Identifiers that are listed in the table bellow. It must be given a body Identifiers that is listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| catname | string | The category name | No | |
| catid | integer | The category ID | Yes | |
| descript | string | The category description | Yes | |
| descript2 | string | The second category description | No | |
| seq | integer | The category sequence | Yes | |
| hidefromnavigation | integer | Hide category from navigation bar | (1 = dont hide, while 0 is hide) | Default 1 |
| isactive | integer | If the Category is an active Category or not | 1 active, 0 if exist delete | Default 1 |
| picture | string | The category Base64 picture | Yes |
DELETE Category
This API is used to delete a Category. It must be given a Category ID to delete that specific Category. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/category/:catid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/category/:catid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response :
Request failed with error:
POST Product
This API is used to add or update a Product. A Product is related to a certain catergory. It must be given a data json that contains several Identifiers that are listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| prodnum | integer | The Product number / ID | Yes | |
| catid | integer | The category ID | Yes | |
| descript | string | The Product description | Yes | |
| descript2 | string | The second Product description | No | |
| prodinfo | string | The Product information | No | |
| prodinfo2 | string | The second Product information | No | |
| price | double | The Product price | Default 0 | |
| groupid | integer | The Product group ID | Default NULL | |
| enabled | integer | Enable Product | (1 and 0) | Default 1 |
| pid | integer | The Product pid | Default NULL | |
| brand | string | The Product brand name | No | |
| refcode1 | string | The Product reference number / barcode | Default NULL | |
| refcode2 | string | The second Product reference number / barcode | Default NULL | |
| country_of_origin | string | The Product country of origin | Default NULL | |
| weight | integer | The Product weight | Default NULL | |
| weight_unit | string | The Product weight unit | Default NULL | |
| istaxable1 | integer | The Product istaxable1 | (1 and 0) | Default NULL |
| istaxable2 | integer | The Product istaxable2 | (1 and 0) | Default NULL |
| istaxable3 | integer | The Product istaxable3 | (1 and 0) | Default NULL |
| ModifiersGroupID | integer | The Product modifiers group ID | Default 0 | |
| ComboGroupID | integer | The Product combo group ID | Default 0 | |
| isactive | integer | If the Product is an active Product or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/products?data={"prodnum": 1003919, "catid": 1, "descript": "Ajax Festival of Flowers Lotus 2 L ", "prodinfo": "", "prodinfo2": "", "price": 12000, "groupid": 0, "enabled": 1, "pid": 1, "brand": "", "refcode1": "8714789791876", "refcode2": "8714789514062", "ModifiersGroupID": 0, "country_of_origin": , "weight": , "weight_unit":, "istaxable1": 1, "istaxable2": 0, "istaxable3": 0, "ComboGroupID": 0}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/products?data={"prodnum": 1003919, "catid": 1, "descript": "Ajax Festival of Flowers Lotus 2 L ", "prodinfo": "", "prodinfo2": "", "price": 12000, "groupid": 0, "enabled": 1, "pid": 1, "brand": "", "refcode1": "8714789791876", "refcode2": "8714789514062", "ModifiersGroupID": 0, "country_of_origin": , "weight": , "weight_unit":, "istaxable1": 1, "istaxable2": 0, "istaxable3": 0, "ComboGroupID": 0}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Product
This API is used to delete a Product. It must be given a Product ID to delete that specific Products. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/product/:prodnum/:catid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/product/:prodnum/:catid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Product Picture
This API is used to add or update a Product Picture. It must be given body Identifiers that are listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| pictureid | integer | The product number / ID | Yes | |
| title | string | The Product Picture title | Yes | |
| picture | string | The Product picture in Base64 | Yes |
Example request:
curl --request POST \
"https://posapis.com/api/v1/products/:prodnum/pictures" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}" \
-d '
{
"pictureid": 1000,
"title": "Sunset Tree",
"picture":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCBYWFRgVFRYYGBgZGhgYGhoaGBoYGhoYGRgZGhkYGBocIS4lHB4rIRgYJjgmKy8xNTU1GiQ7QDs0Py40NTEBDAwMEA8QHxISHzYrJCs0NDQ2NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NP/AABEIALEBHQMBIgACEQEDEQH/xAAbAAACAwEBAQAAAAAAAAAAAAAAAwECBAUGB//EADcQAAEDAgMEBwcEAwEBAAAAAAEAAhEDIQQxQRJRYXEFIoGRodHwExQyUpKxwQZi4fEVQlPScv/EABkBAAMBAQEAAAAAAAAAAAAAAAABAgMEBf/EACwRAAICAQMEAgEDBAMAAAAAAAABAhEDEiExBBNBUSJhFAWRoTJScbEVI0L/2gAMAwEAAhEDEQA/APk7HkKTddDE4RwzZxtosREZhaRaZrLHKLpjKMQWnXLmoZSkwhhByV2knKx+6Y1ToYykW3JieI+yl1PkfBVBn4s+OfeqvaQbFTTNdktlsDsODoezRZn0SOS3Uq0WcVocA4WcORgdx1RbXIu3GStHJa46qWs1WmtRM6dhCU0kWKswcXF7jHw6DHBMp4abyAN5Sp5KWAzIlDXo0TV7oa8SCBp4rC9q6LGA5G/JIfQ370kE4t7mWmbgrY+iYDtCkBkFb6dduyWOyN2ncdRyICb2FjinakZDVgRqqHepqNl3enMp9XthMVNuhuHEgjh9rpFSlErTRYZAGYV6jbmRmM+EKeGbuGqJjeAWi94hKYmPbuShmqRg+RxbISH5LRQ3KjmICStWZoUtKlzVaiLpoyrcs9iWm1ClwmN8lXhVIsmOCoQgllWNlONhxVqdM6epQ9kZoCnyJ2ZXRwrdmDlDT3mViYbi0J768tPOB5+t6lo0xtRdisRUtzJKzhspr22VC+ECbt2x9LE//XerVXg/CRxCyFpCsUqK7kqpgQdO5Wa7fPYfV0MfG9PaDpPggUVfBQGTme1MLDrMqvs0xr5sUGiXsKbNCh9CMrp4Yr1WWSs10bGUPjMFLiTmtIw8iRnulVbRIKdohwkJLCteEws5plslJdIAGYRdlxgk7YjEU4mNLJLHRc33z9wukzDyJ8FerhWhs6apX4L7TfyRzHtmIBSnMK1NaWktMx6utFPDg+rp2Z6GxGEw03Pj+EVeo4gQW6RxWvEv2LN1Ejgk4dm3DctB36+KF7KcUviuS+Ad1w6MuJATcUQSdmYmZ1J3clbF0dgtYPiHWd3WH3U0qUtzUOuTojFpPGc19O8jJKqMvOi14lkGAmUWAsdO+fAKr2Od47k0c9lrpjBmrGiRpZMowqZCi06ZhqtVaITsQEptgmjCaqRR5V2NtKXEpz8oTJW+4oqoCsQiEyRzK2zlnP8ASS90qitCQ7b2GtbAJPD8lUpNJ9ZBXdkeyO7NSynnpYd5QUo7g9s5fwqupN3qzWyLaLPUF1DLapXRZpBzQ1sZ5KjXJrSmSnZaoyDmDxCdQeBPFKdUJzv91QEoLtJ2jTYqfZpTXLbMtGUxeJ8Qk9jWNS5IL7QqG6q8qKTusPylQ3LemOpMvErVTpzbsCzuN7eu1DahzufW5SbQaTovXZBTKDbHRWcdrPNXbSIhKzRQ+VrgWx5aR6Kq55JI0OSaWg2hTVplsW7B6sqsHF19FsNhdpwDrcSlVz1zaAIHZknsrSImCr1Ke11t4AKm3e5pojKNRMNSnrE8VTDvjn5Lc2j1SLpDcMJmfyqTMpYmmmjVtbbQ8i4seSpQpEEgH1uTMNUDCfsZvvhanNnZLcjmdfFS3Wx0RimrfPk5tTDEyddyUxuy6H2BWikNp0HMTP8ACdicM0kcu1O62Zjo1fKJzsSCLC4GXJKc3KE/EsLbbsuSja6sd38KlwYyjcnZnq0ZWSqxb3TEHJZnMvG9UjnyRRFLDHYL9xhKcF38Rhtils/NB8FxHNRGWovNh7VJ80KDNyoWLbh2XMgwB/SzVDeVV7nM47WZyFYNV2slMdCZCRVomTyTqTNqeJvyCgU56rc/AJ9KWsjODpBsolwb44778CGVNm28Ge63csVXNNe8pClLyTkn4RMK7UNfwV7HKy0IRCArbBzQ22iB0WDMitFOkY/Pkq0HgWcJB8NxCY9kQM84P54JM2gklZWq0gXCSuuwNAG2C5pAAu3OL9maw1cLbaZlzB7LclKZc8flFGOyWu0W9FYQ/SEymb28k3EITrY2GrujjPkujhX7QEi4y/sLlUXda9wtzSBkBOhG71vWconbhnvbYpzyx9xacluZsuIG0AIi+fIDVYcW+4Ov3VsNsky4kEaIa2HGdSa8WajhQDInfY7lVlcNgd40g9is/FAWBz++47lUYfbEgiRmLb7mNVPjc2bV/wDXyPxDBBdOYEW1WbAQSY+IafcrXSZsjZsQQdAI4G8arDQGy8jI9yIu00GS006/yPq4UuLjFxr+EYdhbZ3wkgZgjxAWzDMqEmfhIMfdPexpbtG32nhGShy8GkcSfyWzODiGw8GYz9eK2UsUS6NkOmxMRA8lTpHDnMDL1mtWApPDCNppyyLT9iVo2nGzmhFrK4rbyczGM0HoLO+p1Y3Lo4ylHA68iubs804vYyzQakwgkC8+CRk5vAhdLDt/aO1Z6jOsTG5WnZlLG1TOx0z8AjcPsvPQu7jXl9Np5flYAyBkssWyOnrVrmmvSMmLeG9Rp1vzWEhPrsMqtNi6I7I8uduVAynZVcxPcICqXQpciu2qFUmEEE2BMKcTVnLkqPfPNUIQlfInLStKEuVS1Nc1UTZg0GypATIRCZekqCU3bnNV2VOygFaL20Tmu0y/PYs4amAlOi0xjgQLGw0U0sURbSe5UVdhFWPU07RqrxmBnrkeazVGa5qwUtQo0DlZFFxC1NxQ7fys5CqGFDimOMpR4N7XbQkdyq52+345LK0kJ9N5m90tNGiyWJqOIMSt+AxhabZ3y9ZrNXZJS29U2II4T+QhxUkKOSUJWmelw+JY8hsgOOUTE7oO9JxWAghxPVO65jgFhwZBEQJ0Pkus/FBrNg3zkk3jgR3LCUXGWx6kc8ckPkZamIa1o2STE9Uk98q1F7Hi7iCZsJ3G4hcvEEE2SGPLTIJC07aaOZ9W1LdbHUrYgjqPJ78tL8IW3A4ZrmSx/W4W3Lg1qjndZxJJzJzWjo/EPBhsj1qlKHx2FDqE8ltWju1MLLZdncTbMZgrF/jTsywbV9/krux2w0iZJ32HmfBIw3TGwbcsrd0idfNYKEuUdks+JtJmJ8ixBBCGmRG7Vegq0m1ADsQ46iYjtXMfhC3lv0vxCtSTVcMl4ZJ6k7RDX7TA2NfBQ9jTLZyFtxWh9HYYSTEWB/1M8ZWGmwzwA2ieHohKNU6DInaTXJgriVncYK0vMmdJy1WSsVpq2PPnCnZBeozU06ZJTH0ozU6tx6JNWI2VVyc5ij2cK9Rk4GchV2E5yqk5NkaUO9kj2a6LaKt7unqNe0c0UlPsl0hhke7J60HZZzgxWFNb/d1YYdPWHaZgFNW9ktwoJgoI1AsTOcKSkUV0hh1PuyNY+yzm+xU+yXTGGVK1MNBccgjWDxNI53s0tz2tN3AHmsOJ6WcbNEDfmew6aLnc/Xkk5nPKS8Hcd0gwTJJPAZ9qw1OkifhaAONysJQBKzc2S3KRqZ0nUbdpA7B+VZvSdWSdqZEXAI7jrxWZlOVYU1Dmy0pey4x1T5u8DyVv8i+ZtyhK9kqbF4nfdNTZLizfR6S0eO0eS3YbHtNgY52XAMKZ9Z+CpTYlKUWemY7buDteKv7A7l5nD13sIcwwdDHgZtqvQdFdKe0dsvADt8xO6xVa2b45xk6lydTBYtzLZjcd26d67NJ7HnaEbQFzkbb/ALrluwyGAjf65LKSUt0enizSx7PdD+mPgERbOxE7rb1zqg2aY/cJJIP4H9ruUXCNtxkyTFp9ZJOPYwiRBi45m8d5WKco7V5Ox6J27V0eXfszYgc8+1ILSStmOgWhIZRfnEDfl/a1Ujzp4/lX+h9IbAmLpQpOcZTKYMyT6+/gmkk2vHAR4lJPctxuKXgzvpBuqzVHhaX0zy8UsUb3t23WiZzzi3skZQDuRslazASS/gnZi4Ud9tNXFJaNlTsrLUdyghApKfZJwarhqNRagjOKSu2jwTw1XAS1DUEZ/YqzaK0tamMYpcylBGdtFMGHWlrE9rVLmWoIwjDLifqp2zRjq9Yxcwcr7I1PmvVEwvK9Pfp99auHtMtLYMkAN2cgLTB5HNOMt9zm6mLUGoq2zx+Hwxde0cTF+e+yZRYzUuDp5ZSYJmxy3ZFauk8D7J4puc0/CS1pLiAZsLC+val1nNIDAwNdIlxcbCLB2QGWtxs929njaWnTA4VjgAw9Yi4uTaSdLADfw5qHYIzAEkSS0dYgDMyNFamS34JB/wBoc0tIbcFrpN87SbHNdDD4oH4g5pEbAAEEQ6DcHhbmokzaEbMWHwpMQRfwJyHct2H6P3tJMGwtkBe+k9326PR+GL9Gw1rczNtk2zGecZz49xnR7/jYNjasAJECBHP4Z5lc0stHp4+mi1bPGP6PNyAdkXJ2dNYE3A81kfhSSRmYJO4EaSLaL2uK6LIGwQ0EyQ42jZEQDlmAZ4Ea24VYhjusIEva7YJGrZGZjRXDJZlmwUrRx24DqzaIkkG+UxB/E6JVZrLAbjJ62+06kxeFuxOKcZaxpaJOySYcQCT14sdLZTvXPewRtAi1+sQHOP8AtA3LdM8+UaKtpNcSB1RBPWNgb9WQLm40UYZxp1GmQC065RkZibZpteq1zSQxrMo2Ztv2gT4xokMY55a1rS5xMDiTkBuVGfnY+i0GbYBtGc/ynCnFgEnoHAGjRa1xJPxEWs43IEaLqGmLGFg57ntxTcU2qZlo9HvdeICd/j2jN0nmAuoKrS2BGWtrrlVqD3T1h2GR2rKeWR1YMGN7tnPxODpzMSRkFz8SJMQLabuZ/C6xwQbm6eMEfiFndhWDJze4z4LOMnZ3SUHGlRxXUyTb+ezcmNovyA7V1BTYLZ8gf7TWPj4WHuAWus5Hj32TOSOjnu3+uKYOhjqO9dhtcjTxS34l5y8AUd30S+mvdo5NTooDOO7zWV2EbuHgunXFQ/6nwXOqUHk7u1aRn9nLlwNcI64cpleE96qf9H/W7zUjF1P+j/rPmt+19nAut+j3YhWBXgxi3/8AR/1O81b3p/zv+t3ml2/sv836PdgqweF4MYp/zv8Ard5qRiX/ADv+t3mjtD/N+j37CnsXzwYh/wA7/rd5qwxD/nf9bvNLsP2Uut+j6QxqcGBfNRXf87/qPmrtqv8And9R80n0z9lLrE/H8n0F6GNXhGPf8zu8+a0sL/mPeUuw/ZrHOpeD1GM6EpVCS5jdoiC4CHZRmM7b1iH6bpANbsu6uR2iZMRJGRPrKy5jWP8AmPemtpu3+KFCS8hohJ20b3/ppgpvawvbtCSAA6S24EHPIDMTfhHIf+nKzGF52SwS4j4SBAvs5DlP+q3sDt571ppk6lTKL9lx6aN2tg6F6LrAy0EECciDBGWVtc4FivpP6XdSDIcGhwEdYCwGdoXi8LUO8rL+pulHsbT2XEElwnWLLklFxkmi8+LVCr2O50/gzUqEUQWjrDaghuzNxIF9LLxVfoGs98NaTeCXAsDYgTLoBi/wz8NpsvYVa5iATAEDkFzaz37z3nzRjjLk0WD4KLZyKH6KJM1avyyGNBNhbrOFgN0aDs6I/R+HgjZMER8V4mY2s8+KW+q/53fUfNZamJrfO/6nf+l06ZvyYvpYR8WdSn+ksPLTsDqggXJEHfe54rczomnT+BjG62AGeeS8q7E1v+j/AK3f+kh+Lr/9H/W7zR2ZvyJaIO1H+D2fsQodTC8JUxtb/o/63eazux1b/o/63+aa6eXsmXUQXhnv3uDbysr8WPmjsC8G/GVTnUf9bvNKdianzv8Ard5pS6SUuWEOvxw/8s9y7Ez/ALHu8gkHEfu8P5XiTianzv8Aqd5qhxD/AJ3/AFHzS/DkvJT/AFWH9rPctxQ+Zx7R+ApdigPUnxXhTin/ADv+p3mqHFVPnd9TvNH4r9h/ysa/pf7nvPfkt+P9SvCnEv8Anf8AUfNUOIf87vqKa6T7Il+qx/tf7ns62M4jvWN2KHzeC8v7d/zO+o+ar7R3zO7yrXT15MZfqSfgqFMKFIXWeSiQFZVBUhyVDsuFYBLBVgUykxjVdqUHepVw/imUmaGlXZPoFZw/l4JjXIKUjWx/b23Wui/1M/lc9lQ8fBOY/meTWpNG0MlHTY/1AT2v59xXOZWA1AH/AMO7paQE1lad08HEHsErNxOmOV2dAVFZlWDmufUxTGi7ha157sly6/TbQYaJ46LKS9G/5EY8s9pQrrhfrKv1Kd7hztP2/wABcF/T9T/WB4rHice98BztqL9qzUHdsjL1kJQcY3Z9OZidoTI71V7vVl89o9O1miA4HmN3anU/1LVB60EbhLfFJQaNl12Jrez2VUrFUqLk0v1Gx1nDZ4mT9k/31jh1XDvgd+0FrFeyZdRCX9LNLn+rpFR/PtCQ+tH9eZSn1OA7gPwtlE5pZmTVqcvXasz3H1J/Cl7z6ySHv9StEjmlOwcfWSU8qC/klufx7kGTkSVUqC5UJQQ2SVUhBKjaSJsiFBCklVKAIUFShBBEqVUKQgCVYFVVTWASboBoUwsrq53KheTqp1Idm0vAzKj3hu/wWFCNTHZu96bxR7435SsKEamLUzeOkP2nvTWdKftP1fwuWgJamNSaOqelz8veR+AFnr9IvdbIbhksiEm2y9Un5Jc8nMkolQhImywcjaVVCVD1DNtVLlCECthKljiLgwoQmBqp9IPaIBHaAr/5R+4ePmsSqU7YOUvZvPSJ+Ud5VPfv2rGhO2LUzZ77+1R72Nx8FkQjUxWzZ7yDvUio06rEhPUws3SFBWNryMimNrHVCkgseoVG1AVZWnYglRKCoQBQ1FBqpaFnqYEucTmoQhSAIQhAAhCEACEIQAIQhAEypVUIHZZChSgoEShQlQEoUKJTE2WUKEIFZJKhCECBCEIAEIQgAQhCABCEIAFIcVCEAXFRT7RLQnqYAhCEgBCEIAEIQgAQhCABCEIAEIQgAQhCAJClCEFIFCEIGBUIQglghCECBCEIAEIQgAQhCABCEIAEIQgAQhCABCEIA//Z"
}
'
const url = new URL(
"https://posapis.com/api/v1/products/:prodnum/pictures"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const body = {
"pictureid": 1000,
"title": "Sunset Tree",
"picture":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCBYWFRgVFRYYGBgZGhgYGhoaGBoYGhoYGRgZGhkYGBocIS4lHB4rIRgYJjgmKy8xNTU1GiQ7QDs0Py40NTEBDAwMEA8QHxISHzYrJCs0NDQ2NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NP/AABEIALEBHQMBIgACEQEDEQH/xAAbAAACAwEBAQAAAAAAAAAAAAAAAwECBAUGB//EADcQAAEDAgMEBwcEAwEBAAAAAAEAAhEDIQQxQRJRYXEFIoGRodHwExQyUpKxwQZi4fEVQlPScv/EABkBAAMBAQEAAAAAAAAAAAAAAAABAgMEBf/EACwRAAICAQMEAgEDBAMAAAAAAAABAhEDEiExBBNBUSJhFAWRoTJScbEVI0L/2gAMAwEAAhEDEQA/APk7HkKTddDE4RwzZxtosREZhaRaZrLHKLpjKMQWnXLmoZSkwhhByV2knKx+6Y1ToYykW3JieI+yl1PkfBVBn4s+OfeqvaQbFTTNdktlsDsODoezRZn0SOS3Uq0WcVocA4WcORgdx1RbXIu3GStHJa46qWs1WmtRM6dhCU0kWKswcXF7jHw6DHBMp4abyAN5Sp5KWAzIlDXo0TV7oa8SCBp4rC9q6LGA5G/JIfQ370kE4t7mWmbgrY+iYDtCkBkFb6dduyWOyN2ncdRyICb2FjinakZDVgRqqHepqNl3enMp9XthMVNuhuHEgjh9rpFSlErTRYZAGYV6jbmRmM+EKeGbuGqJjeAWi94hKYmPbuShmqRg+RxbISH5LRQ3KjmICStWZoUtKlzVaiLpoyrcs9iWm1ClwmN8lXhVIsmOCoQgllWNlONhxVqdM6epQ9kZoCnyJ2ZXRwrdmDlDT3mViYbi0J768tPOB5+t6lo0xtRdisRUtzJKzhspr22VC+ECbt2x9LE//XerVXg/CRxCyFpCsUqK7kqpgQdO5Wa7fPYfV0MfG9PaDpPggUVfBQGTme1MLDrMqvs0xr5sUGiXsKbNCh9CMrp4Yr1WWSs10bGUPjMFLiTmtIw8iRnulVbRIKdohwkJLCteEws5plslJdIAGYRdlxgk7YjEU4mNLJLHRc33z9wukzDyJ8FerhWhs6apX4L7TfyRzHtmIBSnMK1NaWktMx6utFPDg+rp2Z6GxGEw03Pj+EVeo4gQW6RxWvEv2LN1Ejgk4dm3DctB36+KF7KcUviuS+Ad1w6MuJATcUQSdmYmZ1J3clbF0dgtYPiHWd3WH3U0qUtzUOuTojFpPGc19O8jJKqMvOi14lkGAmUWAsdO+fAKr2Od47k0c9lrpjBmrGiRpZMowqZCi06ZhqtVaITsQEptgmjCaqRR5V2NtKXEpz8oTJW+4oqoCsQiEyRzK2zlnP8ASS90qitCQ7b2GtbAJPD8lUpNJ9ZBXdkeyO7NSynnpYd5QUo7g9s5fwqupN3qzWyLaLPUF1DLapXRZpBzQ1sZ5KjXJrSmSnZaoyDmDxCdQeBPFKdUJzv91QEoLtJ2jTYqfZpTXLbMtGUxeJ8Qk9jWNS5IL7QqG6q8qKTusPylQ3LemOpMvErVTpzbsCzuN7eu1DahzufW5SbQaTovXZBTKDbHRWcdrPNXbSIhKzRQ+VrgWx5aR6Kq55JI0OSaWg2hTVplsW7B6sqsHF19FsNhdpwDrcSlVz1zaAIHZknsrSImCr1Ke11t4AKm3e5pojKNRMNSnrE8VTDvjn5Lc2j1SLpDcMJmfyqTMpYmmmjVtbbQ8i4seSpQpEEgH1uTMNUDCfsZvvhanNnZLcjmdfFS3Wx0RimrfPk5tTDEyddyUxuy6H2BWikNp0HMTP8ACdicM0kcu1O62Zjo1fKJzsSCLC4GXJKc3KE/EsLbbsuSja6sd38KlwYyjcnZnq0ZWSqxb3TEHJZnMvG9UjnyRRFLDHYL9xhKcF38Rhtils/NB8FxHNRGWovNh7VJ80KDNyoWLbh2XMgwB/SzVDeVV7nM47WZyFYNV2slMdCZCRVomTyTqTNqeJvyCgU56rc/AJ9KWsjODpBsolwb44778CGVNm28Ge63csVXNNe8pClLyTkn4RMK7UNfwV7HKy0IRCArbBzQ22iB0WDMitFOkY/Pkq0HgWcJB8NxCY9kQM84P54JM2gklZWq0gXCSuuwNAG2C5pAAu3OL9maw1cLbaZlzB7LclKZc8flFGOyWu0W9FYQ/SEymb28k3EITrY2GrujjPkujhX7QEi4y/sLlUXda9wtzSBkBOhG71vWconbhnvbYpzyx9xacluZsuIG0AIi+fIDVYcW+4Ov3VsNsky4kEaIa2HGdSa8WajhQDInfY7lVlcNgd40g9is/FAWBz++47lUYfbEgiRmLb7mNVPjc2bV/wDXyPxDBBdOYEW1WbAQSY+IafcrXSZsjZsQQdAI4G8arDQGy8jI9yIu00GS006/yPq4UuLjFxr+EYdhbZ3wkgZgjxAWzDMqEmfhIMfdPexpbtG32nhGShy8GkcSfyWzODiGw8GYz9eK2UsUS6NkOmxMRA8lTpHDnMDL1mtWApPDCNppyyLT9iVo2nGzmhFrK4rbyczGM0HoLO+p1Y3Lo4ylHA68iubs804vYyzQakwgkC8+CRk5vAhdLDt/aO1Z6jOsTG5WnZlLG1TOx0z8AjcPsvPQu7jXl9Np5flYAyBkssWyOnrVrmmvSMmLeG9Rp1vzWEhPrsMqtNi6I7I8uduVAynZVcxPcICqXQpciu2qFUmEEE2BMKcTVnLkqPfPNUIQlfInLStKEuVS1Nc1UTZg0GypATIRCZekqCU3bnNV2VOygFaL20Tmu0y/PYs4amAlOi0xjgQLGw0U0sURbSe5UVdhFWPU07RqrxmBnrkeazVGa5qwUtQo0DlZFFxC1NxQ7fys5CqGFDimOMpR4N7XbQkdyq52+345LK0kJ9N5m90tNGiyWJqOIMSt+AxhabZ3y9ZrNXZJS29U2II4T+QhxUkKOSUJWmelw+JY8hsgOOUTE7oO9JxWAghxPVO65jgFhwZBEQJ0Pkus/FBrNg3zkk3jgR3LCUXGWx6kc8ckPkZamIa1o2STE9Uk98q1F7Hi7iCZsJ3G4hcvEEE2SGPLTIJC07aaOZ9W1LdbHUrYgjqPJ78tL8IW3A4ZrmSx/W4W3Lg1qjndZxJJzJzWjo/EPBhsj1qlKHx2FDqE8ltWju1MLLZdncTbMZgrF/jTsywbV9/krux2w0iZJ32HmfBIw3TGwbcsrd0idfNYKEuUdks+JtJmJ8ixBBCGmRG7Vegq0m1ADsQ46iYjtXMfhC3lv0vxCtSTVcMl4ZJ6k7RDX7TA2NfBQ9jTLZyFtxWh9HYYSTEWB/1M8ZWGmwzwA2ieHohKNU6DInaTXJgriVncYK0vMmdJy1WSsVpq2PPnCnZBeozU06ZJTH0ozU6tx6JNWI2VVyc5ij2cK9Rk4GchV2E5yqk5NkaUO9kj2a6LaKt7unqNe0c0UlPsl0hhke7J60HZZzgxWFNb/d1YYdPWHaZgFNW9ktwoJgoI1AsTOcKSkUV0hh1PuyNY+yzm+xU+yXTGGVK1MNBccgjWDxNI53s0tz2tN3AHmsOJ6WcbNEDfmew6aLnc/Xkk5nPKS8Hcd0gwTJJPAZ9qw1OkifhaAONysJQBKzc2S3KRqZ0nUbdpA7B+VZvSdWSdqZEXAI7jrxWZlOVYU1Dmy0pey4x1T5u8DyVv8i+ZtyhK9kqbF4nfdNTZLizfR6S0eO0eS3YbHtNgY52XAMKZ9Z+CpTYlKUWemY7buDteKv7A7l5nD13sIcwwdDHgZtqvQdFdKe0dsvADt8xO6xVa2b45xk6lydTBYtzLZjcd26d67NJ7HnaEbQFzkbb/ALrluwyGAjf65LKSUt0enizSx7PdD+mPgERbOxE7rb1zqg2aY/cJJIP4H9ruUXCNtxkyTFp9ZJOPYwiRBi45m8d5WKco7V5Ox6J27V0eXfszYgc8+1ILSStmOgWhIZRfnEDfl/a1Ujzp4/lX+h9IbAmLpQpOcZTKYMyT6+/gmkk2vHAR4lJPctxuKXgzvpBuqzVHhaX0zy8UsUb3t23WiZzzi3skZQDuRslazASS/gnZi4Ud9tNXFJaNlTsrLUdyghApKfZJwarhqNRagjOKSu2jwTw1XAS1DUEZ/YqzaK0tamMYpcylBGdtFMGHWlrE9rVLmWoIwjDLifqp2zRjq9Yxcwcr7I1PmvVEwvK9Pfp99auHtMtLYMkAN2cgLTB5HNOMt9zm6mLUGoq2zx+Hwxde0cTF+e+yZRYzUuDp5ZSYJmxy3ZFauk8D7J4puc0/CS1pLiAZsLC+val1nNIDAwNdIlxcbCLB2QGWtxs929njaWnTA4VjgAw9Yi4uTaSdLADfw5qHYIzAEkSS0dYgDMyNFamS34JB/wBoc0tIbcFrpN87SbHNdDD4oH4g5pEbAAEEQ6DcHhbmokzaEbMWHwpMQRfwJyHct2H6P3tJMGwtkBe+k9326PR+GL9Gw1rczNtk2zGecZz49xnR7/jYNjasAJECBHP4Z5lc0stHp4+mi1bPGP6PNyAdkXJ2dNYE3A81kfhSSRmYJO4EaSLaL2uK6LIGwQ0EyQ42jZEQDlmAZ4Ea24VYhjusIEva7YJGrZGZjRXDJZlmwUrRx24DqzaIkkG+UxB/E6JVZrLAbjJ62+06kxeFuxOKcZaxpaJOySYcQCT14sdLZTvXPewRtAi1+sQHOP8AtA3LdM8+UaKtpNcSB1RBPWNgb9WQLm40UYZxp1GmQC065RkZibZpteq1zSQxrMo2Ztv2gT4xokMY55a1rS5xMDiTkBuVGfnY+i0GbYBtGc/ynCnFgEnoHAGjRa1xJPxEWs43IEaLqGmLGFg57ntxTcU2qZlo9HvdeICd/j2jN0nmAuoKrS2BGWtrrlVqD3T1h2GR2rKeWR1YMGN7tnPxODpzMSRkFz8SJMQLabuZ/C6xwQbm6eMEfiFndhWDJze4z4LOMnZ3SUHGlRxXUyTb+ezcmNovyA7V1BTYLZ8gf7TWPj4WHuAWus5Hj32TOSOjnu3+uKYOhjqO9dhtcjTxS34l5y8AUd30S+mvdo5NTooDOO7zWV2EbuHgunXFQ/6nwXOqUHk7u1aRn9nLlwNcI64cpleE96qf9H/W7zUjF1P+j/rPmt+19nAut+j3YhWBXgxi3/8AR/1O81b3p/zv+t3ml2/sv836PdgqweF4MYp/zv8Ard5qRiX/ADv+t3mjtD/N+j37CnsXzwYh/wA7/rd5qwxD/nf9bvNLsP2Uut+j6QxqcGBfNRXf87/qPmrtqv8And9R80n0z9lLrE/H8n0F6GNXhGPf8zu8+a0sL/mPeUuw/ZrHOpeD1GM6EpVCS5jdoiC4CHZRmM7b1iH6bpANbsu6uR2iZMRJGRPrKy5jWP8AmPemtpu3+KFCS8hohJ20b3/ppgpvawvbtCSAA6S24EHPIDMTfhHIf+nKzGF52SwS4j4SBAvs5DlP+q3sDt571ppk6lTKL9lx6aN2tg6F6LrAy0EECciDBGWVtc4FivpP6XdSDIcGhwEdYCwGdoXi8LUO8rL+pulHsbT2XEElwnWLLklFxkmi8+LVCr2O50/gzUqEUQWjrDaghuzNxIF9LLxVfoGs98NaTeCXAsDYgTLoBi/wz8NpsvYVa5iATAEDkFzaz37z3nzRjjLk0WD4KLZyKH6KJM1avyyGNBNhbrOFgN0aDs6I/R+HgjZMER8V4mY2s8+KW+q/53fUfNZamJrfO/6nf+l06ZvyYvpYR8WdSn+ksPLTsDqggXJEHfe54rczomnT+BjG62AGeeS8q7E1v+j/AK3f+kh+Lr/9H/W7zR2ZvyJaIO1H+D2fsQodTC8JUxtb/o/63eazux1b/o/63+aa6eXsmXUQXhnv3uDbysr8WPmjsC8G/GVTnUf9bvNKdianzv8Ard5pS6SUuWEOvxw/8s9y7Ez/ALHu8gkHEfu8P5XiTianzv8Aqd5qhxD/AJ3/AFHzS/DkvJT/AFWH9rPctxQ+Zx7R+ApdigPUnxXhTin/ADv+p3mqHFVPnd9TvNH4r9h/ysa/pf7nvPfkt+P9SvCnEv8Anf8AUfNUOIf87vqKa6T7Il+qx/tf7ns62M4jvWN2KHzeC8v7d/zO+o+ar7R3zO7yrXT15MZfqSfgqFMKFIXWeSiQFZVBUhyVDsuFYBLBVgUykxjVdqUHepVw/imUmaGlXZPoFZw/l4JjXIKUjWx/b23Wui/1M/lc9lQ8fBOY/meTWpNG0MlHTY/1AT2v59xXOZWA1AH/AMO7paQE1lad08HEHsErNxOmOV2dAVFZlWDmufUxTGi7ha157sly6/TbQYaJ46LKS9G/5EY8s9pQrrhfrKv1Kd7hztP2/wABcF/T9T/WB4rHice98BztqL9qzUHdsjL1kJQcY3Z9OZidoTI71V7vVl89o9O1miA4HmN3anU/1LVB60EbhLfFJQaNl12Jrez2VUrFUqLk0v1Gx1nDZ4mT9k/31jh1XDvgd+0FrFeyZdRCX9LNLn+rpFR/PtCQ+tH9eZSn1OA7gPwtlE5pZmTVqcvXasz3H1J/Cl7z6ySHv9StEjmlOwcfWSU8qC/klufx7kGTkSVUqC5UJQQ2SVUhBKjaSJsiFBCklVKAIUFShBBEqVUKQgCVYFVVTWASboBoUwsrq53KheTqp1Idm0vAzKj3hu/wWFCNTHZu96bxR7435SsKEamLUzeOkP2nvTWdKftP1fwuWgJamNSaOqelz8veR+AFnr9IvdbIbhksiEm2y9Un5Jc8nMkolQhImywcjaVVCVD1DNtVLlCECthKljiLgwoQmBqp9IPaIBHaAr/5R+4ePmsSqU7YOUvZvPSJ+Ud5VPfv2rGhO2LUzZ77+1R72Nx8FkQjUxWzZ7yDvUio06rEhPUws3SFBWNryMimNrHVCkgseoVG1AVZWnYglRKCoQBQ1FBqpaFnqYEucTmoQhSAIQhAAhCEACEIQAIQhAEypVUIHZZChSgoEShQlQEoUKJTE2WUKEIFZJKhCECBCEIAEIQgAQhCABCEIAFIcVCEAXFRT7RLQnqYAhCEgBCEIAEIQgAQhCABCEIAEIQgAQhCAJClCEFIFCEIGBUIQglghCECBCEIAEIQgAQhCABCEIAEIQgAQhCABCEIA//Z"
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Product Picture
This API is used to delete a Product Picture. It must be given a Product Picture ID to delete that specific Product Picture. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/products/pictures/pictureid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/products/pictures/pictureid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Product Stock
This API will insert or update Product Stocks related to a specific branch and related to the logged in user. It must be given a Product number to post for a specific Product Stock. It must be given two variables, variation1 and variation2. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| branchid | integer | Product Stock for a specific branch | Yes | |
| stock | integer | The stock quantity | Yes | |
| isactive | integer | If the Product Stock is an active Product Stock or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/product/:prodnum/:variation1/:variation2/stock?data={"branchid": 1, "stock":2, "isactive": 1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/product/:prodnum/:variation1/:variation2/stock?data={"branchid": 1, "stock":2, "isactive": 1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Product Stocks
This API will insert or update Product Stocks related to a specific branch and related to the logged in user. It must be given a Product number to post for a specific Product Stock. It must be given two variables, variation1 and variation2. It must be given a data json array that contains several Identifiers listed in the table bellow. This API can be given many branches to manipulate its product stocks. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| branchid | integer | Product Stock for a specific branch | Yes | |
| stock | integer | The stock quantity | Yes | |
| isactive | integer | If the Product Stock is an active Product Stock or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/product/:prodnum/:variation1/:variation2/stocks?data=[{"branchid": 1001, "stock":21, "isactive":1},{"branchid": 1, "stock":2, "isactive":1}]" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/product/:prodnum/:variation1/:variation2/stocks?data=[{"branchid": 1001, "stock":21, "isactive":1},{"branchid": 1, "stock":2, "isactive":1}]"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Product stock
This API is used to delete a Product Stock for a specific branch. It must be given a Product number and a Branch ID to delete that specific Product Stock. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/productstock/:prodnum/:branchid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/productstock/:prodnum/:branchid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Product Tag
This API is used to add or update a Product Tag. A Product contains several Tags. The API requires an Authentication token.
DELETE Product Tag
This API is used to delete a Product Tag. It must be given a Product Tag ID to delete that specific Product Tag. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/producttag/:producttagid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/producttag/:producttagid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Tag
This API is used to add or update a Tag. A Tag needs to be created to be assigned to a product. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| tagid | integer | The Tag ID | Yes | |
| descript | string | The Tag description / name | Yes | |
| isactive | integer | If the Tag is an active Tag or not | 1 active, 0 if exist delete | Default 1 |
DELETE Tag
This API is used to delete a Tag. It must be given a Tag ID to delete that specific Tag. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/tag/tagid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/tag/tagid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Question Group
This API is used to add or update a Question Group. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Question Group ID | Yes | |
| descript | string | The Question Group description / name | Yes | |
| conceptid | integer | The Question Group concept ID | No | |
| isactive | integer | If the Question Group is an active Question Group or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/questiongroups?data={"id": 1000,"descript": "food", "isactive":1, "conceptid": 1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/questiongroups?data={"id": 1000,"descript": "food", "isactive":1, "conceptid": 1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Question Group
This API is used to delete a Question Group. It must be given a Question Group ID to delete that specific Question Group. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/questiongroups/:questiongroupid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/questiongroups/:questiongroupid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Question Group Detail
This API is used to add or update a Question Group Detail. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| uniqueid | integer | The Question Group Detail ID | Yes | |
| questiongroupid | integer | The Question Group ID | Yes | |
| required | integer | If Question Header is required | No | |
| seq | integer | The Question Group sequence | Yes | |
| conseptid | integer | The Question Group concept ID | No | |
| isactive | integer | If the Question Group Detail is an active Question Group Detail or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/questiongroups/details?data={"uniqueid": 2010,"questiongroupid": "1010", "required":3010, "seq": 1, "conceptid": 1, "isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/jsoIf Question Header is required
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/questiongroups/details?data={"uniqueid": 2010,"questiongroupid": "1010", "required":3010, "seq": 1, "conceptid": 1, "isactive":1}"
If Question Header is required headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Question Group Detail
This API is used to delete a Question Group Detail. It must be given a Question Group Detail ID to delete that specific Question Group Detail. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/questiongroups/details/:questiongroup_detail_id" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/questiongroups/details/:questiongroup_detail_id"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Question header
This API is used to add or update a Question Header. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Question Header ID | Yes | |
| descript | string | The Question Header discription / name | Yes | |
| required | integer | If Question Header is required | No | |
| min | integer | The Question header min | No | |
| max | integer | The Question Header max | No | |
| conceptid | integer | The Question Header concept ID | No | |
| fontsize | integer | The Question Header font size | No | |
| cols | integer | The Question Header column | No | |
| searchable | integer | If Question Header is Searchable | (1 and 0) | No |
| backcolor | integer | The Question Header background color | No | |
| forecolor | integer | The Question Header forecolor | No | |
| enable_same_item_ordering | integer | If Question Header is enable on same item ordering | (1 and 0) | No |
| isactive | integer | If the Question Header is an active Question Header or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/questionheaders?data={"id": 3010,"descript": "headers", "isactive":1 , "required": 1, "min": 1, "max":10, "conceptid": 1, "fontsize": 12, "cols":2, "searchable":1, "backcolor":1, "forecolor":1, "enable_same_item_ordering": 1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/questionheaders?data={"id": 3010,"descript": "headers", "isactive":1 , "required": 1, "min": 1, "max":10, "conceptid": 1, "fontsize": 12, "cols":2, "searchable":1, "backcolor":1, "forecolor":1, "enable_same_item_ordering": 1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Question Header
This API is used to delete a Question Header. It must be given a Question Header ID to delete that specific Question Header. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/questionheaders/:questionheaderid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/questionheaders/:questionheaderid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Question Detail
This API is used to add or update a Question Detail. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Question Detail ID | Yes | |
| headerid | integer | The Question Header ID | Yes | |
| prodnum | integer | The modifier product number | Yes | |
| sequence_order | integer | The Question Detail sequence | Yes | |
| weight | double | The Question Detail weight | No | |
| isactive | integer | If the Question Detail is an active Question Detail or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/questiondetails?data={"id": 4010, "headerid": "3010", "prodnum":700, "sequence_order": 1, "weight": 10.1, "isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/questiondetails?data={"id": 4010, "headerid": "3010", "prodnum":700, "sequence_order": 1, "weight": 10.1, "isactive":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Question Detail
This API is used to delete a Question Detail. It must be given a Question Detail ID to delete that specific Question Detail. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/questiondetails/:questiondetailid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer {{token}}"
const url = new URL(
"https://posapis.com/api/v1/questiondetails/:questiondetailid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Modifier
This API is used to add or update a Modifier. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| prodnum | integer | The Modifier number / ID | Yes | |
| catid | integer | The category ID | Yes | |
| descript | string | The Modifier description | Yes | |
| descript2 | string | The second Modifier description | No | |
| prodinfo | string | The Modifier information | No | |
| prodinfo2 | string | The second Modifier information | No | |
| price | double | The Modifier price | Default 0 | |
| groupid | integer | The Modifier group ID | Default NULL | |
| enabled | integer | Enable Modifier | (1 and 0) | Default 1 |
| pid | integer | The Modifier pid | Default NULL | |
| brand | string | The Modifier brand name | No | |
| refcode1 | string | The Modifier reference number / barcode | Default NULL | |
| refcode2 | string | The second Modifier reference number / barcode | Default NULL | |
| istaxable1 | integer | The Modifier istaxable1 | (1 and 0) | Default NULL |
| istaxable2 | integer | The Modifier istaxable2 | (1 and 0) | Default NULL |
| istaxable3 | integer | The Modifier istaxable3 | (1 and 0) | Default NULL |
| ModifiersGroupID | integer | The Modifier modifiers group ID | Default 0 | |
| ComboGroupID | integer | The Modifier combo group ID | Default 0 | |
| isactive | integer | If the Modifier is an active Modifier or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/modifiers?data={"prodnum":595,"catid":66,"descript":"add Tomatos","prodinfo2":"","price":"5000","groupid":0,"enabled":"1","pid":"1","brand":"","refcode1":"2700152","refcode2":"","ModifiersGroupID":0,"istaxable1":"0","istaxable2":"0","istaxable3":"0", "isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/modifiers?data={"prodnum":595,"catid":66,"descript":"add Tomatos","prodinfo2":"","price":"5000","groupid":0,"enabled":"1","pid":"1","brand":"","refcode1":"2700152","refcode2":"","ModifiersGroupID":0,"istaxable1":"0","istaxable2":"0","istaxable3":"0", "isactive":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Modifier
This API is used to delete a Modifiers. It must be given a Modifiers ID (prodnum) to delete that specific Modifiers. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/modifier/modifier_prodnum" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/modifier/modifier_prodnum"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Combo Headers
This API is used to add or update a Combo Headers. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Combo Header ID | Yes | |
| descript | string | The Combo Header name / Description | Yes | |
| min | integer | The Combo Header minimum amount | No | |
| max | integer | The Combo Header maximum amount | No | |
| required | integer | If Combo Header is required | (1, 0) | Default 0 |
| autoselect | integer | If Combo Header is autoselect or not | (1, 0) | Default 0 |
| weight | double | The Combo Header weight | No | |
| ccols | integer | The Combo Header columns | No | |
| crows | integer | The Combo Header rows | No | |
| conceptid | integer | The Combo Header conceptid | No | |
| isactive | integer | If the Combo Header is an active Combo Header or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/combo/headers?data={"id":1001, "descript":"description", "isactive":1, "min":100, "max":100, "required":1, "autoselect":1, "weight":12.2, "ccols":1, "crows":1, "conceptid":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/combo/headers?data={"id":1001, "descript":"description", "isactive":1, "min":100, "max":100, "required":1, "autoselect":1, "weight":12.2, "ccols":1, "crows":1, "conceptid":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Combo Header
This API is used to delete a Combo Header. It must be given a Combo Header ID to delete that specific Combo Header. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/combo/header/comboheaderid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/combo/header/comboheaderid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Combo Details
This API is used to add or update a Combo Details. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Combo Detail ID | Yes | |
| comboid | integer | The Combo Header ID | Yes | |
| prodnum | integer | The Product Number (ID) | Yes | |
| seq | integer | The Combo Detail sequence | Yes | |
| price | double | The Combo Price | Yes | |
| isactive | integer | If the Combo detail is an active Combo detail or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/combo/details?data={"id":1002, "comboid":1001, "prodnum":3000, "seq":2, "price":8.2, "isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/combo/details?data={"id":1002, "comboid":1001, "prodnum":3000, "seq":2, "price":8.2, "isactive":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Combo Detail
This API is used to delete a Combo Detail. It must be given a Combo Detail ID to delete that specific Combo Detail. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/combo/detail/:combodetailid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/combo/detail/:combodetailid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Product Combo
This API is used to add or update a Product Combo. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Product Combo ID | Yes | |
| comboid | integer | The Combo Header ID | Yes | |
| prodnum | integer | The Product Number (ID) | Yes | |
| seq | integer | The Product Combo sequence | Yes | |
| isactive | integer | If the Product Combo is an active Product Combo or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/product/combos?data={"id":2001, "comboid":1001, "prodnum":3001, "seq":2, "isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/product/combos?data={"id":2001, "comboid":1001, "prodnum":3001, "seq":2, "isactive":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Product Combo
This API is used to delete a Product Combo. It must be given a Product Combo ID to delete that specific Product Combo. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/product/combo/:productcomboid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/product/combo/:productcomboid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Combo Item
This API is used to add or update a Combo Item. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| prodnum | integer | The Combo Item number / ID | Yes | |
| catid | integer | The category ID | Yes | |
| descript | string | The Combo Item description | Yes | |
| descript2 | string | The second Combo Item description | No | |
| prodinfo | string | The Combo Item information | No | |
| prodinfo2 | string | The second Combo Item information | No | |
| price | double | The Combo Item price | Default 0 | |
| groupid | integer | The Combo Item group ID | Default NULL | |
| enabled | integer | Enable Combo Item | (1 and 0) | Default 1 |
| pid | integer | The Combo Item pid | Default NULL | |
| brand | string | The Combo Item brand name | No | |
| refcode1 | string | The Combo Item reference number / barcode | Default NULL | |
| refcode2 | string | The second Combo Item reference number / barcode | Default NULL | |
| istaxable1 | integer | The Combo Item istaxable1 | (1 and 0) | Default NULL |
| istaxable2 | integer | The Combo Item istaxable2 | (1 and 0) | Default NULL |
| istaxable3 | integer | The Combo Item istaxable3 | (1 and 0) | Default NULL |
| ModifiersGroupID | integer | The Combo Item modifiers group ID | Default 0 | |
| ComboGroupID | integer | The Combo Item combo group ID | Default 0 | |
| isactive | integer | If the Combo Item is an active Combo Item or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/comboitems?data={"prodnum":3001,"catid":98,"descript":"modi","prodinfo2":"","price":"5000","groupid":0,"enabled":"1","pid":"1","brand":"","refcode1":"2700152","refcode2":"","ModifiersGroupID":0,"istaxable1":"0","istaxable2":"0","istaxable3":"0"}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/comboitems?data={"prodnum":3001,"catid":98,"descript":"modi","prodinfo2":"","price":"5000","groupid":0,"enabled":"1","pid":"1","brand":"","refcode1":"2700152","refcode2":"","ModifiersGroupID":0,"istaxable1":"0","istaxable2":"0","istaxable3":"0"}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Combo Item
This API is used to delete a Combo Item. It must be given a Combo Item ID to delete that specific Combo Item. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/comboitem/:comboitemid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/comboitem/:comboitemid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Region
This API is used to add or update a Region. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Region ID | Yes | |
| name | string | The Region Name | Yes | |
| countrycode | integer | The Region country code (ID) | No | |
| citycode | integer | The Region city code (ID) | No | |
| zipcode | integer | The Region Zip Code | No | |
| isactive | integer | If the Region is an active Region or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/regions?data={"id":1001,"name":"Maten", "countrycode": 1, "citycode": 2,"zipcode": 1212, "isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/regions?data={"id":1001,"name":"Maten", "countrycode": 1, "citycode": 2,"zipcode": 1212, "isactive":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Region
This API is used to delete a Region. It must be given a Region ID to delete that specific Region. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/region/:regionid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/region/:regionid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST City
This API is used to add or update a City. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The City ID | Yes | |
| name | string | The City Name | Yes | |
| phonecode | string | The City phone code | 04 | No |
| isactive | integer | If the City is an active City or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/cities?data={"id": 1001, "name": "Awkar", "phonecode": "04", "isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/cities?data={"id": 1001, "name": "Awkar", "phonecode": "04", "isactive":1}" \"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE City
This API is used to delete a City. It must be given a City ID to delete that specific City. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/city/:cityid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/city/:cityid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Country
This API is used to add or update a Country. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Country ID | Yes | |
| name | string | The Country Name | Yes | |
| phonecode | string | The Country phone code | +961 | No |
| phonelength | integer | The Country phone length | 8 | No |
| phonemask | string | The Country phone mask | ##-###### | No |
| smscodestart | string | The Country SMS code start | No | |
| isactive | integer | If the Country is an active Country or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/countries?data={"id":1001,"name":"Lebanon", "phonecode": "+961", "phonelength": 8,"phonemask": "00000-00-000000", "smscodestart":"Hello every one", "isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/countries?data={"id":1001,"name":"Lebanon", "phonecode": "+961", "phonelength": 8,"phonemask": "00000-00-000000", "smscodestart":"Hello every one", "isactive":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Country
This API is used to delete a Country. It must be given a Country ID to delete that specific Country. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/country/:countryid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/country/:countryid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Order Type
This API is used to add or update an Order Type. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
Example request:
curl --request POST \
"https://posapis.com/api/v1/ordertypes?data={"id":1000,"descript":"fast order", "groupid": 1, "seq":1, "menucode": 1, "remindscheduledbefore": 0,"enforcememberselection":0, "opendrawer":0, "printmemberdetails":0, "showindispatcher":0, "printinred":0, "autoaddproducts":0, "printmoreonprinter":0, "printcopies":2, "autotaginfo":0, "enableonlineordertracking":0, "isdelivery":0, "printtagontickets":0, "printtagonlabels":0, "showautoupsell":0, "printinvoiceongenerateso":0, "isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/ordertypes?data={"id":1000,"descript":"fast order", "groupid": 1, "seq":1, "menucode": 1, "remindscheduledbefore": 0,"enforcememberselection":0, "opendrawer":0, "printmemberdetails":0, "showindispatcher":0, "printinred":0, "autoaddproducts":0, "printmoreonprinter":0, "printcopies":2, "autotaginfo":0, "enableonlineordertracking":0, "isdelivery":0, "printtagontickets":0, "printtagonlabels":0, "showautoupsell":0, "printinvoiceongenerateso":0, "isactive":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Order Type
This API is used to delete a Order Type. It must be given a Order Type ID to delete that specific Order Type. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/ordertype/:ordertypeid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/ordertype/:ordertypeid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Temp Detail
This API is used to insert/update/delete TempDetail. It must be given a Unique ID and Rest ID to modify that specific Temp Detail. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| UNIQUEID | integer | The ID of the TempDetail | Yes | |
| RESTID | string | The Restaurant Id | Yes | |
| ISACTIVE | integer | If the Temp Detail is active or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/tempdetail" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}"
-d '
[
{
"UNIQUEID": 126,
"TEMPTRANSACT": 452,
"QUAN": 12.34,
"PRODNUM": 789,
"STATION": 1,
"USERID": 1001,
"TIM": "2023-11-08 10:30:00",
"PRINTED": 1,
"PRICE": 45.6789,
"TAXEX": 12.3456,
"TAX": 7.8901,
"TAX2": 3.4567,
"TAX3": 2.3456,
"TABLNUM": 5,
"TYPE": 2,
"DESCRIPT": "Sample Description",
"MANUALDESCRIPT": 0,
"LPRODNUM": 987,
"TAXSYMB": "ABC",
"SEATNUM": 10,
"TIMCLOSED": "2023-11-08 18:45:00",
"DISCOUNT": 0,
"SEATDESCRIPT_OLD": "Old Seat Description",
"POINTS": 50,
"ORDERSEQ": 3,
"SPRODNUM": 101,
"WHOAUTH": 1002,
"ITEMTYPE": 4,
"PRICETYPE": 1,
"AVGCOST": 23.4567,
"LASTCOST": 22.3456,
"MEMCODE": 456,
"ADDRESSID": 789,
"CONTACTID": 1003,
"PDASTATION": 2,
"ITEMTAG": "X",
"HOLDPRINT": "Long text for HOLDPRINT field",
"DISCPER": 10,
"DISCVALUE": 5.6789,
"UNITPRICE": 34.5678,
"HEADERDISCPER": 8.9012,
"EXPIRATION": 90,
"PACKING": 7,
"WEIGHT": 20,
"PLDID": 120,
"SERIALNUM": "ABC123XYZ",
"WAR": 1004,
"SkuID1": 201,
"SkuID2": 202,
"LOYALTYID": 1005,
"FORBRANCHID": 3001,
"ISSCHEDULED": true,
"TOBEDEL": "2023-11-09 12:00:00",
"REMIND": "2023-11-09 09:00:00",
"DOREMIND": "Some long text for DOREMIND",
"TALLINKID": 4001,
"ORDERTYPE": 2,
"RESTID": "ABC123456",
"OPENDATE": 20231108
},
{
"UNIQUEID": 124,
"TEMPTRANSACT": 456,
"QUAN": 12.34,
"PRODNUM": 789,
"STATION": 1,
"USERID": 1001,
"TIM": "2023-11-08 10:30:00",
"PRINTED": 1,
"PRICE": 45.6789,
"TAXEX": 12.3456,
"TAX": 7.8901,
"TAX2": 3.4567,
"TAX3": 2.3456,
"TABLNUM": 5,
"TYPE": 2,
"DESCRIPT": "Sample Description",
"MANUALDESCRIPT": 0,
"LPRODNUM": 987,
"TAXSYMB": "ABC",
"SEATNUM": 10,
"TIMCLOSED": "2023-11-08 18:45:00",
"DISCOUNT": 0,
"SEATDESCRIPT_OLD": "Old Seat Description",
"POINTS": 50,
"ORDERSEQ": 3,
"SPRODNUM": 101,
"WHOAUTH": 1002,
"ITEMTYPE": 4,
"PRICETYPE": 1,
"AVGCOST": 23.4567,
"LASTCOST": 22.3456,
"MEMCODE": 456,
"ADDRESSID": 789,
"CONTACTID": 1003,
"PDASTATION": 2,
"ITEMTAG": "X",
"HOLDPRINT": "Long text for HOLDPRINT field",
"DISCPER": 10,
"DISCVALUE": 5.6789,
"UNITPRICE": 34.5678,
"HEADERDISCPER": 8.9012,
"EXPIRATION": 90,
"PACKING": 7,
"WEIGHT": 20,
"PLDID": 120,
"SERIALNUM": "ABC123XYZ",
"WAR": 1004,
"SkuID1": 201,
"SkuID2": 202,
"LOYALTYID": 1005,
"FORBRANCHID": 3001,
"ISSCHEDULED": true,
"TOBEDEL": "2023-11-09 12:00:00",
"REMIND": "2023-11-09 09:00:00",
"DOREMIND": "Some long text for DOREMIND",
"TALLINKID": 4001,
"ORDERTYPE": 2,
"RESTID": "ABC123456",
"OPENDATE": 20231108
}
]',
const url = new URL(
"https://posapis.com/api/v1/tempdetail"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
const body = {
[
{
"UNIQUEID": 126,
"TEMPTRANSACT": 452,
"QUAN": 12.34,
"PRODNUM": 789,
"STATION": 1,
"USERID": 1001,
"TIM": "2023-11-08 10:30:00",
"PRINTED": 1,
"PRICE": 45.6789,
"TAXEX": 12.3456,
"TAX": 7.8901,
"TAX2": 3.4567,
"TAX3": 2.3456,
"TABLNUM": 5,
"TYPE": 2,
"DESCRIPT": "Sample Description",
"MANUALDESCRIPT": 0,
"LPRODNUM": 987,
"TAXSYMB": "ABC",
"SEATNUM": 10,
"TIMCLOSED": "2023-11-08 18:45:00",
"DISCOUNT": 0,
"SEATDESCRIPT_OLD": "Old Seat Description",
"POINTS": 50,
"ORDERSEQ": 3,
"SPRODNUM": 101,
"WHOAUTH": 1002,
"ITEMTYPE": 4,
"PRICETYPE": 1,
"AVGCOST": 23.4567,
"LASTCOST": 22.3456,
"MEMCODE": 456,
"ADDRESSID": 789,
"CONTACTID": 1003,
"PDASTATION": 2,
"ITEMTAG": "X",
"HOLDPRINT": "Long text for HOLDPRINT field",
"DISCPER": 10,
"DISCVALUE": 5.6789,
"UNITPRICE": 34.5678,
"HEADERDISCPER": 8.9012,
"EXPIRATION": 90,
"PACKING": 7,
"WEIGHT": 20,
"PLDID": 120,
"SERIALNUM": "ABC123XYZ",
"WAR": 1004,
"SkuID1": 201,
"SkuID2": 202,
"LOYALTYID": 1005,
"FORBRANCHID": 3001,
"ISSCHEDULED": true,
"TOBEDEL": "2023-11-09 12:00:00",
"REMIND": "2023-11-09 09:00:00",
"DOREMIND": "Some long text for DOREMIND",
"TALLINKID": 4001,
"ORDERTYPE": 2,
"RESTID": "ABC123456",
"OPENDATE": 20231108
},
{
"UNIQUEID": 124,
"TEMPTRANSACT": 456,
"QUAN": 12.34,
"PRODNUM": 789,
"STATION": 1,
"USERID": 1001,
"TIM": "2023-11-08 10:30:00",
"PRINTED": 1,
"PRICE": 45.6789,
"TAXEX": 12.3456,
"TAX": 7.8901,
"TAX2": 3.4567,
"TAX3": 2.3456,
"TABLNUM": 5,
"TYPE": 2,
"DESCRIPT": "Sample Description",
"MANUALDESCRIPT": 0,
"LPRODNUM": 987,
"TAXSYMB": "ABC",
"SEATNUM": 10,
"TIMCLOSED": "2023-11-08 18:45:00",
"DISCOUNT": 0,
"SEATDESCRIPT_OLD": "Old Seat Description",
"POINTS": 50,
"ORDERSEQ": 3,
"SPRODNUM": 101,
"WHOAUTH": 1002,
"ITEMTYPE": 4,
"PRICETYPE": 1,
"AVGCOST": 23.4567,
"LASTCOST": 22.3456,
"MEMCODE": 456,
"ADDRESSID": 789,
"CONTACTID": 1003,
"PDASTATION": 2,
"ITEMTAG": "X",
"HOLDPRINT": "Long text for HOLDPRINT field",
"DISCPER": 10,
"DISCVALUE": 5.6789,
"UNITPRICE": 34.5678,
"HEADERDISCPER": 8.9012,
"EXPIRATION": 90,
"PACKING": 7,
"WEIGHT": 20,
"PLDID": 120,
"SERIALNUM": "ABC123XYZ",
"WAR": 1004,
"SkuID1": 201,
"SkuID2": 202,
"LOYALTYID": 1005,
"FORBRANCHID": 3001,
"ISSCHEDULED": true,
"TOBEDEL": "2023-11-09 12:00:00",
"REMIND": "2023-11-09 09:00:00",
"DOREMIND": "Some long text for DOREMIND",
"TALLINKID": 4001,
"ORDERTYPE": 2,
"RESTID": "ABC123456",
"OPENDATE": 20231108
}
]
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Order Type Charge
This API is used to add or update an Order Type Charge. This API must be given an Order Type ID and a Charge ID as path variables. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Order Type Charge ID | Yes | |
| sdate | integer | The Order Type Charge start date | 20220620 | No |
| edate | integer | The Order Type Charge end date | 20220630 | No |
| setamount | double | The Order Type Charge amount | 100.00 | No |
| byamount | integer | Set Order Type Charge By Amount | (1 - 0) | No |
| bypercent | integer | Set Order Type Charge By Percent | (1 - 0) | No |
| openpercent | integer | Set Order Type Charge Open Percent | (1 - 0) | No |
| openamount | integer | Set Order Type Charge Open Amount | (1 - 0) | No |
| typ | integer | The Order Type Charge Type | No | |
| customschedule | integer | The Order Type Charge customer schedule date | 20220625 | No |
| autoadd | integer | Set Order Type Charge auto add | (1 - 0) | No |
| appliedontaxex | integer | Set Order Type Charge applied on tax | (1 - 0) | No |
| isactive | integer | If the Order Type Charge is an active Order Type Charge or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/ordertype/:ordertypeid/:chargeid?data={"id":1000,"sdate":2, "edate":1, "setamount":5.5, "isactive":1, "byamount":0, "bypercent":0, "openpercent":0, "openamount":0, "typ":0, "customschedule":1, "autoadd":1, "appliedontaxex":0}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/ordertype/:ordertypeid/:chargeid?data={"id":1000,"sdate":2, "edate":1, "setamount":5.5, "isactive":1, "byamount":0, "bypercent":0, "openpercent":0, "openamount":0, "typ":0, "customschedule":1, "autoadd":1, "appliedontaxex":0}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Order Type Charge
This API is used to delete a Order Type Charge. It must be given a Order Type Charge ID to delete that specific Order Type Charge. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/ordertypecharge/:ordertypechargeid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/ordertypecharge/:ordertypechargeid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Order Type Charge By Branch
This API is used to add or update an Order Type Charge By Branch. This API must be given an Order Type ID, a Charge ID and a Branch ID as path variables. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Order Type Charge ID | Yes | |
| sdate | integer | The Order Type Charge start date | 20220620 | No |
| edate | integer | The Order Type Charge end date | 20220630 | No |
| setamount | double | The Order Type Charge amount | 100.00 | No |
| byamount | integer | Set Order Type Charge By Amount | (1 - 0) | No |
| bypercent | integer | Set Order Type Charge By Percent | (1 - 0) | No |
| openpercent | integer | Set Order Type Charge Open Percent | (1 - 0) | No |
| openamount | integer | Set Order Type Charge Open Amount | (1 - 0) | No |
| typ | integer | The Order Type Charge Type | No | |
| customschedule | integer | The Order Type Charge customer schedule date | 20220625 | No |
| autoadd | integer | Set Order Type Charge auto add | (1 - 0) | No |
| appliedontaxex | integer | Set Order Type Charge applied on tax | (1 - 0) | No |
| isactive | integer | If the Order Type Charge is an active Order Type Charge or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/ordertype/:ordertypeid/:chargeid/:branchid?data={"id": 1000, "sdate":2, "edate":1, "setamount":5.5, "isactive":1, "byamount":0, "bypercent":0, "openpercent":0, "openamount":0, "typ":0, "customschedule":1, "autoadd":1, "appliedontaxex":0}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/ordertype/:ordertypeid/:chargeid/:branchid?data={"id": 1000, "sdate":2, "edate":1, "setamount":5.5, "isactive":1, "byamount":0, "bypercent":0, "openpercent":0, "openamount":0, "typ":0, "customschedule":1, "autoadd":1, "appliedontaxex":0}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Order Type Charge By Branch
This API is used to delete a Order Type Charge By Branch. It must be given a Order Type Charge Branch ID to delete that specific Order Type Charge By Branch. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/ordertypechargebranch/:ordertypechargebranchid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/ordertypechargebranch/:ordertypechargebranchid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Order Type Charge Branch By region
This API is used to add or update an Order Type Charge Branch By Region. This API must be given an Order Type ID, a Charge ID, a Branch ID, and Region ID as path variables. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Order Type Charge ID | Yes | |
| sdate | integer | The Order Type Charge start date | 20220620 | No |
| edate | integer | The Order Type Charge end date | 20220630 | No |
| setamount | double | The Order Type Charge amount | 100.00 | No |
| byamount | integer | Set Order Type Charge By Amount | (1 - 0) | No |
| bypercent | integer | Set Order Type Charge By Percent | (1 - 0) | No |
| openpercent | integer | Set Order Type Charge Open Percent | (1 - 0) | No |
| openamount | integer | Set Order Type Charge Open Amount | (1 - 0) | No |
| typ | integer | The Order Type Charge Type | No | |
| customschedule | integer | The Order Type Charge customer schedule date | 20220625 | No |
| autoadd | integer | Set Order Type Charge auto add | (1 - 0) | No |
| appliedontaxex | integer | Set Order Type Charge applied on tax | (1 - 0) | No |
| isactive | integer | If the Order Type Charge is an active Order Type Charge or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/ordertype/:ordertypeid/:chargeid/:branchid/:regionid?data={"id":1000,"sdate":11022020, "edate":11022020, "setamount":5.5, "isactive":1, "byamount":0, "bypercent":0, "openpercent":0, "openamount":0, "typ":0, "customschedule":1, "autoadd":1, "appliedontaxex":0}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/ordertype/:ordertypeid/:chargeid/:branchid/:regionid?data={"id":1000,"sdate":11022020, "edate":11022020, "setamount":5.5, "isactive":1, "byamount":0, "bypercent":0, "openpercent":0, "openamount":0, "typ":0, "customschedule":1, "autoadd":1, "appliedontaxex":0}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Order Type Charge Branch By Region
This API is used to delete a Order Type Charge Branch By Region. It must be given a Order Type Charge Branch Region ID to delete that specific Order Type Charge Branch By Region. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/ordertypechargebranchregion/:ordertypechargebranchregionid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/ordertypechargebranchregion/:ordertypechargebranchregionid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
PUT Order Status
This API is used to update an Order Status. This API must be given an Order ID as path variables. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| success | Boolean | If Order is successfull | true, false | Yes |
| branchid | integer | The Order Branch ID | Yes | |
| message | string | The Order Status message | The Order was recieved | No |
| postransact | integer | The POS order transaction number | Yes | |
| status | integer | The Order Status | Check status table bellow | Yes |
| posmemberreference | integer | The POS order member ID | Yes | |
| posaddressreference | integer | The POS prder address ID | Yes |
| Status ID | Status Description |
|---|---|
| 0 | Pending |
| 1 | Order Saved/Received by posapis.com |
| 2 | Order Received by Restaurant |
| 3 | Order Invoiced |
| 4 | Delivering |
| 5 | Delivered |
| 6 | Pending Accept |
| 7 | Ordered Prepared and Ready for Delivery/Pickup |
| 10 | Order Finalized, no Tracking info available |
| 11 | Order Cancelled |
Example request:
curl --request PUT \
"https://posapis.com/api/v1/orders/:orderid/status?data={"success":true,"branchid":1,"message":"Order%20Pending","postransact":26872,"status":1,"posmemberreference":1050103,"posaddressreference":1000047}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/orders/:orderid/status?data={"success":true,"branchid":1,"message":"Order%20Pending","postransact":26872,"status":1,"posmemberreference":1050103,"posaddressreference":1000047}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Branch
This API is used to add or update a Branch. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Branch ID | Yes | |
| clientid | string | The Branch 6 character client ID | Yes | |
| name | string | The Branch name | Yes | |
| address | string | The Branch address | No | |
| phone | string | The Branch phone number | No | |
| string | The Branch email address | No | ||
| openinghours | string | The Branch opening hours | From 6:00Am Till 12:00Am | No |
| longitude | double | The Branch map longitude | No | |
| latitude | double | The Branch map latitude | No | |
| acceptsdelivery | integer | If Branch accepts delivery | (1 - 0) | No |
| acceptstakeaway | integer | If Branch accepts take away | (1 - 0) | No |
| isactive | integer | If the Branch is an active Branch or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/branches?data={ "id": 1,"clientid": "SHO111","name": "Antelyes","address":"", "phone":"04789654","email": "qw@hotmail.com", "openinghours": "", "longitude":9.5698, "latitude":9.5231, "isactive":1, "acceptsdelivery":1, "acceptstakeaway":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/branches?data={ "id": 1,"clientid": "SHO111","name": "Antelyes","address":"", "phone":"04789654","email": "qw@hotmail.com", "openinghours": "", "longitude":9.5698, "latitude":9.5231, "isactive":1, "acceptsdelivery":1, "acceptstakeaway":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Branch
This API is used to delete a Branch. It must be given a Branch ID to delete that specific Branch. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/branch/:branchid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/branch/:branchid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Branch Regions
This API is used to add or update a Branch Region. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Branch Region ID | Yes | |
| name | string | The Branch Region name | No | |
| deliverycharge | string | The Branch Region delivery charge amount | No | |
| isactive | integer | If the Branch Region is an active or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/branchesregions/:branchid/:regionid?data={"id":1000,"name": "anyname", "deliverycharge": 3, "isactive":0}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/branchesregions/:branchid/:regionid?data={"id":1000,"name": "anyname", "deliverycharge": 3, "isactive":0}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Branch Region
This API is used to delete a Branch Region. It must be given a Branch Region ID to delete that specific Branch Region. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/branchregion/:branchregionid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/branchregion/:branchregionid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Branch Charge
This API is used to update an Branch Charge. This API must be given an Branch ID as path variables. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Charge ID | Yes | |
| descript | string | The Charge description / name | No | |
| sdate | integer | The Charge start date | 20220620 | No |
| edate | integer | The Charge end date | 20220630 | No |
| setamount | double | The Charge amount | 100.00 | No |
| tax1 | integer | The Charge first tax | No | |
| tax2 | integer | The Charge second tax | No | |
| byamount | integer | Set Charge By Amount | (1 - 0) | No |
| bypercent | integer | Set Charge By Percent | (1 - 0) | No |
| openpercent | integer | Set Charge Open Percent | (1 - 0) | No |
| openamount | integer | Set Charge Open Amount | (1 - 0) | No |
| typ | integer | The Charge Type | No | |
| customschedule | integer | The Charge customer schedule date | 20220625 | No |
| autoadd | integer | Set Charge auto add | (1 - 0) | No |
| appliedontaxex | integer | Set Charge applied on tax | (1 - 0) | No |
| isactive | integer | If the Charge is an active Charge or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/charges/:branchid?data={"id": "1002", "descript":"any%3A+%0description", "sdate": 1, "edate": 2, "setamount": 2.5 ,"tax1":1, "tax2":0, "tax3":0, "isactive":1, "byamount":0, "bypercent":0, "openpercent":0, "openamount":0, "typ":0, "customschedule":1, "autoadd":1, "appliedontaxex":0, "isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/charges/:branchid?data={"id": "1002", "descript":"any%3A+%0description", "sdate": 1, "edate": 2, "setamount": 2.5 ,"tax1":1, "tax2":0, "tax3":0, "isactive":1, "byamount":0, "bypercent":0, "openpercent":0, "openamount":0, "typ":0, "customschedule":1, "autoadd":1, "appliedontaxex":0, "isactive":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Branch charge
This API is used to delete a Charge. It must be given a Charge ID to delete that specific Charge. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/charge/:chargeid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/charge/:chargeid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Charge Detail
This API is used to update an Branch Charge. This API must be given a Charge ID, a Branch ID, and a Region ID as path variables. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Charge Detail ID | Yes | |
| sectionid | integer | The Charge Charge Detail section ID | No | |
| isactive | integer | If the Charge is an active Charge or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/chargedetails/:chargeid/:branchid/:regionid?data={"id":1000,"sectionid":2, "isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/chargedetails/:chargeid/:branchid/:regionid?data={"id":1000,"sectionid":2, "isactive":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Charge Detail
This API is used to delete a Charge Detail. It must be given a Charge Detail ID to delete that specific Charge Detail. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/chargedetail/:chargedetailid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/chargedetail/:chargedetailid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Gallery
This API is used to update a Gallery. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Gallery ID | Yes | |
| name | string | The Gallery name | Yes | |
| isactive | integer | If the Gallery is an active Gallery or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/galleries?data={"id":1000, "name":"Cakes", "isactive": 1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/galleries?data={"id":1000, "name":"Cakes", "isactive": 1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Gallery
This API is used to delete a Gallery. It must be given a Gallery ID to delete that specific Gallery. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/gallery/:galleryid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/gallery/:galleryid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Gallery Photo
This API is used to insert or update a Gallery Photo. This API must be given a Gallery ID as path variables. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Gallery Photo ID | Yes | |
| title | string | The Gallery Photo title | Yes | |
| descript | string | The Gallery Photo description | Yes | |
| refnum | string | The Gallery Photo reference number | Yes | |
| minorderqty | integer | The Gallery Photo minimum order quantity | Yes | |
| price | double | The Gallery Photo price | Yes | |
| isactive | integer | If the Gallery Photo is an active Gallery Photo or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/gallery/photos/:galleryphotoid?data={ "id": 1000, "title": "yumy cake", "descript": "chocolate", "refnum": "EAS123", "minorderqty":1, "price":150000.00, "isactive":1 }" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/gallery/photos/:galleryphotoid?data={ "id": 1000, "title": "yumy cake", "descript": "chocolate", "refnum": "EAS123", "minorderqty":1, "price":150000.00, "isactive":1 }"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Gallery Photo
This API is used to delete a Gallery Photo. It must be given a Gallery Photo ID to delete that specific Gallery Photo. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/gallery/photo/:galleyphotoid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/gallery/photo/:galleyphotoid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Department
This API is used to insert or update a Department. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Department ID | Yes | |
| name | string | The Department name | Yes | |
| string | The Department email | Yes | ||
| mobile | string | The Department phone number | Yes | |
| isactive | integer | If the Department is an active Department or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/departments?data={"id":1001, "name":"dev", "email": "dev@store.com", "mobile": "04111111", "isactive": 1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/departments?data={"id":1001, "name":"dev", "email": "dev@store.com", "mobile": "04111111", "isactive": 1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Department
This API is used to delete a Department. It must be given a Department ID to delete that specific Department. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/department/:departmentid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/department/:departmentid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST FeedBack
This API is used to insert or update a FeddBack. This API must be given a Department ID as path variables. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The FeedBack ID | Yes | |
| mobile | string | The FeedBack MOBILE number | Yes | |
| msg | string | The FeedBack name | Yes | |
| type | integer | The FeedBack Type | Yes | |
| isactive | integer | If the Department is an active Department or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/feedbacks/:departmentid?data={"id":1001, "mobile":"04111111", "msg": "hello, world !", "type": 1, "isactive": 1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/feedbacks/:departmentid?data={"id":1001, "mobile":"04111111", "msg": "hello, world !", "type": 1, "isactive": 1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE FeedBack
This API is used to delete a FeedBack. It must be given a FeedBack ID to delete that specific FeedBack. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/feedback/:feedbackid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/feedback/:feedbackid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Web Content
This API is used to insert or update a Web Content. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The Web Content ID | Yes | |
| page_title | string | The Web Content page title | Yes | |
| page_url | string | The Web Content page URL link | Yes | |
| isactive | integer | If the Web Content is an active Web Content or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/contents?data={"id":1000, "page_title":"About Us", "page_url":"https://woodenbakery.com/aboutus.html", "isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/contents?data={"id":1000, "page_title":"About Us", "page_url":"https://woodenbakery.com/aboutus.html", "isactive":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Web Content
This API is used to delete a Web Content. It must be given a Web Content ID to delete that specific Web Content. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/content/:contentid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/content/:contentid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST App Setting
This API is used to insert or update an App Setting. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| id | integer | The App Setting ID | Yes | |
| currency | string | The App Setting currency | LBP | No |
| showRemarksOnQuestions | integer | Show App Setting remarks on question | (1 - 0) | No |
| showRemarksOnAllItems | integer | Show App Setting remark on all items | (1 - 0) | No |
| mobilePrefix | stirng | The App Setting mobile prifix | 03 | No |
| androidMaintenanceMode | integer | The App Setting android maintenance mode | No | |
| androidMinVersion | string | The App Setting android minimum version | 1.0.0 | No |
| androidCurVersion | string | The App Setting current version | 1.0.0 | No |
| iosMinVersion | string | The App Setting IOS minimu version | 1.0.0 | No |
| iosCurVersion | string | The App Setting IOS current version | 1.0.0 | No |
| moneyFormat | string | The App Setting money format | No | |
| phoneMask | string | The App Setting phone mask | No | |
| showBigCategory | integer | Show App Setting big category | No | |
| orderMenuCatalogId | integer | The App Setting order menu catalog ID | No | |
| galleryCatalogId | integer | The App Setting gallery catalog ID | No | |
| productCatalogId | integer | The App Setting product catalog ID | No | |
| isactive | integer | If the App Setting is an active App Setting or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/app/settings?data={"androidMinVersion":1000,"currency":"LBP","showRemarksOnQuestions":1,"showRemarksOnAllItems":1,"mobilePrefix":"03","androidMaintenanceMode":0,"androidMinVersion":"1.0.0","androidCurVersion":"1.0.1","iosMinVersion":"1.0.0","iosCurVersion":"1.0.1","moneyFormat":"%23%23/%23%23","phoneMask":"(%23%23)-(%23%23%23%23%23%23)","showBigCategory":1,"orderMenuCatalogId":1,"galleryCatalogId":1,"productCatalogId":1,"isactive":1}##/##","phoneMask":"(##)-(######)","showBigCategory":1,"orderMenuCatalogId":1000,"galleryCatalogId":1000,"productCatalogId":1000,"isactive":1}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/app/settings?data={"id":1000,"currency":"LBP","showRemarksOnQuestions":1,"showRemarksOnAllItems":1,"mobilePrefix":"03","androidMaintenanceMode":0,"androidMinVersion":"1.0.0","androidCurVersion":"1.0.1","iosMinVersion":"1.0.0","iosCurVersion":"1.0.1","moneyFormat":"%23%23/%23%23","phoneMask":"(%23%23)-(%23%23%23%23%23%23)","showBigCategory":1,"orderMenuCatalogId":1,"galleryCatalogId":1,"productCatalogId":1,"isactive":1}##/##","phoneMask":"(##)-(######)","showBigCategory":1,"orderMenuCatalogId":1000,"galleryCatalogId":1000,"productCatalogId":1000,"isactive":1}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE App Setting
This API is used to delete a App Setting. It must be given a App Setting ID to delete that specific App Setting. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/app/setting/:appsettingid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/app/setting/:appsettingid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
POST Branch Setting
This API is used to insert or update an Branch Setting. This API must be given a Branch ID as path variables. It must be given a data json that contains several Identifiers listed in the table bellow. The API requires an Authentication token.
| Identifier | Value Type | description | Value(s) Examples | Required |
|---|---|---|---|---|
| settingkey | string | The Branch Setting ID | Yes | |
| stringvalue | string | The Branch Setting string value | No | |
| numvalue | integer | The Branch Setting numeric value | No | |
| boolvalue | boolean | The Branch Setting boolean value | No | |
| doublevalue | double | The Branch Setting double (decimal) value | No | |
| isactive | integer | If the Branch Setting is an active Branch Setting or not | 1 active, 0 if exist delete | Default 1 |
Example request:
curl --request POST \
"https://posapis.com/api/v1/branch/:branchid/settings?data={"settingkey":"ACCTMASK","stringvalue":"%23%2F%23%2F%23%2F%23%2F%23%2F%23%23%23%2F%23","numvalue":0,"boolvalue":"0","doublevalue":"0"}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/branch/:branchid/settings?data={"settingkey":"ACCTMASK","stringvalue":"%23%2F%23%2F%23%2F%23%2F%23%2F%23%23%23%2F%23","numvalue":0,"boolvalue":"0","doublevalue":"0"}"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());
Received response:
Request failed with error:
DELETE Branch Setting
This API is used to delete a Branch Setting. It must be given a Branch Setting ID to delete that specific Branch Setting. The API requires an Authentication token.
Example request:
curl --request DELETE \
"https://posapis.com/api/v1/branch/:branchid/setting/:settingid" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization": "Bearer {{token}}",
const url = new URL(
"https://posapis.com/api/v1/branch/:branchid/setting/:settingid"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {{token}}",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());
Received response:
Request failed with error: