Customers
API change historyProvides methods for working with customer objects and data.
Submit Enrollment Form
This method provides an aggregate process for:
- Creating a new Customer
- Placing an initial Order
- Enrolling the new Customer in the Autoship process (optional)
It also places the new Customer within the proper position in commission plan.
Date + Time format
Year-Month-Day'T'MilitaryTimeHour:Minute:Second
- Ex. 2018-10-30T15:47:52
NOTE: Because of the number of steps in this process the latency for this call can be extremely high. It may take 10 to 15 seconds depending on the implementation and complexity of the client's commission plan.
Request
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
NOTE:This request creates a customer, an order, and an autoship. For this to work, you'll need to change the item codes to match what's in your system, along with sponsor ID and payment information.
For the required fields, calls are provided to see examples of the values the variables should be.
Required Fields:
- Order
- ShipMethodID
- Orders: Get Shipping Methods
- StoreID
- Products: Get Stores
- CurrencyCode
- Get Regions displays the country/state codes of the warehouses. If you are concerned about having the proper CurrencyCode, then this will allow you to know what region warehouse support team to call to get the confirmed CurrencyCode.
- ShipMethodID
- Items
- ItemID
- Products: Get Item by SKU
- Products: Get Items by Filter
- Quantity
- ItemID
- Payments
- CurrencyCode
- Get Regions displays the country/state codes of the warehouses. If you are concerned about having the proper CurrencyCode, then this will allow you to know what region warehouse support team to call to get the confirmed CurrencyCode.
- MerchantId
- Get Payment Merchants
- OrderCreditCard
- ExpirationMonth
- CurrencyCode
- AutoShip
- StartDate
- ShipMethodID
- Orders: Get Shipping Methods
- Items
- ItemID
- Products: Get Item by SKU
- Products: Get Items by Filter
- Quantity
- ItemID
- FirstName
- LastName
- Username
- Password
- ApplicantAddress
- Street1
- City
- Region
- PostalCode
- CountryCode
- AssociateBaseType
- SponsorID
- Get Customer
- Get Customer by Parameter
Uniqueness Required:
- TaxID
- Username
NOTE: Unique variables can be validated with our Validate API calls.
*AcceptTerms may not be required based on the logic surrounding CustomerType.
**At least one object must be present in the array.
{
"Order": {
"ShipMethodID": 1,
"StoreID": 1,
"CouponCodes": [
"EX_COUP"
],
"CurrencyCode": "usd",
"Items": [
{
"ItemID": 1,
"Quantity": 1,
"IsKit": false,
"CurrencyCode": "usd"
}
],
"Payments": [
{
"Amount": 29.59,
"SavePaymentMethodId": "1234-1234-asdf",
"OnFileCard": "DoNotSave",
"CurrencyCode": "usd",
"MerchantId": 99,
"RedirectUrl": "",
"SavePayment": true,
"OrderRewardPoints": {
"Amount": 0
},
"OrderCreditCard": {
"CardToken": "1234-1234-asdf",
"NameOnCard": "Sam Space",
"Last4": "4242",
"CardType": "visa",
"ExpirationMonth": 12,
"ExpirationYear": 25,
"CvvCode": "223",
"FirstSix": "424242"
}
}
],
"RequireSuccess": true,
"OrderCustom": {
"Field1": "test 1",
"Field2": "223",
"Field3": "test 3",
"Field4": "321",
"Field5": "test 5"
}
},
"AutoShip": {
"StartDate": "2021-10-14T00:00:00Z",
"Frequency": "Monthly",
"ShipMethodID": 1,
"Items": [
{
"ItemID": 1,
"Quantity": 1,
"IsKit": true,
"CurrencyCode": "usd"
}
],
"AutoshipCustom": {
"Field1": "test 1",
"Field2": "223",
"Field3": "test 3",
"Field4": "321",
"Field5": "test 5"
}
},
"AcceptTerms": true,
"CompanyName": "Test Company",
"FirstName": "Sam",
"LastName": "Space",
"RomanizedFirstName": "Sam",
"RomanizedLastName": "Space",
"LegalFirstName": "Sam",
"LegalLastName": "Space",
"TaxID": "555-55-5555",
"BirthDate": "2000-10-14T00:00:00Z",
"PrimaryPhone": "6546546544",
"SecondaryPhone": "3213213211",
"TextNumber": "9879879877",
"Email": "sam@directscaletest.com",
"Username": "samspace",
"Password": "Thi3Pa33word11",
"LanguageCode": "en",
"ApplicantAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Ste 350",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"ShippingAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Ste 350",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"AssociateBaseType": 1,
"SponsorID": 122,
"WebPageURL": "samspace",
"SendEmails": true,
"AssociateCustom": {
"Field1": "c1",
"Field2": "4433",
"Field3": "c2",
"Field4": "asdf|asdf",
"Field5": "111",
"Field6": "L",
"Field7": "22334",
"Field8": "2003-01-02T00:00:00Z",
"Field9": "0",
"Field10": ""
},
"PlacementOverrides": [
{
"TreeName": "Enrollment",
"CustomerId": 122,
"TreeIndex": 0,
"BaseLegName": ""
},
{
"TreeName": "Unilevel",
"CustomerId": 122,
"TreeIndex": 0,
"BaseLegName": ""
},
{
"TreeName": "Binary",
"CustomerId": 122,
"TreeIndex": 3,
"BaseLegName": "Right"
}
]
}
{
"type": "object",
"properties": {
"Order": {
"type": "object",
"properties": {
"ShipMethodID": {
"type": "integer"
},
"StoreID": {
"type": "integer"
},
"CouponCodes": {
"type": "array",
"items": {
"type": "string"
}
},
"CurrencyCode": {
"type": "string"
},
"Items": {
"type": "array",
"items": {
"required": [
"ItemID",
"Quantity",
"IsKit",
"CurrencyCode"
],
"type": "object",
"properties": {
"ItemID": {
"type": "integer"
},
"Quantity": {
"type": "integer"
},
"IsKit": {
"type": "boolean"
},
"CurrencyCode": {
"type": "string"
}
}
}
},
"Payments": {
"type": "array",
"items": {
"required": [
"Amount",
"OnFileCard",
"CurrencyCode",
"MerchantId",
"SavePayment"
],
"type": "object",
"properties": {
"Amount": {
"type": "number"
},
"SavePaymentMethodId": {
"type": "string"
},
"OnFileCard": {
"type": "string"
},
"CurrencyCode": {
"type": "string"
},
"MerchantId": {
"type": "integer"
},
"RedirectUrl": {
"type": "string"
},
"SavePayment": {
"type": "boolean"
},
"OrderRewardPoints": {
"type": "object",
"properties": {
"Amount": {
"type": "integer"
}
}
},
"OrderCreditCard": {
"type": "object",
"properties": {
"CardToken": {
"type": "string"
},
"NameOnCard": {
"type": "string"
},
"Last4": {
"type": "string"
},
"CardType": {
"type": "string"
},
"ExpirationMonth": {
"type": "integer"
},
"ExpirationYear": {
"type": "integer"
},
"CvvCode": {
"type": "string"
},
"FirstSix": {
"type": "string"
}
}
}
}
}
},
"RequireSuccess": {
"type": "boolean"
},
"OrderCustom": {
"type": "object",
"properties": {
"Field1": {
"type": "string"
},
"Field2": {
"type": "string"
},
"Field3": {
"type": "string"
},
"Field4": {
"type": "string"
},
"Field5": {
"type": "string"
}
}
}
}
},
"AutoShip": {
"type": "object",
"properties": {
"StartDate": {
"type": "string"
},
"Frequency": {
"type": "string"
},
"ShipMethodID": {
"type": "integer"
},
"Items": {
"type": "array",
"items": {
"required": [
"ItemID",
"Quantity",
"IsKit",
"CurrencyCode"
],
"type": "object",
"properties": {
"ItemID": {
"type": "integer"
},
"Quantity": {
"type": "integer"
},
"IsKit": {
"type": "boolean"
},
"CurrencyCode": {
"type": "string"
}
}
}
},
"AutoshipCustom": {
"type": "object",
"properties": {
"Field1": {
"type": "string"
},
"Field2": {
"type": "string"
},
"Field3": {
"type": "string"
},
"Field4": {
"type": "string"
},
"Field5": {
"type": "string"
}
}
}
}
},
"AcceptTerms": {
"type": "boolean"
},
"CompanyName": {
"type": "string"
},
"FirstName": {
"type": "string"
},
"LastName": {
"type": "string"
},
"RomanizedFirstName": {
"type": "string"
},
"RomanizedLastName": {
"type": "string"
},
"LegalFirstName": {
"type": "string"
},
"LegalLastName": {
"type": "string"
},
"TaxID": {
"type": "string"
},
"BirthDate": {
"type": "string"
},
"PrimaryPhone": {
"type": "string"
},
"SecondaryPhone": {
"type": "string"
},
"TextNumber": {
"type": "string"
},
"Email": {
"type": "string"
},
"Username": {
"type": "string"
},
"Password": {
"type": "string"
},
"LanguageCode": {
"type": "string"
},
"ApplicantAddress": {
"type": "object",
"properties": {
"Street1": {
"type": "string"
},
"Street2": {
"type": "string"
},
"City": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"Region": {
"type": "string"
},
"CountryCode": {
"type": "string"
}
}
},
"ShippingAddress": {
"type": "object",
"properties": {
"Street1": {
"type": "string"
},
"Street2": {
"type": "string"
},
"City": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"Region": {
"type": "string"
},
"CountryCode": {
"type": "string"
}
}
},
"AssociateBaseType": {
"type": "integer"
},
"SponsorID": {
"type": "integer"
},
"WebPageURL": {
"type": "string"
},
"SendEmails": {
"type": "boolean"
},
"AssociateCustom": {
"type": "object",
"properties": {
"Field1": {
"type": "string"
},
"Field2": {
"type": "string"
},
"Field3": {
"type": "string"
},
"Field4": {
"type": "string"
},
"Field5": {
"type": "string"
},
"Field6": {
"type": "string"
},
"Field7": {
"type": "string"
},
"Field8": {
"type": "string"
},
"Field9": {
"type": "string"
},
"Field10": {
"type": "string"
}
}
},
"PlacementOverrides": {
"type": "array",
"items": {
"required": [
"TreeName",
"CustomerId"
],
"type": "object",
"properties": {
"TreeName": {
"type": "string"
},
"CustomerId": {
"type": "integer"
},
"TreeIndex": {
"type": "integer"
},
"BaseLegName": {
"type": "string"
}
}
}
}
},
"example": {
"Order": {
"ShipMethodID": 1,
"StoreID": 1,
"CouponCodes": [
"EX_COUP"
],
"CurrencyCode": "usd",
"Items": [
{
"ItemID": 1,
"Quantity": 1,
"IsKit": false,
"CurrencyCode": "usd"
}
],
"Payments": [
{
"Amount": 29.59,
"SavePaymentMethodId": "1234-1234-asdf",
"OnFileCard": "DoNotSave",
"CurrencyCode": "usd",
"MerchantId": 99,
"RedirectUrl": "",
"SavePayment": true,
"OrderRewardPoints": {
"Amount": 0
},
"OrderCreditCard": {
"CardToken": "1234-1234-asdf",
"NameOnCard": "Sam Space",
"Last4": "4242",
"CardType": "visa",
"ExpirationMonth": 12,
"ExpirationYear": 25,
"CvvCode": "223",
"FirstSix": "424242"
}
}
],
"RequireSuccess": true,
"OrderCustom": {
"Field1": "test 1",
"Field2": "223",
"Field3": "test 3",
"Field4": "321",
"Field5": "test 5"
}
},
"AutoShip": {
"StartDate": "2021-10-14",
"Frequency": "Monthly",
"ShipMethodID": 1,
"Items": [
{
"ItemID": 1,
"Quantity": 1,
"IsKit": true,
"CurrencyCode": "usd"
}
],
"AutoshipCustom": {
"Field1": "test 1",
"Field2": "223",
"Field3": "test 3",
"Field4": "321",
"Field5": "test 5"
}
},
"AcceptTerms": true,
"CompanyName": "Test Company",
"FirstName": "Sam",
"LastName": "Space",
"RomanizedFirstName": "Sam",
"RomanizedLastName": "Space",
"LegalFirstName": "Sam",
"LegalLastName": "Space",
"TaxID": "555-55-5555",
"BirthDate": "2000-10-14",
"PrimaryPhone": "6546546544",
"SecondaryPhone": "3213213211",
"TextNumber": "9879879877",
"Email": "sam@directscaletest.com",
"Username": "samspace",
"Password": "Thi3Pa33word11",
"LanguageCode": "en",
"ApplicantAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Ste 350",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"ShippingAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Ste 350",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"AssociateBaseType": 1,
"SponsorID": 122,
"WebPageURL": "samspace",
"SendEmails": true,
"AssociateCustom": {
"Field1": "c1",
"Field2": "4433",
"Field3": "c2",
"Field4": "asdf|asdf",
"Field5": "111",
"Field6": "L",
"Field7": "22334",
"Field8": "1,2,3",
"Field9": "0",
"Field10": ""
},
"PlacementOverrides": [
{
"TreeName": "Enrollment",
"CustomerId": 122,
"TreeIndex": 0,
"BaseLegName": ""
},
{
"TreeName": "Unilevel",
"CustomerId": 122,
"TreeIndex": 0,
"BaseLegName": ""
},
{
"TreeName": "Binary",
"CustomerId": 122,
"TreeIndex": 3,
"BaseLegName": "Right"
}
]
}
}
{
"Order": {
"ShipMethodID": 2,
"StoreID": 1,
"CurrencyCode": "usd",
"Items": [
{
"ItemID": 17901,
"Quantity": 3
}
],
"Payments": [
{
"CurrencyCode": "usd",
"MerchantId": 99,
"OrderCreditCard": {
"ExpirationMonth": 2
}
}
]
},
"AutoShip": {
"StartDate": "2020-03-13T19:40:51.126Z",
"ShipMethodID": 3,
"Items": [
{
"ItemID": 17901,
"Quantity": 2
}
]
},
"FirstName": "John",
"LastName": "Doe Sr.",
"Email": "johndoe04@provider.com",
"Username": "J0nD0330",
"Password": "!SneakyJohnDoe1",
"ApplicantAddress": {
"Street1": "7432 Maytown Road",
"City": "Springfield",
"Region": "NT",
"PostalCode": "49007",
"CountryCode": "US"
},
"AssociateBaseType": 2,
"SponsorID": 2
}
Responses
201 Created
Signifies that the Customer Enrollment was created successfully.
Representations
{
"OrderStatus": {
"OrderNumber": 50316,
"Result": 0
},
"AssociateID": "1234qwer",
"FirstName": "FirstName",
"LastName": "LastName",
"Email": "testing@testing.directscale.com"
}
500 Internal Server Error
Something went wrong... Here are some possible reasons for this error:
- Is the model being sent to the API incorrect?
- Did you forget a required field?
- Is the API marked as deprecated, and the date has expired?
If the answer is "No" to all of these questions, DirectScale could be experiencing technical difficulties. Please contact your DirectScale representative if the issue persists.
Code samples
@ECHO OFF
curl -v -X POST "https://dsapi.directscale.com/v1/customers/enroll"
-H "Content-Type: application/json (full)"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://dsapi.directscale.com/v1/customers/enroll?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://dsapi.directscale.com/v1/customers/enroll");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json (full)");
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://dsapi.directscale.com/v1/customers/enroll?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json (full)");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://dsapi.directscale.com/v1/customers/enroll";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"application/json (full)" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://dsapi.directscale.com/v1/customers/enroll');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json (full)',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'application/json (full)',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('dsapi.directscale.com')
conn.request("POST", "/v1/customers/enroll?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'application/json (full)',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('dsapi.directscale.com')
conn.request("POST", "/v1/customers/enroll?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://dsapi.directscale.com/v1/customers/enroll')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json (full)'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body