# Repzo API - Transfer

OpenAPI specification for Repzo Transfer endpoints.

**Version:** 1.0.0

## Overview

### Base URLs

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

## Authentication

No authentication required.

## Endpoints

### `/transfer`

#### GET /transfer

**Summary:** Find transfers

##### Parameters

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

| `params` | query | object | No | Query parameters for filtering transfers |

##### Responses

**200** - A list of transfers

Content-Type: `application/json`

---

#### POST /transfer

**Summary:** Create a transfer

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**201** - Transfer created

Content-Type: `application/json`

---

### `/transfer/{id}`

#### GET /transfer/{id}

**Summary:** Get a transfer by ID

##### Parameters

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

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

##### Responses

**200** - Transfer details

Content-Type: `application/json`

---

#### PUT /transfer/{id}

**Summary:** Update a transfer

##### Parameters

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

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

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**200** - Transfer updated

Content-Type: `application/json`

---

## Data Models

### TransferFindResult

Result of finding transfers

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

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

| `total_result` | number | No | Total number of transfers |

| `current_count` | number | No | Count of transfers in current page |

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

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

| `per_page` | number | No | Number of transfers per page |

### TransferSchema

Transfer schema

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

| `_id` | string | No | Unique identifier for the transfer |

| `transferNumber` | string | No | Transfer reference number |

| `fromWarehouse` | string | No | Source warehouse ID |

| `toWarehouse` | string | No | Destination warehouse ID |

| `rep` | string | No | Representative ID who initiated the transfer |

| `transferDate` | string | No | Date when transfer was initiated |

| `expectedDate` | string | No | Expected delivery date |

| `completedDate` | string | No | Date when transfer was completed |

| `status` | string | No | Status of the transfer |

| `items` | array | No | List of items being transferred |

| `totalValue` | number | No | Total value of the transfer |

| `reason` | string | No | Reason for the transfer |

| `notes` | string | No | Additional notes |

| `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 |

### TransferCreateBody

Body for creating a transfer

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

| `fromWarehouse` | string | Yes | Source warehouse ID |

| `toWarehouse` | string | Yes | Destination warehouse ID |

| `rep` | string | No | Representative ID who initiated the transfer |

| `expectedDate` | string | No | Expected delivery date |

| `items` | array | Yes | List of items being transferred |

| `reason` | string | No | Reason for the transfer |

| `notes` | string | No | Additional notes |

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

### TransferCreateResult

Result of creating a transfer

### TransferGetResult

Result of getting a transfer

### TransferUpdateBody

Body for updating a transfer

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

| `expectedDate` | string | No | Expected delivery date |

| `status` | string | No | Status of the transfer |

| `items` | array | No | List of items being transferred |

| `notes` | string | No | Additional notes |

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

### TransferUpdateResult

Result of updating a transfer

## TypeScript Usage

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