Get Warranty

This endpoint gets or creates a new warranty.

GET /v1/warranty

cURL

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"
}'

Response

{
    "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": "[e-mail]",
            "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": []
        },
    ]
}   

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.

model · string

Model 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.

Show Show child attributes

amount · decimal

The monetary amount associated with the warranty line item.

condition · string

Describes the condition of the replaced item.

flat_rate_shipping · boolean

Indicates whether the shipping rate is a flat rate.

id · integer

Unique identifier for the warranty line item.

name · string

Name or description of the warranty line item.

price · decimal

The price of the warranty line item.

warranty_id · integer

Unique identifier for the warranty associated with the line item.

serial_number · string

Unique serial number associated with the warranty item.

sales_order_sku · string

Stock Keeping Unit (SKU) of the replaced item.

cURL

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"
}'

Response

{
    "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": "[e-mail]",
            "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

Name	Type	Description
id	Integer	Unique identifier for the warranty entry
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	Date/Time	Date and time when the condition was recorded or observed
country	String	Country associated with the warranty entry
created_date	Date/Time	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	Date/Time	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	Date/Time	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	Date/Time	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	Date/Time	Date and time when the item was received in the warehouse

Warranty Line Item

Name	Type	Description
amount	Decimal	The monetary amount associated with the warranty line item
condition	String	Describes the condition of the replaced item
flat_rate_shipping	Boolean	Indicates whether the shipping rate is a flat rate
id	Integer	Unique identifier for the warranty line item
name	String	Name or description of the warranty line item
price	Decimal	The price of the warranty line item
warranty_id	Integer	Unique identifier for the warranty associated with the line item
serial_number	String	Unique serial number associated with the warranty item
sku	String	Stock Keeping Unit (SKU) of the replaced item