ecomdash API

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

Inventory - Get List

This call gives you the ability to get active products for a company with some options to filter on supplier, sku, product type, and products created since a specific date. Basic information is returned by default, but using the "include" parameter, you can ask for Storefront, Warehouse, Supplier, Image information, as well as kit and built product components.

Try it

Request URL

Request parameters

(optional)
number

The current page number you want retrieved, if paging is needed

(optional)
number

How many products you want retrieved per page. Maximum returned in one call is 200, default is 25.

(optional)
string

The type of products you are searching for. Valid values are Product, Kit, Built.

(optional)
string

A string used to search for products by Sku. Products that contain this string in the Sku field will be returned.

(optional)
number

Used to filter products by Supplier. You can get valid values for this field using the /Suppliers call.

(optional)
string

Used to filter products by creation date.

(optional)
string

Gives you the ability to specify which extra data you want to retrieve. This is optional and should be a comma separated list of any of the valid values: Storefronts, GlobalListingAttributes, Supplier, Images, Warehouses, KitComponents, BuildComponents

(optional)
string

Used to filter products using the last time the quantity of the product was changed.

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.

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

Request body

Response 200

Along with paging information, a list of products from your search are returned.

{
  "status": "Success",
  "messages": [],
  "pagination": {
    "CurrentPage": 1,
    "TotalNumberOfEntries": 8,
    "TotalNumberOfPages": 1
  },
  "data": [
    {
      "Id": 56464291,
      "CompanyId": 17195,
      "Sku": "APITEST17",
      "Name": "Create Product with API Test17",
      "Type": "Product",
      "QuantityOnHand": 0,
      "Identifiers": {
        "ProductId": 56464291,
        "UPC": "01928375612347"
      },
      "IsActive": true,
      "IsAutoSyncEnabled": false,
      "IsDiscontinued": false,
      "IsDropshipped": false,
      "IsFireArm": false,
      "IsVariation": false,
      "Images": [
        {
          "Id": 41889511,
          "ProductId": 56464291,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpjMmwwWlM1MWJtSmxZWFJoWW14bGMyRnNaUzVqYjIwdmFXMW5Namt3TDJOamNuQTJNRGs1TG1kcFpnPT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 1
        },
        {
          "Id": 41889512,
          "ProductId": 56464291,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlphUzUzWVd4dFlYSjBhVzFoWjJWekxtTnZiUzlwTDNBdk1EQXZNRE12TWpJdk5EY3ZNVGN2TURBd016SXlORGN4TnpRd09WODFNREJZTlRBd0xtcHdadz09MnhsYzNWamEzTQ,,.jpg",
          "DisplayOrder": 2
        },
        {
          "Id": 41889513,
          "ProductId": 56464291,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpaV040TG1sdFlXZGxjeTFoYldGNmIyNHVZMjl0TDJsdFlXZGxjeTlRTDBJd01ESlNRa2ROTVRZdU1ERXVYMU5NTlRBd1gxQkZOVFJmVDFVd01WOVRRMHhhV2xwYVdscGFYMVkwTURBNU9EYzFNVEJmTG1wd1p3PT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 3
        }
      ],
      "Warehouses": [
        {
          "Id": 157851961,
          "ProductId": 56464291,
          "WarehouseId": 3272,
          "Name": "My Warehouse",
          "QuantityOnHand": 0,
          "SKU": "APITEST17",
          "IsActive": true,
          "IsDefault": false,
          "IncludeInSyncBalance": true
        },
        {
          "Id": 157851962,
          "ProductId": 56464291,
          "WarehouseId": 4865,
          "Name": "Andora Warehouse",
          "QuantityOnHand": 0,
          "SKU": "APITEST17",
          "IsActive": true,
          "IsDefault": false,
          "IncludeInSyncBalance": true
        }
      ],
      "Storefronts": [
        {
          "ProductId": 56464291,
          "StorefrontId": 61938,
          "AvailableQuantity": 999,
          "ReferenceId": "APITEST17",
          "DoNotList": false,
          "DoSyncAvailableQty": false
        }
      ]
    },
    {
      "Id": 56464341,
      "CompanyId": 17195,
      "Sku": "APITEST18",
      "Name": "Create Product with API Test18",
      "Type": "Product",
      "QuantityOnHand": 0,
      "Identifiers": {
        "ProductId": 56464341,
        "UPC": "01928375612347"
      },
      "IsActive": true,
      "IsAutoSyncEnabled": false,
      "IsDiscontinued": false,
      "IsDropshipped": false,
      "IsFireArm": false,
      "IsVariation": false,
      "Images": [
        {
          "Id": 41889696,
          "ProductId": 56464341,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpjMmwwWlM1MWJtSmxZWFJoWW14bGMyRnNaUzVqYjIwdmFXMW5Namt3TDJOamNuQTJNRGs1TG1kcFpnPT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 1
        },
        {
          "Id": 41889697,
          "ProductId": 56464341,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlphUzUzWVd4dFlYSjBhVzFoWjJWekxtTnZiUzlwTDNBdk1EQXZNRE12TWpJdk5EY3ZNVGN2TURBd016SXlORGN4TnpRd09WODFNREJZTlRBd0xtcHdadz09MnhsYzNWamEzTQ,,.jpg",
          "DisplayOrder": 2
        },
        {
          "Id": 41889698,
          "ProductId": 56464341,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpaV040TG1sdFlXZGxjeTFoYldGNmIyNHVZMjl0TDJsdFlXZGxjeTlRTDBJd01ESlNRa2ROTVRZdU1ERXVYMU5NTlRBd1gxQkZOVFJmVDFVd01WOVRRMHhhV2xwYVdscGFYMVkwTURBNU9EYzFNVEJmTG1wd1p3PT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 3
        }
      ],
      "Warehouses": [
        {
          "Id": 157852004,
          "ProductId": 56464341,
          "WarehouseId": 3272,
          "Name": "My Warehouse",
          "QuantityOnHand": 0,
          "SKU": "APITEST18",
          "IsActive": true,
          "IsDefault": false,
          "IncludeInSyncBalance": true
        },
        {
          "Id": 157852005,
          "ProductId": 56464341,
          "WarehouseId": 4865,
          "Name": "Andora Warehouse",
          "QuantityOnHand": 0,
          "SKU": "APITEST18",
          "IsActive": true,
          "IsDefault": false,
          "IncludeInSyncBalance": true
        }
      ],
      "Storefronts": [
        {
          "ProductId": 56464341,
          "StorefrontId": 61938,
          "AvailableQuantity": 999,
          "ReferenceId": "APITEST18",
          "DoNotList": false,
          "DoSyncAvailableQty": false
        }
      ]
    },
    {
      "Id": 56466102,
      "CompanyId": 17195,
      "Sku": "APITEST19",
      "Name": "Create Product with API Test19",
      "Type": "Product",
      "QuantityOnHand": 0,
      "Identifiers": {
        "ProductId": 56466102,
        "UPC": "01928375612347"
      },
      "IsActive": true,
      "IsAutoSyncEnabled": false,
      "IsDiscontinued": false,
      "IsDropshipped": false,
      "IsFireArm": false,
      "IsVariation": false,
      "Images": [
        {
          "Id": 41894807,
          "ProductId": 56466102,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpjMmwwWlM1MWJtSmxZWFJoWW14bGMyRnNaUzVqYjIwdmFXMW5Namt3TDJOamNuQTJNRGs1TG1kcFpnPT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 1
        },
        {
          "Id": 41894808,
          "ProductId": 56466102,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlphUzUzWVd4dFlYSjBhVzFoWjJWekxtTnZiUzlwTDNBdk1EQXZNRE12TWpJdk5EY3ZNVGN2TURBd016SXlORGN4TnpRd09WODFNREJZTlRBd0xtcHdadz09MnhsYzNWamEzTQ,,.jpg",
          "DisplayOrder": 2
        },
        {
          "Id": 41894809,
          "ProductId": 56466102,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpaV040TG1sdFlXZGxjeTFoYldGNmIyNHVZMjl0TDJsdFlXZGxjeTlRTDBJd01ESlNRa2ROTVRZdU1ERXVYMU5NTlRBd1gxQkZOVFJmVDFVd01WOVRRMHhhV2xwYVdscGFYMVkwTURBNU9EYzFNVEJmTG1wd1p3PT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 3
        }
      ],
      "Warehouses": [
        {
          "Id": 157855285,
          "ProductId": 56466102,
          "WarehouseId": 3272,
          "Name": "My Warehouse",
          "QuantityOnHand": 0,
          "SKU": "APITEST19",
          "IsActive": true,
          "IsDefault": false,
          "IncludeInSyncBalance": true
        },
        {
          "Id": 157855286,
          "ProductId": 56466102,
          "WarehouseId": 4865,
          "Name": "Andora Warehouse",
          "QuantityOnHand": 0,
          "SKU": "APITEST19",
          "IsActive": true,
          "IsDefault": false,
          "IncludeInSyncBalance": true
        }
      ],
      "Storefronts": [
        {
          "ProductId": 56466102,
          "StorefrontId": 61938,
          "AvailableQuantity": 999,
          "ReferenceId": "APITEST19",
          "DoNotList": false,
          "DoSyncAvailableQty": false
        }
      ]
    },
    {
      "Id": 56466349,
      "CompanyId": 17195,
      "Sku": "APITEST20",
      "Name": "Create Product with API Test20",
      "Type": "Product",
      "QuantityOnHand": 5,
      "Identifiers": {
        "ProductId": 56466349,
        "UPC": "01928375612347"
      },
      "IsActive": true,
      "IsAutoSyncEnabled": false,
      "IsDiscontinued": false,
      "IsDropshipped": false,
      "IsFireArm": false,
      "IsVariation": false,
      "Images": [
        {
          "Id": 41895036,
          "ProductId": 56466349,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpjMmwwWlM1MWJtSmxZWFJoWW14bGMyRnNaUzVqYjIwdmFXMW5Namt3TDJOamNuQTJNRGs1TG1kcFpnPT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 1
        },
        {
          "Id": 41895037,
          "ProductId": 56466349,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlphUzUzWVd4dFlYSjBhVzFoWjJWekxtTnZiUzlwTDNBdk1EQXZNRE12TWpJdk5EY3ZNVGN2TURBd016SXlORGN4TnpRd09WODFNREJZTlRBd0xtcHdadz09MnhsYzNWamEzTQ,,.jpg",
          "DisplayOrder": 2
        },
        {
          "Id": 41895038,
          "ProductId": 56466349,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpaV040TG1sdFlXZGxjeTFoYldGNmIyNHVZMjl0TDJsdFlXZGxjeTlRTDBJd01ESlNRa2ROTVRZdU1ERXVYMU5NTlRBd1gxQkZOVFJmVDFVd01WOVRRMHhhV2xwYVdscGFYMVkwTURBNU9EYzFNVEJmTG1wd1p3PT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 3
        }
      ],
      "Warehouses": [
        {
          "Id": 157855549,
          "ProductId": 56466349,
          "WarehouseId": 4865,
          "Name": "Andora Warehouse",
          "QuantityOnHand": 5,
          "IsActive": true,
          "IsDefault": false,
          "IncludeInSyncBalance": false
        }
      ],
      "Storefronts": [
        {
          "ProductId": 56466349,
          "StorefrontId": 61938,
          "AvailableQuantity": 999,
          "ReferenceId": "APITEST20",
          "DoNotList": false,
          "DoSyncAvailableQty": false
        }
      ]
    },
    {
      "Id": 56482925,
      "CompanyId": 17195,
      "Sku": "APITEST21",
      "Name": "Create Product with API Test21",
      "Type": "Product",
      "QuantityOnHand": 5,
      "Identifiers": {
        "ProductId": 56482925,
        "UPC": "01928375612347"
      },
      "IsActive": true,
      "IsAutoSyncEnabled": false,
      "IsDiscontinued": false,
      "IsDropshipped": false,
      "IsFireArm": false,
      "IsVariation": false,
      "Images": [
        {
          "Id": 41910070,
          "ProductId": 56482925,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpjMmwwWlM1MWJtSmxZWFJoWW14bGMyRnNaUzVqYjIwdmFXMW5Namt3TDJOamNuQTJNRGs1TG1kcFpnPT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 1
        },
        {
          "Id": 41910071,
          "ProductId": 56482925,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlphUzUzWVd4dFlYSjBhVzFoWjJWekxtTnZiUzlwTDNBdk1EQXZNRE12TWpJdk5EY3ZNVGN2TURBd016SXlORGN4TnpRd09WODFNREJZTlRBd0xtcHdadz09MnhsYzNWamEzTQ,,.jpg",
          "DisplayOrder": 2
        },
        {
          "Id": 41910072,
          "ProductId": 56482925,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpaV040TG1sdFlXZGxjeTFoYldGNmIyNHVZMjl0TDJsdFlXZGxjeTlRTDBJd01ESlNRa2ROTVRZdU1ERXVYMU5NTlRBd1gxQkZOVFJmVDFVd01WOVRRMHhhV2xwYVdscGFYMVkwTURBNU9EYzFNVEJmTG1wd1p3PT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 3
        }
      ],
      "Warehouses": [
        {
          "Id": 157876358,
          "ProductId": 56482925,
          "WarehouseId": 4865,
          "Name": "Andora Warehouse",
          "QuantityOnHand": 5,
          "IsActive": true,
          "IsDefault": false,
          "IncludeInSyncBalance": false
        },
        {
          "Id": 157876359,
          "ProductId": 56482925,
          "WarehouseId": 3272,
          "Name": "My Warehouse",
          "QuantityOnHand": 0,
          "SKU": "APITEST21",
          "IsActive": true,
          "IsDefault": false,
          "IncludeInSyncBalance": true
        }
      ],
      "Storefronts": [
        {
          "ProductId": 56482925,
          "StorefrontId": 61938,
          "AvailableQuantity": 999,
          "ReferenceId": "APITEST21",
          "DoNotList": false,
          "DoSyncAvailableQty": false
        }
      ]
    },
    {
      "Id": 56507536,
      "CompanyId": 17195,
      "Sku": "APITEST22",
      "Name": "Create Product with API Test22",
      "Type": "Product",
      "QuantityOnHand": 5,
      "Identifiers": {
        "ProductId": 56507536,
        "UPC": "01928375612347"
      },
      "IsActive": true,
      "IsAutoSyncEnabled": false,
      "IsDiscontinued": false,
      "IsDropshipped": false,
      "IsFireArm": false,
      "IsVariation": false,
      "Images": [
        {
          "Id": 41910937,
          "ProductId": 56507536,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpjMmwwWlM1MWJtSmxZWFJoWW14bGMyRnNaUzVqYjIwdmFXMW5Namt3TDJOamNuQTJNRGs1TG1kcFpnPT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 1
        },
        {
          "Id": 41910938,
          "ProductId": 56507536,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlphUzUzWVd4dFlYSjBhVzFoWjJWekxtTnZiUzlwTDNBdk1EQXZNRE12TWpJdk5EY3ZNVGN2TURBd016SXlORGN4TnpRd09WODFNREJZTlRBd0xtcHdadz09MnhsYzNWamEzTQ,,.jpg",
          "DisplayOrder": 2
        },
        {
          "Id": 41910939,
          "ProductId": 56507536,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpaV040TG1sdFlXZGxjeTFoYldGNmIyNHVZMjl0TDJsdFlXZGxjeTlRTDBJd01ESlNRa2ROTVRZdU1ERXVYMU5NTlRBd1gxQkZOVFJmVDFVd01WOVRRMHhhV2xwYVdscGFYMVkwTURBNU9EYzFNVEJmTG1wd1p3PT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 3
        }
      ],
      "Warehouses": [
        {
          "Id": 157877341,
          "ProductId": 56507536,
          "WarehouseId": 4865,
          "Name": "Andora Warehouse",
          "QuantityOnHand": 5,
          "IsActive": true,
          "IsDefault": false
        },
        {
          "Id": 157877342,
          "ProductId": 56507536,
          "WarehouseId": 3272,
          "Name": "My Warehouse",
          "QuantityOnHand": 0,
          "SKU": "APITEST22",
          "IsActive": true,
          "IsDefault": false,
          "IncludeInSyncBalance": true
        }
      ],
      "Storefronts": [
        {
          "ProductId": 56507536,
          "StorefrontId": 61938,
          "AvailableQuantity": 999,
          "ReferenceId": "APITEST22",
          "DoNotList": false,
          "DoSyncAvailableQty": false
        }
      ]
    },
    {
      "Id": 56507711,
      "CompanyId": 17195,
      "Sku": "APITEST23",
      "Name": "Create Product with API Test23",
      "Type": "Product",
      "QuantityOnHand": 5,
      "Identifiers": {
        "ProductId": 56507711,
        "UPC": "01928375612347"
      },
      "IsActive": true,
      "IsAutoSyncEnabled": false,
      "IsDiscontinued": false,
      "IsDropshipped": false,
      "IsFireArm": false,
      "IsVariation": false,
      "Images": [
        {
          "Id": 41911477,
          "ProductId": 56507711,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpjMmwwWlM1MWJtSmxZWFJoWW14bGMyRnNaUzVqYjIwdmFXMW5Namt3TDJOamNuQTJNRGs1TG1kcFpnPT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 1
        },
        {
          "Id": 41911478,
          "ProductId": 56507711,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlphUzUzWVd4dFlYSjBhVzFoWjJWekxtTnZiUzlwTDNBdk1EQXZNRE12TWpJdk5EY3ZNVGN2TURBd016SXlORGN4TnpRd09WODFNREJZTlRBd0xtcHdadz09MnhsYzNWamEzTQ,,.jpg",
          "DisplayOrder": 2
        },
        {
          "Id": 41911479,
          "ProductId": 56507711,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpaV040TG1sdFlXZGxjeTFoYldGNmIyNHVZMjl0TDJsdFlXZGxjeTlRTDBJd01ESlNRa2ROTVRZdU1ERXVYMU5NTlRBd1gxQkZOVFJmVDFVd01WOVRRMHhhV2xwYVdscGFYMVkwTURBNU9EYzFNVEJmTG1wd1p3PT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 3
        }
      ],
      "Warehouses": [
        {
          "Id": 157877704,
          "ProductId": 56507711,
          "WarehouseId": 4865,
          "Name": "Andora Warehouse",
          "QuantityOnHand": 5,
          "IsActive": true,
          "IsDefault": false
        },
        {
          "Id": 157877708,
          "ProductId": 56507711,
          "WarehouseId": 3272,
          "Name": "My Warehouse",
          "QuantityOnHand": 0,
          "SKU": "APITEST23",
          "IsActive": true,
          "IsDefault": false
        }
      ],
      "Storefronts": [
        {
          "ProductId": 56507711,
          "StorefrontId": 61938,
          "AvailableQuantity": 999,
          "ReferenceId": "APITEST23",
          "DoNotList": false,
          "DoSyncAvailableQty": false
        }
      ]
    },
    {
      "Id": 56508046,
      "CompanyId": 17195,
      "Sku": "APITEST24",
      "Name": "Create Product with API Test24",
      "Type": "Product",
      "QuantityOnHand": 5,
      "Identifiers": {
        "ProductId": 56508046,
        "UPC": "01928375612347"
      },
      "IsActive": true,
      "IsAutoSyncEnabled": false,
      "IsDiscontinued": false,
      "IsDropshipped": false,
      "IsFireArm": false,
      "IsVariation": false,
      "Images": [
        {
          "Id": 41912173,
          "ProductId": 56508046,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpjMmwwWlM1MWJtSmxZWFJoWW14bGMyRnNaUzVqYjIwdmFXMW5Namt3TDJOamNuQTJNRGs1TG1kcFpnPT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 1
        },
        {
          "Id": 41912174,
          "ProductId": 56508046,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlphUzUzWVd4dFlYSjBhVzFoWjJWekxtTnZiUzlwTDNBdk1EQXZNRE12TWpJdk5EY3ZNVGN2TURBd016SXlORGN4TnpRd09WODFNREJZTlRBd0xtcHdadz09MnhsYzNWamEzTQ,,.jpg",
          "DisplayOrder": 2
        },
        {
          "Id": 41912175,
          "ProductId": 56508046,
          "MIMEType": "image/jpeg",
          "Url": "http://i.upcindex.com/i/WjI5dlpaV040TG1sdFlXZGxjeTFoYldGNmIyNHVZMjl0TDJsdFlXZGxjeTlRTDBJd01ESlNRa2ROTVRZdU1ERXVYMU5NTlRBd1gxQkZOVFJmVDFVd01WOVRRMHhhV2xwYVdscGFYMVkwTURBNU9EYzFNVEJmTG1wd1p3PT0yeGxjM1ZqYTNN.jpg",
          "DisplayOrder": 3
        }
      ],
      "Warehouses": [
        {
          "Id": 157878584,
          "ProductId": 56508046,
          "WarehouseId": 4865,
          "Name": "Andora Warehouse",
          "QuantityOnHand": 5,
          "SKU": "APITEST24",
          "IsActive": true,
          "IsDefault": false
        },
        {
          "Id": 157878585,
          "ProductId": 56508046,
          "WarehouseId": 3272,
          "Name": "My Warehouse",
          "QuantityOnHand": 0,
          "SKU": "APITEST24",
          "IsActive": true,
          "IsDefault": false
        }
      ],
      "Storefronts": [
        {
          "ProductId": 56508046,
          "StorefrontId": 61938,
          "AvailableQuantity": 999,
          "ReferenceId": "APITEST24",
          "DoNotList": false,
          "DoSyncAvailableQty": false
        }
      ]
    }
  ]
}

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."
}

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 GET "https://ecomdash.azure-api.net/api/Inventory?pageNumber={number}&resultsPerPage={number}&type={string}&sku={string}&supplierId={number}&createdSince={string}&include={string}&quantityChangedSince={string}"
-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}");

            // Request parameters
            queryString["pageNumber"] = "{number}";
            queryString["resultsPerPage"] = "{number}";
            queryString["type"] = "{string}";
            queryString["sku"] = "{string}";
            queryString["supplierId"] = "{number}";
            queryString["createdSince"] = "{string}";
            queryString["include"] = "{string}";
            queryString["quantityChangedSince"] = "{string}";
            var uri = "https://ecomdash.azure-api.net/api/Inventory?" + 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");

            builder.setParameter("pageNumber", "{number}");
            builder.setParameter("resultsPerPage", "{number}");
            builder.setParameter("type", "{string}");
            builder.setParameter("sku", "{string}");
            builder.setParameter("supplierId", "{number}");
            builder.setParameter("createdSince", "{string}");
            builder.setParameter("include", "{string}");
            builder.setParameter("quantityChangedSince", "{string}");

            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
            "pageNumber": "{number}",
            "resultsPerPage": "{number}",
            "type": "{string}",
            "sku": "{string}",
            "supplierId": "{number}",
            "createdSince": "{string}",
            "include": "{string}",
            "quantityChangedSince": "{string}",
        };
      
        $.ajax({
            url: "https://ecomdash.azure-api.net/api/Inventory?" + $.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";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"pageNumber={number}",
                         @"resultsPerPage={number}",
                         @"type={string}",
                         @"sku={string}",
                         @"supplierId={number}",
                         @"createdSince={string}",
                         @"include={string}",
                         @"quantityChangedSince={string}",
                      ];
    
    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');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'ecd-subscription-key' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'pageNumber' => '{number}',
    'resultsPerPage' => '{number}',
    'type' => '{string}',
    'sku' => '{string}',
    'supplierId' => '{number}',
    'createdSince' => '{string}',
    'include' => '{string}',
    'quantityChangedSince' => '{string}',
);

$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({
    # Request parameters
    'pageNumber': '{number}',
    'resultsPerPage': '{number}',
    'type': '{string}',
    'sku': '{string}',
    'supplierId': '{number}',
    'createdSince': '{string}',
    'include': '{string}',
    'quantityChangedSince': '{string}',
})

try:
    conn = httplib.HTTPSConnection('ecomdash.azure-api.net')
    conn.request("GET", "/api/Inventory?%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({
    # Request parameters
    'pageNumber': '{number}',
    'resultsPerPage': '{number}',
    'type': '{string}',
    'sku': '{string}',
    'supplierId': '{number}',
    'createdSince': '{string}',
    'include': '{string}',
    'quantityChangedSince': '{string}',
})

try:
    conn = http.client.HTTPSConnection('ecomdash.azure-api.net')
    conn.request("GET", "/api/Inventory?%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')

query = URI.encode_www_form({
    # Request parameters
    'pageNumber' => '{number}',
    'resultsPerPage' => '{number}',
    'type' => '{string}',
    'sku' => '{string}',
    'supplierId' => '{number}',
    'createdSince' => '{string}',
    'include' => '{string}',
    'quantityChangedSince' => '{string}'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

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