Return Groups

Error

A valid request URL is required to generate request examples

[
  {
    "id": 123,
    "return_method": "TRADITIONAL",
    "created_at": "<string>",
    "updated_at": "<string>",
    "return_outcome": "credit",
    "order": {
      "id": 123,
      "platform_id": "<string>",
      "name": "<string>",
      "tags": [
        "<string>"
      ],
      "created_at": "<string>",
      "taxes_included": true,
      "type": "order",
      "source_name": "<string>",
      "fulfilled_at": "<string>"
    },
    "customer": {
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "type": "customer"
    },
    "shipments": [
      {
        "id": 123,
        "status": "DRAFT",
        "created_at": "<string>",
        "type": "shipment",
        "carrier": "<string>",
        "tracking_number": "<string>",
        "origin_address": {
          "address1": "<string>",
          "city": "<string>",
          "province": "<string>",
          "zip": "<string>",
          "country": "<string>",
          "address2": "<string>"
        },
        "destination_address": {
          "address1": "<string>",
          "city": "<string>",
          "province": "<string>",
          "zip": "<string>",
          "country": "<string>",
          "address2": "<string>"
        },
        "shipped_at": "<string>",
        "delivered_at": "<string>",
        "return_group_id": 123,
        "return_ids": [
          123
        ]
      }
    ],
    "returns": [
      {
        "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"
      }
    ],
    "exchange_line_items": [
      {
        "id": "<string>",
        "line_item_platform_id": "<string>",
        "product_platform_id": "<string>",
        "product_name": "<string>",
        "variant_platform_id": "<string>",
        "variant_name": "<string>",
        "status": "UNPROCESSED",
        "quantity": 123,
        "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": "exchange_line_item",
        "sku": "<string>"
      }
    ],
    "refund_transactions": [
      {
        "amount": {
          "shop_money": {
            "amount": 0,
            "currency_code": "USD"
          },
          "presentment_money": {
            "amount": 0,
            "currency_code": "USD"
          }
        },
        "type": "refund_transaction",
        "platform_id": "<string>",
        "gateway": "<string>"
      }
    ],
    "suggested_refund": {
      "refund_total": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "return_total": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "return_tax_total": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "exchange_total": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "exchange_tax_total": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "handling_fee": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "shipping_fee": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "store_credit_incentive": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "type": "suggested_refund"
    },
    "type": "return_group",
    "credit_method": "STORE_CREDIT"
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

return-groups

Error

A valid request URL is required to generate request examples

[
  {
    "id": 123,
    "return_method": "TRADITIONAL",
    "created_at": "<string>",
    "updated_at": "<string>",
    "return_outcome": "credit",
    "order": {
      "id": 123,
      "platform_id": "<string>",
      "name": "<string>",
      "tags": [
        "<string>"
      ],
      "created_at": "<string>",
      "taxes_included": true,
      "type": "order",
      "source_name": "<string>",
      "fulfilled_at": "<string>"
    },
    "customer": {
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "type": "customer"
    },
    "shipments": [
      {
        "id": 123,
        "status": "DRAFT",
        "created_at": "<string>",
        "type": "shipment",
        "carrier": "<string>",
        "tracking_number": "<string>",
        "origin_address": {
          "address1": "<string>",
          "city": "<string>",
          "province": "<string>",
          "zip": "<string>",
          "country": "<string>",
          "address2": "<string>"
        },
        "destination_address": {
          "address1": "<string>",
          "city": "<string>",
          "province": "<string>",
          "zip": "<string>",
          "country": "<string>",
          "address2": "<string>"
        },
        "shipped_at": "<string>",
        "delivered_at": "<string>",
        "return_group_id": 123,
        "return_ids": [
          123
        ]
      }
    ],
    "returns": [
      {
        "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"
      }
    ],
    "exchange_line_items": [
      {
        "id": "<string>",
        "line_item_platform_id": "<string>",
        "product_platform_id": "<string>",
        "product_name": "<string>",
        "variant_platform_id": "<string>",
        "variant_name": "<string>",
        "status": "UNPROCESSED",
        "quantity": 123,
        "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": "exchange_line_item",
        "sku": "<string>"
      }
    ],
    "refund_transactions": [
      {
        "amount": {
          "shop_money": {
            "amount": 0,
            "currency_code": "USD"
          },
          "presentment_money": {
            "amount": 0,
            "currency_code": "USD"
          }
        },
        "type": "refund_transaction",
        "platform_id": "<string>",
        "gateway": "<string>"
      }
    ],
    "suggested_refund": {
      "refund_total": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "return_total": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "return_tax_total": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "exchange_total": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "exchange_tax_total": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "handling_fee": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "shipping_fee": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "store_credit_incentive": {
        "shop_money": {
          "amount": 0,
          "currency_code": "USD"
        },
        "presentment_money": {
          "amount": 0,
          "currency_code": "USD"
        }
      },
      "type": "suggested_refund"
    },
    "type": "return_group",
    "credit_method": "STORE_CREDIT"
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Headers

x-frate-api-token

string | null

Query Parameters

return_group_id

integer | null

string | null

order_id

integer | null

order_name

string | null

tracking_code

string | null

min_created_at

string<date-time> | null

max_created_at

string<date-time> | null

min_updated_at

string<date-time> | null

max_updated_at

string<date-time> | null

min_shipped_at

string<date-time> | null

max_shipped_at

string<date-time> | null

limit

integer | null

offset

integer | null

Response

Successful Response

integer

required

Unique identifier for the return group

return_method

enum<string>

required

The method used for the return

Available options:

TRADITIONAL,

SELF_SHIP,

STORE_DROP_OFF,

RETURN_BEAR,

HAPPY_RETURNS,

GLOBAL_E,

ECODROP

created_at

string

required

ISO 8601 timestamp when the return group was created

updated_at

string

required

ISO 8601 timestamp when the return group was last updated

return_outcome

enum<string> | null

required

The outcome of the return

Available options:

credit,

refund,

exchange+refund,

exchange,

exchange+credit,

upsell

order

Order · object

required

The associated order for this return group

Show child attributes

customer

Customer · object

required

The customer who initiated the return

Show child attributes

shipments

Shipment · object[]

required

List of shipments associated with the returns in this group

Show child attributes

returns

ReturnLineItem · object[]

required

List of individual returns that make up this return group

Show child attributes

exchange_line_items

ExchangeLineItem · object[]

required

Line items for exchanges if the customer chose to exchange items

Show child attributes

refund_transactions

RefundTransaction · object[]

required

List of refund transactions processed for this return group

Show child attributes

suggested_refund

SuggestedRefund · object

required

Suggested refund amount and breakdown for this return group

Show child attributes

type

string

default:return_group

The type identifier for this resource

Allowed value: "return_group"

credit_method

enum<string> | null

The method used for crediting the customer

Available options:

STORE_CREDIT,

ORIGINAL_PAYMENT_METHOD

Overview

Endpoints

Headers

Query Parameters

Response