Web Service API
The following operations are supported. For a formal definition, please review the Service Description.
-
GetAvailableLanguages
Returns all available language codes
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
Returns:
Returns all available language codes -
GetCataloguePricesAndBreaks
Returns the prices and breaks available in the Smiffy's catalogue (standard price breaks)
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
Returns:
The prices and breaks available in the Smiffy's catalogue (standard price breaks) -
GetCategoryList
Returns all product categories. Use Code (CategoryCode) to get the product information from a category
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
Returns:
All product categories. Use Code (CategoryCode) to get the product information from a categories -
GetCustomerPriceList
Returns the prices and breaks available in the authenticated user's price list
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
Returns:
The prices and breaks available in the authenticated user's price list -
GetDroppedProducts
Returns all products that have been dropped by a given date.
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
cutOffDate: The date use when checking for dropped products
LanguageCode: The two letter language code e.g. EN
Returns:
All prodcuts that have been dropped by a given date. -
GetFullDataSet
Returns full product list
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
LanguageCode: The two letter language code e.g. EN
Returns:
Full product list -
GetPackThemes
Returns all pack themes with the corresponding description
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
Returns:
All pack themes with the corresponding description -
GetPriceList
Returns the prices and breaks for an authenticated user and for a specific product code, along with a description if a match break has been applied)
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
Returns:
The prices and breaks for an authenticated user and for a specific product code, along with a description if a match break has been applied) -
GetProductSizes
Returns all available sizes for a product. Can be called with the base product code or a specific size. Extended size description is also returned.
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
productCode: The Product Code you want to check
LanguageCode: The two letter language code e.g. EN
Returns:
All available sizes for a product. Can be called with the base product code or a specific size. Extended size description is also returned. -
GetProduct_AllDetails
Returns all product information available for a specific product code
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
productCode: The Product Code you want to check
LanguageCode: The two letter language code e.g. EN
Returns:
All product information available for a specific product code -
GetProduct_ByProperty
Returns a single piece of product information
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
productCode: The Product Code you want to check
LanguageCode: The two letter language code e.g. EN
propertyName: The property name of the value you want to return this can be any of the following values 'code','name' ,'description' ,'brochuredescription','packageqty' ,'deleted' ,'eta' ,'licensed' ,'colour' ,'carton' , 'washinginstructions','withaccessories' ,'accessory1' ,'accessory2' ,'accessory3' ,'accessory4' ,'accessory5' , 'alternative1' ,'alternative2' ,'alternative3' ,'alternative4' ,'alternative5' ,'packtype' ,'safety' ,'size' ,'extsize', 'height' ,'length' ,'width' ,'weight' ,'packagingtype' ,'isplatinum' ,'iscostume' ,'barcode' ,'boxed' ,'cataloguePage' , 'suitability' ,'gender' ,'stockqty' ,'rrpincvat' ,'rrpexvat' ,'height' ,'width' ,'weight' ,'length' ,'additionaltheme' , 'price1' ,'break1' ,'price2' ,'break2' ,'price3' ,'break3'Returns: all product information available specific product code
-
GetProduct_CatalogueAccessories
Returns all accessories defined for a product in the current catalogue
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
productCode: The Product Code you want to check
LanguageCode: The two letter language code e.g. EN
Returns:
All accessories defined for a product in the current catalogue -
GetProduct_CatalogueAlternatives
Returns all accessories defined for a product in the current catalogue
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
productCode: The Product Code you want to check
LanguageCode: The two letter language code e.g. EN
Returns:
All accessories defined for a product in the current catalogue -
GetProduct_Images
Returns all images for a product(Side Shot, Front Shot, Back Shot, Main Image).
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
productCode: The Product Code you want to check
Returns:
All images for a product(Side Shot, Front Shot, Back Shot, Main Image). -
GetProduct_NonEFProducts
Return all products which are not on the EF list.
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
Returns:
All products which are not on the EF list. -
GetProducts_InSecondaryTheme
Returns all items found in the specified secondary pack theme.
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
packTheme: The name of the pack theme you want to filter by
Returns:
All items found in the specified secondary pack theme.
-
GetProducts_InTheme
Returns all items found in the specified pack theme.
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
packTheme: The name of the pack theme you want to filter by
LanguageCode: The two letter language code e.g. EN
Returns:
Returns all items found in the specified pack theme. -
GetProducts_In_Category
Returns all available product categories
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
category: The category you want to filter by is a code code return by GetCategoryList
exactMatch:a boolean value, must be set as either 'true' or 'false'
LanguageCode: The two letter language code e.g. EN
Returns:
All available product categories -
GetSecondaryTheme
Returns a list of secondary themes and their description
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
Returns:
A list of secondary themes and their description -
GetStockQuantities_AsStockData
Returns all available stock into an Array of Type StockData (developers only)
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
LanguageCode: The two letter lange code e.g. EN
Returns:
All available stock into an Array of Type StockData -
GetStockQuantities_InBatchesOf500_XML
Returns all available stock into an XML Format in batches of 500 products.
If you wish to retrieve all products in one go, use the light version.
To retrieve specific codes only, fill in the FilterCodeLike parameter
and this will get you only the product code that start with the specified character sequence.
If you want to filter by product name/description, fill in the FilterDescriptionLike parameter
and you will get only products containing the specified string.
Example: Batch 1, Code: 225, Description Hawaii. This will return all codes that start with 255*
and contain hawaii in the description. As a recommendation, use Batch 1 when filtering data because the result set
is usually less then 500 productsParams:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
batchNumber: The batch number, batch number 1 return the first 500 result, batch 2 return the next 500.
if there is less than 500 results, requesting batch number 2 will return nothing. filterCode: A Partial or Full Product Code to filter the data on
filterDescription: A Partial or Full Product Description to filter the data on
LanguageCode: The two letter language code e.g. EN
Returns:
All available stock into an XML Format in batches of 500 products. -
GetStockQuantities_LightVersion_XML
Returns all available stock into an XML Format in pairs of product_code, Available_Stock, Due_Date.
Params:
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
filterCode: A Partial or Full Product Code to filter the data on
filterDescription: A Partial or Full Product Description to filter the data on
Returns:
All available stock into an XML Format in batches of 500 products. -
GetThemeGroups
Returns all the theme groups. Multiple themes can be found in a group. This is the SOAP method.
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
Returns:
All the theme groups. Multiple themes can be found in a group. This is the SOAP method. -
GetThemesAndProducts
Returns all themes and the products associated with them
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
LanguageCode: The two letter language code e.g. EN
Returns:
All themes and the products associated with them. -
GetThemes_In_Group
Returns all themes that belong to this theme group for a specific theme group id.
Params:
apiKey: Your 'API Key'
clientID: Your 'Client ID'
themeGroupID: The ThemeGroupID you want to query
Returns:
All themes that belong to this theme group for a specific theme group id.