ecomdash API

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

Shipments - Submit Tracking Info

Shipments - Submit Tracking Info

Try it

Request URL

Request headers

string

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

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

Submit shipment tracking information to ecomdash.

Attribute Type / Valid Values Requirement Description
Array of Items Required
ShipmentId Integer Required The ecomdash ShipmentId that was given in the results of the /shipments/create call.
CarrierId Integer Optional

The Id of the company's carrier that this was sent with. In order for a marketplaces to be notified which carrier was used in the shipments, this will have to be passed in.

The list of shipping carriers a company has setup can be retrieved using the call /carriers
TrackingNumber string Conditional

Required if LineItems are not passed in. This is the shipping tracking number to associate with the shipment.
ShippedDate DateTime Optional The date or date/time the shipment was shipped.
EstimatedDeliveryDate DateTime Optional The date or date/time the shipment is expected to arrive at its destination.
LineItems Array Conditional

If tracking numbers, estimated delivery dates or if everything has not been shipped, you must send information using LineItems

If you do not send information in LineItems, it will be assumed that ALL remaining items in the shipment have been sent with the information at the base of the request.

LineItems[i].LineItemId Integer Required The ecomdash ShipmentItem Id that was given in the results of the /shipments/create call.
LineItems[i].CarrierId Integer Optional

The Id of the company's carrier that this was sent with. In order for a marketplaces to be notified which carrier was used in the shipments, this will have to be passed in.

If this is missing, but the base request has a CarrierId, the base request CarrierId will be used.

The list of shipping carriers a company has setup can be retrieved using the call /carriers
LineItems[i].TrackingNumber string Conditional

Required if the base request is missing a TrackingNumber.

If this is missing, but the base request has a TrackingNumber, the base request TrackingNumber will be used.
LineItems[i].TrackingURL string Optional A URL to view carrier tracking information
LineItems[i].EstimatedDeliveryDate DateTime Optional The date or date/time the shipment is expected to arrive at its destination. 

[
  {
    "ShipmentId": 0.0,
    "CarrierId": 0.0,
    "TrackingNumber": "string",
    "TrackingURL": "string",
    "ShippedDate": "string",
    "EstimatedDeliveryDate": "string",
    "LineItems": [
      {
        "LineItemId": 0.0,
        "CarrierId": 0.0,
        "TrackingNumber": "string",
        "TrackingURL": "string",
        "EstimatedDeliveryDate": "string"
      }
    ]
  }
]
{
  "title": "ListOfFulfillmentRequest",
  "type": "array",
  "items": {
    "type": "object",
    "additionalProperties": false,
    "properties": {
      "ShipmentId": {
        "type": "number",
        "format": "decimal"
      },
      "CarrierId": {
        "type": "number",
        "format": "decimal"
      },
      "TrackingNumber": {
        "type": "string"
      },
      "TrackingURL": {
        "type": "string"
      },
      "ShippedDate": {
        "type": "string",
        "format": "date-time"
      },
      "EstimatedDeliveryDate": {
        "type": "string",
        "format": "date-time"
      },
      "LineItems": {
        "type": "array",
        "items": {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "LineItemId": {
              "type": "number",
              "format": "decimal"
            },
            "CarrierId": {
              "type": "number",
              "format": "decimal"
            },
            "TrackingNumber": {
              "type": "string"
            },
            "TrackingURL": {
              "type": "string"
            },
            "EstimatedDeliveryDate": {
              "type": "string",
              "format": "date-time"
            }
          }
        }
      }
    }
  }
}

Response 200

You will receive in return information if, per shipment, your shipments were updated successfully.

{
  "status": "Success",
  "messages": [],
  "pagination": null,
  "data": [
    {
      "Request": {
        "ShipmentId": 20405,
        "CarrierId": null,
        "TrackingNumber": "ABC123XYZ",
        "ShippedDate": "2016-07-18T12:57:33",
        "EstimatedDeliveryDate": "2016-07-21T00:00:00",
        "LineItems": []
      },
      "WasSuccessful": true,
      "Messages": null
    },
    {
      "Request": {
        "ShipmentId": 20404,
        "CarrierId": null,
        "TrackingNumber": "XYZ123XYZ",
        "ShippedDate": "2016-07-18T12:57:33",
        "EstimatedDeliveryDate": "2016-07-21T00:00:00",
        "LineItems": []
      },
      "WasSuccessful": true,
      "Messages": null
    }
  ]
}
{
  "title": "ResponseListUpdateShipmentResponse",
  "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": {
              "ShipmentId": {
                "type": "number",
                "format": "decimal"
              },
              "CarrierId": {
                "type": "number",
                "format": "decimal"
              },
              "TrackingNumber": {
                "type": "string"
              },
              "TrackingURL": {
                "type": "string"
              },
              "ShippedDate": {
                "type": "string",
                "format": "date-time"
              },
              "EstimatedDeliveryDate": {
                "type": "string",
                "format": "date-time"
              },
              "LineItems": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "LineItemId": {
                      "type": "number",
                      "format": "decimal"
                    },
                    "CarrierId": {
                      "type": "number",
                      "format": "decimal"
                    },
                    "TrackingNumber": {
                      "type": "string"
                    },
                    "TrackingURL": {
                      "type": "string"
                    },
                    "EstimatedDeliveryDate": {
                      "type": "string",
                      "format": "date-time"
                    }
                  }
                }
              }
            }
          }
        },
        "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/submitTrackingInfo"
-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/submitTrackingInfo?" + 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/submitTrackingInfo");


            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/submitTrackingInfo?" + $.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/submitTrackingInfo";
    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/submitTrackingInfo');
$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/submitTrackingInfo?%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/submitTrackingInfo?%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/submitTrackingInfo')

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