Page History

Table of content

...

Advanced Use

Rendering Options

...

URL: (Store URL)/api/products/?display=full

PHP:

$opt = array(
	'resource' => 'products', 
	'display'  => 'full'
);

Include only the ID of all carriers

URL: (Store URL)/api/products/carriers/?display=[id]

PHP :

$opt = array('resource' => 'products'carriers', 'display' => '[id]');

Only include the "name" and "value" fields from the "configurations" resource

Wiki MarkupURL: (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

...

1

...

or 5

Wiki MarkupURL: (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

...

last names of customers "customers" whose ids are between 1 and 10

Wiki MarkupURL: (Store URL)/api/customers/?display=\[lastname\]&filter\[id\]=\[1,10\]

PHP:

$opt = array(
	'resource'   =>'customers', 
	'display'    => '[lastname]', 
	'filter[id]' => '[1,110]'
);

Only include the birthday of clients whose name is "John" and whose last name is "Doe"

Wiki MarkupURL: (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"

Wiki MarkupURL: (Store URL)/api/manufacturers/?display=\[name\]&filter\[name\]=\[appl\]%

PHP:

$opt = array(
	'resource'     => 'manufacturers', 
	'display'      => '[name]', 
	'filter[name]' => '[appl]%'
);

...

Filter the customers "customers" in alphabetical order according to last name

Wiki MarkupURL: Store URL/api/customers?display=full&sort=\[lastname_ASC\]

PHP:

$opt = array(
	'resource' => 'customers', 
	'display'  => 'full', 
	'sort'     => '[lastname_ASC]'
);

...

URL: (Store URL)/api/states/?display=full&limit=5

PHP:

$opt = array(
	'resource' => 'states', 
	'display'  => 'full', 
	'limit'    => '5'
);

...

URL: (Store URL)/api/states/?display=full&limit=9,5

PHP:

$opt = array(
	'resource' => 'states', 
	'display'  => 'full', 
	'limit'    => '9,5'
);