Products
[base module url]/products
This endpoint is used to retrieve products from the shopping cart. Up to 50 records will be returned at a time within the "products" envelope
Sort parameters ( ?sort=param,param,etc )
Default: -id
Parameter | Info | Asc/Desc |
---|---|---|
id | id number | Y |
created | Creation time | Y |
Filter parameters ( ?parameter=value¶meter=value&etc )
Default: none
Parameter | Info |
---|---|
page | Sets the current page to retrieve ( returned in sets of 50 ) |
id | id number. When used it will filter to >= that id |
created_on_after | created time >= the supplied time value. See supported time formats |
Sample Response
The "next_page" will contain an integer for the next page number to retrieve the next set of results using ?page. If "next_page" is false, there are no more pages of results to retrieve
{
"products": [
{
"id": "14357",
"vendor_id": null,
"product_high_level_type": {
"value": "0",
"name": "Single Product"
},
"name": "fdsa",
"slug": "fdsa",
"category_ids": [
"397"
],
"product_class": {
"value": "0",
"name": "Physical"
},
"model": "G6",
"sku": "",
"upc": "123455",
"manufacturer": "",
"weight": 0.00,
"prod_width": 0.00,
"prod_height": 0.00,
"prod_depth": 0.00,
"cost": 22.00,
"our_cost": 0.00,
"retail_cost": 0.00,
"description": "<p>HTML description of this product</p>",
"short_description": "",
"active": true,
"featured": false,
"prod_type": "",
"track_stock": true,
"num_in_stock": 1,
"starting_stock": 0,
"low_stock": 0,
"primary_pic": "http://www.somedomain.com/pathtoimage.jpg",
"view_count": 12,
"purchase_count": 1,
"personalization_enabled": false,
"personalization_required": false,
"personalization_label": "",
"is_gift_certificate": false,
"gift_certificate_choice": false,
"gift_certificate_choice_min": 0.00,
"gift_certificate_dropdown": "0",
"gift_certificate_amounts": "",
"rating_total": 0,
"rating_average": 0,
"override_shipping": false,
"shipping_cost": 0.00,
"override_shipping_additional": false,
"per_additional_shipping_cost": 0.00,
"override_shipping_subs": false,
"tax_exempt": false,
"meta_title": "",
"meta_keywords": "",
"meta_description": "",
"videos": null,
"created": "2011-09-12T12:47:10-0600",
"created_ip": "127.0.0.1",
"created_user_id": "2",
"modified": "2015-07-15T15:22:34-0600",
"modified_user_id": null
},
.....
],
"next_page": false
}