# Repzo API - Return Reason

OpenAPI specification for Repzo Return Reason endpoints.

**Version:** 1.0.0

## Overview

### Base URLs

- \*\*\*\*: `https://sv.api.repzo.me`

## Authentication

No authentication required.

## Endpoints

### `/return-reason`

#### GET /return-reason

**Summary:** Find return reasons

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `params` | query | object | No | Query parameters for filtering return reasons |

##### Responses

**200** - A list of return reasons

Content-Type: `application/json`

---

#### POST /return-reason

**Summary:** Create a return reason

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**201** - Return reason created

Content-Type: `application/json`

---

### `/return-reason/{id}`

#### GET /return-reason/{id}

**Summary:** Get a return reason by ID

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | No description |

##### Responses

**200** - Return reason details

Content-Type: `application/json`

---

#### PUT /return-reason/{id}

**Summary:** Update a return reason

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | No description |

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**200** - Return reason updated

Content-Type: `application/json`

---

#### DELETE /return-reason/{id}

**Summary:** Remove a return reason

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | No description |

##### Responses

**200** - Return reason removed

Content-Type: `application/json`

---

## Data Models

### ReturnReasonFindResult

Result of finding return reasons

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `data` | array | No | No description |

| `total_result` | number | No | Total number of return reasons |

| `current_count` | number | No | Count of return reasons in current page |

| `total_pages` | number | No | Total number of pages |

| `current_page` | number | No | Current page number |

| `per_page` | number | No | Number of return reasons per page |

| `first_page_url` | string | No | URL for the first page |

| `last_page_url` | string | No | URL for the last page |

| `next_page_url` | string | No | URL for the next page |

| `prev_page_url` | string | No | URL for the previous page |

| `path` | string | No | Base URL path |

### ReturnReasonSchema

Return reason schema

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `_id` | string | No | Unique identifier for the return reason |

| `name` | string | No | Name of the return reason |

| `local_name` | string | No | Localized name of the return reason |

| `disabled` | boolean | No | Whether the return reason is disabled |

| `integration_meta` | object | No | Integration metadata |

| `company_namespace` | array | No | Company namespaces |

| `createdAt` | string | No | Creation timestamp |

| `updatedAt` | string | No | Last update timestamp |

| `__v` | number | No | Version number |

### ReturnReasonCreateBody

Body for creating a return reason

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `name` | string | Yes | Name of the return reason |

| `local_name` | string | No | Localized name of the return reason |

| `disabled` | boolean | No | Whether the return reason is disabled |

| `integration_meta` | object | No | Integration metadata |

| `company_namespace` | array | No | Company namespaces |

### ReturnReasonCreateResult

Result of creating a return reason

### ReturnReasonGetResult

Result of getting a return reason

### ReturnReasonUpdateBody

Body for updating a return reason

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `name` | string | No | Name of the return reason |

| `local_name` | string | No | Localized name of the return reason |

| `disabled` | boolean | No | Whether the return reason is disabled |

| `integration_meta` | object | No | Integration metadata |

| `company_namespace` | array | No | Company namespaces |

| `_id` | string | No | Unique identifier for the return reason |

| `createdAt` | string | No | Creation timestamp |

| `updatedAt` | string | No | Last update timestamp |

| `__v` | number | No | Version number |

### ReturnReasonUpdateResult

Result of updating a return reason

### ReturnReasonRemoveResult

Result of removing a return reason

## TypeScript Usage

See [return-reason-examples.md](./return-reason-examples.md) for detailed TypeScript usage examples.