Products API

Current version: v1.1

Products list

Get a list of all your items

GET
/products/list.json
nodes (string) Additional fields can be required on the fly passing via get "nodes" url parameter.
Available fields: title, image_id, ean, mpn, update_at, weight, dimension.
Multiples accepted using comma separation.
brandUID optional (int) Filter products for a specified brandUID, can be combined with categoryUID param
categoryUID option (int) Filter products for a specified categoryUID, can be combined with brandUID param
[
    {
        "code": "a58",
        "final_price": 173,
        "status": 1,
        "uid": 49532
    },
    ...
    {
        "code": "135424",
        "final_price": 6.66,
        "status": 1,
        "uid": 49558
    },
    ...
]
					

Get product details

List a full featured fieldset of one product

GET
/products/product.json?uid={product-uid}
uid required (int) Unique id of your product
{
    "attributes": [],
    "brandUID": 49232,
    "categoryUID": [ //
        49557        // Legacy name, use categories instead
    ],               //
    "categories": [
        49557
    ],
    "code": "135424", // legacy name, check against sku instead
    "sku": "135424",
    "data": {
        "ean13": "",
        "ean8": "",
        "isbn": "",
        "issn": "",
        "unlimited": false
    },
    "description": "Product Description",
    "dimension": {
        "w": "0",
        "h": "10",
        "z": "0"
    },
    "price": 6.66,
    "final_price": 6.66,
    "highview": 0,
    "parameters": [],
    "seo": {
        "title": "Product SEO Title",
        "keywords": "product, seo, keywords",
        "description": "Product SEO Description"
    },
    "shipping_cost": 0,
    "slug": "api-product-test-custom-friendly-url",
    "status": 1,
    "stockCount": 100, // legacy name, use stock_count instead,
    "stock_count": 100,
    "tags": [],
    "taxable": 0,
    "taxprofile": "52dd3382be85f18660000000", // legacy name, usa tax_profile instead,
	"tax_profile": "52dd3382be85f18660000000",
    "title": "Api Product Test",
    "uid": 49558,
    "updateDate": {
        "sec": 1396856023,
        "usec": 608000
    },
    "usevariants": 0,
    "weight": 0,
    "image_id": "52dd3382be85f186600000fef"
}
					

Get product images list

GET
/products/image.json?uid={product-uid}
uid required (int) Unique id of your product
{
    "product": {
        "uid": 114550
    },
    "images": [
        {
            "image_id": "569f4c0b16f46a366c8b4569",
            "thumbnail": "https://static-cdn.storeden.com/secache/569f4c0b16f46a366c8b4569",
            "original": "https://tcdn.storeden.com/gallery/569f4c0b16f46a366c8b4569"
        }
    ]
}
					

Remove product

DELETE
/products/product.json
uid required (int) Unique id of your product
{
	"ok": 1,
	"err": null
}
					

Add product

Add a new product to your catalog

POST
/products/product.json
sku required (string) Unique product identifier.
title required (string)
description required (string)
tax_profile required (StoredenID)
price required (real) Listing product price, must be higher than 0.
final_price (real) Selling product price. If empty or not higher than 0, "price" field will be used instead.
Product final price must be higher than original price.
brandUID (int) UID of existing brand
categories (array)[int] List of existing categories UID
stock_count required (int) Available product quantity.
package_width (real)
package_height (real)
package_length (real)
weight (real)
shipping_cost (int) Set to -1 to indicate free shipping for this item.
Set to 0 or leave empty otherwise.
data (associative array) Extra product information:
EAN: string of a valid EAN number
MPN: string of item MPN
unlimitedsell: 1/0
minQuantity: (int) minimum items buyable
steps: (int) items after the minimum number of items buyable
tags (string) String of tags, without whitespaces, separated by commas
Eg: "tag1,tag2,tag3"
seo (associative array) SEO meta data for store main language
"seo": {
    "title": "Product SEO Title",
    "keywords": "product, seo, keywords",
    "description": "Product SEO Description"
}
seo_lang (associative array) SEO meta data for additional languages
"seo": {
    "en_US": {
      "title": "Product SEO Title",
      "keywords": "product, seo, keywords",
      "description": "Product SEO Description"
  }
.... }
additional_tabs (associative array) Additional descriptions, from 0 to 4
"additional_tabs": {
    0: "Text of additinal tab 0",
    1: "Text of additinal tab 1",
    2: "Text of additinal tab 2",
    3: "Text of additinal tab 3",
    4: "Text of additinal tab 4"
}
{
    "product_uid": 114557,
    "urls": {
        "manage": "https://132-backoffice.storeden.com/products/edit/114557"
    },
    "next": {
        "image": {
            "method": "POST",
            "endpoint": "https://connect.storeden.com/v1.1/products/image.json"
        }
    }
}
					

