Public REST/JSON reference

Dead Stock Liquidator API

Analyze inventory velocity, classify SKUs as HEALTHY, SLOW, OBSOLETE, or DEAD, and generate liquidation strategies, bundles, discount codes, and flash sales for Shopify merchants with high inventory carrying costs. 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

Spec

/api-specs/deadstock.json

Operations rendered

Response models rendered

GET/api/v1/deadstock/health

Service liveness

Liveness probe for Dead Stock Liquidator 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/deadstock/health" \
  -H "Accept: application/json"

Responses

200

Service healthy

GET/api/v1/deadstock/customers

List customers

List customers record for the customer workspace used by Dead Stock Liquidator 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/deadstock/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CustomerList

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

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

Update customer

Update customer record for the customer workspace used by Dead Stock Liquidator 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

Name	In	Type	Notes
`id`required	path	string	Id

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/deadstock/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

200Customer

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

POST/api/v1/deadstock/inventory/sync

Sync inventory

Import current SKU inventory, unit cost, retail price, and recent sales velocity.

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: InventorySyncRequest

Sample JSON payload for evaluation.

{
  "source": "shopify",
  "locationId": "loc_nyc"
}

Request example

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

curl -X POST "https://api.logicigniter.com/api/v1/deadstock/inventory/sync" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"source":"shopify","locationId":"loc_nyc"}'

Responses

200InventorySyncResult

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

GET/api/v1/deadstock/inventory/velocity

Get velocity report

Return velocity and days-on-hand metrics over the requested period.

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/deadstock/inventory/velocity" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200VelocityReport

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

POST/api/v1/deadstock/inventory/classify

Classify inventory

Classify submitted SKUs into health tiers with clearance recommendations.

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: ClassifyInventoryRequest

Sample JSON payload for evaluation.

{
  "skus": [
    "RUG-8X10-BLUE"
  ],
  "periodDays": 90
}

Request example

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

curl -X POST "https://api.logicigniter.com/api/v1/deadstock/inventory/classify" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"skus":["RUG-8X10-BLUE"],"periodDays":90}'

Responses

200InventoryClassificationResult

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

GET/api/v1/deadstock/inventory/sku/{sku}/health

Get SKU health

Read the latest health classification for a single SKU.

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

Name	In	Type	Notes
`sku`required	path	string	Sku

Request example

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

curl -X GET "https://api.logicigniter.com/api/v1/deadstock/inventory/sku/:sku/health" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200SkuHealth

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

POST/api/v1/deadstock/liquidation/strategies

Generate liquidation strategies

Create markdown, bundle, or channel-routing strategies for dead and obsolete inventory.

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: LiquidationStrategyRequest

Sample JSON payload for evaluation.

{
  "skus": [
    "RUG-8X10-BLUE"
  ],
  "targetClearDays": 30
}

Request example

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

curl -X POST "https://api.logicigniter.com/api/v1/deadstock/liquidation/strategies" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"skus":["RUG-8X10-BLUE"],"targetClearDays":30}'

Responses

200LiquidationStrategyList

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

POST/api/v1/deadstock/liquidation/strategies/{id}/execute

Execute liquidation strategy

Activate a generated clearance strategy and create associated discount artifacts.

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

Name	In	Type	Notes
`id`required	path	string	Id

Request body (required)

Schema: ExecuteStrategyRequest

Sample JSON payload for evaluation.

{
  "channel": "shopify",
  "approvedBy": "mira"
}

Request example

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

curl -X POST "https://api.logicigniter.com/api/v1/deadstock/liquidation/strategies/:id/execute" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"channel":"shopify","approvedBy":"mira"}'

Responses

200LiquidationExecution

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

404Error

Requested resource was not found

POST/api/v1/deadstock/liquidation/flash-sales

Create flash sale

Create a time-boxed sale for selected SKUs and target clearance depth.

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: FlashSaleRequest

Sample JSON payload for evaluation.

{
  "skus": [
    "RUG-8X10-BLUE"
  ],
  "discountPercent": 35,
  "startsAt": "2026-05-15T14:00:00Z",
  "endsAt": "2026-05-17T14:00:00Z"
}

Request example

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

curl -X POST "https://api.logicigniter.com/api/v1/deadstock/liquidation/flash-sales" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"skus":["RUG-8X10-BLUE"],"discountPercent":35,"startsAt":"2026-05-15T14:00:00Z","endsAt":"2026-05-17T14:00:00Z"}'

Responses

200FlashSale

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

GET/api/v1/deadstock/liquidation/performance

Get liquidation performance

Report recovered revenue, units cleared, and remaining dead-stock exposure.

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/deadstock/liquidation/performance" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200LiquidationPerformance

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

POST/api/v1/deadstock/bundles/suggest

Suggest bundles

Suggest bundles that pair slow-moving SKUs with healthier products.

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: BundleSuggestRequest

Sample JSON payload for evaluation.

{
  "anchorSku": "RUG-8X10-BLUE",
  "maxBundleSize": 3
}

Request example

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

