Products

Group: shop, products_and_categories
Resource: products
Sort Properties: ID, average_rating

List all products

GET 	https://api.create.net/products

Input

GET 	https://api.create.net/products?category_id=123133

Param	Type	Required	Description
category_id	INT	Optional	Get all products from a single category

Response

Status: 200 OK

{
 products: [
		{
			"ID" : 898440,
			"parent_category" : 123133,
			"title" : "Retro T-Shirt",
			"visible": true,
			"short_description" : "Quisque sed arcu quis nunc porttitor rutrum faucibus a nunc.",
			"long_description" : "",
			"price" : "25.99",
			"sku" : "898440",
			"weight" : "4.60",

			"stock_number" : 121,
			"stock_backorder" : 0,
			"title_tag" : "Retro T-Shirt",
			"meta_keywords" : "Tshirt, retro, clothing",
			"meta_description" : "A retro T-shirt",
			"was_price" : "0.00",
			"rrp" : "0.00",
			"trade_price" : "0.00",
			"options": [],

			"free_postage": false
		}
	]
}

Get a product

GET 	https://api.create.net/products/:id

Response

Status: 200 OK

{  
    product: {  
        "ID":898440,
        "parent_category":123133,
        "title":"Retro T-Shirt",
		"visible": true,
        "short_description":"Quisque sed arcu quis nunc porttitor rutrum faucibus a nunc.",
        "long_description":"",
        "price":"25.99",
        "sku":"898440",
        "weight":"4.60",
        "stock_number":121,
		"stock_backorder" : 0,
        "title_tag":"Retro T-Shirt",
        "meta_keywords":"Tshirt, retro, clothing",
        "meta_description":"A retro T-shirt",
        "was_price":"0.00",
        "rrp":"0.00",
        "trade_price":"0.00",

        "options":[  
            {  
                "ID":"137379",
                "title":"Colour",
                "required":"1",
                "items":[  
                    {  
                        "ID":"561041",
                        "title":"Red",
                        "price_adjustment":"0.00",
                        "weight_adjustment":"0.000",
                        "is_custom_input":"0"
                    },
                    {  
                        "ID":"561045",
                        "title":"Blue",
                        "price_adjustment":"0.00",
                        "weight_adjustment":"0.000",
                        "is_custom_input":"0"
                    }
                ]
            }
        ],
	"option_based_stock_control": false,

		"free_postage": false
    }
}

Create a product

Note: This endpoint is not yet available, but shows future functionality

POST 	https://api.create.net/products

Input

Param	Type	Required	Description
parent_category	INT	Optional	The ID of the category See: Categories
title	string	Required	The product title
short_description	string	Optional	The product short description
long_description	string	Optional	The product long description
price	INT	Required	The product price
sku	string	Optional	The product SKU
visible	BOOLEAN	Optional (default is true)	Whether the product is visible on the site or not
weight	string	Optional	The product weight
stock_number	integer	Optional	Total product stock
stock_backorder	integer	Optional	The allow back order option of a product. 0 = "Default global behaviour", 1 = "Allow back ordering", 2 = "Don't allow back ordering"
title_tag	string	Optional	The product title meta. Used for SEO
meta_keywords	string	Optional	The product keyword meta. Used for SEO
meta_description	string	Optional	The product description meta. Used for SEO
was_price	INT	Optional	The product 'Was Price'
rrp	INT	Optional	The product recommended retail price (RRP)
trade_price	INT	Optional	The product trade price
free_postage	BOOLEAN	Optional	If using Downloadables, this represents the free postage option, usually set to false.

Response

Status: 201 Created
Location: http://api.create.net/products/2455436

{ "product" :
	{
		"ID" : 898440,
		"parent_category" : 123133,
		"title" : "Retro T-Shirt",
		"short_description" : "Quisque sed arcu quis nunc porttitor rutrum faucibus a nunc.",
		"long_description" : "",
		"price" : "25.99",
		"sku" : "898440",
		"weight" : "4.60",
		"stock_number" : 121,
		"title_tag" : "Retro T-Shirt",
		"meta_keywords" : "Tshirt, retro, clothing",
		"meta_description" : "A retro T-shirt",
		"was_price" : "0.00",
		"rrp" : "0.00",
		"trade_price" : "0.00"
	}
}

Update a product

PUT 	https://api.create.net/products/:id

Input

The request can either be sent as a form post or JSON. The structure is the same as a single product and all fields are optional

{ 
	"title" : "Retro T-Shirt",
	"short_description" : "Quisque sed arcu quis nunc porttitor rutrum faucibus a nunc.",
	"long_description" : "",
	"price" : "25.99",
	"sku" : "898440",
	"weight" : "4.60",
	"stock_number" : 121,
	"title_tag" : "Retro T-Shirt",
	"meta_keywords" : "Tshirt, retro, clothing",
	"meta_description" : "A retro T-shirt",
	"was_price" : "0.00",
	"rrp" : "0.00",
	"trade_price" : "0.00"
}

Response

Status: 200 OK

Delete a product

Note: This endpoint is not yet available, but shows future functionality

DELETE 	https://api.create.net/products/:id

Response

Status: 200 OK