ProductServe API

From Wiki

Contents 1 Introduction 2 WSDL 3 Quota 4 Headers 5 Requests 6 Data Types

Introduction

Web Services are commonly a set of APIs (Application Programming Interface), which allow for data to be exchanged between applications or systems across a network such as the Internet. Software applications developed in various programming languages and running on different platforms can use Web Services as a way to standardize data exchange, allowing for Interoperability between systems.

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

Please note the underscore (_) between the 2 and 1. Authentication User authentication is performed by SOAP-Headers, which must be passed with every single request.

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

• UserAuthentication

(SOAP-Header) The authentication element has to be sent with every single request.

Requests

• 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 merchants

• getMerchantList

Gets the requested merchants

• 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

• 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