Page History

Table of contents

Advanced Use

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.

Wiki MarkupURL : « (Store URL » )/api/configurations/?display=\[name,value\] Wiki Markup

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

URL: (Store URL)/api/customers/?display=\[firstname,lastname\]&filter\[id\]=\[1|5\] Wiki Markup

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

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

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"

Wiki Markup« Store URL » URL: (Store URL)/api/customers/?display=\[birthday\]&filter\[firstname\]=\[John\]&filter\[lastname\]=\[DOE\] Wiki Markup

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"

...

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

Wiki Markup PHP :

Code Block
$opt = array( 'resource' => 'manufacturers', 'display' => '

...

[name

...

]', 'filter

...

[name

...

]' => '

...

[appl

...

]%');

Sorting Filters

...

Filter

...

the

...

customers

...

"customers"

...

in

...

alphabetical

...

order

...

according

...

to

...

last

...

name

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

Wiki MarkupPHP :

$opt = array( 'resource' => 'customers', 
              'display'  => 'full', 
              'sort'     => '

...

[lastname_ASC

...

]' );

Filters to limit rendering

Only include the first 5 states "states"

« URL: (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"

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

PHP:

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