API endpoints for managing an allowlist for orders.
Create Allowlist Item
Create an allowlist item this will allow the customer to submit a return regardless of ineligibility.
Method/Url
POST https://api.fratereturns.com/api/v2/allowlist-items
Headers
X-Frate-Api-Token: <apiKey>
Payload
{ "value": "#1144", "description": "Test description" }
Response
{ "id": 6, "value": "#1144", "description": "Test description", "created_at": "2025-07-25T16:35:37.120831+00:00" }Delete Allowlist Item
Delete allowlist item.
Method/Url
DELETE https://api.fratereturns.com/api/v2/allowlist-items/<allowlist_item_id>
Headers
X-Frate-Api-Token: <apiKey>
Response
nullList Allowlist Item
List all allowlist items.
Method/Url
GET https://api.fratereturns.com/api/v2/allowlist-items
Headers
X-Frate-Api-Token: <apiKey>
Response
{ "items": [ { "id": 5, "value": "#11434", "description": "Test description", "created_at": "2025-07-25T16:38:15.949089+00:00" }, { "id": 4, "value": "#1144", "description": "Test description", "created_at": "2025-07-25T16:35:37.120831+00:00" } ], "page_info": { "has_prev_page": false, "has_next_page": false, "start_cursor": "NQ==", "end_cursor": "NA==", "start_index": 1, "end_index": 2, "total_count": 2 } }