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