Get Warranty
This endpoint gets or creates a new warranty.
Body
This is the id of the warranty.
Response
This is the id of the warranty.
Indicates whether any action is needed for the warranty.
Indicates if advanced replacement is available for the warranty.
The monetary amount associated with the warranty.
Describes the condition of the item or situation.
Date and time when the condition was recorded or observed.
Country associated with the warranty entry.
Date and time when the warranty entry was created.
Email address of the customer associated with the warranty.
Unique identifier for the customer associated with the warranty.
Brief description or additional details about the warranty.
Name or identifier of the person who entered the warranty.
Issue or problem associated with the warranty.
Indicates whether the warranty matches the specified conditions.
Date and time when the order associated with the warranty was placed.
Unique identifier for the order associated with the warranty.
Category or reason associated with the warranty.
Color of the replacement item for the warranty.
Model of the replacement item for the warranty.
Indicates if a replacement order has been created for the warranty.
Condition as reported by the customer or user.
Date and time when a specific request was made for the warranty.
Return Merchandise Authorization (RMA) number for the warranty.
Serial number obtained through scanning for the warranty.
Unique serial number associated with the item in the warranty.
ShipStation order ID associated with the warranty.
Date and time when the item was shipped or dispatched.
Single Sign-On (SSO) ID associated with the warranty.
Current status or state of the warranty.
Stripe invoice ID associated with the warranty.
The amount of tax refunded for the warranty.
The total amount refunded for the warranty.
Tracking number associated with the shipment for the warranty.
Date and time when the item was received in the warehouse.
This is an array of 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 |