Product

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

Product List

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

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

Query Parameters

Name	Type	Description
pagination[pageLimit]	String	Pagination Limit / Page Length
pagination[currentPage]	String	Pagination Current Page Number
filter[{attribute_code}]	String	Attribute Filter Value.

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."

200: OK

{
    "status": true,
    "message": "Attribute List",
    "data": {
        "record": [
            {
                "id": 1,
                "sku": "DCKAP 01",
                "slug": "dckap-01",
                "status": 1,
                "updated_at": "2023-10-18 18:10:29",
                "product_type_id": 1,
                "upc": "4983972973",
                "name": "DCKAP 01",
                "size": "M",
                "color": [
                    "Red",
                    "Green"
                ],
                "price": "129.32 USD",
                "banner": "https://d39pvfofj85a8c.cloudfront.net/kmg/assets/default/product/1/Activity Log_300px.png",
                "family": "Basic",
                "weight": "219 Milligram",
                "catalog": "https://d39pvfofj85a8c.cloudfront.net/kmg/assets/default/product/1/Marysville.xlsx",
                "inStock": "39",
                "warranty": "1",
                "manu_date": "2023/10/13",
                "language_id": 1,
                "meta_keyword": "Test Meta Keyword",
                "web_description": "Test Short Description",
                "meta_description": "Test Data",
                "short_description": "Sample Description",
                "image": null,
                "url": null,
                "category": [
                    "Fashion"
                ]
            },
            {
                "id": 4,
                "sku": "DCKAP 04",
                "slug": "dckap-04",
                "status": 1,
                "updated_at": "2023-10-12 15:23:04",
                "product_type_id": 1,
                "upc": "398982983",
                "name": "DCKAP 04",
                "size": "XL",
                "color": [
                    "Red",
                    "Green"
                ],
                "price": "392,12 USD",
                "family": "Basic",
                "weight": "22,12 Milligram",
                "inStock": "26",
                "warranty": "1",
                "manu_date": "2023/10/18",
                "language_id": 1,
                "short_description": "DCKAP 04 Short Description",
                "image": null,
                "url": null,
                "category": [
                    "Fashion/T-shirt/Adidas/Sweat Wear",
                    "Fashion/Pant"
                ]
            },
            {
                "id": 3,
                "sku": "DCKAP 03",
                "slug": "dckap-03",
                "status": 1,
                "updated_at": "2023-10-10 13:46:58",
                "product_type_id": 1,
                "upc": "2978287312",
                "name": "DCKAP 03",
                "size": "XXL",
                "color": [
                    "Red",
                    "Blue"
                ],
                "price": "322.12 USD",
                "family": "Basic",
                "weight": "12.32 Milligram",
                "inStock": "38",
                "warranty": "1",
                "language_id": 1,
                "short_description": "DCKAP 03 Short Description",
                "image": null,
                "url": null,
                "category": []
            }
        ],
        "recordsTotal": 3,
        "currentPage": 1,
        "pageLimit": 10
    },
    "time": "2023-10-20T12:53:10.478687Z",
    "status_code": 200
}

Product Store

POST https://api.dckappim.com/api/integration/product

Product Create / Store API

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
sku*	String	Product SKU. Unique Value for Product
family_code*	String	Family Code / Attribute Set code determine Product Attribute Sets.
language_code*	String	Product Content Language Code Ex: en_US for United State English
channel[][code]*	String	Channel Code. Product Channel Assign
channel[0][status]	bool	Product status for Channel. Ex: 1 Active, 0 - Inactive
channel[0][completeness_status]	String	Product Channel Sync Status.
[attribute_code]	String	Product Attribute Value
image[]	String	Image URL
[attribute_code-multi-select][]	String	Product Attribute Value
category[][code]	String	Category Code for Product Category Assign
category[][channel]	String	Channel Category Code for Product Category Assign. If multiple channel present

200: OK

{
    "status": true,
    "message": "Product Information",
    "data": {
        "id": 54,
        "content_quality": 20
    },
    "time": "2023-11-28T05:42:22.690296Z",
    "status_code": 200
}

Product Show

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

By utilizing the endpoint, you can retrieve product show information.

Query Parameters

Name	Type	Description
id*	String	Product 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."

200: OK

{
    "status": true,
    "message": "Product Information",
    "data": {
        "family": "Basic",
        "status": 1,
        "image": null,
        "url": null,
        "category": [
            "Fashion"
        ],
        "meta_description": "Test Data",
        "meta_keyword": "Test Meta Keyword",
        "short_description": "Sample Description",
        "catalog": "https://d39pvfofj85a8c.cloudfront.net/kmg/assets/default/product/1/Marysville.xlsx",
        "banner": "https://d39pvfofj85a8c.cloudfront.net/kmg/assets/default/product/1/Activity Log_300px.png",
        "weight": "219 Milligram",
        "price": "129.32 USD",
        "size": "M",
        "color": [
            "Red",
            "Green"
        ],
        "warranty": "1",
        "manu_date": "2023/10/13",
        "name": "DCKAP 01",
        "sku": "DCKAP 01"
    },
    "time": "2023-10-20T12:55:01.145026Z",
    "status_code": 200
}

Product Update

PUT https://api.dckappim.com/api/integration/product

