ECommerce-Related Web Service

From Online Business Wiki

Jump to: navigation, search

This API supports several functions:

Catalogue_ListRetrieve
username: a string containing your username
password: a string containing your password
siteId: an integer containing your site ID
parentCatalogueId: an integer containing the ID of a catalogue or -1

Retrieve an array of Catalogue objects belonging to a particular catalogue (or the root catalogue if -1 is passed).
Catalogue_Retrieve
username: a string containing your username
password: a string containing your password
siteId: an integer containing your site ID
catalogueId: an integer containing the ID of a catalogue

Retrieve a Catalogue object with the details of a given catalogue.
Product_ListRetrieve
username: a string containing your username
password: a string containing your password
siteId: an integer containing your site ID
catalogId: an integer containing either the ID of a catalogue or -1 to retrieve all products

Retrieve an array of Product objects for a given catalog (or all products if CatalogId = -1).
Product_Retrieve
username: a string containing your username
password: a string containing your password
siteId: an integer containing your site ID
productCode: an string containing the product code for the item to retrieve

Retrieve the details of a given product.
Product_UpdateInsert(username, password, siteId, productList)
username: a string containing your username
password: a string containing your password
siteId: an integer containing your site ID
productList: an array of Product objects to be added or updated. Products whose ProductCode already exists in the database are updated, and those that do not exist are inserted.

This method has no return value. An error is returned if the username or password are incorrect, are inconsistent with the siteId, do not have correct permissions to add or edit products, or the site is hosted in a different data center.

DiscountCode_Retrieve(username, password, siteId, discountCodeId)
username: a string containing your username
password: a string containing your password
siteId: an integer containing your site ID
discountCodeId: an integer containing the ID of the discount code you wish to retrieve

This method returns a DiscountCode object.

For technical information, including the WSDL, see the Web Service information page.

Personal tools
Support Material