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 customer's unit to open a repair for.

customer
string
required

The customer who owns the unit, by ID or code. With a return, it must be the return's customer.

Maximum string length: 64
item
string
required

The item being repaired, by ID or SKU. It must be tracked by serial number or lot.

Maximum string length: 64
location
string
required

The ID of the active stock location that parts used on the repair are issued from.

Maximum string length: 64
reported_fault
string
required

What is wrong with the unit, as the customer reported it. Up to 2,000 characters.

Maximum string length: 2000
serial
string | null

The unit's serial number. Required for a serialized item.

Maximum string length: 255
lot
string | null

The unit's lot. Required for an item tracked by lot.

Maximum string length: 255
return_id
string<uuid> | null

The ID of the received return the unit came back on. The return must include this unit.

note
string | null

A free-text note on the repair, 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.