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
lot_strategy
enum<string>
required

fefo, fifo, lifo or manual, for lot-tracked items without their own.

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

block, warn or allow.

Available options:
block,
warn,
allow
warn_expiring
boolean
required
expiring_within_days
integer
required

How many days ahead a lot counts as expiring soon.

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

Days (up to 3650), or a percent (up to 100) of a lot's life; none when null.

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

days or percent.

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

available is always allocatable; quarantined may be added; rejected never is.

Available options:
available,
quarantined

Response

AllocationRulesResource

data
AllocationRulesResource · object
required