Category

The API documentation provides the means to retrieve Category data from PIM.

Category List

GET https://api.dckappim.com/api/integration/category

By utilizing the endpoint, you can retrieve category list information.

Query Parameters

Name
Type
Description

pagination[currentPage]

String

Pagination Current Page Number

pagination[pageLimit]

String

Pagination Page Limit / Page Length

Headers

Name
Type
Description

token*

String

Access Token for PIM Integration.

x-domain*

String

Customer Account Name Example: For the Customer Account URL "demo.dckappim.com," the customer account name is "demo."

{
    "status": true,
    "message": "Attribute List",
    "data": {
        "record": [
            {
                "id": 1,
                "code": "fashion",
                "parent_id": null,
                "status": 1,
                "sort_order": null,
                "created_by": 1,
                "updated_by": 1,
                "created_at": "2023-10-12 13:42:48",
                "updated_at": "2023-10-17 16:16:16",
                "title": "Fashion",
                "description": null,
                "channel_id": 1,
                "category_status": 1
            },
            {
                "id": 2,
                "code": "t_shirt",
                "parent_id": 1,
                "status": 1,
                "sort_order": null,
                "created_by": 1,
                "updated_by": 1,
                "created_at": "2023-10-12 13:43:08",
                "updated_at": "2023-10-12 13:43:08",
                "title": "T-shirt",
                "description": null,
                "channel_id": 1,
                "category_status": 1
            },
            {
                "id": 3,
                "code": "adidas",
                "parent_id": 2,
                "status": 1,
                "sort_order": null,
                "created_by": 1,
                "updated_by": 1,
                "created_at": "2023-10-12 13:43:24",
                "updated_at": "2023-10-12 13:43:24",
                "title": "Adidas",
                "description": null,
                "channel_id": 1,
                "category_status": 1
            },
            {
                "id": 4,
                "code": "pant",
                "parent_id": 1,
                "status": 1,
                "sort_order": null,
                "created_by": 1,
                "updated_by": 1,
                "created_at": "2023-10-12 13:43:43",
                "updated_at": "2023-10-12 13:43:43",
                "title": "Pant",
                "description": null,
                "channel_id": 1,
                "category_status": 1
            },
            {
                "id": 5,
                "code": "sweatshirt",
                "parent_id": 3,
                "status": 1,
                "sort_order": null,
                "created_by": 1,
                "updated_by": 1,
                "created_at": "2023-10-12 13:44:17",
                "updated_at": "2023-10-12 13:44:17",
                "title": "Sweat Wear",
                "description": null,
                "channel_id": 1,
                "category_status": 1
            }
        ],
        "recordsTotal": 5,
        "currentPage": 1,
        "pageLimit": 10
    },
    "time": "2023-10-20T12:58:48.698521Z",
    "status_code": 200
}

Category Show

GET https://api.dckappim.com/api/integration/category/show

By utilizing the endpoint, you can retrieve specific category information.

Query Parameters

Name
Type
Description

id*

String

Category ID

Headers

Name
Type
Description

token*

String

Access Token for PIM Integration.

x-domain*

String

Customer Account Name Example: For the Customer Account URL "demo.dckappim.com," the customer account name is "demo."

{
    "status": true,
    "message": "Category Information",
    "data": {
        "id": 1,
        "code": "fashion",
        "parent_id": null,
        "status": 1,
        "sort_order": null,
        "created_at": "2023-10-12 13:42:48",
        "updated_at": "2023-10-17 16:16:16",
        "title": "Fashion",
        "description": null,
        "username": "Super Admin",
        "image": [
            "https://d39pvfofj85a8c.cloudfront.net/kmg/categories/1/1/1628263777_A-M101-18L-a.png",
            "https://d39pvfofj85a8c.cloudfront.net/kmg/categories/1/1/1628263778_A-M101-18L-b.png",
            "https://d39pvfofj85a8c.cloudfront.net/kmg/categories/1/1/1628263778_A-M101-18L.png"
        ]
    },
    "time": "2023-10-20T13:01:00.755552Z",
    "status_code": 200
}

Category Product List

GET https://api.dckappim.com/api/integration/category/get-products

By utilizing the endpoint, you can retrieve specific category product information.

Headers

Name
Type
Description

token*

String

Access Token for PIM Integration.

x-domain*

String

Customer Account Name Example: For the Customer Account URL "demo.dckappim.com," the customer account name is "demo."

{
    "status": true,
    "message": "Category Information",
    "data": [
        {
            "sku": "DCKAP 01",
            "position": null
        }
    ],
    "time": "2023-10-20T13:02:40.420888Z",
    "status_code": 200
}

Last updated