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

Path Parameters

item
string
required
location
string
required

Body

application/json

How to keep an item in stock at a location.

policy
enum<string>
required

reorder_point, min_max or periodic_review.

Available options:
reorder_point,
min_max,
periodic_review
service_level
number | null

In percent, from 50 to 99.9; empty for the organization's.

review_days
integer | null

Working days between reviews, for periodic_review, from 1 to 260; 10 when empty.

Required range: 1 <= x <= 260
minimum
number | null

For min_max, in the item's base unit: order when stock falls to it; empty for the reorder point.

Required range: x <= 1000000000
maximum
number | null

For min_max, in the item's base unit: order up to it; empty for the minimum plus an order's quantity.

Required range: x <= 1000000000
ordering_cost
number | null

What each order costs to place, in the organization's currency. With a holding cost, orders are the economic order quantity.

Required range: x <= 1000000000
holding_cost
number | null

What a unit costs to hold for a year, in the organization's currency.

Required range: x <= 1000000000

Response

PolicyResource

data
PolicyResource · object
required