Creating an account

Before you start sending events or capturing user profiles, you will need to create your business account on the Contlo platform.

To create an account, you can go to Sign Up on Contlo and create a free account, or get in touch with our support team at [email protected]

Getting your API key

Once your account is setup, you will need an API_KEY to send data to Contlo. You can get the API_KEY from the API Keys tab under Store Settings.

Syncing your Product catalogue

Once you have your API_KEY, you can use our Product API for syncing your product catalogue with your account.

Contlo manages products on 3 levels:

  • Collections
  • Products
  • Variants

Syncing collections

To sync collections, you need to pass all categories using the /collection endpoint. This can be done by passing the following parameters in your payload to the endpoint:



collectionIdstringCollection ID in your system
titlestringCollection title

Syncing products

Now, to sync your products which belong to various collections, you need to pass products data using the /product endpoint. This can be done by passing the following parameters in your payload to the endpoint:

productIdstringProduct ID in your system
titlestringProduct title
statusstringValues: ACTIVE, ARCHIVED
descriptionstringProduct description. We'll limit it to 30 words.
productUrlstringLink to product page
imageUrlstringLink to product image
vendorstringProduct vendor
publishedAtstring (format: date-time)Product publishing date. Use the format. Example: 2017-06-30T17:00:00Z
tagsarray of stringsArray of product tags.
collectionIdsarray of stringsArray of categories ID's. Pass all categories ID's, including all parent categories ID's, to which product belongs.
trackInventorybooleanIf you want to use inventory numbers for your use cases, send this as true.
variantsarray of objectsArray with product variants. Product must have at least one variant. If your product doesn't have variants, use the product's info as the variant (example: variantID = productID, title=variants.title, etc.)
variant.variantIdstringProduct variant identificator
variant.titlestringVariant title
variant.skustringVariant's stock keeping unit
variant.priceintegerVariant price in numbers
variant.oldPriceintegerVariant old price in numbers
variant.currencyCodestringCurrency code of variant prices. Follow ISO 4217:2015 Format:
variant.inventoryQuantityintegerVariant Inventory Quantity

Collection ID

The collectionIDs - array of strings. It should contain all collection ID(s) to which product belongs, including parent categories ID's.