POS Namespace
The pos namespace contains the resource to manage the pos with the following methods Method Endpoint Scope Description.
Operation | Method | Endpoint | Scope | Sample | Description |
Create POS | Post | pos | POS | Sample | Create POS |
Create POS User | Post | pos/user/pos_id | POS | Sample | Create POS User |
Create Custom Field | Post | pos/custom_field/pos_id | POS | Sample | Create Custom Field |
Activate POS | Put | pos/pos_id | POS | Sample | Activate POS |
Update POS | Put | pos/pos_id | POS | Sample | Update POS |
Update POS User | Put | pos/user/pos_id | POS | Sample | Update POS User |
Update POS Configuration | Put | pos/config/pos_id | POS | Sample | Update POS Configuration |
Update POS Location | Put | pos/location/pos_id | POS | Sample | Update POS Location |
Get POS | Get | pos/pos_id | POS | Sample | Get POS |
Get POS User | Get | pos/user/pos_id | POS | Sample | Get POS User |
Get POS Configuration | Get | pos/config/pos_id | POS | Sample | Get POS Configuration |
Get POS History | Get | pos/history/pos_id | POS | Sample | Get POS History |
Get POS Latest History | Get | pos/history/latest/pos_id | POS | Sample | Get POS Latest History |
POS Inquiry | Get | pos/inquiry | POS | Sample | POS Inquiry |
POS Forget PIN Code | Post | pos/security/reset/pos_user_id | POS | Sample | POS Forget PIN Code |
POS Reset PIN Code | Post | pos/user/security/reset/pos_user_id | POS | Sample | POS Reset PIN Code |
POS Reset Password | Post | pos/security/reset/pos_id | POS | Sample | POS Reset Password |
User Security Reset | Post | pos/user/security/reset/pos_user_id | POS | Sample | User Security Reset |
User Security Verify | Post | pos/user/security/verify/pos_id | POS | Sample | User Security Verify |
Delete POS User | Delete | pos/user/pos_id | POS | Sample | Delete POS User |
Delete POS | Delete | pos/pos_id | POS | Sample | Delete POS |
- POS Namespace Objects
- POS User Namespace Objects
- Reset POS Security Namespace Objects
- Query Parameters
Data Object
Field Name | Field Type | Regular Expression | Sample | Field Status | |||
POST | PUT | GET | DELETE | ||||
pos_data | |||||||
info Security Type: None |
Object | None | R | O | NA | NA | |
pos_user Security Type: None |
Object | None | R | NA | NA | NA | |
address Security Type: None |
Object | None | O | O | NA | NA | |
location Security Type: None |
Object | None | O | O | NA | NA | |
device_info Security Type: None |
Object | None | O | O | NA | NA | |
configuration Security Type: None |
Object | None | O | O | NA | NA | |
picture Security Type: None |
Object | None | O | O | NA | NA | |
geo_coordinates Security Type: None |
Object | None | O | O | NA | NA | |
review Security Type: None |
Object | None | O | O | NA | NA | |
notes Security Type: None |
Object | None | O | O | O | O | |
last_activity Security Type: None |
Object | None | NA | NA | NA | NA | |
validate Security Type: None |
String | ^[0-1]{1,1}$ | 1, 0 | O | O | NA | NA |
classification Security Type: None |
Object | None | O | O | O | O | |
landmark Security Type: None |
Object | None | O | O | O | O | |
history Security Type: None |
Object | None | O | O | O | O | |
custom_field Security Type: None |
Object | None | O | O | O | O | |
account_info Security Type: None |
Object | None | O | O | O | O | |
authentication Security Type: None |
Object | None | O | O | O | O | |
info | |||||||
id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | R | R | R |
program_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | R | O | NA | NA |
user_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | R | R | NA | NA |
status Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | C | C | NA | NA |
server_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | NA | NA | NA |
date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | NA | NA | NA |
original_source_id Security Type: None |
String | ^[a-zA-Z0-9]{1,100} | 2Feb2015000001 | NA | NA | NA | NA |
source_time_zone Security Type: None |
String | ^((?:UTC [+|-](?:2[0-3]|[01][0-9]):[0-5][0-9])){1,10}$ | UTC -06:00, UTC +02:30 | NA | NA | NA | NA |
update_date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | NA | NA | NA |
activation_date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | NA | NA | NA |
local_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | O | O | NA | NA |
name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | R | O | NA | NA |
type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | R | O | NA | NA |
verification_status Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | C | C | NA | NA |
working_hour Security Type: None |
Object | None | O | O | NA | NA | |
pos_user_admin_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
info | |||||||
id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
supplied_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
program_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
bin_id Security Type: None |
String | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
user_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
nick_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
type Security Type: None |
String | ^[0-9]{1,3}$ | 900 | O | O | O | O |
number Security Type: Masked |
String | ^[0-9]{11,19}$ | 5389820000000000, 3333330000000000000 | O | O | O | O |
currency Security Type: None |
String | ^[0-9a-zA-Z]{3,3}$ | USD, CAD, EUR, GBP | O | O | O | O |
status Security Type: None |
String | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
balance Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | O | O | O | O |
available_balance Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | O | O | O | O |
activation_date_time Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | O | O | O | O |
replace_account Security Type: None |
String | ^[0-9]{11,19}$ | 5389820000000000, 3333330000000000000 | O | O | O | O |
original_source_id Security Type: None |
String | ^[a-zA-Z0-9]{1,100} | 2Feb2015000001 | O | O | O | O |
server_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | O | O | O | O |
date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | O | O | O | O |
source_time_zone Security Type: None |
String | ^((?:UTC [+|-](?:2[0-3]|[01][0-9]):[0-5][0-9])){1,10}$ | UTC -06:00, UTC +02:30 | O | O | O | O |
security Security Type: None |
Object | None | O | O | O | O | |
address | |||||||
id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | R |
type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | R | O | NA | NA |
is_primary Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | NA | O | NA | NA |
is_billing Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | R | O | NA | NA |
address_line1 Security Type: None |
String | ^$|(^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$) | Abc00, fʁɑ̃s123 | O | O | NA | NA |
address_line2 Security Type: None |
String | ^$|(^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$) | Abc00, fʁɑ̃s123 | O | O | NA | NA |
postal_zip_code Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{1,20}$ | Abc00, fʁɑ̃s123 | O | O | NA | NA |
state_region Security Type: None |
String | ^$|(^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$) | Abc00, fʁɑ̃s123 | O | O | NA | NA |
city_town Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,500}$ | Abc00, fʁɑ̃s123 | O | O | NA | NA |
country_code Security Type: None |
String | ^[0-9]{1,3}$ | 900 | R | O | NA | NA |
status Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | C | C | NA | NA |
custom_field Security Type: None |
Object | None | O | NA | NA | NA | |
verification_status Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | C | C | NA | NA |
original_source_id Security Type: None |
String | ^[a-zA-Z0-9]{1,100} | 2Feb2015000001 | NA | NA | NA | NA |
server_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | NA | NA | NA |
date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | NA | NA | NA |
update_date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | NA | NA | NA |
location | |||||||
id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | R |
type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | R | O | NA | NA |
privacy_type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | O | O | NA | NA |
show_on_map Security Type: None |
String | ^[0-1]{1,1}$ | 1, 0 | O | O | NA | NA |
user_description Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | O | O | NA | NA |
user_localized_description Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | O | O | NA | NA |
google_map_description Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | O | O | NA | NA |
geo_coordinates Security Type: None |
Object | None | O | O | NA | NA | |
country Security Type: None |
Object | None | R | O | NA | NA | |
state_province Security Type: None |
Object | None | O | O | NA | NA | |
city Security Type: None |
Object | None | O | O | NA | NA | |
area Security Type: None |
Object | None | O | O | NA | NA | |
region Security Type: None |
Object | None | O | O | O | O | |
location_info | |||||||
server_date Security Type: None |
String | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | O | O |
datetime_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | O | O |
source_ip Security Type: None |
String | None | O | O | O | O | |
latitude Security Type: None |
String | None | O | O | O | O | |
longitude Security Type: None |
String | None | O | O | O | O | |
description Security Type: None |
String | None | O | O | O | O | |
server_date Security Type: None |
String | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | O | O |
datetime_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | O | O |
source_ip Security Type: None |
String | None | O | O | O | O | |
latitude Security Type: None |
String | None | O | O | O | O | |
longitude Security Type: None |
String | None | O | O | O | O | |
description Security Type: None |
String | None | O | O | O | O | |
configuration | |||||||
disable_wap_login Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | NA | NA |
allowed_pin_code_trials Security Type: None |
Integer | ^[0-9]{1,9}$ | 900000000 | O | O | NA | NA |
allow_electronic_delivery Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | NA | NA |
allow_pincode_display Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | NA | NA |
max_print_count Security Type: None |
Integer | ^[0-9]{1,9}$ | 900000000 | O | O | NA | NA |
enable_reversal_options Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | NA | NA |
disallow_reversal_refund Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | NA | NA |
disable_pincode_security_option Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | NA | NA |
disable_application_automatic_update Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | NA | NA |
max_allowed_bulk_order_count_per_item Security Type: None |
Integer | ^[0-9]{1,9}$ | 900000000 | O | O | O | O |
enable_bulk_order_export Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
enable_online_orders Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
allowed_number_of_print_export_operations Security Type: None |
Integer | ^[0-9]{1,9}$ | 900000000 | O | O | O | O |
excluded_categories Security Type: None |
String | (^\d+(,\d+)*$)|(^$) | 10,20,304455 | O | O | O | O |
excluded_products Security Type: None |
String | (^\d+(,\d+)*$)|(^$) | 10,20,304455 | O | O | O | O |
excluded_variants Security Type: None |
String | (^\d+(,\d+)*$)|(^$) | 10,20,304455 | O | O | O | O |
encryption_type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | O | O | O | O |
stock_selection_priority Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | O | O | O | O |
allow_database_export Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
enable_transaction_tracking Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
force_database_export_on_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | O | O |
unlock_admin_user_pin_on_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | O | O |
reset_admin_user_pin_on_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | O | O |
disable_sending_transfers Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
disable_receiving_transfers Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
vat_number Security Type: None |
String | None | O | O | O | O | |
force_location_tracking Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
use_program_default_configuration Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
price_printing_options Security Type: None |
Integer | ^[0-9]{1,25}$ | 90000000000000 | O | O | O | O |
is_price_printing_options_enabled Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
session_time_out Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,255}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
enable_reports Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
enable_local_device_report Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
enable_local_device_order_reprint_report Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
enable_online_transaction_report Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
enable_online_order_report Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
enable_recon Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
recon_auto_schedule Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | O | O | O | O |
recon_max_records Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | O | O | O | O |
disable_online_transaction Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
enable_offline_bulk_orders Security Type: None |
Integer | ^[0-1]{1,1}$ | 1, 0 | O | O | O | O |
recon_from_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | O | O |
recon_to_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | O | O |
action_to_date Security Type: None |
String | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | O | O |
picture | |||||||
id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
extension Security Type: None |
String | ^.*\.(ZIP|zip|7Z|7z|GZ|gz|GZIP|gzip|RAR|rar|PDF|pdf|DOC|doc|DOCX|docx|GIF|gif|JPG|jpg|PNG|png|ODT|odt|ODG|odg|TXT|txt|JPRG|jpeg|TIFF|tiff|TIF|tif|BMP|bmp|PPM|ppm|PGM|pgm|PBM|pbm|BPG|bpg)$ | .DOC | O | O | O | O |
url Security Type: None |
String | ^(true|false)$ | true, false | O | O | O | O |
size Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
content Security Type: Wiped |
String | ^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$ | ejJlQUVFSFpCcUpjVDNlWW5WcEd0QQ== | O | O | O | O |
geo_coordinates | |||||||
latitude Security Type: None |
String | ^(-?(?:1[0-7]|[1-9])?\d(?:\.\d{1,24})?|180(?:\.0{1,24})?)$ | 37.42242 | O | O | NA | NA |
longitude Security Type: None |
String | ^(-?(?:1[0-7]|[1-9])?\d(?:\.\d{1,24})?|180(?:\.0{1,24})?)$ | 37.42242 | O | O | NA | NA |
position_description Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,255}$ | Abc00, fʁɑ̃s123 | O | O | NA | NA |
review | |||||||
id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | R | R | R |
average_rate Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
weighted_rate Security Type: None |
Decimal | ^[-]?[0-9]{1,7}(?:\.\d{1,2})?$ | 50.24 | NA | NA | NA | NA |
total_reviews Security Type: None |
Integer | ^[0-9]{1,6}$ | 900000 | NA | NA | NA | NA |
update_datetime_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
notes | |||||||
user_notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,255}$) | Abc000000 | O | O | O | O |
admin_notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,255}$) | Abc000000 | O | O | O | O |
last_activity | |||||||
entity Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | O | NA | NA |
entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | O | NA | NA |
activity_type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | O | NA | NA |
notes Security Type: None |
Object | None | NA | O | NA | NA | |
update_date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | O | NA | NA |
entity_data Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | O | O | O | O |
classification | |||||||
mcc Security Type: None |
String | None | O | O | O | O | |
sic Security Type: None |
String | None | O | O | O | O | |
revenue_class Security Type: None |
String | None | O | O | O | O | |
emp_class Security Type: None |
String | None | O | O | O | O | |
channel_type Security Type: None |
String | None | O | O | O | O | |
custom Security Type: None |
String | None | O | O | O | O | |
landmark | |||||||
id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | R | O | NA | NA |
type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | NA | O | NA | NA |
description Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | NA | O | NA | NA |
localized_description Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | NA | NA | NA | NA |
geo_coordinates Security Type: None |
Object | None | NA | NA | NA | NA | |
history | |||||||
id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
activity_type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
entity Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
by_entity Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
by_entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
entity_data Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | O | O | O | O |
json Security Type: None |
String |
(?(DEFINE)
(? |
{ "Object": [ { "property1": "value1", "property2": "value2" } ] } | O | O | O | O |
notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | O | O | O | O |
admin_notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,500}$) | Abc000000 | O | O | O | O |
original_source_id Security Type: None |
String | ^[a-zA-Z0-9]{1,100} | 2Feb2015000001 | O | O | O | O |
server_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | O | O | O | O |
date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | O | O | O | O |
Old_Data Security Type: None |
String | None | O | O | O | O | |
New_Data Security Type: None |
String | None | O | O | O | O | |
authentication | |||||||
type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
code Security Type: Encrypted |
String | ^[ A-Za-z0-9_.\/#=&+-]*$ | UN7C-KKT98L-4HAU | O | O | O | O |
POS User Object
Field Name | Field Type | Regular Expression | Sample | Field Status | |||
POST | PUT | GET | DELETE | ||||
pos_user_data | |||||||
info Security Type: None |
Object | None | O | O | NA | R | |
Configuration_JSON Security Type: None |
String | None | O | O | NA | NA | |
security Security Type: None |
Object | None | R | O | NA | NA | |
contact Security Type: None |
Object | None | R | O | NA | NA | |
edit_mode Security Type: -1 |
Boolean | O | O | O | O | ||
info | |||||||
id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | R | NA | R |
program_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
user_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
server_date Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
expiry_date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | O | O | NA | NA |
update_date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | NA | NA | NA | NA |
activation_date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]){1,22}$ | 2012-11-03T13:00:59 (yyyy-mm-ddThh:mm:ss) | NA | NA | NA | NA |
source_time_zone Security Type: None |
String | ^[0-9]{1,10}$ | 5000000 | NA | NA | NA | NA |
status Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | C | C | NA | NA |
verification_status Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | C | C | NA | O |
update_activity_type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | NA | NA | NA | NA |
supported_pos Security Type: None |
String | (^\d+(,\d+)*$)|(^$) | 10,20,304455 | O | O | O | O |
security | |||||||
role Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | R | O | NA | NA |
user_name Security Type: None |
String | ^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,100}$ | Abc000000 | R | O | NA | NA |
password Security Type: Wiped |
String | ^(?!.*--)[^\^+=<>|\n\r\b\t]{6,255}$ | hello1 | O | OP | NA | NA |
pin_code Security Type: Wiped |
String | ^[0-9]{4,6}$ | 123456 | NA | OP | NA | NA |
contact | |||||||
title Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | R | O | NA | NA |
first_name Security Type: None |
String | ^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,100}$ | Abc000000 | R | O | NA | NA |
last_name Security Type: None |
String | ^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,100}$ | Abc000000 | R | O | NA | NA |
job_title Security Type: None |
String | ^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,100}$ | Abc000000 | R | O | NA | NA |
email Security Type: None |
Object | None | R | O | NA | NA | |
phone Security Type: None |
Object | None | R | O | NA | NA | |
reset_pos_security | |||||||
info Security Type: None |
Object | None | R | NA | NA | NA | |
reset_security_data Security Type: None |
Object | None | R | NA | NA | NA | |
geo_coordinates Security Type: None |
Object | None | O | O | NA | NA | |
notes Security Type: None |
Object | None | O | O | O | O | |
last_activity Security Type: None |
Object | None | NA | O | NA | NA | |
validate Security Type: None |
String | ^[0-1]{1,1}$ | 1, 0 | O | NA | NA | NA |
authentication Security Type: None |
Object | None | O | O | O | O |
Reset POS Security Data Object
Field Name | Field Type | Regular Expression | Sample | Field Status | |||
POST | PUT | GET | DELETE | ||||
reset_security_data | |||||||
reset_password Security Type: None |
Object | None | O | O | O | O | |
reset_pin_code Security Type: None |
Object | None | O | O | O | O | |
forget_pin_code Security Type: None |
Object | None | O | O | O | O | |
geo_coordinates | |||||||
latitude Security Type: None |
String | ^(-?(?:1[0-7]|[1-9])?\d(?:\.\d{1,24})?|180(?:\.0{1,24})?)$ | 37.42242 | O | O | O | O |
longitude Security Type: None |
String | ^(-?(?:1[0-7]|[1-9])?\d(?:\.\d{1,24})?|180(?:\.0{1,24})?)$ | 37.42242 | O | O | O | O |
position_description Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\^+=<>|\n\r\b\t]{0,255}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
notes | |||||||
user_notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,255}$) | Abc000000 | O | O | O | O |
admin_notes Security Type: None |
String | ^$|(^(?!.*--)[?-?a-zA-Z0-9][^\^+=<>|\n\r\b\t]{0,255}$) | Abc000000 | O | O | O | O |
last_activity | |||||||
entity_data Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | O | O | O | O |
entity Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
entity_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
activity_type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
notes Security Type: None |
Object | None | O | O | O | O | |
update_date_utc Security Type: None |
Date | ^(19|20)\d{2}-(0[1-9]|1[0-2])-(0[1-9]|1\d|2\d|3[01]){1,22}$ | 1992-01-12 (yyyy-mm-dd) | O | O | O | O |
authentication | |||||||
type Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | O | O | O | O |
code Security Type: Encrypted |
String | ^[ A-Za-z0-9_.\/#=&+-]*$ | UN7C-KKT98L-4HAU | O | O | O | O |
POS Query Parameters
Field Name | Field Type | Regular Expression | Sample | Field Status | |||
POST | PUT | GET | DELETE | ||||
pos_inquiry | |||||||
start_index Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
page_size Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
from_date Security Type: None |
String | ^([0-9]{4})[\/|-]((0[1-9])|(1[0-2]))[\/|-]((0[1-9])|(1[0-9])|(2[0-9])|(3[0-1]))$ | 2006-06-12, 2006/06/12 (yyyy-mm-dd or yyyy/mm/dd) | NA | NA | O | NA |
to_date Security Type: None |
String | ^([0-9]{4})[\/|-]((0[1-9])|(1[0-2]))[\/|-]((0[1-9])|(1[0-9])|(2[0-9])|(3[0-1]))$ | 2006-06-12, 2006/06/12 (yyyy-mm-dd or yyyy/mm/dd) | NA | NA | O | NA |
pos_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
program_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
user_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
admin_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | NA | NA | O | NA |
pos_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | NA | NA | O | NA |
status Security Type: None |
Integer | ^(-1|[0-9]{1,2})$ | 10,3,-1 | NA | NA | O | NA |
type Security Type: None |
Integer | ^[0-9]{1,1}$ | 0-9 | NA | NA | O | NA |
account_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
pos_user_id Security Type: None |
Integer | ^[0-9]{1,10}$ | 5000000 | O | O | O | O |
email Security Type: None |
String | ^(?!.*--)([\w-+\.]{1,80})@([\w-+\.]{1,80})\.([a-zA-Z]{1,20})$ | John.Smith@example.com | O | O | O | O |
phone_number Security Type: None |
String | ^[+]([1-9])\d{7,14}$ | +15180000000 | O | O | O | O |
country_code Security Type: None |
Integer | ^[0-9]{1,3}$ | 900 | O | O | O | O |
city_name Security Type: None |
String | ^(?!.*--)[\p{L}\p{N}][^\\\/*$%^+=<>|\n\r\b\t]{0,49}$ | Abc00, fʁɑ̃s123 | O | O | O | O |
Create POS
Create POS
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Create POS User
Create POS User
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Create Custom Field
Create Custom Field
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Activate POS
Activate POS
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Update POS
Update POS
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Update POS User
Update POS User
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Update POS Configuration
Update POS Configuration
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Update POS Location
Update POS Location
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Get POS
Get POS
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Get POS User
Get POS User
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Get POS Configuration
Get POS Configuration
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Get POS History
Get POS History
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Get POS Latest History
Get POS Latest History
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
POS Inquiry
POS Inquiry
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
POS Forget PIN Code
POS Forget PIN Code
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
POS Reset PIN Code
POS Reset PIN Code
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
POS Reset Password
POS Reset Password
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
User Security Reset
User Security Reset
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
User Security Verify
User Security Verify
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Delete POS User
Delete POS User
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|
Delete POS
Delete POS
Configuration Header: |
|
Configuration Query Parameters: |
|
Request Parameters: |
|
Response Parameters: |
|