# Repzo API - Storecheck Template

OpenAPI specification for Repzo Storecheck Template endpoints.

**Version:** 1.0.0

## Overview

### Base URLs

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

## Authentication

No authentication required.

## Endpoints

### `/storecheck-template`

#### GET /storecheck-template

**Summary:** Find storecheck templates

##### Parameters

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

| `params` | query | object | No | Query parameters for filtering storecheck templates |

##### Responses

**200** - A list of storecheck templates

Content-Type: `application/json`

---

#### POST /storecheck-template

**Summary:** Create a storecheck template

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**201** - Storecheck template created

Content-Type: `application/json`

---

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

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

**Summary:** Get a storecheck template by ID

##### Parameters

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

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

##### Responses

**200** - Storecheck template details

Content-Type: `application/json`

---

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

**Summary:** Update a storecheck template

##### Parameters

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

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

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**200** - Storecheck template updated

Content-Type: `application/json`

---

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

**Summary:** Remove a storecheck template

##### Parameters

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

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

##### Responses

**200** - Storecheck template removed

Content-Type: `application/json`

---

## Data Models

### StorecheckTemplateFindResult

Result of finding storecheck templates

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

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

| `total_result` | number | No | Total number of storecheck templates |

| `current_count` | number | No | Count of storecheck templates in current page |

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

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

| `per_page` | number | No | Number of storecheck templates per page |

### StorecheckTemplateSchema

Storecheck template schema

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

| `_id` | string | No | Unique identifier for the storecheck template |

| `name` | string | No | Name of the storecheck template |

| `description` | string | No | Description of the template |

| `category` | string | No | Category of the storecheck |

| `sections` | array | No | Template sections and questions |

| `targets` | array | No | Target entities (clients, routes, etc.) |

| `frequency` | string | No | Frequency of storecheck execution |

| `validFrom` | string | No | Start date of template validity |

| `validTo` | string | No | End date of template validity |

| `disabled` | boolean | No | Whether the template 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 |

### StorecheckTemplateCreateBody

Body for creating a storecheck template

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

| `name` | string | Yes | Name of the storecheck template |

| `description` | string | No | Description of the template |

| `category` | string | No | Category of the storecheck |

| `sections` | array | Yes | Template sections and questions |

| `targets` | array | No | Target entities (clients, routes, etc.) |

| `frequency` | string | No | Frequency of storecheck execution |

| `validFrom` | string | No | Start date of template validity |

| `validTo` | string | No | End date of template validity |

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

### StorecheckTemplateCreateResult

Result of creating a storecheck template

### StorecheckTemplateGetResult

Result of getting a storecheck template

### StorecheckTemplateUpdateBody

Body for updating a storecheck template

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

| `name` | string | No | Name of the storecheck template |

| `description` | string | No | Description of the template |

| `category` | string | No | Category of the storecheck |

| `sections` | array | No | Template sections and questions |

| `targets` | array | No | Target entities (clients, routes, etc.) |

| `frequency` | string | No | Frequency of storecheck execution |

| `validFrom` | string | No | Start date of template validity |

| `validTo` | string | No | End date of template validity |

| `disabled` | boolean | No | Whether the template is disabled |

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

### StorecheckTemplateUpdateResult

Result of updating a storecheck template

### StorecheckTemplateRemoveResult

Result of removing a storecheck template

## TypeScript Usage

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