Sign in

v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Customers

Create Customer

Create a new customer.

post/customers

Request body

external_idstring nullable

The provided external_id must be unique. If a non-unique external_id is provided, the API will respond with an error.

sales_channelstring required

If a channel with this name is not already associated with the shop, it will be used to create a new channel.

first_namestring nullable

The customer's given name.

last_namestring nullable

The customer's surname.

emailstring email nullable

The customer's email address.

phonestring nullable

The customer's phone number.

tagsTagRequestData[] nullable

An array of tags used to classify and group customers.

Example request

{
  "external_id": "71263csss-12uhsdfh-2138dja",
  "sales_channel": "shopify",
  "first_name": "Edgar",
  "last_name": "Martinez",
  "email": "sample@example.com",
  "phone": "678-999-8212",
  "tags": [
    "FirstPurchase",
    "ReturnCustomer"
  ]
}

Response

Success

Example response

{
  "customer": {
    "id": 9007199254740991,
    "external_id": "71263csss-12uhsdfh-2138dja",
    "sales_channel": "shopify",
    "first_name": "Edgar",
    "last_name": "Martinez",
    "email": "sample@example.com",
    "phone": "678-999-8212",
    "tags": [
      "FirstPurchase",
      "ReturnCustomer"
    ]
  }
}