# Return rate

**GET /v1/returns/rate**

Warehouse return rate: Pattern warehouse returned units divided by departed shipped units in the same window. Amazon FBA returns are excluded from this ratio because they have no matching warehouse shipped denominator.


## Servers
- Public API: https://api.pattern.com/hub (Public API)
- Staging API: https://stage-api.pattern.com/hub (Staging API)


## Authentication methods
- Bearer auth


## Parameters


### Query parameters

- **start_date** (string)
  ISO date (YYYY-MM-DD), inclusive. Defaults to 30 days before end_date when omitted.

- **end_date** (string)
  ISO date (YYYY-MM-DD), inclusive. Defaults to today when omitted.

- **warehouses[]** (array)
  Filter by Pattern warehouse name. When set, Amazon FBA returns are omitted.

- **vendors[]** (array)
  Filter by vendor name among vendors on the authenticated org.



## Responses
### 200
rate retrieved successfully

#### Body: application/json (object)
- **returned_units** (integer)
  Pattern warehouse returned units

- **shipped_units** (integer)
  Departed warehouse order units

- **rate** (number | null)
  returned_units / shipped_units, or null when nothing shipped

- **rate_pct** (number | null)
  Rate as a percentage



[Powered by Bump.sh](https://bump.sh)