Customers

API change history

Provides methods for working with customer objects and data.

Get Customers By Parameter

Retrieves an array of Customers based on a valid parameter of choice.

Note: This API allows for multiple parameters, however only one parameter should be passed to the API at any given time, as only one will be honored.

You can get the Request Parameters at this call:

  • Get Customer

NOTE: Do not include spaces between words.

  • Format: FirstnameLastname
    • Ex. SamSpace

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    The Back Office ID of the Customer(s) to retrieve.

  • (optional)
    string

    The External Reference ID of the Customer(s) to retrieve.

  • (optional)
    string

    The Email Address of the Customer(s) to retrieve.

  • (optional)
    string

    The Username of the Customer(s) to retrieve.

  • (optional)
    string

    The Web Alias of the Customer(s) to retrieve.

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Returns an array of valid Customer objects.

Representations

[
  {
    "CustomerId": 2,
    "BackOfficeId": "ABC123",
    "BirthDate": "1988-04-01T00:00:00Z",
    "CompanyName": "Test Company Name",
    "CustomerStatus": 1,
    "CustomerType": 1,
    "DefaultShippingAddress": {
      "AddressId": 15714,
      "Street1": "7432 Maytown Road",
      "Street2": "",
      "Street3": "",
      "City": "Springfield",
      "Region": "NT",
      "PostalCode": "49007",
      "CountryCode": "US"
    },
    "EmailAddress": "testing@testing.directscale.com",
    "EnrollerId": 2,
    "ExternalReferenceId": "TEST123",
    "FirstName": "TestFirst",
    "InactiveDate": "1900-01-01T00:00:00Z",
    "LanguageCode": "EN",
    "LastName": "TestLast",
    "PrimaryAddress": {
      "AddressId": 15714,
      "Street1": "7432 Maytown Road",
      "Street2": "",
      "Street3": "",
      "City": "Springfield",
      "Region": "NT",
      "PostalCode": "49007",
      "CountryCode": "US"
    },
    "PrimaryPhone": "+1 555 555 1111",
    "SecondaryPhone": "+1 555 555 2222",
    "SendEmails": false,
    "SignupDate": "2014-10-30T00:00:00Z",
    "SponsorId": 1,
    "TaxExemptId": "11-ASDF-1234",
    "TaxId": "152-55-6765",
    "TermsAccepted": true,
    "TextPhone": "+1 555 555 1111",
    "Username": "myUsername",
    "WebAlias": "hello-world-web-alias"
  }
]

404 Not Found

No Customers with the given parameter were found.

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 GET "https://dsapi.directscale.com/v1/customers/?backofficeid={string}&externalreferenceid={string}&email={string}&username={string}&webalias={string}"
-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}");

            // Request parameters
            queryString["backofficeid"] = "{string}";
            queryString["externalreferenceid"] = "{string}";
            queryString["email"] = "{string}";
            queryString["username"] = "{string}";
            queryString["webalias"] = "{string}";
            var uri = "https://dsapi.directscale.com/v1/customers/?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // 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/");

            builder.setParameter("backofficeid", "{string}");
            builder.setParameter("externalreferenceid", "{string}");
            builder.setParameter("email", "{string}");
            builder.setParameter("username", "{string}");
            builder.setParameter("webalias", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            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
            "backofficeid": "{string}",
            "externalreferenceid": "{string}",
            "email": "{string}",
            "username": "{string}",
            "webalias": "{string}",
        };
      
        $.ajax({
            url: "https://dsapi.directscale.com/v1/customers/?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // 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/";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"backofficeid={string}",
                         @"externalreferenceid={string}",
                         @"email={string}",
                         @"username={string}",
                         @"webalias={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_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/');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'backofficeid' => '{string}',
    'externalreferenceid' => '{string}',
    'email' => '{string}',
    'username' => '{string}',
    'webalias' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// 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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'backofficeid': '{string}',
    'externalreferenceid': '{string}',
    'email': '{string}',
    'username': '{string}',
    'webalias': '{string}',
})

try:
    conn = httplib.HTTPSConnection('dsapi.directscale.com')
    conn.request("GET", "/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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'backofficeid': '{string}',
    'externalreferenceid': '{string}',
    'email': '{string}',
    'username': '{string}',
    'webalias': '{string}',
})

try:
    conn = http.client.HTTPSConnection('dsapi.directscale.com')
    conn.request("GET", "/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.directscale.com/v1/customers/')

query = URI.encode_www_form({
    # Request parameters
    'backofficeid' => '{string}',
    'externalreferenceid' => '{string}',
    'email' => '{string}',
    'username' => '{string}',
    'webalias' => '{string}'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Get.new(uri.request_uri)
# 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