KIBO OMS DOCUMENTATION

Catalog Search

The Catalog Search API is used to search for the catalogs of manufacturers in the Kibo system. It can return either information about a specific catalog, or a summary of all catalogs that belong to that particular manufacturer.

Version2.0
Callhttps://integration.shopatron.com/api/v2/catalog
Supported FormatsJSON
HTTP MethodGET
Schemahttps://integration.shopatron.com/api/v2/schema/catalog.json

The .json address above can be used to access the schema within Postman. An example use of the API follows here — or go directly to the schema or the sample Postman collection.

The request itself is built within the URL by adding a “/?” to the call followed by specific parameters joined by the “&” symbol. For instance, searching for a specific catalog (usually designated with an integer) from a certain manufacturer would use the following format:

  • https://integration.shopatron.com/api/v2/catalog/?manufacturerID=[Manufacturer ID]&catalogID=[Catalog ID]

Example

This example case creates a call that will search for all catalogs from a particular manufacturer:

  • Manufacturer 00000

Required Parameters

The API call always requires a manufacturer to be specified when searching for a catalog:

ParameterTypeDescription
pageintegerThe page number to start displaying the results at. The minimum and default value is "1".
manufacturerIDintegerA unique identifier for a manufacturer. The minimum value is "1".

Optional Parameters

The API can also search for any of these additional elements:

ParameterTypeDescription
perPageintegerThe (max) number of items to return. The minimum value is "1" and the maximum value is "100". The default is "10".
sortBystringThe field(s) to sort results by, use a minus (-) in front of field name for descending, a plus (+) for ascending. The minimum value is "1".
catalogIDintegerThe catalog number for a manufacturer.

The Full Request

Using the URL format as outlined above, the entire call is fairly simple to put together. This sample will search for catalogs matching the example’s parameters.

https://integration.shopatron.com/api/v2/catalog/?manufacturerID=00000

The Full Response

The API returns the following response. This particular manufacturer had 7 catalogs that were returned.

{
 "collection": [
 {
 "catalogID": 0,
 "manufacturerCatalogID": "00000.0",
 "catalogName": "Store One",
 "manufacturerID": 00000
 },
 {
 "catalogID": 1,
 "manufacturerCatalogID": "00000.1",
 "catalogName": "Store Two",
 "manufacturerID": 00000
 },
 {
 "catalogID": 2,
 "manufacturerCatalogID": "00000.2",
 "catalogName": "Store Three",
 "manufacturerID": 00000
 },
 {
 "catalogID": 3,
 "manufacturerCatalogID": "00000.3",
 "catalogName": "Store Four",
 "manufacturerID": 00000
 },
 {
 "catalogID": 4,
 "manufacturerCatalogID": "00000.4",
 "catalogName": "Store Five",
 "manufacturerID": 00000
 },
 {
 "catalogID": 5,
 "manufacturerCatalogID": "00000.5",
 "catalogName": "Store Six",
 "manufacturerID": 00000
 },
 {
 "catalogID": 6,
 "manufacturerCatalogID": "00000.6",
 "catalogName": "Store Seven",
 "manufacturerID": 00000
 }
 ],
 "page": 1,
 "perPage": 10,
 "totalCount": 7,
 "queryString": "manufacturerID=00000"
}

Megan MayfieldOMS Dev: Catalog Search