> ## Documentation Index
> Fetch the complete documentation index at: https://docs.frate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Submit Return Group Review

> Submit return groups for review through the Frate API



## OpenAPI

````yaml POST /v2/submit-return-group-review
openapi: 3.1.0
info:
  title: Frate Returns API
  version: 0.1.0
servers:
  - url: /api
security: []
paths:
  /v2/submit-return-group-review:
    post:
      summary: Submit Return Group Review
      description: Public API submit return group review endpoint
      operationId: submit_return_group_review_v2_submit_return_group_review_post
      parameters:
        - name: x-frate-api-token
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Frate-Api-Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitReturnGroupReviewInput'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReturnLineItemSerializer'
                title: >-
                  Response Submit Return Group Review V2 Submit Return Group
                  Review Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SubmitReturnGroupReviewInput:
      properties:
        return_group_id:
          type: integer
          title: Return Group Id
          description: The ID of the return group to review
        returns:
          items:
            $ref: '#/components/schemas/SubmitReturnReviewInput'
          type: array
          title: Returns
          description: The returns to review
      type: object
      required:
        - return_group_id
        - returns
      title: SubmitReturnGroupReviewInput
      description: Input serializer for reviewing a return group
    ReturnLineItemSerializer:
      properties:
        type:
          type: string
          const: return_line_item
          title: Type
          description: The type identifier for this resource
          default: return_line_item
        id:
          type: integer
          title: Id
          description: Unique identifier for the return
        platform_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Platform Id
          description: The return ID from the e-commerce platform
        created_at:
          type: string
          title: Created At
          description: ISO 8601 timestamp when the return was created
        status:
          $ref: '#/components/schemas/InternalReturnStatusEnum'
          description: Current status of the return
        shipment_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Shipment Id
          description: ID of the associated shipment for this return
        platform_refund_transaction_ids:
          items:
            type: string
          type: array
          title: Platform Refund Transaction Ids
          description: The refund transaction IDs from the e-commerce platform
        platform_line_item_id:
          type: string
          title: Platform Line Item Id
          description: The line item ID from the e-commerce platform
        product_platform_id:
          type: string
          title: Product Platform Id
          description: The product ID from the e-commerce platform
        product_name:
          type: string
          title: Product Name
          description: The name of the product being returned
        variant_platform_id:
          type: string
          title: Variant Platform Id
          description: The variant ID from the e-commerce platform
        variant_name:
          type: string
          title: Variant Name
          description: The name of the specific variant being returned
        sku:
          anyOf:
            - type: string
            - type: 'null'
          title: Sku
          description: The SKU (Stock Keeping Unit) of the item being returned
        barcode:
          anyOf:
            - type: string
            - type: 'null'
          title: Barcode
          description: The barcode of the item being returned
        quantity:
          type: integer
          title: Quantity
          description: The quantity of items being returned
        return_reason:
          type: string
          title: Return Reason
          description: The reason provided for the return
          deprecated: true
        return_note:
          anyOf:
            - type: string
            - type: 'null'
          title: Return Note
          description: Additional notes provided with the return
          deprecated: true
        return_reason_details:
          $ref: '#/components/schemas/ReturnReasonSerializer'
          description: The details of the reason provided for the return
        questions_answers:
          items:
            $ref: '#/components/schemas/QuestionAnswerSerializer'
          type: array
          title: Questions Answers
          description: The questions and answers provided for the return
        subtotal:
          $ref: '#/components/schemas/MoneyBag'
          description: The subtotal amount before discounts and taxes
        discounted_subtotal:
          $ref: '#/components/schemas/MoneyBag'
          description: The subtotal amount after discounts but before taxes
        discount_total:
          $ref: '#/components/schemas/MoneyBag'
          description: The total discount amount for this return
        tax_total:
          $ref: '#/components/schemas/MoneyBag'
          description: The total tax amount for this return
        tax_percentage:
          type: number
          title: Tax Percentage
          description: The tax percentage applied to this return
        total:
          $ref: '#/components/schemas/MoneyBag'
          description: The total amount for this return (including taxes and discounts)
        last_rma_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Rma Number
          description: The last processed RMA number for this return
        last_rma_provider:
          anyOf:
            - $ref: '#/components/schemas/RmaPlatformEnum'
            - type: 'null'
          description: The last processed RMA provider for this return
      type: object
      required:
        - id
        - created_at
        - status
        - platform_refund_transaction_ids
        - platform_line_item_id
        - product_platform_id
        - product_name
        - variant_platform_id
        - variant_name
        - quantity
        - return_reason
        - return_reason_details
        - questions_answers
        - subtotal
        - discounted_subtotal
        - discount_total
        - tax_total
        - tax_percentage
        - total
      title: ReturnLineItem
      description: ReturnLineItem
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SubmitReturnReviewInput:
      properties:
        return_id:
          type: integer
          title: Return Id
          description: The ID of the return to review
        review_decision:
          $ref: '#/components/schemas/ReturnReviewDecisionEnum'
          description: The review decision for the return
        image_urls:
          items:
            type: string
          type: array
          title: Image Urls
          description: The URLs of the images to review
          default: []
      type: object
      required:
        - return_id
        - review_decision
      title: SubmitReturnReviewInput
      description: Input serializer for reviewing a single return
    InternalReturnStatusEnum:
      type: string
      enum:
        - IN_REVIEW
        - OPEN
        - COMPLETED
        - CANCELED
      title: InternalReturnStatusEnum
    ReturnReasonSerializer:
      properties:
        type:
          type: string
          const: return_reason
          title: Type
          description: The type identifier for this resource
          default: return_reason
        value:
          type: string
          title: Value
          description: The reason provided for the return
        label:
          type: string
          title: Label
          description: The label of the reason
        path:
          items:
            type: string
          type: array
          title: Path
          description: The path to the reason in reasons tree
        path_labels:
          items:
            type: string
          type: array
          title: Path Labels
          description: The path to the reason in reasons tree in labels
        note:
          anyOf:
            - type: string
            - type: 'null'
          title: Note
          description: Additional notes provided by user for the return
      type: object
      required:
        - value
        - label
        - path
        - path_labels
        - note
      title: ReturnReason
      description: ReturnReason
    QuestionAnswerSerializer:
      properties:
        type:
          type: string
          const: question_answer
          title: Type
          description: The type identifier for this resource
          default: question_answer
        question_text:
          type: string
          title: Question Text
          description: The question text
        question_description:
          type: string
          title: Question Description
          description: The question description
        question_type:
          type: string
          enum:
            - TEXT
            - SELECT
          title: Question Type
          description: The type of question
        answers:
          items:
            type: string
          type: array
          title: Answers
          description: The text answer or selected options
      type: object
      required:
        - question_text
        - question_description
        - question_type
        - answers
      title: QuestionAnswer
      description: QuestionAnswer
    MoneyBag:
      properties:
        shop_money:
          $ref: '#/components/schemas/MoneySerializer'
          description: The amount in the shop's currency
        presentment_money:
          $ref: '#/components/schemas/MoneySerializer'
          description: The amount in the presentment currency
      type: object
      title: MoneyBag
      description: MoneyBag
    RmaPlatformEnum:
      type: string
      enum:
        - SHIPWIRE
        - TWO_BOXES
        - RETURN_BEAR
        - BLADE
        - TRACKSTAR
        - MANUAL
        - SHIPHERO
        - HAPPY_RETURNS
      title: RmaPlatformEnum
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ReturnReviewDecisionEnum:
      type: string
      enum:
        - APPROVED
        - DECLINED
        - NO_DECISION
      title: ReturnReviewDecisionEnum
    MoneySerializer:
      properties:
        amount:
          type: number
          title: Amount
          default: 0
        currency_code:
          $ref: '#/components/schemas/CurrencyCodeEnum'
          default: USD
      type: object
      title: MoneySerializer
      description: Money
    CurrencyCodeEnum:
      type: string
      enum:
        - 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
      title: CurrencyCodeEnum

````