# Activity Storecheck API

API for managing activity storecheck records

**Version:** 1.0.0

## Overview

### Base URLs

- **Production server**: `https://sv.api.repzo.me`

- **Staging server**: `https://staging.sv.api.repzo.me`

### API Categories

- **Activity Storecheck**: Operations related to activity storecheck management

## Authentication

This API uses the following authentication methods:

- **ApiKeyAuth**

## Endpoints

### `/activity-storecheck`

#### GET /activity-storecheck

**Summary:** Get all activity storecheck records

**Description:** Retrieve a list of all activity storecheck records with optional filtering and pagination

**Tags:** Activity Storecheck

##### Parameters

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

| `limit` | query | integer | No | Maximum number of records to return |

| `offset` | query | integer | No | Number of records to skip for pagination |

| `sort` | query | string | No | Field to sort by |

| `order` | query | string | No | Sort order (asc or desc) |

| `filter` | query | string | No | Filter conditions in JSON format |

| `search` | query | string | No | Search term for text fields |

##### Responses

**200** - List of activity storecheck records retrieved successfully

Content-Type: `application/json`

**400** - Bad request

**401** - Unauthorized

**500** - Internal server error

---

#### POST /activity-storecheck

**Summary:** Create a new activity storecheck record

**Description:** Create a new activity storecheck record with the provided data

**Tags:** Activity Storecheck

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**201** - Activity storecheck record created successfully

Content-Type: `application/json`

**400** - Bad request

**401** - Unauthorized

**500** - Internal server error

---

### `/activity-storecheck/{id}`

#### GET /activity-storecheck/{id}

**Summary:** Get activity storecheck record by ID

**Description:** Retrieve a specific activity storecheck record by its ID

**Tags:** Activity Storecheck

##### Parameters

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

| `id` | path | string | Yes | Activity storecheck record ID |

##### Responses

**200** - Activity storecheck record retrieved successfully

Content-Type: `application/json`

**404** - Activity storecheck record not found

**401** - Unauthorized

**500** - Internal server error

---

#### PUT /activity-storecheck/{id}

**Summary:** Update activity storecheck record

**Description:** Update an existing activity storecheck record with new data

**Tags:** Activity Storecheck

##### Parameters

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

| `id` | path | string | Yes | Activity storecheck record ID |

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**200** - Activity storecheck record updated successfully

Content-Type: `application/json`

**400** - Bad request

**404** - Activity storecheck record not found

**401** - Unauthorized

**500** - Internal server error

---

#### DELETE /activity-storecheck/{id}

**Summary:** Delete activity storecheck record

**Description:** Delete an existing activity storecheck record

**Tags:** Activity Storecheck

##### Parameters

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

| `id` | path | string | Yes | Activity storecheck record ID |

##### Responses

**200** - Activity storecheck record deleted successfully

Content-Type: `application/json`

**404** - Activity storecheck record not found

**401** - Unauthorized

**500** - Internal server error

---

## Data Models

### ActivityStorecheck

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

| `_id` | string | No | Unique identifier for the activity storecheck record |

| `client` | string | Yes | Client identifier |

| `rep` | string | Yes | Sales representative identifier |

| `template` | string | Yes | Storecheck template identifier |

| `date` | string | Yes | Date and time of the storecheck activity |

| `location` | object | No | No description |

| `responses` | array | No | No description |

| `status` | string | No | Status of the storecheck activity |

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

| `createdAt` | string | No | Record creation timestamp |

| `updatedAt` | string | No | Record last update timestamp |

### ActivityStorecheckInput

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

| `client` | string | Yes | Client identifier |

| `rep` | string | Yes | Sales representative identifier |

| `template` | string | Yes | Storecheck template identifier |

| `date` | string | Yes | Date and time of the storecheck activity |

| `location` | object | No | No description |

| `responses` | array | No | No description |

| `status` | string | No | Status of the storecheck activity |

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

## TypeScript Usage

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