ecomdash API

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

Listing Templates - Create

Create a new listing template for a storefront.

Try it

Request URL

Request parameters

number

The ID of the storefront the listing template is being created for.

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

The product being added is represented as JSON in the body of the HTTP request, below are definitions of the properties of the product.
Attribute Type / Valid Values Requirement Description
Name string Required The name of the new listing template.
Body string Required The body of the new listing template.

{
  "Id": 0.0,
  "StorefrontId": 0.0,
  "Name": "string",
  "Body": "string"
}
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "Id": {
      "type": "number",
      "format": "decimal"
    },
    "StorefrontId": {
      "type": "number",
      "format": "decimal"
    },
    "Name": {
      "type": "string"
    },
    "Body": {
      "type": "string"
    }
  }
}

Response 200

A 200 will be returned in two cases:

  • The template was created successfully
  • Data wasn't bad enough for a 403 code, but either the Name or Body was missing from the request. The ListingTemplate in the results will be empty and validation messages will be populated in the Messages property.

{
  "ListingTemplate": {
    "Id": 3126,
    "StorefrontId": 61938,
    "Name": "Test Three",
    "Body": "<p class=\"testClass\">\r\nThis is some sample Html for the <a href=\"http://lmgtfy.com/?s=b&q=ecomdash+api+developer+portal\">API documentation</a>.  \r\n</p>"
  },
  "WasSuccessful": true,
  "Messages": []
}
{
  "title": "CreateListingTemplateResponse",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "ListingTemplate": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "Id": {
          "type": "number",
          "format": "decimal"
        },
        "StorefrontId": {
          "type": "number",
          "format": "decimal"
        },
        "Name": {
          "type": "string"
        },
        "Body": {
          "type": "string"
        }
      }
    }
  },
  "allOf": [
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "WasSuccessful": {
          "type": "boolean"
        },
        "Messages": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  ]
}

Response 403

If you have provided an invalid 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.
  • The storefrontid provided was invalid.

{
  "Message": "Invalid StorefrontId for company."
}

Response 500

If you receive a 500 code response, something went wrong on ecomdash's side while trying to retrieve the data you were requesting.

{
  "Message": "Oops, something went wrong."
}

Code samples

@ECHO OFF

curl -v -X POST "https://ecomdash.azure-api.net/api/storefronts/{storefrontid}/listingTemplates"
-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/storefronts/{storefrontid}/listingTemplates?" + 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/storefronts/{storefrontid}/listingTemplates");


            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/storefronts/{storefrontid}/listingTemplates?" + $.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/storefronts/{storefrontid}/listingTemplates";
    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/storefronts/{storefrontid}/listingTemplates');
$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/storefronts/{storefrontid}/listingTemplates?%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/storefronts/{storefrontid}/listingTemplates?%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/storefronts/{storefrontid}/listingTemplates')

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