ecomdash API

The ecomdash API allows third party software to integrate with the inventory management module of ecomdash.

Orders - Get Shipments Tied to an Order

Retrieve shipments and tracking information that are attached to a sales order

Try it

Request URL

Request parameters

number

The Sales Order ID (EcomdashId from the Sales Order GET operations)

Request headers

string

The API integration key from the ecomdash account. This can be found by an ecomdash customer in ecomdash under Administration --> Settings, on the "Tools" tab.

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

Request body

Response 200

This call, upon success will return all shipments, tracking information, and their details attached to an order.

{
  "status": "Success",
  "messages": [
    "Found 1 shipments associated with sales order 86988"
  ],
  "data": [
    {
      "Id": 7030820,
      "CompanyId": 934,
      "EcomdashOrderId": 86988,
      "ShipmentNumber": "118",
      "ShippedDate": "2016-11-18T16:28:01",
      "ShipToContactId": 197295,
      "Status": "Shipped",
      "ShipToContact": {
        "Id": 197295,
        "FullName": "James R Madison",
        "EmailAddress": "1F43A24K54E@marketplace.amazon.com",
        "BusinessPhone": "(919) 360-1205",
        "AddressId": 320840,
        "Address": {
          "Id": 320840,
          "Street1": "123 Main Street",
          "City": "Chapel Hill",
          "State": "NC",
          "Country": "US",
          "ZipCode": "27516",
          "IsResidential": false
        }
      },
      "Items": [
        {
          "Id": 8582907,
          "ShipmentId": 7030820,
          "OrderLineItemId": 150077,
          "QuantityShipped": 1,
          "IsShipped": true,
          "CompanyCarrier": {
            "Id": 366,
            "Name": "USPS (Endicia)"
          },
          "TrackingNumber": "9400110200881134582878",
          "CustomsValue": 8.99,
          "ProductId": 36928667,
          "ProductSku": "OFF1234RLWHT",
          "ProductName": "Dizzy Leather Cord Choker Necklace 10 inch"
        }
      ]
    }
  ]
}
{
  "title": "ResponseListShipment",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "status": {
      "type": "string"
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "pagination": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "CurrentPage": {
          "type": "integer",
          "format": "int32"
        },
        "TotalNumberOfEntries": {
          "type": "integer",
          "format": "int32"
        },
        "TotalNumberOfPages": {
          "type": "integer",
          "format": "int32"
        }
      }
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "Id": {
            "type": "number",
            "format": "decimal"
          },
          "CompanyId": {
            "type": "number",
            "format": "decimal"
          },
          "EcomdashOrderId": {
            "type": "number",
            "format": "decimal"
          },
          "Comments": {
            "type": "string"
          },
          "FulfillmentAction": {
            "type": "string"
          },
          "FulfillmentOrderNumber": {
            "type": "string"
          },
          "FulfillmentStatus": {
            "type": "string"
          },
          "FulfillmentStatusDate": {
            "type": "string",
            "format": "date-time"
          },
          "FulfillmentWarehouseId": {
            "type": "number",
            "format": "decimal"
          },
          "ShipmentNumber": {
            "type": "string"
          },
          "ShippedDate": {
            "type": "string",
            "format": "date-time"
          },
          "Status": {
            "type": "string",
            "description": "",
            "x-enumNames": [
              "Cancelled",
              "PartiallyShipped",
              "Shipped",
              "Unshipped"
            ],
            "enum": [
              "Cancelled",
              "PartiallyShipped",
              "Shipped",
              "Unshipped"
            ]
          },
          "ShipToContactId": {
            "type": "number",
            "format": "decimal"
          },
          "ShipToContact": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "Id": {
                "type": "number",
                "format": "decimal"
              },
              "CompanyName": {
                "type": "string"
              },
              "FullName": {
                "type": "string"
              },
              "FirstName": {
                "type": "string"
              },
              "LastName": {
                "type": "string"
              },
              "EmailAddress": {
                "type": "string"
              },
              "BusinessPhone": {
                "type": "string"
              },
              "MobilePhone": {
                "type": "string"
              },
              "FaxNumber": {
                "type": "string"
              },
              "AddressId": {
                "type": "number",
                "format": "decimal"
              },
              "Address": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "Id": {
                    "type": "number",
                    "format": "decimal"
                  },
                  "Street1": {
                    "type": "string"
                  },
                  "Street2": {
                    "type": "string"
                  },
                  "Street3": {
                    "type": "string"
                  },
                  "City": {
                    "type": "string"
                  },
                  "State": {
                    "type": "string"
                  },
                  "Country": {
                    "type": "string"
                  },
                  "ZipCode": {
                    "type": "string"
                  },
                  "UrbanizationCode": {
                    "type": "string"
                  },
                  "IsResidential": {
                    "type": "boolean"
                  }
                }
              }
            }
          },
          "Items": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "Id": {
                  "type": "number",
                  "format": "decimal"
                },
                "ShipmentId": {
                  "type": "number",
                  "format": "decimal"
                },
                "OrderLineItemId": {
                  "type": "number",
                  "format": "decimal"
                },
                "QuantityShipped": {
                  "type": "number",
                  "format": "decimal"
                },
                "IsShipped": {
                  "type": "boolean"
                },
                "Comments": {
                  "type": "string"
                },
                "CompanyCarrier": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "Id": {
                      "type": "number",
                      "format": "decimal"
                    },
                    "Name": {
                      "type": "string"
                    }
                  }
                },
                "TrackingNumber": {
                  "type": "string",
                  "x-nullable": true
                },
                "CustomsValue": {
                  "type": "number",
                  "format": "decimal"
                },
                "EstimatedDeliveryDate": {
                  "type": "string",
                  "format": "date-time"
                },
                "ProductId": {
                  "type": "number",
                  "format": "decimal"
                },
                "ProductSku": {
                  "type": "string"
                },
                "ProductName": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Response 403

If you have provided an invalid value for the header "ecd-subscription-key", you will receive a 403 FORBIDDEN response. This will happen for the following reasons:

  • The header, "ecd-subscription-key" was missing or it not found in the ecomdash databases
  • The header, "ecd-subscription-key" was found, but the company attached to it does not have a current ecomdash subscription.

{
  "Message": "The provided 'ecd-subscription-key' is not valid or does not belong to a company with a current ecomdash subscription."
}

Code samples

@ECHO OFF

curl -v -X GET "https://ecomdash.azure-api.net/api/orders/{orderId}/shipments"
-H "ecd-subscription-key: "
-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("ecd-subscription-key", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://ecomdash.azure-api.net/api/orders/{orderId}/shipments?" + 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://ecomdash.azure-api.net/api/orders/{orderId}/shipments");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("ecd-subscription-key", "");
            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://ecomdash.azure-api.net/api/orders/{orderId}/shipments?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("ecd-subscription-key","");
                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://ecomdash.azure-api.net/api/orders/{orderId}/shipments";
    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:@"" forHTTPHeaderField:@"ecd-subscription-key"];
    [_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://ecomdash.azure-api.net/api/orders/{orderId}/shipments');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'ecd-subscription-key' => '',
    '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
    'ecd-subscription-key': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('ecomdash.azure-api.net')
    conn.request("GET", "/api/orders/{orderId}/shipments?%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
    'ecd-subscription-key': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('ecomdash.azure-api.net')
    conn.request("GET", "/api/orders/{orderId}/shipments?%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://ecomdash.azure-api.net/api/orders/{orderId}/shipments')

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['ecd-subscription-key'] = ''
# 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