Public REST/JSON reference

Collection Profit Sorter API

Rank Shopify collection products by profit per page view using COGS, margin, sales velocity, and merchandising pins, then preview, apply, or schedule the resulting sort order. 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/collectionsort.json

Operations rendered

Response models rendered

GET/api/v1/collectionsort/health

Service liveness

Liveness probe for Collection Profit Sorter 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/collectionsort/health" \
  -H "Accept: application/json"

Responses

200

Service healthy

GET/api/v1/collectionsort/customers

List customers

List customers record for the customer workspace used by Collection Profit Sorter 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/collectionsort/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/collectionsort/customers/{id}

Update customer

Update customer record for the customer workspace used by Collection Profit Sorter 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/collectionsort/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/collectionsort/collections/sync

Sync collections

Import collections and product metadata from the connected storefront.

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

Sample JSON payload for evaluation.

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

Request example

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

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

Responses

200CollectionSyncResult

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/collectionsort/collections

List collections

List storefront collections known to the sorter.

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/collectionsort/collections" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CollectionList

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/collectionsort/collections/{collection_id}/products

Get collection products

Return products, views, velocity, and margin inputs for one collection.

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
`collection_id`required	path	string	Collection Id

Request example

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

curl -X GET "https://api.logicigniter.com/api/v1/collectionsort/collections/:collection_id/products" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200CollectionProducts

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/collectionsort/collections/{collection_id}/sort/calculate

Calculate sort

Calculate profit-per-view ranking for a collection without applying it.

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
`collection_id`required	path	string	Collection Id

Request body (required)

Schema: SortCalculateRequest

Sample JSON payload for evaluation.

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

Request example

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

curl -X POST "https://api.logicigniter.com/api/v1/collectionsort/collections/:collection_id/sort/calculate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"SortCalculateRequest"}'

Responses

200SortResult

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/collectionsort/collections/{collection_id}/sort/preview

Preview sort

Preview the proposed ordering with before and after position changes.

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
`collection_id`required	path	string	Collection Id

Request body (required)

Schema: SortPreviewRequest

Sample JSON payload for evaluation.

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

Request example

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

curl -X POST "https://api.logicigniter.com/api/v1/collectionsort/collections/:collection_id/sort/preview" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"SortPreviewRequest"}'

Responses

200SortPreview

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/collectionsort/collections/{collection_id}/sort/apply

Apply sort

Write the calculated ordering back to Shopify or the configured storefront.

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
`collection_id`required	path	string	Collection Id

Request body (required)

Schema: ApplySortRequest

Sample JSON payload for evaluation.

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

Request example

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

curl -X POST "https://api.logicigniter.com/api/v1/collectionsort/collections/:collection_id/sort/apply" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"ApplySortRequest"}'

Responses

200SortApplication

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/collectionsort/collections/{collection_id}/products/{product_id}/pin

Pin product

Pin a product to a fixed collection position while preserving profit sorting around it.

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
`collection_id`required	path	string	Collection Id
`product_id`required	path	string	Product Id

Request body (required)

Schema: PinProductRequest

Sample JSON payload for evaluation.

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

Request example

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

curl -X POST "https://api.logicigniter.com/api/v1/collectionsort/collections/:collection_id/products/:product_id/pin" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"PinProductRequest"}'

Responses

200PinnedProduct

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/collectionsort/collections/{collection_id}/sort/schedule

Schedule sort

Schedule automatic recalculation and application for a collection.

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
`collection_id`required	path	string	Collection Id

Request body (required)

Schema: ScheduleSortRequest

Sample JSON payload for evaluation.

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

Request example

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

curl -X POST "https://api.logicigniter.com/api/v1/collectionsort/collections/:collection_id/sort/schedule" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"id":"obj_123","status":"READY","summary":"ScheduleSortRequest"}'

Responses

200SortSchedule

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

GET/api/v1/collectionsort/collections/{collection_id}/performance

Get sort performance

Measure margin, revenue, click-through, and product movement after sorting.

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
`collection_id`required	path	string	Collection Id

Request example

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

curl -X GET "https://api.logicigniter.com/api/v1/collectionsort/collections/:collection_id/performance" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

200SortPerformance

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

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"

ApplySortRequest

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "ApplySortRequest"

CollectionList

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "CollectionList"

CollectionProducts

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "CollectionProducts"

CollectionSyncRequest

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "CollectionSyncRequest"

CollectionSyncResult

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "CollectionSyncResult"

PinProductRequest

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "PinProductRequest"

PinnedProduct

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "PinnedProduct"

ScheduleSortRequest

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "ScheduleSortRequest"

SortApplication

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "SortApplication"

SortCalculateRequest

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "SortCalculateRequest"

SortPerformance

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "SortPerformance"

SortPreview

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "SortPreview"

SortPreviewRequest

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "SortPreviewRequest"

SortResult

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "SortResult"

SortSchedule

Field	Type	Notes
`id`required	string	Example: "obj_123"
`status`required	string	Example: "READY"
`summary`	string	Example: "SortSchedule"