POST api/users/customer

Allows for creation of a new customer for a given representative.

Request Information

URI Parameters

None.

Body Parameters

CustomerCreationViewModel
NameDescriptionTypeAdditional information
FirstName

The First Name of the Customer

string

Max length: 50

LastName

THe Last Name of the Customer

string

Max length: 50

Email

The email of the customer

string

Max length: 100

Password

The password of the customer

string

None.

RepDID

The RepDID who referred this customer

string

None.

Company

The Company of the Customer

string

None.

Phone1

The Phone1 of the Customer

string

None.

Phone2

The Phone2 of the Customer

string

None.

Phone3

The Phone3 of the Customer

string

None.

Phone4

The Phone4 of the Customer

string

None.

ShippingStreet1

The Shipping Street1 of the Customer

string

None.

ShippingStreet2

The Shipping Street2 of the Customer

string

None.

ShippingCountry

The Shipping Country of the Customer

string

None.

ShippingPostalCode

The Shipping Postal Code of the Customer

string

None.

ShippingCity

The Shipping City of the Customer

string

None.

ShippingState

The Shipping State of the Customer

string

None.

ShippingCounty

The Shipping County of the Customer

string

None.

BillingStreet1

The Billing Street1 of the Customer

string

None.

BillingStreet2

The Billing Street2 of the Customer

string

None.

BillingCountry

The Billing Country of the Customer

string

None.

BillingPostalCode

The Billing Postal Code of the Customer

string

None.

BillingCity

The Billing City of the Customer

string

None.

BillingState

The Billing State of the Customer

string

None.

BillingCounty

The Billing County of the Customer

string

None.

AgreedToTerms

The Customer agreed to terms

boolean

None.

ReferralMarketType

The Referral Market Type of the Customer

integer

None.

ReferralMarketTypeInput

Additional Referral Market Type Input for the Customer

string

None.

ReferCustomerID

The CustomerID who referred this customer

string

None.

TaxID

The TaxID of the Customer

string

None.

TaxID2

The TaxID2 of the Customer

string

None.

ReplicatedSiteUrl

The ReplicatedSiteUrl of the Customer

string

None.

CustomerType

The CustomerType of the Customer

integer

None.

SendAutoresponders

Indicates whether or not to send the AR related to customer signups. Optional. Default is true.

boolean

None.

DateOfBirth

The Customer's Date of Birth

date

None.

ReciprocalRepDID

The RepDID of the Representative this customer account is to be used with for personal purchasing, etc. Requires the setting JSCART_RECIPROCALIDS_INUSE

string

None.

PreferredCulture

Prefered locale for the Customer.

integer

None.

Request Formats

application/xml, text/xml

Sample:
<CustomerCreationViewModel>
  <FirstName>sample string 1</FirstName>
  <LastName>sample string 2</LastName>
  <Email>sample string 3</Email>
  <Password>sample string 4</Password>
  <RepDID>sample string 5</RepDID>
  <Company>sample string 6</Company>
  <Phone1>sample string 7</Phone1>
  <Phone2>sample string 8</Phone2>
  <Phone3>sample string 9</Phone3>
  <Phone4>sample string 10</Phone4>
  <ShippingStreet1>sample string 11</ShippingStreet1>
  <ShippingStreet2>sample string 12</ShippingStreet2>
  <ShippingCountry>sample string 13</ShippingCountry>
  <ShippingPostalCode>sample string 14</ShippingPostalCode>
  <ShippingCity>sample string 15</ShippingCity>
  <ShippingState>sample string 16</ShippingState>
  <ShippingCounty>sample string 17</ShippingCounty>
  <BillingStreet1>sample string 18</BillingStreet1>
  <BillingStreet2>sample string 19</BillingStreet2>
  <BillingCountry>sample string 20</BillingCountry>
  <BillingPostalCode>sample string 21</BillingPostalCode>
  <BillingCity>sample string 22</BillingCity>
  <BillingState>sample string 23</BillingState>
  <BillingCounty>sample string 24</BillingCounty>
  <AgreedToTerms>True</AgreedToTerms>
  <ReferralMarketType>1</ReferralMarketType>
  <ReferralMarketTypeInput>sample string 26</ReferralMarketTypeInput>
  <ReferCustomerID>sample string 27</ReferCustomerID>
  <TaxID>sample string 28</TaxID>
  <TaxID2>sample string 29</TaxID2>
  <ReplicatedSiteUrl>sample string 30</ReplicatedSiteUrl>
  <CustomerType>31</CustomerType>
  <SendAutoresponders>True</SendAutoresponders>
  <DateOfBirth>01/07/2025 12:08:40</DateOfBirth>
  <ReciprocalRepDID>sample string 33</ReciprocalRepDID>
  <PreferredCulture>34</PreferredCulture>
</CustomerCreationViewModel>

application/json, text/json

