Docs
Management API
Settings

Settings

Get Global Cart Settings

GET /carts/settings

Request

Returns the global cart settings of a store.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required

    The MIME type of the response body.

example

Response

OK

Body

object | application/json

The response object of cart settings at the global level.

  • data
    object

    Represents all settings related to the shopping cart functionality of a store.

  • meta
    object

    Response metadata.

example

Update Global Cart Settings

PUT /carts/settings

Request

Update the global cart settings of a store.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required

Body

application/json
  • allow_purchasing
    boolean

    • allow_purchasing
      boolean

      example

      Response

      OK

      Body

      object | application/json

      The response object of cart settings at the global level.

      • data
        object

        Represents all settings related to the shopping cart functionality of a store.

      • meta
        object

        Response metadata.

      example

      Get Channel Cart Settings

      GET /carts/settings/channels/{channel_id}

      Request

      Returns the per-channel overrides for the cart settings of a store.

      Authentication

      • X-Auth-Token in header
        required

      Parameters

      • store_hash in path - string
      • Accept in header with default of application/json - string
        required

        The MIME type of the response body.

      • channel_id in path - integer
        required

        The channel ID of the settings overrides.

      example

      Response

      OK

      Body

      object | application/json

      The response object of cart settings overrides for a channel.

      • data
        object

        Represents all settings overrides related to the shopping cart functionality of a store for a channel.

      • meta
        object

        Response metadata.

      example

      Update Channel Cart Settings

      PUT /carts/settings/channels/{channel_id}

      Request

      Update the per-channel overrides for the cart settings of a store.

      Authentication

      • X-Auth-Token in header
        required

      Parameters

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

        The channel ID of the settings overrides.

      • Content-Type in header with default of application/json - string
        required

      Body

      application/json
      • allow_purchasing
        boolean or null

        • allow_purchasing
          boolean or null

          example

          Response

          OK

          Body

          object | application/json

          The response object of cart settings overrides for a channel.

          • data
            object

            Represents all settings overrides related to the shopping cart functionality of a store for a channel.

          • meta
            object

            Response metadata.

          example

          Did you find what you were looking for?