API Documentation – Unbxd PIM Support Center

Integrate and interact with Unbxd PIM

The Get Products API lets you retrieve products from a specific PIM organization. It retrieves the certified products from Unbxd PIM.

Endpoint:

POST /v1/products

Request Parameters:

Header

Name: Value	Required	Data Type
content-type: application/json	Yes	String
Authorization: api_key	Yes	String

Request Body:

Sample 1

{
	"page": 1,
	"count": 100,
	"groupByParent": false,
        "properties" : ["property_name1", "property_name2"],
        "q": "search string"
}

Sample 2

{
	"page": 1,
	"count": 100,
	"parentId": "Id121",
        "properties" : ["property_name1", "property_name2"],
        "q": "search string"
}

The sample 2 code lets you retrieve variants for the respective parent id.

Schema

Name	Data Type	Description
page	Integer	Page number for paginated list of products.
count	Integer	Number of products to be retrieved in a page. Upper limit: 100
groupByParent	Boolean	If group by parent is false: solo +variants By default, it will retrieve solo and variant products. If group by parent is true: parent +solo
properties	String list	Properties you want to retrieve for the product
q	String	Search query for retrieving specific products
parentId	String	Retrieve variant products for the specific parent id.
referenceId	String	Retrieve specific certified products from Unbxd PIM.

Response:

{
	"data": {
		"total": 1000,
		"products": [{
			"uniqueId": "12345",
			"brand": "nike",
			"color": "red"
		}]
	}
}

Schema

Name	Data Type	Description
total	Integer	Total number of products

Was this helpful? Yes No

0 of 0 users found this section helpful