Introduction

This API provides you with several options to maintain your product catalog and search products in your catalog.

With this API you can create, update and delete products in your product catalog. The API automatically manages the product groups for you. The product group is identified by the groupID field (i.e. all the products with the same groupID are combined in a single product group). While the API allows you to get and delete product groups by group ID, the API does not allow you to directly modify the product groups. The only way to modify product groups is to use API options for products. With this approach the API tries to ensure that the data is not corrupted. When you delete a product group, all the products in the group are automatically deleted.

The search API is fairly powerful. It allows features like search on a specific field or a set of fields. The search API responds with product groups where the query matches certain fields. Search API also allows you to select if you want the standard facets (work on advanced features in progress) to be included in the API response. In addtion to the features mentioned above, the API syncs the search index with changes in products/product groups, in real-time. Also, for efficiency and speed, the search and GET product/productgroup responses are cached. Upon any updates the cache is updated as well, as needed.

We are continuously adding new features and improving this API, if you have any suggestions please reach out to us here

API Powered by:

NodeJS
Redis
Elastic Search
MongoDB

The current API version is: v1 Please replace {API version} with v1 in your API calls

API login

Get API access token

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZWNyZXQiOiJDb250ZUFtZXJpY2EuZmZhYWJiY2NkZCIsImlhdCI6MTU3NzU5NzA3NCwiZXhwIjoxNTc3NjgzNDc0fQ.OWmntF6eSpAxUqFovVO0I01p1QqEn_McQDNVm7ISoIk",
    "validFor": 86400,
    "success": true,
    "code": "OK",
    "message": "Access with valid credentials! Please include the token in the header of your subsequent API calls ..."
}

{
    "apiResponseKeySuccess": false,
    "apiResponseKeyCode": "INVALID",
    "message": "The token is not valid (anymore)! If you think that your token is expired please use the login endpoint to get a new token for your API calls ..."
}

{
    "success": false,
    "code": "INVALID",
    "message": "Invalid credentials or login attempt with valid credentials by an inactive customer!"
}

This endpoint gets your your API access token. You need to send your customer ID and the API key that we provided you for using our SaaS platform. Upon receiving your valid credentials, the API will respond with a token with additional information including the validFor key which tells you how long this access token is valid for. please set x-access-token to the value of the token key, in the header of your subsequent API calls.

HTTP Request

GET http://api.gallao.io/admin/{API version}/customers/login

URL Parameters

Parameter	Description
id	Your customer ID provided by us
apiKey	The apiKey that is sent by us

You do not need to invoke login too often. Please include the token that you receive upon a successful login, in your subsequent API calls until the token expires.

Response

Key	Description
token	The token that you will be including in your subsequent API calls
validFor	The validity of the token (in seconds)
success	Was the API call successful?
code	Additional code
message	Short message providing more information.

With the field validFor in response, you can calculate the time after with your servers need to login again to get a new token.

Products

Add a new product

{
    "success": true,
    "code": "OK",
    "reponse": {
        "images": [
            "https://homepages.cae.wisc.edu/~ece533/images/fruits.png"
        ],
        "searchKeywords": [
            "Biscuit"
        ],
        "category": [
            "Food>Snacks>Biscuit"
        ],
        "isMain": true,
        "sku": "9398111",
        "name": "Parle-G",
        "description": "biscuits",
        "groupID": "B39408",
        "regularPrice": 5.99,
        "promotionPrice": 2.99,
        "quantity": 38780,
        "color": "Brown",
        "brand": "Parle",
        "size": "Normal",
        "active": true
    }
}

Use this API endpoint to add a new product in the products collection. When a product is added in the products collection, this product is also added in product group collection. If the product group with the matching group ID is missing, a new product group is formed. Search index is also automatically updated with a valid call to this endpoint.

HTTP Request

POST http://api.gallao.io/catalog/{API version}/products

Header

Parameter	Description
x-access-token	The access token that you receive upon login
Content-Type	application/x-www-form-urlencoded

Body Parameters

Parameter   |          Constraints         |        Description

