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 unit to repair.

customer
string
required

The customer: their id or code. With a return, the return's customer.

Maximum string length: 64
item
string
required

The item repaired: its 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 its parts come from.

Maximum string length: 64
reported_fault
string
required

What is wrong with it, as the customer reported it.

Maximum string length: 2000
serial
string | null

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

Maximum string length: 255
lot
string | null

The unit's lot, 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, which must name it.

note
string | null
Maximum string length: 2000

Response

RepairResource

data
RepairResource · object
required