View source for LiveCatalog XML-RPC API

From Opentaps Wiki

← LiveCatalog XML-RPC API

You do not have permission to edit this page, for the following reasons:

• The action you have requested is limited to users in the group: Users.
• This page has been protected to prevent editing or other actions.

---

You can view and copy the source of this page.

= Opentaps LiveCatalog XML-RPC API = == Overview == ... description text ... == Methods == === Catalog Export Methods === ==== catalogexport.getProductCatalogIds ==== : Starting point : Arguments :# ''&lt;string&gt;'' systemId<br />'''' :# ''&lt;string&gt;'' productStoreId : Return''&lt;array&gt;'' CatalogIds ==== catalogexport.getBrowseRootCategoryId ==== : Get the root categoryId for a catalog : Arguments :# ''&lt;string&gt;'' systemId<br />'''' :# ''&lt;string&gt;'' catalogId : Return''&lt;string&gt;'' CategoryId ==== catalogexport.getSpecialCategoryIds ==== : To get IDs for special categories like Default Search, Most Popular, etc. : Arguments :# ''&lt;string&gt;'' systemId<br />'''' :# ''&lt;string&gt;'' catalogId : Return''&lt;struct&gt;'' CategoryIds :* productCategoryTypeId =&gt; ''&lt;string&gt;'' productCategoryId :* ... ==== catalogexport.getCategory ==== : Retrieve data for a category, including its product or category children. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt; ''productStoreId :# ''&lt;string&gt; ''catalogId :# ''&lt;string&gt;'' categoryId :# ''&lt;string&gt;'' userLocale : Return''&lt;struct&gt;'' Category Data :* Name - ''&lt;string&gt;'' Category Name :* Description - ''&lt;string&gt;'' Category Description :* LongDescription - ''&lt;string&gt;'' Long category Description :* CategoryImageURL - ''&lt;string&gt;'' Category image URL :* CategoryImageAltText - &lt;string&gt; Alt text for category image<br /> :* ProductData =&gt; ''&lt;array&gt;'' of ''&lt;struct&gt;'' of type: :** ProductId - ''&lt;string&gt;'' Product ID :** Name - ''&lt;string&gt;'' Product Name :** Description - ''&lt;string&gt;'' Product Description :** ImageURL - ''&lt;string&gt;'' Product image URL :** ImageAltText - ''&lt;string&gt;'' Product image alt text :** PriceCurrencyCode - ''&lt;string&gt;'' Product price currency<br /> :** IsSale - ''&lt;boolean&gt;'' Is the product on sale? :** Price - ''&lt;double&gt;'' Product Price :** ListPrice - ''&lt;double&gt;'' List Price :* ChildData =&gt; ''&lt;array&gt;'' of ''&lt;struct&gt;'' of type: :** CategoryId - &lt;string&gt; Category ID :** Name - &lt;string&gt; Category Name :** Description - &lt;string&gt; Category Description :** CategoryImageURL - ''&lt;string&gt;'' Child category image URL :** CategoryImageAltText - ''&lt;string&gt;'' Child category image alt text ==== catalogexport.getCategoryContent ==== : Retrieve content for a category : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt; ''productStoreId :# ''&lt;string&gt; ''catalogId :# ''&lt;string&gt;'' categoryId :# ''&lt;string&gt;'' userLocale : Return''&lt;struct&gt;'' Category Data :* Name - ''&lt;string&gt;'' Category Name :* Description - ''&lt;string&gt;'' Category Description :* LongDescription - ''&lt;string&gt;'' Long category Description :* CategoryImageURL - ''&lt;string&gt;'' Category image URL :* CategoryImageAltText - &lt;string&gt; Alt text for category image ==== catalogexport.getProduct ==== : Retrieve data for a product. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' productId :# ''&lt;string&gt;'' productStoreId :# ''&lt;string&gt;'' catalogId :# ''&lt;string&gt;'' userLocale : Return''&lt;struct&gt;'' Product Data :* ProductId - ''&lt;string&gt;'' Product ID :* Name - ''&lt;string&gt;'' Product Name :* Description - ''&lt;string&gt;'' Product Description :* LongDescription - ''&lt;string&gt;'' Long product Description :* SmallImageURL - ''&lt;string&gt;'' URL for thumbnail image :* MediumImageURL - ''&lt;string&gt;'' URL for medium image :* LargeImageURL - ''&lt;string&gt;'' URL for large image :* DetailImageURL - ''&lt;string&gt;'' URL for detail image :* SmallImageAltText - ''&lt;string&gt;'' Alt text for thumbnail image :* MediumImageAltText - ''&lt;string&gt;'' Alt text for medium image :* LargeImageAltText - ''&lt;string&gt;'' Alt text for large image :* DetailImageAltText - ''&lt;string&gt;'' Alt text for detail image :* PriceCurrencyCode - ''&lt;string&gt;'' Price Currency Code :* Price - ''&lt;double&gt;'' Product Price :* IsSale - ''&lt;boolean&gt;'' Is product on sale? :* ListPrice - ''&lt;double&gt; '' Product List Price :* RequireInventory - ''&lt;boolean&gt;'' Require Inventory for sale? :* IntroductionDate - ''&lt;dateTime&gt;'' Timestamp of product introduction :* DiscontinuationDate - ''&lt;dateTime&gt;'' Timestamp of product discontinuation :* ProductType - ''&lt;string&gt;'' Product Type :* QuantityInStock - ''&lt;double&gt;'' Product Quantity In Stock :* DaysToShip - '' &lt;double&gt;'' Days to Shipping Availability ==== catalogexport.getProductContent ==== : Retrieve content for a product. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' productId :# ''&lt;string&gt;'' userLocale : Return''&lt;struct&gt;'' Product Data :* Name - ''&lt;string&gt;'' Product Name :* Description - ''&lt;string&gt;'' Product Description :* LongDescription - ''&lt;string&gt;'' Long product Description :* SmallImageURL - ''&lt;string&gt;'' URL for thumbnail image :* MediumImageURL - ''&lt;string&gt;'' URL for medium image :* LargeImageURL - ''&lt;string&gt;'' URL for large image :* DetailImageURL - ''&lt;string&gt;'' URL for detail image :* SmallImageAltText - ''&lt;string&gt;'' Alt text for thumbnail image :* MediumImageAltText - ''&lt;string&gt;'' Alt text for medium image :* LargeImageAltText - ''&lt;string&gt;'' Alt text for large image :* DetailImageAltText - ''&lt;string&gt;'' Alt text for detail image ==== catalogexport.getProductKeywords ==== : Retrieve keywords for a product. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' productId : Return''&lt;struct&gt;'' Keywords :* keyword - ''&lt;i4&gt;'' weight :* ... ==== catalogexport.getAssociatedProducts ==== : Retrieve associated products (eg: cross-sell, upgrade, etc) to a given product. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' productId :# ''&lt;string&gt; ''productStoreId :# ''&lt;string&gt; ''catalogId :# ''&lt;string&gt; '' : Return''&lt;struct&gt;'' AssociatedProducts :* associationType =&gt; ''&lt;array&gt;'' products :** ''&lt;struct&gt;'' Product Data :*** ProductId - ''&lt;string&gt;'' Product ID :*** Name - ''&lt;string&gt;'' Product Name :*** Description - ''&lt;string&gt;'' Product Description :*** ImageURL - ''&lt;string&gt;'' Image URL :*** ImageAltText - ''&lt;string&gt;'' Image alt text :*** IsSale - ''&lt;boolean&gt;'' Is the product on sale? :*** Price - ''&lt;double&gt;'' Product Price :*** ListPrice - ''&lt;double&gt;'' List Price :*** PriceCurrencyCode - ''&lt;string&gt;'' Currency ==== catalogexport.getAvailablePromotions ==== : Provides a list of descriptions of promotions available. If a userId and password are specified, the promotions will be filtered accordingly. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' productStoreId :# ''&lt;string&gt;'' userLoginId :# ''&lt;string&gt;'' password : Return''&lt;struct&gt;'' :* AvailablePromotions - ''&lt;array&gt;'' Descriptions of available promotions ==== catalogexport.getCategoryHierarchy ==== : Provides a full representation of the category data structure, considering the top level as the given categoryId. Category names will be based on userLocale. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' categoryId :# ''&lt;string&gt;'' userLocale : Return''&lt;struct&gt;'' :* CategoryId - ''&lt;string&gt;'' The argument categoryId :* CategoryImageURL - ''&lt;string&gt;'' URL of the image for the argument category :* Name - ''&lt;string&gt;'' Name of the argument category :* ProductCount - ''&lt;i4&gt;'' Number of products in the argument category :* ChildData - ''&lt;array&gt;'' Child categories of the argument category. Each array member mirrors the return structure of the procedure (CategoryId, CategoryImageURL, Name, ProductCount, ChildData) ==== catalogexport.getProductTypes ==== : Provides a list of all product types. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' userLocale : Return''&lt;struct&gt;'' ProductTypes :* productType =&gt; ''&lt;struct&gt;'' :** Description - ''&lt;string&gt;'' Product type description :** IsPhysical - ''&lt;boolean&gt;'' Product is a physical product :** IsDigital - ''&lt;boolean&gt;'' Product is a digital product <br /> === Catalog Export Helper Methods === ==== catalogexport.getProductPrices ==== : Retrieve prices for a product. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' productId :# ''&lt;string&gt;'' productStoreId :# ''&lt;string&gt;'' catalogId : Return''&lt;struct&gt;'' :* PriceCurrencyCode - ''&lt;string&gt;'' Price Currency Code :* Price - ''&lt;double&gt;'' Product Price :* IsSale - ''&lt;boolean&gt;'' Is product on sale? :* ListPrice - ''&lt;double&gt; '' Product List Price ==== catalogexport.getProductName ==== : Simple product name retrieval. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' productId :# ''&lt;string&gt;'' userLocale : Return''&lt;string&gt;'' Name ==== catalogexport.getCategoryName ==== : Simple category name retrieval. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' categoryId :# ''&lt;string&gt;'' userLocale : Return''&lt;string&gt;'' Name ==== catalogexport.getProductDescription ==== : Simple product description retrieval. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' productId :# ''&lt;string&gt;'' userLocale : Return''&lt;struct&gt;'' :* Description - ''&lt;string&gt;'' Product Description :* LongDescription - ''&lt;string&gt;'' Long Product Description ==== catalogexport.getCategoryDescription ==== : Simple category description retrieval. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' categoryId :# ''&lt;string&gt;'' userLocale : Return''&lt;struct&gt;'' :* Description - ''&lt;string&gt;'' Category Description :* LongDescription - ''&lt;string&gt;'' Long Category Description <br /> == Membership Methods == ==== catalogexport.security.getAuthenticatedUser ==== : Authenticate a user/member and return simple member data. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' userLoginId :# ''&lt;string&gt;'' password : Return''&lt;struct&gt;'' :* FirstName - ''&lt;string&gt;'' User first name :* LastName - ''&lt;string&gt;'' User last name :* FullName - ''&lt;string&gt;'' User full name :* Suffix - ''&lt;string&gt;'' User suffix (eg. Jr)<br /> :* Title - ''&lt;string&gt;'' User form of address<br /> :* Email - ''&lt;string&gt;'' User email :* Locale - ''&lt;string&gt;'' User's last locale<br /> ==== catalogexport.security.performExternalLogin ==== : Authenticates a user and stores an external login key. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' userLoginId :# ''&lt;string&gt;'' password : Return''&lt;struct&gt;'' :* ExternalLoginKey - ''&lt;string&gt;'' Key to be provided to Opentaps in the request querystring<br /> ==== catalogexport.security.initializeCheckout ==== : Authenticate a user, set up a shopping cart, and return an external login key which can be used to redirect the user to the Opentaps checkout. (IE: http://demo1.opentaps.org/ecommerce/control/showcart?externalLoginKey=EL7429384 ) : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' userLoginId :# ''&lt;string&gt;'' password :# ''&lt;string&gt;'' catalogId :# ''&lt;string&gt;'' productStoreId :# ''&lt;struct&gt;'' cartItems of product Id - ''&lt;double&gt;'' quantity (note that virtual products will be ignored) : Return''&lt;struct&gt;'' :* ExternalLoginKey - ''&lt;string&gt;'' Key to be provided to Opentaps in the request querystring<br /> <br /> == Search Methods == ==== catalogexport.search.getAvailableProductFeatures ==== : Get available product features for populating a search form : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' userLocale : Return''&lt;struct&gt;'' AvailableFeatures :* featureTypeDescription =&gt; ''&lt;struct&gt;'' :** ''&lt;struct&gt;'' :*** FeatureTypeID - ''&lt;string&gt;'' Product feature type ID<br /> :*** Features - ''&lt;struct&gt;'' Features available :*** ''&lt;struct&gt;'' :**** featureDescription - ''&lt;''''struct''''&gt;'' :**** ''&lt;''''struct''''&gt;'' :***** FeatureID - ''&lt;string&gt;'' Product feature ID :***** ... <br /> ==== catalogexport.search.getSortOrders ==== : Get available sort orders for populating a search form : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' userLocale : Return''&lt;struct&gt;'' SortOrders :* sort order key - ''&lt;string&gt;'' Sort order description :* ...''''<br /> <br /> ==== catalogexport.search.searchProducts ==== : Search the catalog for products : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' catalogId :# ''&lt;string&gt;'' productStoreId :# ''&lt;string&gt;'' countryCode :# ''&lt;string&gt;'' categoryId :# ''&lt;string&gt;'' sortOrder :# ''&lt;string&gt;'' keywordString :# ''&lt;string&gt;'' searchOperator :# ''&lt;boolean&gt;'' searchSubcategories :# ''&lt;''''boolean''''&gt;'' ascendingSort :# ''&lt;array&gt;'' includeFeatureIds :# ''&lt;''''array''''&gt;'' excludeFeatureIds :# ''&lt;double&gt;'' priceRangeLow :# ''&lt;''''double''''&gt;'' priceRangeHigh : Return''&lt;array&gt;'' ProductIds''''<br /> ==== catalogexport.search.findProductsByKeyword ==== : Simplified access to the searchProducts method, specifying only a keyword string and using all default settings. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' catalogId :# ''&lt;string&gt;'' productStoreId :# ''&lt;string&gt;'' keywordString :# ''&lt;string&gt;'' userLocale : Return''&lt;array&gt;'' of ''&lt;struct&gt;'' of product data (see catalogexport.getProduct) ==== catalogexport.search.findRecentProducts ==== : Default product search limited to most recent products, ordered by creationDate descending. Limit, fromDate and toDate arguments are optional - if none are specified the entire catalog will be returned. : Arguments :# ''&lt;string&gt;'' systemId :# ''&lt;string&gt;'' catalogId :# ''&lt;string&gt;'' productStoreId :# ''&lt;int&gt;'' limit :# ''&lt;dateTime.iso8601&gt;'' fromDate :# ''&lt;dateTime.iso8601&gt;'' toDate : Return''&lt;array&gt;'' of ''&lt;struct&gt;'' of product data (see catalogexport.getProduct) <br />

Return to LiveCatalog XML-RPC API.