Create customer

post

https://api.epicorretailcloud.com/api/sales/v1/customer/

Creates a customer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Customer information

name

string

required

length between 1 and 128

[^\s]+

The name of this customer.

customer_number

string | null

The customer number. If not specified, the next available sequential number will be automatically assigned.

customer_type

integer

enum

-2147483648 to 2147483647

The customer type.

0 - Personal
1 - Business

Allowed:

store_account_opened_id

integer | null

The ID of the store where the customer account was opened.

customer_price_group_id

integer | null

The unique identifier for this customer price group.

bill_to_customer_id

integer | null

Customer ID of the bill-to customer

title

string

length ≤ 40

The customer's title.

first_name

string

required

length between 1 and 128

The customer's first name.

last_name

string

length ≤ 40

The customer's last name.

string

length ≤ 128

The customer's e-mail address.

line_1

string | null

The customer's address line 1.

line_2

string | null

The customer's address line 2.

line_3

string | null

The customer's address line 3.

city

string | null

The customer's city.

postal_code_location

string | null

The customer's postal code location.

postal_code

string | null

The customer's postal code.

country

string | null

The customer's country.

phone_number

string

length ≤ 32

The phone number of the primary contact for this customer. Valid phone number format with country code : +1 2144141441 or without country code: 2144141441.

phone_country

string

length ≤ 2

Primary Phone number’s country. If Blank, system will default country to “US”.

phone_type

string

enum

Primary Phone number’s type. If Blank, system will default Phone Type to “M”.

`` -
O - Office
M - Mobile
F - Fax
H - Home
C - Business Main
P - Pager
T - Toll-Free
X - Other

Headers

X-Active-Store

integer

required

The id of the active store to be used for this API invocation

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

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

application/json

201