Get Packaging Exclusions
GET/api/success-plan/settings/exclusions
Returns the packaging and consumables exclusion list: products SKU.io leaves out of measured figures such as stock-count adjustments, chosen by product category, tag or individual product.
success_plan:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Fields: category_ids, tags, product_ids, include_decoration_consumables (also exclude decoration consumables), the resolved categories and products, is_default (the list has not been customised), hash, excluded_product_count and decoration_consumable_count. packaging_exclusions_missing is null for API tokens.
Authentication: Requires Bearer token with the success_plan:read scope. The user must hold the success_plan.view permission.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.