v1

Similar Products

Find products similar to a given product.

Consider setting filters to narrow results to the same gender, brand, category, price range, etc. when you only want similar items within a specific slice of the catalog.

post/v1/similar

Request body

product_idstring required

Canonical product ID to find similar products for.

limitinteger nullable

Optional limit on the number of results. Default is 20, max is 30.

page_tokenstring nullable

Opaque token from a previous similar response to fetch the next page of results.

Response

Successful Response

next_page_tokenstring nullable

Token to fetch the next page. Null when no more results.

Changes

Changed in 12 of the 45 revisions of this API.1231

    • response property products/items/images/items/is_cleaned_image deprecated

      response-property-deprecated

    • added the optional property products/items/images/items/cleaned_url to the response with the 200 status

      response-optional-property-added

    • added the new optional request property filters/colors/anyOf[subschema #1: SearchColorsFilter]/match

      new-optional-request-property

    • removed the request property config/preferred_length_unit

      request-property-removed

    • removed the request property config/preferred_weight_unit

      request-property-removed

    • added the new optional request property config/length_unit

      new-optional-request-property

    • added the new optional request property config/weight_unit

      new-optional-request-property

    • added the new optional request property config/preferred_length_unit

      new-optional-request-property

    • added the new optional request property config/preferred_weight_unit

      new-optional-request-property

    • added the new optional request property filters/dimensions

      new-optional-request-property

    • added the optional property products/items/offers/items/dimensions to the response with the 200 status

      response-optional-property-added

    • added the new optional request property filters/sale

      new-optional-request-property

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property products/items/offers/items/condition to the response with the 200 status

      response-optional-property-added

    • added the optional property products/items/images/items/is_cleaned_image to the response with the 200 status

      response-optional-property-added

    • added the optional property products/items/category to the response with the 200 status

      response-optional-property-added

    • the categories response's property default value was removed for the status 200

      response-property-default-value-removed

    • response property products/items/categories deprecated

      response-property-deprecated

    • added the optional property products/items/variants to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog