---
title: "return.list"
method: GET
path: "/return.list.json"
tags: ["return"]
---

# return.list

`GET /return.list.json`

## Request

- Base URL: `https://api.api2cart.com/v1.1`
- URL: `https://api.api2cart.com/v1.1/return.list.json`
- Auth: API key in header `x-api-key` and API key in header `x-store-key`

Get list of return requests from store.

## Query parameters

- `start` integer
- `count` integer
- `page_cursor` string
- `order_id` string
- `order_ids` string
- `customer_id` string
- `store_id` string
- `status` string
- `return_type` string
- `created_from` string
- `created_to` string
- `modified_from` string
- `modified_to` string
- `response_fields` string
- `params` string
- `exclude` string
- `report_request_id` string
- `disable_report_cache` boolean

## Response `200`

successful operation

- ModelResponseReturnList
  - `return_code` integer, nullable
  - `return_message` string, nullable
  - `pagination` Pagination
    - `previous` string, nullable
    - `next` string, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `result` ResponseReturnListResult
    - `total_count` integer, nullable
    - `returns` Return[]
      - `id` string
      - `name` string, nullable
      - `order_id` string, nullable
      - `customer_id` string, nullable
      - `store_id` string, nullable
      - `created_at` string, nullable
      - `modified_at` string, nullable
      - `status` ReturnStatus
        - `id` string
        - `name` string
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `order_products` ReturnOrderProduct[]
        - `product_id` string, nullable
        - `order_product_id` string
        - `sku` string, nullable
        - `name` string, nullable
        - `quantity` integer
        - `reason` ReturnReason
          - `id` string
          - `name` string
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `action` ReturnAction
          - `id` string
          - `name` string
          - `additional_fields` object, nullable
          - `custom_fields` object, nullable
        - `condition` string, nullable
        - `customer_comment` string, nullable
        - `additional_fields` object, nullable
        - `custom_fields` object, nullable
      - `comment` string, nullable
      - `staff_note` string, nullable
      - `additional_fields` object, nullable
      - `custom_fields` object, nullable
    - `additional_fields` object, nullable
    - `custom_fields` object, nullable
  - `additional_fields` object, nullable
  - `custom_fields` object, nullable

---

[API](https://skmtc.dev/api2cart/apis/api2cart-openapi.md) · [All operations](https://skmtc.dev/api2cart/apis/api2cart-openapi/llms.txt) · [OpenAPI document](https://skmtc.dev/api2cart/apis/api2cart-openapi/revisions/c34440741693?raw)