Family
The API documentation provides the means to retrieve family data from PIM.
Family List
GET https://api.dckappim.com/api/integration/family
By utilizing the endpoint, you can retrieve family list information.
Query Parameters
pagination[currentPage]
String
Pagination Current Page
pagination[pageLimit]
String
Pagination Limit / Length Number
Headers
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": "Family List",
"data": {
"record": [
{
"id": 15,
"code": "holder",
"status": 1,
"created_by": "Super Admin",
"created_at": "2023-10-18 12:29:31",
"updated_at": "2023-10-18 12:29:31",
"title": "Holder"
},
{
"id": 14,
"code": "IC",
"status": 1,
"created_by": "Super Admin",
"created_at": "2023-10-18 12:29:19",
"updated_at": "2023-10-18 13:28:06",
"title": "IC's"
},
{
"id": 13,
"code": "Condenser",
"status": 1,
"created_by": "Super Admin",
"created_at": "2023-10-18 12:29:10",
"updated_at": "2023-10-18 12:29:10",
"title": "Condenser"
},
{
"id": 12,
"code": "router",
"status": 1,
"created_by": "Super Admin",
"created_at": "2023-10-18 12:28:58",
"updated_at": "2023-10-18 12:28:58",
"title": "Router"
},
{
"id": 11,
"code": "wings",
"status": 1,
"created_by": "Super Admin",
"created_at": "2023-10-18 12:28:51",
"updated_at": "2023-10-18 12:28:51",
"title": "Wings"
},
{
"id": 10,
"code": "buttons",
"status": 1,
"created_by": "Super Admin",
"created_at": "2023-10-18 12:28:42",
"updated_at": "2023-10-18 12:28:42",
"title": "Button"
},
{
"id": 9,
"code": "switches",
"status": 1,
"created_by": "Super Admin",
"created_at": "2023-10-18 12:28:29",
"updated_at": "2023-10-18 12:28:29",
"title": "Switch"
},
{
"id": 8,
"code": "engine",
"status": 1,
"created_by": "Super Admin",
"created_at": "2023-10-18 12:26:43",
"updated_at": "2023-10-18 12:26:43",
"title": "Engine"
},
{
"id": 7,
"code": "motor",
"status": 1,
"created_by": "Super Admin",
"created_at": "2023-10-18 12:26:35",
"updated_at": "2023-10-18 12:26:35",
"title": "Motor"
},
{
"id": 6,
"code": "os",
"status": 1,
"created_by": "Super Admin",
"created_at": "2023-10-18 12:26:28",
"updated_at": "2023-10-18 12:26:28",
"title": "OS"
}
],
"recordsTotal": 15,
"currentPage": 1,
"pageLimit": 10
},
"time": "2023-10-20T13:05:42.130473Z",
"status_code": 200
}Family Show
GET https://api.dckappim.com/api/integration/family/show
By utilizing the endpoint, you can retrieve specific family information.
Query Parameters
id*
String
Family ID
Headers
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": "Family Information",
"data": {
"id": 14,
"code": "IC",
"status": 1,
"built_in": 0,
"created_by": "Super Admin",
"created_at": "2023-10-18 12:29:19",
"updated_at": "2023-10-18 13:28:06",
"title": "IC's",
"attribute": [
{
"code": "short_description",
"attribute_name": "Short Description",
"group_name": "Seo",
"id": 8,
"attribute_sort_id": 0
},
{
"code": "catalog",
"attribute_name": "Catalog",
"group_name": "Seo",
"id": 10,
"attribute_sort_id": 0
},
{
"code": "size",
"attribute_name": "Size",
"group_name": "Seo",
"id": 15,
"attribute_sort_id": 0
},
{
"code": "name",
"attribute_name": "Name",
"group_name": "General",
"id": 1,
"attribute_sort_id": 0
},
{
"code": "sku",
"attribute_name": "SKU",
"group_name": "General",
"id": 2,
"attribute_sort_id": 0
},
{
"code": "description",
"attribute_name": "Description",
"group_name": "General",
"id": 3,
"attribute_sort_id": 0
},
{
"code": "image",
"attribute_name": "Image",
"group_name": "General",
"id": 4,
"attribute_sort_id": 0
}
]
},
"time": "2023-10-20T13:07:44.008406Z",
"status_code": 200
}Last updated
Was this helpful?