Piloterr

Shophouzz Product

GET
/v2/shophouzz/product

Retrieve full product details from Shophouzz, including title, price, variants, images, vendor, and structured metadata.

Credit cost: 1 credit per call

Authentification

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Paramètres de requête

query*string

Full URL of the Shophouzz product page to retrieve details for.

Example:

https://shophouzz.com/products/burke-counter-stool-cognac-vegan-leather-white-oak-veneer-metal-dowel-prvw-vr-186041078

Notes:

  • Full product URL required: The query must be the complete product page URL, including the product handle.
  • Handle-only format not supported: Only full URLs starting with https://shophouzz.com/products/ are accepted.
fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Corps de la réponse

Successful response

application/json
  1. response
id?integer
tags?string
image?
title?string
handle?string
images?array<>
vendor?string
options?array<>
variants?array<>
body_html?string
created_at?string
updated_at?string
product_type?string
published_at?string
published_scope?string
template_suffix?unknown
Example Request
curl -X GET 'https://api.piloterr.com/v2/shophouzz/product?query=string'
Example Response
{  "id": 9992209793336,  "tags": "assembly_required, best-seller, black, black faux leather, black faux leather straps, comfortable, compliance:cal-prop-65, contemporary, elegant, furniture, matte black metal frame, modern, soft black faux leather, vendor-type:direct, white oak veneer metal dowel, YGroup_857-Parent",  "image": {    "id": 51424882983224,    "alt": null,    "src": "https://cdn.shopify.com/s/files/1/0941/8535/7624/files/d428cade-7856-43a2-b0ab-ad6d1fa4c68d.jpg?v=1770873702",    "width": 478,    "height": 990,    "position": 1,    "created_at": "2025-06-27T23:07:28-07:00",    "product_id": 9992209793336,    "updated_at": "2026-02-11T21:21:42-08:00",    "variant_ids": []  },  "title": "Burke Counter Stool, Cognac, Vegan Leather, White Oak Veneer Metal Dowel",  "handle": "burke-counter-stool-cognac-vegan-leather-white-oak-veneer-metal-dowel-prvw-vr-186041078",  "images": [    {      "id": 51424882983224,      "alt": null,      "src": "https://cdn.shopify.com/s/files/1/0941/8535/7624/files/d428cade-7856-43a2-b0ab-ad6d1fa4c68d.jpg?v=1770873702",      "width": 478,      "height": 990,      "position": 1,      "created_at": "2025-06-27T23:07:28-07:00",      "product_id": 9992209793336,      "updated_at": "2026-02-11T21:21:42-08:00",      "variant_ids": []    },    {      "id": 51424882852152,      "alt": null,      "src": "https://cdn.shopify.com/s/files/1/0941/8535/7624/files/9f98d8da-988d-4d34-b3ff-90ddc25486cf.jpg?v=1770873702",      "width": 990,      "height": 990,      "position": 2,      "created_at": "2025-06-27T23:07:28-07:00",      "product_id": 9992209793336,      "updated_at": "2026-02-11T21:21:42-08:00",      "variant_ids": []    },    {      "id": 51424883114296,      "alt": null,      "src": "https://cdn.shopify.com/s/files/1/0941/8535/7624/files/31ba4089-8a92-40b2-8b04-c7a3f02c4849.jpg?v=1770873702",      "width": 624,      "height": 990,      "position": 3,      "created_at": "2025-06-27T23:07:28-07:00",      "product_id": 9992209793336,      "updated_at": "2026-02-11T21:21:42-08:00",      "variant_ids": []    },    {      "id": 51424882950456,      "alt": null,      "src": "https://cdn.shopify.com/s/files/1/0941/8535/7624/files/673c4606-170e-4568-bd23-7d9e4a56a5b5.jpg?v=1770873702",      "width": 690,      "height": 990,      "position": 4,      "created_at": "2025-06-27T23:07:28-07:00",      "product_id": 9992209793336,      "updated_at": "2026-02-11T21:21:42-08:00",      "variant_ids": []    },    {      "id": 51424883048760,      "alt": null,      "src": "https://cdn.shopify.com/s/files/1/0941/8535/7624/files/f3267b6e-3bd2-4fe3-aed7-0fae3e1f183c.jpg?v=1770873702",      "width": 990,      "height": 660,      "position": 5,      "created_at": "2025-06-27T23:07:28-07:00",      "product_id": 9992209793336,      "updated_at": "2026-02-11T21:21:42-08:00",      "variant_ids": []    },    {      "id": 51424882884920,      "alt": null,      "src": "https://cdn.shopify.com/s/files/1/0941/8535/7624/files/e01a9298-c313-44e9-b47c-94009ee0fbde.jpg?v=1770873702",      "width": 990,      "height": 738,      "position": 6,      "created_at": "2025-06-27T23:07:28-07:00",      "product_id": 9992209793336,      "updated_at": "2026-02-11T21:21:42-08:00",      "variant_ids": []    }  ],  "vendor": "Meridian Furniture",  "options": [    {      "id": 12575493423416,      "name": "Color",      "values": [        "Cognac"      ],      "position": 1,      "product_id": 9992209793336    },    {      "id": 12575493456184,      "name": "Configuration",      "values": [        "White Oak Veneer Metal Dowel"      ],      "position": 2,      "product_id": 9992209793336    },    {      "id": 12575493488952,      "name": "Design",      "values": [        "Vegan Leather"      ],      "position": 3,      "product_id": 9992209793336    }  ],  "variants": [    {      "id": 50554338476344,      "sku": "857Cognac-C",      "grams": 14061,      "price": "237.99",      "title": "Cognac / White Oak Veneer Metal Dowel / Vegan Leather",      "weight": 31,      "barcode": "94308268583",      "option1": "Cognac",      "option2": "White Oak Veneer Metal Dowel",      "option3": "Vegan Leather",      "taxable": true,      "image_id": null,      "position": 1,      "created_at": "2025-06-27T23:07:26-07:00",      "product_id": 9992209793336,      "updated_at": "2026-04-27T08:03:33-07:00",      "weight_unit": "lb",      "quantity_rule": {        "max": null,        "min": 1,        "increment": 1      },      "price_currency": "USD",      "compare_at_price": "",      "requires_shipping": true,      "fulfillment_service": "manual",      "inventory_management": "shopify",      "quantity_price_breaks": [],      "compare_at_price_currency": ""    }  ],  "body_html": "<p>Kick back and relax with a drink in your hand with this Burke cognac vegan leather counter stool. Featuring soft cognac vegan leather upholstery and cognac vegan leather straps, this counter stool is cozy and stylish. Its matte cognac metal frame provides sturdy support so you can enjoy this stool for years to come. A white oak veneer metal dowel is tucked firmly in place beneath the front of the stool, providing extra support and added style.</p>\n\n<p>Overall Product Dimensions: 18\" W x 24\" D x 37.5\" H\n<br>Soft Cognac Vegan Leather\n<br>Black Vegan Leather Straps\n<br>Matte Black Metal Frame\n<br>White Oak Veneer Metal Dowel\n<br>Counter Height Stool\n<br>Contemporary Design</p>\n\n<p>Seat Dimensions: \n<br>Seat Width: 18\"\n<br>Seat Height: 26.4\"\n<br>Seat Depth: 16\"\n<br>Back Height: 11.25\"</p>",  "created_at": "2025-06-27T23:07:26-07:00",  "updated_at": "2026-04-27T08:03:33-07:00",  "product_type": "Product",  "published_at": "2025-06-27T23:07:27-07:00",  "published_scope": "web",  "template_suffix": null}