# List Product Settings ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/products/settings: get: summary: List Product Settings deprecated: false description: >- The product setting endpoint allows merchants to retrieve the current product settings status from their dashboard. These settings control various aspects of how products are displayed, including search features, related products, and sold product counts. The endpoint helps merchants manage and fine-tune the visibility and order of products in their stores. `products.read` - Products Read tags: - Default module/Apps/Merchant APIs/Products/Managing Products parameters: - name: x-manager-token in: header description: >- A token used to verify the manager's identity and authorize the request required: false example: '{{Access-Token}}' schema: type: string - name: Authorization in: header description: ' A Bearer token used to authenticate the merchant.' required: false example: '{{Autherization}}' schema: type: string - name: store-id in: header description: The unique identifier of the merchant's store. required: false example: '{{StoreId}}' schema: type: string - name: Role in: header description: Role of the user. required: false example: Manager schema: type: string - name: Accept-Language in: header description: '' required: false example: en schema: type: string enum: - ar - en x-apidog-enum: - value: ar name: '' description: '' - value: en name: '' description: '' responses: '200': description: '' content: application/json: schema: title: Retrieve Product Settings Response type: object description: >- Response returned when retrieving product-related configuration settings for a store. required: - settings properties: settings: type: object description: >- Container object holding all product configuration settings. required: - extended_search_support - related_products_status - related_products_count - sold_products_count_status - min_sold_products_count - default_products_ordering - has_products_filtration - is_wishlist_enabled properties: extended_search_support: type: boolean description: >- Indicates whether extended product search functionality is enabled (e.g., searching by additional attributes or metadata). examples: - false related_products_status: type: boolean description: >- Determines whether related products are enabled and displayed on product pages. examples: - false related_products_count: type: integer description: >- Number of related products to display when related products are enabled. examples: - 8 sold_products_count_status: type: boolean description: >- Indicates whether the sold products count is visible on product listings or product details pages. examples: - false min_sold_products_count: type: integer description: >- Minimum sold quantity required before the sold products count is displayed. examples: - 1 default_products_ordering: type: string description: >- Default ordering rule applied when listing products. Supports multiple comma-separated fields, prefixed with '-' for descending order. examples: - '-is_infinite,-quantity' has_products_filtration: type: boolean description: >- Indicates whether product filtering (e.g., by price, category, attributes) is enabled in the storefront or dashboard. examples: - false is_wishlist_enabled: type: boolean description: >- Determines whether the wishlist feature is enabled for customers. examples: - true examples: - extended_search_support: false related_products_status: false related_products_count: 8 sold_products_count_status: false min_sold_products_count: 1 default_products_ordering: '-is_infinite,-quantity' has_products_filtration: false is_wishlist_enabled: true x-apidog-orders: - extended_search_support - related_products_status - related_products_count - sold_products_count_status - min_sold_products_count - default_products_ordering - has_products_filtration - is_wishlist_enabled x-apidog-ignore-properties: [] x-apidog-orders: - settings x-apidog-ignore-properties: [] example: settings: extended_search_support: false related_products_status: false related_products_count: 8 sold_products_count_status: false min_sold_products_count: 1 default_products_ordering: '-is_infinite,-quantity' has_products_filtration: false is_wishlist_enabled: true is_quick_donation_enabled: false headers: {} x-apidog-name: Success '401': description: '' content: application/json: schema: type: object description: >- Response returned when the request cannot be authenticated because the required credentials are missing, invalid, or expired. properties: status: type: string description: Indicates the overall status of the API response. examples: - error message: type: object description: >- Contains structured details explaining why the request could not be authenticated. properties: type: type: string description: Indicates the category of the response message. examples: - error code: type: string description: >- A machine-readable code identifying the authentication error. Returns null when no specific code is available. examples: - UNAUTHORIZED nullable: true name: type: string description: >- A short, human-readable title describing the authentication error. Returns null when no title is available. examples: - Unauthorized nullable: true description: type: string description: >- A human-readable explanation of why the request could not be authenticated. Returns null when no detailed explanation is available. examples: - >- Authentication credentials are missing, invalid, or expired. nullable: true required: - type - code - name - description x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] required: - status - message x-apidog-orders: - status - message examples: - status: error message: type: error code: UNAUTHORIZED name: Unauthorized description: >- Authentication credentials are missing, invalid, or expired. x-apidog-ignore-properties: [] examples: '2': summary: Example 1 value: status: error message: type: error code: ERROR_SESSION_MISSING name: Sorry description: Please login first. '3': summary: Example 2 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Login session expired. Please login again. '4': summary: Example 3 value: status: error message: type: error code: ERROR_SESSION_INVALID name: Sorry description: Invalid authentication headers: {} x-apidog-name: Unauthorized '500': description: '' content: application/json: schema: type: object properties: status: type: string description: Status of the error. message: $ref: '#/components/schemas/ResponseEnvelopMessage' required: - status - message x-apidog-orders: - status - message x-apidog-ignore-properties: [] example: status: error message: type: error code: MSG_HIDDEN name: Error description: Internal Server Error headers: {} x-apidog-name: Internal Server error security: [] x-apidog-folder: Default module/Apps/Merchant APIs/Products/Managing Products x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/613905/apis/api-9992615-run components: schemas: ResponseEnvelopMessage: type: object properties: type: type: string description: Type of response message returned by the API. examples: - success code: type: string description: Response code returned by the API, if available. examples: - MSG_POPUP_OK nullable: true name: type: string description: Name or title of the response message, if available. examples: - Coupons nullable: true description: type: string description: Detailed description of the response message, if available. examples: - Coupons created successfully nullable: true required: - type - code - name - description description: Additional response metadata. x-apidog-orders: - type - code - name - description x-apidog-ignore-properties: [] x-apidog-folder: '' securitySchemes: {} servers: - url: https://api.zid.sa/ description: Prod Env security: [] ```