GET

/v1/warranty

Bearer*

Body

id
string

This is the id of the warranty.

Response

id
string

This is the id of the warranty.

action_needed
boolean

Indicates whether any action is needed for the warranty.

advanced_replacement
boolean

Indicates if advanced replacement is available for the warranty.

amount
decimal

The monetary amount associated with the warranty.

condition
string

Describes the condition of the item or situation.

condition_date
datetime

Date and time when the condition was recorded or observed.

country
string

Country associated with the warranty entry.

created_date
datetime

Date and time when the warranty entry was created.

customerEmail
string

Email address of the customer associated with the warranty.

customer_id
integer

Unique identifier for the customer associated with the warranty.

description
string

Brief description or additional details about the warranty.

enteredBy
string

Name or identifier of the person who entered the warranty.

issue
string

Issue or problem associated with the warranty.

match
boolean

Indicates whether the warranty matches the specified conditions.

order_date
datetime

Date and time when the order associated with the warranty was placed.

order_id
integer

Unique identifier for the order associated with the warranty.

reason_category
string

Category or reason associated with the warranty.

replacement_color
string

Color of the replacement item for the warranty.

replacement_order_created
boolean

Indicates if a replacement order has been created for the warranty.

reported_condition
string

Condition as reported by the customer or user.

requested_date
datetime

Date and time when a specific request was made for the warranty.

rma
string

Return Merchandise Authorization (RMA) number for the warranty.

scanned_serial_number
string

Serial number obtained through scanning for the warranty.

serial_number
string

Unique serial number associated with the item in the warranty.

shipstation_order_id
string

ShipStation order ID associated with the warranty.

shipped_date
datetime

Date and time when the item was shipped or dispatched.

sso_id
string

Single Sign-On (SSO) ID associated with the warranty.

status
string

Current status or state of the warranty.

stripe_invoice_id
string

Stripe invoice ID associated with the warranty.

tax_refunded
decimal

The amount of tax refunded for the warranty.

total_refunded
decimal

The total amount refunded for the warranty.

tracking_number
string

Tracking number associated with the shipment for the warranty.

warehouse_received_date
datetime

Date and time when the item was received in the warehouse.

warranty_line_items
object

This is an array of warranty line items.

curl --location --request GET 'https://api.stateset.com/v1/return' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "0901f083-aa1c-43c5-af5c-0a9d2fc64e30"
}'

{
    "warranties": [
        {
            "id": "0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
            "created_date": "2023-06-28T19:34:59.189838+00:00",
            "amount": null,
            "action_needed": null,
            "condition": null,
            "customerEmail": "customer@gmail.com",
            "customer_id": null,
            "description": null,
            "enteredBy": null,
            "flat_rate_shipping": null,
            "order_date": null,
            "order_id": "524213310335630636",
            "reason_category": null,
            "reported_condition": null,
            "requested_date": null,
            "rma": "#1014-R5",
            "serial_number": null,
            "shipped_date": null,
            "status": "RCV",
            "tax_refunded": null,
            "total_refunded": null,
            "tracking_number": null,
            "warranty_line_items": []
        },
    ]
}   

Warranty

NameTypeDescription
idIntegerUnique identifier for the warranty entry
action_neededBooleanIndicates whether any action is needed for the warranty
advanced_replacementBooleanIndicates if advanced replacement is available for the warranty
amountDecimalThe monetary amount associated with the warranty
conditionStringDescribes the condition of the item or situation
condition_dateDate/TimeDate and time when the condition was recorded or observed
countryStringCountry associated with the warranty entry
created_dateDate/TimeDate and time when the warranty entry was created
customerEmailStringEmail address of the customer associated with the warranty
customer_idIntegerUnique identifier for the customer associated with the warranty
descriptionStringBrief description or additional details about the warranty
enteredByStringName or identifier of the person who entered the warranty
issueStringIssue or problem associated with the warranty
matchBooleanIndicates whether the warranty matches the specified conditions
order_dateDate/TimeDate and time when the order associated with the warranty was placed
order_idIntegerUnique identifier for the order associated with the warranty
reason_categoryStringCategory or reason associated with the warranty
replacement_colorStringColor of the replacement item for the warranty
replacement_order_createdBooleanIndicates if a replacement order has been created for the warranty
reported_conditionStringCondition as reported by the customer or user
requested_dateDate/TimeDate and time when a specific request was made for the warranty
rmaStringReturn Merchandise Authorization (RMA) number for the warranty
scanned_serial_numberStringSerial number obtained through scanning for the warranty
serial_numberStringUnique serial number associated with the item in the warranty
shipstation_order_idStringShipStation order ID associated with the warranty
shipped_dateDate/TimeDate and time when the item was shipped or dispatched
sso_idStringSingle Sign-On (SSO) ID associated with the warranty
statusStringCurrent status or state of the warranty
stripe_invoice_idStringStripe invoice ID associated with the warranty
tax_refundedDecimalThe amount of tax refunded for the warranty
total_refundedDecimalThe total amount refunded for the warranty
tracking_numberStringTracking number associated with the shipment for the warranty
warehouse_received_dateDate/TimeDate and time when the item was received in the warehouse

Warranty Line Item

NameTypeDescription
amountDecimalThe monetary amount associated with the warranty line item
conditionStringDescribes the condition of the replaced item
flat_rate_shippingBooleanIndicates whether the shipping rate is a flat rate
idIntegerUnique identifier for the warranty line item
nameStringName or description of the warranty line item
priceDecimalThe price of the warranty line item
warranty_idIntegerUnique identifier for the warranty associated with the line item
serial_numberStringUnique serial number associated with the warranty item
skuStringStock Keeping Unit (SKU) of the replaced item