Recommendations

scope: recommendationsbeta

AI-powered suggestions to optimize your warehouse operations. Get actionable recommendations for restocking, cost savings, and operational improvements based on your inventory and shipment data.

Endpoints

GET

/v0/recommendations

Get recommendations — AI-powered suggestions for your operations

Recommendation Types

When available, recommendations will be categorized by type to help you prioritize actions.

Type	Description
`restock`	Products or cartons running low based on historical shipment velocity.
`optimization`	Operational improvements like consolidating carton types or optimizing warehouse allocation.
`cost_saving`	Opportunities to reduce costs based on shipping patterns and pricing analysis.
`general`	General best practice suggestions and platform tips.

Get Recommendations

Query Parameters

Parameter	Type	Description
`type`	string	Filter by type: restock, optimization, cost_saving, general
`priority`	string	Filter by priority: low, medium, high
`skip`	number	Number of records to skip (default: 0)
`take`	number	Number of records to return (default: 10, max: 10)

GET /v0/recommendations

[]

Currently returns an empty array. Recommendations will be populated as the engine is built out.

Response Fields (Preview)

When recommendations become available, each item in the response will follow this structure:

Parameter	Type	Description
`id`*	string	Unique recommendation ID
`type`*	enum	Category: restock, optimization, cost_saving, general
`priority`*	enum	Priority: low, medium, high
`title`*	string	Short summary of the recommendation
`message`*	string	Detailed explanation and suggested action
`resourceType`	string	Related resource type (product, carton, shipment)
`resourceId`	string	Related resource ID for deep-linking
`createdAt`*	ISO 8601	When this recommendation was generated

Future example response

[
  {
    "id": "rec-1",
    "type": "restock",
    "priority": "high",
    "title": "Restock Egg Shells — projected stockout in 5 days",
    "message": "Based on your average shipment velocity of 40 units/day, your current stock of 200 units of Egg Shells (ABC123) will run out around March 10. Consider placing an inbound shipment soon.",
    "resourceType": "product",
    "resourceId": "1",
    "createdAt": "2026-03-05T08:00:00.000Z"
  },
  {
    "id": "rec-2",
    "type": "cost_saving",
    "priority": "medium",
    "title": "Consolidate 10-Pack and 12-Pack cases",
    "message": "You have two similar carton types for Egg Shells with low individual volume. Consolidating into a single carton type could reduce storage fees by ~15%.",
    "resourceType": "carton",
    "resourceId": "3",
    "createdAt": "2026-03-05T08:00:00.000Z"
  }
]

Coming soon

The recommendations engine is under active development. The endpoint is live and ready for integration — it will begin returning data as the engine is enabled for your organization. The response shape shown above is final and will not change.

Notifications

Organizations