BigCommerce
Management API
Units of Measurement

Settings V3

Get Units of Measurement Settings

GET /settings/store/units-of-measurement

Request

Get settings for units of measurements.

Authentication

  • X-Auth-Token in header - required

Parameters

  • store_hash in path - string
  • channel_id in query - integer

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

example

Response

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

Body

object | application/json
  • data
    object

  • meta
    object

example

Update Units of Measurement Settings

PUT /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 header - required

Parameters

  • store_hash in path - string
  • channel_id in query - integer

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

Body

object | application/json
  • weight_measurement
    string

    Allowed: LBS | Ounces | KGS | Grams | Tonnes

    Example: Ounces

  • length_measurement
    string

    Allowed: Inches | Centimeters

    Example: Inches

  • decimal_token
    string

    Example: .

  • thousands_token
    string

    Example: ,

  • decimal_places
    integer

    Example: 2

  • factoring_dimension
    string

    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
  • data
    object

  • meta
    object

example

Did you find what you were looking for?