BeepXtra API
The API accepts REST requests using the following methods:
GET
POST
PUT
DELETE
HEAD
e.g. if the request is GET /card/9 it will automatically return the card details in JSON format for processing
Configuration
appid : YOURAPPID
(You will receive this from out integrations department)
appkey : YOURAPPKEY (You will receive this from out integrations department)
format : json
referer: e.g. 'myePOS' (insert a unique referer. This will be used to identify your application requests for debugging purposes)
cookie : e.g. 'myePOS' (insert a unique cookie name. recommended to use the same as referer for consistency. Also for debugging purposes)
Available Requests
card Controller
owner
Get Card Owner
Accepts Card_No or email
PHP SDK Request:
$beepapi->request('get', 'card', 'owner/1');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|card" -X GET [Link]
REST Direct URL:
[Link]
balance
Get Card Balance
Accepts Card_no | email
PHP SDK Request:
$beepapi->request('get', 'card', 'balance/0000000000000009');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|card" -X GET [Link]
REST Direct URL:
[Link]
cashback
Post multiproduct cashback
multiproduct/simple | outlet_id-cashier_id | card number |
productid_priceeach_discountpercentage_quantity | receipt no ~ Returns True | error message
PHP SDK Request:
$beepapi->request('post', 'card', 'cashback/multiproduct/39154270/90000000000000064/1_0.50_2.5_3:2_0.25_5.0_1:3_1_10.5_1:4_1_10.5_1/receipt123');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|card" -X POST [Link]
REST Direct URL:
[Link]
Lib Controller
api
Get the access permissions for your app_id
PHP SDK Request:
$beepapi->request('get', 'lib', 'api');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|lib" -X GET [Link]
REST Direct URL:
[Link]
platform Controller
rates
Get All Exchange Rates
PHP SDK Request:
$beepapi->request('get', 'platform', 'rates');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET [Link]
REST Direct URL:
[Link]
Get Exchange Rates for specific currency
PHP SDK Request:
$beepapi->request('get', 'platform', 'rates/cyp');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET [Link]
REST Direct URL:
[Link]
categories
Get Sub Category Details
Accepts Parent Category ID
PHP SDK Request:
$beepapi->request('get', 'platform', 'categories/112160');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET [Link]
REST Direct URL:
[Link]
currencies
Get all country currencies
PHP SDK Request:
$beepapi->request('get', 'platform', 'currencies');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET [Link]
REST Direct URL:
[Link]
Get a currency by country id
PHP SDK Request:
$beepapi->request('get', 'platform', 'currencies/3');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET [Link]
REST Direct URL:
[Link]
countries
Get all Countries
PHP SDK Request:
$beepapi->request('get', 'platform', 'countries');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET [Link]
REST Direct URL:
[Link]
Get a country by id
PHP SDK Request:
$beepapi->request('get', 'platform', 'countries/3');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET [Link]
REST Direct URL:
[Link]
Get countries by Continent
Accepts africa | asia | europe | north america | oceania | south america
PHP SDK Request:
$beepapi->request('get', 'platform', 'countries/europe');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET [Link]
REST Direct URL:
[Link]
category
Get Category Details
Accepts Category ID
PHP SDK Request:
$beepapi->request('get', 'platform', 'category/-1');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|platform" -X GET [Link]
REST Direct URL:
[Link]
Product Controller
details
Get Product Details
Accepts product ID
PHP SDK Request:
$beepapi->request('get', 'product', 'details/1');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X GET [Link]
REST Direct URL:
[Link]
outlet
Get Outlet Products
Accepts outlet ID
PHP SDK Request:
$beepapi->request('get', 'product', 'outlet/391');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X GET [Link]
REST Direct URL:
[Link]
store
Get Store Products
Accepts Store ID
PHP SDK Request:
$beepapi->request('get', 'product', 'store/829');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X GET [Link]
REST Direct URL:
[Link]
category
Get Category Products
Accepts Category ID
PHP SDK Request:
$beepapi->request('get', 'product', 'category/3470');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X GET [Link]
REST Direct URL:
[Link]
add
Add a new product (Non-existent) to an outlet
accepts parameters as follows:
add/OUTLET_ID/BARCODE:PRODUCT_NAME:PRODUCT_DESCRIPTION:IMAGE:PRICE:DISCOUNT:QUANTITY:REORDER_LEVE
L:DELIVERY_TYPE:WEIGHT:SHIPPING_COST:AVAILABILITY:PROMO_PRICE:PROMO_START_DATE:PROMO_END_DATE:CAT
_ID
PHP SDK Request:
$beepapi->request('post', 'product', 'add/391/12345678:dog shoes:doggy shoes, size 53:image:100.05:2.[Link]pickup:0:1:1:0:0:0:77664');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X POST [Link] shoes:doggy shoes, size
53:image:100.05:2.[Link]pickup:0:1:1:0:0:0:77664
REST Direct URL:
[Link] shoes:doggy shoes, size 53:image:100.05:2.[Link]pickup:0:1:1:0:0:0:77664
use
Add an existing product to an outlet
accepts parameters as follows:
use/OUTLET_ID/PRODUCT_ID:BARCODE:PRODUCT_NAME:PRODUCT_DESCRIPTION:IMAGE:PRICE:DISCOUNT:QUANTITY:R
EORDER_LEVEL:DELIVERY_TYPE:WEIGHT:SHIPPING_COST:AVAILABILITY:PROMO_PRICE:PROMO_START_DATE:PROMO_E
ND_DATE:CAT_ID
PHP SDK Request:
$beepapi->request('post', 'product', 'use/391/3:12345678:dog shoes:doggy shoes, size 53:image:100.05:2.[Link]pickup:0:1:1:0:0:0:77664');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X POST [Link] shoes:doggy shoes,
size 53:image:100.05:2.[Link]pickup:0:1:1:0:0:0:77664
REST Direct URL:
[Link] shoes:doggy shoes, size 53:image:100.05:2.[Link]pickup:0:1:1:0:0:0:77664
change
Update a product for a specific outlet
accepts parameters as follows:
change/OUTLET_ID/PRODUCT_ID:PRODUCT_NAME:PRODUCT_DESCRIPTION:IMAGE:PRICE:DISCOUNT:QUANTITY:REORDE
R_LEVEL:DELIVERY_TYPE:WEIGHT:SHIPPING_COST:AVAILABILITY:PROMO_PRICE:PROMO_START_DATE:PROMO_END_DA
TE
PHP SDK Request:
$beepapi->request('put', 'product', 'change/391/12:dog shoes:doggy shoes:[Link].25:2.[Link]pickup:0:1:1:0:0:0');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X PUT [Link] shoes:doggy
shoes:[Link].25:2.[Link]pickup:0:1:1:0:0:0
REST Direct URL:
[Link] shoes:doggy shoes:[Link].25:2.[Link]pickup:0:1:1:0:0:0
outlet
Delete a product from an outlet
Accepts numeric outlet ID and product ID
PHP SDK Request:
$beepapi->request('delete', 'product', 'outlet/391/product/3');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|product" -X DELETE [Link]
REST Direct URL:
[Link]
Report Controller
users
Get number of registered users
PHP SDK Request:
$beepapi->request('get', 'report', 'users/registered');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|report" -X GET [Link]
REST Direct URL:
[Link]
Get number of Inactive users
PHP SDK Request:
$beepapi->request('get', 'report', 'users/inactive');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|report" -X GET [Link]
REST Direct URL:
[Link]
Get number of Active Invites
PHP SDK Request:
$beepapi->request('get', 'report', 'users/invites');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|report" -X GET [Link]
REST Direct URL:
[Link]
Get number of users by country
PHP SDK Request:
$beepapi->request('get', 'report', 'users/usersbycountry');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|report" -X GET [Link]
REST Direct URL:
[Link]
Get number of users Registered This Month
PHP SDK Request:
$beepapi->request('get', 'report', 'users/thismonth');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|report" -X GET [Link]
REST Direct URL:
[Link]
Staff Controller
outlet
Get store or outlet active employees
Accepts store/ID or outlet/ID
PHP SDK Request:
$beepapi->request('get', 'staff', 'outlet/391');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET [Link]
REST Direct URL:
[Link]
managed
Get outlets managed by User ID
Accepts user ID
PHP SDK Request:
$beepapi->request('get', 'staff', 'managed/54270');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET [Link]
REST Direct URL:
[Link]
outlet
Order the results
accepts order-name-asc, order-surname-desc, order-type-asc, order-started-asc
PHP SDK Request:
$beepapi->request('get', 'staff', 'outlet/391/order-default-desc');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET [Link]
REST Direct URL:
[Link]
Paginate the results
Self Explanatory
PHP SDK Request:
$beepapi->request('get', 'staff', 'outlet/391/limit-0-1');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET [Link]
REST Direct URL:
[Link]
Order and Paginate Combination usage
Accepts all ordering types of the returned fields in ASC or DESC commands
PHP SDK Request:
$beepapi->request('get', 'staff', 'outlet/391/limit-0-2/order-default-asc');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET [Link]
REST Direct URL:
[Link]
employee
Get outlets the employee has access to
//Accepts user_id or email
PHP SDK Request:
$beepapi->request('get', 'staff', 'employee/123');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET [Link]
REST Direct URL:
[Link]
Get Employee Permissions for Specific Outlet
Accepts ID or Email for employee
PHP SDK Request:
$beepapi->request('get', 'staff', 'employee/54397/permissions/391');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X GET [Link]
REST Direct URL:
[Link]
OUTLETID
Add new employee to outlet/store
accepts parameters as follows: OUTLET_ID/USER_EMAIL_OR_ID/USER_TYPE
PHP SDK Request:
$beepapi->request('post', 'staff', '391/aaaaa@[Link]/3');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X POST [Link]
REST Direct URL:
[Link]
Update an existing employee position
accepts parameters as follows: OUTLET_ID/USER_EMAIL_OR_ID/USER_TYPE
PHP SDK Request:
$beepapi->request('put', 'staff', '391/aaaaa@[Link]/3');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X PUT [Link]
REST Direct URL:
[Link]
Remove an existing employee position
accepts parameters as follows: OUTLET_ID/USER_EMAIL_OR_ID/USER_TYPE (All must match)
PHP SDK Request:
$beepapi->request('delete', 'staff', '391/aaaaa@[Link]/3');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|staff" -X DELETE [Link]
REST Direct URL:
[Link]
Store Controller
authenticate
authenticate employee login
accepts parameters as follows: authenticate/OUTLET_ID/USER_EMAIL/USER_PASSWORD it will return the
user details if successful or error
PHP SDK Request:
$beepapi->request('get', 'store', 'authenticate/391/aaaaa@[Link]/12345678');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|store" -X GET [Link]
REST Direct URL:
[Link]
user Controller
Get user details
Accepts id | email
PHP SDK Request:
$beepapi->request('get', 'user', '13');
CURL Request:
CURL -A "YOURUSERAGENT|1.0|YOURAPPID|YOURAPPKEY|user" -X GET [Link]
REST Direct URL:
[Link]
