> ## Documentation Index > Fetch the complete documentation index at: https://docs.spurtcommerce.com/llms.txt > Use this file to discover all available pages before exploring further. # Get related products for a product slug. > Get related products for a product slug. **Authentication:** Public or token-aware middleware; handler has CheckTokenMiddleware. **Feature area:** Product discovery **Implementation source:** `src/api/store/controllers/StoreProductRelatedController.ts` **Request example provenance:** Use query parameter `productId` with the product slug; response fields are based on source success example. **Response example provenance:** Use query parameter `productId` with the product slug; response fields are based on source success example. > Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant. ## OpenAPI ````yaml /StoreAPI.json get /api/list/related-product-list openapi: 3.0.3 info: title: SpurtCommerce Store API version: 6.0.0 description: >- Store API reference generated from the public SpurtCommerce repository (master, package version 6.0.0). Route inventory, controller annotations, request examples and response examples were used where available. Examples that are not explicitly defined by source annotations are marked illustrative in the operation description. This specification excludes Admin APIs. license: name: MIT url: https://github.com/spurtcommerce/spurtcommerce/blob/master/LICENSE servers: - url: https://api.example.com description: Replace with your SpurtCommerce API host. Paths include the /api prefix. security: [] tags: - name: Store description: Store API endpoint reference, organized by functional topic. - name: Cart description: >- Retrieve, create, update, and clear the authenticated customer shopping cart. x-parent: Store x-displayName: Cart - name: Customer address description: >- Create, retrieve, and manage customer addresses and live-address settings used during checkout. x-parent: Store x-displayName: Customer address - name: Customer profile description: >- Retrieve and update the signed-in customer profile and read customer permission modules and assignments. x-parent: Store x-displayName: Customer profile - name: Authentication description: >- Register customers, send and verify OTPs, sign in, sign out, and authenticate through supported OAuth providers. x-parent: Store x-displayName: Authentication - name: Wishlist description: >- Add products to the customer wishlist, list saved items, and remove wishlist entries. x-parent: Store x-displayName: Wishlist - name: Product discovery description: >- Discover products and categories, retrieve product details, compare products, and inspect filters, attributes, and variants. x-parent: Store x-displayName: Product discovery - name: Orders description: >- Retrieve order details and payment status, request cancellations, track shipments, download invoices, and retry payments. x-parent: Store x-displayName: Orders - name: Store content description: >- Retrieve storefront settings, categories, languages, zones, payment methods, CMS pages, banners, widgets, and contact information. x-parent: Store x-displayName: Store content - name: Payments description: >- Start supported Store payment flows for existing orders through PayPal, Razorpay, and Stripe. x-parent: Store x-displayName: Payments - name: Ratings and reviews description: >- Retrieve product rating counts, rating distributions, and customer reviews for product SKUs. x-parent: Store x-displayName: Ratings and reviews - name: Products x-parent: Product discovery description: Browse product listings and retrieve product details. - name: Categories x-parent: Product discovery description: Browse storefront product categories and category filters. - name: Product comparison x-parent: Product discovery description: Compare products and retrieve related product suggestions. - name: Attributes and variants x-parent: Product discovery description: Retrieve product attributes and variant options. - name: Product ratings and reviews x-parent: Product discovery description: Retrieve product ratings, statistics and customer reviews. - name: Customer login and sessions x-parent: Authentication description: Register, authenticate and sign out customer accounts. - name: OTP and verification x-parent: Authentication description: Send and verify one-time passwords for customer authentication. - name: OAuth authentication x-parent: Authentication description: Authenticate customers through supported OAuth providers. - name: Customer permissions x-parent: Customer profile description: Retrieve customer permission modules and assignments. - name: Address book x-parent: Customer address description: Manage customer delivery and billing addresses. - name: Cart items x-parent: Cart description: Retrieve, create and remove shopping cart items. - name: Order details and tracking x-parent: Orders description: Retrieve order details, tracking and payment status. - name: Order cancellation x-parent: Orders description: Retrieve cancellation reasons and submit cancellation requests. - name: Order payments x-parent: Orders description: Retry order payments and retrieve payment status. - name: Payment gateways x-parent: Payments description: Start Store payment flows for supported payment gateways. - name: Store configuration x-parent: Store content description: Retrieve storefront settings, payment methods and configuration. - name: Navigation and widgets x-parent: Store content description: Retrieve storefront banners, widgets and navigation data. - name: Localization x-parent: Store content description: Retrieve available languages, zones and localization options. - name: Contact and store information x-parent: Store content description: Retrieve store contact information and public store metadata. - name: Store pages x-parent: Store content description: Retrieve published storefront content pages. paths: /api/list/related-product-list: get: tags: - Product comparison summary: Get related products for a product slug. description: >- Get related products for a product slug. **Authentication:** Public or token-aware middleware; handler has CheckTokenMiddleware. **Feature area:** Product discovery **Implementation source:** `src/api/store/controllers/StoreProductRelatedController.ts` **Request example provenance:** Use query parameter `productId` with the product slug; response fields are based on source success example. **Response example provenance:** Use query parameter `productId` with the product slug; response fields are based on source success example. > Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant. operationId: getApiListRelatedProductList parameters: - name: productId in: query required: false schema: type: string example: wireless-headphones description: Query parameter productId. - name: count in: query required: false schema: type: boolean example: 'false' description: Query parameter count. responses: '200': description: >- Successful response. Use query parameter `productId` with the product slug; response fields are based on source success example. content: application/json: schema: type: object properties: status: type: string message: type: string data: type: object properties: productId: type: integer skuId: type: integer name: type: string price: type: string productSlug: type: string quantity: type: integer rating: type: number categoryLevels: type: array items: {} additionalProperties: true additionalProperties: true examples: success: summary: Sample success response value: status: '1' message: Related Product List Showing Successfully..! data: productId: 1 skuId: 1 name: Wireless Headphones price: '79.99' productSlug: wireless-headphones quantity: 25 rating: 4.5 categoryLevels: [] '400': description: >- Error response example. Use query parameter `productId` with the product slug; response fields are based on source success example. content: application/json: schema: type: object properties: status: type: integer message: type: string additionalProperties: true examples: error: summary: Sample error response value: status: 1 message: Invalid product. externalDocs: description: Open implementation source in GitHub url: >- https://github.com/spurtcommerce/spurtcommerce/blob/master/src/api/store/controllers/StoreProductRelatedController.ts x-codeSamples: - lang: HTTP label: HTTP source: > GET /api/list/related-product-list?productId=wireless-headphones&count=false HTTP/1.1 Host: Accept: application/json - lang: bash label: cURL source: |- curl --request GET \ 'https:///api/list/related-product-list?productId=wireless-headphones&count=false' \ --header 'Accept: application/json' - lang: JavaScript label: JavaScript (fetch) source: |- const API_BASE_URL = 'https://'; const url = new URL("/api/list/related-product-list", API_BASE_URL); const query = { "productId": "wireless-headphones", "count": "false" }; for (const [key, value] of Object.entries(query)) { url.searchParams.set(key, String(value)); } const headers = { "Accept": "application/json" }; const response = await fetch(url, { method: "GET", headers }); const result = await response.json(); console.log(response.status, result); - lang: JavaScript label: Node.js (Axios) source: >- import axios from 'axios'; const API_BASE_URL = 'https://'; const url = `${API_BASE_URL}/api/list/related-product-list`; const API_BASE_URL = 'https://'; const url = `${API_BASE_URL}/api/list/related-product-list`; const headers = { "Accept": "application/json" }; const params = { "productId": "wireless-headphones", "count": "false" }; const response = await axios.request({ method: "GET", url, headers, params }); console.log(response.status, response.data); - lang: Python label: Python (requests) source: >- import requests url = 'https:///api/list/related-product-list' headers = {'Accept': 'application/json'} params = {'productId': 'wireless-headphones', 'count': 'false'} response = requests.request('GET', url, headers=headers, params=params) print(response.status_code) print(response.json()) ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.