GET products
Updated, 2012-06-19 14:28
Returns a list of products that are available in the public catalog view
Resource Information
Rate Limited? | No |
Authentication | Optional |
Response Formats | json,xml |
HTTP Methods | GET |
Response Object | list<Product> |
Resource URL
https://ecommerce.dexero.com/service/rest/2/merchant/catalog/products.format
Parameters
Parameter | Description |
---|---|
count | Specifies the number of records to retrieve. The default value 20. Example Values : 30 |
offset | The offset starting point (0-based) to return the first object in the list. The default value is 0. Example Values : 20 |
page | The page of data to retrieve. Example Values : 6 |
sort_key | The field on which to sort the returned results. If the field is not present on an input, the value of empty string is used. The default value is the name.
Example Values : name , prixLow, priceHigh |
sort_dir | The direction of sorting results. The default is asc. Example Values : asc, desc |
locale | Product language Example Values : fr,en |
image_size | Size of the returned Image Example Values : 80 , 80x90 |
include_attributes | When set to true or 1, each include a node called "attributes". This node offers a variety of values specific to the product configuration. The default value is false Example Values : true |
only_active | Return only the active products. The default value is "true" Example Values : true, false |
visibility_scope | Allows you to restrict the scope of the search. The default value is "CATALOG" Example Values : NOT_VISIBLE (Not visible product for customers) CATALOG (Only visible in the list of products catalog) SEARCH (Visible only with search) CATALOG_SEARCH (In the search and list) |
Example Request
https://ecommerce.dexero.com/service/rest/2/merchand/catalogue/products.json?page=14
Example Response
XML
JSON
{ "products" : { "totalResults" : 261, "startIndex" : 260, "itemsPerPage" : 20, "pageCount" : 14, "uri" : "\/ecommerce\/service\/rest\/2\/jpf\/jpf\/products.json?page=14", "firstpageuri" : "\/ecommerce\/service\/rest\/2\/jpf\/jpf\/products.json?page=1", "previouspageuri" : "\/ecommerce\/service\/rest\/2\/jpf\/jpf\/products.json?page=13", "lastpageuri" : "\/ecommerce\/service\/rest\/2\/jpf\/jpf\/products.json?page=14", "product" : { "id" : 15609, "sku" : "adsa", "identifier" : "eheheh", "name" : "hehehe", "currency" : "CAD", "type" : "grouped", "price" : "0.00", "rebate_price" : "0.00", "is_active" : true, "is_buyable" : false, "is_shippable" : false, "is_featured_new" : false, "weight" : 0, "length" : 0, "width" : 0, "height" : 0, "in_promotion" : false, "parent_product_id" : 0, "is_managed_inventory" : false, "number_remaining" : 0, "number_sold" : 0 } } }
Response Object "Product"
Field | Data Type | Description |
---|---|---|
id | long | The unique identification number of this product. The ID is automatically generated and can not be changed. |
sku | string | Stock Keeping Unit ( SKU ) . |
identifier | string | The unique identification number of the product defined by a user. |
name | string | Product name |
description_short | string | The short description of the product which does not contain HTML formatting. |
description_full | text | The long description of the product, which may include HTML formatting. |
type | enum('regular', 'donation','grouped', 'bundle','download','event') |
Product Type :
|
price | decimal(20,2) | Le prix du produit |
rebate_price | decimal(20,2) | Product price calculated with discount |
is_buyable | boolean> | Availability of the product purchase |
is_active | boolean | Determines whether the product is active |
is_shippable | boolean | Determines whether the product should be shipped. |
is_featured_new | boolean | Determines whether the product is considered new |
is_managed_inventory | boolean | Determines whether the inventory management is enabled |
weight | float(7,4) | Weight of the product that can be used when calculating shipping costs |
length | float(7,4) | Length of product that can be used when calculating shipping. |
width | float(7,4) | Width of the product that can be used when calculating shipping. |
height | float(7,4) | Height of product that can be used when calculating shipping. |
in_promotion | boolean | Determines whether the product is currently in promotion |
image | string | Main product image |
parent_product_id | long | ID of the parent product |
child_products | array | A product table identifiers for which the product is the parent |
number_remaining | int | The remaining amount of product inventory |
number_sold | int | The total number of times this item has been sold. |
categories | array | A table of identifiers of the product categories that relate |
attributes | List<Attribute> | A table of complementary product attributes |
Response Object "Attribute"
Field | Data Type | Description |
---|---|---|
id | long | The unique identification number of the attribute. The ID is automatically generated and can not be changed. |
identifier | string | The unique identifier for this attribute defined by a user. |
label | string | The label of the attribute |
type | string |
The type attribute :
|
cross_linked | boolean | Related to the products of the same level. |
attributes | List<Value> | The values of the attribute |
Response Object "Value"
Field | Data Type | Description |
---|---|---|
id | long | The unique identifier of the attribute value. The ID is automatically generated and can not be changed. |
value | string | The value of the attribute |
Pagination information
Property | Description |
---|---|
totalResults | The total number of elements in the list. |
startIndex | The offset starting point (0-based) to return the first object in the list. The default value is 0. |
itemsPerPage | The total number of items per page. |
pageCount | The number of pages. |
uri | The URI of the current page. |
firstpageuri | The URI of the first page. |
previouspageuri | The URI of the previous page. |
nextpageuri | The URI of the next page. |
lastpageuri | The URI of the last page. |