Products
Allow convertedin to get your products
These keys are specified to use as defined in docs, they are case-sensitive. Any change in these keys may cause issues during data sync
Authentication
Use your token provided inside converted.in after on boarding process to authenticate the request using form-data body
If collectionid exists within the request, your api should return products within this collection. if not return all products. For pagination : use per_page and page as listed in the image above.
Products
POST YOUR_BASEURL/convertedin/products
Request Body
per_page*
integer
limit per page (default 100)
page*
integer
page number
token*
string
Fixed token provided by Convertedin
Note: you have to send either stock_status or quantity so we can show/hide products in your catalog
If you want product to be inactive you can pass null at published_at
id
product id in your database and linked to orders
Required
category_id
category id linked to that product
Not required
title
product name or title
Required
handle
product slug or permalink id
Not required
full_permalink
Full product public url
Required
app_links
The app_links key provides platform-specific deep links for accessing product details directly within the associated mobile applications.
Not required
app_links.android
The deep link URL for accessing the product within the Android application
Not required
app_links.ios
The deep link URL for accessing the product within the iOS application
Not required
image
Full product image public url ( 600 * 600 mandatory)
Required
content
Product description or page content
Required
type
Product type (aliases to category)
Not required
vendor
Product provider, brand, or your store name if the latter is not available
Required
compare_at_price
product price before sale (this the old price is shown stripped)
Not required
price
product price
Required
quantity
product stock quantity (default zero if you don't want the product to be used in ads or any integer above zero for enabled)
Not required
stock_status
Product stock status (instock, onbackorder, outofstock)
Not required
published_at
product publish date, Format: Y-m-d H:i:s, ex: 2020-12-15 19:00:00
Required
tags
product SEO tags (comma separated)
Not required
images
product gallery images (format in json response example)
Not required
meta
Any other non existing data
Not required
Response
Get Category Products
Products
POST YOUR_BASEURL/convertedin/products
Get the products related to the given category
Query Parameters
per_page*
integer
limit per page (default 100)
page*
integer
page number
token*
string
Fixed token provided by Convertedin
collection_id*
int
The category id
Parameters
page
int
true
page number
limit
int
true
count items per page
collection_id
int
false
used to fetch only products related to this collection
Last updated
Was this helpful?