----------------| -----------------------------|------------------------------ sku | String, Max 50 Characters | The SKU of the product name | Text, Max 250 Characters | The name of the product description | Text, Max 2048 Characters | The description of the product groupID | String, Max 50 Characters | The product group ID regularPrice | Float, Greater than 0 | Everyday price promotionPrice | Float, Greater than 0 | On-sale price images | URL, Mandatory | Product images (recommended multiple) searchKeywords | Text, Mandatory | Keywords that you want this product to be searched with quantity | Integer, Greater than 0 | Inventory stock quantity category | Text, Mandatory | Category breadcrumbs color | Text, Optional | Product color brand | Text, Optional | Product brand size | Text, Optional | Product size active | Boolean, Mandatory | Is product available for sale? isMain | Boolean, Mandatory | Is the product main product in the group?

Response

    Key        |          Description

------------------ | ----------------------------- success | The flag that tells if the API request was successful code | Additional response code response | Product object sent in response

Get a specific product

{
    "_id": "5e07f2b5544f16401a1952e4",
    "images": [
        "https://homepages.cae.wisc.edu/~ece533/images/boat.png"
    ],
    "searchKeywords": [
        "Biscuit"
    ],
    "category": [
        "Food>Snacks>Biscuit"
    ],
    "isMain": true,
    "sku": "9398474",
    "name": "Krackjack",
    "description": "biscuits",
    "groupID": "B39408",
    "regularPrice": 7.99,
    "promotionPrice": 5.99,
    "quantity": 4435,
    "color": "Brown",
    "brand": "HIL",
    "size": "Square",
    "active": true
}

{
    "success": false,
    "code": "INVALID",
    "message": "Product with SKU 93984746 not found ..."
}

When you want to get a specific product you can use this endpoint. All you need to pass is your access token and the SKU. This endpoint is cached for efficiency but also ensures that updated product data is served when applicable.

HTTP Request

GET http://api.gallao.io/catalog/{API version}/products/{SKU}

Header

Parameter	Description
x-access-token	The access token that you receive upon login

URL Parameters

Parameter	Description
SKU	The product SKU

Response

Key         |          Description

----------------| ------------------------------ _id | Internal field, object identifier sku | The SKU of the product name | The name of the product description | The description of the product groupID | The product group ID regularPrice | Everyday price promotionPrice | On-sale price images | Product images (recommended multiple) searchKeywords | Keywords that you want this product to be searched with quantity | Inventory stock quantity category | Category breadcrumbs color | Product color brand | Product brand size | Product size active | Is product available for sale? isMain | Is the product main product in the group?

Update a product

{
    "success": true,
    "code": "OK",
    "message": "Product Updated",
    "reponse": {
        "images": [
            "https://homepages.cae.wisc.edu/~ece533/images/fruits.png"
        ],
        "searchKeywords": [
            "Biscuit"
        ],
        "category": [
            "Food>Snacks>Biscuit"
        ],
        "isMain": true,
        "sku": "9398111",
        "name": "Parle-G",
        "description": "biscuits",
        "groupID": "B39408",
        "regularPrice": 7.99,
        "promotionPrice": 2.99,
        "quantity": 38780,
        "color": "Brown",
        "brand": "Parle",
        "size": "Normal",
        "active": true
    }
}

Use this API endpoint to update your product information in the catalog. For now you need to pass the entire product object with updated parts (will be improved very soon). When you hit this endpoint the data in the database gets updated, product group data also gets updated automatically, search index is also updated and the cache entry is removed first and updated on the next GET call.

HTTP Request

PUT http://api.gallao.io/catalog/{API version}/products

Header

Parameter	Description
x-access-token	The access token that you receive upon login
Content-Type	application/x-www-form-urlencoded

Body Parameters

Parameter   |          Constraints         |        Description

----------------| -----------------------------|------------------------------ sku | String, Max 50 Characters | The SKU of the product name | Text, Max 250 Characters | The name of the product description | Text, Max 2048 Characters | The description of the product groupID | String, Max 50 Characters | The product group ID regularPrice | Float, Greater than 0 | Everyday price promotionPrice | Float, Greater than 0 | On-sale price images | URL, Mandatory | Product images (recommended multiple) searchKeywords | Text, Mandatory | Keywords that you want this product to be searched with quantity | Integer, Greater than 0 | Inventory stock quantity category | Text, Mandatory | Category breadcrumbs color | Text, Optional | Product color brand | Text, Optional | Product brand size | Text, Optional | Product size active | Boolean, Mandatory | Is product available for sale? isMain | Boolean, Mandatory | Is the product main product in the group?

Response

    Key        |          Description

------------------ | ----------------------------- success | The flag that tells if the API request was successful code | Additional response code response | Product object with updated data is sent in response message | Additional message for more information on the API response

