QUICKSTART

Changelog

Reference

API Overview

Warranty Registrations

Query warranty registrations by order

get

Update a warranty registration

patch

Invalidate a warranty registration

Claims

Mark claim as received

post

Check claim resolution availability

post

Process a claim

post

Claim Shipments

Create a claim shipment

Item Tags

Claim Items

Model

Primitive

Envelope

ClaimItem

A claim item resource.

string

source_id

string

title

string

product_title

string

variant_title

string

quantity

integer

unit_price

object

currency

string

amount

string

discounted_price

object

currency

string

amount

string

tax

object or null

Tax amount for the item. Only populated for order flow; null for non-order flows.

currency

string

amount

string

discounted_price_including_tax

object or null

Discounted price including tax (presentment). Only populated for order flow; null for non-order flows.

currency

string

amount

string

product_tags

array[string]

Platform product tags. Populated for order and store product flows; empty array for CSV or no-source flows.

image

object

url

string

source_variant_id

string or null

sku

string

issue_description

object

reason

string

subreason

string or null

description

string or null

files

array[object] or null

process_item_resolution_method

string

Allowed values:

repair_itemreplace_itemsend_repair_kitissue_store_creditother

process_item_details

string or null

store_credit

object or null

The store credit created for this claim item.

value

Money

The store credit value.

replacement_order

object or null

The replacement order created for this claim item.

order_name

string

The replacement order name from the e-commerce platform.

Example:

1536

items

array[object]

Replacement order items.

product_source

string

shopper_notes

string or null

item_tags

array[ItemTag]

Merchant item tags applied to this claim item.

string

The unique identifier for the item tag.

name

string

The name of the item tag.

created_at

string<date-time>

The date and time, formatted in ISO 8601, when the item tag was created.

Example:

2026-05-19T10:00:00Z

merchant_uploaded_image_urls

array[string]

Merchant-uploaded image URLs attached to this claim item.

created_at

string<date-time>

The date and time, formatted in ISO 8601, when the claim item was created.

Example:

2026-05-19T10:00:00Z

updated_at

string<date-time>

The date and time, formatted in ISO 8601, when the claim item was last updated.

Example:

2026-05-19T10:00:00Z

Example

preparing...