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

Authentication

Use your token provided inside converted.in after on boarding process to authenticate the request using form-data body
post
YOUR_BASEURL
/convertedin/customers
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

Response

{
"data": [
{
"id": 207119551,
"email": "[email protected]",
"accepts_marketing": false,
"created_at": "2021-10-01T16:52:26-04:00",
"updated_at": "2021-10-01T16:52:26-04:00",
"first_name": "Bob",
"last_name": "Norman",
"orders_count": 1,
"state": "disabled",
"total_spent": "199.65",
"last_order_id": 450789469,
"verified_email": true,
"phone": "+16136120707",
"last_order_name": "#1001",
"currency": "USD",
"addresses": [
{
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
],
"default_address": {
"id": 207119551,
"customer_id": 207119551,
"first_name": null,
"last_name": null,
"company": null,
"address1": "Chestnut Street 92",
"address2": "",
"city": "Louisville",
"province": "Kentucky",
"country": "United States",
"zip": "40202",
"phone": "555-625-1199",
"name": "",
"province_code": "KY",
"country_code": "US",
"country_name": "United States",
"default": true
}
}
],
"total": 1000,
"per_page": 100,
"current_page": 1,
"last_page": 10,
"from": 1,
"to": 100
}
Copy link
Outline
Authentication
post
Response