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

An item's warranty, or a customer's for the item.

item
string
required

The item: its id or SKU.

Maximum string length: 64
months
integer
required

How many months it lasts, 1 to 600.

Required range: 1 <= x <= 600
starts_from
enum<string>
required

What it counts from: shipment, the day the unit last shipped, or build, the day it was built.

Available options:
shipment,
build
customer
string | null

The customer whose term overrides the item's own: their id or code. Left out for the item's own term.

Maximum string length: 64

Response

WarrantyTermPageResource

data
WarrantyTermPageResource · object
required