Skip to content Docs index for AI agents (llms.txt)

DevelopersCustomersCreate a customer

Create a customer

Add a customer to a shop with the API.

Updated 1 min read

This endpoint needs the Pro plan and works on the customers of the shop from the shop context. See the API overview for authentication and the rate limit.

POST /customers

Send the fields as JSON. Returns 201 Created with the customer in data, in the same shape as in list customers.

Field Type Required Description
name string Yes Full name. Up to 255 characters.
is_company boolean Yes Whether the customer is a company.
company_name string No Up to 255 characters.
postal_code string No Up to 255 characters.
house_number integer No
house_number_addition string No Up to 255 characters.
street string No Up to 255 characters.
city string No Up to 255 characters.
country_id integer No Id of an existing country.
phone_number string No Up to 255 characters.
email string No A valid email address. Up to 255 characters.
invoice_email string No A valid email address. Up to 255 characters.
registration_number string No Chamber of Commerce number. Up to 255 characters.
vat_number string No Up to 255 characters.
codice_fiscale string No Italian tax code. Up to 255 characters.
remarks string No Free text. Up to 65535 characters.