---
title: "List Return Configuration"
method: GET
path: "/v4/returns/returns-configurations/"
tags: ["Return Configuration Set"]
---

# List Return Configuration

`GET /v4/returns/returns-configurations/`

## Request

- The document declares no server URL.
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer

Return configuration (sets) represent a bundle of configurations, that are available with that configuration code
on an account. The configuration set for instance groups configurations, such as Courier APIs for a specific country
or language.

## Query parameters

- `account` integer[]
- `limit` integer
- `offset` integer
- `ordering` string

## Response `200`

- PaginatedReturnConfigurationList
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` ReturnConfiguration[], required
    - `id` integer, required
    - `account` integer, required
    - `code` string, required: Configuration code of the return configuration
    - `client` integer, nullable: Default client for this portal. Shopify Order API registrations override this with the *.myshopify.com domain.
    - `courier_mappings` ReturnCourierMapping[], required
      - `courier_api` ReturnCourierAPI, required: Represents a courier API configuration
        - `account` integer, required
        - `name` string, required
        - `courier_code` string, required: Code used for the translation for the courier in the returns portal.
        - `identifier` string: Identifier, for instance Warehouse code
        - `has_oauth_credential` boolean, required
        - `service_levels` ReferenceItem[], required
          - `key` string, required
          - `name` string, required
          - `type` 'destination-country-iso3' | 'client' | 'courier' | 'warehouse' | 'courier-service-level' | 'delivery-method' | 'delivery-info-market' | 'payment-method' | 'order-status' | 'claim-reason' | 'return-reject-reason' | 'delivery-timezone' | 'delivery-region' | 'delivery-location' | 'delivery-status' | 'delivery-exception' | 'tracking-tags', required: * `destination-country-iso3` - Destination Country ISO3 * `client` - Client * `courier` - Courier * `warehouse` - Warehouse * `courier-service-level` - Courier Service Level * `delivery-method` - Delivery Method * `delivery-info-market` - Delivery Info Market * `payment-method` - Payment Method * `order-status` - Order Status * `claim-reason` - Claim Reason * `return-reject-reason` - Return Reject Reason * `delivery-timezone` - Timezone (Delivery Info) * `delivery-region` - Region (Destination) * `delivery-location` - Delivery Location * `delivery-status` - Delivery Status * `delivery-exception` - Delivery Exception * `tracking-tags` - Tracking Tags
          - `updated_at` string, date-time, required
        - `service_name` string, required
        - `service_config` string, required
        - `is_pydantic_schema` boolean, required
      - `filter` object, required
    - `returns_order_api` integer, nullable: The API to be used to fetch order information
    - `returns_rules` integer, nullable: Returns reasons to use for this portal
    - `returnable_periods` ReturnablePeriod[], required
      - `description` string, required
      - `trial_period` integer, required: in days
      - `customer_service_period_days` integer, nullable: Overrides the trial period for customer service portals only. Leave empty to use the regular trial period. Ignored for warranty periods. Extending the trial period delays warranty-only reasons and requirements.
      - `grace_period` integer, required: Grace period (OrderDate) in days is calculated from the OrderDate in days
      - `grace_period_shipping_date` integer: Grace period (ShippingDate) in days is calculated from the ShippingDate in days
      - `grace_period_delivery_date` integer: Grace period (DeliveryDate) in days is calculated from the DeliveryDate in days
      - `is_warranty_period` boolean, required
      - `filter` object

## Other responses

- `400`
- `403`
- `404`

## Changes

- **2026-11-03** `84524f38b6c9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/parcellab/apis/parcellab-api/changes/v4/returns/returns-configurations/get.md)

---

[API](https://skmtc.dev/parcellab/apis/parcellab-api.md) - [All operations](https://skmtc.dev/parcellab/apis/parcellab-api/llms.txt) - [OpenAPI document](https://skmtc.dev/parcellab/apis/parcellab-api/revisions/84524f38b6c9?raw)