Product Setting

GET

https://api.zid.sa/v1/products/settings

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.

🔑Scopes

products.read - Products Read

Request

Header Params

x-manager-token

string

optional

A token used to verify the manager's identity and authorize the request

Example:

x-manager-token: A1B2C3D4E5F6G7H8I9J0

store-id

string

optional

The unique identifier of the merchant's store.

Example:

12345

Authorization

string

optional

A Bearer token used to authenticate the merchant.

Example:

Authorization: Bearer abcd1234efgh5678ijkl

Role

string

optional

Role of the user.

Example:

Manager

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zid.sa/v1/products/settings' \
--header 'x-manager-token: x-manager-token: A1B2C3D4E5F6G7H8I9J0' \
--header 'store-id: 12345' \
--header 'Authorization: Authorization: Bearer abcd1234efgh5678ijkl' \
--header 'Role: Manager'

Responses

🟢200Success

application/json

Body

extended_search_support

boolean

required

A boolean flag (true or false) that determines whether the product search results are more intelligent and comprehensive. If set to true, the search includes broader criteria.

related_products_status

boolean

required

A boolean flag that determines whether related or similar products are displayed on product pages. When set to true, similar products will be visible on the product pages.

related_products_count

integer

required

An integer value representing the number of related products that will be shown on a product page.

sold_products_count_status

boolean

required

A boolean flag indicating whether the number of sold products is displayed. If true, the count of sold items will be visible on the product page.

min_sold_products_count

integer

required

This integer represents the minimum number of sold products that need to be sold before displaying the count on the product page.

default_products_ordering

string

required

A string representing the default ordering of products on the page. Out-of-stock products are shown at the bottom when this option is enabled. If this setting is disabled, the value will return null.

Example

{
  "extended_search_support": true,
  "related_products_status": true,
  "related_products_count": 5,
  "sold_products_count_status": true,
  "min_sold_products_count": 100,
  "default_products_ordering": "-is_infinite,-quantity"
}

Modified at 2025-01-15 08:11:57

Delete a product.

Digital Vouchers