Fields
None. Needs Restrictions: Read, a permission of Data Feed stores.
Your restrictions, the rules on your Exclusions screen, oldest first. A product is hidden from your store when any switched-on exclude matches it, or when you have a switched-on only_show and none of them matches it. An exclude wins over an only-show, and order never matters, so restrictions have no reorder. How they combine, offer by offer: Rules and restrictions.
Each restriction
| Field | Meaning |
|---|---|
| id | The restriction's id, which GET, PATCH and DELETE /restrictions/{id} take. |
| name | Its name, as your Exclusions screen shows it. |
| restriction_type | exclude hides the products it matches. only_show: once your store has a switched-on one, every product that no switched-on only-show matches is hidden. |
| distributors | Distributor slugs, as a product's sourced_from names them: it applies to those distributors' offers only. Empty: any. |
| categories | Category slugs from GET /categories. A category takes in the ones below it. Empty: any. |
| manufacturers | Brand slugs from GET /manufacturers. Empty: any. |
| product_classes | Product class slugs from GET /product-classes. Empty: any. |
| upcs | UPCs. Empty: any. |
| skus | SKUs: a distributor's, matched against its offer, or your own in-house one. Empty: any. |
| min_stock | On an exclude, it matches an offer with fewer than this in stock; on an only-show, one with at least this many, so both hide low stock. Null: any. |
| from_price | The lowest distributor cost it matches, two decimals, or null for no lower bound. |
| to_price | The highest distributor cost it matches, or null for no upper bound. |
| disabled | true: the restriction is kept, and hides nothing. |
A restriction matches an offer when every condition it has matches, and a condition matches when any one of its values does. Money is a string with two decimals. A category, brand or product class deleted since the restriction was saved reads "(deleted)", as on a pricing rule, and sending it back is refused.
Returns
- 200Every restriction, in
data, oldest first.
This endpoint can also answer 401 invalid_api_key, 403 license_not_active, 403 product_not_included, 403 insufficient_scope and 429 rate_limited.