Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Query Parameters

search
string | null

Only items whose SKU starts with it or whose name holds it.

Maximum string length: 100
pattern
enum<string> | null

Only series of this demand pattern: smooth, erratic, intermittent or lumpy.

Available options:
smooth,
erratic,
intermittent,
lumpy
method
enum<string> | null

Only series forecast by this method. The statistical methods a forecast can use.

Available options:
naive,
seasonal_naive,
moving_average,
ses,
holt,
holt_damped,
holt_winters_additive,
holt_winters_multiplicative,
holt_winters_damped,
croston,
sba,
tsb
after
string | null

The cursor the previous page gave as next.

Maximum string length: 512

Response

ForecastListResource

data
ForecastListResource · object
required