POST Customers/AddCustomer

Registers a Customer and Sends a notification to the Customer

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Disabled		date	None.
ExternalID	ID of Customer in the external database (Use only for data sync)	string	None.
Email		string	Required
Password		string	Required Data type: Password String length: inclusive between 6 and 100
TypeID		integer	Required
InvoiceRequired		boolean	None.
ExcludeTaxes		boolean	None.
PaymentMeansID		integer	None.
TariffID		integer	None.
VatIdentifier		string	String length: inclusive between 0 and 20
LanguageID		integer	None.
BacCode	bac (business activity code. Epígrafe iae in spain)	string	None.
BusinessName		string	None.
NewsletterSubscriberID		integer	None.
IsEquivalenceSurcharged	The equivalence surcharge is a special VAT regime compulsory for retail sellers that don’t make any kind of transformation to the products they sell. That is for the self-employed sellers that sell to the final client. It’s applied both to physical people that register as self-employed to communities of property. The supplier of the seller is to include the equivalence surcharge of their invoices, separated from the VAT, and consider both amount as VAT charged on their VAT statements.	boolean	None.
BusinessID	A customer related to a business uses BusinessContacts as Shipping Contacts	integer	None.
ShippingBusinessContactID	Default BusinessContact for this customer used for Shipping	integer	None.
Name		string	Required String length: inclusive between 0 and 100
Surnames		string	String length: inclusive between 0 and 100
Gender		Gender	None.
DateOfBirth		date	None.
Lang		string	None.
StoreID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Disabled": "2025-12-06T05:42:42.8347464+01:00",
  "ExternalID": "sample string 1",
  "Email": "sample string 2",
  "Password": "sample string 3",
  "TypeID": 4,
  "InvoiceRequired": true,
  "ExcludeTaxes": true,
  "PaymentMeansID": 7,
  "TariffID": 8,
  "VatIdentifier": "sample string 9",
  "LanguageID": 10,
  "BacCode": "sample string 11",
  "BusinessName": "sample string 12",
  "NewsletterSubscriberID": 1,
  "IsEquivalenceSurcharged": true,
  "BusinessID": 1,
  "ShippingBusinessContactID": 1,
  "Name": "sample string 14",
  "Surnames": "sample string 15",
  "Gender": 1,
  "DateOfBirth": "2025-12-06T05:42:42.8347464+01:00",
  "Lang": "sample string 16",
  "StoreID": 17
}

application/xml, text/xml

Sample:

<AddCustomerBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Customer">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 16</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">17</StoreID>
  <DateOfBirth xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Base">2025-12-06T05:42:42.8347464+01:00</DateOfBirth>
  <Gender xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Base">Male</Gender>
  <Name xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Base">sample string 14</Name>
  <Surnames xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Base">sample string 15</Surnames>
  <BacCode>sample string 11</BacCode>
  <BusinessID>1</BusinessID>
  <BusinessName>sample string 12</BusinessName>
  <Disabled>2025-12-06T05:42:42.8347464+01:00</Disabled>
  <Email>sample string 2</Email>
  <ExcludeTaxes>true</ExcludeTaxes>
  <ExternalID>sample string 1</ExternalID>
  <InvoiceRequired>true</InvoiceRequired>
  <IsEquivalenceSurcharged>true</IsEquivalenceSurcharged>
  <LanguageID>10</LanguageID>
  <NewsletterSubscriberID>1</NewsletterSubscriberID>
  <Password>sample string 3</Password>
  <PaymentMeansID>7</PaymentMeansID>
  <ShippingBusinessContactID>1</ShippingBusinessContactID>
  <TariffID>8</TariffID>
  <TypeID>4</TypeID>
  <VatIdentifier>sample string 9</VatIdentifier>
</AddCustomerBinding>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>