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

NameTypeDescription

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

NameTypeDescription

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

NameTypeDescription

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

NameTypeDescription

id*

String

Channel ID

locale

String

Language Code. Ex: en_US

Headers

NameTypeDescription

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