POST v1/Customers

Add a new Customer.

Request Information

Requires Authorization!

URI Parameters

None.

Body Parameters

The Customer changes object

Name	Description	Type	Additional information
SyncShipToAddressOnSave	Gets or sets a value indicating whether the ship-to address is synchronized.	boolean	None.
SyncBillToAddressOnSave	Gets or sets a value indicating whether the bill-to address is synchronized.	boolean	None.
CustomerCode	Gets or sets the customer code.	string	Max length: 50
ReceiveNewsLetter		boolean	Required
CustomerGroupId		integer	None.
BillToAddress	Gets or sets the bill-to address.	ContactInfo	None.
ShipToAddress	Gets or sets the ship-to address.	ContactInfo	None.
ShopOwnerId	Gets or sets the shop owner identifier.	integer	Required
PersonTitle	Gets or sets the person title.	string	Max length: 50
FirstName	Gets or sets the first name.	string	Max length: 50
MiddleName	Gets or sets the middle name.	string	Max length: 50
LastNamePrefix	Gets or sets the last name prefix.	string	Max length: 50
LastName	Gets or sets the last name.	string	Max length: 50
CultureId	Gets or sets the culture identifier.	integer	None.
PersonalNumber	Gets or sets the personal number.	string	Max length: 20
ChangedTimestamp	Gets or sets the changed timestamp.	date	None.
Id	Gets or sets the identifier.	integer	Must be 0
FullName	Gets or sets the full name.	string	Max length: 100
CompanyName	Gets or sets the name of the company.	string	Max length: 100
EMail	Gets or sets the e mail.	string	Max length: 200
ContactReference	Gets or sets the contact reference.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SyncShipToAddressOnSave": true,
  "SyncBillToAddressOnSave": true,
  "CustomerCode": "sample string 3",
  "ReceiveNewsLetter": true,
  "CustomerGroupId": 1,
  "BillToAddress": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2021-12-02T20:19:32.0291544+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "ShipToAddress": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2021-12-02T20:19:32.0291544+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "ShopOwnerId": 1,
  "PersonTitle": "sample string 5",
  "FirstName": "sample string 6",
  "MiddleName": "sample string 7",
  "LastNamePrefix": "sample string 8",
  "LastName": "sample string 9",
  "CultureId": 1,
  "PersonalNumber": "sample string 10",
  "ChangedTimestamp": "2021-12-02T20:19:32.0291544+01:00",
  "Id": 11,
  "FullName": "sample string 12",
  "CompanyName": "sample string 13",
  "EMail": "sample string 14",
  "ContactReference": "sample string 15"
}

application/xml, text/xml

Sample:

