Skip to content

View Product Detail

GET
/products/{product_id}

Parameters

Path Parameters

product_id
required
integer

ID of the Product

Example
574316

Responses

200

OK

object
id
number
title
string
created_by_id
number
created_at
string
weight
number
origin_country
nullable
deleted_at
nullable
deleted_by_id
nullable
hs_tariff_number
nullable
notes
string
product_tax_rate_id
nullable
tax_rate
number
updated_at
string
updated_by_id
number
web_meta_description
string
web_meta_keywords
string
web_meta_title
string
web_page_title
string
web_page_url
string
main_image
object
id
number
binary_data
nullable
content_type
nullable
display_position
number
created_by_id
nullable
updated_by_id
nullable
deleted_at
nullable
deleted_by_id
nullable
created_at
string
updated_at
string
src
string
product_id
number
picture_file_name
nullable
picture_content_type
nullable
picture_file_size
nullable
picture_updated_at
nullable
picture_order
number
estimated_delivery
nullable
total_quantity_sold
number
brand
nullable
sellables
Array<object>
object
total_quantity_sold
required
number
allocated_stock_level_at_all_warehouses
required
number
id
required
number
type
required
string
title
required
string
sku_code
required
string
upc_code
required
string
model_number
required
string
price
required
number
cost_price
required
number
min_reorder_level
required
number
quantity_to_reorder
required
number
created_by_id
required
number
created_at
required
string
updated_at
required
string
weight_grams
required
number
weight_unit
required
string
product_title
required
string
full_title
required
string
sellable_title
required
string
profit
required
number
margin
required
number
tax_rate
required
number
product
required
object
id
number
title
string
weight
number
origin_country
nullable
hs_tariff_number
nullable
tax_rate
number
main_image
object
id
number
binary_data
nullable
content_type
nullable
display_position
number
created_by_id
nullable
updated_by_id
nullable
deleted_at
nullable
deleted_by_id
nullable
created_at
string
updated_at
string
src
string
product_id
number
picture_file_name
nullable
picture_content_type
nullable
picture_file_size
nullable
picture_updated_at
nullable
picture_order
number
estimated_delivery
nullable
deleted_at
nullable
deleted_by_id
nullable
description
string
main_image_src
string
stock_entries
required
Array<object>
object
sellable_id
required
number
warehouse_id
required
number
infinite
required
boolean
allocated_stock_level
required
number
warehouse
required
object
id
number
name
string
user_id
nullable
address_line_1
string
address_line_2
string
city
string
region
string
country
nullable
post_code
string
inventory_type_code
string
default_min_reorder
number
click_and_collect_enabled
boolean
click_and_collect_days
nullable
created_by_id
number
updated_by_id
nullable
deleted_at
nullable
deleted_by_id
nullable
created_at
string
updated_at
string
phone
nullable
requested_carrier_account
nullable
location
required
nullable
stock_running_low
required
boolean
updated_at
required
string
incoming_stock_level
required
number
physical_stock_level
required
number
available_stock_level
required
number
sellable_on_hand_value
required
number
variant_option_specifics
required
Array
variant_property_specifics
required
Array
measurement_attributes
required
object
id
number
width
number
height
number
depth
number
dimensions_unit
string
images
required
Array
active_channels
required
Array
channel_sellables
required
Array
available_stock_level_at_all_warehouses
required
number
stock_level_at_all_warehouses
required
number
on_hand_value
required
number
inventory
required
object
infinite
boolean
physical_stock_level_at_all_warehouses
number
allocated_stock_level_at_all_warehouses
number
available_stock_level_at_all_warehouses
number
incoming_stock_level_at_all_warehouses
number
weight
required
number
channel_products
Array
active_channels
Array
tags
Array
image
string
description
string
on_hand_value
number
main_image_src
string
total_allocated_stock_level
number
total_available_stock_level
number
total_stock_level
number
inventory
object
infinite
boolean
Example
{
"id": 8636420,
"title": "Golden Retriever Dog - Title",
"created_by_id": 23005,
"created_at": "2017-10-13T09:08:13.707Z",
"weight": 0,
"origin_country": null,
"deleted_at": null,
"deleted_by_id": null,
"hs_tariff_number": null,
"notes": "Golden Retriever Dog - Notes",
"product_tax_rate_id": null,
"tax_rate": 0,
"updated_at": "2017-10-13T14:17:46.833Z",
"updated_by_id": 23005,
"web_meta_description": "",
"web_meta_keywords": "",
"web_meta_title": "",
"web_page_title": "",
"web_page_url": "",
"main_image": {
"id": 11499439,
"binary_data": null,
"content_type": null,
"display_position": 1,
"created_by_id": null,
"updated_by_id": null,
"deleted_at": null,
"deleted_by_id": null,
"created_at": "2017-10-13T09:08:13.759Z",
"updated_at": "2017-10-13T09:08:13.759Z",
"src": "http://pluspng.com/img-png/dog-png-dog-png-image-267.png",
"product_id": 8636420,
"picture_file_name": null,
"picture_content_type": null,
"picture_file_size": null,
"picture_updated_at": null,
"picture_order": 9999
},
"estimated_delivery": null,
"total_quantity_sold": 0,
"brand": null,
"sellables": [
{
"total_quantity_sold": 0,
"allocated_stock_level_at_all_warehouses": 0,
"id": 14144703,
"type": "ProductVariant",
"title": "Puppy - ProdVariantTitle",
"sku_code": "g-dog-2",
"upc_code": "",
"model_number": "",
"price": 150,
"cost_price": 100,
"min_reorder_level": 0,
"quantity_to_reorder": 0,
"created_by_id": 23005,
"created_at": "2017-10-13T09:08:13.744Z",
"updated_at": "2017-10-13T14:17:46.763Z",
"weight_grams": 0,
"weight_unit": "g",
"product_title": "Golden Retriever Dog - Title",
"full_title": "Golden Retriever Dog - Title Puppy - ProdVariantTitle",
"sellable_title": "Puppy - ProdVariantTitle",
"profit": 50,
"margin": 33.33,
"tax_rate": 0,
"product": {
"id": 8636420,
"title": "Golden Retriever Dog - Title",
"weight": 0,
"origin_country": null,
"hs_tariff_number": null,
"tax_rate": 0,
"main_image": {
"id": 11499439,
"binary_data": null,
"content_type": null,
"display_position": 1,
"created_by_id": null,
"updated_by_id": null,
"deleted_at": null,
"deleted_by_id": null,
"created_at": "2017-10-13T09:08:13.759Z",
"updated_at": "2017-10-13T09:08:13.759Z",
"src": "http://pluspng.com/img-png/dog-png-dog-png-image-267.png",
"product_id": 8636420,
"picture_file_name": null,
"picture_content_type": null,
"picture_file_size": null,
"picture_updated_at": null,
"picture_order": 9999
},
"estimated_delivery": null,
"deleted_at": null,
"deleted_by_id": null,
"description": "Golden Retriever Dog - Description",
"main_image_src": "http://pluspng.com/img-png/dog-png-dog-png-image-267.png"
},
"stock_entries": [
{
"sellable_id": 14144703,
"warehouse_id": 22668,
"infinite": false,
"allocated_stock_level": 0,
"warehouse": {
"id": 22668,
"name": "My Warehouse",
"user_id": null,
"address_line_1": "",
"address_line_2": "",
"city": "",
"region": "",
"country": null,
"post_code": "",
"inventory_type_code": "wavg",
"default_min_reorder": 0,
"click_and_collect_enabled": false,
"click_and_collect_days": null,
"created_by_id": 23005,
"updated_by_id": null,
"deleted_at": null,
"deleted_by_id": null,
"created_at": "2017-07-04T09:40:37.539Z",
"updated_at": "2017-07-04T09:40:37.539Z",
"phone": null,
"requested_carrier_account": null
},
"location": null,
"stock_running_low": true,
"updated_at": "2017-10-13T09:13:49.145Z",
"incoming_stock_level": 0,
"physical_stock_level": 0,
"available_stock_level": 0,
"sellable_on_hand_value": 0
}
],
"variant_option_specifics": [],
"variant_property_specifics": [],
"measurement_attributes": {
"id": 12587623,
"width": 0,
"height": 0,
"depth": 0,
"dimensions_unit": "cm"
},
"images": [],
"active_channels": [],
"channel_sellables": [],
"available_stock_level_at_all_warehouses": 0,
"stock_level_at_all_warehouses": 0,
"on_hand_value": 0,
"inventory": {
"infinite": false,
"physical_stock_level_at_all_warehouses": 0,
"allocated_stock_level_at_all_warehouses": 0,
"available_stock_level_at_all_warehouses": 0,
"incoming_stock_level_at_all_warehouses": 0
},
"weight": 0
},
{
"total_quantity_sold": 0,
"allocated_stock_level_at_all_warehouses": 0,
"id": 14144702,
"type": "ProductVariant",
"title": "Dog - ProdVariantTitle",
"sku_code": "g-dog-1",
"upc_code": "",
"model_number": "",
"price": 150,
"cost_price": 100,
"min_reorder_level": 0,
"quantity_to_reorder": 0,
"created_by_id": 23005,
"created_at": "2017-10-13T09:08:13.712Z",
"updated_at": "2017-10-13T14:17:46.750Z",
"weight_grams": 10,
"weight_unit": "g",
"product_title": "Golden Retriever Dog - Title",
"full_title": "Golden Retriever Dog - Title Dog - ProdVariantTitle",
"sellable_title": "Dog - ProdVariantTitle",
"profit": 50,
"margin": 33.33,
"tax_rate": 0,
"product": {
"id": 8636420,
"title": "Golden Retriever Dog - Title",
"weight": 0,
"origin_country": null,
"hs_tariff_number": null,
"tax_rate": 0,
"main_image": {
"id": 11499439,
"binary_data": null,
"content_type": null,
"display_position": 1,
"created_by_id": null,
"updated_by_id": null,
"deleted_at": null,
"deleted_by_id": null,
"created_at": "2017-10-13T09:08:13.759Z",
"updated_at": "2017-10-13T09:08:13.759Z",
"src": "http://pluspng.com/img-png/dog-png-dog-png-image-267.png",
"product_id": 8636420,
"picture_file_name": null,
"picture_content_type": null,
"picture_file_size": null,
"picture_updated_at": null,
"picture_order": 9999
},
"estimated_delivery": null,
"deleted_at": null,
"deleted_by_id": null,
"description": "Golden Retriever Dog - Description",
"main_image_src": "http://pluspng.com/img-png/dog-png-dog-png-image-267.png"
},
"stock_entries": [
{
"sellable_id": 14144702,
"warehouse_id": 22668,
"infinite": false,
"allocated_stock_level": 0,
"warehouse": {
"id": 22668,
"name": "My Warehouse",
"user_id": null,
"address_line_1": "",
"address_line_2": "",
"city": "",
"region": "",
"country": null,
"post_code": "",
"inventory_type_code": "wavg",
"default_min_reorder": 0,
"click_and_collect_enabled": false,
"click_and_collect_days": null,
"created_by_id": 23005,
"updated_by_id": null,
"deleted_at": null,
"deleted_by_id": null,
"created_at": "2017-07-04T09:40:37.539Z",
"updated_at": "2017-07-04T09:40:37.539Z",
"phone": null,
"requested_carrier_account": null
},
"location": null,
"stock_running_low": true,
"updated_at": "2017-10-13T09:13:49.172Z",
"incoming_stock_level": 0,
"physical_stock_level": 0,
"available_stock_level": 0,
"sellable_on_hand_value": 0
}
],
"variant_option_specifics": [],
"variant_property_specifics": [],
"measurement_attributes": {
"id": 12587624,
"width": 0,
"height": 0,
"depth": 0,
"dimensions_unit": "cm"
},
"images": [],
"active_channels": [],
"channel_sellables": [],
"available_stock_level_at_all_warehouses": 0,
"stock_level_at_all_warehouses": 0,
"on_hand_value": 0,
"inventory": {
"infinite": false,
"physical_stock_level_at_all_warehouses": 0,
"allocated_stock_level_at_all_warehouses": 0,
"available_stock_level_at_all_warehouses": 0,
"incoming_stock_level_at_all_warehouses": 0
},
"weight": 10
}
],
"channel_products": [],
"active_channels": [],
"tags": [],
"image": "http://pluspng.com/img-png/dog-png-dog-png-image-267.png",
"description": "Golden Retriever Dog - Description",
"on_hand_value": 0,
"main_image_src": "http://pluspng.com/img-png/dog-png-dog-png-image-267.png",
"total_allocated_stock_level": 0,
"total_available_stock_level": 0,
"total_stock_level": 0,
"inventory": {
"infinite": false
}
}