Update Units of Measurement Settings | BigCommerce Developer Center

Update settings for units of measurements.

The endpoint does not support partial updates. Provide all fields to update global or channel-level settings.

Create channel-level settings, or overrides for a channel, using the channel_id query parameter.

To delete overrides for a channel, supply null as a value for all fields. A channel then inherits global values.

The endpoint does not support ‘null’ as a value for global-level settings.

Update settings for [units of measurements](https://support.bigcommerce.com/s/article/Store-Settings?language=en_US#physical). The endpoint does not support partial updates. Provide all fields to update global or channel-level settings. Create channel-level settings, or overrides for a channel, using the `channel_id` query parameter. To delete overrides for a channel, supply `null` as a value for all fields. A channel then inherits global values. The endpoint does not support 'null' as a value for global-level 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.

### 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](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Query parameters

channel_idintegerOptional

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

Request

This endpoint expects an object.

weight_measurementenumOptional

Allowed values:

length_measurementenumOptional

Allowed values:

decimal_tokenstringOptional

thousands_tokenstringOptional

decimal_placesintegerOptional

factoring_dimensionenumOptional

Allowed values:

Response

OK. When you request channel-level settings, null indicates that a channel does not have overrides.

dataobject

metaobject

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.

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v3/settings/store/units-of-measurement"
4
5	payload = {}
6	headers = {
7	"X-Auth-Token": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.put(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"data": {
3	"weight_measurement": "Ounces",
4	"length_measurement": "Inches",
5	"decimal_token": ".",
6	"thousands_token": ",",
7	"decimal_places": 2,
8	"factoring_dimension": "depth"
9	},
10	"meta": {}
11	}