<CustomerChanges xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>11</Id>
  <FullName>sample string 12</FullName>
  <CompanyName>sample string 13</CompanyName>
  <EMail>sample string 14</EMail>
  <ContactReference>sample string 15</ContactReference>
  <ShopOwnerId>1</ShopOwnerId>
  <PersonTitle>sample string 5</PersonTitle>
  <FirstName>sample string 6</FirstName>
  <MiddleName>sample string 7</MiddleName>
  <LastNamePrefix>sample string 8</LastNamePrefix>
  <LastName>sample string 9</LastName>
  <CultureId>1</CultureId>
  <PersonalNumber>sample string 10</PersonalNumber>
  <ChangedTimestamp>2021-12-02T20:19:32.0291544+01:00</ChangedTimestamp>
  <CustomerCode>sample string 3</CustomerCode>
  <ReceiveNewsLetter>true</ReceiveNewsLetter>
  <CustomerGroupId>1</CustomerGroupId>
  <BillToAddress>
    <Id>9</Id>
    <CompanyName>sample string 10</CompanyName>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <StreetAddress>sample string 13</StreetAddress>
    <StreetAddressNumber>sample string 14</StreetAddressNumber>
    <StreetAddressExtension>sample string 15</StreetAddressExtension>
    <PostalCode>sample string 16</PostalCode>
    <City>sample string 17</City>
    <CountryId>1</CountryId>
    <CountryCode>sample string 18</CountryCode>
    <EMail>sample string 19</EMail>
    <Phone>sample string 20</Phone>
    <Phone2>sample string 21</Phone2>
    <StateProvince>sample string 22</StateProvince>
    <StateProvinceCode>sample string 23</StateProvinceCode>
    <VatNumber>sample string 1</VatNumber>
    <FullName>sample string 2</FullName>
    <DateOfBirth>2021-12-02T20:19:32.0291544+01:00</DateOfBirth>
    <Gender>sample string 3</Gender>
    <PersonTitle>sample string 4</PersonTitle>
    <MiddleName>sample string 5</MiddleName>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <LastNamePrefix>sample string 8</LastNamePrefix>
  </BillToAddress>
  <ShipToAddress>
    <Id>9</Id>
    <CompanyName>sample string 10</CompanyName>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <StreetAddress>sample string 13</StreetAddress>
    <StreetAddressNumber>sample string 14</StreetAddressNumber>
    <StreetAddressExtension>sample string 15</StreetAddressExtension>
    <PostalCode>sample string 16</PostalCode>
    <City>sample string 17</City>
    <CountryId>1</CountryId>
    <CountryCode>sample string 18</CountryCode>
    <EMail>sample string 19</EMail>
    <Phone>sample string 20</Phone>
    <Phone2>sample string 21</Phone2>
    <StateProvince>sample string 22</StateProvince>
    <StateProvinceCode>sample string 23</StateProvinceCode>
    <VatNumber>sample string 1</VatNumber>
    <FullName>sample string 2</FullName>
    <DateOfBirth>2021-12-02T20:19:32.0291544+01:00</DateOfBirth>
    <Gender>sample string 3</Gender>
    <PersonTitle>sample string 4</PersonTitle>
    <MiddleName>sample string 5</MiddleName>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <LastNamePrefix>sample string 8</LastNamePrefix>
  </ShipToAddress>
  <SyncShipToAddressOnSave>true</SyncShipToAddressOnSave>
  <SyncBillToAddressOnSave>true</SyncBillToAddressOnSave>
</CustomerChanges>

Response Information

Resource Description

The Customer object.

Customer

Name	Description	Type	Additional information
CustomerCode	Gets or sets the customer code.	string	Max length: 50
ReceiveNewsLetter		boolean	Required
CustomerGroupId		integer	None.
BillToAddress	Gets or sets the bill-to address.	ContactInfo	None.
ShipToAddress	Gets or sets the ship-to address.	ContactInfo	None.
ShopOwnerId	Gets or sets the shop owner identifier.	integer	Required
PersonTitle	Gets or sets the person title.	string	Max length: 50
FirstName	Gets or sets the first name.	string	Max length: 50
MiddleName	Gets or sets the middle name.	string	Max length: 50
LastNamePrefix	Gets or sets the last name prefix.	string	Max length: 50
LastName	Gets or sets the last name.	string	Max length: 50
CultureId	Gets or sets the culture identifier.	integer	None.
PersonalNumber	Gets or sets the personal number.	string	Max length: 20
ChangedTimestamp	Gets or sets the changed timestamp.	date	None.
Id	Gets or sets the identifier.	integer	Must be 0
FullName	Gets or sets the full name.	string	Max length: 100
CompanyName	Gets or sets the name of the company.	string	Max length: 100
EMail	Gets or sets the e mail.	string	Max length: 200
ContactReference	Gets or sets the contact reference.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerCode": "sample string 1",
  "ReceiveNewsLetter": true,
  "CustomerGroupId": 1,
  "BillToAddress": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2021-12-02T20:19:32.0291544+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "ShipToAddress": {
    "VatNumber": "sample string 1",
    "FullName": "sample string 2",
    "DateOfBirth": "2021-12-02T20:19:32.0291544+01:00",
    "Gender": "sample string 3",
    "PersonTitle": "sample string 4",
    "MiddleName": "sample string 5",
    "FirstName": "sample string 6",
    "LastName": "sample string 7",
    "LastNamePrefix": "sample string 8",
    "Id": 9,
    "CompanyName": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "StreetAddress": "sample string 13",
    "StreetAddressNumber": "sample string 14",
    "StreetAddressExtension": "sample string 15",
    "PostalCode": "sample string 16",
    "City": "sample string 17",
    "CountryId": 1,
    "CountryCode": "sample string 18",
    "CountryName": null,
    "EMail": "sample string 19",
    "Phone": "sample string 20",
    "Phone2": "sample string 21",
    "StateProvince": "sample string 22",
    "StateProvinceCode": "sample string 23"
  },
  "ShopOwnerId": 1,
  "PersonTitle": "sample string 3",
  "FirstName": "sample string 4",
  "MiddleName": "sample string 5",
  "LastNamePrefix": "sample string 6",
  "LastName": "sample string 7",
  "CultureId": 1,
  "PersonalNumber": "sample string 8",
  "ChangedTimestamp": "2021-12-02T20:19:32.0291544+01:00",
  "Id": 9,
  "FullName": "sample string 10",
  "CompanyName": "sample string 11",
  "EMail": "sample string 12",
  "ContactReference": "sample string 13"
}

