Get Inventory Settings

GET

https://api.bigcommerce.com/stores/:store_hash/v3/settings/inventory

GET

/stores/:store_hash/v3/settings/inventory

curl https://api.bigcommerce.com/stores/store_hash/v3/settings/inventory \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "data": {
    "product_out_of_stock_behavior": "do_nothing",
    "option_out_of_stock_behavior": "do_nothing",
    "update_stock_behavior": "order_placed",
    "edit_order_stock_adjustment": true,
    "refund_order_stock_adjustment": true,
    "stock_level_display": "dont_show",
    "default_out_of_stock_message": "Currently out of stock",
    "hide_in_product_filtering": true,
    "show_pre_order_stock_levels": true,
    "show_out_of_stock_message": true,
    "show_quantity_on_backorder": false,
    "show_quantity_on_hand": false,
    "show_backorder_message": false,
    "show_backorder_availability_prompt": false,
    "backorder_availability_prompt": "More available for backorder",
    "show_default_shipping_expectation_prompt": false,
    "default_shipping_expectation_prompt": "We ship available items right away, and backordered items as soon as they're in stock"
  },
  "meta": {}
}

Get Inventory Settings

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Information & Settings	modify	`store_v2_information`
Information & Settings	read-only	`store_v2_information_read_only`

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

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

channel_idintegerOptional

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

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.

Errors

422

Unprocessable Entity Error

Get Inventory Settings

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Query parameters

Response

Errors