{
  "opencollection": "1.0.0",
  "info": {
    "name": "Addresses Introduction Account Addresses Rules API",
    "version": "25.1126.6886238"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Rules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Gets all authorized catalog rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/catalogs/rules",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "This endpoint supports filtering. See [Filtering](#filtering).\n"
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used."
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query",
                "description": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results."
              }
            ]
          },
          "docs": "Retrieves all authorized catalog rules.\n\n### Filtering\n\nThis endpoint supports filtering. For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are supported.\n\n| Operator | Description | Supported Attributes | Example |\n|:--- |:--- |:--- |:--- |\n| `eq` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. | `id`,`catalog_id`,`account_ids`,`customer_ids`,`channels`,`tags`,`pricebook_ids` | `"
        },
        {
          "info": {
            "name": "Creates a new catalog rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/catalogs/rules",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "If you have multiple catalogs, create catalog rule resources. With catalog rules, you can display different catalogs to different shoppers. For example, you can display a preferred pricing catalog to a few special customers. Or you can display one catalog to shoppers using your website and a different catalog to shoppers using your mobile app. Finally, you can define custom criteria by creating tags.\n\n:::note\n\n- If you have one catalog for all customers and channels, you can omit creating this r"
        },
        {
          "info": {
            "name": "Get a catalog rule by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/catalogs/rules/:catalog_rule_id",
            "params": [
              {
                "name": "catalog_rule_id",
                "value": "",
                "type": "path",
                "description": "The catalog rule ID."
              }
            ]
          },
          "docs": "Get a catalog rule by ID"
        },
        {
          "info": {
            "name": "Updates a catalog rule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://useast.api.elasticpath.com/catalogs/rules/:catalog_rule_id",
            "params": [
              {
                "name": "catalog_rule_id",
                "value": "",
                "type": "path",
                "description": "The catalog rule ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the catalog rule is not updated."
        },
        {
          "info": {
            "name": "Deletes a catalog rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/catalogs/rules/:catalog_rule_id",
            "params": [
              {
                "name": "catalog_rule_id",
                "value": "",
                "type": "path",
                "description": "The catalog rule ID."
              }
            ]
          },
          "docs": "Deletes a catalog rule"
        },
        {
          "info": {
            "name": "Validate catalog rules for a given context",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/catalogs/rules/validate",
            "params": [
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used."
              },
              {
                "name": "page[offset]",
                "value": "",
                "type": "query",
                "description": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. You would normally increment the page offset by multiples of the page limit to paginate through the results."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Validates catalog rules for a given context and returns a list of matching catalog rules.\n"
        }
      ]
    }
  ],
  "bundled": true
}