ecomdash API
The ecomdash API allows third party software to integrate with the inventory management module of ecomdash.
Request URL
Request headers
The API integration key from the ecomdash account. This can be found by an ecomdash customer in ecomdash by launching the relevant App Store application
Request body
Create new shipments for orders. This is the first step to be able to fulfill orders for ecomdash customers.
Attribute | Type / Valid Values | Requirement | Description |
---|---|---|---|
Array | Required | ||
OrderId | Integer | Required | The ecomdash OrderId that is a shipment is getting created for. |
LineItems | Array | Conditional |
Required if the order is already partially fulfilled or if the order already has other shipments tied to it. |
LineItems[i].LineItemId | Integer | Conditional |
Required if LineItems are passed in. The ecomdash LineItemId of the OrderLineItem. |
LineItems[i].Quantity | Integer | Optional |
How many items of the LineItem product will be in the shipment. If missing, the value of 'QuantityNotTiedToShipment' from the OrderLineItem will be used. |
[
{
"OrderId": 0.0,
"LineItems": [
{
"LineItemId": 0.0,
"Quantity": 0.0
}
]
}
]
{
"title": "ListOfCreateShipmentRequest",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"OrderId": {
"type": "number",
"format": "decimal"
},
"LineItems": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"LineItemId": {
"type": "number",
"format": "decimal"
},
"Quantity": {
"type": "number",
"format": "decimal"
}
}
}
}
}
}
}
Response 200
Upon completion of this call, you will get returned to you the status of each order requested. If shipments were successfully created, you will also receive the shipment information. You will need to use some of this data to later submit the tracking information.
{
"status": "Success",
"messages": [],
"pagination": null,
"data": [
{
"Request": {
"OrderId": 220,
"LineItems": []
},
"Shipment": {
"Id": 20404,
"CompanyId": 4,
"EcomdashOrderId": 220,
"Comments": null,
"ShipmentNumber": "145",
"ShippedDate": null,
"ShipToContactId": 43388,
"StatusInd": "U",
"ShipToContact": {
"Id": 43388,
"CompanyName": null,
"FullName": "John Smith",
"FirstName": null,
"LastName": null,
"EmailAddress": "abcdef@google.com",
"BusinessPhone": null,
"MobilePhone": null,
"FaxNumber": null,
"AddressId": 44061,
"Address": {
"Id": 44061,
"Street1": "3314 E 117th Street",
"Street2": "Apt A",
"Street3": null,
"City": "Charlotte",
"State": "NC",
"Country": "US",
"ZipCode": "28234",
"UrbanizationCode": null,
"IsResidential": false
}
},
"Items": [
{
"Id": 23920,
"ShipmentId": 20404,
"OrderLineItemId": 250,
"QuantityShipped": 1,
"ShippedInd": "N",
"Comments": null,
"CompanyCarrier": null,
"TrackingNumber": null,
"CustomsValue": 2,
"EstimatedDeliveryDate": null
}
]
},
"WasSuccessful": true,
"Messages": null
},
{
"Request": {
"OrderId": 193,
"LineItems": []
},
"Shipment": {
"Id": 20405,
"CompanyId": 4,
"EcomdashOrderId": 193,
"Comments": null,
"ShipmentNumber": "146",
"ShippedDate": null,
"ShipToContactId": 43389,
"StatusInd": "U",
"ShipToContact": {
"Id": 43389,
"CompanyName": "",
"FullName": "Mary Jones",
"FirstName": null,
"LastName": null,
"EmailAddress": "alphabet@microsoft.com",
"BusinessPhone": null,
"MobilePhone": null,
"FaxNumber": null,
"AddressId": 44062,
"Address": {
"Id": 44062,
"Street1": "789 Main St.",
"Street2": "Apt 87",
"Street3": null,
"City": "Harrisburg",
"State": "NC",
"Country": "US",
"ZipCode": "94566",
"UrbanizationCode": null,
"IsResidential": false
}
},
"Items": [
{
"Id": 23921,
"ShipmentId": 20405,
"OrderLineItemId": 219,
"QuantityShipped": 2,
"ShippedInd": "N",
"Comments": null,
"CompanyCarrier": null,
"TrackingNumber": null,
"CustomsValue": 0,
"EstimatedDeliveryDate": null
}
]
},
"WasSuccessful": true,
"Messages": null
}
]
}
{
"title": "ResponseListCreateShipmentResponse",
"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": {
"Request": {
"type": "object",
"additionalProperties": false,
"properties": {
"OrderId": {
"type": "number",
"format": "decimal"
},
"LineItems": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"LineItemId": {
"type": "number",
"format": "decimal"
},
"Quantity": {
"type": "number",
"format": "decimal"
}
}
}
}
}
},
"Shipment": {
"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"
}
},
"example": "{\r\n \"Name\": \"Test Carrier from API\"\r\n}"
},
"TrackingNumber": {
"type": "string",
"x-nullable": true
},
"TrackingURL": {
"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"
}
}
}
},
"Labels": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"Id": {
"type": "number",
"format": "decimal"
},
"ShipmentId": {
"type": "number",
"format": "decimal"
},
"CompanyCarrierId": {
"type": "number",
"format": "decimal"
},
"TotalCost": {
"type": "number",
"format": "decimal"
},
"InsuranceAmount": {
"type": "number",
"format": "decimal"
}
}
}
}
}
}
},
"allOf": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"WasSuccessful": {
"type": "boolean"
},
"Messages": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
}
}
}
}
Response 403
If you have provided invalid subscription data, you will receive a 403 FORBIDDEN response. This will happen for the following reasons:
- The "ecd-subscription-key" was missing or it not found in the ecomdash databases
- The "ecd-subscription-key" was found, but the company attached to it does not have a current ecomdash subscription.
{
"Message": "The provided 'ecd-subscription-key' / 'application-id' combination is not valid or does not belong to a company with a current ecomdash subscription."
}
Response 500
If you receive a 500 code response, something went wrong on ecomdash's side while trying to process your request.
{
"Message": "Oops, something went wrong while processing your request"
}
Code samples
@ECHO OFF
curl -v -X POST "https://ecomdash.azure-api.net/api/Shipments/Create"
-H "ecd-subscription-key: "
-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("ecd-subscription-key", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://ecomdash.azure-api.net/api/Shipments/Create?" + 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://ecomdash.azure-api.net/api/Shipments/Create");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("ecd-subscription-key", "");
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://ecomdash.azure-api.net/api/Shipments/Create?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("ecd-subscription-key","");
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://ecomdash.azure-api.net/api/Shipments/Create";
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:@"" forHTTPHeaderField:@"ecd-subscription-key"];
[_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://ecomdash.azure-api.net/api/Shipments/Create');
$url = $request->getUrl();
$headers = array(
// Request headers
'ecd-subscription-key' => '',
'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
'ecd-subscription-key': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('ecomdash.azure-api.net')
conn.request("POST", "/api/Shipments/Create?%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': '',
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('ecomdash.azure-api.net')
conn.request("POST", "/api/Shipments/Create?%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/Shipments/Create')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['ecd-subscription-key'] = ''
# 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