Retrieves the full record for one product — its variants, images, options, and the collections it belongs to.

💡 The product id goes on the wire as id, even though the SDKs name the parameter productId / product_id.


Request

method is "getProductItem".

Field Type Required Description
id String Yes The product to retrieve.
app_id String Yes The app the product belongs to.
reference String Optional Your id for this request. Echoed back in the response.

Preconditions

Requirement Why
"Manage Products" permission Needed to read product data for the app.

Response

getProductItemResponse

Field Type Returned Description
method String Yes "getProductItemResponse"
data Product Yes The full product, including variant, image, option, and collection arrays.
app_id String Yes Echoed from the request.
reference String Optional Echoed from the request.

SDKs

SDK Call 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

{
  "method": "getProductItem",
  "id": "5121419845126176",
  "app_id": "90090684293000559",
  "reference": "1123423511"
}
api.getProductDetail("5121419845126176", "90090684293000559", "1123423511");
api.getProductDetail("5121419845126176", "90090684293000559", "1123423511");
napi.get_product_detail(
    product_id="5121419845126176",
    app_id="90090684293000559",
    reference="1123423511",
)

Response