A valid request URL is required to generate request examples[
{
"id": 123,
"created_at": "<string>",
"status": "IN_REVIEW",
"platform_refund_transaction_ids": [
"<string>"
],
"platform_line_item_id": "<string>",
"product_platform_id": "<string>",
"product_name": "<string>",
"variant_platform_id": "<string>",
"variant_name": "<string>",
"quantity": 123,
"return_reason": "<string>",
"return_reason_details": {
"value": "<string>",
"label": "<string>",
"path": [
"<string>"
],
"path_labels": [
"<string>"
],
"note": "<string>",
"type": "return_reason"
},
"questions_answers": [
{
"question_text": "<string>",
"question_description": "<string>",
"question_type": "TEXT",
"answers": [
"<string>"
],
"type": "question_answer"
}
],
"subtotal": {
"shop_money": {
"amount": 0,
"currency_code": "USD"
},
"presentment_money": {
"amount": 0,
"currency_code": "USD"
}
},
"discounted_subtotal": {
"shop_money": {
"amount": 0,
"currency_code": "USD"
},
"presentment_money": {
"amount": 0,
"currency_code": "USD"
}
},
"discount_total": {
"shop_money": {
"amount": 0,
"currency_code": "USD"
},
"presentment_money": {
"amount": 0,
"currency_code": "USD"
}
},
"tax_total": {
"shop_money": {
"amount": 0,
"currency_code": "USD"
},
"presentment_money": {
"amount": 0,
"currency_code": "USD"
}
},
"tax_percentage": 123,
"total": {
"shop_money": {
"amount": 0,
"currency_code": "USD"
},
"presentment_money": {
"amount": 0,
"currency_code": "USD"
}
},
"type": "return_line_item",
"platform_id": "<string>",
"shipment_id": 123,
"sku": "<string>",
"barcode": "<string>",
"return_note": "<string>",
"last_rma_number": "<string>",
"last_rma_provider": "SHIPWIRE"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Submit Return Group Review (by SKU)
Submit return groups for review through the Frate API (by SKU)
A valid request URL is required to generate request examples[
{
"id": 123,
"created_at": "<string>",
"status": "IN_REVIEW",
"platform_refund_transaction_ids": [
"<string>"
],
"platform_line_item_id": "<string>",
"product_platform_id": "<string>",
"product_name": "<string>",
"variant_platform_id": "<string>",
"variant_name": "<string>",
"quantity": 123,
"return_reason": "<string>",
"return_reason_details": {
"value": "<string>",
"label": "<string>",
"path": [
"<string>"
],
"path_labels": [
"<string>"
],
"note": "<string>",
"type": "return_reason"
},
"questions_answers": [
{
"question_text": "<string>",
"question_description": "<string>",
"question_type": "TEXT",
"answers": [
"<string>"
],
"type": "question_answer"
}
],
"subtotal": {
"shop_money": {
"amount": 0,
"currency_code": "USD"
},
"presentment_money": {
"amount": 0,
"currency_code": "USD"
}
},
"discounted_subtotal": {
"shop_money": {
"amount": 0,
"currency_code": "USD"
},
"presentment_money": {
"amount": 0,
"currency_code": "USD"
}
},
"discount_total": {
"shop_money": {
"amount": 0,
"currency_code": "USD"
},
"presentment_money": {
"amount": 0,
"currency_code": "USD"
}
},
"tax_total": {
"shop_money": {
"amount": 0,
"currency_code": "USD"
},
"presentment_money": {
"amount": 0,
"currency_code": "USD"
}
},
"tax_percentage": 123,
"total": {
"shop_money": {
"amount": 0,
"currency_code": "USD"
},
"presentment_money": {
"amount": 0,
"currency_code": "USD"
}
},
"type": "return_line_item",
"platform_id": "<string>",
"shipment_id": 123,
"sku": "<string>",
"barcode": "<string>",
"return_note": "<string>",
"last_rma_number": "<string>",
"last_rma_provider": "SHIPWIRE"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
Path Parameters
Body
Input serializer for reviewing a return group by SKU
The returns to review by SKU
Show child attributes
Show child attributes
Response
Successful Response
Unique identifier for the return
ISO 8601 timestamp when the return was created
Current status of the return
IN_REVIEW, OPEN, COMPLETED, CANCELED The refund transaction IDs from the e-commerce platform
The line item ID from the e-commerce platform
The product ID from the e-commerce platform
The name of the product being returned
The variant ID from the e-commerce platform
The name of the specific variant being returned
The quantity of items being returned
The reason provided for the return
The details of the reason provided for the return
Show child attributes
Show child attributes
The questions and answers provided for the return
Show child attributes
Show child attributes
The subtotal amount before discounts and taxes
Show child attributes
Show child attributes
The subtotal amount after discounts but before taxes
Show child attributes
Show child attributes
The total discount amount for this return
Show child attributes
Show child attributes
The total tax amount for this return
Show child attributes
Show child attributes
The tax percentage applied to this return
The total amount for this return (including taxes and discounts)
Show child attributes
Show child attributes
The type identifier for this resource
"return_line_item"The return ID from the e-commerce platform
ID of the associated shipment for this return
The SKU (Stock Keeping Unit) of the item being returned
The barcode of the item being returned
Additional notes provided with the return
The last processed RMA number for this return
The last processed RMA provider for this return
SHIPWIRE, TWO_BOXES, RETURN_BEAR, BLADE, TRACKSTAR, MANUAL, SHIPHERO, HAPPY_RETURNS