DCKAP PIM
Release NotesRoadmap
  • overview
    • What is Product Information Management (PIM) ?
    • DCKAP PIM: Streamline Product Data Management with Ease
    • How to Access DCKAP PIM?
  • Getting started
    • Dashboard
      • Components
      • Header
    • Categories
      • Create Category
      • Tree View
        • Edit Category
        • Assign Channel
        • Assign Products
        • Delete Category
        • Activity Logs
      • List View
        • Edit Category
        • Assign Products
        • Delete Category
    • Attributes
      • Create Attribute
      • Edit Attribute
      • Delete Attribute
    • Attribute Groups
      • Create Attribute Group
      • Assign/Unassign Attribute
      • Edit Attribute Group
      • Delete Attribute Group
    • Families
    • Channels
    • Product Relation
    • Rules
    • Product
      • Create Product
      • Update Product
      • Attribute Group
      • Product Type
      • Relations
      • Channel
      • Assets
      • Activity Log
      • Quick Edit
    • Assets
    • Import
      • Product Import
      • Category
      • Attribute
      • Family
      • Assets
      • Variant Import
      • Variant Assign Import
      • Group
      • Custom Import
      • Log Management
    • Export
      • Category
      • Attribute
      • Family
      • Variants
      • Product
      • Assets
    • Settings
      • Manage Users
      • Manage Roles
      • Product Status
      • Locale
      • Currencies
      • General Settings
    • Notifications
  • Integration
    • REST API
      • Authentication
      • Attribute
      • Category
      • Product
      • Family
      • Channels
      • Locale
      • Currency
  • Extension
    • DCKAP PIM Marketplace Extension
    • PIM Adobe Commerce Extension
      • Configuration
      • Attribute Mapping
      • Sync
        • Category Sync
        • Product Sync
      • Magento Log Management Documentation | PIM Sync Audit Logs
    • PIM Bigcommerce Extension
      • Store Configuration
      • Attribute Relation
  • Others
    • Product Roadmap
    • Release Notes
      • 2.3.5 June 1, 2024
      • 2.3.4 May 9, 2024
      • 2.3.3 April 3, 2024
      • 2.3.2 February 5, 2024
      • 2.3.1 January 4, 2024
    • DOCUMENT CONTROL
Powered by GitBook
On this page
  • Category List
  • Category Show
  • Category Product List

Was this helpful?

  1. Integration
  2. REST API

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 1 year ago

Was this helpful?