POST v3/customer?domain={domain}

Create a new customer record

Request Information

URI Parameters

NameDescriptionTypeAdditional information
domain

string

None.

Body Parameters

NewCustomer
NameDescriptionTypeAdditional information
AgreedStatements

Collection of string

None.

Addresses

Collection of NewCustomerAddress

None.

BirthDate

date

None.

Email

string

None.

FirstName

string

None.

FriendlyId

string

None.

LastName

string

None.

Mobile

string

None.

Phone

string

None.

Title

string

None.

Tags

Collection of string

None.

Password

string

None.

Attributes

There will be additional properties (custom to each client) with the prefix 'Attribute_'

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json

Sample:
{
  "birthDate": "2021-07-25T19:47:40.5204454+00:00",
  "email": "sample string 1",
  "firstName": "sample string 2",
  "friendlyId": "sample string 3",
  "lastName": "sample string 4",
  "mobile": "sample string 5",
  "phone": "sample string 6",
  "title": "sample string 7",
  "password": "sample string 8"
}

text/xml

Sample:
<NewCustomer>
  <BirthDate>2021-07-25T19:47:40.5204454+00:00</BirthDate>
  <Email>sample string 1</Email>
  <FirstName>sample string 2</FirstName>
  <FriendlyId>sample string 3</FriendlyId>
  <LastName>sample string 4</LastName>
  <Mobile>sample string 5</Mobile>
  <Phone>sample string 6</Phone>
  <Title>sample string 7</Title>
  <Password>sample string 8</Password>
</NewCustomer>

Response Information

Resource Description

Customer
NameDescriptionTypeAdditional information
Age

integer

None.

AllStatements

Collection of DataProtectionStatement

None.

AgreedStatements

Collection of DataProtectionStatement

None.

Addresses

Collection of CustomerAddress

None.

BillingAddress

CustomerAddress

None.

DeliveryAddress

CustomerAddress

None.

BirthDate

date

None.

Email

string

None.

FirstName

string

None.

LastName

string

None.

Mobile

string

None.

Name

string

None.

Phone

string

None.

AllTagsByGroup

Collection of CustomerTagGroup

None.

TagsByGroup

Collection of TagGroup

None.

Tags

Collection of Tag

None.

AllTags

Collection of CustomerTag

None.

PrintAtHomeDocuments

Collection of PrintAtHomeDocument

None.

Title

string

None.

PasswordSet

boolean

None.

GiftAidDeclarationRequired

boolean

None.

Subscriptions

Collection of CustomerSubscription

None.

Orders

Collection of Order

None.

StoredCards

Collection of StoredCard

None.

Id

string

None.

Attributes

There will be additional properties (custom to each client) with the prefix 'Attribute_'

None.

CreditBalance

Money

None.

Response Formats

application/json, text/xml

Sample:

Sample not available.