Skip to main content
POST
/
v2
/
submit-return-group-review
Error
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>"
  }
]

Headers

​
x-frate-api-token
string | null

Body

application/json

Input serializer for reviewing a return group

​
return_group_id
integer
required

The ID of the return group to review

​
returns
SubmitReturnReviewInput · object[]
required

The returns to review

Response

Successful Response

​
id
integer
required

Unique identifier for the return

​
created_at
string
required

ISO 8601 timestamp when the return was created

​
status
enum<string>
required

Current status of the return

Available options:
IN_REVIEW,
OPEN,
COMPLETED,
CANCELED
​
platform_refund_transaction_ids
string[]
required

The refund transaction IDs from the e-commerce platform

​
platform_line_item_id
string
required

The line item ID from the e-commerce platform

​
product_platform_id
string
required

The product ID from the e-commerce platform

​
product_name
string
required

The name of the product being returned

​
variant_platform_id
string
required

The variant ID from the e-commerce platform

​
variant_name
string
required

The name of the specific variant being returned

​
quantity
integer
required

The quantity of items being returned

​
return_reason
string
required
deprecated

The reason provided for the return

​
return_reason_details
ReturnReason · object
required

The details of the reason provided for the return

​
questions_answers
QuestionAnswer · object[]
required

The questions and answers provided for the return

​
subtotal
MoneyBag · object
required

The subtotal amount before discounts and taxes

​
discounted_subtotal
MoneyBag · object
required

The subtotal amount after discounts but before taxes

​
discount_total
MoneyBag · object
required

The total discount amount for this return

​
tax_total
MoneyBag · object
required

The total tax amount for this return

​
tax_percentage
number
required

The tax percentage applied to this return

​
total
MoneyBag · object
required

The total amount for this return (including taxes and discounts)

​
type
string
default:return_line_item

The type identifier for this resource

Allowed value: "return_line_item"
​
platform_id
string | null

The return ID from the e-commerce platform

​
shipment_id
integer | null

ID of the associated shipment for this return

​
sku
string | null

The SKU (Stock Keeping Unit) of the item being returned

​
barcode
string | null

The barcode of the item being returned

​
return_note
string | null
deprecated

Additional notes provided with the return