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
  • Channel List
  • Channel Show
  • Channel Attribute

Was this helpful?

  1. Integration
  2. REST API

Channels

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

Channel List

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

By utilizing the endpoint, you can retrieve channel list 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": "Channel List",
    "data": [
        {
            "id": 1,
            "code": "default",
            "status": 1,
            "sort_order": 0,
            "created_at": "2023-09-27 11:14:51",
            "updated_at": "2023-10-18 13:28:33",
            "created_by_user": "Super Admin",
            "name": "Default"
        }
    ],
    "time": "2023-10-20T09:09:03.852164Z",
    "status_code": 200
}

Channel Show

POST https://api.dckappim.com/api/integration/channel/show

By utilizing the endpoint, you can retrieve Specific channel 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."

Request Body

Name
Type
Description

locale

String

Language Code

id*

String

Channel Id

{
    "status": true,
    "message": "Channel Information",
    "data": {
        "id": 1,
        "code": "default",
        "status": 1,
        "sort_order": 0,
        "created_at": "2023-09-27 11:14:51",
        "updated_at": "2023-10-18 13:28:33",
        "name": "Default"
    },
    "time": "2023-10-20T09:05:41.248796Z",
    "status_code": 200
}

Channel Attribute

GET https://api.dckappim.com/api/integration/channel/attribute

By utilizing the endpoint, you can retrieve Specific channel-accessible Attribute information.

Query Parameters

Name
Type
Description

id*

String

Channel ID

locale

String

Language Code. Ex: en_US

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": "Channel Information",
    "data": [
        {
            "id": 8,
            "code": "short_description"
        },
        {
            "id": 6,
            "code": "meta_keyword"
        },
        {
            "id": 5,
            "code": "meta_description"
        },
        {
            "id": 10,
            "code": "catalog"
        },
        {
            "id": 11,
            "code": "banner"
        },
        {
            "id": 12,
            "code": "upc"
        },
        {
            "id": 13,
            "code": "weight"
        }
    ],
    "time": "2023-10-20T09:10:34.103179Z",
    "status_code": 200
}

Last updated 1 year ago

Was this helpful?