Rendering Options
Include all fields from the "products" resource.
URL :
« Store URL » /api/products/?display=full
PHP :
$opt = array('resource' => 'products', 'display' => 'full');
Include only the ID of all carriers "carriers"
URL :
« Store URL » /api/products/
PHP :
$opt = array('resource' => 'products');
Only include the "name" and "value" fields from the "configurations" resource.
URL : « Store URL » /api/configurations/?display=\[name,value\] |
PHP : $opt = array('resource' =>'configurations', 'display' => '\[name,value\]'); |
Rendering Filters
Only include the first and last names of customers "customers" whose ids are between 1 and 5 « Store URL » /api/customers/?display=\[firstname,lastname\]&filter\[id\]=\[1|5\] |
PHP : $opt = array('resource' =>'customers', 'display' => '\[firstname,lastname\]', 'filter\[id\]' => '\[1|5\]'); |
Only include the first and last names of customers "customers" whose ids are between 1 and 10
« Store URL » /api/customers/?display=\[lastname\]&filter\[id\]=\[1,10\] |
PHP : $opt = array('resource' =>'customers', 'display' => '\[lastname\]', 'filter\[id\]' => '\[1,10\]'); |
Only include the birthday of clients whose name is "John" and whose last name is "Doe"
« Store URL » /api/customers/?display=\[birthday\]&filter\[firstname\]=\[John\]&filter\[lastname\]=\[DOE\] |
PHP : $opt = array('resource' =>'customers', 'display' => '\[birthday\]', 'filter\[firstname\]' => '\[John\]', 'filter\[lastname\]' => '\[DOE\]'); |
*Only include the names of manufacturers "manufacturers" whose name begins with "Appl"* « Store URL » /api/manufacturers/?display=\[name\]&filter\[name\]=\[appl\]% |
PHP : $opt = array('resource' => 'manufacturers', 'display' => '\[name\]', 'filter\[name\]' => '\[appl\]%'); |
Sorting Filters
Filter the customers "customers" in alphabetical order according to last name « Store URL » /api/customers?display=full&sort=\[lastname_ASC\] |
PHP : $opt = array('resource' => 'customers', 'display' => 'full', 'sort' => '\[lastname_ASC\]'); |
Filters to limit rendering
Only include the first 5 states "states"
« Store URL » /api/states/?display=full&limit=5
PHP :
$opt = array('resource' => 'states', 'display' => 'full', 'limit' => '5');
Only include the first 5 elements starting from the 10th element from the states resource "states"
« Store URL » /api/states/?display=full&limit=9,5
PHP :
$opt = array('resource' => 'states', 'display' => 'full', 'limit' => '9,5');