Create a customer

post

https://apisandbox.dev.clover.com/v3/merchants/{mId}/customers

Creates customer record for a merchant. Note that the request body cannot be null.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

mId

string

required

Merchant identifier.

Query Params

expand

string

Expandable fields to display additional nested information: [addresses, emailAddresses, phoneNumbers, cards, metadata]

Body Params

string

Unique identifier.

merchant

object

Merchant with which the customer is associated.

firstName

string

First name of the customer.
Length: Maximum 64 characters

lastName

string

Last name of the customer.
Length: Maximum 64 characters

marketingAllowed

boolean

Indicates whether the customer allows marketing communication from Clover.
Note: This function is only allowed for Clover internal apps, and third-party apps should receive marketing opt-in from customers per their local laws and store consent in their own systems.

customerSince

int64

Date since when the customer is associated with the merchant.

orders

array of objects

Customer's orders.

orders

addresses

array of objects

Customer's mailing and shipping address. This information is displayed on invoices emailed to the customer.
Note: Address must contain a value
Length: Maximum 127 characters.

addresses

emailAddresses

array of objects

Customer's email address.

emailAddresses

phoneNumbers

array of objects

Customer phone numbers.

phoneNumbers

cards

array of objects

Customer card details.

cards

metadata

object

Additional information about the customer.

Headers

User-Agent

string

required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response. Customer record is created.