Product Details
OAuthScope
ZohoCommerce.items.READ
HTTP Request
GET https://commerce.zoho.com/store/api/v1/products/editpage
Query Parameters
Parameter | Values |
product_id* | string: Give unique product id to get the details |
Request Example
Copiedcurl -i -X GET \
-H "Authorization:Zoho-oauthtoken ***" \
-H "X-com-zoho-store-organizationid:682219181" \
'https://commerce.zoho.com/store/api/v1/products/editpage?product_id=1706707000000561016'
Success Response
Copied{
"code": 0,
"message": "success",
"product": {
"product_id": "1706707000000561016",
"account_id": "1706707000000000388",
"ancestor_categories": [
{
"parent_category_id": "null",
"category_id": "1706707000000068762",
"name": "Partywear",
"url": "partywear"
}
],
"attribute1": {
"name": "Size",
"options": [
{
"option_id": "1706707000000067341",
"option_name": "L"
}
],
"id": "1706707000000067329",
"type": "Text"
},
"attribute2": {
},
"attribute3": {
},
"show_in_storefront": true,
"show_in_pos": false,
"show_in_both": false,
"attribute_id1": "1706707000000067329",
"attribute_id2": "",
"attribute_id3": "",
"attribute_name1": "Size",
"attribute_name2": "",
"attribute_name3": "",
"attribute_type1": "Text",
"attribute_type2": "",
"attribute_type3": "",
"attributes": [
{
"id": "1706707000000067329",
"name": "Size",
"type": "text",
"options": [
{
"id": "1706707000000067341",
"name": "L",
"data": ""
}
]
}
],
"brand": "Remy",
"category_id": "1706707000000068762",
"category": {
"category_id": "1706707000000068762",
"category_name": "Partywear"
},
"description": "",
"product_description": "",
"product_short_description": "",
"documents": [
],
"has_variant": false,
"image_name": "",
"image_type": "",
"inventory_account_id": "1706707000000034001",
"is_taxable": true,
"is_returnable": true,
"manufacturer": "",
"name": "A-line Pink Dress",
"purchase_account_id": "1706707000000034003",
"seo_description": "",
"seo_keyword": "Pink-dress, A-line",
"seo_title": "A-line Pink dress",
"specifications": [
],
"specificationset_id": "",
"specificationset_name": "",
"tags": [
{
"tag_name": "Pink",
"tag_id": "1706707000000557078"
},
{...}
],
"page_layout_id": "",
"url": "a-line-pink-dress",
"variant_type": "inventory",
"variants": [
{
"variant_id": "1706707000000561018",
"attribute_id1": "1706707000000067329",
"attribute_id2": "",
"attribute_id3": "",
"attribute_name1": "Size",
"attribute_name2": "",
"attribute_name3": "",
"attribute_type1": "Text",
"attribute_type2": "",
"attribute_type3": "",
"attribute_option_id1": "1706707000000067341",
"attribute_option_id2": "",
"attribute_option_id3": "",
"attribute_option_name1": "L",
"attribute_option_name2": "",
"attribute_option_name3": "",
"attribute_option_data1": "",
"attribute_option_data2": "",
"attribute_option_data3": "",
"collect_variant_level_data": "",
"created_time": "2019-12-20T00:46:02-0700",
"description": "",
"ean": "",
"image_name": "",
"image_type": "",
"documents": [
],
"isbn": "",
"is_combo_product": false,
"is_linked_with_zohocrm": false,
"is_taxable": true,
"last_modified_time": "2019-12-20T00:46:02-0700",
"package_details": {
"length": "",
"width": "",
"height": "",
"weight": "",
"weight_unit": "lb",
"dimension_unit": "in"
},
"name": "A-line Pink Dress-L",
"part_number": "",
"product_type": "goods",
"purchase_description": "",
"purchase_rate": 0,
"rate": 1539,
"label_rate": 2199,
"reorder_level": 5,
"initial_stock": 25,
"initial_stock_rate": 1539,
"sku": "W005-51-120",
"source": "",
"status": "active",
"stock_on_hand": 25,
"actual_available_stock": 25,
"available_stock": 25,
"available_sale_stock": 25,
"custom_fields": [
],
"tax_exemption_id": "",
"upc": "",
"variant_type": "inventory"
}
],
"sales_channels": [
],
"source": "user",
"status": "active",
"tax_exemption_code": "",
"tax_exemption_id": "",
"is_featured": false,
"unit": ""
},
"taxes": [
{
"tax_specific_type": "tax",
"tax_percentage_formatted": "5",
"is_value_added": false,
"tax_name": "gst",
"tax_authority_id": "1706707000000110073",
"is_editable": true,
"tax_id": "1706707000000110075",
"country_code_formatted": "",
"country_code": "",
"deleted": false,
"tax_specific_type_formatted": "Tax",
"tax_type_formatted": "Tax",
"tax_type": "tax",
"tax_percentage": 5
}
],
"is_books_start_date_empty": false,
"tax_exemptions": [
],
"reporting_tags": [
],
"income_accounts_list": [
"account_type": "income",
"ParentGeneralLedgerName": "",
"gain_or_loss_account": false,
"currency_code": "USD",
"ignore_currency": false,
"is_accounts_payable": false,
"account_name": "Discount",
"schedule_balancesheet_category": "no_category",
"allow_multi_currency": false,
"schedule_profit_and_loss_category": "no_category",
"account_type_formatted": "Income",
"is_primary_account": false,
"is_accounts_receivable": false,
"is_active": true,
"currency_symbol": "$",
"masked_account_no": "",
"is_disabled_master": false,
"is_default": false,
"price_precision": 2,
"account_id": "1706707000000000406",
"depth": 0,
"account_type_int": 14,
"account_code": "",
"ParentGeneralLedgerID": "",
"disable_tax": false,
"is_retained_earnings": false,
"currency_id": "1706707000000000097"
},
{...},
{...}
],
"purchase_accounts_list": [
{
"account_type": "expense",
"ParentGeneralLedgerName": "",
"gain_or_loss_account": false,
"currency_code": "USD",
"ignore_currency": false,
"is_accounts_payable": false,
"account_name": "Advertising And Marketing",
"schedule_balancesheet_category": "no_category",
"allow_multi_currency": false,
"schedule_profit_and_loss_category": "no_category",
"account_type_formatted": "Expense",
"is_primary_account": false,
"is_accounts_receivable": false,
"is_active": true,
"currency_symbol": "$",
"masked_account_no": "",
"is_disabled_master": false,
"is_default": false,
"price_precision": 2,
"account_id": "1706707000000000403",
"depth": 0,
"account_type_int": 16,
"account_code": "",
"ParentGeneralLedgerID": "",
"disable_tax": false,
"is_retained_earnings": false,
"currency_id": "1706707000000000097"
},
{...},
{...}
],
"attributes": [
{
"id": "1706707000000067329",
"name": "Size",
"type": "text",
"options": [
{
"id": "1706707000000067341",
"name": "L",
"data": ""
}
],
"selected_option_id": "",
"selected_option_name": "",
"selected_option_data": ""
}
],
"inventory_accounts_list": [
{
"account_type": "stock",
"ParentGeneralLedgerName": "",
"gain_or_loss_account": false,
"currency_code": "USD",
"ignore_currency": false,
"is_accounts_payable": false,
"account_name": "Inventory Asset",
"schedule_balancesheet_category": "no_category",
"allow_multi_currency": false,
"schedule_profit_and_loss_category": "no_category",
"account_type_formatted": "Stock",
"is_primary_account": false,
"is_accounts_receivable": false,
"is_active": true,
"currency_symbol": "$",
"masked_account_no": "",
"is_disabled_master": false,
"is_default": false,
"price_precision": 2,
"account_id": "1706707000000034001",
"depth": 0,
"account_type_int": 19,
"account_code": "",
"ParentGeneralLedgerID": "",
"disable_tax": false,
"is_retained_earnings": false,
"currency_id": "1706707000000000097"
}
],
"units": [
{
"unit_id": "1706707000000067020",
"unit": "box"
},
{...},
{...}
],
"brands": [
{
"brand_id": "1706707000000090009",
"brand": "Laura"
},
{...},
{...}
],
"manufacturers": [
],
"specificationsets": [
],
"tags": [
{
"name": "Pink",
"tag_id": "1706707000000557078"
},
{...}
],
"custom_fields": [
{
"customfield_id": "1706707000000490001",
"show_in_store": true,
"is_active": true,
"index": 1,
"show_in_hp": false,
"is_mandatory": false,
"label": "Include a note for us",
"is_mandatory_in_sales_item": false,
"is_mandatory_in_hp": false,
"edit_on_store": true,
"show_in_all_pdf": false,
"data_type": "string",
"pii_type": "non_pii",
"placeholder": "cf_include_a_note_for_us",
"is_inherited_value": false,
"value": "",
"max_length": 255,
"help_text": ""
},
{...}
],
"crm_owners": [
],
"page_layout": [
{
"field_id": -1,
"customfield_id": "1706707000000490001",
"show_in_store": true,
"is_editable": true,
"is_mandatory": false,
"label": "Include a note for us",
"entity_type_formatted": "Item",
"is_custom_field": true,
"is_mandatory_in_sales_item": false,
"field_name": "Include a note for us",
"is_enabled": true,
"is_reporting_tag": false,
"edit_on_store": true,
"entity_type": "item",
"can_show_in_pdf": true,
"hint": "",
"data_type": "string",
"tag_id": "",
"entity_customization_id": "1706707000000490013",
"value": ""
},
{...}
],
"is_page_layouts_available": true,
"page_layouts": [
{
"page_layout_id": "1706707000000496001",
"name": "Include Note Layout",
"description": "",
"created_by": 1706707000000069405,
"created_time": 1573743725173,
"type": "item",
"categories": [
],
"entity_type": "item"
}
]
}
Show full
Show less