Orders
API change historyProvides methods for working with order processing and settings.
Request
Request URL
Request parameters
-
integer
The ID of the warehouse from which to retrieve the packages
-
(optional)date/time string
Filters packages whose order's invoice date is the value specified or later. If left out/blank, the default value is today at midnight.
-
(optional)date/time string
Filters packages whose status is one the value(s) specified. Filters packages whose order's invoice date is the value specified or earlier. If left out/blank, the default value is the current date/time.
-
(optional)PackageStatus[]
Multiple values must be comma-separated. The default value is "NotSpecified", which will return packages of all PackageStatus types.
Request headers
Request body
Responses
200 OK
The operation was executed successfully
Representations
[
{
"ID": 687,
"CustomerID": "2",
"Address1": "350 S. 400 W.",
"Address2": "Ste 225",
"Carrier": "FedEx Freight",
"City": "Lindon",
"CountryCode": "US",
"Height": 0,
"Length": 0,
"Notes": "1 of 1",
"OrderNumber": 694,
"ShipByDate": "2020-08-04T15:04:50Z",
"PrintedDate": null,
"ShippedDate": null,
"ShipMethodID": 1,
"State": "UT",
"WarehouseID": 1,
"Weight": 1,
"Width": 0,
"Zip": "84042",
"ShipTo": "Sam Space",
"Status": "Submitted",
"TrackingNumber": "abc-123-def-456",
"Code": "",
"LineItems": [
{
"OrderLineItemId": 113,
"Amount": 10,
"Bonus": 0,
"CategoryId": 1,
"Cost": 0,
"CurrencyCode": "USD",
"Height": 0,
"Length": 0,
"OrderNumber": 694,
"PackageNumber": 687,
"Cv": 10,
"Qv": 10,
"Qty": 1,
"Sku": "TestSKU-383Q",
"ItemId": 58,
"ProductName": "ProductName-2HZN9U",
"Weight": 1,
"Width": 0,
"FlagCancer": false,
"FlagBirthDefects": false,
"HasKitGroups": false,
"Image": "/no_image.jpg"
}
]
}
]{
"type": "array",
"items": {
"type": "object",
"properties": {
"ID": {
"type": "integer"
},
"CustomerID": {
"type": "string"
},
"Address1": {
"type": "string"
},
"Address2": {
"type": "string"
},
"Carrier": {
"type": "string"
},
"City": {
"type": "string"
},
"CountryCode": {
"type": "string"
},
"Height": {
"type": "integer"
},
"Length": {
"type": "integer"
},
"Notes": {
"type": "string"
},
"OrderNumber": {
"type": "integer"
},
"ShipByDate": {
"type": "string"
},
"PrintedDate": {
"type": "string"
},
"ShippedDate": {
"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"
},
"TrackingNumber": {
"type": "string"
},
"Code": {
"type": "string"
},
"LineItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"OrderLineItemId": {
"type": "integer"
},
"Amount": {
"type": "integer"
},
"Bonus": {
"type": "integer"
},
"CategoryId": {
"type": "integer"
},
"Cost": {
"type": "integer"
},
"CurrencyCode": {
"type": "string"
},
"Height": {
"type": "integer"
},
"Length": {
"type": "integer"
},
"OrderNumber": {
"type": "integer"
},
"PackageNumber": {
"type": "integer"
},
"Cv": {
"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"
},
"FlagBirthDefects": {
"type": "boolean"
},
"HasKitGroups": {
"type": "boolean"
},
"Image": {
"type": "string"
}
}
}
}
}
},
"example": [
{
"ID": 687,
"CustomerID": "2",
"Address1": "350 S. 400 W.",
"Address2": "Ste 225",
"Carrier": "FedEx Freight",
"City": "Lindon",
"CountryCode": "US",
"Height": 0,
"Length": 0,
"Notes": "1 of 1",
"OrderNumber": 694,
"ShipByDate": "2020-08-04T15:04:50Z",
"PrintedDate": null,
"ShippedDate": null,
"ShipMethodID": 1,
"State": "UT",
"WarehouseID": 1,
"Weight": 1,
"Width": 0,
"Zip": "84042",
"ShipTo": "Sam Space",
"Status": "Submitted",
"TrackingNumber": "abc-123-def-456",
"Code": "",
"LineItems": [
{
"OrderLineItemId": 113,
"Amount": 10,
"Bonus": 0,
"CategoryId": 1,
"Cost": 0,
"CurrencyCode": "USD",
"Height": 0,
"Length": 0,
"OrderNumber": 694,
"PackageNumber": 687,
"Cv": 10,
"Qv": 10,
"Qty": 1,
"Sku": "TestSKU-383Q",
"ItemId": 58,
"ProductName": "ProductName-2HZN9U",
"Weight": 1,
"Width": 0,
"FlagCancer": false,
"FlagBirthDefects": false,
"HasKitGroups": false,
"Image": "/no_image.jpg"
}
]
}
]
}400 Bad Request
Returns one of an array of different error possibilities. Please refer to the error description for greater detail.
Code samples
@ECHO OFF
curl -v -X GET "https://dsapi-stage.directscale.com/v1/orders/packages?warehouseId={warehouseId}?invoiceStartDate={date/time string}&invoiceEndDate={date/time string}&packageStatuses={PackageStatus[]}"
-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["invoiceStartDate"] = "{date/time string}";
queryString["invoiceEndDate"] = "{date/time string}";
queryString["packageStatuses"] = "{PackageStatus[]}";
var uri = "https://dsapi-stage.directscale.com/v1/orders/packages?warehouseId={warehouseId}&" + 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/orders/packages?warehouseId={warehouseId}");
builder.setParameter("invoiceStartDate", "{date/time string}");
builder.setParameter("invoiceEndDate", "{date/time string}");
builder.setParameter("packageStatuses", "{PackageStatus[]}");
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
"invoiceStartDate": "{date/time string}",
"invoiceEndDate": "{date/time string}",
"packageStatuses": "{PackageStatus[]}",
};
$.ajax({
url: "https://dsapi-stage.directscale.com/v1/orders/packages?warehouseId={warehouseId}&" + $.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/orders/packages?warehouseId={warehouseId}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"invoiceStartDate={date/time string}",
@"invoiceEndDate={date/time string}",
@"packageStatuses={PackageStatus[]}",
];
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/orders/packages?warehouseId={warehouseId}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'invoiceStartDate' => '{date/time string}',
'invoiceEndDate' => '{date/time string}',
'packageStatuses' => '{PackageStatus[]}',
);
$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
'invoiceStartDate': '{date/time string}',
'invoiceEndDate': '{date/time string}',
'packageStatuses': '{PackageStatus[]}',
})
try:
conn = httplib.HTTPSConnection('dsapi-stage.directscale.com')
conn.request("GET", "/v1/orders/packages?warehouseId={warehouseId}&%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
'invoiceStartDate': '{date/time string}',
'invoiceEndDate': '{date/time string}',
'packageStatuses': '{PackageStatus[]}',
})
try:
conn = http.client.HTTPSConnection('dsapi-stage.directscale.com')
conn.request("GET", "/v1/orders/packages?warehouseId={warehouseId}&%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/orders/packages?warehouseId={warehouseId}')
query = URI.encode_www_form({
# Request parameters
'invoiceStartDate' => '{date/time string}',
'invoiceEndDate' => '{date/time string}',
'packageStatuses' => '{PackageStatus[]}'
})
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