SEOTOASTER 2.0 Documentation: Store API for developers
Class

Api_Store_Products

class Api_Store_Products extends Api_Service_Abstract

Products REST API controller

Methods

init()

Initialization
JSON getAction()

Get products by giving contitions
JSON postAction()

New product creation
JSON putAction()

Update product model fields
JSON deleteAction()

Remove product

Details

at line 41
public init()

Initialization

at line 83
public JSON getAction()

Get products by giving contitions

Resourse:
: /api/store/products/id/:id

Method:
: GET

## Parameters:
id (type string)
: Product id to fetch single product

## Optional parameters (оnly if ID is not defined)

limit (type integer)
: Maximum number of results

offset (type integer)
: Number of results to skip

count (type boolean)
: Include total result count if true

key (type string)
: Filter results by keyword. Searches across name, mpn, sku, brand name or tags

ftag (type array)
: Filter results by given tag IDs

fbrand (type string)
: Filter results by given brand names

Return Value

JSON List of products

at line 152
public JSON postAction()

New product creation

Resourse:
: /api/store/products/

HttpMethod:
: POST

Return Value

JSON New product model

at line 186
public JSON putAction()

Update product model fields

Resourse:
: /api/store/products/

HttpMethod:
: PUT

Return Value

JSON Updated product model

at line 259
public JSON deleteAction()

Remove product

Resourse:
: /api/store/products/

HttpMethod:
: DELETE

## Parameters:
id (type string)
: Id of product to delete

## Optional parameters (оnly if ID is not defined)

key (type string)
: Filter results by keyword. Searches across name, mpn, sku, brand name or tags.

ftag (type array)
: Filter results by given tag IDs

fbrand (type string)
: Filter results by given brand names

Return Value

JSON Result of deletion