Changelog

API Explorer now renders your store’s hash as a path parameter

Thanks to user feedback, store_hash now appears as a first-class, highlighted input in the API Explorer for the majority of REST endpoints — matching how order_id, product_id, and other resource identifiers already work.

• Highlighted in the request URL — {store_hash} renders with the same accent styling as other path parameters in the URL bar at the top of every Explorer page.

  

• Dedicated input field — store_hash now appears in the Path parameters section, so you can fill it in like any other parameter. Previously, you had to edit the URL string in the Explorer directly to set your store’s hash.

  

• Generated code snippets updated — cURL, JavaScript, and Python snippets on the right rail pick up the value you enter, no manual substitution required.

This update covers every REST endpoint in the API Reference.

For an example, see List Products.

Price Lists Records API: required fields corrected

Thanks to user feedback, we’ve corrected the API reference for the Create or Update Batch of Price Lists Records endpoint (PUT /pricelists/records). Several fields the server enforces as required were previously marked as optional.

• price_list_id — now correctly marked Required
• currency — now correctly marked Required
• variant_id or sku — clarified that exactly one of these is required to identify the variant
• Operation description — added a note summarizing the required fields

For details, see Create or Update Batch of Price Lists Records.

Product Modifiers spec accuracy improvements

Thanks to user feedback, we’ve improved the accuracy and consistency of the Product Modifiers OpenAPI spec so request and response shapes now match the live API exactly.

• Aligned UPDATE with CREATE — PUT /catalog/products/{product_id}/modifiers/{modifier_id} and the option_values update schema now share the same field set and types as their CREATE counterparts.
• Scoped option_value required fields to POST — label and sort_order are required only on create, matching the partial-update behavior of PUT.
• Corrected the Create Product Modifier response — the 200 response now refs the modifier schema directly under data, matching the live API and the GET/UPDATE responses (previously wrapped under a spurious data.items array).
• Documented adjusters.image_url as read-only — sending it on POST/PUT returns HTTP 500. The field is set via the dedicated Create Product Modifier Image endpoint, which is now cross-linked from the relevant operations.
• Tightened multipart upload schema — Create Product Modifier Image now declares image_file as required at the schema level instead of in prose.
• Removed noise from rendered docs — dropped redundant “Required/Read-Only Fields” prose blocks (Fern already renders these inline), and removed meaningless full-int32 min/max bounds on sort_order that were rendering as a confusing range pill.

For details, see the Product Modifiers reference.