OMS DOCUMENTATIONRESOURCE CENTER

These guides provide examples for many tasks that a developer will need to be familiar with during implementation.

KIBO OMS DEVELOPMENT

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.

Knowing the proper catalog for the manufacturer and/or store is necessary before creating an order.

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

The .json address above can be used to access the schema within Postman. An example use of the API follows below, or view 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]

In the case of performing a search with multiple terms of the same parameter, such as retrieving multiple manufacturer IDs at once, use a comma-separated list as shown below. The maximum amount of terms that can be passed into the search query is 100.

  • https://integration.shopatron.com/api/v2/catalog/?manufacturerID=[ManufacturerID One],[Manufacturer ID Two],[Manufacturer ID Three]

GET calls that support pagination for numerous results, such as when searching, also accept a perPage parameter that defines how many results can be returned on each page. The default is 10 and the maximum is 200. Switch between pages of results by appending the page parameter to the call.

  • https://integration.shopatron.com/api/v2/catalog/?manufacturerID=[Manufacturer ID]&perPage=2&page=2

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
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
pageintegerThe page number to begin listing the results from. The default and minimum value is “1”.
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 minimum value is “0”.
catalogIDsstring A single or list of catalogIDs, which are positive integers. Use this to provide multiple catalogIDs or provide a single one as a string instead of an integer (as in the catalogID parameter). The minimum length is 1.

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"
}