Skip to navigation
RESTAdminManagementSettingsInventory

Update Inventory Settings

Update inventory settings

Authentication

X-Auth-Tokenstring

OAuth scopes

UI NamePermissionParameter
Information & Settingsmodifystore_v2_information
Information & Settingsread-onlystore_v2_information_read_only

NOTE: Analytics endpoints require the Content (store_v2_content and store_v2_content_read_only) OAuth scope.

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Query parameters

channel_idintegerOptional

Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.

Request

null set for a particular field removes override on a channel level and means inheritance from a global level
product_out_of_stock_behaviorenumOptional
Describes storefront behavior when product is out of stock.
Allowed values:
option_out_of_stock_behaviorenumOptional
Describes storefront behavior when variant is out of stock.
Allowed values:
update_stock_behaviorenumOptional

Describes when stock levels are updated.

Global settings apply when inventory changes through a manual order. Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including product, SKU, and inventory webhooks.

Allowed values:
edit_order_stock_adjustmentbooleanOptional

Describes whether stock levels automatically adjust when you edit an order.

Global settings apply when inventory changes through a manual order. Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including product, SKU, and inventory webhooks.

refund_order_stock_adjustmentbooleanOptional

Describes whether stock levels automatically adjust when you refund or cancel an order.

Global settings apply when inventory changes through a manual order. Settings for a channel apply when inventory changes through an order in a channel. These settings affect webhooks that trigger from order-related events, including product, SKU, and inventory webhooks.

stock_level_displayenumOptional
Describes whether a storefront displays stock levels.
Allowed values:
default_out_of_stock_messagestringOptional
Out of stock message displayed to shoppers.
hide_in_product_filteringbooleanOptional

Describes whether an option is hidden in product filtering. Applies when option_out_of_stock_behavior is set to label_option.

show_pre_order_stock_levelsbooleanOptionalDefaults to false

Describes whether pre-order stock levels are shown.

show_out_of_stock_messagebooleanOptionalDefaults to false

Describes whether out-of-stock messages are shown on product listing pages.

show_quantity_on_backorderbooleanOptionalDefaults to false

Shows the quantity of an item that will be backordered, on the product detail page and in cart line items.

Backorder display settings are omitted from the response entirely when the store’s backorder feature is not enabled. See Backorders.

show_quantity_on_handbooleanOptionalDefaults to false
Shows the quantity of an item that is ready to ship, in cart line items.
show_backorder_messagebooleanOptionalDefaults to false

Shows the per-variant backorder message on the product detail page, cart, and product cards.

show_backorder_availability_promptbooleanOptionalDefaults to false
Shows the availability prompt next to the stock level on the product detail page.
backorder_availability_promptstringOptionalDefaults to More available for backorder

Text of the availability prompt shown on the product detail page. Only shown when show_backorder_availability_prompt is true.

show_default_shipping_expectation_promptbooleanOptionalDefaults to false
Shows the shipping expectation message in cart totals when any item in the cart is backordered.
default_shipping_expectation_promptstringOptionalDefaults to We ship available items right away, and backordered items as soon as they're in stock

Text of the shipping expectation message shown in cart totals. Only shown when show_default_shipping_expectation_prompt is true.

Response

OK, null indicates that a particular field has not been overridden on a channel level when channel level settings are requested
dataobjectOptional
metaobjectOptional
Response metadata.