Sample:
{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "Email": "sample string 3",
  "Password": "sample string 4",
  "RepDID": "sample string 5",
  "Company": "sample string 6",
  "Phone1": "sample string 7",
  "Phone2": "sample string 8",
  "Phone3": "sample string 9",
  "Phone4": "sample string 10",
  "ShippingStreet1": "sample string 11",
  "ShippingStreet2": "sample string 12",
  "ShippingCountry": "sample string 13",
  "ShippingPostalCode": "sample string 14",
  "ShippingCity": "sample string 15",
  "ShippingState": "sample string 16",
  "ShippingCounty": "sample string 17",
  "BillingStreet1": "sample string 18",
  "BillingStreet2": "sample string 19",
  "BillingCountry": "sample string 20",
  "BillingPostalCode": "sample string 21",
  "BillingCity": "sample string 22",
  "BillingState": "sample string 23",
  "BillingCounty": "sample string 24",
  "AgreedToTerms": true,
  "ReferralMarketType": 1,
  "ReferralMarketTypeInput": "sample string 26",
  "ReferCustomerID": "sample string 27",
  "TaxID": "sample string 28",
  "TaxID2": "sample string 29",
  "ReplicatedSiteUrl": "sample string 30",
  "CustomerType": 31,
  "SendAutoresponders": true,
  "DateOfBirth": "2025-01-07T12:08:40.1042261-05:00",
  "ReciprocalRepDID": "sample string 33",
  "PreferredCulture": 34
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'CustomerCreationViewModel'.

Response Information

Resource Description

ICustomer
NameDescriptionTypeAdditional information
CustomerID

integer

None.

CustomerDID

string

None.

BCKey

integer

None.

CustomerTypeID

integer

None.

FirstName

string

None.

LastName

string

None.

MI

string

None.

Email

string

None.

Company

string

None.

PreferredCulture

integer

None.

Password

string

None.

BillStreet1

string

None.

BillStreet2

string

None.

BillCity

string

None.

BillState

string

None.

BillPostalCode

string

None.

BillCountry

string

None.

BillCounty

string

None.

ShipStreet1

string

None.

ShipStreet2

string

None.

ShipCity

string

None.

ShipState

string

None.

ShipPostalCode

string

None.

ShipCountry

string

None.

ShipCounty

string

None.

Phone1

string

None.

Phone2

string

None.

Phone3

string

None.

Phone4

string

None.

Phone5

string

None.

Phone6

string

None.

TaxExemptCodeID

string

None.

TaxExempt

boolean

None.

TaxID

string

None.

TaxID2

string

None.

ReferralMarketTypeID

integer

None.

ReferralMarketTypeInput

string

None.

ReferCustomerID

integer

None.

CreatedBy

string

None.

PasswordResetKey

string

None.

PasswordResetExpirationDate

date

None.

DateOfBirth

date

None.

ApplicationDate

date

None.

StatusTypeID

integer

None.

ContactStatusID

integer

None.

RomanizedName

string

None.

ReciprocalRepID

integer

None.

LastModifiedBy

string

None.

DateLastModified

date

None.

TaxExemptReasonTypeID

integer

None.

UpgradeRepID

integer

None.

PhonesComputed

string

None.

CreatedDate

date

None.

guid

string

None.

AccountNumber

string

None.

Gender

string

None.

EmailOptOut_Company

boolean

None.

EmailOptOut_Upline

boolean

None.

Response Formats

application/xml, text/xml

Sample:
<Customer>
  <CustomerID>0</CustomerID>
  <CustomerDID />
  <BCKey>0</BCKey>
  <CustomerTypeID>0</CustomerTypeID>
  <FirstName />
  <LastName />
  <MI />
  <Company />
  <Email />
  <PreferredCulture>0</PreferredCulture>
  <Password />
  <BillStreet1 />
  <BillStreet2 />
  <BillCity />
  <BillState />
  <BillPostalCode />
  <BillCountry />
  <BillCounty />
  <ShipStreet1 />
  <ShipStreet2 />
  <ShipCity />
  <ShipState />
  <ShipPostalCode />
  <ShipCountry />
  <ShipCounty />
  <Phone1 />
  <Phone2 />
  <Phone3 />
  <Phone4 />
  <Phone5 />
  <Phone6 />
  <TaxExemptCodeID />
  <TaxExempt>False</TaxExempt>
  <TaxID />
  <TaxID2 />
  <ReferralMarketTypeID />
  <ReferralMarketTypeInput />
  <ReferCustomerID />
  <CreatedBy />
  <PasswordResetKey />
  <PasswordResetExpirationDate />
  <DateOfBirth />
  <ApplicationDate>01/01/0001 00:00:00</ApplicationDate>
  <StatusTypeID>0</StatusTypeID>
  <ContactStatusID>0</ContactStatusID>
  <ReciprocalRepID />
  <LastModifiedBy />
  <DateLastModified />
  <RomanizedName />
  <TaxExemptReasonTypeID />
  <UpgradeRepID />
  <PhonesComputed />
  <CreatedDate>01/01/0001 00:00:00</CreatedDate>
  <guid />
  <AccountNumber />
  <Gender />
  <EmailOptOut_Company>False</EmailOptOut_Company>
  <EmailOptOut_Upline>False</EmailOptOut_Upline>
</Customer>

application/json, text/json

Sample:
{
  "CustomerID": 0,
  "BCKey": 0,
  "CustomerTypeID": 0,
  "PreferredCulture": 0,
  "TaxExempt": false,
  "ApplicationDate": "0001-01-01T00:00:00",
  "StatusTypeID": 0,
  "ContactStatusID": 0,
  "CreatedDate": "0001-01-01T00:00:00",
  "EmailOptOut_Company": false,
  "EmailOptOut_Upline": false
}