POS API Reference
HomeSimpra POSSimpra InventoryCheck&Place
HomeSimpra POSSimpra InventoryCheck&Place
  1. Customers
  • Introduction
  • Overview
  • External API Action Scenarios
  • Checks
    • Get Checks
    • Add Discount to Check
    • Get Check
    • Add Payment to Check
    • Add Portal Plus Invoice Id to Check
    • Add Service Charge to Check
    • Add Service Message To Check
    • Cancel Check Item
    • Change Delivery Status
    • Create Check Item
    • Create Check
    • Remove Check Discount
    • Remove Check Service Charge
    • Unlock Check
    • Get Check Activities
    • Add Note to Check
  • Menu Items
    • Get Menu Items
    • Get Menu Item
    • Create Menu Items
    • Update Menu Items
    • Upsert Menu Items
    • Remove Menu Item Report Tags
  • Menu Item Definitions
    • Get Menu Item Definitions
  • Menu Item Groups
    • Get Menu Item Groups
  • Item Definitions
    • Get Item Definitions
    • Update Item Definitions
  • Condiments
    • Get Condiments
  • Condiment Groups
    • Get Condiment Groups
  • ComboMenus
    • Get ComboMenus
  • Custom Menu Items
    • Get Custom Menu Items
  • Customers
    • Get Customers
      GET
    • Add Customer
      POST
    • Update Customer
      PATCH
  • CustomerDiscounts
    • Get CustomerDiscounts
  • Employees
    • Get Employees
  • Properties
    • Get Properties
  • Accounting API
    • Get Enterprise
    • Get Property
    • Get Enterprises
    • Get Payment
    • Get Payments
    • Get Future Payments
    • Get Dealers
  • Cash Trackings
    • Get Cash Trackings
  • Currencies
    • Get Currencies
  • Current Accounts
    • Get Current Accounts
  • Daily Totals
    • Get Daily Totals
  • Devices
    • Get Devices
  • Discounts
    • Get Discounts
  • Imports
    • Get Imports
  • Opera Checks
    • Index
    • Mark As Sent Opera Pms Check
  • Payment Types
    • Get Payment Types
  • Price Lists
    • Get Price Lists
    • Get Price List
    • Create Price List
    • Create Price List with Sku
    • Update Price List
    • Delete Price List
    • Update Price List Items
    • Delete Price List Items
    • Update Price List Items with Sku
    • Delete Price List Items with Sku
  • Reason Payments
    • Get Reason Payments
  • Reasons
    • Get Reasons
  • Report Tags
    • Get Report Tags
    • Add Report Tag
    • Update Report Tag
  • Revenue Centers
    • Get Revenue Centers
  • Sales Channels
    • Get Sales Channels
  • Scheduled Jobs
    • Get Scheduled Job
    • Create Scheduled Job
    • Create Scheduled Job with Sku
    • Update Scheduled Job
    • Update Scheduled Job with Sku
  • Section Things
    • Get Section Things
  • Sections
    • Get Sections
  • Service Charges
    • Get Service Charges
  • Shifts
    • Get Shifts
    • Get Shift
  • Tables
    • Get Tables
  • Tags
    • Get Tags
  • Taxes
    • Get Taxes
  • Z Reports
    • Get Z Reports
  • Schemas
    • Schemas
      • PaginationMeta
      • Translation
      • Metafield
      • Error
      • Check
      • Customer
      • CustomerSummary
      • CustomerAccountDetail
      • MenuItem
      • Employee
      • Property
      • Enterprise
      • RevenueCenter
      • Table
      • SalesChannel
      • Delivery
      • CheckServiceCharge
      • CheckSummary
      • CheckDiscount
      • CheckPayment
      • CheckItem
      • CheckItemSummary
      • CheckOffer
      • Tax
      • Item
      • Device
      • Tag
      • ItemDefinition
      • CondimentGroup
      • DailyTotals
      • CreateCheckRequest
      • CreateCheckItemRequest
      • AddCheckPaymentRequest
      • AddCheckDiscountRequest
      • CreateCustomerRequest
      • CustomerAddressRequest
      • CustomerInvoiceRequest
      • UpdateCustomerRequest
      • CreateMenuItemRequest
      • UpdateMenuItemRequest
  1. Customers

Add Customer

Production
https://api.simpra.app
Production
https://api.simpra.app
POST
https://api.simpra.app
/apps/api/v1/customers
Last modified:2026-07-30 09:20:57
Scope: Enterprise
Body Parameters
ParameterDefaultDescriptionRequired
phone_numbercustomer phone_numberREQUIRED
emailcustomer email
first_namecustomer first name
last_namecustomer last name
gendercustomer gender
external_idcustomer external id
customer_discount_idcustomer discount id
customer_address.addresscustomer adressREQUIRED
customer_address.labelcustomer adress label
customer_address.property_idcustomer adress
customer_invoice.namecustomer invoice nameREQUIRED
customer_invoice.companycustomer invoice companyREQUIRED
customer_invoice.tax_admincustomer invoice tax adminREQUIRED
customer_invoice.tckn_or_vkncustomer invoice tckn or vknREQUIRED
customer_invoice.companycustomer invoice companyREQUIRED
customer_invoice.addresscustomer invoice address
customer_invoice.emailcustomer invoice email
customer_invoice.descriptioncustomer invoice description

Request

Authorization
Add parameter in header
Simpra-Access-Token
Example:
Simpra-Access-Token: ********************
Header Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
OK
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.simpra.app/apps/api/v1/customers' \
--header 'Simpra-Access-Token: <api-key>' \
--header 'Content-Type: application\json' \
--data-raw '{
    "email": "hildred@muller.co",
    "first_name": "Noriko",
    "last_name": "Ebert",
    "phone_number": "1569714718",
    "gender": 1,
    "external_id": "6f6fc0e2",
    "customer_discount_id": "ac5cbc53-d295-4c93-ba75-a6229a49b8cc",
    "customer_address": {
        "address": "81412 Hane Trace",
        "label": "West Wadeville",
        "property_id": "ea6750f3-6f72-4f19-8564-5c73db0153d0"
    },
    "customer_invoice": {
        "company": "Rippin and Sons",
        "tax_admin": "Bobby Abshire",
        "tckn_or_vkn": "4799967681",
        "name": "Ms. Ignacia Ziemann",
        "address": "Apt. 545 2122 Ruecker Pines, Jerdeview, VA 68855-0750",
        "email": "gavin@gottlieb.biz",
        "description": "Perferendis sed non. Dignissimos non ipsa. Et quos velit."
    }
}'
Response Response Example
{
    "customer": {
        "id": "a1e1cce8-5cc6-4fbb-aec0-5539962db183",
        "name": "Noriko Ebert"
    }
}
Modified at 2026-07-30 09:20:57
Previous
Get Customers
Next
Update Customer
Built with