Developers



  • General
    • Pagination
    • Searching and Ordering
  • Product
    • Introduction
    • Category
    • Product
    • Product Composition
    • Brand
    • Popup Note
    • Tax Rate
    • Multiple Choice Note
    • Multiple Choice Option
    • Multiple Choice Product
    • Multiple Choice Product Group
    • Multiple Choice Product Group Item
    • Product Location Area Price
  • Customer
    • Introduction
    • Customer
    • Customer Address
    • Customer Type
    • Customer Rating
    • Customer Credit
    • Customer Points
  • Booking
    • Introduction
    • Booking
    • Booking Customer
    • Booking Item
  • Stock Control
    • Introduction
    • Product Stock
    • Stock Transfer
    • Stock Transfer Item
    • Stock Transfer Reason
    • Purchase Order
    • Purchase Order Item
    • Supplier
    • Location
    • Location Area
  • Transaction
    • Introduction
    • Transaction
    • Transaction Item
    • Tender
    • Tender Type
    • Base Item
    • Preparation Status
    • Transaction Details
    • Discount Reason
    • Complete Transaction
    • Seating Area
    • Seating Table
  • Staff
    • Introduction
    • Staff
    • AccessRight
    • Clocking
    • ClockingType
  • Reports
    • End Of Day Report
    • Daily Sales Report
    • Bookkeeping Report
  • Other
    • Device
    • End Of Day
Developers
  • Home
  • Setup
  • Documentation
    • V2
    • V4
  • Examples
  • Support
  • Search

Introduction to Creating a Customer

This page will detail the entire process of creating a complete customer entry using the API. The other pages in this section further detail the available API requests for each attribute. Not all attributes are required to create a customer (see below), but this guide will assume that the customer being created has all attributes.

In this example, a customer and its attributes will be created in the following order:
  1. Type
  2. Customer *
  3. Address
  4. Credit †
  5. Rating
  6. Points †

* Required
† Not required to create a customer. Creates a Transaction that increases, or decreases if negative, the customer's credit or points by the given amount.

Address, Credit, Rating and Points can be created in any order after the Customer is created. To be efficient, Type should be the first attribute created, followed by Customer as the second. This ordering is due to Type being assigned to a Customer by the TypeID, and Address, Credit, Rating and Points all require a CustomerID.


Step 1: Creating a Customer Type

The first step in creating a Customer is to create the Type of the Customer. This is only required once, for each unique Type, and does not need to be re-created for each Customer.

Documentation on how to create new customer type can be found here.


Step 2: Creating a Customer

The second step is to create the Customer; this requires the Type ID from the previous step.

Note: A Customer account can be linked to multiple addresses, via the Customer Address controller. Assigning a Main Address to a Customer serves only to highlight the fact that it is the Customer's primary address.

Documentation on how to create new customer can be found here.


Step 3: Creating an Address

The third step in creating a Customer is to create the Customer's Address.

Documentation on how to create new customer address can be found here.


Step 4: Adding Customer Credit

The fourth step in creating a customer account is to add Credit to the account.

Documentation on how to add credit to the customer account can be found here.


Step 6: Adding Loyalty Points

The final step in creating a Customer account is to add Loyalty Points to the account.

Documentation on how to add point to the customer account can be found here.


EposNow
About Us
Contact Us
Documentation
API V2
API V4
Example Apps
Specials Board






© 2025 - Epos Now Ltd, Developers