Skip to main content

Retrieve Product Settings

Retrieves the current product settings of the project

HTTP Request​

GET/api/settings/products

Authorization​

Authorization

  • Required: Yes
  • Permission: Staff with ProductsSettingsPermission or Admin
  • Permission Code: 1021
  • Authentication: Token authentication

Example Requests​

1import requests
2
3# Retrieve product settings
4response = requests.get('http://www.example.com/api/settings/products', 
5  headers={'Authorization': 'Token <your_api_key>'}
6)
7print(response.json())

Response Fields​

FieldTypeDescription
products_display_out_of_stocks_last_at_shopBooleanWhether out-of-stock products should be displayed at the end of the product list in the shop.

Example Response​

{
"products_display_out_of_stocks_last_at_shop": true
}