Product Update / Modify API

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
sku*	String	Product SKU. Unique Value for Product
language_code*	String	Product Content Language Code Ex: en_US for United State English
family_code	String	Family Code / Attribute Set code determine Product Attribute Sets.
is_data_overwrite	bool	Flag to Overwrite the New Data With Existing one. It will works only for Channel, Category, Image and Multi-Select Entity.
[attribute_code]	String	Product Attribute Value
[attribute_code-multi-select][]	String	Product Attribute Value
channel[][code]	String	Channel Code. Product Channel Assign
channel[0][status]	String	Product status for Channel. Ex: 1 Active, 0 - Inactive
channel[0][completeness_status]	String	Product Channel Sync Status.
category[][code]	String	Category Code For Product
category[][channel]	String	Channel Category Code for Product Category Assign. If multiple channel present

200: OK

{
    "status": true,
    "message": "Product Updated",
    "data": {
        "id": 54,
        "content_quality": 50
    },
    "time": "2023-11-30T07:10:33.553060Z",
    "status_code": 200
}

400: Bad Request

{
    "status": false,
    "message": {
        "language_code": [
            "The language code field is required."
        ],
        "category": [
            "'Engine Propellers' Category code not available"
        ]
    },
    "data": [],
    "time": "2023-11-30T09:42:59.992273Z",
    "status_code": 400
}

Relation List

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

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

Query Parameters

Name	Type	Description
pagination[currentPage]	String	Pagination Current Page Number
pagination[pageLimit]	String	Pagination 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."

200: OK

{
    "status": true,
    "message": "Relation List",
    "data": {
        "record": [
            {
                "id": 1,
                "code": "upsell",
                "status": 1,
                "created_by": "Super Admin",
                "created_at": "2023-10-18 16:15:16",
                "title": "Upsell"
            },
            {
                "id": 2,
                "code": "crosssell",
                "status": 1,
                "created_by": "Super Admin",
                "created_at": "2023-10-18 16:15:52",
                "title": "Cross Sell"
            },
            {
                "id": 3,
                "code": "related_product",
                "status": 1,
                "created_by": "Super Admin",
                "created_at": "2023-10-18 16:16:12",
                "title": "Related Product"
            }
        ],
        "recordsTotal": 3,
        "currentPage": 1,
        "pageLimit": 10
    },
    "time": "2023-10-20T13:08:10.480289Z",
    "status_code": 200
}

Relation Info

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

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

Query Parameters

Name	Type	Description
id*	String	Relation 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."

200: OK

{
    "status": true,
    "message": "Relation Information",
    "data": {
        "id": 1,
        "code": "upsell",
        "status": 1,
        "created_by": "Super Admin",
        "created_at": "2023-10-18 16:15:16",
        "title": "Upsell"
    },
    "time": "2023-10-20T13:12:31.377749Z",
    "status_code": 200
}

Product Relation Info

GET https://api.dckappim.com/api/integration/relation/product-relation

The API documentation provides the means to retrieve specific product relation data from PIM.

Query Parameters

Name	Type	Description
sku*	String	Product SKU
relation_id*	String	Relation 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."

200: OK

{
    "status": true,
    "message": "Relation Information",
    "data": [
        {
            "id": 3,
            "sku": "DCKAP 03"
        }
    ],
    "time": "2023-10-20T13:14:27.599740Z",
    "status_code": 200
}

Product Channel Assign

POST https://api.dckappim.com/api/integration/product/assign-channel

Using this API to Assign and change Products into Channels and their status

Headers

Name	Type	Description
x-domain*	String	Customer Account Name Example: For the Customer Account URL "demo.dckappim.com," the customer account name is "demo."
token*	String	Access Token for PIM Integration.

Request Body

Name	Type	Description
sku*	String	Product SKU.
code*	String	Channel Code
status	bool	Product Status for the Channel. By Default it consider as In-active
completeness_status	String	Product Completeness Status. See More

200: OK

{
    "status": true,
    "message": "Channel Assigned",
    "data": {
        "sku": "DCKAP 10"
    },
    "time": "2023-11-30T12:44:45.494699Z",
    "status_code": 200
}

400: Bad Request Channel Permission Denied

{
    "status": false,
    "message": "You don't have Permission for this Channel",
    "data": [],
    "time": "2023-11-30T13:21:27.123840Z",
    "status_code": null
}

400: Bad Request Invalid Data

{
    "status": false,
    "message": "Product SKU not found.",
    "time": "2023-11-30T13:22:19.951626Z",
    "status_code": 404
}

Product Category Assign

POST https://api.dckappim.com/api/integration/product/assign-category

By utilizing the endpoint, you can assign a category to the product.

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
sku*	String	Product SKU.
code*	String	Category Code
channel*	String	Channel Code
sort_order	String	Sort Order for Product Category Relation

200: OK Success

{
    "status": true,
    "message": "Product Updated",
    "data": {
        "sku": "DCKAP 10"
    },
    "time": "2023-12-05T17:16:15.645067Z",
    "status_code": 200
}

400: Bad Request Invalid Channel

{
    "status": false,
    "message": "Channel not found.",
    "time": "2023-12-07T10:27:35.415015Z",
    "status_code": 404
}

400: Bad Request Invalid Category

{
    "status": false,
    "message": "Category not found.",
    "time": "2023-12-07T10:27:47.692896Z",
    "status_code": 404
}