Settings
Use the Settings API to configure global settings for your project.
Page length
This defines the number of results per page when paginating results (max: 100
).
Name | Type | Default | Max |
---|---|---|---|
page_length | integer | 100 | 100 |
For more information on pagination including a list of which resources support pagination, see Pagination.
List child products
This defines whether you want to display child products in product listings.
Name | Type | Default |
---|---|---|
list_child_products | boolean | true |
Additional languages
You can define additional language codes that are enabled for a project (max: 5
).
Name | Type | Default | Max |
---|---|---|---|
additional_languages | array | [] | 5 |
Calculation method
This option defines the method used to calculate cart and order totals. Currently there are two methods: {simple}
and {line}
The {simple}
method is our previous method for calculating cart and order totals which focuses on the total value of the cart. This should only be used in the case where Commerce Cloud is not used for tax calculations. The {line}
method treats each line item individually resulting in more accurate figures after taxes and promotions are applied.
Name | Type | Value | Default |
---|---|---|---|
calculation_method | string | simple | Yes |
calculation_method | string | line | No |
Note: In Promotions, line item discounts, such as item_percent_discount
and item_amount_discount
, are only supported by the line
calculation method. For more information, see Promotions.
Readonly settings
Readonly settings are used for internal store configuration and attempts to update them fail silently.
Name | Type | Default |
---|---|---|
currency_limit | integer | 10 |