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 planner's change to the forecast.

level
enum<string>
required

location (an item at a location), item, family or organization.

Available options:
location,
item,
family,
organization
first_week
string<date>
required

The first week it changes, as a day of it (YYYY-MM-DD); not one gone by.

last_week
string<date>
required

The last week it changes, as a day of it; the adjustment carries into each run until it passes.

kind
enum<string>
required

quantity (added each week, less than 0 to take away), percent, or formula.

Available options:
quantity,
percent,
formula
reason
string
required

Why, such as "Trade show in March". Kept in the audit trail.

Maximum string length: 500
item_id
string<uuid> | null

The item, for the location and item levels.

location_id
string<uuid> | null

The location, for the location level.

family_id
string<uuid> | null

The item family, for the family level. Its change is spread to its items by their share of its forecast.

amount
number | null

The quantity a week, or the percentage, as 20 for 20% more or -15 for 15% less.

Required range: -1000000000 <= x <= 1000000000
formula
string | null

For formula: the week's new forecast from [Forecast] and [Week], such as IF(MONTH([Week]) = 3, [Forecast] * 1.2, [Forecast]).

Maximum string length: 2000

Response

AdjustmentResource

data
AdjustmentResource · object
required