Delete a product

{
    "success": true,
    "code": "OK",
    "message": "Product with SKU 9398473 deleted and the product group is updated ..."
}

{
    "success": false,
    "code": "INVALID",
    "message": "Product with SKU 9398473 does not exist ..."
}

Use this API endpoint to remove a product from the catalog. When you hit this endpoint with a valid request, the product in the product collection gets removed, the product collection is automatically updated and the cache and search index is also updated.

HTTP Request

DELETE http://api.gallao.io/catalog/{API version}/products/{SKU}

Header

Parameter	Description
x-access-token	The access token that you receive upon login

URL Parameters

Parameter	Description
SKU	the SKU of the product to be deleted

Product Groups

Get a product group

{
    "_id": "5e07f10b544f16401a195281",
    "productSKUs": [
        "9398111",
        "9398474"
    ],
    "colors": [
        "Brown"
    ],
    "brands": [
        "Parle",
        "HIL"
    ],
    "sizes": [
        "Normal",
        "Square"
    ],
    "images": [
        "https://homepages.cae.wisc.edu/~ece533/images/fruits.png"
    ],
    "searchKeywords": [
        "Biscuit"
    ],
    "category": [
        "Food>Snacks>Biscuit"
    ],
    "groupID": "B39408",
    "name": "Parle-G",
    "description": "biscuits",
    "regularPriceMin": 7.99,
    "regularPriceMax": 7.99,
    "promotionPriceMin": 2.99,
    "promotionPriceMax": 5.99,
    "active": true,
    "products": {
        "9398111": {
            "sku": "9398111",
            "regularPrice": 7.99,
            "promotionPrice": 2.99,
            "images": [
                "https://homepages.cae.wisc.edu/~ece533/images/fruits.png"
            ],
            "searchKeywords": [
                "Biscuit"
            ],
            "quantity": 38780,
            "active": true,
            "category": [
                "Food>Snacks>Biscuit"
            ],
            "attributes": null,
            "color": "Brown",
            "brand": "Parle",
            "size": "Normal",
            "isMain": true
        },
        "9398474": {
            "sku": "9398474",
            "regularPrice": 7.99,
            "promotionPrice": 5.99,
            "images": [
                "https://homepages.cae.wisc.edu/~ece533/images/boat.png"
            ],
            "searchKeywords": [
                "Biscuit"
            ],
            "quantity": 4435,
            "active": true,
            "category": [
                "Food>Snacks>Biscuit"
            ],
            "attributes": null,
            "color": "Brown",
            "brand": "HIL",
            "size": "Square",
            "isMain": false
        }
    }
}

{
    "success": false,
    "code": "INVALID",
    "message": "Product Group with ID B3940866 not found ..."
}

This API endpoint gets a specific product group by product group ID. This endpoint is cached for efficiency and speed.

HTTP Request

GET http://api.gallao.io/catalog/{API version}/productgroups/{PGID}

Header

Parameter	Description
x-access-token	The access token that you receive upon login

URL Parameters

Parameter	Description
PGID	The ID of the product group that you wish to get

Response

  Key             |             Description

--------------------- | ------------------------------------ productSKUs | A list of SKUs of all the products in the group colors | A list of all the colors from all the products in the group brands | A list of all the brands from all the products in the group sizes | A list of all the sizes from all the products in the group images | A list of all the images from the main product in the group searchKeywords | A list of all the searchKeywords from all the products in the group category | Category from the main product in the group groupID | Product group ID to uniquely identify this product group name | Name from the main product in the group description | Product description regularPriceMin | Minimum regular price computed in the group regularPriceMax | Maximum regular price computed in the group promotionPriceMin | Minimum promotion price computed in the group promotionPriceMax | Maximum promotion price computed in the group active | Active flag to indicate if the product is available for sale products | List of all the product objects for reference

Delete a product group

{
    "success": true,
    "code": "OK",
    "message": "Product group is now deleted ..."
}

{
    "success": false,
    "code": "INVALID",
    "message": "Product Group with ID 9398473 does not exist ..."
}

Use this API endpoint to remove a product group from the product group collection in the database. This call also updates the search index. When a product group is deleted, entries of related products in the products collection are also removed.

HTTP Request

DELETE http://api.gallao.io/catalog/{API version}/productgroups/{PGID}

Header

Parameter	Description
x-access-token	The access token that you receive upon login

URL Parameters

