ecomdash API

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

Inventory - Get Products by SKU or UPC

Inventory - Get Products by SKU or UPC

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 under Administration --> Settings, on the "Tools" tab.

(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

You can currently retrieve products with a filter on SKU or UPC.

AttributeValid ValuesDescription
idType"sku"
"upc"
The type of ID the items in the "idList" represent
idListstring[]An array of strings representing the "idType" of products that are being sought

{
  "idType": "string",
  "idList": [
    "string"
  ]
}
{
  "title": "GetProductsBody",
  "type": "object",
  "required": [
    "idType",
    "idList"
  ],
  "additionalProperties": false,
  "properties": {
    "idType": {
      "type": "string"
    },
    "idList": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Response 200

Field Type / Values Description
data Product[] An array of product objects
data[i].Id decimal The ecomdash id for the product.
data[i].Sku string The sku of the for the product.
data[i].QuantityOnHand decimal The current quantity on hand for the product.
data[i].UPC string The UPC for the product.
data[i].Warehouses Warehouse[] An array of warehouses the product is in
data[i].Warehouses[j].ProductId decimal The Id of the product
data[i].Warehouses[j].WarehouseId Warehouse[] The Id of the warehouse
data[i].Warehouses[j].QuantityOnHand decimal The quantity on hand in the this warehouse
data[i].Warehouses[j].WarehouseSKU string The SKU used for this product in the warehouse
data[i].Warehouses[j].IsActive boolean Boolean to show if the warehouse is active for the product.
data[i].Warehouses[j].IncludeInSyncBalance boolean Boolean to show if the warehouse's quantity is used when sending new balances to storefronts.
status "Success" or "Error" Shows if the API call was a success or if an error was encountered.
messages string[] Array of messages. Primarily used for error or validation messages

{
  "status": "Success",
  "messages": [],
  "data": [
    {
      "Id": 41052937,
      "Sku": "ProductOne",
      "QuantityOnHand": 44,
      "Warehouses": [
        {
          "ProductId": 41052937,
          "WarehouseId": 3272,
          "QuantityOnHand": 4,
          "WarehouseSKU": "ProductOne",
          "IsActive": true,
          "IncludeInSyncBalance": true
        },
        {
          "ProductId": 41052937,
          "WarehouseId": 4865,
          "QuantityOnHand": 40,
          "WarehouseSKU": "ProductOne",
          "IsActive": true,
          "IncludeInSyncBalance": true
        }
      ]
    },
    {
      "Id": 41052972,
      "Sku": "ProductTwo",
      "QuantityOnHand": 24,
      "Warehouses": [
        {
          "ProductId": 41052972,
          "WarehouseId": 3272,
          "QuantityOnHand": 21,
          "WarehouseSKU": "ProductOne",
          "IsActive": true,
          "IncludeInSyncBalance": true
        },
        {
          "ProductId": 41052972,
          "WarehouseId": 4865,
          "QuantityOnHand": 3,
          "WarehouseSKU": "ProductOne",
          "IsActive": true,
          "IncludeInSyncBalance": true
        }
      ]
    }
  ]
}
{
  "title": "ResponseListProductBalance",
  "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": {
        "title": "ProductBalance",
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "Id": {
            "type": "integer",
            "format": "int32"
          },
          "Sku": {
            "type": "string"
          },
          "QuantityOnHand": {
            "type": "integer",
            "format": "int32"
          },
          "UPC": {
            "type": "string"
          },
          "Warehouses": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "ProductId": {
                  "type": "number",
                  "format": "decimal"
                },
                "WarehouseId": {
                  "type": "number",
                  "format": "decimal"
                },
                "QuantityOnHand": {
                  "type": "number",
                  "format": "decimal"
                },
                "WarehouseSKU": {
                  "type": "string"
                },
                "IsActive": {
                  "type": "boolean"
                },
                "IncludeInSyncBalance": {
                  "type": "boolean"
                }
              }
            }
          }
        }
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://ecomdash.azure-api.net/api/inventory/getProducts"
-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/inventory/getProducts?" + 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/inventory/getProducts");


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

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