Orders

Provides methods for working with order processing and settings.

Split Package

This API creates additional packages from an already-existing package.

It is important to note that the existing package will not be removed or replaced as a result of this call. Rather, some of the existing package's line items will be split off and will be assigned to the new packages specified.

Example Scenario

Let's say a given package (Package# 222) currently has 4 line items assigned to it with the following item ids: 3, 4, 22, and 19. Additionally, lets suppose that the 3PL working with this API wants to reassign items 4 and 22 to a single new package. This is what the process would look like:

The existingPackageId would be specified: 222
The newPackages array would contain one entry. This entry, among other specifications, would contain 2 item ids in the itemIds parameter: 4 and 22.
The 3PL would then send the request
The 3PL receives a response - an array of packages with 2 entries:
- The old package (Package# 222) that now only lists 2 line items associated with it (3 and 19)
- A new package (Package# 251) that lists 2 line items associated with it (4 and 22)

Try it

Request

Request URL

https://dsapi.directscale.com/v1/orders/packages/split/{packageId}

Request parameters

packageId

int

The ID of the Package to split

Request headers

Content-Type (optional)

string

Media type of the body sent to the API.
Ocp-Apim-Subscription-Key

string

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

Request body

application/json

Sample
Schema

[
  {
    "height": 12.5,
    "itemIds": [
      1,
      2
    ],
    "length": 16.75,
    "notes": "Deliver to door around back.",
    "shipByDate": "2020-11-11T00:00:00Z",
    "shipMethodId": 1,
    "shippingAddress": {
      "Street1": "1234 Test Dr.",
      "Street2": "Suite 225",
      "City": "Placerville",
      "PostalCode": "95667",
      "Region": "CA",
      "CountryCode": "US"
    },
    "shipToName": "Sam Space",
    "warehouseId": 1,
    "weight": 1,
    "width": 7.25
  },
  {
    "height": 10.75,
    "itemIds": [
      93
    ],
    "length": 10.75,
    "notes": "Deliver to door around back.",
    "shipByDate": "2020-11-11T00:00:00Z",
    "shipMethodId": 5,
    "shippingAddress": {
      "Street1": "1234 Test Dr.",
      "Street2": "Suite 225",
      "Street3": "",
      "City": "Placerville",
      "PostalCode": "95667",
      "Region": "CA",
      "CountryCode": "US"
    },
    "shipToName": "Sam Space",
    "warehouseId": 2,
    "weight": 1,
    "width": 7.25
  }
]

{
  "type": "array",
  "items": {
    "required": [
      "itemIds",
      "shipByDate",
      "shipMethodId",
      "shippingAddress",
      "shipToName",
      "warehouseId"
    ],
    "type": "object",
    "properties": {
      "height": {
        "type": "number"
      },
      "itemIds": {
        "type": "array",
        "items": {
          "type": "integer"
        }
      },
      "length": {
        "type": "number"
      },
      "notes": {
        "type": "string"
      },
      "shipByDate": {
        "type": "string"
      },
      "shipMethodId": {
        "type": "integer"
      },
      "shippingAddress": {
        "type": "object",
        "properties": {
          "Street1": {
            "type": "string"
          },
          "Street2": {
            "type": "string"
          },
          "Street3": {
            "type": "string"
          },
          "City": {
            "type": "string"
          },
          "PostalCode": {
            "type": "string"
          },
          "Region": {
            "type": "string"
          },
          "CountryCode": {
            "type": "string"
          }
        }
      },
      "shipToName": {
        "type": "string"
      },
      "warehouseId": {
        "type": "integer"
      },
      "weight": {
        "type": "integer"
      },
      "width": {
        "type": "number"
      }
    }
  },
  "example": [
    {
      "height": 12.5,
      "itemIds": [
        1,
        2
      ],
      "length": 16.75,
      "notes": "Deliver to door around back.",
      "shipByDate": "2020-11-11",
      "shipMethodId": 1,
      "shippingAddress": {
        "Street1": "1234 Test Dr.",
        "Street2": "Suite 225",
        "City": "Placerville",
        "PostalCode": "95667",
        "Region": "CA",
        "CountryCode": "US"
      },
      "shipToName": "Sam Space",
      "warehouseId": 1,
      "weight": 1,
      "width": 7.25
    },
    {
      "height": 10.75,
      "itemIds": [
        93
      ],
      "length": 10.75,
      "notes": "Deliver to door around back.",
      "shipByDate": "2020-11-11",
      "shipMethodId": 5,
      "shippingAddress": {
        "Street1": "1234 Test Dr.",
        "Street2": "Suite 225",
        "Street3": "",
        "City": "Placerville",
        "PostalCode": "95667",
        "Region": "CA",
        "CountryCode": "US"
      },
      "shipToName": "Sam Space",
      "warehouseId": 2,
      "weight": 1,
      "width": 7.25
    }
  ]
}

Responses

201 Created

The operation was executed successfully

Representations

application/json

Sample
Schema

[
  {
    "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 POST "https://dsapi.directscale.com/v1/orders/packages/split/{packageId}"
-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/split/{packageId}?" + 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.directscale.com/v1/orders/packages/split/{packageId}");


            URI uri = builder.build();
            HttpPost request = new HttpPost(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/split/{packageId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                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.directscale.com/v1/orders/packages/split/{packageId}";
    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" 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/split/{packageId}');
$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_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',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('dsapi.directscale.com')
    conn.request("POST", "/v1/orders/packages/split/{packageId}?%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("POST", "/v1/orders/packages/split/{packageId}?%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/split/{packageId}')

request = Net::HTTP::Post.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