Customers

Allow convertedin to get your customer's data

These keys are specified to use as defined in docs, they are case-sensitive. Any change in these keys may cause issues during data sync

post

YOUR_BASEURL/convertedin/customers
Request
Response
Request
Query Parameters
par_page
optional
integer
limit per page (default 100)
page
required
integer
page number
token
required
string
Response
200: OK
{
"current_page": 1,
"data": [
{
"id": 1739,
"email": "[email protected]",
"first_name": "صالح",
"last_name": "عادل",
"orders_count": 23,
"total_spent": 184,
"currency": "EGP",
"phone": "01000000001",
"registered_at": "2020-10-12 10:00:00",
"gender": "male" // male, female, unknown
}
],
"from": 1,
"last_page": 25,
"per_page": 100,
"to": 100,
"total": 2442
}

key

Description

Validation Rules

id

customer id on your database linked to his orders

Required

email

customer unique email

Required

first_name

customer first name

Required

last_name

customer last/family name

Required

orders_count

customer successful orders count

Required

total_spent

customer total money spent on orders

Required

currency

customer currency in ISO code (USD, EUR)

Required

phone

customer phone number

Not required

registered_at

customer registration date, Format: Y-m-d H:i:s, ex: 2020-12-15 19:00:00

Required

gender

customer gender ('male','female','unknown')

Not required, Recommended