curl -X POST "https://api.logicigniter.com/api/v1/deadstock/bundles/suggest" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"anchorSku":"RUG-8X10-BLUE","maxBundleSize":3}'

Responses

200BundleSuggestionList

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

POST/api/v1/deadstock/bundles

Create bundle

Create a bundle offer for a selected SKU mix and discount.

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: BundleCreateRequest

Sample JSON payload for evaluation.

{
  "skus": [
    "RUG-8X10-BLUE",
    "PAD-8X10"
  ],
  "discountPercent": 20
}

Request example

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

curl -X POST "https://api.logicigniter.com/api/v1/deadstock/bundles" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"skus":["RUG-8X10-BLUE","PAD-8X10"],"discountPercent":20}'

Responses

200Bundle

Successful response

400Error

Invalid request payload or parameters

401Error

Missing or invalid bearer token

403Error

Workspace does not have access to the ecommerce-operations bundle

Data models

Customer

Field	Type	Notes
`id`required	string	Example: "cus_mira_home"
`companyName`required	string	Example: "Mira Home Goods"
`email`required	string (email)	Example: "[email protected]"
`bundle`required	string	Example: "ecommerce-operations"
`createdAt`	string (date-time)

CustomerInput

Field	Type	Notes
`companyName`required	string	Example: "Mira Home Goods"
`email`required	string (email)	Example: "[email protected]"
`bundle`	string	Example: "ecommerce-operations"

CustomerList

Field	Type	Notes
`customers`	array<Customer>

Error

Field	Type	Notes
`error`required	string	Example: "validation failed"
`message`	string	Example: "sku is required"
`requestId`	string	Example: "req_01HX9E2M7K8Q4J3V"

Bundle

Field	Type	Notes
`id`required	string	Example: "bun_123"
`skus`required	array<string>	Example: ["RUG-8X10-BLUE","PAD-8X10"]
`status`	string	Example: "ACTIVE"

BundleCreateRequest

Field	Type	Notes
`skus`required	array<string>	Example: ["RUG-8X10-BLUE","PAD-8X10"]
`discountPercent`required	integer	Example: 20

BundleSuggestRequest

Field	Type	Notes
`anchorSku`required	string	Example: "RUG-8X10-BLUE"
`maxBundleSize`required	integer	Example: 3

BundleSuggestionList

Field	Type	Notes
`bundles`required	array<object>	Example: [{"skus":["RUG-8X10-BLUE","PAD-8X10"],"discountPercent":20,"expectedMargin":38.5}]

ClassifyInventoryRequest

Field	Type	Notes
`skus`required	array<string>	Example: ["RUG-8X10-BLUE"]
`periodDays`required	integer	Example: 90

ExecuteStrategyRequest

Field	Type	Notes
`channel`required	string	Example: "shopify"
`approvedBy`required	string	Example: "mira"

FlashSale

Field	Type	Notes
`id`required	string	Example: "sale_123"
`status`required	string	Example: "SCHEDULED"
`discountPercent`	integer	Example: 35

FlashSaleRequest

Field	Type	Notes
`skus`required	array<string>	Example: ["RUG-8X10-BLUE"]
`discountPercent`required	integer	Example: 35
`startsAt`	string	Example: "2026-05-15T14:00:00Z"
`endsAt`	string	Example: "2026-05-17T14:00:00Z"

InventoryClassificationResult

Field	Type	Notes
`classifications`required	array<object>	Example: [{"sku":"RUG-8X10-BLUE","tier":"DEAD","suggestedClearancePrice":79,"estimatedDaysToClear":21}]

InventorySyncRequest

Field	Type	Notes
`source`required	string	Example: "shopify"
`locationId`required	string	Example: "loc_nyc"

InventorySyncResult

Field	Type	Notes
`syncedSkus`required	integer	Example: 1280
`startedAt`required	string	Example: "2026-05-14T02:00:00Z"

LiquidationExecution

Field	Type	Notes
`strategyId`required	string	Example: "liq_123"
`status`required	string	Example: "ACTIVE"
`discountCode`	string	Example: "CLEAR35"

LiquidationPerformance

Field	Type	Notes
`recoveredRevenue`required	number (double)	Example: 12840.5
`unitsCleared`required	integer	Example: 92
`remainingDeadStockValue`	integer	Example: 4300

LiquidationStrategyList

Field	Type	Notes
`strategies`required	array<object>	Example: [{"id":"liq_123","type":"FLASH_SALE","discountPercent":35,"expectedRecovery":4200}]

LiquidationStrategyRequest

Field	Type	Notes
`skus`required	array<string>	Example: ["RUG-8X10-BLUE"]
`targetClearDays`required	integer	Example: 30

SkuHealth

Field	Type	Notes
`sku`required	string	Example: "RUG-8X10-BLUE"
`tier`required	string	Example: "DEAD"
`reason`	string	Example: "2 units sold in 90 days"

VelocityReport

Field	Type	Notes
`periodDays`required	integer	Example: 90
`items`required	array<object>	Example: [{"sku":"RUG-8X10-BLUE","unitsSold":2,"daysOnHand":410}]