GET /api/v3/settings
Get settings for a shop

Params

Param name Description
shop
required

Shopify domain of the store. Example: test-store.myshopify.com

Validations:

  • Must be a String

Returns

Code: 200

Description:

Settings information

Param name Description
pickup
required

Pickup configuration

Validations:

  • Must be a Hash
pickup[enabled]
required

Whether pickup is enabled. Values: true or false only

Validations:

  • Must be one of: true, false, 1, 0.
delivery
required

Delivery configuration

Validations:

  • Must be a Hash
delivery[enabled]
required

Whether delivery is enabled. Values: true or false only

Validations:

  • Must be one of: true, false, 1, 0.
shipping
required

Shipping configuration

Validations:

  • Must be a Hash
shipping[enabled]
required

Whether shipping is enabled. Values: true or false only

Validations:

  • Must be one of: true, false, 1, 0.
shipping[managed]
required

Whether shipping calendar is managed by app. Values: true or false only

Validations:

  • Must be one of: true, false, 1, 0.
shipping[slot_type]
required

Slot type for shipping calendar

Validations:

  • Must be a String
rates
required

Rates configuration

Validations:

  • Must be a Hash
rates[enabled]
required

Whether rates are enabled. Values: true or false only

Validations:

  • Must be one of: true, false, 1, 0.
rates[pickup_pricing_policy]
required

How merchant configured pickup rates

Validations:

  • Must be one of: GLOBAL, LOCATION_BASED.
rates[delivery_pricing_policy]
required

How merchant configured delivery rates

Validations:

  • Must be one of: GLOBAL, LOCATION_BASED, SHOPIFY.
rates[shipping_pricing_policy]
required

How merchant configured shipping rates

Validations:

  • Must be one of: GLOBAL, LOCATION_BASED, SHOPIFY.
shop
required

Shop configuration

Validations:

  • Must be a Hash
shop[timezone]
required

Shop timezone

Validations:

  • Must be a String
shop[locales]
required

List of locales with their date and time formats

Validations:

  • Must be an Array of nested elements
shop[locales][locale]
required

Locale code

Validations:

  • Must be a String
shop[locales][date_format]
required

Date format for this locale

Validations:

  • Must be a String
shop[locales][time_format]
required

Time format for this locale

Validations:

  • Must be a String

Code: 404

Description:

Shop not found

Param name Description