Skip to main content
POST
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.

Body

application/json

A what-if copy of the latest forecast.

name
string
required

Such as "Lose Acme, grow 5%".

Maximum string length: 120
growth_percent
number | null

Every forecast grown by this share, as 5 for 5% more or -5 for 5% less.

Required range: -100 <= x <= 1000
lost_customer_id
string<uuid> | null

A customer whose share of each item's recent demand is taken away.

like_item_id
string<uuid> | null

An existing item a new one is forecast like.

new_item_name
string | null

The new item's name, with like_item_id.

Maximum string length: 120
like_factor
number | null

The new item's forecast as a share of the existing one's, as 0.5 for half; 1 by default.

Required range: x <= 100

Response

ScenarioRecordResource

data
ScenarioRecordResource · object
required