Update product data

PUT
/products/product.json
uid required (int) Unique id of product to update
title required (string)
description required (string)
categories (array)[int] List of existing categories uid
tax_profile required (StoredenID)
price required (float) Listing product price, must be higher than 0.
final_price (float) Selling product price. If empty or not higher than 0, "price" field will be used instead.
Product final price must be higher than original price.
sku required (string) Unique product identifier.
stock_count required (int) Available product quantity.
brandUID (int) Unique identifier of existing brand.
package_width (float)
package_height (float)
package_length (float)
weight (float)
facebook (int) Enable (1) or disable (0) Facebook selling.
shipping_cost (int) Set to -1 to indicate free shipping for this item.
Set to 0 or leave empty otherwise.
data (associative array)
data[ean13]
data[mpn]
data[unlimitedsell]
data[minQuantity]
data[steps]
Extra product information:
EAN13: string of a valid EAN number
MPN: string of item MPN
unlimitedsell: 1/0
minQuantity: (int) minimum items buyable
steps: (int) items after the minimum number of items buyable
* If you pass just one element in "data", please be aware that this "data" container will be completely overwritten.
tags (string) String of tags, without whitespaces, separated by commas
Eg: "tag1,tag2,tag3"
seo (associative array)
seo[title]
seo[description]
seo[keywords]
SEO meta data for store main language
"seo": {
    "title": "Product SEO Title",
    "keywords": "product, seo, keywords",
    "description": "Product SEO Description"
}
seo_lang (associative array)
seo_lang[lng][title]
seo_lang[lng][keywords]
seo_lang[lng][description]
SEO meta data for additional languages
"seo": {
    "en_US": {
      "title": "Product SEO Title",
      "keywords": "product, seo, keywords",
      "description": "Product SEO Description"
  }
.... }
additional_tabs (associative array)
additional_tabs[0]
additional_tabs[1]
additional_tabs[2]
additional_tabs[3]
additional_tabs[4]
Additional descriptions, from 0 to 4
"additional_tabs": {
    0: "Text of additinal tab 0",
    1: "Text of additinal tab 1",
    2: "Text of additinal tab 2",
    3: "Text of additinal tab 3",
    4: "Text of additinal tab 4"
}
{
    "ok": 1,
    "err": null
}
					

Upload product image

POST
/products/image.json
uid required (int) Unique id of your product
base64 required (base64) Base64 encoded image content
related (int) Specify if uploaded image will be the principal image (0) or a related image (1)
{
    "image_id": "56a0aa7e16f46a334cc7c823",
    "thumbnail": "https://static-cdn.storeden.com/secache/56a0aa7e16f46a334cc7c823",
    "original": "https://tcdn.storeden.com/gallery/56a0aa7e16f46a334cc7c823"
}
					

Set image placeholder

PUT
/products/image.json
uid required (int) Unique id of your product
image_id required (StoredenId) Unique image identifier
{
    "n": "1",
    "ok": 1
}
					

Search product

Search product by SKU

