ecomdash API

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

Inventory - Find Products by Reference Id

Find a product in a company's inventory using the ReferenceID for a specific storefront instead of searching by SKU.

Try it

Request URL

Request parameters

number

The ID of the storefront used to search for the given referenceID

string

A referenceId is a SKU used for a product on a particular Storefront. It may be the same or different from the product's regular number.

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

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

Response 200

The base result will show success or failure with messages and if products were found, an array of products that were found with the ReferenceId for the given Storefront.

{
  "status": "Success",
  "messages": [
    "Found 1 products with a ReferenceID of 'ProductOne' in Storefront with an ID of 61938"
  ],
  "data": [
    {
      "Id": 41052937,
      "CompanyId": 17195,
      "Sku": "ProductOne",
      "Name": "Product One",
      "Notes": "",
      "ParentSku": "",
      "ChildSku": "",
      "TargetInventoryLevel": 20,
      "AverageCost": 0,
      "AverageLandedCost": 0,
      "Type": "Product",
      "QuantityOnHand": 44,
      "ReorderLevel": 15,
      "ReserveLevel": 2,
      "Identifiers": {
        "ProductId": 41052937,
        "UPC": "013139510999"
      },
      "IsActive": true,
      "IsAutoSyncEnabled": false,
      "IsDiscontinued": false,
      "IsDropshipped": false,
      "IsFireArm": false,
      "IsVariation": false,
      "Storefronts": [
        {
          "ProductId": 41052937,
          "StorefrontId": 61938,
          "AvailableQuantity": 999,
          "ReferenceId": "ProductOne",
          "DoNotList": false,
          "DoSyncAvailableQty": false
        }
      ]
    }
  ]
}

Response 400

If the referenceId is missing or empty or the storefrontId is missing or less than or equal to zero, a 400 - Bad Request response will be returned.

{
  "Message": "The ReferenceId and StorefrontId are both required fields.  Please refer to the documentation for the proper format."
}

Response 403

A 403 Forbidden response is returned when we cannot find an active ecomdash customer using the information you passed in the header value "ecd-subscription-key" or if the "ecd-subscription-key" header is missing.

{
  "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 GET "https://ecomdash.azure-api.net/api/inventory/SearchWithReferenceId?storefrontId={storefrontId}&referenceId={referenceId}"
-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/inventory/SearchWithReferenceId?storefrontId={storefrontId}&referenceId={referenceId}&" + 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/inventory/SearchWithReferenceId?storefrontId={storefrontId}&referenceId={referenceId}");


            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/inventory/SearchWithReferenceId?storefrontId={storefrontId}&referenceId={referenceId}&" + $.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/inventory/SearchWithReferenceId?storefrontId={storefrontId}&referenceId={referenceId}";
    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/inventory/SearchWithReferenceId?storefrontId={storefrontId}&referenceId={referenceId}');
$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/inventory/SearchWithReferenceId?storefrontId={storefrontId}&referenceId={referenceId}&%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/inventory/SearchWithReferenceId?storefrontId={storefrontId}&referenceId={referenceId}&%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/inventory/SearchWithReferenceId?storefrontId={storefrontId}&referenceId={referenceId}')

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