getProductItem

Use this method to retrieve full product details, including its variants, images, options, and collections.

Required Fields

Field	Type	Required	Description
`method`	String	Yes	Must be `"getProductItem"` to trigger the lookup.
`id`	String	Yes	Unique identifier of the product to retrieve.
`app_id`	String	Yes	Unique identifier of the app the product belongs to.

Preconditions for API Functionality

The following table outlines the preconditions that must be met for the API to function correctly. Failure to meet these conditions may result in errors or unexpected behavior.

Condition	Description
API must have `"Manage Products"` permission	The API needs `"Manage Products"` permission to manage products within the app.

Response:

listCollectionsResponse

✅ On success, the getProductItemResponse method is returned with an echo of the chat object.

Field	Type	Returned	Description
`method`	String	Yes	`"getProductItemResponse` `"`
`app_id`	String	Yes	Unique identifier for App.
`data`	Product	Yes	Collection Object.
`reference`	String	Optional	Unique identifier echoed from the request.

SDK Mapping — `GetProductItem`

SDK	Request Method	Response Callback
Java	`api.getProductDetail(productId, appId, reference);`	`onProductDetail(ProductItemResponse productItem)`
JavaScript	`api.getProductDetail(productId, appId, reference);`	`onProductDetail(productItem)`
Python	`napi.get_product_detail(product_id=product_id, app_id=app_id, reference=reference)`	`on_product_detail(self, obj)`

Example

Request

json

{
  "method": "getProductItem",
  "product_id": "5121419845126176",
  "app_id": "90090684293000559"
}

java
api.getProductDetail("5121228327126172", Long.valueOf("90090684293000559"), null);

javascript
api.getProductDetail("5121228327126172", "90090684293000559", null);

python
napi.get_product_detail(productId="5121228327126172", app_id="90090684293000559", None)

Response

json
{
	"reference": "1123423511",
	"data": {
		"description": "Cotton T-shirt for Men",
		"type": "0",
		"price": 50.0,
		"variant": [
			{
				"compare_at_price": 0,
				"business_channel_id": 90090684293000559,
				"price": 50,
				"parent_id": "5121419845126176",
				"option1": "Large",
				"track_stock": false,
				"in_stock": null,
				"is_taxable": false,
				"shipping_required": false,
				"id": "5121792017126173",
				"type": 2,
				"category": "product",
				"app_id": 90090684293000559,
				"status": "A"
			},
			{
				"compare_at_price": 0,
				"business_channel_id": 90090684293000559,
				"price": 50,
				"parent_id": "5121419845126176",
				"option1": "Medium",
				"track_stock": false,
				"in_stock": null,
				"is_taxable": false,
				"shipping_required": false,
				"id": "5121362976126174",
				"type": 2,
				"category": "product",
				"app_id": 90090684293000559,
				"status": "A"
			},
			{
				"compare_at_price": 0,
				"business_channel_id": 90090684293000559,
				"price": 50,
				"parent_id": "5121419845126176",
				"option1": "Small",
				"track_stock": false,
				"in_stock": null,
				"is_taxable": false,
				"shipping_required": false,

				"id": "5121705203126175",
				"type": 2,
				"category": "product",
				"app_id": 90090684293000559,
				"status": "A"
			}
		],
		"id": "5121419845126176",
  	    "cost": 0,
		"timezone": "America/Toronto",
		"track_stock": false,
		"in_stock": null,
		"is_taxable": false,
		"shipping_required": false,
		"tag": [],
		"app_id": 90090684293000559,
		"image": [
			{
				"width": 235,
				"url": "https://m1.nandbox.ca/v1/AUTH_137b624a8e434c4e88e9be30fa5e7bed/g/90090684293000559_b7010f02ed0d2a57ace1df2607986f0fa2a9ed3fff30caedcba7fa9c21a6451c.jpg?temp_url_sig=c5c3d17d11b1e5093552242cc62d1ff95c068cea&temp_url_expires=2059844191",
				"height": 275
			}
		],
		"compare_at_price": 0.0,
		"collection": [
			{
				"image": [
					{
						"width": 720,
						"url": "https://m1.nandbox.ca/v1/AUTH_137b624a8e434c4e88e9be30fa5e7bed/g/null073734a35fbf6f2374c2cfe1080a2c3eb28a64f8c75fc7ba0ef6d7b7fe3520af.jpg?temp_url_sig=3d864d3723b85e6ebce8c99231419781818ebbc1&temp_url_expires=2059203944",
						"height": 340
					}
				],
				"name": "New Collection",
				"id": "5121960361126208"
			}
		],
		"version": "L0hmcA",
		"business_channel_id": 90090684293000559,
		"name": "Black T-shirt",
		"created_date": "2025-04-02 13:56:34",
		"updated_date": "2025-04-02 14:15:17",
		"category": "product",
		"status": "A",
		"option": [
			{
				"values": [
					"Large",
					"Medium",
					"Small"
				],
				"name": "Size",
				"id": "option1"
			}
		]
	},
	"method": "getProductItemResponse"
}