Catalogue Management Service

Complete Catalogue Management service on the cloud. This service provides several utility methods to manage catalogues, categories and items. The user can add items with its related information in a particular category and there can be several categories in a catalogue. The developer can also create multiple catalogues if required for example: Catalogue for gadgets, apparels, etc. The cart service can be used along with catalogue service to create an end to end shopping feature for your app.

Import Statement
  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Initialize

In order to use the various functions available in a specific API, the developer has to initialize with App42API by passing the apiKey and the secretKey which will become available after the app creation from AppHQ dashboard.

Required Parameters

apiKey - The Application key given when the application was created. secretKey - The secret key corresponding to the application key given when the application was created.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Build Service

After initialization, the developer will have to call the buildXXXService method on App42API to get the instance of the particular API that they wish to build. For example, to build an instance of CatalogueService, buildCatalogueService() method needs to be called.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Create Catalogue

Create a catalogue for a particular app. Categories can be added to the catalogue.

Required Parameters

catalogueName - Name of the catalogue to be created. description - Description of the catalogue to be created.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Create Category

Creates a category for a particular catalogue such as books, movies, etc.

Required Parameters
catalogueName - Name of the catalogue in which category has to be created. categoryName - Name of the category that has to be created. description - Description of the category to be created.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Add Item

Creates an item in a category for a particular catalogue.

Required Parameters
catalogueName - Name of the catalogue in which item has to be added. categoryName - Name of the category in which item has to be added. itemData - Item information.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Get Items

Fetch all items for a Catalogue.

Required Parameters

catalogueName - Name of the catalogue from which item has to be fetched.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Get Items By Category

Fetch all items in a category for a catalogue.

Required Parameters

catalogueName - Name of the catalogue from which item has to be fetched. categoryName - Name of the category from which item has to be fetched.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Get Items By Category Count

Fetche count of all items in a particular category for a catalogue.

Required Parameters

catalogueName - Name of the catalogue from which count of the item has to be fetched. categoryName - Name of the category from which count of the item has to be fetched.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Get Items By Category Paging

Fetch all items in a category for a catalogue by paging.

Required Parameters

catalogueName - Name of the catalogue from which item has to be fetched. categoryName - Name of the category from which item has to be fetched. max - Maximum number of records to be fetched. offset - From where the records are to be fetched.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Get Item By ID

Fetch item by ID in a category for a catalogue.

Required Parameters

catalogueName - Name of the catalogue from which item has to be fetched. categoryName - Name of the category from which item has to be fetched. itemId - Item ID for which information has to be fetched.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Remove All Items

Remove all items in a catalogue.

Required Parameters

catalogueName - Name of the catalogue from which items have to be removed.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Remove Items By Category

Removes all the items in a category for a catalogue.

Required Parameters

catalogueName - Name of the catalogue from which item has to be removed. categoryName - Name of the category from which item has to be removed.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Remove Items By ID

Remove Item by ID in a particular category for a catalogue.

Required Parameters

catalogueName - Name of the catalogue from which item has to be removed. categoryName - Name of the category from which item has to be removed. itemId - Item ID which has to be removed.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Delete Category

Delete a category from a particular catalogue.

Required Parameters

catalogueName - Name of the catalogue from which catalogue has to be removed. categoryName - Name of the category which you have to remove.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Exception Handling

The functions available under Catalogue API can throw some exceptions in abnormal conditions. For example, if a developer is creating a category under the catalogue which is not in a database, the function will throw the App42Exception (as shown below) with the message as “Not Found” and the appErrorCode as “3401” and the details as “Catalogue by the name ‘@catalogueName’ does not exist”.

  • create User Api for Android
  • create User Api for Windows
  • create User Api for iOS
  • create User Api for Swift
  • create User Api for Java
  • create User Api for Unity
  • create User Api for JS
  • create User Api for Corona
  • create User Api for Cocos2DX
  • create User Api for .Net
  • create User Api for PHP
  • create User Api for Marmalade
  •  create User Api for Ruby
  •  create User Api for Flash
Error Codes

Functions in Catalogue API might throw exceptions with following HTTP and Application Error Codes (along with their descriptions):

1400 - BAD REQUEST - The requested parameters are invalid. 1401 - UNAUTHORIZED - Client is not authorized. 1500 - INTERNAL SERVER ERROR - Internal Server Error. Please try again. 3400 - BAD REQUEST - The request parameters are invalid. Catalogue by the name '@catalogueName' already exists. 3401 - NOT FOUND - Catalogue by the name '@catalogueName' does not exist. 3402 - BAD REQUEST - The request parameters are invalid. Category by the name '@categoryName' for the Catalogue by the name '@catalogueName' already exists. 3403 - NOT FOUND - Category by the name '@categoryName' for the Catalogue by the name '@catalogueName' does not exist. 3404 - BAD REQUEST - The request parameters are invalid. The Item with the id '@itemId' for the Category by the name '@categoryName' and Catalogue by the name '@catalogueName' already exists. 3405 - NOT FOUND - Item with the id '@itemId' for the Category by the name '@categoryName' and Catalogue by the name '@catalogueName' does not exist. 3406 - NOT FOUND - Item with the id '@itemId' does not exist. 3407 - NOT FOUND - The number of items for Category by the name '@categoryName' for Catalogue by the name '@catalogueName' is less than the specified : + "offset".