application/xml, text/xml

Sample:

<Customer xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>9</Id>
  <FullName>sample string 10</FullName>
  <CompanyName>sample string 11</CompanyName>
  <EMail>sample string 12</EMail>
  <ContactReference>sample string 13</ContactReference>
  <ShopOwnerId>1</ShopOwnerId>
  <PersonTitle>sample string 3</PersonTitle>
  <FirstName>sample string 4</FirstName>
  <MiddleName>sample string 5</MiddleName>
  <LastNamePrefix>sample string 6</LastNamePrefix>
  <LastName>sample string 7</LastName>
  <CultureId>1</CultureId>
  <PersonalNumber>sample string 8</PersonalNumber>
  <ChangedTimestamp>2021-12-02T20:19:32.0291544+01:00</ChangedTimestamp>
  <CustomerCode>sample string 1</CustomerCode>
  <ReceiveNewsLetter>true</ReceiveNewsLetter>
  <CustomerGroupId>1</CustomerGroupId>
  <BillToAddress>
    <Id>9</Id>
    <CompanyName>sample string 10</CompanyName>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <StreetAddress>sample string 13</StreetAddress>
    <StreetAddressNumber>sample string 14</StreetAddressNumber>
    <StreetAddressExtension>sample string 15</StreetAddressExtension>
    <PostalCode>sample string 16</PostalCode>
    <City>sample string 17</City>
    <CountryId>1</CountryId>
    <CountryCode>sample string 18</CountryCode>
    <EMail>sample string 19</EMail>
    <Phone>sample string 20</Phone>
    <Phone2>sample string 21</Phone2>
    <StateProvince>sample string 22</StateProvince>
    <StateProvinceCode>sample string 23</StateProvinceCode>
    <VatNumber>sample string 1</VatNumber>
    <FullName>sample string 2</FullName>
    <DateOfBirth>2021-12-02T20:19:32.0291544+01:00</DateOfBirth>
    <Gender>sample string 3</Gender>
    <PersonTitle>sample string 4</PersonTitle>
    <MiddleName>sample string 5</MiddleName>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <LastNamePrefix>sample string 8</LastNamePrefix>
  </BillToAddress>
  <ShipToAddress>
    <Id>9</Id>
    <CompanyName>sample string 10</CompanyName>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <StreetAddress>sample string 13</StreetAddress>
    <StreetAddressNumber>sample string 14</StreetAddressNumber>
    <StreetAddressExtension>sample string 15</StreetAddressExtension>
    <PostalCode>sample string 16</PostalCode>
    <City>sample string 17</City>
    <CountryId>1</CountryId>
    <CountryCode>sample string 18</CountryCode>
    <EMail>sample string 19</EMail>
    <Phone>sample string 20</Phone>
    <Phone2>sample string 21</Phone2>
    <StateProvince>sample string 22</StateProvince>
    <StateProvinceCode>sample string 23</StateProvinceCode>
    <VatNumber>sample string 1</VatNumber>
    <FullName>sample string 2</FullName>
    <DateOfBirth>2021-12-02T20:19:32.0291544+01:00</DateOfBirth>
    <Gender>sample string 3</Gender>
    <PersonTitle>sample string 4</PersonTitle>
    <MiddleName>sample string 5</MiddleName>
    <FirstName>sample string 6</FirstName>
    <LastName>sample string 7</LastName>
    <LastNamePrefix>sample string 8</LastNamePrefix>
  </ShipToAddress>
</Customer>