POST 3dCartWebAPI/v1/Customers
Adds a new customer to the system
Request Information
URI Parameters
None.
Body Parameters
A Json or XML object containing the new customer
CustomerName | Description | Type | Additional information |
---|---|---|---|
CustomerID |
Primary key. Auto-incremented. database reference = customers.contactid |
integer |
None. |
database reference = customers.email |
string |
Required String length: inclusive between 0 and 100 |
|
Password |
database reference = customers.pass |
string |
Required String length: inclusive between 0 and 50 |
BillingCompany |
database reference = customers.billing_company |
string |
String length: inclusive between 0 and 255 |
BillingFirstName |
database reference = customers.billing_firstname |
string |
String length: inclusive between 0 and 50 |
BillingLastName |
database reference = customers.billing_lastname |
string |
String length: inclusive between 0 and 50 |
BillingAddress1 |
database reference = customers.billing_address |
string |
String length: inclusive between 0 and 255 |
BillingAddress2 |
database reference = customers.billing_address2 |
string |
String length: inclusive between 0 and 50 |
BillingCity |
database reference = customers.billing_city |
string |
String length: inclusive between 0 and 100 |
BillingState |
database reference = customers.billing_state |
string |
String length: inclusive between 0 and 100 |
BillingZipCode |
database reference = customers.billing_zip |
string |
String length: inclusive between 0 and 20 |
BillingCountry |
database reference = customers.billing_country |
string |
String length: inclusive between 0 and 100 |
BillingPhoneNumber |
database reference = customers.billing_phone |
string |
String length: inclusive between 0 and 50 |
BillingTaxID |
database reference = customers.accountno |
string |
String length: inclusive between 0 and 50 |
ShippingCompany |
database reference = customers.shipping_company |
string |
String length: inclusive between 0 and 255 |
ShippingFirstName |
database reference = customers.shipping_firstname |
string |
String length: inclusive between 0 and 50 |
ShippingLastName |
database reference = customers.shipping_lastname |
string |
String length: inclusive between 0 and 50 |
ShippingAddress1 |
database reference = customers.shipping_address |
string |
String length: inclusive between 0 and 255 |
ShippingAddress2 |
database reference = customers.shipping_address2 |
string |
String length: inclusive between 0 and 50 |
ShippingCity |
database reference = customers.shipping_city |
string |
String length: inclusive between 0 and 100 |
ShippingState |
database reference = customers.shipping_state |
string |
String length: inclusive between 0 and 100 |
ShippingZipCode |
database reference = customers.shipping_zip |
string |
String length: inclusive between 0 and 20 |
ShippingCountry |
database reference = customers.shipping_country |
string |
String length: inclusive between 0 and 100 |
ShippingPhoneNumber |
database reference = customers.shipping_phone |
string |
String length: inclusive between 0 and 50 |
ShippingAddressType |
database reference = customers.oshipaddresstype |
integer |
None. |
CustomerGroupID |
database reference = customers.discount |
integer |
None. |
Enabled |
database reference = customers.custenabled |
boolean |
None. |
MailList |
database reference = customers.maillist |
boolean |
None. |
NonTaxable |
database reference = customers.type |
boolean |
None. |
DisableBillingSameAsShipping | boolean |
None. |
|
Comments |
database reference = customers.comments |
string |
String length: inclusive between 0 and 255 |
AdditionalField1 |
database reference = customers.additional_field1 |
string |
String length: inclusive between 0 and 250 |
AdditionalField2 |
database reference = customers.additional_field2 |
string |
String length: inclusive between 0 and 250 |
AdditionalField3 |
database reference = customers.additional_field3 |
string |
String length: inclusive between 0 and 150 |
TotalStoreCredit |
computed column ==> sum(customer_credit.credit) of all records |
decimal number |
None. |
ResetPassword |
database reference = customers.reset_pass |
boolean |
None. |
Request Formats
application/json, text/json
{ "CustomerID": 1, "Email": "sample string 1", "Password": "sample string 2", "BillingCompany": "sample string 3", "BillingFirstName": "sample string 4", "BillingLastName": "sample string 5", "BillingAddress1": "sample string 6", "BillingAddress2": "sample string 7", "BillingCity": "sample string 8", "BillingState": "sample string 9", "BillingZipCode": "sample string 10", "BillingCountry": "sample string 11", "BillingPhoneNumber": "sample string 12", "BillingTaxID": "sample string 13", "ShippingCompany": "sample string 14", "ShippingFirstName": "sample string 15", "ShippingLastName": "sample string 16", "ShippingAddress1": "sample string 17", "ShippingAddress2": "sample string 18", "ShippingCity": "sample string 19", "ShippingState": "sample string 20", "ShippingZipCode": "sample string 21", "ShippingCountry": "sample string 22", "ShippingPhoneNumber": "sample string 23", "ShippingAddressType": 1, "CustomerGroupID": 1, "Enabled": true, "MailList": true, "NonTaxable": true, "DisableBillingSameAsShipping": true, "Comments": "sample string 24", "AdditionalField1": "sample string 25", "AdditionalField2": "sample string 26", "AdditionalField3": "sample string 27", "TotalStoreCredit": 1.1, "ResetPassword": true }
application/xml, text/xml
<Customer xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <CustomerID>1</CustomerID> <Email>sample string 1</Email> <Password>sample string 2</Password> <BillingCompany>sample string 3</BillingCompany> <BillingFirstName>sample string 4</BillingFirstName> <BillingLastName>sample string 5</BillingLastName> <BillingAddress1>sample string 6</BillingAddress1> <BillingAddress2>sample string 7</BillingAddress2> <BillingCity>sample string 8</BillingCity> <BillingState>sample string 9</BillingState> <BillingZipCode>sample string 10</BillingZipCode> <BillingCountry>sample string 11</BillingCountry> <BillingPhoneNumber>sample string 12</BillingPhoneNumber> <BillingTaxID>sample string 13</BillingTaxID> <ShippingCompany>sample string 14</ShippingCompany> <ShippingFirstName>sample string 15</ShippingFirstName> <ShippingLastName>sample string 16</ShippingLastName> <ShippingAddress1>sample string 17</ShippingAddress1> <ShippingAddress2>sample string 18</ShippingAddress2> <ShippingCity>sample string 19</ShippingCity> <ShippingState>sample string 20</ShippingState> <ShippingZipCode>sample string 21</ShippingZipCode> <ShippingCountry>sample string 22</ShippingCountry> <ShippingPhoneNumber>sample string 23</ShippingPhoneNumber> <ShippingAddressType>1</ShippingAddressType> <CustomerGroupID>1</CustomerGroupID> <Enabled>true</Enabled> <MailList>true</MailList> <NonTaxable>true</NonTaxable> <DisableBillingSameAsShipping>true</DisableBillingSameAsShipping> <Comments>sample string 24</Comments> <AdditionalField1>sample string 25</AdditionalField1> <AdditionalField2>sample string 26</AdditionalField2> <AdditionalField3>sample string 27</AdditionalField3> <TotalStoreCredit>1.1</TotalStoreCredit> <ResetPassword>true</ResetPassword> </Customer>
Sample Request |
|
Response Information
application/json, text/json
[ { "Key":"CustomerID", "Value":"1234", "Status":"201", "Message":"Created successfully", } ]
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |