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.
post
YOUR_BASEURL
/convertedin/products
Products
Note: you have to send either stock_status or quantity so we can show/hide products in your catalog
key
description
validation rules
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
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

{
"data": [
{
"id": 632910392,
"title": "IPod Nano - 8GB",
"content": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>",
"vendor": "Apple",
"created_at": "2021-10-01T16:42:46-04:00",
"handle": "ipod-nano",
"updated_at": "2021-10-01T16:42:46-04:00",
"published_at": "2007-12-31T19:00:00-05:00",
"available": true,
"tags": "Emotive, Flash Memory, MP3, Music",
"variants": [
{
"id": 808950810,
"product_id": 632910392,
"title": "Pink",
"price": "199.00",
"sku": "IPOD2008PINK",
"position": 1,
"compare_at_price": null,
"created_at": "2021-10-01T16:42:46-04:00",
"updated_at": "2021-10-01T16:42:46-04:00",
"barcode": "1234_pink",
"grams": 567,
"image_id": 562641783,
"weight": 1.25,
"weight_unit": "lb",
"inventory_quantity": 10
},
{
"id": 49148385,
"product_id": 632910392,
"title": "Red",
"price": "199.00",
"sku": "IPOD2008RED",
"position": 2,
"compare_at_price": null,
"created_at": "2021-10-01T16:42:46-04:00",
"updated_at": "2021-10-01T16:42:46-04:00",
"barcode": "1234_red",
"grams": 567,
"image_id": null,
"weight": 1.25,
"weight_unit": "lb",
"inventory_quantity": 20
}
],
"options": [
{
"id": 594680422,
"product_id": 632910392,
"name": "Color",
"position": 1,
"values": [
"Pink",
"Red"
]
}
],
"images": [
{
"id": 850703190,
"product_id": 632910392,
"position": 1,
"created_at": "2021-10-01T16:42:46-04:00",
"updated_at": "2021-10-01T16:42:46-04:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1633120966",
"variant_ids": []
},
{
"id": 562641783,
"product_id": 632910392,
"position": 2,
"created_at": "2021-10-01T16:42:46-04:00",
"updated_at": "2021-10-01T16:42:46-04:00",
"alt": null,
"width": 123,
"height": 456,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano-2.png?v=1633120966",
"variant_ids": [
808950810
]
}
],
"image": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1633120966"
}
],
"total": 1000,
"per_page": 100,
"current_page": 1,
"last_page": 10,
"from": 1,
"to": 100
}

Get Category Products

post
YOUR_BASEURL
/convertedin/products
Products

Parameters

Name
Type
Required
Description
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
Copy link
Outline
Authentication
post
Products
Response
Get Category Products
post
Products
Parameters