BigCommerce · Example Payload

Bigcommerce Updatesettingsenabledsearchfilters Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Updatesettingsenabledsearchfilters Example is an example object payload from BigCommerce, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "updateSettingsEnabledSearchFilters",
  "method": "PUT",
  "path": "/settings/search/filters",
  "summary": "BigCommerce Update Enabled Filters",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "example-1",
      "example": [
        {
          "collapsed_by_default": false,
          "display_name": "Size",
          "display_product_count": true,
          "id": "U123=",
          "is_enabled": true,
          "items_to_show": 12,
          "sort_by": "alpha",
          "type": "product"
        },
        {
          "collapsed_by_default": false,
          "display_name": "Brand",
          "display_product_count": true,
          "id": "Y123=",
          "is_enabled": true,
          "items_to_show": 10,
          "sort_by": "alpha",
          "type": "brand"
        },
        {
          "collapsed_by_default": false,
          "display_name": "Color",
          "display_product_count": true,
          "id": "Q123=",
          "is_enabled": true,
          "items_to_show": 10,
          "sort_by": "alpha",
          "type": "product"
        },
        {
          "collapsed_by_default": true,
          "display_name": "Ships for Free",
          "display_product_count": true,
          "id": "Y456=",
          "is_enabled": true,
          "show_free_shipping_filter": true,
          "show_in_stock_filter": true,
          "show_is_featured_filter": true,
          "type": "other"
        }
      ]
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "example-1",
      "example": {
        "data": [
          {
            "collapsed_by_default": false,
            "display_name": "Size",
            "display_product_count": true,
            "id": "U123==",
            "is_enabled": true,
            "items_to_show": 12,
            "sort_by": "alpha",
            "type": "product"
          },
          {
            "collapsed_by_default": false,
            "display_name": "Brand",
            "display_product_count": true,
            "id": "Y123=",
            "is_enabled": true,
            "items_to_show": 10,
            "sort_by": "alpha",
            "type": "brand"
          },
          {
            "collapsed_by_default": false,
            "display_name": "Color",
            "display_product_count": true,
            "id": "Q123=",
            "is_enabled": true,
            "items_to_show": 10,
            "sort_by": "alpha",
            "type": "product"
          },
          {
            "collapsed_by_default": true,
            "display_name": "Ships for Free",
            "display_product_count": true,
            "id": "Y456=",
            "is_enabled": true,
            "show_free_shipping_filter": true,
            "show_in_stock_filter": true,
            "show_is_featured_filter": true,
            "type": "other"
          }
        ],
        "meta": {}
      }
    }
  ]
}