API Reference

List warranty programs

get
https://api.protectplus.io/warranties

List the warranty programs configured for the authenticated store.
Results are paginated; check pagination.has_next_page to know if
there's more. Warranty data is served by the Returns & Exchange
service; this gateway projects a stable, snake_case summary of each
program.

Filter with is_active (true/false), order_number, or a free-text
search. Sort with sort + order (asc/desc).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 1
integer
1 to 250
Defaults to 50
string
enum

Sort field. Combine with order (asc/desc).

Allowed:
string
enum
Allowed:
boolean

Filter to active (true) or inactive (false) warranty programs.

string

Filter to the warranty program(s) applicable to a given order number.

string
length ≤ 256
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 3 months ago

Did this page help you?