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

Claim

A claim resource.

string

note

string

approval_note

string or null

A note included when the claim was approved.

warranty_page

object

The warranty page from which the claim was submitted.

string

Unique identifier of the warranty page, UUID v4 without hyphens (e.g. 006b053d93564aaab58f95c0a90e06eb).

name

string

Merchant-configured name of the warranty page.

items

array[ClaimItem]

A claim item resource.

string

source_id

string

title

string

product_title

string

variant_title

string

quantity

integer

unit_price

object

discounted_price

object

tax

object or null

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

discounted_price_including_tax

object or null

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

product_tags

array[string]

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

image

object

source_variant_id

string or null

sku

string

issue_description

object

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.

replacement_order

object or null

The replacement order created for this claim item.

product_source

string

shopper_notes

string or null

item_tags

array[ItemTag]

Merchant item tags applied to this claim item.

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

order

object

address

Address

customer

object

order_name

string

place_of_purchase

object

status

string

Allowed values:

under_reviewapprovedin_processcompletedrejectedcanceled

flow_type

string

Allowed values:

no_order_numberrequired_order_number

created_at

string<date-time>

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

Example:

2026-05-19T10:00:00Z

process_at

string<date-time> or null

The date and time, formatted in ISO 8601, when the claim entered processing.

Example:

2026-05-19T10:00:00Z

rma_number

string

updated_at

string<date-time>

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

Example:

2026-05-19T10:00:00Z

approved_at

string<date-time> or null

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

Example:

2026-05-19T10:00:00Z

canceled_at

string<date-time> or null

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

Example:

2026-05-19T10:00:00Z

rejected_at

string<date-time> or null

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

Example:

2026-05-19T10:00:00Z

completed_at

string<date-time> or null

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

Example:

2026-05-19T10:00:00Z

shipping_address

Address

contact_email

string

organization

object

string

cancel_reason

string or null

A free-form reason describing why the claim was canceled.

reject_reason

string or null

A free-form reason describing why the claim was rejected.

dynamic_fields

object

order_information

object

additional_information

object

inbound_shipments

array[ClaimShipment] or null

string

label

object

tracking_number

string or null

tracking_slug

string or null

tracking_status

string or null

tracking_status_updated_at

string<date-time> or null

The date and time, formatted in ISO 8601, when the shipment tracking status was last updated.

Example:

2026-05-19T10:03:00Z

item_selections

array[object]

ship_from

ship_to

created_at

string<date-time>

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

Example:

2026-05-19T10:00:00Z

updated_at

string<date-time>

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

Example:

2026-05-19T10:00:00Z

outbound_shipments

array[ClaimShipment] or null

string

label

object

tracking_number

string or null

tracking_slug

string or null

tracking_status

string or null

tracking_status_updated_at

string<date-time> or null

The date and time, formatted in ISO 8601, when the shipment tracking status was last updated.

Example:

2026-05-19T10:03:00Z

item_selections

array[object]

ship_from

ship_to

created_at

string<date-time>

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

Example:

2026-05-19T10:00:00Z

updated_at

string<date-time>

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

Example:

2026-05-19T10:00:00Z

receiving_status

string

Allowed values:

receivednot_received

Default:

not_received

received_at

string<date-time> or null

The date and time, formatted in ISO 8601, when the returned item was marked as received.

Example:

2026-05-19T10:00:00Z

Example

preparing...