Praxis Wiki logo

API Methods GetCustomer Required

This method is invoked only if you want the Cashier to PULL the customer information from your Platform. This can occur after login or if the customer information appears incomplete or invalid.


Variable Type Description
PIN varchar(50) Required. Unique customer id in your system
SiteID int Optional: only used if you need to identify a brand or company to which this customer belongs.
FrontEndName varchar(256) Required. Cashier front end name, normally common name of the website. Linked to a specific base currency.


Variable Type Description
status int Required.
- 0 if the request was successful
- Negative integer if internal server/network error occurs
- Positive integer if application/logical error occurs
description varchar(256) Required. Accurate description of the result. Return the actual error for any exception as it helps to diagnose issues in production
PIN varchar(50) Required. Unique customer id in your platform
CustName varchar(50) Full customer name, can be split in two fields first and last name
Currency varchar(3) Required. Customer’s base currency
Street varchar(100) Street address of the customer
City varchar(50) City of the customer
Province varchar(2) State/Province where the customer resides. Only for US, CA and AU. 2 characters ISO format. Otherwise leave blank.
PCode varchar(12) Postal Code of the customer. Only required for US and CA. Can provide values for other countries. Limited to 12 alphanumeric characters only.
Country varchar(2) ISO 3166-1 alpha-2 (US, MT, IT, GB, DE, etc)
Phone varchar(20) Numeric only, includes country area code. Should not be a dummy sequence like 123456 or 111111, should be at least 6 digits long.
Email varchar50) Customer’s email
DOB date Date of birth of the customer. MM/DD/YYYY format accepted.
Gender char(1) M or F (male or female)
Profile int(1) Profile level of the customer (0 to 5)
IP_Address char(15) IP Address of the customer



curl -X POST \ \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR",

Response (OK)

    "description":"customer found", 
    "CustName":"John Doe", 
    "Street":"123 boulevard", 
    "Email":"[email protected]", 

Response (ERR)

{"Status":1, "Description":"User not found"}

You are currently viewing version 2.24b Latest API version here