Skip to main content

Public REST/JSON reference

Return Fraud Pattern Detector API

Score return requests and customer histories for serial returns, wardrobing, bracketing, and claim-without-ship patterns, then route risky returns to verification, manual review, or enforcement. Part of the Logic Igniter E-commerce Operations bundle.

Access boundary

These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.

Base URL

https://api.logicigniter.com

Auth

Authorization: Bearer YOUR_API_KEY

Version

OpenAPI 3.0.3 · 1.0.0

Operations rendered

12

Response models rendered

18

GET/api/v1/returnfraud/health

Service liveness

Liveness probe for Return Fraud Pattern Detector API. Returns 200 when the public API route is reachable.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/returnfraud/health" \
  -H "Accept: application/json"

Responses

200

Service healthy

GET/api/v1/returnfraud/customers

List customers

List customers record for the customer workspace used by Return Fraud Pattern Detector API.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/returnfraud/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

Requested resource was not found

PUT/api/v1/returnfraud/customers/{id}

Update customer

Update customer record for the customer workspace used by Return Fraud Pattern Detector API.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstringId

Request body (required)

Schema: CustomerInput

Sample JSON payload for evaluation.

{
  "companyName": "Mira Home Goods",
  "email": "[email protected]"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/returnfraud/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"companyName":"Mira Home Goods","email":"[email protected]"}'

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

Requested resource was not found

GET/api/v1/returnfraud/customers/{customer_id}/risk-profile

Get customer risk profile

Read return-risk score, contributing signals, and active flags for a customer.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
customer_idrequiredpathstringCustomer Id

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/returnfraud/customers/:customer_id/risk-profile" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

Requested resource was not found

POST/api/v1/returnfraud/customers/{customer_id}/score

Score customer

Score a customer or return request against fraud patterns.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
customer_idrequiredpathstringCustomer Id

Request body (required)

Schema: FraudScoreRequest

Sample JSON payload for evaluation.

{
  "id": "obj_123",
  "status": "READY",
  "summary": "FraudScoreRequest"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/returnfraud/customers/:customer_id/score" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"FraudScoreRequest"}'

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

Requested resource was not found

GET/api/v1/returnfraud/customers/{customer_id}/patterns

Detect patterns

Return detected return-fraud patterns for a customer.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
customer_idrequiredpathstringCustomer Id

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/returnfraud/customers/:customer_id/patterns" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

Requested resource was not found

POST/api/v1/returnfraud/customers/{customer_id}/override

Override score

Apply a manual override with a reason and expiration.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
customer_idrequiredpathstringCustomer Id

Request body (required)

Schema: ScoreOverrideRequest

Sample JSON payload for evaluation.

{
  "id": "obj_123",
  "status": "READY",
  "summary": "ScoreOverrideRequest"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/returnfraud/customers/:customer_id/override" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"ScoreOverrideRequest"}'

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

Requested resource was not found

GET/api/v1/returnfraud/customers/flagged

List flagged customers

List customers currently above return-risk thresholds.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/returnfraud/customers/flagged" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

POST/api/v1/returnfraud/returns/sync

Sync returns

Import return requests, dispositions, refunds, and shipment events.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: ReturnSyncRequest

Sample JSON payload for evaluation.

{
  "id": "obj_123",
  "status": "READY",
  "summary": "ReturnSyncRequest"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/returnfraud/returns/sync" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"ReturnSyncRequest"}'

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

GET/api/v1/returnfraud/returns/stats

Get return stats

Return fraud rate, repeat-return rate, and return cost metrics.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/returnfraud/returns/stats" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

GET/api/v1/returnfraud/enforcement

List enforcement actions

List active and historical enforcement actions.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/returnfraud/enforcement" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

POST/api/v1/returnfraud/enforcement/{action_id}/revoke

Revoke enforcement

Revoke an enforcement action and record the reason.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
action_idrequiredpathstringAction Id

Request body (required)

Schema: RevokeEnforcementRequest

Sample JSON payload for evaluation.

{
  "id": "obj_123",
  "status": "READY",
  "summary": "RevokeEnforcementRequest"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/returnfraud/enforcement/:action_id/revoke" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"RevokeEnforcementRequest"}'

Responses

Successful response

Invalid request payload or parameters

Missing or invalid bearer token

Workspace does not have access to the ecommerce-operations bundle

Requested resource was not found

Data models

Customer

FieldTypeNotes
idrequiredstringExample: "cus_mira_home"
companyNamerequiredstringExample: "Mira Home Goods"
emailrequiredstring (email)Example: "[email protected]"
bundlerequiredstringExample: "ecommerce-operations"
createdAtstring (date-time)

CustomerInput

FieldTypeNotes
companyNamerequiredstringExample: "Mira Home Goods"
emailrequiredstring (email)Example: "[email protected]"
bundlestringExample: "ecommerce-operations"

CustomerList

FieldTypeNotes
customersarray<Customer>

Error

FieldTypeNotes
errorrequiredstringExample: "validation failed"
messagestringExample: "sku is required"
requestIdstringExample: "req_01HX9E2M7K8Q4J3V"

EnforcementAction

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "EnforcementAction"

EnforcementActionList

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "EnforcementActionList"

EnforcementRequest

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "EnforcementRequest"

FlaggedCustomerList

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "FlaggedCustomerList"

FraudPatternList

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "FraudPatternList"

FraudScore

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "FraudScore"

FraudScoreRequest

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "FraudScoreRequest"

ReturnStats

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "ReturnStats"

ReturnSyncRequest

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "ReturnSyncRequest"

ReturnSyncResult

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "ReturnSyncResult"

RevokeEnforcementRequest

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "RevokeEnforcementRequest"

RiskProfile

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "RiskProfile"

ScoreOverride

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "ScoreOverride"

ScoreOverrideRequest

FieldTypeNotes
idrequiredstringExample: "obj_123"
statusrequiredstringExample: "READY"
summarystringExample: "ScoreOverrideRequest"