/ifixit/products

POST /api/ifixit/products

Price: 5 credits

Get one iFixit store product with every option, price, stock level and compatible device

How to use it

The full record behind a store product handle: one variant per option combination, each with its own price, stock level, SKU, warranty and specification table. Prices and stock come back for the US store; other regions are reachable through the product search. Everything a buyer needs to judge fit lives here — compatible_devices, the per-variant specifications_html and kit_contents_html — and none of it is in the search results, so fetch the product itself before answering 'does this part fit'. Pass the handle from a product URL, not the numeric product code.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Store product handle, or the URL of a product page (examples: "iphone-13-battery", "https://www.ifixit.com/products/iphone-13-battery"; minLength: 1)

Response

• @type string (default: "IfixitProduct")
• id string required
• name string required
• alias string required
• url string nullable
• sku string nullable
• shopify_id string nullable
• description string nullable
• vendor string nullable
• is_enabled boolean nullable
• rating number nullable
• rating_count integer nullable
• view_count integer nullable
• view_count_today integer nullable
• view_count_week integer nullable
• view_count_month integer nullable
• prop65_chemicals string nullable
• prop65_warning_type string nullable
• has_more_compatible_devices boolean nullable
• video_url string nullable
• categories array (default: [])
• item_types array (default: [])
• tool_categories array (default: [])
• tags array (default: [])
• device_ancestors array (default: [])
• enabled_store_regions array (default: [])
• compatibility_notes array (default: [])
• fixbot_suggestions array (default: [])
• images array (default: [])
• breadcrumbs array (default: [])
  • @type string (default: "IfixitBreadcrumb")
  • name string required
  • url string nullable
• options array (default: [])
  • @type string (default: "IfixitProductOption")
  • name string required
  • values array (default: [])
• variants array (default: [])
  • @type string (default: "IfixitProductVariant")
  • id string required
  • name string nullable
  • sku string nullable
  • product_code string nullable
  • option_id string nullable
  • internal_name string nullable
  • price number nullable
  • currency string nullable
  • compare_at_price number nullable
  • discount_percent integer nullable
  • is_discounted boolean nullable
  • quantity_available integer nullable
  • is_backordered boolean nullable
  • is_preorder boolean nullable
  • is_enabled boolean nullable
  • disable_when_out_of_stock boolean nullable
  • expected_ship_date string nullable
  • ships_from string nullable
  • fulfiller string nullable
  • core_return_value number nullable
  • warranty string nullable
  • warning string nullable
  • image string nullable
  • description_html string nullable
  • note_html string nullable
  • disclaimer_html string nullable
  • specifications_html string nullable
  • kit_contents_html string nullable
  • assembly_contents_html string nullable
  • shipping_restrictions array (default: [])
  • selected_options array (default: [])
    • @type string (default: "IfixitSelectedOption")
    • name string required
    • value string nullable
  • cross_sells array (default: [])
    • @type string (default: "IfixitProductPreview")
    • alias string required
    • name string nullable
    • url string nullable
    • image string nullable
    • sku string nullable
    • price number nullable
    • currency string nullable
    • rating number nullable
    • rating_count integer nullable
    • quantity_available integer nullable
    • categories array (default: [])
    • is_pro boolean nullable
    • has_lifetime_warranty boolean nullable
    • is_enabled boolean nullable
• compatible_devices array (default: [])
  • @type string (default: "IfixitCompatibleDevice")
  • name string required
  • url string nullable
  • image string nullable
  • variants array (default: [])
• guides array (default: [])
  • @type string (default: "IfixitProductGuide")
  • id string required
  • name string nullable
  • url string nullable
  • image string nullable
  • summary string nullable
  • time_required string nullable
  • difficulty string nullable
• faqs array (default: [])
  • @type string (default: "IfixitProductFaq")
  • question string required
  • answer string nullable
  • priority integer nullable
  • category string nullable
  • item_type string nullable
• featured_products array (default: [])
  • @type string (default: "IfixitProductPreview")
  • alias string required
  • name string nullable
  • url string nullable
  • image string nullable
  • sku string nullable
  • price number nullable
  • currency string nullable
  • rating number nullable
  • rating_count integer nullable
  • quantity_available integer nullable
  • categories array (default: [])
  • is_pro boolean nullable
  • has_lifetime_warranty boolean nullable
  • is_enabled boolean nullable
• specs array (default: [])
  • @type string (default: "IfixitProductSpec")
  • name string required
  • value string nullable
• bits array (default: [])
  • @type string (default: "IfixitToolkitBit")
  • id string required
  • size string nullable
  • bit_type string nullable
  • driver_size string nullable
  • icon string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No store product exists under that handle. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.