Skip to main content
POST
/
customers
Create customer
curl --request POST \
  --url https://api.orafi.app/v1/customers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstname": "John",
  "lastname": "Doe",
  "email": "john.doe@example.com"
}
'
{
  "success": true,
  "message": "Customer created successfully",
  "data": {
    "id": "customer_abc123",
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@example.com",
    "totalSpent": 500.5,
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for merchant authentication required for most endpoints

Body

application/json
​
firstname
string
required

Customer first name

Example:

"John"

​
lastname
string
required

Customer last name

Example:

"Doe"

​
email
string<email>
required

Customer email address

Example:

"john.doe@example.com"

Response

Customer created successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Customer created successfully"

​
data
object