GET
/products/search.json?sku={product-sku}
sku required (string) Product Sku
{
    "uid": 114554,
    "endpoint": {
        "type": "GET",
        "url": "https://connect.storeden.com/v1.1/products/product.json?uid=114554"
    }
}
					

Product visibility

Enable of disable product for sells.

PUT
/products/status.json
uid required (int) An existing product uid
status required (int) Set status to 1 to enable product visibility or 0 to disable product visibility
{
    "ok" : 1
}
					

Get additional tabs

GET
/products/addition_tabs.json?product_uid={uid}
uid required (int) Unique id of your product
{
	"count" : 5,
	"tab_0" : "tab 0 content",
	"tab_1" : "tab 1 content",
	"tab_2' => "tab 2 content",
	"tab_3' => "tab 3 content",
	"tab_4' => "tab 4 content",
}
			

Get product prices

GET
/products/prices.json?uid={uid}
uid required (int) Unique id of your product
{
	"uid" : 17843530,
	"final_price" : 80.00,
	"price" : 100.00,
	"discount' => 20.00
}
					

Update product prices

PUT
/products/prices.json
uid required (int) Unique id of your product
price required (real)
final_price required (real)
{
	"ok" : 1
}
					

Update product weight

PUT
/products/weight.json
uid required (int) Unique id of your product
weight required (real)
{
	"ok" : 1
}
					

Update product dimension

PUT
/products/dimensions.json
uid required (int) Unique id of your product
width required (real)
height required (real)
depth required (real)
{
	"ok" : 1
}
					

Assign specific category to product

PUT
/products/category.json
uid required (int) Unique id of your product
categoryUID (int) Existing category UID
{
	"ok" : 1
}
					

Update product attributes

PUT
/products/attributes.json
uid required (int) Unique id of your product
attribute_id required (StoredenID) repeatable Substitute the "attribute_id" with a valid attribute id
{
    "ok" : 1
}
					

Update products variants

PUT
/products/variants.json
uid required (int) Unique id of your products
usevariants (int) Enable the use of variants (1) or disable it (0)
vars (array)[string] Variants to use in combinations "variants"
variants (array)[string] NB: url of the image: the picture must be uploaded before the assignment
Example:

{
	"uid" : 123,
	"usevariants" : 1,
	"vars" : {
		"taglia" : ["s", "m", "l"],
		"colore" : ["rosso", "giallo"]
	},
	"variants" : [
		{
			"superkey" => "s_rosso",
			"available" => 10,
			"price" => 0,
			"sku" => "sku_s_rosso",
			"image" => "https://...."
			"variants" : {
				"taglia" : "s",
				"colore" : "rosso"
			}
		},
		.... // each combination of vars options
	]
}
					

Update products filters

PUT
/products/filter.json
uid required (int) Unique id of your products
filters required (associative array) Couples "filter_key" : "option_index"
Example:

{
	"uid" : 123,
	"vars" : {
		"color" : 3,
		"material" : 6,
		"size" : 0
	}
}
					

Get related products

GET
/products/related_products.json
uid required (int) Unique uid of your product
{
	"count": 1,
	"products": [
		241274
	]
}
					

Set related products

Insert a list of related products

PUT
/products/related_products.json
uid required (int) Unique uid of your product
related[] (int) repeatable Unique uid of product
{
	"ok": 1,
	"nModified": 1,
	"err": null,
	"associated": [
		"241274"
	]
}
					

Set product attributes

PUT
/products/attributes.json
uid required (int) Unique uid of your product
[attribute_id]:[value] StoredenID : string/int/... repeatable StoredenID: id of existing attribute
Value type depends on attribute type definition.
Example:

{
	uid: 1234,
	"56764sdf930643sdfs" : "Attribute text value",
	"56764930634643sdfa" : 1,
	"5676493s034643sdce" : 49.99,
	....
}

Return:

{
	"ok": 1,
	"nModified": 1,
	"err": null,
	"associated": [
		...
	]
}