Customers
API change historyProvides methods for working with customer objects and data.
Get Customer Orders
Retrieves an array of Orders based on a valid Customer Id.
You can get the Request Parameter at these calls:
customerId
- Get Customer IDs
- Get Customer IDs by Filter
Request
Request URL
Request parameters
-
number
The Id of the Customer for whom Orders are to be retrieved.
Request headers
Request body
Responses
200 OK
Returns an array of valid Order objects.
Representations
[
{
"BillPhone": "+1 555 555 1111",
"CommissionDate": "2015-05-11T00:00:00Z",
"DistributorID": 2,
"Email": "testing@testing.directscale.com",
"InvoiceDate": "2015-05-11T00:00:00Z",
"LocalInvoiceNumber": 1234,
"Name": "Testing Name",
"OrderDate": "2015-05-11T00:00:00Z",
"OrderType": 1,
"OrderTypeDescription": "Test Description",
"OrderNumber": 18,
"SpecialInstructions": "Special Instructions here...",
"Status": "Paid",
"TotalBonus": 12,
"TotalCost": 120,
"TotalCV": 1,
"TotalRewardPoints": 5,
"TotalQV": 1,
"Void": false,
"BillAddress": {
"ID": 3214,
"Line1": "1234 Testing Wy.",
"Line2": null,
"Line3": null,
"City": "Elko",
"State": "NV",
"Zip": "55487",
"CountryCode": "US"
},
"IsPaid": true,
"IsShipped": false,
"LineItems": [
{
"Amount": 25.5,
"Bonus": 0,
"Cost": 0,
"CurrencyCode": "USD",
"Height": 0,
"Length": 0,
"OrderNumber": 18,
"PackageNumber": 15,
"CV": 0,
"RewardPoints": 5,
"QV": 0,
"Qty": 1,
"SKU": "TDLARCH",
"ItemID": 6,
"ProductName": "Turtle Arch",
"Weight": 0,
"Width": 0,
"FlagCancer": false,
"FlagBirthDefect": false
}
],
"Packages": [
{
"ID": 15,
"CustomerID": "233F7-16",
"Address1": 3214,
"Address2": null,
"Carrier": "FedEx",
"City": "Elko",
"CountryCode": "US",
"Height": 0,
"Length": 0,
"Notes": "Special Instructions here...",
"OrderNumber": 18,
"ShipByDate": "2015-05-11T00:00:00Z",
"ShipMethodID": 1,
"State": "NV",
"WarehouseID": 1,
"Weight": 0,
"Width": 0,
"Zip": "55487",
"ShipTo": "Test Name",
"Status": "Submitted"
}
],
"Totals": [
{
"TaxableSubTotal": 18.5,
"CurrencyCode": "USD",
"ExchangeRate": 1,
"OrderNumber": 18,
"Shipping": 7,
"SubTotal": 25.5,
"Tax": 1.67,
"TaxTransactionID": "",
"DiscountTotal": 0,
"OverridenShippingTax": false,
"Total": 27.17,
"PaidAmount": 27.17,
"TotalDue": 0
}
],
"Payments": [
{
"Amount": 27.17,
"AuthorizationNumber": "asdf1234",
"TransactionNumber": "asdfw56",
"CurrencyCode": "USD",
"ExchangeRate": 1,
"Merchant": 12,
"OrderNumber": 18,
"PayDate": "2015-05-11T00:00:00Z",
"PaymentResponse": "0: Success",
"PayType": "Cash",
"Reference": "",
"Status": "Paid"
}
],
"OrderCustom": {
"Field1": "Fields 1-5",
"Field5": "Here"
}
}
]{
"type": "array",
"items": {
"required": [
"BillPhone",
"CommissionDate",
"DistributorID",
"Email",
"InvoiceDate",
"LocalInvoiceNumber",
"Name",
"OrderDate",
"OrderType",
"OrderTypeDescription",
"OrderNumber",
"SpecialInstructions",
"Status",
"TotalBonus",
"TotalCost",
"TotalCV",
"TotalRewardPoints",
"TotalQV",
"Void",
"BillAddress",
"IsPaid",
"IsShipped",
"LineItems",
"Packages",
"Totals",
"Payments",
"OrderCustom"
],
"type": "object",
"properties": {
"BillPhone": {
"type": "string"
},
"CommissionDate": {
"type": "string"
},
"DistributorID": {
"type": "integer"
},
"Email": {
"type": "string"
},
"InvoiceDate": {
"type": "string"
},
"LocalInvoiceNumber": {
"type": "integer"
},
"Name": {
"type": "string"
},
"OrderDate": {
"type": "string"
},
"OrderType": {
"type": "integer"
},
"OrderTypeDescription": {
"type": "string"
},
"OrderNumber": {
"type": "integer"
},
"SpecialInstructions": {
"type": "string"
},
"Status": {
"type": "string"
},
"TotalBonus": {
"type": "integer"
},
"TotalCost": {
"type": "integer"
},
"TotalCV": {
"type": "integer"
},
"TotalRewardPoints": {
"type": "integer"
},
"TotalQV": {
"type": "integer"
},
"Void": {
"type": "boolean"
},
"BillAddress": {
"type": "object",
"properties": {
"ID": {
"type": "integer"
},
"Line1": {
"type": "string"
},
"Line2": {},
"Line3": {},
"City": {
"type": "string"
},
"State": {
"type": "string"
},
"Zip": {
"type": "string"
},
"CountryCode": {
"type": "string"
}
}
},
"IsPaid": {
"type": "boolean"
},
"IsShipped": {
"type": "boolean"
},
"LineItems": {
"type": "array",
"items": {
"required": [
"Amount",
"Bonus",
"Cost",
"CurrencyCode",
"Height",
"Length",
"OrderNumber",
"PackageNumber",
"CV",
"RewardPoints",
"QV",
"Qty",
"SKU",
"ItemID",
"ProductName",
"Weight",
"Width",
"FlagCancer",
"FlagBirthDefect"
],
"type": "object",
"properties": {
"Amount": {
"type": "number"
},
"Bonus": {
"type": "integer"
},
"Cost": {
"type": "integer"
},
"CurrencyCode": {
"type": "string"
},
"Height": {
"type": "integer"
},
"Length": {
"type": "integer"
},
"OrderNumber": {
"type": "integer"
},
"PackageNumber": {
"type": "integer"
},
"CV": {
"type": "integer"
},
"RewardPoints": {
"type": "integer"
},
"QV": {
"type": "integer"
},
"Qty": {
"type": "integer"
},
"SKU": {
"type": "string"
},
"ItemID": {
"type": "integer"
},
"ProductName": {
"type": "string"
},
"Weight": {
"type": "integer"
},
"Width": {
"type": "integer"
},
"FlagCancer": {
"type": "boolean"
},
"FlagBirthDefect": {
"type": "boolean"
}
}
}
},
"Packages": {
"type": "array",
"items": {
"required": [
"ID",
"CustomerID",
"Address1",
"Address2",
"Carrier",
"City",
"CountryCode",
"Height",
"Length",
"Notes",
"OrderNumber",
"ShipByDate",
"ShipMethodID",
"State",
"WarehouseID",
"Weight",
"Width",
"Zip",
"ShipTo",
"Status"
],
"type": "object",
"properties": {
"ID": {
"type": "integer"
},
"CustomerID": {
"type": "string"
},
"Address1": {
"type": "integer"
},
"Address2": {},
"Carrier": {
"type": "string"
},
"City": {
"type": "string"
},
"CountryCode": {
"type": "string"
},
"Height": {
"type": "integer"
},
"Length": {
"type": "integer"
},
"Notes": {
"type": "string"
},
"OrderNumber": {
"type": "integer"
},
"ShipByDate": {
"type": "string"
},
"ShipMethodID": {
"type": "integer"
},
"State": {
"type": "string"
},
"WarehouseID": {
"type": "integer"
},
"Weight": {
"type": "integer"
},
"Width": {
"type": "integer"
},
"Zip": {
"type": "string"
},
"ShipTo": {
"type": "string"
},
"Status": {
"type": "string"
}
}
}
},
"Totals": {
"type": "array",
"items": {
"required": [
"TaxableSubTotal",
"CurrencyCode",
"ExchangeRate",
"OrderNumber",
"Shipping",
"SubTotal",
"Tax",
"TaxTransactionID",
"DiscountTotal",
"OverridenShippingTax",
"Total",
"PaidAmount",
"TotalDue"
],
"type": "object",
"properties": {
"TaxableSubTotal": {
"type": "number"
},
"CurrencyCode": {
"type": "string"
},
"ExchangeRate": {
"type": "integer"
},
"OrderNumber": {
"type": "integer"
},
"Shipping": {
"type": "integer"
},
"SubTotal": {
"type": "number"
},
"Tax": {
"type": "number"
},
"TaxTransactionID": {
"type": "string"
},
"DiscountTotal": {
"type": "integer"
},
"OverridenShippingTax": {
"type": "boolean"
},
"Total": {
"type": "number"
},
"PaidAmount": {
"type": "number"
},
"TotalDue": {
"type": "integer"
}
}
}
},
"Payments": {
"type": "array",
"items": {
"required": [
"Amount",
"AuthorizationNumber",
"TransactionNumber",
"CurrencyCode",
"ExchangeRate",
"Merchant",
"OrderNumber",
"PayDate",
"PaymentResponse",
"PayType",
"Reference",
"Status"
],
"type": "object",
"properties": {
"Amount": {
"type": "number"
},
"AuthorizationNumber": {
"type": "string"
},
"TransactionNumber": {
"type": "string"
},
"CurrencyCode": {
"type": "string"
},
"ExchangeRate": {
"type": "integer"
},
"Merchant": {
"type": "integer"
},
"OrderNumber": {
"type": "integer"
},
"PayDate": {
"type": "string"
},
"PaymentResponse": {
"type": "string"
},
"PayType": {
"type": "string"
},
"Reference": {
"type": "string"
},
"Status": {
"type": "string"
}
}
}
},
"OrderCustom": {
"type": "object",
"properties": {
"Field1": {
"type": "string"
},
"Field5": {
"type": "string"
}
}
}
}
},
"example": [
{
"BillPhone": "+1 555 555 1111",
"CommissionDate": "2015-05-11T00:00:00Z",
"DistributorID": 2,
"Email": "testing@testing.directscale.com",
"InvoiceDate": "2015-05-11T00:00:00Z",
"LocalInvoiceNumber": 1234,
"Name": "Testing Name",
"OrderDate": "2015-05-11T00:00:00Z",
"OrderType": 1,
"OrderTypeDescription": "Test Description",
"OrderNumber": 18,
"SpecialInstructions": "Special Instructions here...",
"Status": "Paid",
"TotalBonus": 12,
"TotalCost": 120,
"TotalCV": 1,
"TotalRewardPoints": 5,
"TotalQV": 1,
"Void": false,
"BillAddress": {
"ID": 3214,
"Line1": "1234 Testing Wy.",
"Line2": null,
"Line3": null,
"City": "Elko",
"State": "NV",
"Zip": "55487",
"CountryCode": "US"
},
"IsPaid": true,
"IsShipped": false,
"LineItems": [
{
"Amount": 25.5,
"Bonus": 0,
"Cost": 0,
"CurrencyCode": "USD",
"Height": 0,
"Length": 0,
"OrderNumber": 18,
"PackageNumber": 15,
"CV": 0,
"RewardPoints": 5,
"QV": 0,
"Qty": 1,
"SKU": "TDLARCH",
"ItemID": 6,
"ProductName": "Turtle Arch",
"Weight": 0,
"Width": 0,
"FlagCancer": false,
"FlagBirthDefect": false
}
],
"Packages": [
{
"ID": 15,
"CustomerID": "2",
"Address1": 3214,
"Address2": null,
"Carrier": "FedEx",
"City": "Elko",
"CountryCode": "US",
"Height": 0,
"Length": 0,
"Notes": "Special Instructions here...",
"OrderNumber": 18,
"ShipByDate": "2015-05-11T00:00:00Z",
"ShipMethodID": 1,
"State": "NV",
"WarehouseID": 1,
"Weight": 0,
"Width": 0,
"Zip": "55487",
"ShipTo": "Test Name",
"Status": "Submitted"
}
],
"Totals": [
{
"TaxableSubTotal": 18.5,
"CurrencyCode": "USD",
"ExchangeRate": 1,
"OrderNumber": 18,
"Shipping": 7,
"SubTotal": 25.5,
"Tax": 1.67,
"TaxTransactionID": "",
"DiscountTotal": 0,
"OverridenShippingTax": false,
"Total": 27.17,
"PaidAmount": 27.17,
"TotalDue": 0
}
],
"Payments": [
{
"Amount": 27.17,
"AuthorizationNumber": "asdf1234",
"TransactionNumber": "asdfw56",
"CurrencyCode": "USD",
"ExchangeRate": 1,
"Merchant": 12,
"OrderNumber": 18,
"PayDate": "2015-05-11T00:00:00Z",
"PaymentResponse": "0: Success",
"PayType": "Cash",
"Reference": "",
"Status": "Paid"
}
],
"OrderCustom": {
"Field1": "Fields 1-5",
"Field5": "Here"
}
}
]
}404 Not Found
A Customer with the given Customer ID was not 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-stage.directscale.com/v1/customers/{customerId}/orders"
-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/{customerId}/orders?" + 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-stage.directscale.com/v1/customers/{customerId}/orders");
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
};
$.ajax({
url: "https://dsapi-stage.directscale.com/v1/customers/{customerId}/orders?" + $.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-stage.directscale.com/v1/customers/{customerId}/orders";
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:@"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-stage.directscale.com/v1/customers/{customerId}/orders');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$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({
})
try:
conn = httplib.HTTPSConnection('dsapi-stage.directscale.com')
conn.request("GET", "/v1/customers/{customerId}/orders?%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({
})
try:
conn = http.client.HTTPSConnection('dsapi-stage.directscale.com')
conn.request("GET", "/v1/customers/{customerId}/orders?%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/{customerId}/orders')
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