ProductServe API

From Wiki

(Redirected from ProductServe API v3)
Jump to: navigation, search

Contents

Introduction

The ProductServe provides the necessary functionality to retrieve all the information about the products and services available from Affiliate Window's advertisers.

WSDL

As new versions are deployed, old versions stop being supported. They will be left on the servers for a limited time however, to allow for a smooth transition from one version to another. As of time of publishing, there is currently no set timeline for removal of the v1 WSDL.

WSDL v1

http://api.productserve.com/v1/ProductServeService?wsdl

WSDL v2

http://api.productserve.com/v2/ProductServeService?wsdl

WSDL v3

http://v3.core.com.productserve.com/ProductServeService.wsdl


Quota

Every user has an allocated operations quota. The remaining quota is returned as a SOAPHeader, in the response of every request. This quota may be increased where necessary by contacting ShopWindow support.


Headers

The authentication SOAP-Header element must be sent with every single request.

sToken optional

Unique token to identify visitor

This parameter is optional. If you provide it, please supply a unique string (session id is the Client Software default) to identify each unique visitor. We use this non-identifying visitor data for reporting purposes with the potential to build future reporting technology for ShopWindow publishers. Value Type: String

sApiKey required

User specific key to authenticate user (ProductServe API (ShopWindow Client) Password)

Value Type: String


API Requests

Request

Description

getCategory

Gets the specified categories

getCategoryTree

Gets the category list, used to construct the category navigation tree

getCategoryPath

Gets the categories as a path (breadcrumb), from the main tree down to the specified category

getDescendantCategoryIds

Gets the category ids that descend from the specified category

getProduct

Gets the requested products

getMerchantProduct

Gets the requested products

getRelatedProducts

Gets the related products based on conditions given

getProductList

Gets the products belonging to the specified search criteria

getMerchant

Gets the requested advertisers

getMerchantList

Gets the requested advertisers

getQueryList

Gets the query list

getDiscountCodes

Gets the requested discount codes

getGiftFinderProductList

Gets the requested gift finder product lists

getGiftFinderOptions

Returns the gift finder options


Data Types

Data Type

Description

CategoryTree

The CategoryTree object

Category

The category object

Product

The product object

ProductListSortOption

The type of sorting to be applied to the results

SearchProductModeOption

The search mode to use when searching for products

RefineByGroup

The refine by group object

RefineByDefinition

The refine by definition object

Merchant

The merchant object

Query

The query object

DiscountCode

The discount code object

CommissionRange

The commission range object

CommissionType

The commission type


Found a discrepancy in the wiki guide? Contact us at support@affiliatewindow.com

Privacy

Due to new European legislation regarding how websites store information about you, Affiliate Window is updating its privacy policy. You can see the new version of our policy here. If you would like to see the information we capture on this website, please click here for further details. In order to accept cookies on this site please click the 'I ACCEPT' button