Error
Copy
A valid request URL is required to generate request examplesCopy
[
{
"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>"
}
]Endpoints
Submit Return Group Review
Submit return groups for review through the Frate API
POST
/
v2
/
submit-return-group-review
Error
Copy
A valid request URL is required to generate request examplesCopy
[
{
"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>"
}
]Headers
Body
application/json
Input serializer for reviewing a return group
The ID of the return group to review
Response
Successful Response
Unique identifier for the return
ISO 8601 timestamp when the return was created
Current status of the return
Available options:
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 reason provided for the return
The label of the reason
The path to the reason in reasons tree
The path to the reason in reasons tree in labels
Additional notes provided by user for the return
The type identifier for this resource
Allowed value:
"return_reason"The questions and answers provided for the return
Show child attributes
Show child attributes
The question text
The question description
The type of question
Available options:
TEXT, SELECT The text answer or selected options
The type identifier for this resource
Allowed value:
"question_answer"The subtotal amount before discounts and taxes
Show child attributes
Show child attributes
The amount in the shop's currency
Show child attributes
Show child attributes
Available options:
USD, EUR, GBP, JPY, CNY, CAD, AUD, CHF, AED, AFN, BDT, BHD, BND, BTN, HKD, IDR, ILS, INR, IQD, IRR, JOD, KHR, KRW, KWD, KZT, LAK, LKR, MMK, MNT, MOP, MVR, MYR, NPR, OMR, PHP, PKR, QAR, SAR, SGD, THB, TWD, UZS, VND, YER, BWP, CDF, DJF, EGP, ERN, ETB, GHS, GMD, GNF, KES, KMF, LRD, LSL, MAD, MGA, MWK, MZN, NAD, NGN, RWF, SDG, SLL, SOS, SSP, TND, TZS, UGX, ZAR, ZMW, ARS, BBD, BMD, BOB, BRL, BSD, BZD, CLP, COP, CRC, CUP, DOP, FKP, GYD, HNL, JMD, KID, KYD, MXN, NIO, PAB, PEN, PYG, SRD, TTD, UYU, VED, VES, ALL, AMD, AZN, BAM, BGN, BYN, CZK, DKK, GEL, HRK, HUF, ISK, LTL, LVL, MDL, MKD, NOK, PLN, RON, RSD, RUB, SEK, TRY, UAH, FJD, NZD, PGK, SBD, TOP, VUV, WST, AOA, ANG, AWG, BIF, CVE, LBP, LYD, MRU, MUR, SCR, SHP, STN, SYP, SZL, TJS, TMT, XAF, XCD, XOF, XPF, XXX, GIP, JEP, SLE The amount in the presentment currency
Show child attributes
Show child attributes
Available options:
USD, EUR, GBP, JPY, CNY, CAD, AUD, CHF, AED, AFN, BDT, BHD, BND, BTN, HKD, IDR, ILS, INR, IQD, IRR, JOD, KHR, KRW, KWD, KZT, LAK, LKR, MMK, MNT, MOP, MVR, MYR, NPR, OMR, PHP, PKR, QAR, SAR, SGD, THB, TWD, UZS, VND, YER, BWP, CDF, DJF, EGP, ERN, ETB, GHS, GMD, GNF, KES, KMF, LRD, LSL, MAD, MGA, MWK, MZN, NAD, NGN, RWF, SDG, SLL, SOS, SSP, TND, TZS, UGX, ZAR, ZMW, ARS, BBD, BMD, BOB, BRL, BSD, BZD, CLP, COP, CRC, CUP, DOP, FKP, GYD, HNL, JMD, KID, KYD, MXN, NIO, PAB, PEN, PYG, SRD, TTD, UYU, VED, VES, ALL, AMD, AZN, BAM, BGN, BYN, CZK, DKK, GEL, HRK, HUF, ISK, LTL, LVL, MDL, MKD, NOK, PLN, RON, RSD, RUB, SEK, TRY, UAH, FJD, NZD, PGK, SBD, TOP, VUV, WST, AOA, ANG, AWG, BIF, CVE, LBP, LYD, MRU, MUR, SCR, SHP, STN, SYP, SZL, TJS, TMT, XAF, XCD, XOF, XPF, XXX, GIP, JEP, SLE The subtotal amount after discounts but before taxes
Show child attributes
Show child attributes
The amount in the shop's currency
Show child attributes
Show child attributes
Available options:
USD, EUR, GBP, JPY, CNY, CAD, AUD, CHF, AED, AFN, BDT, BHD, BND, BTN, HKD, IDR, ILS, INR, IQD, IRR, JOD, KHR, KRW, KWD, KZT, LAK, LKR, MMK, MNT, MOP, MVR, MYR, NPR, OMR, PHP, PKR, QAR, SAR, SGD, THB, TWD, UZS, VND, YER, BWP, CDF, DJF, EGP, ERN, ETB, GHS, GMD, GNF, KES, KMF, LRD, LSL, MAD, MGA, MWK, MZN, NAD, NGN, RWF, SDG, SLL, SOS, SSP, TND, TZS, UGX, ZAR, ZMW, ARS, BBD, BMD, BOB, BRL, BSD, BZD, CLP, COP, CRC, CUP, DOP, FKP, GYD, HNL, JMD, KID, KYD, MXN, NIO, PAB, PEN, PYG, SRD, TTD, UYU, VED, VES, ALL, AMD, AZN, BAM, BGN, BYN, CZK, DKK, GEL, HRK, HUF, ISK, LTL, LVL, MDL, MKD, NOK, PLN, RON, RSD, RUB, SEK, TRY, UAH, FJD, NZD, PGK, SBD, TOP, VUV, WST, AOA, ANG, AWG, BIF, CVE, LBP, LYD, MRU, MUR, SCR, SHP, STN, SYP, SZL, TJS, TMT, XAF, XCD, XOF, XPF, XXX, GIP, JEP, SLE The amount in the presentment currency
Show child attributes
Show child attributes
Available options:
USD, EUR, GBP, JPY, CNY, CAD, AUD, CHF, AED, AFN, BDT, BHD, BND, BTN, HKD, IDR, ILS, INR, IQD, IRR, JOD, KHR, KRW, KWD, KZT, LAK, LKR, MMK, MNT, MOP, MVR, MYR, NPR, OMR, PHP, PKR, QAR, SAR, SGD, THB, TWD, UZS, VND, YER, BWP, CDF, DJF, EGP, ERN, ETB, GHS, GMD, GNF, KES, KMF, LRD, LSL, MAD, MGA, MWK, MZN, NAD, NGN, RWF, SDG, SLL, SOS, SSP, TND, TZS, UGX, ZAR, ZMW, ARS, BBD, BMD, BOB, BRL, BSD, BZD, CLP, COP, CRC, CUP, DOP, FKP, GYD, HNL, JMD, KID, KYD, MXN, NIO, PAB, PEN, PYG, SRD, TTD, UYU, VED, VES, ALL, AMD, AZN, BAM, BGN, BYN, CZK, DKK, GEL, HRK, HUF, ISK, LTL, LVL, MDL, MKD, NOK, PLN, RON, RSD, RUB, SEK, TRY, UAH, FJD, NZD, PGK, SBD, TOP, VUV, WST, AOA, ANG, AWG, BIF, CVE, LBP, LYD, MRU, MUR, SCR, SHP, STN, SYP, SZL, TJS, TMT, XAF, XCD, XOF, XPF, XXX, GIP, JEP, SLE The total discount amount for this return
Show child attributes
Show child attributes
The amount in the shop's currency
Show child attributes
Show child attributes
Available options:
USD, EUR, GBP, JPY, CNY, CAD, AUD, CHF, AED, AFN, BDT, BHD, BND, BTN, HKD, IDR, ILS, INR, IQD, IRR, JOD, KHR, KRW, KWD, KZT, LAK, LKR, MMK, MNT, MOP, MVR, MYR, NPR, OMR, PHP, PKR, QAR, SAR, SGD, THB, TWD, UZS, VND, YER, BWP, CDF, DJF, EGP, ERN, ETB, GHS, GMD, GNF, KES, KMF, LRD, LSL, MAD, MGA, MWK, MZN, NAD, NGN, RWF, SDG, SLL, SOS, SSP, TND, TZS, UGX, ZAR, ZMW, ARS, BBD, BMD, BOB, BRL, BSD, BZD, CLP, COP, CRC, CUP, DOP, FKP, GYD, HNL, JMD, KID, KYD, MXN, NIO, PAB, PEN, PYG, SRD, TTD, UYU, VED, VES, ALL, AMD, AZN, BAM, BGN, BYN, CZK, DKK, GEL, HRK, HUF, ISK, LTL, LVL, MDL, MKD, NOK, PLN, RON, RSD, RUB, SEK, TRY, UAH, FJD, NZD, PGK, SBD, TOP, VUV, WST, AOA, ANG, AWG, BIF, CVE, LBP, LYD, MRU, MUR, SCR, SHP, STN, SYP, SZL, TJS, TMT, XAF, XCD, XOF, XPF, XXX, GIP, JEP, SLE The amount in the presentment currency
Show child attributes
Show child attributes
Available options:
USD, EUR, GBP, JPY, CNY, CAD, AUD, CHF, AED, AFN, BDT, BHD, BND, BTN, HKD, IDR, ILS, INR, IQD, IRR, JOD, KHR, KRW, KWD, KZT, LAK, LKR, MMK, MNT, MOP, MVR, MYR, NPR, OMR, PHP, PKR, QAR, SAR, SGD, THB, TWD, UZS, VND, YER, BWP, CDF, DJF, EGP, ERN, ETB, GHS, GMD, GNF, KES, KMF, LRD, LSL, MAD, MGA, MWK, MZN, NAD, NGN, RWF, SDG, SLL, SOS, SSP, TND, TZS, UGX, ZAR, ZMW, ARS, BBD, BMD, BOB, BRL, BSD, BZD, CLP, COP, CRC, CUP, DOP, FKP, GYD, HNL, JMD, KID, KYD, MXN, NIO, PAB, PEN, PYG, SRD, TTD, UYU, VED, VES, ALL, AMD, AZN, BAM, BGN, BYN, CZK, DKK, GEL, HRK, HUF, ISK, LTL, LVL, MDL, MKD, NOK, PLN, RON, RSD, RUB, SEK, TRY, UAH, FJD, NZD, PGK, SBD, TOP, VUV, WST, AOA, ANG, AWG, BIF, CVE, LBP, LYD, MRU, MUR, SCR, SHP, STN, SYP, SZL, TJS, TMT, XAF, XCD, XOF, XPF, XXX, GIP, JEP, SLE The total tax amount for this return
Show child attributes
Show child attributes
The amount in the shop's currency
Show child attributes
Show child attributes
Available options:
USD, EUR, GBP, JPY, CNY, CAD, AUD, CHF, AED, AFN, BDT, BHD, BND, BTN, HKD, IDR, ILS, INR, IQD, IRR, JOD, KHR, KRW, KWD, KZT, LAK, LKR, MMK, MNT, MOP, MVR, MYR, NPR, OMR, PHP, PKR, QAR, SAR, SGD, THB, TWD, UZS, VND, YER, BWP, CDF, DJF, EGP, ERN, ETB, GHS, GMD, GNF, KES, KMF, LRD, LSL, MAD, MGA, MWK, MZN, NAD, NGN, RWF, SDG, SLL, SOS, SSP, TND, TZS, UGX, ZAR, ZMW, ARS, BBD, BMD, BOB, BRL, BSD, BZD, CLP, COP, CRC, CUP, DOP, FKP, GYD, HNL, JMD, KID, KYD, MXN, NIO, PAB, PEN, PYG, SRD, TTD, UYU, VED, VES, ALL, AMD, AZN, BAM, BGN, BYN, CZK, DKK, GEL, HRK, HUF, ISK, LTL, LVL, MDL, MKD, NOK, PLN, RON, RSD, RUB, SEK, TRY, UAH, FJD, NZD, PGK, SBD, TOP, VUV, WST, AOA, ANG, AWG, BIF, CVE, LBP, LYD, MRU, MUR, SCR, SHP, STN, SYP, SZL, TJS, TMT, XAF, XCD, XOF, XPF, XXX, GIP, JEP, SLE The amount in the presentment currency
Show child attributes
Show child attributes
Available options:
USD, EUR, GBP, JPY, CNY, CAD, AUD, CHF, AED, AFN, BDT, BHD, BND, BTN, HKD, IDR, ILS, INR, IQD, IRR, JOD, KHR, KRW, KWD, KZT, LAK, LKR, MMK, MNT, MOP, MVR, MYR, NPR, OMR, PHP, PKR, QAR, SAR, SGD, THB, TWD, UZS, VND, YER, BWP, CDF, DJF, EGP, ERN, ETB, GHS, GMD, GNF, KES, KMF, LRD, LSL, MAD, MGA, MWK, MZN, NAD, NGN, RWF, SDG, SLL, SOS, SSP, TND, TZS, UGX, ZAR, ZMW, ARS, BBD, BMD, BOB, BRL, BSD, BZD, CLP, COP, CRC, CUP, DOP, FKP, GYD, HNL, JMD, KID, KYD, MXN, NIO, PAB, PEN, PYG, SRD, TTD, UYU, VED, VES, ALL, AMD, AZN, BAM, BGN, BYN, CZK, DKK, GEL, HRK, HUF, ISK, LTL, LVL, MDL, MKD, NOK, PLN, RON, RSD, RUB, SEK, TRY, UAH, FJD, NZD, PGK, SBD, TOP, VUV, WST, AOA, ANG, AWG, BIF, CVE, LBP, LYD, MRU, MUR, SCR, SHP, STN, SYP, SZL, TJS, TMT, XAF, XCD, XOF, XPF, XXX, GIP, JEP, SLE The tax percentage applied to this return
The total amount for this return (including taxes and discounts)
Show child attributes
Show child attributes
The amount in the shop's currency
Show child attributes
Show child attributes
Available options:
USD, EUR, GBP, JPY, CNY, CAD, AUD, CHF, AED, AFN, BDT, BHD, BND, BTN, HKD, IDR, ILS, INR, IQD, IRR, JOD, KHR, KRW, KWD, KZT, LAK, LKR, MMK, MNT, MOP, MVR, MYR, NPR, OMR, PHP, PKR, QAR, SAR, SGD, THB, TWD, UZS, VND, YER, BWP, CDF, DJF, EGP, ERN, ETB, GHS, GMD, GNF, KES, KMF, LRD, LSL, MAD, MGA, MWK, MZN, NAD, NGN, RWF, SDG, SLL, SOS, SSP, TND, TZS, UGX, ZAR, ZMW, ARS, BBD, BMD, BOB, BRL, BSD, BZD, CLP, COP, CRC, CUP, DOP, FKP, GYD, HNL, JMD, KID, KYD, MXN, NIO, PAB, PEN, PYG, SRD, TTD, UYU, VED, VES, ALL, AMD, AZN, BAM, BGN, BYN, CZK, DKK, GEL, HRK, HUF, ISK, LTL, LVL, MDL, MKD, NOK, PLN, RON, RSD, RUB, SEK, TRY, UAH, FJD, NZD, PGK, SBD, TOP, VUV, WST, AOA, ANG, AWG, BIF, CVE, LBP, LYD, MRU, MUR, SCR, SHP, STN, SYP, SZL, TJS, TMT, XAF, XCD, XOF, XPF, XXX, GIP, JEP, SLE The amount in the presentment currency
Show child attributes
Show child attributes
Available options:
USD, EUR, GBP, JPY, CNY, CAD, AUD, CHF, AED, AFN, BDT, BHD, BND, BTN, HKD, IDR, ILS, INR, IQD, IRR, JOD, KHR, KRW, KWD, KZT, LAK, LKR, MMK, MNT, MOP, MVR, MYR, NPR, OMR, PHP, PKR, QAR, SAR, SGD, THB, TWD, UZS, VND, YER, BWP, CDF, DJF, EGP, ERN, ETB, GHS, GMD, GNF, KES, KMF, LRD, LSL, MAD, MGA, MWK, MZN, NAD, NGN, RWF, SDG, SLL, SOS, SSP, TND, TZS, UGX, ZAR, ZMW, ARS, BBD, BMD, BOB, BRL, BSD, BZD, CLP, COP, CRC, CUP, DOP, FKP, GYD, HNL, JMD, KID, KYD, MXN, NIO, PAB, PEN, PYG, SRD, TTD, UYU, VED, VES, ALL, AMD, AZN, BAM, BGN, BYN, CZK, DKK, GEL, HRK, HUF, ISK, LTL, LVL, MDL, MKD, NOK, PLN, RON, RSD, RUB, SEK, TRY, UAH, FJD, NZD, PGK, SBD, TOP, VUV, WST, AOA, ANG, AWG, BIF, CVE, LBP, LYD, MRU, MUR, SCR, SHP, STN, SYP, SZL, TJS, TMT, XAF, XCD, XOF, XPF, XXX, GIP, JEP, SLE The type identifier for this resource
Allowed value:
"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
⌘I