Parameter	Description
PGID	the group ID of the product group to be deleted

Search

Basic search

{
    "took": 7,
    "timed_out": false,
    "_shards": {
        "total": 1,
        "successful": 1,
        "skipped": 0,
        "failed": 0
    },
    "hits": {
        "total": {
            "value": 1,
            "relation": "eq"
        },
        "max_score": 0.18232156,
        "hits": [
            {
                "_index": "conteamerica.ffaabbccdd.productgroups.index",
                "_type": "_doc",
                "_id": "B39408",
                "_score": 0.18232156,
                "_source": {
                    "productSKUs": [
                        "9398111",
                        "9398474"
                    ],
                    "colors": [
                        "Brown"
                    ],
                    "brands": [
                        "Parle",
                        "HIL"
                    ],
                    "sizes": [
                        "Normal",
                        "Square"
                    ],
                    "images": [
                        "https://homepages.cae.wisc.edu/~ece533/images/fruits.png"
                    ],
                    "searchKeywords": [
                        "Biscuit"
                    ],
                    "category": [
                        "Food>Snacks>Biscuit"
                    ],
                    "groupID": "B39408",
                    "name": "Parle-G",
                    "description": "biscuits",
                    "regularPriceMin": 7.99,
                    "regularPriceMax": 7.99,
                    "promotionPriceMin": 2.99,
                    "promotionPriceMax": 5.99,
                    "active": true,
                    "products": {
                        "9398111": {
                            "sku": "9398111",
                            "regularPrice": 7.99,
                            "promotionPrice": 2.99,
                            "images": [
                                "https://homepages.cae.wisc.edu/~ece533/images/fruits.png"
                            ],
                            "searchKeywords": [
                                "Biscuit"
                            ],
                            "quantity": 38780,
                            "active": true,
                            "category": [
                                "Food>Snacks>Biscuit"
                            ],
                            "attributes": null,
                            "color": "Brown",
                            "brand": "Parle",
                            "size": "Normal",
                            "isMain": true
                        },
                        "9398474": {
                            "sku": "9398474",
                            "regularPrice": 7.99,
                            "promotionPrice": 5.99,
                            "images": [
                                "https://homepages.cae.wisc.edu/~ece533/images/boat.png"
                            ],
                            "searchKeywords": [
                                "Biscuit"
                            ],
                            "quantity": 4435,
                            "active": true,
                            "category": [
                                "Food>Snacks>Biscuit"
                            ],
                            "attributes": null,
                            "color": "Brown",
                            "brand": "HIL",
                            "size": "Square",
                            "isMain": false
                        }
                    }
                }
            }
        ]
    }
}

Use this API endpoint to search a product group in the search index. Please note that product group objects are only returned in the response.

HTTP Request

GET http://api.gallao.io/search/v1/search

Header

Parameter	Description
x-access-token	The access token that you receive upon login

URL Parameters

Parameter	Description
q	Alphanumeric, main query parameter
qfield	String, Multiple, query fields
debug	Boolean, to show additional information from search servers
facets	Boolean, include standard facets

Response

  Key             |             Description

--------------------- | ------------------------------------ took | query response time timed_out | boolean: was the query request timed out _shards | details on sharding hits | query matches aggregations | Is included when facets = true

Name		Name	Last commit message	Last commit date
Latest commit History 87 Commits
conf		conf
docs		docs
.gitignore		.gitignore
App.js		App.js
CatalogAPI.properties		CatalogAPI.properties
CatalogApi.js		CatalogApi.js
Consumer.js		Consumer.js
Customer.js		Customer.js
Database.js		Database.js
LICENSE		LICENSE
Order.js		Order.js
Product.js		Product.js
ProductGroup.js		ProductGroup.js
README.md		README.md

License

viveknarang/CatalogAPI

Folders and files

Latest commit

History

Repository files navigation

Introduction

API login

Get API access token

HTTP Request

URL Parameters

Response

Products

Add a new product

HTTP Request

Header

Body Parameters

Response

Get a specific product

HTTP Request

Header

URL Parameters

Response

Update a product

HTTP Request

Header

Body Parameters

Response

Delete a product

HTTP Request

Header

URL Parameters

Product Groups

Get a product group

HTTP Request

Header

URL Parameters

Response

Delete a product group

HTTP Request

Header

URL Parameters

Search

Basic search

HTTP Request

Header

URL Parameters

Response

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages