Customer Lookup

Background

In the Ka-ching POS, a customer can be added to a sale. Doing this allows for some interesting functionality.

First and foremost, the customer id will be available on the exported sale data, so that you may register these details in your own system.

Secondly, if your system contains information about the customer address, phone, email, etc., this can be used for pre-filling shipping details for e-commerce orders, and pre-filling email address for the receipt.

Thirdly, you can create discount campaign rules that only trigger when a customer is added to the basket, so this can be used to create customer discounts.

Options for the configuration

Like all of our 'runtime integrations', the actual endpoints and parameters for a http request can be configured in our system.

Similarly, the returned response can be transformed in Ka-ching before being passed to the client (Ka-ching POS).

This means that wether you prefer a GET request with query parameters or a POST request with a JSON body containing the parameters is less important.

But of course the integration becomes easier if the response already matches what our client expects, because then we can skip a transformation step.

Request parameters

search_term

currency_code

The search_term is the string that is entered when performing the customer lookup in POS. Based on what the receiving system can do, you may consider this to be a search string for filtering by any or all properties in your customer database. For instance it is common to return matches on customer id, name, phone number, email or even address - this is basically up to you. You may also, for instance, consider it to be a lookup of a single customer by a customer id.

The currency code of the active shop in POS may be passed along too - in case your system can report customer account balances in multiple currencies.

Response

The response will in the end be transformed to a list of Customer representations.

Please have a look at the Customer entity model for more information.