Products Actions

Product Import

In order to add a new product to Valigara, use the product_import action:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=product_import&data={IMPORT_DATA}

All of the necessary information about the imported product is sent using the data parameter, which is mandatory for this action.

The IMPORT_DATA is a JSON array. Its structure should look similar to:

Product Update

In order to update an existing product, use the product_update action:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=product_update&data={UPDATE_DATA}

All of the necessary information about the updated product is sent using the data parameter, which is mandatory for this action.

The UPDATE_DATA is a JSON array. Its structure should look similar to:

Important:

* skip data you don’t wish to update.

* empty options will override existing data.

* when sending arrays such as gemstones or images, make sure to send existing values if you want to keep them.

* to change default behaviour for “metals“,”gemstones” and “images” you may append to request optional parameter “actions” as follows:

if some parameter inside “actions” will be not defined default value will be used

Product Search

In order to search for a product id, use the action product_search:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=product_search[&data={SEARCH_DATA}]

data is optional. if you wish to filter your search result, set SEARCH_DATA as:

search action result example:

which means that our search returned product ids 1,2,3

Sold Product

In order to notify Valigara of a sold product, use the action product_sold:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=product_sold&data={SOLD_DATA}

data is mandatory. An example of using SOLD_DATA is:

quantity refers to the quantity that was sold (not the quantity left!)

sold_action is optional, its value can be one of: “remove”, “revise” or “no_action” (default)
remove – removes product from all channels
revise – revise product (please note that when the product’s quantity is less than 1, you will receive a 201 error)

Delete products

In order to delete products by their product id, use the action product_delete:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=product_delete&data={DELETE_DATA}

data is mandatory. An example of using DELETE_DATA is:

The channels parameter is optional. if it is set to true, the product won’t be deleted from its associated channels (Ebay, Etsy, etc.).

By default, the `channels` parameter is set to false, meaning: when you delete a product, it will be deleted from Valigara.com and from all of the associated channels.

Product List Fields

In order to retrieve list of allowed product fields, use the action product_listfields:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=product_listfields

An example of using Product List Fields is:

Optional parameter ‘preview’ will show the list of product fields in readable mode for preview purposes only:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=product_listfields&preview=1

Product List Listing Accounts

In order to retrive list of allowed product listings accounts, use the action listings_accounts_get:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=listings_accounts_get

An example of using Product List Listing accounts is:

Product Update Listings

Rate limit: 4 requests in 1 hour

In order to update product listings, use the action product_update_listings:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=product_update_listings&data={DATA}

All of the necessary information about the product & listing accounts is sent using the data parameter, which is mandatory for this action.

The DATA is a JSON array.

DATA example for all Listing Accounts is:

DATA example for specified Listing Accounts only is:

An response example of using Product Update Listings is:

Product Export

In order to export single product, use the action product_export:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=product_export&data={DATA}

The DATA is a JSON array.

DATA example:

Success response example:

Failed response example:

Products Export

In order to export multiple products, use the action products_export:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=products_export&data={DATA}

The DATA is a JSON array.

DATA example:

Success response example:

Failed response example:

Product Post Templates

In order to retrieve list of allowed product post templates, use the action products_post_templates_list:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=products_post_templates_list

Example of using Product Post Templates is:

Products Post

In order to post products to related channels, use the action products_post:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=products_post&data={DATA}

The DATA is a JSON array.

DATA example:

Success response example:

Failed response example:

Products Revise Inventory

In order to revise products inventory on related channel, use the action products_revise_inventory:

https://api.valigara.com/client/V1/?auth={ACCESS_KEY}&action=products_revise_inventory&data={DATA}

The DATA is a JSON array.

DATA example:

Success response example:

Failed response example: