This endpoint is used to fetch the size guide for a specific product in an online store. The endpoint takes a product_id parameter, which is the ID of the product for which the size guide is being fetched.The Size Guides endpoint has been implemented in the Product Size Guide Web Component, and It's all setup to save developer's time and effort. Payload#
Response#
product.getSizeGuides.success
Data is available when the success is true
This value contains the name of the size guide. It is a string value that can be used to identify the size guide.
This value contains a description of the size guide. It is a string value that provides additional information about the size guide, such as how to use it or what it contains.
Usage#
To perform the action of retrieving the size guide for any product, the developer may call the method getSizeGuides() and pass in the product ID as an argument as follows:Events#
This endpoint may trigger two events, the onSizeGuideFetched and onSizeGuideFetchFailed events.onSizeGuideFetched#
This event is triggered when the action of retrieving the size guide for any product is done without having any errors coming back from the backend.onSizeGuideFetchFailed#
This event is triggered when the action of retrieving retrieving the size guide for any product is not completed and an error has occurred. Modified at 2025-03-04 12:54:02
