Customers
API change historyProvides methods for working with customer objects and data.
Create Customer
Creates a new Customer based on a valid Customer object.
Date + Time format
Year-Month-Day'T'MilitaryTimeHour:Minute:Second
- Ex. 2018-10-30T15:47:52
Request
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
Required Fields (based on customerType):
- BirthDate (1)
- Get Customer
- CustomerType (1, 2, 3)
- Get Customer
- DefaultShippingAddress (1)
- street1
- PostalCode
- City
- CountryCode
- EmailAddress (1, 2, 3)
- Get Customer
- FirstName (1, 2, 3)
- Get Customer
- LastName (1, 2, 3)
- Get Customer
- Password (1, 2)
- PrimaryAddress (1, 2, 3)
- street1
- Region
- CountryCode
- SponsorId (1, 2, 3)
- Get Customer
- TaxId (1)
- Get Customer
- TermsAccepted (1)
- Username (1, 2, 3)
- Get Customer
Uniqueness Required:
- BackOfficeId
- EmailAddress
- TaxId
- Username
- WebAlias
NOTE: Unique variables can be validated with our Validate API calls.
Note: Many of the property's behaviors can be changed by the implementation of the commission plan to allow the property to be optional or have different uniqueness characteristics. Please contact your support representative for specific details.
{
"BackOfficeId": "15F963",
"BirthDate": "2000-10-14T00:00:00Z",
"CompanyName": "Test Company",
"CustomerStatus": 1,
"CustomerType": 1,
"DefaultShippingAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Ste 350",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"EmailAddress": "samespace@directscaletest.com",
"ExternalReferenceId": "111-aa",
"FirstName": "Sam",
"LanguageCode": "en",
"LastName": "Space",
"Password": "Pa33word1!",
"PrimaryAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Ste 350",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"PrimaryPhone": "6546546544",
"SecondaryPhone": "3213213211",
"SendEmails": true,
"SignUpDate": "2021-10-14T00:00:00Z",
"SponsorId": 122,
"TaxExempt": false,
"TaxExemptId": "555-55-5555",
"TaxId": "555-55-5555",
"TermsAccepted": true,
"TextPhone": "9879879877",
"Username": "samspace",
"WebAlias": "samspace",
"RomanizedFirstName": "Sam",
"RomanizedLastName": "Space",
"LegalFirstName": "Sam",
"LegalLastName": "Space",
"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": {
"BackOfficeId": {
"type": "string"
},
"BirthDate": {
"type": "string"
},
"CompanyName": {
"type": "string"
},
"CustomerStatus": {
"type": "integer"
},
"CustomerType": {
"type": "integer"
},
"DefaultShippingAddress": {
"type": "object",
"properties": {
"Street1": {
"type": "string"
},
"Street2": {
"type": "string"
},
"City": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"Region": {
"type": "string"
},
"CountryCode": {
"type": "string"
}
}
},
"EmailAddress": {
"type": "string"
},
"ExternalReferenceId": {
"type": "string"
},
"FirstName": {
"type": "string"
},
"LanguageCode": {
"type": "string"
},
"LastName": {
"type": "string"
},
"Password": {
"type": "string"
},
"PrimaryAddress": {
"type": "object",
"properties": {
"Street1": {
"type": "string"
},
"Street2": {
"type": "string"
},
"City": {
"type": "string"
},
"PostalCode": {
"type": "string"
},
"Region": {
"type": "string"
},
"CountryCode": {
"type": "string"
}
}
},
"PrimaryPhone": {
"type": "string"
},
"SecondaryPhone": {
"type": "string"
},
"SendEmails": {
"type": "boolean"
},
"SignUpDate": {
"type": "string"
},
"SponsorId": {
"type": "integer"
},
"TaxExempt": {
"type": "boolean"
},
"TaxExemptId": {
"type": "string"
},
"TaxId": {
"type": "string"
},
"TermsAccepted": {
"type": "boolean"
},
"TextPhone": {
"type": "string"
},
"Username": {
"type": "string"
},
"WebAlias": {
"type": "string"
},
"RomanizedFirstName": {
"type": "string"
},
"RomanizedLastName": {
"type": "string"
},
"LegalFirstName": {
"type": "string"
},
"LegalLastName": {
"type": "string"
},
"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": {
"BackOfficeId": "15F963",
"BirthDate": "2000-10-14",
"CompanyName": "Test Company",
"CustomerStatus": 1,
"CustomerType": 1,
"DefaultShippingAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Ste 350",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"EmailAddress": "samespace@directscaletest.com",
"ExternalReferenceId": "111-aa",
"FirstName": "Sam",
"LanguageCode": "en",
"LastName": "Space",
"Password": "Pa33word1!",
"PrimaryAddress": {
"Street1": "1234 Test Dr.",
"Street2": "Ste 350",
"City": "Placerville",
"PostalCode": "95667",
"Region": "CA",
"CountryCode": "US"
},
"PrimaryPhone": "6546546544",
"SecondaryPhone": "3213213211",
"SendEmails": true,
"SignUpDate": "2021-10-14",
"SponsorId": 122,
"TaxExempt": false,
"TaxExemptId": "555-55-5555",
"TaxId": "555-55-5555",
"TermsAccepted": true,
"TextPhone": "9879879877",
"Username": "samspace",
"WebAlias": "samspace",
"RomanizedFirstName": "Sam",
"RomanizedLastName": "Space",
"LegalFirstName": "Sam",
"LegalLastName": "Space",
"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"
}
]
}
}
{
"BirthDate": "1973-05-12T00:00:00Z",
"CustomerType": 1,
"DefaultShippingAddress": {
"Street1": "250 South 400 West",
"PostalCode": "84042",
"City": "Lindon",
"CountryCode": "US"
},
"EmailAddress": "yodaminch@testing.directscale.com",
"FirstName": "Minch",
"LastName": "Yoda",
"Password": "Password123!",
"PrimaryAddress": {
"Street1": "250 South 400 West",
"Region": "UT",
"CountryCode": "US"
},
"SponsorId": 2,
"TaxExempt": false,
"TaxId": "TAX-TEST-3333",
"TermsAccepted": true,
"Username": "YodaIAm"
}
{
"CustomerType": 2,
"EmailAddress": "darthsidious66@testing.directscale.com",
"FirstName": "Sheev",
"LastName": "Palpatine",
"Password": "Password123!",
"PrimaryAddress": {
"Street1": "250 South 400 West",
"Region": "UT",
"CountryCode": "US"
},
"SponsorId": 2,
"Username": "Emperor Palpatine"
}
{
"CustomerType": 3,
"EmailAddress": "bobafett@testing.directscale.com",
"FirstName": "Boba",
"LastName": "Fett",
"PrimaryAddress": {
"Street1": "250 South 400 West",
"Region": "UT",
"CountryCode": "US"
},
"SponsorId": 2
}
Responses
201 Created
Signifies that the Customer was created successfully.
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-stage.directscale.com/v1/customers/"
-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-stage.directscale.com/v1/customers/?" + 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-stage.directscale.com/v1/customers/");
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-stage.directscale.com/v1/customers/?" + $.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-stage.directscale.com/v1/customers/";
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-stage.directscale.com/v1/customers/');
$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-stage.directscale.com')
conn.request("POST", "/v1/customers/?%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-stage.directscale.com')
conn.request("POST", "/v1/customers/?%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-stage.directscale.com/v1/customers/')
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