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

post
Products

YOUR_BASEURL/convertedin/products
Request
Response
Request
Query Parameters
per_page
optional
integer
limit per page (default 100)
page
required
integer
page number
token
required
string
Fixed token provided by Convertedin
Response
200: OK
Cake successfully retrieved.
{
"current_page": 1,
"data": [
{
"id": 206,
"category_id": "44",
"title": "Brain Challenge Bundle",
"handle": "brain-challenge-bundle",
"full_permalink": "http://storeurl.com/product/abominable-hoodie/", // full product public link
"image": "https://www.3anqod.com/wp-content/uploads/2020/11/WhatsApp-Image-2020-11-16-at-3.04.06-AM.jpeg",
"content": "<div class=\"section parbase\"><section class=\"ps-section--white ds-intro\" data-dtm-banner-position=\"1\">\r\n<div class=\"onecolumn parbase\">\r\n<div class=\"single-column no-top no-bottom\">\r\n<div class=\"row\">\r\n<div class=\"single-column--md\">\r\n<div class=\"richtext parbase\">\r\n<div class=\"block-copy \">\r\n\r\nSave more than 20% of the original price by renting this bundle offer:\r\n\r\nSpin Master Classic Board Games + The Heist\r\n\r\n</div>\r\n</div>\r\n</div>\r\n</div>\r\n</div>\r\n</div>\r\n</section></div>",
"type": null,
"vendor": "Brand or seller name",
"price": 90,
"quantity": 0,
"published_at": "2020-10-10 20:00:00",
"tags": "games, products, trending",
"images": [
{
"path": "http://convertedin-wordpress.test/wp-content/uploads/2020/09/ug07-bk-0_alt1-150x150.jpg",
"width": 150,
"height": 150
}
]
}
],
"from": 1,
"last_page": 36,
"per_page": 100,
"to": 100,
"total": 3538
}

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

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

price

product price

Required

quantity

product stock quantity (default zero if not tracked)

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