Orders
API change historyProvides methods for working with order processing and settings.
Request
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
Currently, the only supported statuses are "NotSpecified", "Printed", and "Shipped". Any attempt to update a package or packages to a different status will result in an error. If the status is set to "Printed", the "printedDate" parameter will be used to set the Printed Date on the package. If the "printedDate" parameter does not contain a value, the current date/time will be used instead. The "Shipped" status works in a similar fashion.
If no status is provided, the status will default to "NotSpecified" and only the carrier info (Carrier and Tracking Number) will be updated.
[
{
"packageId": 1234,
"carrier": "FedEx",
"packageStatus": "Shipped",
"printedDate": "",
"shippedDate": "2020-08-11T22:04:34.802Z",
"trackingNumber": "asdf-1234-qwer-5678"
},
{
"packageId": 1235,
"carrier": "",
"packageStatus": "Printed",
"printedDate": "2020-08-11T22:04:35.107Z",
"shippedDate": "",
"trackingNumber": ""
}
]
{
"type": "array",
"items": {
"required": [
"packageId"
],
"type": "object",
"properties": {
"packageId": {
"type": "integer"
},
"carrier": {
"type": "string"
},
"packageStatus": {
"type": "string"
},
"printedDate": {
"type": "string"
},
"shippedDate": {
"type": "string"
},
"trackingNumber": {
"type": "string"
}
}
},
"example": [
{
"packageId": 1234,
"carrier": "FedEx",
"packageStatus": "Shipped",
"printedDate": "",
"shippedDate": "2020-08-11T22:04:34.802Z",
"trackingNumber": "asdf-1234-qwer-5678"
},
{
"packageId": 1235,
"carrier": "",
"packageStatus": "Printed",
"printedDate": "2020-08-11T22:04:35.107Z",
"shippedDate": "",
"trackingNumber": ""
}
]
}
Responses
204 No Content
The operation was executed successfully.
400 Bad Request
Returns one of an array of different error possibilities. Please refer to the error description for greater detail.
Representations
[
{
"packageId": 1234,
"carrier": "FedEx",
"packageStatus": "Shipped",
"printedDate": "",
"shippedDate": "2020-08-11T22:04:34.802Z",
"trackingNumber": "asdf-1234-qwer-5678"
},
{
"packageId": 1235,
"carrier": "",
"packageStatus": "Printed",
"printedDate": "2020-08-11T22:04:35.107Z",
"shippedDate": "",
"trackingNumber": ""
}
]
{
"type": "array",
"items": {
"required": [
"packageId"
],
"type": "object",
"properties": {
"packageId": {
"type": "integer"
},
"carrier": {
"type": "string"
},
"packageStatus": {
"type": "string"
},
"printedDate": {
"type": "string"
},
"shippedDate": {
"type": "string"
},
"trackingNumber": {
"type": "string"
}
}
},
"example": [
{
"packageId": 1234,
"carrier": "FedEx",
"packageStatus": "Shipped",
"printedDate": "",
"shippedDate": "2020-08-11T22:04:34.802Z",
"trackingNumber": "asdf-1234-qwer-5678"
},
{
"packageId": 1235,
"carrier": "",
"packageStatus": "Printed",
"printedDate": "2020-08-11T22:04:35.107Z",
"shippedDate": "",
"trackingNumber": ""
}
]
}
Code samples
@ECHO OFF
curl -v -X PUT "https://dsapi.directscale.com/v1/orders/packages/batch/package-status"
-H "Content-Type: application/json"
-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/orders/packages/batch/package-status?" + 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.PutAsync(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/orders/packages/batch/package-status");
URI uri = builder.build();
HttpPut request = new HttpPut(uri);
request.setHeader("Content-Type", "application/json");
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/orders/packages/batch/package-status?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "PUT",
// 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/orders/packages/batch/package-status";
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:@"PUT"];
// Request headers
[_request setValue:@"application/json" 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/orders/packages/batch/package-status');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_PUT);
// 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',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('dsapi.directscale.com')
conn.request("PUT", "/v1/orders/packages/batch/package-status?%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',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('dsapi.directscale.com')
conn.request("PUT", "/v1/orders/packages/batch/package-status?%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/orders/packages/batch/package-status')
request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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