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.

Path Parameters

repair
string
required

The ID of the repair.

Body

application/json

A part put into a repair's unit from stock, or taken out of it.

kind
enum<string>
required

Whether the part was used, issued from stock at the repair's location, or removed from the unit.

Available options:
used,
removed
item
string
required

The part, by ID or SKU.

Maximum string length: 64
quantity
string
required

How many, in the part's base unit, as an exact decimal string above zero.

Pattern: ^(?!0+(\.0+)?$)\d{1,20}(\.\d{1,20})?$
lot
string | null

The part's lot. For a part used, the allocation rules choose one when it's left out.

Maximum string length: 255
serials
string[]

The part's serial numbers, one per unit. Up to 1,000, with no repeats ignoring case.

Maximum array length: 1000
Maximum string length: 255
disposition
enum<string> | null

What became of a removed part: scrap or return_to_supplier. Required when kind is removed.

Available options:
scrap,
return_to_supplier
note
string | null

A free-text note on the part, up to 2,000 characters.

Maximum string length: 2000

Response

RepairResource

data
RepairResource · object
required

A repair with its unit's warranty, parts and cost.