Units of Measurement
Get Units of Measurement Settings
GET https://api.bigcommerce.com/stores/{store_hash}/v3/settings/store/units-of-measurementRequest
Get settings for units of measurements.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- channel_id in query - integerChannel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.
example
Response
OK. When you request channel-level settings,
null indicates that a channel does not have overrides.Body
object | application/json
dataobject
example
Update Units of Measurement Settings
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/settings/store/units-of-measurementRequest
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.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- channel_id in query - integerChannel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.
Body
object | application/json
weight_measurementstring
Allowed: LBS | Ounces | KGS | Grams | Tonnes
Example: Ounceslength_measurementstring
Allowed: Inches | Centimeters
Example: Inchesdecimal_tokenstring
Example: .thousands_tokenstring
Example: ,decimal_placesinteger
Example: 2factoring_dimensionstring
Allowed: depth | height | width
Example: depth
example
Response
OK. When you request channel-level settings,
null indicates that a channel does not have overrides.Body
object | application/json
dataobject
example
Did you find what you were looking for?