| List | Supported entry types | Effect |
|---|---|---|
| Allowlist | email, order | Bypass return rules |
| Blocklist | email, order, product, product_tag | Block return-portal access |
List Allowlist
Tool name:list-allowlist-tool · Read-only · Permissions: manage-listings
List all entries on the allowlist. Optionally filter by entry type.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
type | string | – | Filter by email or order. |
page | integer | 1 | Page number. |
limit | integer | 25 | Page size, max 100. |
Example prompt
“Show me everything on the allowlist.”
Add to Allowlist
Tool name:add-to-allowlist-tool · Destructive · Permissions: manage-listings
Add an email address or order to the allowlist.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | yes | email or order. |
value | string | yes | The email address or order name. |
Example prompt
“Add vip@example.com to the allowlist.”
Remove from Allowlist
Tool name:remove-from-allowlist-tool · Destructive · Permissions: manage-listings
Remove an entry from the allowlist.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
value | string | yes | The allowlist value to remove (email or order name). |
type | string | yes (nullable) | email or order. Pass an empty string when the value is unique; required when multiple entries share the same value. |
Example prompt
“Take vip@example.com off the allowlist.”
List Blocklist
Tool name:list-blocklist-tool · Read-only · Permissions: manage-listings
List all entries on the blocklist. Optionally filter by entry type.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
type | string | – | Filter by email, order, product, or product_tag. |
page | integer | 1 | Page number. |
limit | integer | 25 | Page size, max 100. |
Example prompt
“Show me all blocked products.”
Add to Blocklist
Tool name:add-to-blocklist-tool · Destructive · Permissions: manage-listings
Add an entry to the blocklist. Once added, that order, customer, product, or product tag is blocked from the return portal.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | yes | email, order, product, or product_tag. |
value | string | yes | The value to blocklist (email, order name, SKU/product ID/variant ID, or product tag). |
secondary_value | string | yes (nullable) | Order name to scope a product blocklist entry to a specific order. Pass an empty string when not used. |
Example prompt
“Block fraudster@example.com from the return portal.”
Remove from Blocklist
Tool name:remove-from-blocklist-tool · Destructive · Permissions: manage-listings
Remove an entry from the blocklist.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
value | string | yes | The blocklist value to remove. |
type | string | yes (nullable) | email, order, product, or product_tag. Pass an empty string to match any type when the value is unique. |
secondary_value | string | yes (nullable) | Order name when removing a product entry scoped to a specific order. Pass an empty string when not needed. |
Example prompt
“Remove SKU SHIRT-RED-L from the blocklist.”