Syncing Products
Use product sync APIs to sync the product and inventory of your store with Growlytics. This article will give you all the details you need to create products, collections and map products to collections.
Data Structure Of Product And Collections
The data structure of products and collections is many to many kinds of relationships. One collection can have multiple products and one product can be in multiple collections.
Add/Update Products
POST
https://dc.growlytics.in /product
Using /product
API, you can add products to Growlytics. If a product not found with the given id, it will be created, else it will be updated.
Headers
Name | Type | Description |
---|---|---|
x-growlytics-key | String | Growlytics API Key |
Request Body
Name | Type | Description |
---|---|---|
id | string | Product id. Your system's unique product id. Max 50 chars allowed. |
name | string | Product name. Max 2000 chars allowed. |
image | string | Product Image url. Max 1000 characters allowed. |
description | string | Product description. Max 2000 characters allowed. Null and empty values are alo allowed. |
url | string | Url of the product. Max 1000 characters allowed. |
price | number | Price of the product. Decimals are also allowed. Example: 12.20, 1321, 15.5 |
originalHigherPrice | number | Product price without discount. Decimals are also allowed. Provide this field to show discounts in the campaign messages. |
vendor | string | Vendor of the product. Max 1000 characters allowed. |
status | string | Inventory status of the product. Allowed values are |
Remove Product
DELETE
https://dc.growlytics.in/product/:id
Use this API to delete products from Growlytics's product dataset.
Path Parameters
Name | Type | Description |
---|---|---|
id | string | Product Id. Your system's product Id. Max 50 characters allowed. |
Headers
Name | Type | Description |
---|---|---|
x-growlytics-key | string | Growlytics API Key |
Add/Update Collection
POST
https://dc.growlytics.in/collection
Using /collection
API, you can add or update collection in the Growlytics collection dataset. If a collection does not exist for given id, it will be created, else it will be updated.
Headers
Name | Type | Description |
---|---|---|
x-growlytics-key | string | Growlytics API Key |
Request Body
Name | Type | Description |
---|---|---|
id | string | Collection Id. Your system's unique collection id. Max 50 chars allowed. |
name | string | Collection name. Max 2000 characters allowed. |
image | string | |
url | string |
Delete Collection
DELETE
https://dc.growlytics.in/collection/:id
Use this api to delete collection from Growlytics collection dataset. You will need to pass the id of the collection in url.
Path Parameters
Name | Type | Description |
---|---|---|
id | string | Id of the collection to be removed. Your system's collection id. |
Headers
Name | Type | Description |
---|---|---|
x-growlytics-key | string | Growlytics API Key. |
Mapping Products & Collections
Products and Collections have many to many relationships. You can use APIs to add or remove multiple products from a particular collection.
Add products to the collection
POST
https://dc.growlytics.in/collection/:id/products/add
Use this API to add multiple products to the collection. You will need to pass the collection id in the URL.
Path Parameters
Name | Type | Description |
---|---|---|
id | string | Collection id. Your system's collection id. |
Request Body
Name | Type | Description |
---|---|---|
products | array | Array of string. List of product ids. Example: ['produc id 1', 'product id 2'] |
Make sure you have added products and collections in Growlytics before adding them to any collection. In short, products and collections to be mapped must exist in Growlytics.
Remove products from the collection
POST
https://dc.growlytics.in/collection/:id/products/remove
Use this API to remove multiple products from a particular collection. You will need to pass the collection id in the URL.
Path Parameters
Name | Type | Description |
---|---|---|
id | string | Collection id. Your system's collection id. |
Request Body
Name | Type | Description |
---|---|---|
products | array | Array of string. List of product ids. Example: ['pid 1', 'pid 2'] |
Last updated