Categories

Allow convertedin to get your product categories

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

Categories API

POST YOUR_BASEURL/convertedin/categories

Request Body

Name	Type	Description
per_page*	integer	limit per page (default 100)
page*	integer	page number
token*	string	Fixed token provided by Convertedin

200

{
    "current_page": 1, 
    "data": [ 
        {
            "id": 1,
            "title": "Uncategorized",
            "handle": "uncategorized",
            "content": ""
        }, 
        {
            "id": 1,
            "title": "For him",
            "handle": "for-him",
            "content": ""
        }
    ],
    "from": 1, // start for current page
    "last_page": 23, // last available page 
    "per_page": 100, // limit per page
    "to": 100,  // end for current page
    "total": 2220 // total number of categories
}

Key	Description	Validation Rules
id	category id linked to your products	Required
title	category name	Required
handle	category slug or url	Not required
content	category description or brief	Not required
available	is category publicly available	Required
published_at	the date that the category was available on it.	Required

Response

{
    "data": [
        {
            "id": 841564295,
            "taxonomy": "Category > Sub Category",
            "handle": "ipods",
            "title": "IPods",
            "updated_at": "2008-02-01T19:00:00-05:00",
            "content": "<p>The best selling ipod ever</p>",
            "published_at": "2008-02-01T19:00:00-05:00",
            "available": true,
            "image": {
                "created_at": "2021-10-01T17:17:03-04:00",
                "alt": "MP3 Player 8gb",
                "width": 123,
                "height": 456,
                "src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1633123023"
            }
        },
        {
            "id": 395646240,
            "taxonomy": "Category > Sub Category",
            "handle": "ipods_two",
            "title": "IPods Two",
            "updated_at": "2008-02-01T19:00:00-05:00",
            "body_html": "<p>The best selling ipod ever. Again</p>",
            "published_at": "2008-02-01T19:00:00-05:00",
            "sort_order": "manual",
            "template_suffix": null,
            "available": true,
            "image": null
        }
    ],
    "total": 1000,
    "per_page": 100,
    "current_page": 1,
    "last_page": 10,
    "from": 1,
    "to": 100
}