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

Query Product

Products can be searched for through PerfectSync based on a search term. Different orders, only the product itself from the catalog. The results supply identifiers, availability information, and pricing for each product related to the search term. However, note that data parameters such as availability cannot be used as search criteria. Only a generic search term may be provided by the user, and the results will include all potentially related products.

This API is triggered during the create order flow within the Customer Care UI. To add a product to the cart, it is searched for on the Find Product screen and the Query Product API returns the results and their product details.

Version1.0
Callhttps://integration.shopatron.com/api/snap/v1/product/?{search term}
Supported FormatsJSON
HTTP MethodGET
Schemahttps://integration.shopatron.com/api/snap/v1/product.json

The .json address above can be used to access the schema within Postman.

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 orders related to “shoes” would use the following format:

  • https://integration.shopatron.com/api/snap/v1/product/?term=shoes

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 100. Switch between pages of results by appending the page parameter to the call. For example:

  • https://integration.shopatron.com/api/snap/v1/product/?term=shoes&perPage=2&page=2

Additionally, “sortBy=relevance” can also be appended to sort by the closest matching value to the search term. This is the only value of sortBy that is supported by Customer Care at this time.

Example

The example case creates an API call to search for a product that has the following properties:

  • Search term = “rolex”

This guide will demonstrate how to put together each section of the request.

Header

Note that all PerfectSync integration APIs use Basic Authorization, a Base64 encoded string of the username and password combination separated by a colon. This authorization will be included in the header for every API call, along with the following:

Header NameDescriptionData Type
Kibo-Manufacturer-IdThis contains the Kibo OMS manufacturer identifierInteger
Kibo-Catalog-IdThis contains the Kibo OMS product catalog identifierInteger
Kibo-Currency-CodeThe product catalog currency ISO codeString
Kibo-LocaleThe product catalog locale ISO codeString

Required Parameters

Unlike the REST APIs for order management outside of PerfectSync, querying is done only by a generic search time. A specific parameter of the product or order data cannot be searched for, but sortBy can be used to improve the results as explained above.

ParameterTypeDescription
termstringSearch term or terms to query products by. The minimum length is “1” and the maximum length is “100”.

Optional Parameters

The following parameters do not have to be provided because they are either optional or they have a default value that may not need to be changed.

ParameterTypeDescription
pageintegerThe page number to begin listing the results from. The default and minimum value is “1”. While this parameter is technically required, this default means that it does not have to be provided in the request unless a different page is specifically desired.
perPageintegerThe (max) number of items to return per results page. 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 length is 1.

The Full Request

This is the entire request that will search for “rolex” products.

https://integration.shopatron.com/api/snap/v1/product/?term=rolex

The Full Response

The response will provide a list of all appropriate results and their blocks of product data.

{
    "totalCount": 380,
    "nextPage": 2,
    "perPage": 10,
    "collection": [{
        "productID": "VRX33151",
        "partNumber": "VRX33151",
        "availability": "yes",
        "imageUrl": "url.com/images/image.png",
        "price": 3650.0,
        "currency": "USD",
        "name": "18K Yellow Gold and Stainless Steel Datejust Automatic"
    }, {
        "productID": "VRX9706744",
        "partNumber": "VRX9706744",
        "availability": "yes",
        "imageUrl": "url.com/images/image.png",
        "price": 13500.0,
        "currency": "USD",
        "name": "18K Yellow Gold and Stainless Steel Daytona Automatic"
    }, {
        "productID": "VRX33175",
        "partNumber": "VRX33175",
        "availability": "yes",
        "imageUrl": "url.com/images/image.png",
        "price": 7495.0,
        "currency": "USD",
        "name": "18K Yellow Gold and Stainless Steel Datejust Automatic "
    }, {
        "productID": "VRX33063",
        "partNumber": "VRX33063",
        "availability": "yes",
        "imageUrl": "url.com/images/image.png",
        "price": 5650.0,
        "currency": "USD",
        "name": "18K Yellow Gold and Stainless Steel Datejust Automatic "
    }, {
        "productID": "VRX9706783",
        "partNumber": "VRX9706783",
        "availability": "yes",
        "imageUrl": "url.com/images/image.png",
        "price": 65000.0,
        "currency": "USD",
        "name": "Platinum Day-Date Special Edition Automatic"
    }, {
        "productID": "VRX33154",
        "partNumber": "VRX33154",
        "availability": "yes",
        "imageUrl": "url.com/images/image.png",
        "price": 3650.0,
        "currency": "USD",
        "name": "18K Yellow Gold and Stainless Steel Datejust Automatic"
    }, {
        "productID": "VRX9706635",
        "partNumber": "VRX9706635",
        "availability": "yes",
        "imageUrl": "url.com/images/image.png",
        "price": 3650.0,
        "currency": "USD",
        "name": "18K Yellow Gold and Stainless Steel Datejust Automatic"
    }, {
        "productID": "VRX9706738",
        "partNumber": "VRX9706738",
        "availability": "yes",
        "imageUrl": "url.com/images/image.png",
        "price": 5450.0,
        "currency": "USD",
        "name": "18K Yellow Gold and Stainless Steel Datejust Automatic "
    }, {
        "productID": "VRX33144",
        "partNumber": "VRX33144",
        "availability": "yes",
        "imageUrl": "url.com/images/image.png",
        "price": 5100.0,
        "currency": "USD",
        "name": "18K Rose Gold Cellini Cestello Manual"
    }, {
        "productID": "VRX9706735",
        "partNumber": "VRX9706735",
        "availability": "yes",
        "imageUrl": "url.com/images/image.png",
        "price": 17995.0,
        "currency": "USD",
        "name": "18K Yellow Gold Daytona Automatic"
    }],
}