/hm/categories/products

POST /api/hm/categories/products

Price: 10 credits

List H&M products in a category: article id, name, brand, price, list_price, images, available colors (swatches), sizes with stock, stock availability and category code.

How to use it

List products from an H&M category. Provide category as {category_id, page_id} (e.g. category_id 'men_viewall', page_id '/men/shop-by-product/view-all') plus a locale and how many products you want. Returns id (article number), name, brand, url, alias, price/list_price/price_formatted, image+images, color_name, colors (other color variants with their article id/name/code/image), sizes (label + stock), is_in_stock, is_new_arrival, is_multipack, has_video and category code.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category object required — H&M category to list products from (examples: {"category_id":"men_viewall","page_id":"/men/shop-by-product/view-all"})
  • category_id string required — H&M category filter id (examples: "men_viewall"; minLength: 1)
  • page_id string required — H&M category navigation path (examples: "/men/shop-by-product/view-all"; minLength: 1)
• locale string — H&M store locale (default: "en_us"; one of: "en_us", "en_gb", "de_de", "fr_fr", "es_es", "it_it")
• count integer required — Max number of products to return (min: 1)

Response

• @type string (default: "HmProduct")
• id string required
• name string nullable
• brand string nullable
• url string nullable
• alias string nullable
• price number nullable
• list_price number nullable
• price_formatted string nullable
• image string nullable
• images array (default: [])
• color_name string nullable
• colors array (default: [])
  • @type string (default: "HmProductColor")
  • article_id string required
  • name string nullable
  • code string nullable
  • url string nullable
  • image string nullable
• sizes array (default: [])
  • @type string (default: "HmProductSize")
  • id string required
  • label string nullable
  • stock integer nullable
• is_in_stock boolean nullable
• is_coming_soon boolean nullable
• is_new_arrival boolean nullable
• is_multipack boolean nullable
• has_video boolean nullable
• category 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 — The entity was not found, or a precondition failed 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.