Settings V3
Get Units of Measurement Settings
GET /stores/{store_hash}/v3/settings/store/units-of-measurement
Request
Get settings for units of measurements.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- channel_id in query - integer
Channel 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
dataobject
metaobject
example
Update Units of Measurement Settings
PUT /stores/{store_hash}/v3/settings/store/units-of-measurement
Request
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 headerrequired
Parameters
- store_hash in path - string
- channel_id in query - integer
Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.
Body
weight_measurementstring
Allowed: LBS | Ounces | KGS | Grams | Tonnes
Example: Ounces
length_measurementstring
Allowed: Inches | Centimeters
Example: Inches
decimal_tokenstring
Example: .
thousands_tokenstring
Example: ,
decimal_placesinteger
Example: 2
factoring_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
dataobject
metaobject