Insights
Get customer order trends
Compares each customer's order value/count in the last windowDays (default 90) against the prior windowDays. Sorted by percent change ascending — biggest decline first.
path Parameters
companyIdThe company to query. Example: 11111111-2222-3333-4444-555555555555
query Parameters
windowDaysRolling window size in days, compared against the same-length prior window. Default 90.
Headers
GoSmarter-Api-KeyThe GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Get customer order trends › Responses
Customer trend rows, worst decline first
relatedOrganisationIdcustomerNamecurrentPeriodValuecurrentPeriodOrderCountpriorPeriodValuepriorPeriodOrderCountpercentChangeGet insights summary for a single customer organisation
Bundles product mix and order trend for one customer — backs the per-organisation drill-down view.
path Parameters
companyIdThe company to query. Example: 11111111-2222-3333-4444-555555555555
organisationIdThe customer organisation to summarize
query Parameters
windowDaysRolling window size in days for the trend comparison. Default 90.
Headers
GoSmarter-Api-KeyThe GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Get insights summary for a single customer organisation › Responses
Organisation insights summary
Get product mix by customer
Returns aggregated order quantity/value grouped by customer, material, type and grade. Filter to a single customer with organisationId.
path Parameters
companyIdThe company to query. Example: 11111111-2222-3333-4444-555555555555
query Parameters
organisationIdOptional: filter to a single customer organisation
Headers
GoSmarter-Api-KeyThe GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Get product mix by customer › Responses
Product mix rows, highest value first
relatedOrganisationIdcustomerNamematerialIdmaterialNametypeIdtypeNamemetalGradeIdgradeNametotalQuantitytotalValueorderCountGet slow-moving stock
Returns inventory items with no linked order activity in the given threshold window (default 90 days), oldest/most-stale first.
path Parameters
companyIdThe company to query. Example: 11111111-2222-3333-4444-555555555555
query Parameters
thresholdDaysMinimum days since last movement to be considered slow-moving. Default 90.
Headers
GoSmarter-Api-KeyThe GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Get slow-moving stock › Responses
Slow-moving stock rows
inventoryIdcompanyIdproductNameproductReferencequantityweightunitPriceheatCodesupplierIdsupplierNamereceivedAtdaysSinceReceivedlastOrderDatedaysSinceLastMovement