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.

Body

application/json

The organization's allocation rules: which lots stock is held and issued from, and how expired and short-dated lots are treated.

lot_strategy
enum<string>
required

The order lots are picked in, for lot-tracked items without a strategy of their own: fefo, fifo, lifo or manual.

Available options:
fefo,
fifo,
lifo,
manual
expired_lots
enum<string>
required

What happens to expired lots: block, warn or allow.

Available options:
block,
warn,
allow
warn_expiring
boolean
required

Whether a lot held for a reservation is flagged when it expires within expiring_within_days.

expiring_within_days
integer
required

How many days ahead a lot counts as expiring soon, from 0 to 3650.

Required range: 0 <= x <= 3650
shelf_life_minimum
integer | null

The shortest shelf life a lot must have left to be allocated, in shelf_life_unit: up to 3650 days, or up to 100 percent of the lot's life. Null for no minimum.

Required range: 0 <= x <= 3650
shelf_life_unit
enum<string> | null

The unit of shelf_life_minimum: days or percent. It's days when left out.

Available options:
days,
percent
allocatable_statuses
enum<string>[] | null

The statuses stock can be allocated from besides available, which is always included. Only quarantined can be added; rejected stock is never allocated.

A status to allocate from: available or quarantined.

Available options:
available,
quarantined

Response

AllocationRulesResource

data
AllocationRulesResource · object
required

The organization's allocation rules: which lot is held and issued first, what happens to expired lots and the minimum shelf life left.