PUT Customers/ModifyCustomer
Registers a Customer.
Request Information
URI Parameters
None.
Body Parameters
CustomerBinding| Name | Description | Type | Additional information |
|---|---|---|---|
| Disabled | date |
None. |
|
| ExternalID |
ID of Customer in the external database (Use only for data sync) |
string |
None. |
| ID | string |
Required String length: inclusive between 0 and 128 |
|
| TypeID | integer |
Required |
|
| InvoiceRequired | boolean |
None. |
|
| ExcludeTaxes | boolean |
None. |
|
| ShippingContactID | integer |
None. |
|
| BillingContactID | integer |
None. |
|
| PaymentMeansID | integer |
None. |
|
| TariffID | integer |
None. |
|
| VatIdentifier | string |
String length: inclusive between 0 and 20 |
|
| BacCode |
bac (business activity code. Epígrafe iae in spain) |
string |
None. |
| BusinessName | string |
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. |
| NewsletterSubscriberID |
NewsletterSubscriber ID |
integer |
None. |
| LanguageID | integer |
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
{
"Disabled": "2025-12-06T05:42:41.8383099+01:00",
"ExternalID": "sample string 1",
"ID": "sample string 2",
"TypeID": 3,
"InvoiceRequired": true,
"ExcludeTaxes": true,
"ShippingContactID": 1,
"BillingContactID": 1,
"PaymentMeansID": 6,
"TariffID": 7,
"VatIdentifier": "sample string 8",
"BacCode": "sample string 9",
"BusinessName": "sample string 10",
"IsEquivalenceSurcharged": true,
"NewsletterSubscriberID": 1,
"LanguageID": 12,
"BusinessID": 1,
"ShippingBusinessContactID": 1,
"Name": "sample string 13",
"Surnames": "sample string 14",
"Gender": 1,
"DateOfBirth": "2025-12-06T05:42:41.8383099+01:00",
"Lang": "sample string 15",
"StoreID": 16
}
application/xml, text/xml
<CustomerBinding 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 15</Lang> <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">16</StoreID> <DateOfBirth xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Base">2025-12-06T05:42:41.8383099+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 13</Name> <Surnames xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Base">sample string 14</Surnames> <BacCode>sample string 9</BacCode> <BillingContactID>1</BillingContactID> <BusinessID>1</BusinessID> <BusinessName>sample string 10</BusinessName> <Disabled>2025-12-06T05:42:41.8383099+01:00</Disabled> <ExcludeTaxes>true</ExcludeTaxes> <ExternalID>sample string 1</ExternalID> <ID>sample string 2</ID> <InvoiceRequired>true</InvoiceRequired> <IsEquivalenceSurcharged>true</IsEquivalenceSurcharged> <LanguageID>12</LanguageID> <NewsletterSubscriberID>1</NewsletterSubscriberID> <PaymentMeansID>6</PaymentMeansID> <ShippingBusinessContactID>1</ShippingBusinessContactID> <ShippingContactID>1</ShippingContactID> <TariffID>7</TariffID> <TypeID>3</TypeID> <VatIdentifier>sample string 8</VatIdentifier> </CustomerBinding>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.