View Product Detail
GET /products/{product_id}
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”ID of the Product
Responses
Section titled “ Responses ”OK
object
ID of the product.
The product’s title.
ID of the user who created the product.
The time the product was created.
Two letter country code where this product was manufactured, for customs declarations. Used for international shipments if the product’s variants have no origin country.
The Harmoized System code (tarriff number) of this product. Used for international shipments if the product’s variants have no HS code.
Notes associated with this product.
The tax rate of this product.
The date and time this product was last updated.
ID of the user that last updated the product.
object
Number of days this product will take to ship. This value is overridden by this product’s sellables.
Whether this product contains hazardous goods, required to be declared by certain carriers. This value is overridden by this product’s sellables.
Number of units this product has sold within the past 6 months.
The brand this product is associated with.
object
ID of the product brand.
The name of the product brand.
The position in which this brand is displayed.
The number of products this brand is attached to.
The product variants and/or kits associated with this product.
object
object
object
object
object
object
object
object
List of linked store listings.
List of channels that this product has a listing linked to it.
Tags on this product.
object
ID of the tag.
Name of the tag.
Color of the tag, in hexadecimal format or a HTML color name.
Customer-facing product description.
The number of units available multiplied by the cost price.
URL of the product’s main image.
The number of units that are committed to open orders across all product variants.
The number of units that are available for sale across all product variants.
The number of units that are ready for sale across all product variants.
object
Whether this product has infinte stock level in any location.
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 }}