> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Simla.com API reference

> API reference for the Simla.com plugin in Corsair: every `simlacom.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Api

### apiVersions.get

`api.apiVersions.get`

Getting the list of available api versions

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.api.apiVersions.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `versions` | `string[]` | No | — |

***

### credentials.get

`api.credentials.get`

Getting the list of available api methods and stores for current key

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.api.credentials.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `credentials` | `string[]` | No | — |
| `scopes` | `string[]` | No | — |
| `siteAccess` | `custom` | No | — |
| `sitesAvailable` | `string[]` | No | — |

***

## Corporate Customers

### byExternalidAddressesByEntityexternalidEdit.post

`corporateCustomers.byExternalidAddressesByEntityexternalidEdit.post`

Editing the address of the corporate customer

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.byExternalidAddressesByEntityexternalidEdit.post({
	path: { externalId: 'demo', entityExternalId: 'demo' },
	body: {
		address: { index: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown,
>   entityExternalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string,
>   entityBy?: custom
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   address?: {
>     index?: string | null,
>     countryIso?: string | null,
>     region?: string | null,
>     regionId?: number | null,
>     city?: string | null,
>     cityId?: number | null,
>     cityType?: string,
>     street?: string | null,
>     streetId?: number | null,
>     streetType?: string,
>     building?: string | null,
>     flat?: string | null,
>     floor?: number | null,
>     block?: number | null,
>     house?: string | null,
>     housing?: string,
>     metro?: string | null,
>     notes?: string | null,
>     text?: string,
>     isMain?: boolean,
>     externalId?: string,
>     name?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | — |

***

### byExternalidAddressesCreate.post

`corporateCustomers.byExternalidAddressesCreate.post`

Creating an address for a corporate customer

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.byExternalidAddressesCreate.post({
	path: { externalId: 'demo' },
	body: {
		address: { index: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   address?: {
>     index?: string | null,
>     countryIso?: string | null,
>     region?: string | null,
>     regionId?: number | null,
>     city?: string | null,
>     cityId?: number | null,
>     cityType?: string,
>     street?: string | null,
>     streetId?: number | null,
>     streetType?: string,
>     building?: string | null,
>     flat?: string | null,
>     floor?: number | null,
>     block?: number | null,
>     house?: string | null,
>     housing?: string,
>     metro?: string | null,
>     notes?: string | null,
>     text?: string,
>     isMain?: boolean,
>     externalId?: string,
>     name?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | — |

***

### byExternalidCompaniesByEntityexternalidEdit.post

`corporateCustomers.byExternalidCompaniesByEntityexternalidEdit.post`

Editing the company of the corporate customer

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.byExternalidCompaniesByEntityexternalidEdit.post({
	path: { externalId: 'demo', entityExternalId: 'demo' },
	body: {
		company: { isMain: false },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown,
>   entityExternalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string,
>   entityBy?: custom
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   company?: {
>     isMain?: boolean,
>     externalId?: string,
>     active?: boolean,
>     name?: string,
>     brand?: string,
>     site?: string,
>     createdAt?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     customFields?: custom[] | {
>     },
>     address?: {
>       id?: number,
>       externalId?: string
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | — |

***

### byExternalidCompaniesCreate.post

`corporateCustomers.byExternalidCompaniesCreate.post`

Creating a company for a corporate customer

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.byExternalidCompaniesCreate.post({
	path: { externalId: 'demo' },
	body: {
		company: { isMain: false },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   company?: {
>     isMain?: boolean,
>     externalId?: string,
>     active?: boolean,
>     name?: string,
>     brand?: string,
>     site?: string,
>     createdAt?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     customFields?: custom[] | {
>     },
>     address?: {
>       id?: number,
>       externalId?: string
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | — |

***

### byExternalidContactsByEntityexternalidEdit.post

`corporateCustomers.byExternalidContactsByEntityexternalidEdit.post`

Editing the link between the corporate customer and the contact person

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.byExternalidContactsByEntityexternalidEdit.post({
	path: { externalId: 'demo', entityExternalId: 'demo' },
	body: {
		contact: { isMain: false },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown,
>   entityExternalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string,
>   entityBy?: custom
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   contact?: {
>     isMain?: boolean,
>     companies?: {
>       company?: {
>         id?: number,
>         externalId?: string
>       }
>     }[]
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | — |

***

### byExternalidContactsCreate.post

`corporateCustomers.byExternalidContactsCreate.post`

Creating a link between a corporate customer and a contact person

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.byExternalidContactsCreate.post({
	path: { externalId: 'demo' },
	body: {
		contact: { isMain: false },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   contact?: {
>     isMain?: boolean,
>     customer?: {
>       id?: number,
>       externalId?: string,
>       browserId?: string,
>       site?: string
>     },
>     companies?: {
>       company?: {
>         id?: number,
>         externalId?: string
>       }
>     }[]
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | — |

***

### byExternalidEdit.post

`corporateCustomers.byExternalidEdit.post`

Corporate customer editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.byExternalidEdit.post({
	path: { externalId: 'demo' },
	body: {
		customerCorporate: { externalId: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   customerCorporate?: {
>     externalId?: string,
>     createdAt?: string,
>     vip?: boolean,
>     bad?: boolean,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     discountCardNumber?: string | null,
>     nickName?: string,
>     managerId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Customer internal ID |
| `state` | `string \| null` | No | Customer customer (not returned by default) |

***

### combine.post

`corporateCustomers.combine.post`

Combining of corporate customers

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.combine.post({
	body: {
		resultCustomer: { id: 1 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   customers?: {
>     id: number
>   }[],
>   resultCustomer: {
>     id: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### create.post

`corporateCustomers.create.post`

Corporate customer creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.create.post({
	body: {
		customerCorporate: { externalId: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   customerCorporate?: {
>     externalId?: string,
>     createdAt?: string,
>     vip?: boolean,
>     bad?: boolean,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     discountCardNumber?: string | null,
>     nickName?: string,
>     managerId?: number,
>     customerContacts?: {
>       isMain?: boolean,
>       customer?: {
>         id?: number,
>         externalId?: string,
>         browserId?: string,
>         site?: string
>       },
>       companies?: {
>         company?: {
>           id?: number,
>           externalId?: string
>         }
>       }[]
>     }[],
>     companies?: {
>       isMain?: boolean,
>       externalId?: string,
>       active?: boolean,
>       name?: string,
>       brand?: string,
>       site?: string,
>       createdAt?: string,
>       contragent?: {
>         contragentType?: string | null,
>         legalName?: string,
>         legalAddress?: string,
>         INN?: string,
>         OKPO?: string,
>         KPP?: string,
>         OGRN?: string,
>         OGRNIP?: string,
>         certificateNumber?: string,
>         certificateDate?: string | null,
>         BIK?: string,
>         bank?: string,
>         bankAddress?: string,
>         corrAccount?: string,
>         bankAccount?: string
>       },
>       customFields?: custom[] | {
>       },
>       address?: {
>         id?: number,
>         externalId?: string
>       }
>     }[],
>     addresses?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     }[]
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created customer |

***

### fixExternalIds.post

`corporateCustomers.fixExternalIds.post`

The mass recording of corporate customers external ID

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.fixExternalIds.post({
	body: {
		customersCorporate: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   customersCorporate?: {
>     id: number,
>     externalId: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### getByExternalid.get

`corporateCustomers.getByExternalid.get`

Getting information on corporate customer

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.getByExternalid.get({
	path: { externalId: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `customerCorporate` | `object` | No | Corporate customer |

> [accordion] customerCorporate full type
>
> ```ts theme={null}
> {
>   type?: string,
>   id?: number,
>   externalId?: string,
>   mainAddress?: {
>     id?: number,
>     externalId?: string,
>     name?: string
>   },
>   createdAt?: string,
>   managerId?: number,
>   vip?: boolean,
>   bad?: boolean,
>   site?: string,
>   tags?: {
>     color?: string,
>     name?: string,
>     colorCode?: string,
>     attached?: boolean
>   }[],
>   firstClientId?: string,
>   lastClientId?: string,
>   customFields?: custom[] | {
>   },
>   personalDiscount?: number,
>   cumulativeDiscount?: number,
>   discountCardNumber?: string | null,
>   avgMarginSumm?: number | null,
>   marginSumm?: number,
>   totalSumm?: number,
>   averageSumm?: number | null,
>   ordersCount?: number | null,
>   ticketsCount?: number,
>   costSumm?: number | null,
>   mainCustomerContact?: {
>     id?: number,
>     customer?: {
>       id?: number,
>       externalId?: string,
>       browserId?: string
>     } | null,
>     companies?: {
>       id?: number,
>       company?: {
>         id?: number,
>         externalId?: string,
>         name?: string
>       } | null
>     }[]
>   },
>   mainCompany?: {
>     id?: number,
>     externalId?: string,
>     name?: string
>   },
>   nickName?: string
> }
> ```

***

### getByExternalidAddresses.get

`corporateCustomers.getByExternalidAddresses.get`

List of addresses for a corporate customer

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.getByExternalidAddresses.get({
	path: { externalId: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   filter[
>     name
>   ]?: string,
>   filter[
>     city
>   ]?: string,
>   filter[
>     region
>   ]?: string,
>   by?: custom,
>   site?: string,
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `addresses` | `object[]` | No | — |

> [accordion] addresses full type
>
> ```ts theme={null}
> {
>   id?: number,
>   index?: string | null,
>   countryIso?: string | null,
>   region?: string | null,
>   regionId?: number | null,
>   city?: string | null,
>   cityId?: number | null,
>   cityType?: string,
>   street?: string | null,
>   streetId?: number | null,
>   streetType?: string,
>   building?: string | null,
>   flat?: string | null,
>   floor?: number | null,
>   block?: number | null,
>   house?: string | null,
>   housing?: string,
>   metro?: string | null,
>   notes?: string | null,
>   text?: string,
>   isMain?: boolean,
>   externalId?: string,
>   name?: string
> }[]
> ```

***

### getByExternalidCompanies.get

`corporateCustomers.getByExternalidCompanies.get`

List of companies of a contact person

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.getByExternalidCompanies.get({
	path: { externalId: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string,
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `companies` | `object[]` | No | — |

> [accordion] companies full type
>
> ```ts theme={null}
> {
>   isMain?: boolean,
>   id?: number,
>   externalId?: string,
>   customer?: {
>     site?: string,
>     id?: number,
>     externalId?: string,
>     type?: string
>   } | null,
>   active?: boolean,
>   name?: string,
>   brand?: string,
>   site?: string,
>   createdAt?: string,
>   contragent?: {
>     contragentType?: string | null,
>     legalName?: string,
>     legalAddress?: string,
>     INN?: string,
>     OKPO?: string,
>     KPP?: string,
>     OGRN?: string,
>     OGRNIP?: string,
>     certificateNumber?: string,
>     certificateDate?: string | null,
>     BIK?: string,
>     bank?: string,
>     bankAddress?: string,
>     corrAccount?: string,
>     bankAccount?: string
>   } | null,
>   address?: {
>     id?: number,
>     index?: string | null,
>     countryIso?: string | null,
>     region?: string | null,
>     regionId?: number | null,
>     city?: string | null,
>     cityId?: number | null,
>     cityType?: string,
>     street?: string | null,
>     streetId?: number | null,
>     streetType?: string,
>     building?: string | null,
>     flat?: string | null,
>     floor?: number | null,
>     block?: number | null,
>     house?: string | null,
>     housing?: string,
>     metro?: string | null,
>     notes?: string | null,
>     text?: string,
>     externalId?: string,
>     name?: string
>   } | null,
>   avgMarginSumm?: number | null,
>   marginSumm?: number,
>   totalSumm?: number,
>   averageSumm?: number | null,
>   costSumm?: number | null,
>   ordersCount?: number | null,
>   customFields?: custom[] | {
>   }
> }[]
> ```

***

### getByExternalidContacts.get

`corporateCustomers.getByExternalidContacts.get`

List of contact persons of the corporate customer

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.getByExternalidContacts.get({
	path: { externalId: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string,
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `contacts` | `object[]` | No | — |

> [accordion] contacts full type
>
> ```ts theme={null}
> {
>   isMain?: boolean,
>   id?: number,
>   customer?: {
>     id?: number,
>     externalId?: string,
>     browserId?: string,
>     site?: string
>   } | null,
>   companies?: {
>     id?: number,
>     company?: {
>       id?: number,
>       externalId?: string,
>       name?: string
>     } | null
>   }[]
> }[]
> ```

***

### history.get

`corporateCustomers.history.get`

Getting the corporate customer change history

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.history.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     startDate
>   ]?: string,
>   filter[
>     endDate
>   ]?: string,
>   filter[
>     customerId
>   ]?: number,
>   filter[
>     customerExternalId
>   ]?: string,
>   filter[
>     sinceId
>   ]?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `generatedAt` | `string` | No | Time of response formation |
| `history` | `object[]` | No | — |
| `pagination` | `object` | No | Pagination |

> [accordion] history full type
>
> ```ts theme={null}
> {
>   id?: number,
>   createdAt?: string,
>   created?: boolean,
>   deleted?: boolean,
>   source?: string,
>   user?: {
>     id?: number
>   },
>   field?: string,
>   oldValue?: custom,
>   newValue?: custom,
>   apiKey?: {
>     current?: boolean,
>     id?: number
>   },
>   customer?: {
>     id?: number,
>     externalId?: string,
>     site?: string
>   },
>   address?: {
>     id?: number,
>     externalId?: string,
>     name?: string,
>     isMain?: boolean
>   },
>   combinedTo?: {
>     id?: number,
>     externalId?: string,
>     site?: string
>   },
>   subscription?: {
>     channel?: string,
>     name?: string,
>     code?: string
>   },
>   customerContact?: {
>     id?: number
>   },
>   company?: {
>     id?: number,
>     externalId?: string,
>     name?: string
>   }
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

***

### list.get

`corporateCustomers.list.get`

Getting the list of corporate customers matched the specified filter

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.list.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     externalIds
>   ][]?: string[],
>   filter[
>     name
>   ]?: string,
>   filter[
>     city
>   ]?: string,
>   filter[
>     region
>   ]?: string,
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     managers
>   ][]?: number[],
>   filter[
>     managerGroups
>   ][]?: string[],
>   filter[
>     notes
>   ]?: string,
>   filter[
>     vip
>   ]?: boolean,
>   filter[
>     bad
>   ]?: boolean,
>   filter[
>     discountCardNumber
>   ]?: string,
>   filter[
>     attachments
>   ]?: custom,
>   filter[
>     tasksCounts
>   ]?: custom,
>   filter[
>     email
>   ]?: string,
>   filter[
>     contragentName
>   ]?: string,
>   filter[
>     contragentTypes
>   ][]?: custom[],
>   filter[
>     contragentInn
>   ]?: string,
>   filter[
>     contragentKpp
>   ]?: string,
>   filter[
>     contragentBik
>   ]?: string,
>   filter[
>     contragentCorrAccount
>   ]?: string,
>   filter[
>     contragentBankAccount
>   ]?: string,
>   filter[
>     classSegment
>   ]?: string,
>   filter[
>     minOrdersCount
>   ]?: number,
>   filter[
>     maxOrdersCount
>   ]?: number,
>   filter[
>     minTicketsCount
>   ]?: number,
>   filter[
>     maxTicketsCount
>   ]?: number,
>   filter[
>     minAverageSumm
>   ]?: number,
>   filter[
>     maxAverageSumm
>   ]?: number,
>   filter[
>     minTotalSumm
>   ]?: number,
>   filter[
>     maxTotalSumm
>   ]?: number,
>   filter[
>     minCostSumm
>   ]?: number,
>   filter[
>     maxCostSumm
>   ]?: number,
>   filter[
>     dateFrom
>   ]?: string,
>   filter[
>     dateTo
>   ]?: string,
>   filter[
>     firstOrderFrom
>   ]?: string,
>   filter[
>     firstOrderTo
>   ]?: string,
>   filter[
>     lastOrderFrom
>   ]?: string,
>   filter[
>     lastOrderTo
>   ]?: string,
>   filter[
>     customFields
>   ]?: custom[] | {
>   },
>   filter[
>     nickName
>   ][]?: string[],
>   filter[
>     contactName
>   ]?: string,
>   filter[
>     addressName
>   ]?: string,
>   filter[
>     phone
>   ]?: string,
>   filter[
>     companyCustomFields
>   ][]?: string[],
>   filter[
>     contactIds
>   ][]?: number[],
>   filter[
>     companyName
>   ]?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `customersCorporate` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] customersCorporate full type
>
> ```ts theme={null}
> {
>   type?: string,
>   id?: number,
>   externalId?: string,
>   mainAddress?: {
>     id?: number,
>     externalId?: string,
>     name?: string
>   },
>   createdAt?: string,
>   managerId?: number,
>   vip?: boolean,
>   bad?: boolean,
>   site?: string,
>   tags?: {
>     color?: string,
>     name?: string,
>     colorCode?: string,
>     attached?: boolean
>   }[],
>   firstClientId?: string,
>   lastClientId?: string,
>   customFields?: custom[] | {
>   },
>   personalDiscount?: number,
>   cumulativeDiscount?: number,
>   discountCardNumber?: string | null,
>   avgMarginSumm?: number | null,
>   marginSumm?: number,
>   totalSumm?: number,
>   averageSumm?: number | null,
>   ordersCount?: number | null,
>   ticketsCount?: number,
>   costSumm?: number | null,
>   mainCustomerContact?: {
>     id?: number,
>     customer?: {
>       id?: number,
>       externalId?: string,
>       browserId?: string
>     } | null,
>     companies?: {
>       id?: number,
>       company?: {
>         id?: number,
>         externalId?: string,
>         name?: string
>       } | null
>     }[]
>   },
>   mainCompany?: {
>     id?: number,
>     externalId?: string,
>     name?: string
>   },
>   nickName?: string
> }[]
> ```

***

### notes.get

`corporateCustomers.notes.get`

Getting the notes

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.notes.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ]?: number[],
>   filter[
>     customerIds
>   ]?: number[],
>   filter[
>     customerExternalIds
>   ]?: string[],
>   filter[
>     managerIds
>   ]?: number[],
>   filter[
>     text
>   ]?: string,
>   filter[
>     createdAtFrom
>   ]?: string,
>   filter[
>     createdAtTo
>   ]?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `notes` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] notes full type
>
> ```ts theme={null}
> {
>   customer?: {
>     site?: string,
>     id?: number,
>     externalId?: string,
>     type?: string
>   },
>   managerId?: number,
>   id?: number,
>   text?: string,
>   createdAt?: string
> }[]
> ```

***

### notesByIdDelete.post

`corporateCustomers.notesByIdDelete.post`

Note removing

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.notesByIdDelete.post({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### notesCreate.post

`corporateCustomers.notesCreate.post`

Note creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.notesCreate.post({
	body: {
		note: { managerId: 1 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   note?: {
>     managerId?: number,
>     text?: string,
>     customer?: {
>       id?: number,
>       externalId?: string
>     } | null
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created note |

***

### upload.post

`corporateCustomers.upload.post`

Packet corporate customers uploading

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.corporateCustomers.upload.post({
	body: { site: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   customersCorporate?: {
>     externalId?: string,
>     createdAt?: string,
>     vip?: boolean,
>     bad?: boolean,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     discountCardNumber?: string | null,
>     nickName?: string,
>     managerId?: number,
>     customerContacts?: {
>       isMain?: boolean,
>       customer?: {
>         id?: number,
>         externalId?: string,
>         browserId?: string,
>         site?: string
>       },
>       companies?: {
>         company?: {
>           id?: number,
>           externalId?: string
>         }
>       }[]
>     }[],
>     companies?: {
>       isMain?: boolean,
>       externalId?: string,
>       active?: boolean,
>       name?: string,
>       brand?: string,
>       site?: string,
>       createdAt?: string,
>       contragent?: {
>         contragentType?: string | null,
>         legalName?: string,
>         legalAddress?: string,
>         INN?: string,
>         OKPO?: string,
>         KPP?: string,
>         OGRN?: string,
>         OGRNIP?: string,
>         certificateNumber?: string,
>         certificateDate?: string | null,
>         BIK?: string,
>         bank?: string,
>         bankAddress?: string,
>         corrAccount?: string,
>         bankAccount?: string
>       },
>       customFields?: custom[] | {
>       },
>       address?: {
>         id?: number,
>         externalId?: string
>       }
>     }[],
>     addresses?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     }[]
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `uploadedCustomers` | `object[]` | No | — |
| `failedCustomers` | `object[]` | No | — |

> [accordion] uploadedCustomers full type
>
> ```ts theme={null}
> {
>   id: number,
>   externalId: string
> }[]
> ```

> [accordion] failedCustomers full type
>
> ```ts theme={null}
> {
>   externalId?: string
> }[]
> ```

***

## Cost

### byIdDelete.post

`cost.byIdDelete.post`

Cost removing

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.cost.byIdDelete.post({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### byIdEdit.post

`cost.byIdEdit.post`

Cost editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.cost.byIdEdit.post({
	path: { id: '17' },
	body: {
		cost: { dateFrom: '2025-01-01' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   cost?: {
>     dateFrom?: string | null,
>     dateTo?: string | null,
>     summ?: number | null,
>     comment?: string,
>     costItem?: string,
>     order?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     } | null,
>     userId?: number,
>     sites?: custom[] | {
>     },
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     } | null
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Cost ID |

***

### create.post

`cost.create.post`

Creation of the cost

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.cost.create.post({
	body: {
		cost: { dateFrom: '2025-01-01' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   cost?: {
>     dateFrom?: string | null,
>     dateTo?: string | null,
>     summ?: number | null,
>     comment?: string,
>     costItem?: string,
>     order?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     } | null,
>     userId?: number,
>     sites?: custom[] | {
>     },
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     } | null
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | ID of created cost |

***

### delete.post

`cost.delete.post`

Batch removing of costs

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.cost.delete.post({
	body: {
		ids: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ids?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `count` | `number` | No | Quantity of removed costs |
| `notRemovedIds` | `number[]` | No | Identifiers of not removed costs |

***

### getById.get

`cost.getById.get`

Getting of cost information

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.cost.getById.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `cost` | `object` | No | Cost |

> [accordion] cost full type
>
> ```ts theme={null}
> {
>   currency?: string,
>   source?: {
>     source?: string,
>     medium?: string,
>     campaign?: string,
>     keyword?: string,
>     content?: string
>   },
>   id?: number,
>   dateFrom?: string | null,
>   dateTo?: string | null,
>   summ?: number | null,
>   costItem?: string,
>   comment?: string,
>   createdAt?: string,
>   createdBy?: string,
>   order?: {
>     id?: number,
>     number?: string,
>     externalId?: string
>   },
>   userId?: number,
>   sites?: string[]
> }
> ```

***

### list.get

`cost.list.get`

Getting of the cost list, adequate for the given filter

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.cost.list.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     costItems
>   ][]?: string[],
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     createdBy
>   ][]?: number[],
>   filter[
>     orderNumber
>   ]?: string,
>   filter[
>     costGroups
>   ][]?: string[],
>   filter[
>     users
>   ][]?: number[],
>   filter[
>     comment
>   ]?: string,
>   filter[
>     orderIds
>   ][]?: number[],
>   filter[
>     orderExternalIds
>   ][]?: string[],
>   filter[
>     createdAtFrom
>   ]?: string,
>   filter[
>     createdAtTo
>   ]?: string,
>   filter[
>     dateFrom
>   ]?: string,
>   filter[
>     dateTo
>   ]?: string,
>   filter[
>     minSumm
>   ]?: number,
>   filter[
>     maxSumm
>   ]?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `costs` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] costs full type
>
> ```ts theme={null}
> {
>   currency?: string,
>   source?: {
>     source?: string,
>     medium?: string,
>     campaign?: string,
>     keyword?: string,
>     content?: string
>   },
>   id?: number,
>   dateFrom?: string | null,
>   dateTo?: string | null,
>   summ?: number | null,
>   costItem?: string,
>   comment?: string,
>   createdAt?: string,
>   createdBy?: string,
>   order?: {
>     id?: number,
>     number?: string,
>     externalId?: string
>   },
>   userId?: number,
>   sites?: string[]
> }[]
> ```

***

### upload.post

`cost.upload.post`

Batch loading of costs

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.cost.upload.post({
	body: {
		costs: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   costs?: {
>     dateFrom?: string | null,
>     dateTo?: string | null,
>     summ?: number | null,
>     comment?: string,
>     costItem?: string,
>     order?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     } | null,
>     userId?: number,
>     sites?: custom[] | {
>     },
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     } | null
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `uploadedCosts` | `number[]` | No | Identifiers of uploaded costs |

***

## Customer Interaction

### cartBySiteClear.post

`customerInteraction.cartBySiteClear.post`

Cleaning the current cart of the customer

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.customerInteraction.cartBySiteClear.post({
	path: { site: 'demo' },
	body: {
		cart: { clearedAt: '2025-01-01 12:00:00+00:00' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   site: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   siteBy?: custom
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   cart?: {
>     clearedAt?: string,
>     customer?: {
>       id?: number,
>       externalId?: string,
>       browserId?: string,
>       gaClientId?: string
>     },
>     order?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### cartBySiteSet.post

`customerInteraction.cartBySiteSet.post`

Creating or overwriting cart data

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customerInteraction.cartBySiteSet.post({
	path: { site: 'demo' },
	body: {
		cart: { externalId: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   site: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   siteBy?: custom
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   cart?: {
>     externalId?: string,
>     droppedAt?: string,
>     link?: string,
>     customer?: {
>       id?: number,
>       externalId?: string,
>       browserId?: string,
>       site?: string,
>       gaClientId?: string
>     },
>     items?: {
>       price?: number,
>       quantity: number,
>       offer: {
>         id?: number,
>         externalId?: string,
>         xmlId?: string
>       }
>     }[]
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### favoritesBySiteByCustomeridAdd.post

`customerInteraction.favoritesBySiteByCustomeridAdd.post`

Adding a product offer to the customer's list of favorites

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customerInteraction.favoritesBySiteByCustomeridAdd.post({
	path: { site: 'demo', customerId: 'demo' },
	body: {
		favorite: {
			offer: { id: 1 },
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   site: unknown,
>   customerId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   siteBy?: custom
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   favorite?: {
>     offer: {
>       id?: number,
>       externalId?: string,
>       xmlId?: string
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### favoritesBySiteByCustomeridRemove.post

`customerInteraction.favoritesBySiteByCustomeridRemove.post`

Deleting a product offer from the customer's list of favorites

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customerInteraction.favoritesBySiteByCustomeridRemove.post({
	path: { site: 'demo', customerId: 'demo' },
	body: {
		favorite: {
			offer: { id: 1 },
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   site: unknown,
>   customerId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   siteBy?: custom
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   favorite?: {
>     offer: {
>       id?: number,
>       externalId?: string,
>       xmlId?: string
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### getCartBySiteByCustomerid.get

`customerInteraction.getCartBySiteByCustomerid.get`

Getting the current cart of the customer

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.customerInteraction.getCartBySiteByCustomerid.get({
	path: { customerId: 'demo', site: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   customerId: unknown,
>   site: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   siteBy?: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `cart` | `object` | No | Cart |

> [accordion] cart full type
>
> ```ts theme={null}
> {
>   currency?: string,
>   externalId?: string,
>   droppedAt?: string,
>   clearedAt?: string,
>   link?: string,
>   items?: {
>     id?: number,
>     offer?: {
>       displayName?: string,
>       id?: number | null,
>       externalId?: string,
>       xmlId?: string,
>       name: string,
>       article?: string,
>       vatRate?: string,
>       properties?: custom[] | {
>       },
>       unit?: {
>         code?: string,
>         name?: string,
>         sym?: string
>       },
>       barcode?: string
>     } | null,
>     quantity?: number,
>     price?: number
>   }[]
> }
> ```

***

### getFavoritesBySiteByCustomerid.get

`customerInteraction.getFavoritesBySiteByCustomerid.get`

Getting a list of favorites for the customer

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.customerInteraction.getFavoritesBySiteByCustomerid.get({
	path: { site: 'demo', customerId: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   site: unknown,
>   customerId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   siteBy?: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `favorites` | `object[]` | No | — |

> [accordion] favorites full type
>
> ```ts theme={null}
> {
>   offer?: {
>     displayName?: string,
>     id?: number | null,
>     externalId?: string,
>     xmlId?: string,
>     name: string,
>     article?: string,
>     vatRate?: string,
>     properties?: custom[] | {
>     },
>     unit?: {
>       code?: string,
>       name?: string,
>       sym?: string
>     },
>     barcode?: string
>   } | null,
>   createdAt?: string
> }[]
> ```

***

## Customers

### byExternalidEdit.post

`customers.byExternalidEdit.post`

Customer editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customers.byExternalidEdit.post({
	path: { externalId: 'demo' },
	body: {
		customer: { externalId: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   by?: string,
>   site?: string,
>   customer?: {
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     vip?: boolean,
>     bad?: boolean,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     discountCardNumber?: string | null,
>     address?: {
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string
>     } | null,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     photoUrl?: string,
>     managerId?: number,
>     sex?: string,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomerId?: {
>     },
>     subscribed?: boolean,
>     addTags?: string[],
>     removeTags?: string[],
>     tags?: string[],
>     attachedTag?: string,
>     browserId?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Customer internal ID |
| `state` | `string \| null` | No | Customer customer (not returned by default) |

***

### byExternalidSubscriptions.post

`customers.byExternalidSubscriptions.post`

Subscribe/unsubscribe customer to mailings

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customers.byExternalidSubscriptions.post({
	path: { externalId: 'demo' },
	body: { by: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   by?: string,
>   site?: string,
>   subscriptions?: {
>     channel: custom,
>     subscription?: string,
>     active: boolean,
>     messageId?: number
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### combine.post

`customers.combine.post`

Combining of customers

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.customers.combine.post({
	body: {
		customers: [{ id: 2 }],
		resultCustomer: { id: 1 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   customers?: {
>     id: number
>   }[],
>   resultCustomer: {
>     id: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### create.post

`customers.create.post`

Customer creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customers.create.post({
	body: {
		customer: { externalId: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   customer?: {
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     vip?: boolean,
>     bad?: boolean,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     discountCardNumber?: string | null,
>     address?: {
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string
>     } | null,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     photoUrl?: string,
>     managerId?: number,
>     sex?: string,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomerId?: {
>     },
>     subscribed?: boolean,
>     tags?: string[],
>     attachedTag?: string,
>     browserId?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created customer |

***

### fixExternalIds.post

`customers.fixExternalIds.post`

The mass recording of customers external ID

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customers.fixExternalIds.post({
	body: {
		customers: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   customers?: {
>     id: number,
>     externalId: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### getByExternalid.get

`customers.getByExternalid.get`

Getting information on customer

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.customers.getByExternalid.get({
	path: { externalId: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `customer` | `object` | No | Customer |

> [accordion] customer full type
>
> ```ts theme={null}
> {
>   type?: string,
>   id?: number,
>   externalId?: string,
>   isContact?: boolean,
>   createdAt?: string,
>   managerId?: number,
>   vip?: boolean,
>   bad?: boolean,
>   site?: string,
>   contragent?: {
>     contragentType?: string | null,
>     legalName?: string,
>     legalAddress?: string,
>     INN?: string,
>     OKPO?: string,
>     KPP?: string,
>     OGRN?: string,
>     OGRNIP?: string,
>     certificateNumber?: string,
>     certificateDate?: string | null,
>     BIK?: string,
>     bank?: string,
>     bankAddress?: string,
>     corrAccount?: string,
>     bankAccount?: string
>   },
>   tags?: {
>     color?: string,
>     name?: string,
>     colorCode?: string,
>     attached?: boolean
>   }[],
>   firstClientId?: string,
>   lastClientId?: string,
>   customFields?: custom[] | {
>   },
>   personalDiscount?: number,
>   cumulativeDiscount?: number,
>   discountCardNumber?: string | null,
>   avgMarginSumm?: number | null,
>   marginSumm?: number,
>   totalSumm?: number,
>   averageSumm?: number | null,
>   ordersCount?: number | null,
>   ticketsCount?: number,
>   costSumm?: number | null,
>   address?: {
>     id?: number,
>     index?: string | null,
>     countryIso?: string | null,
>     region?: string | null,
>     regionId?: number | null,
>     city?: string | null,
>     cityId?: number | null,
>     cityType?: string,
>     street?: string | null,
>     streetId?: number | null,
>     streetType?: string,
>     building?: string | null,
>     flat?: string | null,
>     floor?: number | null,
>     block?: number | null,
>     house?: string | null,
>     housing?: string,
>     metro?: string | null,
>     notes?: string | null,
>     text?: string,
>     externalId?: string,
>     name?: string
>   },
>   segments?: {
>     id?: number,
>     code?: string,
>     name?: string,
>     createdAt?: string,
>     isDynamic?: boolean,
>     customersCount?: number,
>     active?: boolean
>   }[],
>   maturationTime?: number,
>   firstName?: string | null,
>   lastName?: string | null,
>   patronymic?: string | null,
>   sex?: string,
>   presumableSex?: string,
>   email?: string | null,
>   emailMarketingUnsubscribedAt?: string,
>   customerSubscriptions?: {
>     subscription?: {
>       id?: number,
>       channel?: string,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       autoSubscribe?: boolean,
>       ordering?: number
>     },
>     subscribed?: boolean,
>     changedAt?: string
>   }[],
>   phones?: {
>     number?: string | null
>   }[],
>   birthday?: string | null,
>   source?: {
>     source?: string,
>     medium?: string,
>     campaign?: string,
>     keyword?: string,
>     content?: string
>   },
>   mgCustomers?: {
>     id?: number,
>     externalId?: number,
>     mgChannel?: {
>       allowedSendByPhone?: boolean,
>       id?: number | null,
>       externalId?: number,
>       type?: string,
>       active?: boolean,
>       name?: string
>     }
>   }[],
>   photoUrl?: string
> }
> ```

***

### history.get

`customers.history.get`

Getting the customer change history

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.customers.history.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     startDate
>   ]?: string,
>   filter[
>     endDate
>   ]?: string,
>   filter[
>     customerId
>   ]?: number,
>   filter[
>     customerExternalId
>   ]?: string,
>   filter[
>     sinceId
>   ]?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `generatedAt` | `string` | No | Time of response formation |
| `history` | `object[]` | No | — |
| `pagination` | `object` | No | Pagination |

> [accordion] history full type
>
> ```ts theme={null}
> {
>   id?: number,
>   createdAt?: string,
>   created?: boolean,
>   deleted?: boolean,
>   source?: string,
>   user?: {
>     id?: number
>   },
>   field?: string,
>   oldValue?: custom,
>   newValue?: custom,
>   apiKey?: {
>     current?: boolean,
>     id?: number
>   },
>   customer?: {
>     id?: number,
>     externalId?: string,
>     site?: string
>   },
>   address?: {
>     id?: number,
>     externalId?: string,
>     name?: string,
>     isMain?: boolean
>   },
>   combinedTo?: {
>     id?: number,
>     externalId?: string,
>     site?: string
>   },
>   subscription?: {
>     channel?: string,
>     name?: string,
>     code?: string
>   }
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

***

### list.get

`customers.list.get`

Getting the list of customers matched the specified filter

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.customers.list.get({
	query: { filter[subscriptions][channel]: 'email', filter[subscriptions][subscribed]: false },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     externalIds
>   ][]?: string[],
>   filter[
>     name
>   ]?: string,
>   filter[
>     city
>   ]?: string,
>   filter[
>     region
>   ]?: string,
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     managers
>   ][]?: number[],
>   filter[
>     managerGroups
>   ][]?: string[],
>   filter[
>     notes
>   ]?: string,
>   filter[
>     vip
>   ]?: boolean,
>   filter[
>     bad
>   ]?: boolean,
>   filter[
>     discountCardNumber
>   ]?: string,
>   filter[
>     attachments
>   ]?: custom,
>   filter[
>     tasksCounts
>   ]?: custom,
>   filter[
>     email
>   ]?: string,
>   filter[
>     contragentName
>   ]?: string,
>   filter[
>     contragentTypes
>   ][]?: custom[],
>   filter[
>     contragentInn
>   ]?: string,
>   filter[
>     contragentKpp
>   ]?: string,
>   filter[
>     contragentBik
>   ]?: string,
>   filter[
>     contragentCorrAccount
>   ]?: string,
>   filter[
>     contragentBankAccount
>   ]?: string,
>   filter[
>     classSegment
>   ]?: string,
>   filter[
>     minOrdersCount
>   ]?: number,
>   filter[
>     maxOrdersCount
>   ]?: number,
>   filter[
>     minTicketsCount
>   ]?: number,
>   filter[
>     maxTicketsCount
>   ]?: number,
>   filter[
>     minAverageSumm
>   ]?: number,
>   filter[
>     maxAverageSumm
>   ]?: number,
>   filter[
>     minTotalSumm
>   ]?: number,
>   filter[
>     maxTotalSumm
>   ]?: number,
>   filter[
>     minCostSumm
>   ]?: number,
>   filter[
>     maxCostSumm
>   ]?: number,
>   filter[
>     dateFrom
>   ]?: string,
>   filter[
>     dateTo
>   ]?: string,
>   filter[
>     firstOrderFrom
>   ]?: string,
>   filter[
>     firstOrderTo
>   ]?: string,
>   filter[
>     lastOrderFrom
>   ]?: string,
>   filter[
>     lastOrderTo
>   ]?: string,
>   filter[
>     customFields
>   ]?: custom[] | {
>   },
>   filter[
>     sex
>   ]?: custom,
>   filter[
>     isContact
>   ]?: boolean,
>   filter[
>     subscriptions
>   ][
>     channel
>   ]?: custom,
>   filter[
>     subscriptions
>   ][
>     subscription
>   ]?: string,
>   filter[
>     subscriptions
>   ][
>     subscribed
>   ]?: boolean,
>   filter[
>     online
>   ]?: boolean,
>   filter[
>     segment
>   ]?: string,
>   filter[
>     commentary
>   ]?: string,
>   filter[
>     browserId
>   ]?: string,
>   filter[
>     mgChannels
>   ][]?: number[],
>   filter[
>     sourceName
>   ]?: string,
>   filter[
>     mediumName
>   ]?: string,
>   filter[
>     campaignName
>   ]?: string,
>   filter[
>     keywordName
>   ]?: string,
>   filter[
>     adContentName
>   ]?: string,
>   filter[
>     tags
>   ][]?: string[],
>   filter[
>     attachedTags
>   ][]?: string[],
>   filter[
>     countries
>   ][]?: string[],
>   filter[
>     abandonedCart
>   ]?: boolean,
>   filter[
>     emailMarketingUnsubscribed
>   ]?: boolean,
>   filter[
>     mgCustomerId
>   ]?: number,
>   filter[
>     firstWebVisitFrom
>   ]?: string,
>   filter[
>     firstWebVisitTo
>   ]?: string,
>   filter[
>     lastWebVisitFrom
>   ]?: string,
>   filter[
>     lastWebVisitTo
>   ]?: string,
>   filter[
>     birthdayFrom
>   ]?: string,
>   filter[
>     birthdayTo
>   ]?: string,
>   filter[
>     minAge
>   ]?: number,
>   filter[
>     maxAge
>   ]?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `customers` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] customers full type
>
> ```ts theme={null}
> {
>   type?: string,
>   id?: number,
>   externalId?: string,
>   isContact?: boolean,
>   createdAt?: string,
>   managerId?: number,
>   vip?: boolean,
>   bad?: boolean,
>   site?: string,
>   contragent?: {
>     contragentType?: string | null,
>     legalName?: string,
>     legalAddress?: string,
>     INN?: string,
>     OKPO?: string,
>     KPP?: string,
>     OGRN?: string,
>     OGRNIP?: string,
>     certificateNumber?: string,
>     certificateDate?: string | null,
>     BIK?: string,
>     bank?: string,
>     bankAddress?: string,
>     corrAccount?: string,
>     bankAccount?: string
>   },
>   tags?: {
>     color?: string,
>     name?: string,
>     colorCode?: string,
>     attached?: boolean
>   }[],
>   firstClientId?: string,
>   lastClientId?: string,
>   customFields?: custom[] | {
>   },
>   personalDiscount?: number,
>   cumulativeDiscount?: number,
>   discountCardNumber?: string | null,
>   avgMarginSumm?: number | null,
>   marginSumm?: number,
>   totalSumm?: number,
>   averageSumm?: number | null,
>   ordersCount?: number | null,
>   ticketsCount?: number,
>   costSumm?: number | null,
>   address?: {
>     id?: number,
>     index?: string | null,
>     countryIso?: string | null,
>     region?: string | null,
>     regionId?: number | null,
>     city?: string | null,
>     cityId?: number | null,
>     cityType?: string,
>     street?: string | null,
>     streetId?: number | null,
>     streetType?: string,
>     building?: string | null,
>     flat?: string | null,
>     floor?: number | null,
>     block?: number | null,
>     house?: string | null,
>     housing?: string,
>     metro?: string | null,
>     notes?: string | null,
>     text?: string,
>     externalId?: string,
>     name?: string
>   },
>   segments?: {
>     id?: number,
>     code?: string,
>     name?: string,
>     createdAt?: string,
>     isDynamic?: boolean,
>     customersCount?: number,
>     active?: boolean
>   }[],
>   maturationTime?: number,
>   firstName?: string | null,
>   lastName?: string | null,
>   patronymic?: string | null,
>   sex?: string,
>   presumableSex?: string,
>   email?: string | null,
>   emailMarketingUnsubscribedAt?: string,
>   customerSubscriptions?: {
>     subscription?: {
>       id?: number,
>       channel?: string,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       autoSubscribe?: boolean,
>       ordering?: number
>     },
>     subscribed?: boolean,
>     changedAt?: string
>   }[],
>   phones?: {
>     number?: string | null
>   }[],
>   birthday?: string | null,
>   source?: {
>     source?: string,
>     medium?: string,
>     campaign?: string,
>     keyword?: string,
>     content?: string
>   },
>   mgCustomers?: {
>     id?: number,
>     externalId?: number,
>     mgChannel?: {
>       allowedSendByPhone?: boolean,
>       id?: number | null,
>       externalId?: number,
>       type?: string,
>       active?: boolean,
>       name?: string
>     }
>   }[],
>   photoUrl?: string
> }[]
> ```

***

### notes.get

`customers.notes.get`

Getting the notes

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.customers.notes.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ]?: number[],
>   filter[
>     customerIds
>   ]?: number[],
>   filter[
>     customerExternalIds
>   ]?: string[],
>   filter[
>     managerIds
>   ]?: number[],
>   filter[
>     text
>   ]?: string,
>   filter[
>     createdAtFrom
>   ]?: string,
>   filter[
>     createdAtTo
>   ]?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `notes` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] notes full type
>
> ```ts theme={null}
> {
>   customer?: {
>     site?: string,
>     id?: number,
>     externalId?: string,
>     type?: string
>   },
>   managerId?: number,
>   id?: number,
>   text?: string,
>   createdAt?: string
> }[]
> ```

***

### notesByIdDelete.post

`customers.notesByIdDelete.post`

Note removing

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.customers.notesByIdDelete.post({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### notesCreate.post

`customers.notesCreate.post`

Note creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customers.notesCreate.post({
	body: {
		note: { managerId: 1 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   note?: {
>     managerId?: number,
>     text?: string,
>     customer?: {
>       id?: number,
>       externalId?: string
>     } | null
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created note |

***

### pushTokens.get

`customers.pushTokens.get`

Get customer mobile app push token data

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.customers.pushTokens.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   token?: string,
>   fid?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pushTokens` | `object[]` | No | — |

> [accordion] pushTokens full type
>
> ```ts theme={null}
> {
>   customer?: {
>     id?: number,
>     externalId?: string,
>     browserId?: string
>   },
>   deviceType?: string,
>   id?: number,
>   categories?: {
>     id?: number,
>     name?: string,
>     code?: string,
>     active?: boolean,
>     createdAt?: string
>   }[],
>   createdAt?: string
> }[]
> ```

***

### pushTokensBatch.post

`customers.pushTokensBatch.post`

Batch create/edit customer mobile app push tokens

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customers.pushTokensBatch.post({
	body: {
		pushTokens: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   pushTokens?: {
>     customer: {
>       id?: number,
>       externalId?: string,
>       browserId?: string,
>       site?: string
>     },
>     token?: string,
>     fid?: string,
>     type: string,
>     deviceType: custom,
>     categories?: string[]
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pushTokens` | `object[]` | No | — |

> [accordion] pushTokens full type
>
> ```ts theme={null}
> {
>   customer?: {
>     id?: number,
>     externalId?: string,
>     browserId?: string
>   },
>   deviceType?: string,
>   id?: number,
>   categories?: {
>     id?: number,
>     name?: string,
>     code?: string,
>     active?: boolean,
>     createdAt?: string
>   }[],
>   createdAt?: string
> }[]
> ```

***

### upload.post

`customers.upload.post`

Packet customers uploading

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customers.upload.post({
	body: { site: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   customers?: {
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     vip?: boolean,
>     bad?: boolean,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     discountCardNumber?: string | null,
>     address?: {
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string
>     } | null,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     photoUrl?: string,
>     managerId?: number,
>     sex?: string,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomerId?: {
>     },
>     subscribed?: boolean,
>     tags?: string[],
>     attachedTag?: string,
>     browserId?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `uploadedCustomers` | `object[]` | No | — |
| `failedCustomers` | `object[]` | No | — |

> [accordion] uploadedCustomers full type
>
> ```ts theme={null}
> {
>   id: number,
>   externalId: string
> }[]
> ```

> [accordion] failedCustomers full type
>
> ```ts theme={null}
> {
>   externalId?: string
> }[]
> ```

***

## Custom Fields

### byEntityByCodeEdit.post

`customFields.byEntityByCodeEdit.post`

Custom fields editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customFields.byEntityByCodeEdit.post({
	path: { entity: 'order', code: 'demo' },
	body: {
		customField: { name: 'demo', ordering: 0 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   entity: unknown,
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   customField?: {
>     name: string & string,
>     required?: boolean,
>     inFilter?: boolean,
>     inList?: boolean,
>     inGroupActions?: boolean,
>     entity?: string,
>     default?: string | null,
>     ordering: number & number,
>     displayArea?: string & custom,
>     viewMode?: string & custom,
>     viewModeMobile?: string & custom,
>     defaultTyped?: custom
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `code` | `string` | No | Symbolic code |

***

### byEntityCreate.post

`customFields.byEntityCreate.post`

Custom fields creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customFields.byEntityCreate.post({
	path: { entity: 'order' },
	body: {
		customField: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   entity: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   customField?: {
>     name?: string,
>     code?: string,
>     required?: boolean,
>     inFilter?: boolean,
>     inList?: boolean,
>     inGroupActions?: boolean,
>     type?: string | null,
>     entity?: string,
>     default?: string | null,
>     ordering?: number,
>     displayArea?: string,
>     viewMode?: string,
>     viewModeMobile?: string,
>     dictionary?: string,
>     defaultTyped?: custom
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `code` | `string` | No | Symbolic code |

***

### dictionaries.get

`customFields.dictionaries.get`

Getting the list of custom directory

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.customFields.dictionaries.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     name
>   ]?: string,
>   filter[
>     code
>   ]?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `customDictionaries` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] customDictionaries full type
>
> ```ts theme={null}
> {
>   name: string,
>   code?: string | null,
>   elements: {
>     name: string,
>     code?: string,
>     ordering?: number
>   }[]
> }[]
> ```

***

### dictionariesByCodeEdit.post

`customFields.dictionariesByCodeEdit.post`

Directory fields editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customFields.dictionariesByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		customDictionary: {
			name: 'demo',
			elements: [],
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   customDictionary?: {
>     name: string & string,
>     elements: {
>       name: string,
>       code?: string,
>       ordering?: number
>     }[]& {
>       name: string,
>       code?: string,
>       ordering?: number
>     }[]
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `code` | `string` | No | Symbolic code |

***

### dictionariesCreate.post

`customFields.dictionariesCreate.post`

Directory fields creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.customFields.dictionariesCreate.post({
	body: {
		customDictionary: {
			name: 'demo',
			elements: [],
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   customDictionary?: {
>     name: string,
>     code?: string | null,
>     elements: {
>       name: string,
>       code?: string,
>       ordering?: number
>     }[]
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `code` | `string` | No | Symbolic code |

***

### getByEntityByCode.get

`customFields.getByEntityByCode.get`

Getting information on custom fields

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.customFields.getByEntityByCode.get({
	path: { entity: 'order', code: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   entity: unknown,
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `customField` | `object` | No | Custom field |

> [accordion] customField full type
>
> ```ts theme={null}
> {
>   name?: string,
>   code?: string,
>   required?: boolean,
>   inFilter?: boolean,
>   inList?: boolean,
>   inGroupActions?: boolean,
>   type?: string | null,
>   entity?: string,
>   default?: string | null,
>   ordering?: number,
>   displayArea?: string,
>   viewMode?: string,
>   viewModeMobile?: string,
>   dictionary?: string,
>   defaultTyped?: custom
> }
> ```

***

### getDictionariesByCode.get

`customFields.getDictionariesByCode.get`

Getting information on directory

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.customFields.getDictionariesByCode.get({
	path: { code: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `customDictionary` | `object` | No | Directory |

> [accordion] customDictionary full type
>
> ```ts theme={null}
> {
>   name: string,
>   code?: string | null,
>   elements: {
>     name: string,
>     code?: string,
>     ordering?: number
>   }[]
> }
> ```

***

### list.get

`customFields.list.get`

Getting the list of custom fields

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.customFields.list.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     name
>   ]?: string,
>   filter[
>     code
>   ]?: string,
>   filter[
>     type
>   ]?: custom,
>   filter[
>     viewMode
>   ]?: custom,
>   filter[
>     viewModeMobile
>   ]?: custom,
>   filter[
>     entity
>   ]?: custom,
>   filter[
>     displayArea
>   ]?: custom,
>   filter[
>     inFilter
>   ]?: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `customFields` | `object[]` | No | Custom fields |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] customFields full type
>
> ```ts theme={null}
> {
>   name?: string,
>   code?: string,
>   required?: boolean,
>   inFilter?: boolean,
>   inList?: boolean,
>   inGroupActions?: boolean,
>   type?: string | null,
>   entity?: string,
>   default?: string | null,
>   ordering?: number,
>   displayArea?: string,
>   viewMode?: string,
>   viewModeMobile?: string,
>   dictionary?: string,
>   defaultTyped?: custom
> }[]
> ```

***

## Data Book

### getReferenceSitesByCodeTracker.get

`dataBook.getReferenceSitesByCodeTracker.get`

Getting store tracker settings

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.getReferenceSitesByCodeTracker.get({
	path: { code: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `tracker` | `object` | No | — |

> [accordion] tracker full type
>
> ```ts theme={null}
> {
>   active?: boolean,
>   token?: string | null,
>   useCookieConsent?: boolean | null,
>   useGpc?: boolean | null
> }
> ```

***

### referenceCostGroups.get

`dataBook.referenceCostGroups.get`

Getting of the costs groups list

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceCostGroups.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `costGroups` | `object[]` | No | — |

> [accordion] costGroups full type
>
> ```ts theme={null}
> {
>   code?: string,
>   name?: string,
>   ordering?: number,
>   active?: boolean,
>   color?: string
> }[]
> ```

***

### referenceCostGroupsByCodeEdit.post

`dataBook.referenceCostGroupsByCodeEdit.post`

Editing costs groups

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceCostGroupsByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		costGroup: {
			code: 'demo',
			name: 'demo',
			ordering: 0,
			color: '#ffd298',
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   costGroup?: {
>     code: string,
>     name: string,
>     ordering: number,
>     active?: boolean,
>     color: custom
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceCostItems.get

`dataBook.referenceCostItems.get`

Getting of the costs items list

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceCostItems.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `costItems` | `object[]` | No | — |

> [accordion] costItems full type
>
> ```ts theme={null}
> {
>   source?: {
>     source?: string,
>     medium?: string,
>     campaign?: string,
>     keyword?: string,
>     content?: string
>   },
>   code?: string,
>   name?: string,
>   group?: string,
>   ordering?: number,
>   active?: boolean,
>   appliesToOrders?: boolean,
>   type?: string,
>   appliesToUsers?: boolean
> }[]
> ```

***

### referenceCostItemsByCodeEdit.post

`dataBook.referenceCostItemsByCodeEdit.post`

Editing costs items

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceCostItemsByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		costItem: { code: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   costItem?: {
>     code?: string,
>     name?: string,
>     ordering?: number,
>     active?: boolean,
>     appliesToOrders?: boolean,
>     appliesToUsers?: boolean,
>     group?: string,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     } | null,
>     type?: custom
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceCountries.get

`dataBook.referenceCountries.get`

Getting the list of available country codes

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceCountries.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `countriesIso` | `string[]` | No | List of ISO 3166-1 alpha-2 codes of active countries |

***

### referenceCouriers.get

`dataBook.referenceCouriers.get`

Getting the list of couriers

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceCouriers.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `couriers` | `object[]` | No | — |

> [accordion] couriers full type
>
> ```ts theme={null}
> {
>   id?: number,
>   firstName?: string,
>   lastName?: string,
>   patronymic?: string,
>   active?: boolean,
>   email?: string,
>   phone?: {
>     number?: string | null
>   },
>   description?: string
> }[]
> ```

***

### referenceCouriersByIdEdit.post

`dataBook.referenceCouriersByIdEdit.post`

Courier editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceCouriersByIdEdit.post({
	path: { id: '17' },
	body: {
		courier: { firstName: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

The official OpenAPI marks `courier.firstName` required but omits its type and constraints; the plugin enforces its presence, while the value shape is unverified.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   courier?: {
>     firstName: string,
>     lastName?: string,
>     patronymic?: string,
>     active?: boolean,
>     email?: string,
>     phone?: {
>       number?: string | null
>     },
>     description?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceCouriersCreate.post

`dataBook.referenceCouriersCreate.post`

Courier creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceCouriersCreate.post({
	body: {
		courier: { firstName: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

The official OpenAPI marks `courier.firstName` required but omits its type and constraints; the plugin enforces its presence, while the value shape is unverified.

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   courier?: {
>     firstName: string,
>     lastName?: string,
>     patronymic?: string,
>     active?: boolean,
>     email?: string,
>     phone?: {
>       number?: string | null
>     },
>     description?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### referenceCurrencies.get

`dataBook.referenceCurrencies.get`

Getting the list of currencies

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceCurrencies.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `currencies` | `object[]` | No | — |

> [accordion] currencies full type
>
> ```ts theme={null}
> {
>   id?: number,
>   code?: string | null,
>   isBase?: boolean,
>   isAutoConvert?: boolean,
>   autoConvertExtraPercent?: number,
>   manualConvertNominal?: number,
>   manualConvertValue?: number
> }[]
> ```

***

### referenceCurrenciesByIdEdit.post

`dataBook.referenceCurrenciesByIdEdit.post`

Currency editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceCurrenciesByIdEdit.post({
	path: { id: '17' },
	body: {
		currency: { code: 'USD' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   currency?: {
>     code: string & (string | null),
>     isAutoConvert?: boolean,
>     autoConvertExtraPercent?: number,
>     manualConvertNominal?: custom,
>     manualConvertValue?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceCurrenciesCreate.post

`dataBook.referenceCurrenciesCreate.post`

Currency creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceCurrenciesCreate.post({
	body: {
		currency: { code: 'USD' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   currency?: {
>     code: string & (string | null),
>     isAutoConvert?: boolean,
>     autoConvertExtraPercent?: number,
>     manualConvertNominal?: custom,
>     manualConvertValue?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### referenceDeliveryServices.get

`dataBook.referenceDeliveryServices.get`

Getting the list of delivery services

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceDeliveryServices.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `deliveryServices` | `object` | No | — |

> [accordion] deliveryServices full type
>
> ```ts theme={null}
> {
> }
> ```

***

### referenceDeliveryServicesByCodeEdit.post

`dataBook.referenceDeliveryServicesByCodeEdit.post`

Delivery service creation/editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceDeliveryServicesByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		deliveryService: { name: 'demo', code: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   deliveryService?: {
>     name: string | null,
>     code: string | null,
>     active?: boolean,
>     deliveryType?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceDeliveryTypes.get

`dataBook.referenceDeliveryTypes.get`

Getting the list of delivery types

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceDeliveryTypes.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   filter[
>     codes
>   ][]?: string[],
>   includeCostSettings?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `deliveryTypes` | `object` | No | — |

> [accordion] deliveryTypes full type
>
> ```ts theme={null}
> {
> }
> ```

***

### referenceDeliveryTypesByCodeEdit.post

`dataBook.referenceDeliveryTypesByCodeEdit.post`

Delivery type creation/editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceDeliveryTypesByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		deliveryType: { name: 'demo', defaultCost: 0, defaultNetCost: 0 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   deliveryType?: {
>     paymentTypes?: custom[] | {
>     },
>     name: string & string,
>     code?: string,
>     active?: boolean,
>     defaultCost: (number | null)& (number | null),
>     defaultNetCost: (number | null)& (number | null),
>     description?: string,
>     defaultForCrm?: boolean,
>     defaultTariffCode?: string | null,
>     defaultTariffType?: string | null,
>     integrationCode?: string,
>     deliveryServices?: custom[] | {
>     },
>     sites?: custom[] | {
>     },
>     vatRate?: string | null
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceLegalEntities.get

`dataBook.referenceLegalEntities.get`

Getting the list of legal entities

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceLegalEntities.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `legalEntities` | `object[]` | No | — |

> [accordion] legalEntities full type
>
> ```ts theme={null}
> {
>   contragentType?: custom | null,
>   legalName?: string,
>   legalAddress?: string,
>   INN?: string,
>   OKPO?: string,
>   KPP?: string,
>   OGRN?: string,
>   OGRNIP?: string,
>   certificateNumber?: string,
>   certificateDate?: string | null,
>   BIK?: string,
>   bank?: string,
>   bankAddress?: string,
>   corrAccount?: string,
>   bankAccount?: string,
>   code?: string,
>   countryIso?: string,
>   vatRate?: string | null
> }[]
> ```

***

### referenceLegalEntitiesByCodeEdit.post

`dataBook.referenceLegalEntitiesByCodeEdit.post`

Editing of information on legal entity

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceLegalEntitiesByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		legalEntity: { contragentType: 'legal-entity' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   legalEntity?: {
>     contragentType?: custom | null,
>     legalName?: string,
>     legalAddress?: string,
>     INN?: string,
>     OKPO?: string,
>     KPP?: string,
>     OGRN?: string,
>     OGRNIP?: string,
>     certificateNumber?: string,
>     certificateDate?: string | null,
>     BIK?: string,
>     bank?: string,
>     bankAddress?: string,
>     corrAccount?: string,
>     bankAccount?: string,
>     code?: string,
>     countryIso?: string,
>     vatRate?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceMgChannels.get

`dataBook.referenceMgChannels.get`

Getting a list of MessageGateway channels

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceMgChannels.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `mgChannels` | `object[]` | No | — |

> [accordion] mgChannels full type
>
> ```ts theme={null}
> {
>   allowedSendByPhone?: boolean,
>   id?: number | null,
>   externalId?: number,
>   type?: string,
>   active?: boolean,
>   name?: string
> }[]
> ```

***

### referenceOrderMethods.get

`dataBook.referenceOrderMethods.get`

Getting the list of order methods

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceOrderMethods.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `orderMethods` | `object` | No | — |

> [accordion] orderMethods full type
>
> ```ts theme={null}
> {
> }
> ```

***

### referenceOrderMethodsByCodeEdit.post

`dataBook.referenceOrderMethodsByCodeEdit.post`

Order method creation/editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceOrderMethodsByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		orderMethod: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   orderMethod?: {
>     name: string & string,
>     code?: string,
>     active?: boolean,
>     defaultForCrm?: boolean,
>     defaultForApi?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceOrderTypes.get

`dataBook.referenceOrderTypes.get`

Getting the list of order types

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceOrderTypes.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `orderTypes` | `object` | No | — |

> [accordion] orderTypes full type
>
> ```ts theme={null}
> {
> }
> ```

***

### referenceOrderTypesByCodeEdit.post

`dataBook.referenceOrderTypesByCodeEdit.post`

Order type creation/editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceOrderTypesByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		orderType: { name: 'demo', ordering: 0 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   orderType?: {
>     name: string & string,
>     code?: string,
>     active?: boolean,
>     defaultForCrm?: boolean,
>     defaultForApi?: boolean,
>     ordering: number & number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referencePaymentStatuses.get

`dataBook.referencePaymentStatuses.get`

Getting the list of payment statuses

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referencePaymentStatuses.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `paymentStatuses` | `object` | No | — |

> [accordion] paymentStatuses full type
>
> ```ts theme={null}
> {
> }
> ```

***

### referencePaymentStatusesByCodeEdit.post

`dataBook.referencePaymentStatusesByCodeEdit.post`

Payment status creation/editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referencePaymentStatusesByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		paymentStatus: { name: 'demo', ordering: 0 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   paymentStatus?: {
>     name: string & string,
>     code?: string,
>     active?: boolean,
>     defaultForCrm?: boolean,
>     defaultForApi?: boolean,
>     paymentComplete?: boolean,
>     ordering: number & number,
>     description?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referencePaymentTypes.get

`dataBook.referencePaymentTypes.get`

Getting the list of payment types

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referencePaymentTypes.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `paymentTypes` | `object` | No | — |

> [accordion] paymentTypes full type
>
> ```ts theme={null}
> {
> }
> ```

***

### referencePaymentTypesByCodeEdit.post

`dataBook.referencePaymentTypesByCodeEdit.post`

Payment type creation/editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referencePaymentTypesByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		paymentType: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   paymentType?: {
>     name: string & string,
>     code?: string,
>     active?: boolean,
>     defaultForCrm?: boolean,
>     defaultForApi?: boolean,
>     description?: string,
>     paymentStatuses?: custom[] | {
>     },
>     sites?: custom[] | {
>     },
>     paymentDeliveryTypes?: {
>       code: string,
>       cod?: boolean
>     }[]
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number \| null` | No | Internal ID of created object |
| `ignoredDeliveryTypes` | `string[]` | No | Delivery types skipped on save because their payment settings are managed by integration |

***

### referencePriceTypes.get

`dataBook.referencePriceTypes.get`

Getting the list of price types

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referencePriceTypes.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `priceTypes` | `object[]` | No | — |

> [accordion] priceTypes full type
>
> ```ts theme={null}
> {
>   id?: number,
>   code?: string,
>   name?: string,
>   active?: boolean,
>   promo?: boolean,
>   default?: boolean,
>   description?: string,
>   filterExpression?: string,
>   geo?: {
>     country?: string | null,
>     regionId?: string | null,
>     region?: string | null,
>     cityId?: string | null,
>     city?: string | null
>   }[],
>   groups?: custom[] | {
>   },
>   ordering?: number,
>   currency?: string
> }[]
> ```

***

### referencePriceTypesByCodeEdit.post

`dataBook.referencePriceTypesByCodeEdit.post`

Price type creation/editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referencePriceTypesByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		priceType: { code: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   priceType?: {
>     code?: string,
>     name?: string,
>     active?: boolean,
>     promo?: boolean,
>     description?: string,
>     filterExpression?: string,
>     ordering?: number,
>     geo?: {
>       country?: string | null,
>       regionId?: string | null,
>       cityId?: string | null
>     }[],
>     groups?: custom[] | {
>     },
>     currency?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceProductStatuses.get

`dataBook.referenceProductStatuses.get`

Getting the list of item statuses in order

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceProductStatuses.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `productStatuses` | `object` | No | — |

> [accordion] productStatuses full type
>
> ```ts theme={null}
> {
> }
> ```

***

### referenceProductStatusesByCodeEdit.post

`dataBook.referenceProductStatusesByCodeEdit.post`

Item status creation/editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceProductStatusesByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		productStatus: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   productStatus?: {
>     code?: string,
>     ordering?: number,
>     active?: boolean,
>     cancelStatus?: boolean,
>     name: string,
>     orderStatusByProductStatus?: string,
>     orderStatusForProductStatus?: string,
>     type?: custom | null
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referencePushCategories.get

`dataBook.referencePushCategories.get`

Get customer mobile push notification categories

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referencePushCategories.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pushCategories` | `object[]` | No | — |

> [accordion] pushCategories full type
>
> ```ts theme={null}
> {
>   id?: number,
>   name?: string,
>   code?: string,
>   active?: boolean,
>   createdAt?: string
> }[]
> ```

***

### referencePushCategoriesByCodeEdit.post

`dataBook.referencePushCategoriesByCodeEdit.post`

Create/edit customer mobile push notification category

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referencePushCategoriesByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		pushCategory: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   pushCategory?: {
>     name: string,
>     active?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### referenceSites.get

`dataBook.referenceSites.get`

Getting the stores list

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceSites.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `sites` | `object` | No | — |

> [accordion] sites full type
>
> ```ts theme={null}
> {
> }
> ```

***

### referenceSitesByCodeEdit.post

`dataBook.referenceSitesByCodeEdit.post`

Store creation/editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceSitesByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		site: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: {
>     name: string & string,
>     url?: string & string,
>     code?: string & string,
>     description?: string & string,
>     phones?: string & string,
>     address?: string & string,
>     zip?: string & string,
>     defaultForCrm?: boolean,
>     ymlUrl?: string & string,
>     loadFromYml?: boolean,
>     countryIso?: string,
>     contragentCode?: string,
>     currency?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### referenceStatuses.get

`dataBook.referenceStatuses.get`

Getting the list of order statuses

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceStatuses.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `statuses` | `object` | No | — |

> [accordion] statuses full type
>
> ```ts theme={null}
> {
> }
> ```

***

### referenceStatusesByCodeEdit.post

`dataBook.referenceStatusesByCodeEdit.post`

Order status creation/editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceStatusesByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		status: { name: 'demo', ordering: 0, group: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   status?: {
>     name: string & string,
>     code?: string,
>     active?: boolean,
>     ordering: number & number,
>     group: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceStatusGroups.get

`dataBook.referenceStatusGroups.get`

Getting the list of order status groups

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceStatusGroups.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `statusGroups` | `object` | No | — |

> [accordion] statusGroups full type
>
> ```ts theme={null}
> {
> }
> ```

***

### referenceStores.get

`dataBook.referenceStores.get`

Getting the list of warehouses

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceStores.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `stores` | `object[]` | No | — |

> [accordion] stores full type
>
> ```ts theme={null}
> {
>   externalId?: string,
>   xmlId?: string,
>   description?: string,
>   email?: string,
>   type?: custom,
>   inventoryType?: custom,
>   address?: {
>     index?: string | null,
>     countryIso?: string | null,
>     region?: string | null,
>     regionId?: number | null,
>     city?: string | null,
>     cityId?: number | null,
>     cityType?: string,
>     street?: string | null,
>     streetId?: number | null,
>     streetType?: string,
>     building?: string | null,
>     flat?: string | null,
>     floor?: number | null,
>     block?: number | null,
>     house?: string | null,
>     housing?: string,
>     metro?: string | null,
>     notes?: string | null,
>     text?: string,
>     coordinates?: {
>       latitude?: number,
>       longitude?: number
>     } | null
>   },
>   active?: boolean,
>   ordering?: string | null,
>   phone?: {
>     number?: string | null
>   } | null,
>   contact?: string,
>   code?: string,
>   workTime?: {
>     mo?: {
>       startTime?: string,
>       endTime?: string,
>       lunchStartTime?: string,
>       lunchEndTime?: string
>     }[],
>     tu?: {
>       startTime?: string,
>       endTime?: string,
>       lunchStartTime?: string,
>       lunchEndTime?: string
>     }[],
>     we?: {
>       startTime?: string,
>       endTime?: string,
>       lunchStartTime?: string,
>       lunchEndTime?: string
>     }[],
>     th?: {
>       startTime?: string,
>       endTime?: string,
>       lunchStartTime?: string,
>       lunchEndTime?: string
>     }[],
>     fr?: {
>       startTime?: string,
>       endTime?: string,
>       lunchStartTime?: string,
>       lunchEndTime?: string
>     }[],
>     sa?: {
>       startTime?: string,
>       endTime?: string,
>       lunchStartTime?: string,
>       lunchEndTime?: string
>     }[],
>     su?: {
>       startTime?: string,
>       endTime?: string,
>       lunchStartTime?: string,
>       lunchEndTime?: string
>     }[]
>   },
>   name: string
> }[]
> ```

***

### referenceStoresByCodeEdit.post

`dataBook.referenceStoresByCodeEdit.post`

Creation/editing of information on warehouse

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceStoresByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		store: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   store?: {
>     externalId?: string,
>     xmlId?: string,
>     description?: string,
>     email?: string,
>     type?: custom,
>     inventoryType?: custom,
>     address?: {
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       coordinates?: {
>         latitude?: number,
>         longitude?: number
>       } | null
>     },
>     active?: boolean,
>     phone?: {
>       number?: string | null
>     } | null,
>     code?: string,
>     name: string,
>     workTime?: {
>       mo?: {
>         startTime?: string,
>         endTime?: string,
>         lunchStartTime?: string,
>         lunchEndTime?: string
>       }[],
>       tu?: {
>         startTime?: string,
>         endTime?: string,
>         lunchStartTime?: string,
>         lunchEndTime?: string
>       }[],
>       we?: {
>         startTime?: string,
>         endTime?: string,
>         lunchStartTime?: string,
>         lunchEndTime?: string
>       }[],
>       th?: {
>         startTime?: string,
>         endTime?: string,
>         lunchStartTime?: string,
>         lunchEndTime?: string
>       }[],
>       fr?: {
>         startTime?: string,
>         endTime?: string,
>         lunchStartTime?: string,
>         lunchEndTime?: string
>       }[],
>       sa?: {
>         startTime?: string,
>         endTime?: string,
>         lunchStartTime?: string,
>         lunchEndTime?: string
>       }[],
>       su?: {
>         startTime?: string,
>         endTime?: string,
>         lunchStartTime?: string,
>         lunchEndTime?: string
>       }[]
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceSubscriptions.get

`dataBook.referenceSubscriptions.get`

Subscription categories list

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceSubscriptions.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `subscriptions` | `object[]` | No | — |

> [accordion] subscriptions full type
>
> ```ts theme={null}
> {
>   id?: number,
>   channel?: string,
>   name?: string,
>   code?: string,
>   active?: boolean,
>   autoSubscribe?: boolean,
>   ordering?: number
> }[]
> ```

***

### referenceSubscriptionsByChannelByCodeEdit.post

`dataBook.referenceSubscriptionsByChannelByCodeEdit.post`

Create/edit subscription category

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceSubscriptionsByChannelByCodeEdit.post({
	path: { channel: 'demo', code: 'demo' },
	body: {
		subscription: { channel: 'email', name: 'demo', ordering: 0 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   channel: unknown,
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   subscription?: {
>     channel: custom,
>     name: string,
>     code?: string,
>     active?: boolean,
>     autoSubscribe?: boolean,
>     ordering: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### referenceTicketChannels.get

`dataBook.referenceTicketChannels.get`

Getting ticket channel list

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketChannels.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `ticketChannels` | `object[]` | No | — |

> [accordion] ticketChannels full type
>
> ```ts theme={null}
> {
>   id?: number,
>   name?: string,
>   code?: string,
>   active?: boolean,
>   defaultForCrm?: boolean,
>   defaultForApi?: boolean,
>   ordering?: number
> }[]
> ```

***

### referenceTicketChannelsByIdEdit.post

`dataBook.referenceTicketChannelsByIdEdit.post`

Editing a ticket channel

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketChannelsByIdEdit.post({
	path: { id: '17' },
	body: {
		ticketChannel: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticketChannel: {
>     name?: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     defaultForCrm?: boolean,
>     defaultForApi?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceTicketChannelsCreate.post

`dataBook.referenceTicketChannelsCreate.post`

Creating a ticket channel

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketChannelsCreate.post({
	body: {
		ticketChannel: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticketChannel: {
>     name: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     defaultForCrm?: boolean,
>     defaultForApi?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### referenceTicketStatuses.get

`dataBook.referenceTicketStatuses.get`

Getting ticket status list

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketStatuses.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `ticketStatuses` | `object[]` | No | — |

> [accordion] ticketStatuses full type
>
> ```ts theme={null}
> {
>   id?: number,
>   name?: string,
>   code?: string,
>   active?: boolean,
>   ordering?: number,
>   group?: {
>     color?: string,
>     id?: number,
>     name?: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number
>   }
> }[]
> ```

***

### referenceTicketStatusesByIdEdit.post

`dataBook.referenceTicketStatusesByIdEdit.post`

Editing a ticket status

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketStatusesByIdEdit.post({
	path: { id: '17' },
	body: {
		ticketStatus: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticketStatus: {
>     name?: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     group?: {
>       id: number
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceTicketStatusesCreate.post

`dataBook.referenceTicketStatusesCreate.post`

Creating a ticket status

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketStatusesCreate.post({
	body: {
		ticketStatus: {
			name: 'demo',
			group: { id: 1 },
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticketStatus: {
>     name: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     group: {
>       id: number
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### referenceTicketStatusGroups.get

`dataBook.referenceTicketStatusGroups.get`

Getting ticket status group list

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketStatusGroups.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `ticketStatusGroups` | `object[]` | No | — |

> [accordion] ticketStatusGroups full type
>
> ```ts theme={null}
> {
>   color?: string,
>   id?: number,
>   name?: string,
>   code?: string,
>   active?: boolean,
>   ordering?: number
> }[]
> ```

***

### referenceTicketStatusGroupsByIdEdit.post

`dataBook.referenceTicketStatusGroupsByIdEdit.post`

Editing a ticket status group

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketStatusGroupsByIdEdit.post({
	path: { id: '17' },
	body: {
		ticketStatusGroup: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticketStatusGroup: {
>     name?: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     color?: custom | null
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceTicketStatusGroupsCreate.post

`dataBook.referenceTicketStatusGroupsCreate.post`

Creating a ticket status group

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketStatusGroupsCreate.post({
	body: {
		ticketStatusGroup: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticketStatusGroup: {
>     name: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     color?: custom | null
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### referenceTicketSubtopics.get

`dataBook.referenceTicketSubtopics.get`

Getting ticket subtopic list

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketSubtopics.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `ticketSubtopics` | `object[]` | No | — |

> [accordion] ticketSubtopics full type
>
> ```ts theme={null}
> {
>   id?: number,
>   name?: string,
>   code?: string,
>   active?: boolean,
>   ordering?: number,
>   topic?: {
>     id?: number,
>     name?: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number
>   }
> }[]
> ```

***

### referenceTicketSubtopicsByIdEdit.post

`dataBook.referenceTicketSubtopicsByIdEdit.post`

Editing a ticket subtopic

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketSubtopicsByIdEdit.post({
	path: { id: '17' },
	body: {
		ticketSubtopic: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticketSubtopic: {
>     name?: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     topic?: {
>       id: number
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceTicketSubtopicsCreate.post

`dataBook.referenceTicketSubtopicsCreate.post`

Creating a ticket subtopic

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketSubtopicsCreate.post({
	body: {
		ticketSubtopic: {
			name: 'demo',
			topic: { id: 1 },
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticketSubtopic: {
>     name: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     topic: {
>       id: number
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### referenceTicketTopics.get

`dataBook.referenceTicketTopics.get`

Getting ticket topic list

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketTopics.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `ticketTopics` | `object[]` | No | — |

> [accordion] ticketTopics full type
>
> ```ts theme={null}
> {
>   id?: number,
>   name?: string,
>   code?: string,
>   active?: boolean,
>   ordering?: number
> }[]
> ```

***

### referenceTicketTopicsByIdEdit.post

`dataBook.referenceTicketTopicsByIdEdit.post`

Editing a ticket topic

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketTopicsByIdEdit.post({
	path: { id: '17' },
	body: {
		ticketTopic: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticketTopic: {
>     name?: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceTicketTopicsCreate.post

`dataBook.referenceTicketTopicsCreate.post`

Creating a ticket topic

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketTopicsCreate.post({
	body: {
		ticketTopic: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticketTopic: {
>     name: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### referenceTicketTypes.get

`dataBook.referenceTicketTypes.get`

Getting ticket type list

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketTypes.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `ticketTypes` | `object[]` | No | — |

> [accordion] ticketTypes full type
>
> ```ts theme={null}
> {
>   id?: number,
>   name?: string,
>   code?: string,
>   active?: boolean,
>   defaultForCrm?: boolean,
>   defaultForApi?: boolean,
>   ordering?: number
> }[]
> ```

***

### referenceTicketTypesByIdEdit.post

`dataBook.referenceTicketTypesByIdEdit.post`

Editing a ticket type

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketTypesByIdEdit.post({
	path: { id: '17' },
	body: {
		ticketType: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticketType: {
>     name?: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     defaultForCrm?: boolean,
>     defaultForApi?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### referenceTicketTypesCreate.post

`dataBook.referenceTicketTypesCreate.post`

Creating a ticket type

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceTicketTypesCreate.post({
	body: {
		ticketType: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticketType: {
>     name: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     defaultForCrm?: boolean,
>     defaultForApi?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### referenceUnits.get

`dataBook.referenceUnits.get`

Getting the list of units

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceUnits.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `units` | `object` | No | — |

> [accordion] units full type
>
> ```ts theme={null}
> {
> }
> ```

***

### referenceUnitsByCodeEdit.post

`dataBook.referenceUnitsByCodeEdit.post`

Unit creation/edition

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.dataBook.referenceUnitsByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		unit: { name: 'demo', sym: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   unit?: {
>     code?: string,
>     name: string,
>     sym: string,
>     default?: boolean,
>     active?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

## Deliveries

### deliveryCalculate.post

`deliveries.deliveryCalculate.post`

Calculation of the delivery cost

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.deliveries.deliveryCalculate.post({
	body: {
		order: { weight: 1 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   deliveryTypeCodes?: string[],
>   order?: {
>     weight?: number | null,
>     length?: number,
>     width?: number,
>     height?: number,
>     items?: {
>       initialPrice?: number | null,
>       discountManualAmount?: number | null,
>       discountManualPercent?: number | null,
>       quantity?: number | null
>     }[],
>     delivery?: {
>       date?: string,
>       time?: {
>         from?: string | null,
>         to?: string | null,
>         custom?: string | null
>       },
>       address?: {
>         index?: string | null,
>         countryIso?: string | null,
>         region?: string | null,
>         regionId?: number | null,
>         city?: string | null,
>         cityId?: number | null,
>         cityType?: string,
>         street?: string | null,
>         streetId?: number | null,
>         streetType?: string,
>         building?: string | null,
>         flat?: string | null,
>         floor?: number | null,
>         block?: number | null,
>         house?: string | null,
>         housing?: string,
>         metro?: string | null
>       }
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `calculations` | `object[]` | No | — |
| `failedCalculations` | `object[]` | No | — |

> [accordion] calculations full type
>
> ```ts theme={null}
> {
>   code?: string,
>   available?: boolean,
>   vatRate?: string | null,
>   cost?: number
> }[]
> ```

> [accordion] failedCalculations full type
>
> ```ts theme={null}
> {
>   code?: string,
>   reason?: string,
>   message?: string
> }[]
> ```

***

### deliveryGenericBySubcodeTracking.post

`deliveries.deliveryGenericBySubcodeTracking.post`

Updating of delivery statuses

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.deliveries.deliveryGenericBySubcodeTracking.post({
	path: { subcode: 'demo' },
	body: {
		statusUpdate: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   subcode: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   statusUpdate?: {
>     deliveryId: string,
>     trackNumber?: string,
>     cost?: number,
>     history?: {
>       code: string,
>       updatedAt: string,
>       comment?: string
>     }[],
>     extraData?: {
>     }
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### deliveryShipments.get

`deliveries.deliveryShipments.get`

Getting the list of shipments to delivery services

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.deliveries.deliveryShipments.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     externalId
>   ]?: string,
>   filter[
>     orderNumber
>   ]?: string,
>   filter[
>     deliveryTypes
>   ][]?: string[],
>   filter[
>     managers
>   ][]?: number[],
>   filter[
>     stores
>   ][]?: string[],
>   filter[
>     statuses
>   ][]?: custom[],
>   filter[
>     dateFrom
>   ]?: string,
>   filter[
>     dateTo
>   ]?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `deliveryShipments` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] deliveryShipments full type
>
> ```ts theme={null}
> (
>   {
>     integrationCode?: string,
>     id?: number,
>     externalId?: string,
>     deliveryType: string,
>     store: string,
>     managerId: number,
>     status?: string,
>     date: string,
>     time: {
>       from?: string | null,
>       to?: string | null,
>       custom?: string | null
>     },
>     comment?: string,
>     orders?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     }[],
>     extraData?: custom[] | {
>     }
>   } | {
>     integrationCode?: string,
>     id?: number,
>     externalId?: string,
>     deliveryType: string,
>     store: string,
>     managerId: number,
>     status?: string,
>     date: string,
>     time: {
>       from?: string | null,
>       to?: string | null,
>       custom?: string | null
>     },
>     comment?: string,
>     orders?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     }[],
>     extraData?: custom[] | {
>     }
>   }
> )[]
> ```

***

### deliveryShipmentsByIdEdit.post

`deliveries.deliveryShipmentsByIdEdit.post`

Shipment editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.deliveries.deliveryShipmentsByIdEdit.post({
	path: { id: 1 },
	body: {
		deliveryShipment: {
			store: 'demo',
			managerId: 1,
			date: '2025-01-01',
			time: { from: '12:00' },
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   deliveryShipment?: {
>     status?: string,
>     date: string,
>     time: {
>       from?: string | null,
>       to?: string | null,
>       custom?: string | null
>     },
>     comment?: string,
>     store: string,
>     managerId: number,
>     orders?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     }[],
>     extraData?: custom[] | {
>     }
>   } | {
>     status?: string,
>     date: string,
>     time: {
>       from?: string | null,
>       to?: string | null,
>       custom?: string | null
>     },
>     comment?: string,
>     store: string,
>     managerId: number,
>     orders?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     }[],
>     extraData?: custom[] | {
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Shipment id |
| `status` | `string \| null` | No | Shipment status |

***

### deliveryShipmentsCreate.post

`deliveries.deliveryShipmentsCreate.post`

Shipment creation

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.deliveries.deliveryShipmentsCreate.post({
	body: {
		deliveryShipment: {
			store: 'demo',
			managerId: 1,
			date: '2025-01-01',
			time: { from: '12:00' },
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   deliveryType?: string,
>   site?: string,
>   deliveryShipment?: {
>     status?: string,
>     date: string,
>     time: {
>       from?: string | null,
>       to?: string | null,
>       custom?: string | null
>     },
>     comment?: string,
>     store: string,
>     managerId: number,
>     orders?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     }[],
>     extraData?: custom[] | {
>     }
>   } | {
>     status?: string,
>     date: string,
>     time: {
>       from?: string | null,
>       to?: string | null,
>       custom?: string | null
>     },
>     comment?: string,
>     store: string,
>     managerId: number,
>     orders?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     }[],
>     extraData?: custom[] | {
>     }
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Shipment id |
| `status` | `string \| null` | No | Shipment status |

***

### getDeliveryShipmentsById.get

`deliveries.getDeliveryShipmentsById.get`

Getting information on shipment

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.deliveries.getDeliveryShipmentsById.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `deliveryShipment` | `object` | No | Shipment to delivery service |

> [accordion] deliveryShipment full type
>
> ```ts theme={null}
> {
>   integrationCode?: string,
>   id?: number,
>   externalId?: string,
>   deliveryType: string,
>   store: string,
>   managerId: number,
>   status?: string,
>   date: string,
>   time: {
>     from?: string | null,
>     to?: string | null,
>     custom?: string | null
>   },
>   comment?: string,
>   orders?: {
>     id?: number,
>     externalId?: string,
>     number?: string
>   }[],
>   extraData?: custom[] | {
>   }
> } | {
>   integrationCode?: string,
>   id?: number,
>   externalId?: string,
>   deliveryType: string,
>   store: string,
>   managerId: number,
>   status?: string,
>   date: string,
>   time: {
>     from?: string | null,
>     to?: string | null,
>     custom?: string | null
>   },
>   comment?: string,
>   orders?: {
>     id?: number,
>     externalId?: string,
>     number?: string
>   }[],
>   extraData?: custom[] | {
>   }
> }
> ```

***

## Files

### byIdDelete.post

`files.byIdDelete.post`

Deleting the file

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.files.byIdDelete.post({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### byIdDownload.get

`files.byIdDownload.get`

File downloading

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.files.byIdDownload.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

Returns the file bytes in a base64 envelope; maximum response size is capped by the client at 20 MiB.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |

***

### byIdEdit.post

`files.byIdEdit.post`

Editing the file

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.files.byIdEdit.post({
	path: { id: 1 },
	body: {
		file: { filename: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   file?: {
>     filename?: string,
>     attachment?: {
>       customer?: {
>         id?: number,
>         externalId?: string,
>         browserId?: string,
>         site?: string
>       } | null,
>       order?: {
>         id?: number,
>         externalId?: string,
>         number?: string,
>         site?: string
>       } | null,
>       ticket?: {
>         id?: number,
>         externalId?: string,
>         number?: string,
>         site?: string
>       },
>       knowledgeBaseDocument?: {
>         id?: number
>       }
>     }[]
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `file` | `object` | No | File |

> [accordion] file full type
>
> ```ts theme={null}
> {
>   id?: number
> }
> ```

***

### getById.get

`files.getById.get`

Getting information about the file

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.files.getById.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `file` | `object` | No | File |

> [accordion] file full type
>
> ```ts theme={null}
> {
>   id?: number,
>   filename?: string,
>   type?: string,
>   createdAt?: string,
>   size?: number,
>   attachment?: {
>     customer?: {
>       id?: number,
>       externalId?: string,
>       site?: string
>     } | {
>       id?: number,
>       externalId?: string,
>       site?: string
>     } | {
>       id?: number,
>       externalId?: string,
>       site?: string
>     },
>     order?: {
>       id?: number,
>       number?: string,
>       externalId?: string,
>       site?: string
>     },
>     ticket?: {
>       id?: number,
>       number?: string,
>       externalId?: string,
>       site?: string
>     },
>     knowledgeBaseDocument?: {
>       id?: number
>     }
>   }[]
> }
> ```

***

### list.get

`files.list.get`

Getting the list of files according to the selected filter

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.files.list.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     orderIds
>   ][]?: number[],
>   filter[
>     orderExternalIds
>   ][]?: string[],
>   filter[
>     ticketIds
>   ][]?: number[],
>   filter[
>     ticketExternalIds
>   ][]?: string[],
>   filter[
>     customerIds
>   ][]?: number[],
>   filter[
>     customerExternalIds
>   ][]?: string[],
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     type
>   ][]?: string[],
>   filter[
>     filename
>   ]?: string,
>   filter[
>     isAttached
>   ]?: boolean,
>   filter[
>     createdAtFrom
>   ]?: string,
>   filter[
>     createdAtTo
>   ]?: string,
>   filter[
>     sizeFrom
>   ]?: number,
>   filter[
>     sizeTo
>   ]?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `files` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] files full type
>
> ```ts theme={null}
> {
>   id?: number,
>   filename?: string,
>   type?: string,
>   createdAt?: string,
>   size?: number,
>   attachment?: {
>     customer?: {
>       id?: number,
>       externalId?: string,
>       site?: string
>     } | {
>       id?: number,
>       externalId?: string,
>       site?: string
>     } | {
>       id?: number,
>       externalId?: string,
>       site?: string
>     },
>     order?: {
>       id?: number,
>       number?: string,
>       externalId?: string,
>       site?: string
>     },
>     ticket?: {
>       id?: number,
>       number?: string,
>       externalId?: string,
>       site?: string
>     },
>     knowledgeBaseDocument?: {
>       id?: number
>     }
>   }[]
> }[]
> ```

***

### upload.post

`files.upload.post`

Uploading the file to server

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.files.upload.post({ body: 'QQ==' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `string` | Yes | — |

Pass a base64-encoded string in `body`; the provider documents this request as `application/octet-stream`.

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `file` | `object` | No | File |

> [accordion] file full type
>
> ```ts theme={null}
> {
>   id?: number
> }
> ```

***

## Integration

### getIntegrationModulesByCode.get

`integration.getIntegrationModulesByCode.get`

Getting the integration module

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.integration.getIntegrationModulesByCode.get({
	path: { code: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `integrationModule` | `object` | No | Integration module |

> [accordion] integrationModule full type
>
> ```ts theme={null}
> {
>   code: string,
>   integrationCode: string,
>   active?: boolean,
>   freeze?: boolean,
>   name?: string,
>   logo?: string,
>   native?: boolean,
>   baseUrl?: string,
>   actions?: {
>   },
>   availableCountries?: custom[] | {
>   },
>   accountUrl?: string,
>   integrations?: {
>     telephony?: {
>       makeCallUrl?: string,
>       allowEdit?: boolean,
>       inputEventSupported?: boolean,
>       outputEventSupported?: boolean,
>       hangupEventSupported?: boolean,
>       changeUserStatusUrl?: string,
>       additionalCodes?: {
>         userId: number,
>         code: string
>       }[],
>       externalPhones?: {
>         siteCode: string,
>         externalPhone: string
>       }[]
>     },
>     delivery?: {
>       description?: string,
>       actions?: {
>       },
>       payerType?: custom[] | {
>       },
>       platePrintLimit?: number,
>       rateDeliveryCost?: boolean,
>       allowPackages?: boolean,
>       codAvailable?: boolean,
>       selfShipmentAvailable?: boolean,
>       duplicateOrderProductSupported?: boolean,
>       allowTrackNumber?: boolean,
>       availableCountries?: custom[] | {
>       },
>       requiredFields?: custom[] | {
>       },
>       statusList?: {
>         code?: string,
>         name?: string,
>         isEditable?: boolean,
>         isError?: boolean,
>         isPreprocessing?: boolean
>       }[] | null,
>       plateList?: {
>         type?: string,
>         code?: string,
>         label?: string
>       }[],
>       deliveryDataFieldList?: {
>         code?: string,
>         label?: string,
>         hint?: string,
>         type?: string,
>         multiple?: boolean,
>         choices?: custom[] | {
>         },
>         autocompleteUrl?: string,
>         visible?: boolean,
>         required?: boolean,
>         affectsCost?: boolean,
>         editable?: boolean
>       }[],
>       shipmentDataFieldList?: {
>         code?: string,
>         label?: string,
>         hint?: string,
>         type?: string,
>         multiple?: boolean,
>         choices?: custom[] | {
>         },
>         autocompleteUrl?: string,
>         visible?: boolean,
>         required?: boolean,
>         affectsCost?: boolean,
>         editable?: boolean
>       }[],
>       settings?: {
>         defaultPayerType?: string,
>         costCalculateBy?: string,
>         nullDeclaredValue?: boolean,
>         lockedByDefault?: boolean,
>         paymentTypes?: {
>           code?: string,
>           active?: boolean,
>           cod?: boolean
>         }[],
>         shipmentPoints?: {
>           code?: string,
>           shipmentPointId?: string,
>           shipmentPointLabel?: string
>         }[],
>         statuses?: {
>           code?: string,
>           trackingStatusCode?: string
>         }[] | null,
>         deliveryExtraData?: custom[] | {
>         },
>         shipmentExtraData?: custom[] | {
>         }
>       }
>     },
>     store?: {
>       actions?: {
>         code?: string,
>         url?: string,
>         callPoints?: string[]
>       }[]
>     },
>     recommendation?: {
>       actions?: {
>         recommendation: string
>       },
>       addDefaultModes?: boolean,
>       modes?: {
>         code?: string | null,
>         names?: {
>         }
>       }[]
>     },
>     payment?: {
>       actions: {
>         create: string,
>         approve?: string,
>         cancel?: string,
>         refund?: string | null
>       },
>       currencies: string[],
>       invoiceTypes: string[],
>       shops?: {
>         code: string,
>         name: string,
>         active?: boolean
>       }[]
>     },
>     embedJs?: {
>       entrypoint?: string,
>       stylesheet?: string,
>       runner?: custom,
>       targets?: custom[] | {
>       } | null,
>       pages?: {
>         code: string | null,
>         menu?: string | null,
>         parentMenuItemCode?: string | null,
>         menuItemOrdering?: number | null,
>         menuItemTitle?: {
>           en: string | null,
>           es: string | null,
>           ru: string | null
>         } | null,
>         pageHelpLink?: {
>           en: string | null,
>           es: string | null,
>           ru: string | null
>         } | null,
>         isSettingsMainPage?: boolean
>       }[] | null
>     },
>     mgTransport?: {
>       token?: string | null,
>       isActive?: boolean | null,
>       webhookUrl?: string,
>       actions?: {
>         visits?: string,
>         online?: string,
>         manualTemplatesSync?: string
>       }
>     },
>     mgBot?: {
>       isActive?: boolean,
>       logo?: string,
>       token?: string,
>       name?: string
>     }
>   }[] | null
> }
> ```

***

### integrationModulesByCodeEdit.post

`integration.integrationModulesByCodeEdit.post`

Integration module creation/editing

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.integration.integrationModulesByCodeEdit.post({
	path: { code: 'demo' },
	body: {
		integrationModule: { code: 'demo', integrationCode: 'demo', clientId: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   code: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   integrationModule?: {
>     code: string,
>     integrationCode: string,
>     active?: boolean,
>     name?: string,
>     logo?: string,
>     clientId: string,
>     baseUrl?: string,
>     actions?: {
>     },
>     availableCountries?: custom[] | {
>     },
>     accountUrl?: string,
>     integrations?: {
>       telephony?: {
>         makeCallUrl?: string,
>         allowEdit?: boolean,
>         inputEventSupported?: boolean,
>         outputEventSupported?: boolean,
>         hangupEventSupported?: boolean,
>         changeUserStatusUrl?: string,
>         additionalCodes?: {
>           userId: number,
>           code: string
>         }[],
>         externalPhones?: {
>           siteCode: string,
>           externalPhone: string
>         }[]
>       },
>       delivery?: {
>         description?: string,
>         actions?: {
>         },
>         payerType?: custom[] | {
>         },
>         platePrintLimit?: number,
>         rateDeliveryCost?: boolean,
>         allowPackages?: boolean,
>         codAvailable?: boolean,
>         selfShipmentAvailable?: boolean,
>         duplicateOrderProductSupported?: boolean,
>         allowTrackNumber?: boolean,
>         availableCountries?: custom[] | {
>         },
>         requiredFields?: custom[] | {
>         },
>         statusList?: {
>           code?: string,
>           name?: string,
>           isEditable?: boolean,
>           isError?: boolean,
>           isPreprocessing?: boolean
>         }[] | null,
>         plateList?: {
>           type?: string,
>           code?: string,
>           label?: string
>         }[],
>         deliveryDataFieldList?: {
>           code?: string,
>           label?: string,
>           hint?: string,
>           type?: string,
>           multiple?: boolean,
>           choices?: custom[] | {
>           },
>           autocompleteUrl?: string,
>           visible?: boolean,
>           required?: boolean,
>           affectsCost?: boolean,
>           editable?: boolean
>         }[],
>         shipmentDataFieldList?: {
>           code?: string,
>           label?: string,
>           hint?: string,
>           type?: string,
>           multiple?: boolean,
>           choices?: custom[] | {
>           },
>           autocompleteUrl?: string,
>           visible?: boolean,
>           required?: boolean,
>           affectsCost?: boolean,
>           editable?: boolean
>         }[],
>         settings?: {
>           defaultPayerType?: string,
>           costCalculateBy?: string,
>           nullDeclaredValue?: boolean,
>           lockedByDefault?: boolean,
>           paymentTypes?: {
>             code?: string,
>             active?: boolean,
>             cod?: boolean
>           }[],
>           shipmentPoints?: {
>             code?: string,
>             shipmentPointId?: string,
>             shipmentPointLabel?: string
>           }[],
>           statuses?: {
>             code?: string,
>             trackingStatusCode?: string
>           }[] | null,
>           deliveryExtraData?: custom[] | {
>           },
>           shipmentExtraData?: custom[] | {
>           }
>         }
>       },
>       store?: {
>         actions?: {
>           code?: string,
>           url?: string,
>           callPoints?: string[]
>         }[]
>       },
>       recommendation?: {
>         actions?: {
>           recommendation: string
>         },
>         addDefaultModes?: boolean,
>         modes?: {
>           code?: string | null,
>           names?: {
>           }
>         }[]
>       },
>       payment?: {
>         actions: {
>           create: string,
>           approve?: string,
>           cancel?: string,
>           refund?: string | null
>         },
>         currencies: string[],
>         invoiceTypes: string[],
>         shops?: {
>           code: string,
>           name: string,
>           active?: boolean
>         }[]
>       },
>       embedJs?: {
>         entrypoint?: string,
>         stylesheet?: string,
>         runner?: custom,
>         targets?: custom[] | {
>         } | null,
>         pages?: {
>           code: string | null,
>           menu?: string | null,
>           parentMenuItemCode?: string | null,
>           menuItemOrdering?: number | null,
>           menuItemTitle?: {
>             en: string | null,
>             es: string | null,
>             ru: string | null
>           } | null,
>           pageHelpLink?: {
>             en: string | null,
>             es: string | null,
>             ru: string | null
>           } | null,
>           isSettingsMainPage?: boolean
>         }[] | null
>       },
>       mgTransport?: {
>         webhookUrl?: string,
>         actions?: {
>           visits?: string,
>           online?: string,
>           manualTemplatesSync?: string
>         },
>         refreshToken?: boolean
>       },
>       mgBot?: {
>         refreshToken?: boolean
>       }
>     }[] | null
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `info` | `custom[] \| object` | No | Additional information about the results of editing the module |

> [accordion] info full type
>
> ```ts theme={null}
> custom[] | {
> }
> ```

***

## Knowledge Base

### documents.get

`knowledgeBase.documents.get`

Getting the list of knowledge base documents matching the filter

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.knowledgeBase.documents.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   cursor?: string,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     sectionId
>   ]?: number,
>   filter[
>     directOnly
>   ]?: boolean,
>   filter[
>     availableForCopilot
>   ]?: boolean,
>   filter[
>     hasFile
>   ]?: boolean,
>   filter[
>     externalIds
>   ][]?: string[],
>   filter[
>     search
>   ]?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination with cursors |
| `documents` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   nextCursor?: string
> }
> ```

> [accordion] documents full type
>
> ```ts theme={null}
> {
>   id?: number,
>   sectionId?: number,
>   title?: string,
>   content?: string,
>   file?: {
>     id?: number,
>     name?: string,
>     type?: string,
>     size?: number,
>     url?: string
>   },
>   availableForCopilot?: boolean,
>   externalId?: string,
>   contentHash?: string,
>   createdAt?: string,
>   updatedAt?: string
> }[]
> ```

***

### documentsByIdDelete.post

`knowledgeBase.documentsByIdDelete.post`

Knowledge base document deletion

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.knowledgeBase.documentsByIdDelete.post({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### documentsByIdEdit.post

`knowledgeBase.documentsByIdEdit.post`

Knowledge base document editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.knowledgeBase.documentsByIdEdit.post({
	path: { id: 'demo' },
	body: {
		document: { title: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   by?: string,
>   document?: {
>     title?: string,
>     content?: string,
>     sectionId?: number,
>     availableForCopilot?: boolean,
>     externalId?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### documentsCreate.post

`knowledgeBase.documentsCreate.post`

Knowledge base document creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.knowledgeBase.documentsCreate.post({
	body: {
		document: { title: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   document?: {
>     title: string,
>     content?: string,
>     sectionId?: number,
>     availableForCopilot?: boolean,
>     externalId?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### documentsHistory.get

`knowledgeBase.documentsHistory.get`

Getting the change history of knowledge base documents

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.knowledgeBase.documentsHistory.get({
	query: { filter[documentId]: 0, filter[sinceId]: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     startDate
>   ]?: string,
>   filter[
>     endDate
>   ]?: string,
>   filter[
>     documentId
>   ]?: number,
>   filter[
>     sinceId
>   ]?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `generatedAt` | `string` | No | — |
| `pagination` | `object` | No | Pagination |
| `history` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] history full type
>
> ```ts theme={null}
> {
>   id?: number,
>   createdAt?: string,
>   created?: boolean,
>   deleted?: boolean,
>   source?: string,
>   user?: {
>     id?: number
>   },
>   field?: string,
>   oldValue?: custom,
>   newValue?: custom,
>   apiKey?: {
>     current?: boolean,
>     id?: number
>   },
>   document?: {
>     id?: number,
>     externalId?: string
>   },
>   file?: {
>     id?: number,
>     name?: string,
>     type?: string,
>     size?: number,
>     url?: string
>   }
> }[]
> ```

***

### getDocumentsById.get

`knowledgeBase.getDocumentsById.get`

Getting a knowledge base document

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.knowledgeBase.getDocumentsById.get({
	path: { id: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `document` | `object` | No | — |

> [accordion] document full type
>
> ```ts theme={null}
> {
>   id?: number,
>   sectionId?: number,
>   title?: string,
>   content?: string,
>   file?: {
>     id?: number,
>     name?: string,
>     type?: string,
>     size?: number,
>     url?: string
>   },
>   availableForCopilot?: boolean,
>   externalId?: string,
>   contentHash?: string,
>   createdAt?: string,
>   updatedAt?: string
> }
> ```

***

### sections.get

`knowledgeBase.sections.get`

Getting the list of knowledge base sections

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.knowledgeBase.sections.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `sections` | `object[]` | No | — |

> [accordion] sections full type
>
> ```ts theme={null}
> {
>   id?: number,
>   parentId?: number,
>   name?: string,
>   path?: string,
>   documentsCount?: number,
>   createdAt?: string,
>   updatedAt?: string
> }[]
> ```

***

### sectionsByIdDelete.post

`knowledgeBase.sectionsByIdDelete.post`

Knowledge base section deletion

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.knowledgeBase.sectionsByIdDelete.post({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### sectionsByIdEdit.post

`knowledgeBase.sectionsByIdEdit.post`

Knowledge base section editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.knowledgeBase.sectionsByIdEdit.post({
	path: { id: 1 },
	body: {
		section: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   section?: {
>     name?: string,
>     parentId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### sectionsCreate.post

`knowledgeBase.sectionsCreate.post`

Knowledge base section creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.knowledgeBase.sectionsCreate.post({
	body: {
		section: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   section?: {
>     name: string,
>     parentId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

## Loyalty

### accountByIdActivate.post

`loyalty.accountByIdActivate.post`

Activation of participation in the loyalty program

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.loyalty.accountByIdActivate.post({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `loyaltyAccount` | `object` | No | Participation in the loyalty program |
| `verification` | `object` | No | SMS-verification |

> [accordion] loyaltyAccount full type
>
> ```ts theme={null}
> {
>   active?: boolean,
>   id?: number,
>   phoneNumber?: string,
>   cardNumber?: string,
>   amount?: number,
>   level: {
>     id?: number,
>     name: string
>   },
>   createdAt?: string,
>   activatedAt?: string,
>   confirmedPhoneAt?: string,
>   lastCheckId?: string,
>   customFields?: custom[] | {
>   }
> }
> ```

> [accordion] verification full type
>
> ```ts theme={null}
> {
>   createdAt?: string,
>   expiredAt?: string,
>   verifiedAt?: string,
>   checkId?: string,
>   actionType?: string
> }
> ```

***

### accountByIdBonusCharge.post

`loyalty.accountByIdBonusCharge.post`

Charging off bonuses to a loyalty program participant

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.loyalty.accountByIdBonusCharge.post({
	path: { id: 1 },
	body: { amount: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   amount: number,
>   comment?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### accountByIdBonusCredit.post

`loyalty.accountByIdBonusCredit.post`

Accrual of bonuses for participation in the loyalty program

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.loyalty.accountByIdBonusCredit.post({
	path: { id: 1 },
	body: { amount: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   amount: number,
>   activationDate?: string,
>   expireDate?: string,
>   comment?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `loyaltyBonus` | `object` | No | — |

> [accordion] loyaltyBonus full type
>
> ```ts theme={null}
> {
>   amount?: number,
>   activationDate?: string,
>   expireDate?: string
> }
> ```

***

### accountByIdEdit.post

`loyalty.accountByIdEdit.post`

Editing participation in the loyalty program

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.loyalty.accountByIdEdit.post({
	path: { id: 1 },
	body: {
		loyaltyAccount: { phoneNumber: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   loyaltyAccount?: {
>     phoneNumber?: string,
>     cardNumber?: string,
>     customFields?: custom[] | {
>     },
>     loyaltyLevelId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `loyaltyAccount` | `object` | No | Participation in the loyalty program |

> [accordion] loyaltyAccount full type
>
> ```ts theme={null}
> {
>   active?: boolean,
>   id?: number,
>   phoneNumber?: string,
>   cardNumber?: string,
>   amount?: number,
>   level: {
>     id?: number,
>     name: string
>   },
>   createdAt?: string,
>   activatedAt?: string,
>   confirmedPhoneAt?: string,
>   lastCheckId?: string,
>   customFields?: custom[] | {
>   }
> }
> ```

***

### accountCreate.post

`loyalty.accountCreate.post`

Adding a customer to the loyalty program

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.loyalty.accountCreate.post({
	body: {
		loyaltyAccount: {
			customer: { id: 1 },
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   loyaltyAccount?: {
>     phoneNumber?: string,
>     cardNumber?: string,
>     customFields?: custom[] | {
>     },
>     customer: {
>       id?: number,
>       externalId?: string
>     } | null
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `loyaltyAccount` | `object` | No | Participation in the loyalty program |
| `warnings` | `custom[] \| object` | No | — |

> [accordion] loyaltyAccount full type
>
> ```ts theme={null}
> {
>   active?: boolean,
>   id?: number,
>   phoneNumber?: string,
>   cardNumber?: string,
>   amount?: number,
>   level: {
>     id?: number,
>     name: string
>   },
>   createdAt?: string,
>   activatedAt?: string,
>   confirmedPhoneAt?: string,
>   lastCheckId?: string,
>   customFields?: custom[] | {
>   }
> }
> ```

> [accordion] warnings full type
>
> ```ts theme={null}
> custom[] | {
> }
> ```

***

### accounts.get

`loyalty.accounts.get`

List participation in the loyalty program

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.loyalty.accounts.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     id
>   ]?: number,
>   filter[
>     customer
>   ]?: string,
>   filter[
>     loyalties
>   ][]?: number[],
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     status
>   ]?: custom,
>   filter[
>     phoneNumber
>   ]?: string,
>   filter[
>     cardNumber
>   ]?: string,
>   filter[
>     level
>   ]?: number,
>   filter[
>     customerId
>   ]?: number,
>   filter[
>     customerExternalId
>   ]?: string,
>   filter[
>     customerSites
>   ][]?: string[],
>   filter[
>     segment
>   ][]?: string[],
>   filter[
>     createdAtFrom
>   ]?: string,
>   filter[
>     createdAtTo
>   ]?: string,
>   filter[
>     burnDateFrom
>   ]?: string,
>   filter[
>     burnDateTo
>   ]?: string,
>   filter[
>     minOrdersSum
>   ]?: number,
>   filter[
>     maxOrdersSum
>   ]?: number,
>   filter[
>     minAmount
>   ]?: number,
>   filter[
>     maxAmount
>   ]?: number,
>   filter[
>     statuses
>   ][]?: custom[],
>   filter[
>     customFields
>   ]?: custom[] | {
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `loyaltyAccounts` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] loyaltyAccounts full type
>
> ```ts theme={null}
> {
>   active?: boolean,
>   id?: number,
>   loyalty: {
>     currency?: string,
>     id?: number,
>     minResidualCost?: number
>   },
>   customer: {
>     id?: number,
>     externalId?: string,
>     site?: string,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null
>   },
>   phoneNumber?: string,
>   cardNumber?: string,
>   amount?: number,
>   ordersSum?: number,
>   nextLevelSum?: number,
>   level: {
>     type?: string,
>     id?: number,
>     name: string,
>     sum?: number,
>     privilegeSize?: number,
>     privilegeSizePromo?: number
>   },
>   createdAt?: string,
>   activatedAt?: string,
>   confirmedPhoneAt?: string,
>   lastCheckId?: string,
>   status?: string
> }[]
> ```

***

### bonusOperations.get

`loyalty.bonusOperations.get`

History of the bonus account for all participations

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.loyalty.bonusOperations.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   cursor?: string,
>   filter[
>     loyalties
>   ]?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination with cursors |
| `bonusOperations` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   nextCursor?: string
> }
> ```

> [accordion] bonusOperations full type
>
> ```ts theme={null}
> {
>   type?: string,
>   createdAt?: string,
>   amount?: number,
>   order?: {
>     id?: number,
>     externalId?: string
>   },
>   bonus?: {
>     activationDate?: string,
>     expireDate?: string
>   },
>   event?: {
>     id?: number,
>     type?: string
>   },
>   loyaltyAccount?: {
>     id?: number
>   },
>   loyalty?: {
>     id?: number
>   },
>   comment?: string
> }[]
> ```

***

### calculate.post

`loyalty.calculate.post`

Calculation of a maximum discount

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.loyalty.calculate.post({
	body: {
		order: { privilegeType: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   order?: {
>     privilegeType?: string | null,
>     discountManualAmount?: number | null,
>     discountManualPercent?: number | null,
>     customer?: {
>       id?: number,
>       externalId?: string
>     },
>     items?: {
>       initialPrice?: number | null,
>       discountManualAmount?: number | null,
>       discountManualPercent?: number | null,
>       quantity?: number | null,
>       offer?: {
>         id?: number,
>         externalId?: string,
>         xmlId?: string
>       } | null,
>       priceType?: {
>         code?: string
>       }
>     }[],
>     delivery?: {
>       cost?: number
>     },
>     applyRound?: boolean
>   },
>   bonuses?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `order` | `object` | No | — |
| `calculations` | `object[]` | No | — |
| `loyalty` | `object` | No | — |

> [accordion] order full type
>
> ```ts theme={null}
> {
>   bonusesCreditTotal?: number,
>   bonusesChargeTotal?: number,
>   currency?: string,
>   privilegeType?: string | null,
>   totalSumm?: number,
>   personalDiscountPercent?: number,
>   loyaltyAccount?: {
>     id?: number,
>     amount?: number
>   },
>   loyaltyLevel?: {
>     id?: number,
>     name: string
>   },
>   loyaltyEventDiscount?: {
>     id?: number,
>     loyaltyEvent?: {
>       type?: string
>     } | {
>       type?: string
>     } | {
>       type?: string
>     } | {
>     }
>   },
>   customer?: {
>     id?: number,
>     externalId?: string,
>     personalDiscount?: number
>   },
>   delivery?: {
>     cost?: number
>   },
>   site?: string,
>   items?: {
>     bonusesChargeTotal?: number,
>     bonusesCreditTotal?: number,
>     id?: number | null,
>     externalIds?: {
>       code?: string,
>       value?: string
>     }[],
>     priceType?: {
>       code?: string
>     },
>     initialPrice?: number | null,
>     discounts?: {
>       type?: string,
>       amount?: number
>     }[],
>     discountTotal?: number | null,
>     prices?: {
>       price?: number,
>       quantity?: number
>     }[] | null,
>     vatRate?: string | null,
>     quantity?: number | null,
>     offer?: {
>       id?: number | null,
>       externalId?: string,
>       xmlId?: string
>     }
>   }[]
> }
> ```

> [accordion] calculations full type
>
> ```ts theme={null}
> {
>   privilegeType?: string,
>   discount?: number,
>   creditBonuses?: number,
>   loyaltyEventDiscount?: {
>     id?: number,
>     loyaltyEvent?: {
>       type?: string
>     } | {
>       type?: string
>     } | {
>       type?: string
>     } | {
>     }
>   },
>   maxChargeBonuses?: number,
>   maximum?: boolean
> }[]
> ```

> [accordion] loyalty full type
>
> ```ts theme={null}
> {
>   currency?: string,
>   name: string,
>   chargeRate: number
> }
> ```

***

### getAccountById.get

`loyalty.getAccountById.get`

Getting information about participation in the loyalty program

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.loyalty.getAccountById.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `loyaltyAccount` | `object` | No | Participation in the loyalty program |

> [accordion] loyaltyAccount full type
>
> ```ts theme={null}
> {
>   active?: boolean,
>   id?: number,
>   loyalty: {
>     currency?: string,
>     id?: number,
>     promoChargeAllowed?: boolean,
>     minResidualCost?: number
>   },
>   customer: {
>     id?: number,
>     externalId?: string,
>     site?: string,
>     customFields?: custom[] | {
>     },
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null
>   },
>   phoneNumber?: string,
>   cardNumber?: string,
>   amount?: number,
>   ordersSum?: number,
>   nextLevelSum?: number,
>   level: {
>     type?: string,
>     id?: number,
>     name: string,
>     sum?: number,
>     privilegeSize?: number,
>     privilegeSizePromo?: number,
>     creditConditions?: {
>       id?: number,
>       privilegeSize?: number,
>       privilegeSizePromo?: number,
>       items?: (
>         {
>           id?: number,
>           offer?: {
>             displayName?: string,
>             id?: number | null,
>             externalId?: string,
>             xmlId?: string,
>             name: string,
>             article?: string,
>             properties?: custom[] | {
>             },
>             active?: boolean
>           }
>         } | {
>           id?: number,
>           offer?: {
>             displayName?: string,
>             id?: number | null,
>             externalId?: string,
>             xmlId?: string,
>             name: string,
>             article?: string,
>             properties?: custom[] | {
>             },
>             active?: boolean
>           }
>         } | {
>           id?: number,
>           product?: {
>             id?: number,
>             name: string,
>             externalId?: string,
>             active?: boolean
>           }
>         } | {
>           id?: number,
>           productGroup?: {
>             id?: number,
>             name: string,
>             externalId?: string,
>             active?: boolean
>           }
>         } | {
>           id?: number,
>           manufacturer?: string
>         }
>       )[]
>     }[]
>   },
>   createdAt?: string,
>   activatedAt?: string,
>   confirmedPhoneAt?: string,
>   lastCheckId?: string,
>   status?: string,
>   customFields?: custom[] | {
>   }
> }
> ```

***

### getAccountByIdBonusByStatusDetails.get

`loyalty.getAccountByIdBonusByStatusDetails.get`

Getting details on the bonus account

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.loyalty.getAccountByIdBonusByStatusDetails.get({
	path: { id: 1, status: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number,
>   status: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     date
>   ]?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `statistic` | `object` | No | Bonus statistics |
| `bonuses` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] statistic full type
>
> ```ts theme={null}
> {
>   totalAmount?: number
> }
> ```

> [accordion] bonuses full type
>
> ```ts theme={null}
> {
>   date?: string,
>   amount?: number
> }[]
> ```

***

### getAccountByIdBonusOperations.get

`loyalty.getAccountByIdBonusOperations.get`

History of the bonus account for a specific participation

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.loyalty.getAccountByIdBonusOperations.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     createdAtFrom
>   ]?: string,
>   filter[
>     createdAtTo
>   ]?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `bonusOperations` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] bonusOperations full type
>
> ```ts theme={null}
> {
>   type?: string,
>   createdAt?: string,
>   amount?: number,
>   order?: {
>     id?: number,
>     externalId?: string
>   },
>   bonus?: {
>     activationDate?: string,
>     expireDate?: string
>   },
>   event?: {
>     id?: number,
>     type?: string
>   },
>   comment?: string
> }[]
> ```

***

### getLoyaltiesById.get

`loyalty.getLoyaltiesById.get`

Getting information about the loyalty program

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.loyalty.getLoyaltiesById.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `loyalty` | `object` | No | Loyalty program |

> [accordion] loyalty full type
>
> ```ts theme={null}
> {
>   levels?: {
>     type?: string,
>     id?: number,
>     name: string,
>     sum?: number,
>     privilegeSize?: number,
>     privilegeSizePromo?: number,
>     creditConditions?: {
>       id?: number,
>       privilegeSize?: number,
>       privilegeSizePromo?: number,
>       items?: (
>         {
>           id?: number,
>           offer?: {
>             displayName?: string,
>             id?: number | null,
>             externalId?: string,
>             xmlId?: string,
>             name: string,
>             article?: string,
>             vatRate?: string,
>             properties?: custom[] | {
>             },
>             active?: boolean,
>             unit?: {
>               code?: string,
>               name?: string,
>               sym?: string
>             },
>             barcode?: string
>           }
>         } | {
>           id?: number,
>           offer?: {
>             displayName?: string,
>             id?: number | null,
>             externalId?: string,
>             xmlId?: string,
>             name: string,
>             article?: string,
>             vatRate?: string,
>             properties?: custom[] | {
>             },
>             active?: boolean,
>             unit?: {
>               code?: string,
>               name?: string,
>               sym?: string
>             },
>             barcode?: string
>           }
>         } | {
>           id?: number,
>           product?: {
>             id?: number,
>             name: string,
>             externalId?: string,
>             active?: boolean
>           }
>         } | {
>           id?: number,
>           productGroup?: {
>             id?: number,
>             name: string,
>             externalId?: string,
>             active?: boolean
>           }
>         } | {
>           id?: number,
>           manufacturer?: string
>         }
>       )[]
>     }[]
>   }[],
>   expirePeriod?: string,
>   burnSettings?: {
>     id?: number,
>     period?: string,
>     percent?: number
>   }[],
>   active?: boolean,
>   blocked?: boolean,
>   currency?: string,
>   id?: number,
>   name: string,
>   burnType?: number,
>   confirmSmsCharge?: boolean,
>   confirmSmsRegistration?: boolean,
>   maxChargePercent: number,
>   chargeRate: number,
>   minResidualCost?: number,
>   events?: (
>     {
>       id?: number,
>       privilegeType?: custom,
>       privilegeSize?: number,
>       privilegeSizePromo?: number,
>       expirePeriod?: string,
>       activatePeriod?: custom,
>       discountOneOrderOnly?: boolean,
>       activatedAt?: string,
>       discountForAllProducts?: boolean,
>       type?: string,
>       afterFirstOrder?: boolean
>     } | {
>       id?: number,
>       privilegeType?: custom,
>       privilegeSize?: number,
>       privilegeSizePromo?: number,
>       expirePeriod?: string,
>       activatePeriod?: custom,
>       discountOneOrderOnly?: boolean,
>       activatedAt?: string,
>       discountForAllProducts?: boolean,
>       type?: string,
>       afterFirstOrder?: boolean
>     } | {
>       id?: number,
>       privilegeType?: custom,
>       privilegeSize?: number,
>       privilegeSizePromo?: number,
>       expirePeriod?: string,
>       activatePeriod?: custom,
>       discountOneOrderOnly?: boolean,
>       activatedAt?: string,
>       discountForAllProducts?: boolean,
>       type?: string,
>       beforePeriod?: string
>     }
>   )[],
>   createdAt?: string,
>   activatedAt?: string,
>   deactivatedAt?: string,
>   blockedAt?: string
> }
> ```

***

### loyalties.get

`loyalty.loyalties.get`

List of loyalty programs

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.loyalty.loyalties.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     active
>   ]?: boolean,
>   filter[
>     blocked
>   ]?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `loyalties` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] loyalties full type
>
> ```ts theme={null}
> {
>   levels?: {
>     type?: string,
>     id?: number,
>     name: string,
>     sum?: number,
>     privilegeSize?: number,
>     privilegeSizePromo?: number
>   }[],
>   active?: boolean,
>   blocked?: boolean,
>   currency?: string,
>   id?: number,
>   name: string,
>   confirmSmsCharge?: boolean,
>   confirmSmsRegistration?: boolean,
>   minResidualCost?: number,
>   createdAt?: string,
>   activatedAt?: string,
>   deactivatedAt?: string,
>   blockedAt?: string
> }[]
> ```

***

## Notifications

### send.post

`notifications.send.post`

Sending notification

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.notifications.send.post({
	body: {
		notification: { type: 'api.info', message: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   notification?: {
>     type: custom,
>     message: string,
>     userIds?: number[],
>     userGroups?: custom[]
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

## Orders

### byExternalidDeliveryCancel.post

`orders.byExternalidDeliveryCancel.post`

Cancellation of the integrated delivery

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.orders.byExternalidDeliveryCancel.post({
	path: { externalId: 'demo' },
	body: { by: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   by?: string,
>   force?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### byExternalidEdit.post

`orders.byExternalidEdit.post`

Order editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.orders.byExternalidEdit.post({
	path: { externalId: 'demo' },
	body: {
		order: { number: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   by?: string,
>   site?: string,
>   order?: {
>     number?: string,
>     externalId?: string,
>     privilegeType?: string | null,
>     countryIso?: string,
>     createdAt?: string,
>     discountManualAmount?: number | null,
>     discountManualPercent?: number | null,
>     mark?: number,
>     markDatetime?: string,
>     lastName?: string,
>     firstName?: string,
>     patronymic?: string,
>     phone?: string,
>     additionalPhone?: string,
>     email?: string,
>     call?: boolean,
>     expired?: boolean,
>     customerComment?: string | null,
>     managerComment?: string | null,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     statusComment?: string,
>     weight?: number | null,
>     length?: number,
>     width?: number,
>     height?: number,
>     shipmentDate?: string | null,
>     shipped?: boolean,
>     dialogId?: {
>     },
>     customFields?: custom[] | {
>     },
>     orderType?: string,
>     orderMethod?: string,
>     customer?: {
>       id?: number,
>       externalId?: string,
>       browserId?: string,
>       site?: string,
>       type?: string,
>       nickName?: string
>     },
>     contact?: {
>       id?: number,
>       externalId?: string,
>       browserId?: string,
>       site?: string
>     },
>     company?: {
>       id?: number,
>       externalId?: string
>     },
>     managerId?: number,
>     status?: string,
>     items?: {
>       markingCodes?: string[],
>       markingObjects?: {
>         code: string,
>         provider: custom
>       }[],
>       id?: number | null,
>       initialPrice?: number | null,
>       discountManualAmount?: number | null,
>       discountManualPercent?: number | null,
>       vatRate?: string | null,
>       createdAt?: string,
>       quantity?: number | null,
>       comment?: string,
>       properties?: {
>         code: string,
>         name: string,
>         value: string
>       }[],
>       purchasePrice?: number,
>       ordering?: number,
>       offer?: {
>         id?: number,
>         externalId?: string,
>         xmlId?: string
>       } | null,
>       productName?: string,
>       status?: string,
>       priceType?: {
>         code?: string
>       },
>       externalId?: string,
>       externalIds?: {
>         code?: string,
>         value?: string
>       }[] | null
>     }[],
>     delivery?: {
>       code?: string,
>       data?: {
>         externalId?: string,
>         trackNumber?: string,
>         locked?: boolean,
>         tariff?: string,
>         pickuppointId?: string,
>         payerType?: string,
>         shipmentpointId?: string,
>         extraData?: custom[] | {
>         },
>         itemDeclaredValues?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           value?: number
>         }[],
>         packages?: {
>           packageId?: string,
>           weight?: number,
>           length?: number,
>           width?: number,
>           height?: number,
>           items?: {
>             orderProduct?: {
>               id?: number,
>               externalId?: string,
>               externalIds?: {
>                 code?: string,
>                 value?: string
>               }[] | null
>             },
>             quantity?: number
>           }[] | null
>         }[] | null
>       } | {
>         externalId?: string,
>         trackNumber?: string,
>         locked?: boolean,
>         tariff?: string,
>         pickuppointId?: string,
>         payerType?: string,
>         shipmentpointId?: string,
>         extraData?: custom[] | {
>         },
>         itemDeclaredValues?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           value?: number
>         }[],
>         packages?: {
>           packageId?: string,
>           weight?: number,
>           length?: number,
>           width?: number,
>           height?: number,
>           items?: {
>             orderProduct?: {
>               id?: number,
>               externalId?: string,
>               externalIds?: {
>                 code?: string,
>                 value?: string
>               }[] | null
>             },
>             quantity?: number
>           }[] | null
>         }[] | null
>       } | {
>         locked?: boolean,
>         courierId?: number
>       } | {
>         trackNumber?: string,
>         locked?: boolean,
>         serviceType?: string,
>         pickuppoint?: string,
>         pickuppointId?: string,
>         receiverWarehouseTypeRef?: string,
>         shipmentpointId?: string,
>         receiverCity?: string,
>         receiverCityRef?: string,
>         receiverStreet?: string,
>         receiverStreetRef?: string,
>         seatsAmount?: number,
>         cargoType?: string,
>         cargoDescription?: string,
>         payerType?: string,
>         cashPayerType?: string,
>         paymentForm?: string,
>         ownershipForm?: string,
>         packageNumber?: string,
>         accompanyingDocument?: string,
>         notes?: string,
>         preferredDeliveryDate?: string | null,
>         backwardDelivery?: boolean,
>         backwardDeliveryCargoType?: string,
>         backwardDeliveryPayerType?: string,
>         backwardDeliveryRedeliveryString?: string,
>         afterpaymentOnGoodsCost?: number,
>         declaredValue?: number,
>         sendDate?: string,
>         itemDeclaredValues?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           value?: number
>         }[]
>       } | {
>         locked?: boolean,
>         deliveryType?: string,
>         pickuppointId?: string,
>         pickupType?: number | null,
>         receiverCity?: string,
>         receiverCityRef?: string,
>         placesCount?: number | null,
>         services?: string[],
>         comment?: string,
>         itemDeclaredValues?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           value?: number
>         }[]
>       } | {
>         trackNumber?: string,
>         locked?: boolean
>       },
>       service?: {
>         name?: string | null,
>         code?: string | null,
>         active?: boolean,
>         deliveryType?: string
>       },
>       cost?: number,
>       netCost?: number,
>       date?: string,
>       time?: {
>         from?: string | null,
>         to?: string | null,
>         custom?: string | null
>       },
>       address?: {
>         index?: string | null,
>         countryIso?: string | null,
>         region?: string | null,
>         regionId?: number | null,
>         city?: string | null,
>         cityId?: number | null,
>         cityType?: string,
>         street?: string | null,
>         streetId?: number | null,
>         streetType?: string,
>         building?: string | null,
>         flat?: string | null,
>         floor?: number | null,
>         block?: number | null,
>         house?: string | null,
>         housing?: string,
>         metro?: string | null,
>         notes?: string | null,
>         text?: string
>       },
>       vatRate?: string | null
>     },
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     shipmentStore?: string,
>     loyaltyEventDiscountId?: number,
>     applyRound?: boolean,
>     isFromCart?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Order internal ID |
| `order` | `object` | No | Order |
| `state` | `string \| null` | No | Order condition (not returned by default) |

> [accordion] order full type
>
> ```ts theme={null}
> {
>   slug?: number,
>   bonusesCreditTotal?: number,
>   bonusesChargeTotal?: number,
>   summ?: number,
>   currency?: string,
>   id?: number,
>   number?: string,
>   externalId?: string,
>   orderType?: string,
>   orderMethod?: string,
>   privilegeType?: string | null,
>   countryIso?: string,
>   createdAt?: string,
>   statusUpdatedAt?: string,
>   totalSumm?: number,
>   prepaySum?: number,
>   purchaseSumm?: number,
>   personalDiscountPercent?: number,
>   loyaltyLevel?: {
>     id?: number,
>     name: string
>   },
>   loyaltyEventDiscount?: {
>     id?: number
>   },
>   mark?: number,
>   markDatetime?: string,
>   lastName?: string,
>   firstName?: string,
>   patronymic?: string,
>   phone?: string,
>   additionalPhone?: string,
>   email?: string,
>   call?: boolean,
>   expired?: boolean,
>   customerComment?: string | null,
>   managerComment?: string | null,
>   managerId?: number,
>   customer?: {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   } | {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   } | {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     mainAddress?: {
>       id?: number,
>       externalId?: string,
>       name?: string
>     },
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     mainCustomerContact?: {
>       id?: number,
>       customer?: {
>         id?: number,
>         externalId?: string,
>         browserId?: string
>       } | null,
>       companies?: {
>         id?: number,
>         company?: {
>           id?: number,
>           externalId?: string,
>           name?: string
>         } | null
>       }[]
>     },
>     mainCompany?: {
>       id?: number,
>       externalId?: string,
>       name?: string
>     },
>     nickName?: string
>   },
>   contact?: {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   },
>   company?: {
>     id?: number,
>     externalId?: string,
>     customer?: {
>       site?: string,
>       id?: number,
>       externalId?: string,
>       type?: string
>     } | null,
>     active?: boolean,
>     name?: string,
>     brand?: string,
>     site?: string,
>     createdAt?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     } | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     } | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     costSumm?: number | null,
>     ordersCount?: number | null,
>     customFields?: custom[] | {
>     }
>   },
>   contragent?: {
>     contragentType?: string | null,
>     legalName?: string,
>     legalAddress?: string,
>     INN?: string,
>     OKPO?: string,
>     KPP?: string,
>     OGRN?: string,
>     OGRNIP?: string,
>     certificateNumber?: string,
>     certificateDate?: string | null,
>     BIK?: string,
>     bank?: string,
>     bankAddress?: string,
>     corrAccount?: string,
>     bankAccount?: string
>   },
>   delivery?: {
>     code?: string,
>     integrationCode?: string,
>     data?: {
>       externalId?: string,
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppointAddress?: string,
>       days?: string,
>       statusText?: string,
>       statusDate?: string,
>       tariff?: string,
>       tariffName?: string,
>       pickuppointId?: string,
>       pickuppointSchedule?: string,
>       pickuppointPhone?: string,
>       payerType?: string,
>       statusComment?: string,
>       cost?: number | null,
>       minTerm?: number,
>       maxTerm?: number,
>       shipmentpointId?: string,
>       shipmentpointName?: string,
>       shipmentpointAddress?: string,
>       shipmentpointSchedule?: string,
>       shipmentpointPhone?: string,
>       shipmentpointCoordinateLatitude?: string,
>       shipmentpointCoordinateLongitude?: string,
>       pickuppointName?: string,
>       pickuppointCoordinateLatitude?: string,
>       pickuppointCoordinateLongitude?: string,
>       extraData?: custom[] | {
>       },
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[],
>       packages?: {
>         packageId?: string,
>         weight?: number,
>         length?: number,
>         width?: number,
>         height?: number,
>         items?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           quantity?: number
>         }[] | null
>       }[] | null
>     } | {
>       externalId?: string,
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppointAddress?: string,
>       days?: string,
>       statusText?: string,
>       statusDate?: string,
>       tariff?: string,
>       tariffName?: string,
>       pickuppointId?: string,
>       pickuppointSchedule?: string,
>       pickuppointPhone?: string,
>       payerType?: string,
>       statusComment?: string,
>       cost?: number | null,
>       minTerm?: number,
>       maxTerm?: number,
>       shipmentpointId?: string,
>       shipmentpointName?: string,
>       shipmentpointAddress?: string,
>       shipmentpointSchedule?: string,
>       shipmentpointPhone?: string,
>       shipmentpointCoordinateLatitude?: string,
>       shipmentpointCoordinateLongitude?: string,
>       pickuppointName?: string,
>       pickuppointCoordinateLatitude?: string,
>       pickuppointCoordinateLongitude?: string,
>       extraData?: custom[] | {
>       },
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[],
>       packages?: {
>         packageId?: string,
>         weight?: number,
>         length?: number,
>         width?: number,
>         height?: number,
>         items?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           quantity?: number
>         }[] | null
>       }[] | null
>     } | {
>       locked?: boolean,
>       id?: number,
>       firstName?: string,
>       lastName?: string,
>       patronymic?: string,
>       active?: boolean,
>       email?: string,
>       phone?: {
>         number?: string | null
>       },
>       description?: string,
>       courierId?: number
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       statusDate?: string,
>       serviceType?: string,
>       days?: string,
>       pickuppoint?: string,
>       pickuppointId?: string,
>       receiverWarehouseTypeRef?: string,
>       statusName?: string,
>       price?: number | null,
>       shipmentpointId?: string,
>       receiverCity?: string,
>       receiverCityRef?: string,
>       receiverStreet?: string,
>       receiverStreetRef?: string,
>       seatsAmount?: number,
>       cargoType?: string,
>       cargoDescription?: string,
>       payerType?: string,
>       cashPayerType?: string,
>       paymentForm?: string,
>       ownershipForm?: string,
>       packageNumber?: string,
>       accompanyingDocument?: string,
>       notes?: string,
>       preferredDeliveryDate?: string | null,
>       timeInterval?: string,
>       saturdayDelivery?: boolean,
>       deliveryDate?: string,
>       denieReason?: string | null,
>       backwardDelivery?: boolean,
>       backwardDeliveryCargoType?: string,
>       backwardDeliveryPayerType?: string,
>       backwardDeliveryRedeliveryString?: string,
>       afterpaymentOnGoodsCost?: number,
>       declaredValue?: number,
>       sendDate?: string,
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[]
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppoint?: string,
>       statusText?: string,
>       deliveryType?: string,
>       deliveryName?: string,
>       pickuppointId?: string,
>       days?: string,
>       pickupType?: number | null,
>       cost?: number | null,
>       receiverCity?: string,
>       receiverCityRef?: string,
>       pickuppointSchedule?: string,
>       pickuppointDescription?: string,
>       placesCount?: number | null,
>       services?: string[],
>       comment?: string,
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[]
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       statusText?: string
>     },
>     service?: {
>       name?: string | null,
>       code?: string | null,
>       active?: boolean
>     },
>     cost?: number,
>     netCost?: number,
>     date?: string,
>     time?: {
>       from?: string | null,
>       to?: string | null,
>       custom?: string | null
>     },
>     address?: {
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string
>     },
>     vatRate?: string | null
>   },
>   site?: string,
>   status?: string,
>   statusComment?: string,
>   source?: {
>     source?: string,
>     medium?: string,
>     campaign?: string,
>     keyword?: string,
>     content?: string
>   },
>   items?: {
>     externalId?: string,
>     bonusesChargeTotal?: number,
>     bonusesCreditTotal?: number,
>     markingCodes?: string[],
>     markingObjects?: {
>       code: string,
>       provider?: custom
>     }[],
>     id?: number | null,
>     externalIds?: {
>       code?: string,
>       value?: string
>     }[],
>     priceType?: {
>       code?: string
>     },
>     initialPrice?: number | null,
>     discounts?: {
>       type?: string,
>       amount?: number
>     }[],
>     discountTotal?: number | null,
>     prices?: {
>       price?: number,
>       quantity?: number
>     }[] | null,
>     vatRate?: string | null,
>     createdAt?: string,
>     quantity?: number | null,
>     status?: string,
>     comment?: string,
>     offer?: {
>       displayName?: string,
>       id?: number | null,
>       externalId?: string,
>       xmlId?: string,
>       name: string,
>       article?: string,
>       vatRate?: string,
>       properties?: custom[] | {
>       },
>       unit?: {
>         code?: string,
>         name?: string,
>         sym?: string
>       },
>       barcode?: string
>     },
>     isCanceled?: boolean,
>     properties?: {
>       code: string,
>       name: string,
>       value: string
>     }[],
>     purchasePrice?: number | null,
>     ordering?: number
>   }[],
>   fullPaidAt?: string,
>   payments?: {
>   },
>   fromApi?: boolean,
>   weight?: number | null,
>   length?: number,
>   width?: number,
>   height?: number,
>   shipmentStore?: string,
>   shipmentDate?: string | null,
>   shipped?: boolean,
>   links?: {
>     order?: {
>       id?: number,
>       number?: string,
>       externalId?: string
>     },
>     createdAt?: string,
>     comment?: string
>   }[],
>   customFields?: custom[] | {
>   },
>   clientId?: string
> }
> ```

***

### byExternalidPlatesByPlateidPrint.get

`orders.byExternalidPlatesByPlateidPrint.get`

Getting the file of the printed form for the order

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.orders.byExternalidPlatesByPlateidPrint.get({
	path: { externalId: 'demo', plateId: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

Returns the printed form as a file stream, so the output is a base64 envelope (`kind`, `contentType`, `base64`) capped at 20 MiB.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown,
>   plateId: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |

***

### combine.post

`orders.combine.post`

Combining of orders

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.orders.combine.post({
	body: {
		order: { id: 1 },
		resultOrder: { id: 1 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   order: {
>     id: number
>   },
>   resultOrder: {
>     id: number
>   },
>   technique?: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `errors` | `custom[] \| object` | No | Errors when combining of orders |

> [accordion] errors full type
>
> ```ts theme={null}
> custom[] | {
> }
> ```

***

### create.post

`orders.create.post`

Order creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.orders.create.post({
	body: {
		order: { number: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   order?: {
>     number?: string,
>     externalId?: string,
>     privilegeType?: string | null,
>     countryIso?: string,
>     createdAt?: string,
>     statusUpdatedAt?: string,
>     discountManualAmount?: number | null,
>     discountManualPercent?: number | null,
>     mark?: number,
>     markDatetime?: string,
>     lastName?: string,
>     firstName?: string,
>     patronymic?: string,
>     phone?: string,
>     additionalPhone?: string,
>     email?: string,
>     call?: boolean,
>     expired?: boolean,
>     customerComment?: string | null,
>     managerComment?: string | null,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     statusComment?: string,
>     weight?: number | null,
>     length?: number,
>     width?: number,
>     height?: number,
>     shipmentDate?: string | null,
>     shipped?: boolean,
>     dialogId?: {
>     },
>     customFields?: custom[] | {
>     },
>     orderType?: string,
>     orderMethod?: string,
>     customer?: {
>       id?: number,
>       externalId?: string,
>       browserId?: string,
>       site?: string,
>       type?: string,
>       nickName?: string
>     },
>     contact?: {
>       id?: number,
>       externalId?: string,
>       browserId?: string,
>       site?: string
>     },
>     company?: {
>       id?: number,
>       externalId?: string
>     },
>     managerId?: number,
>     status?: string,
>     items?: {
>       markingCodes?: string[],
>       markingObjects?: {
>         code: string,
>         provider: custom
>       }[],
>       initialPrice?: number | null,
>       discountManualAmount?: number | null,
>       discountManualPercent?: number | null,
>       vatRate?: string | null,
>       createdAt?: string,
>       quantity?: number | null,
>       comment?: string,
>       properties?: {
>         code: string,
>         name: string,
>         value: string
>       }[],
>       purchasePrice?: number,
>       ordering?: number,
>       offer?: {
>         id?: number,
>         externalId?: string,
>         xmlId?: string
>       } | null,
>       productName?: string,
>       status?: string,
>       priceType?: {
>         code?: string
>       },
>       externalId?: string,
>       externalIds?: {
>         code?: string,
>         value?: string
>       }[] | null
>     }[],
>     delivery?: {
>       code?: string,
>       data?: {
>         externalId?: string,
>         trackNumber?: string,
>         locked?: boolean,
>         tariff?: string,
>         pickuppointId?: string,
>         payerType?: string,
>         shipmentpointId?: string,
>         extraData?: custom[] | {
>         },
>         itemDeclaredValues?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           value?: number
>         }[],
>         packages?: {
>           packageId?: string,
>           weight?: number,
>           length?: number,
>           width?: number,
>           height?: number,
>           items?: {
>             orderProduct?: {
>               id?: number,
>               externalId?: string,
>               externalIds?: {
>                 code?: string,
>                 value?: string
>               }[] | null
>             },
>             quantity?: number
>           }[] | null
>         }[] | null
>       } | {
>         externalId?: string,
>         trackNumber?: string,
>         locked?: boolean,
>         tariff?: string,
>         pickuppointId?: string,
>         payerType?: string,
>         shipmentpointId?: string,
>         extraData?: custom[] | {
>         },
>         itemDeclaredValues?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           value?: number
>         }[],
>         packages?: {
>           packageId?: string,
>           weight?: number,
>           length?: number,
>           width?: number,
>           height?: number,
>           items?: {
>             orderProduct?: {
>               id?: number,
>               externalId?: string,
>               externalIds?: {
>                 code?: string,
>                 value?: string
>               }[] | null
>             },
>             quantity?: number
>           }[] | null
>         }[] | null
>       } | {
>         locked?: boolean,
>         courierId?: number
>       } | {
>         trackNumber?: string,
>         locked?: boolean,
>         serviceType?: string,
>         pickuppoint?: string,
>         pickuppointId?: string,
>         receiverWarehouseTypeRef?: string,
>         shipmentpointId?: string,
>         receiverCity?: string,
>         receiverCityRef?: string,
>         receiverStreet?: string,
>         receiverStreetRef?: string,
>         seatsAmount?: number,
>         cargoType?: string,
>         cargoDescription?: string,
>         payerType?: string,
>         cashPayerType?: string,
>         paymentForm?: string,
>         ownershipForm?: string,
>         packageNumber?: string,
>         accompanyingDocument?: string,
>         notes?: string,
>         preferredDeliveryDate?: string | null,
>         backwardDelivery?: boolean,
>         backwardDeliveryCargoType?: string,
>         backwardDeliveryPayerType?: string,
>         backwardDeliveryRedeliveryString?: string,
>         afterpaymentOnGoodsCost?: number,
>         declaredValue?: number,
>         sendDate?: string,
>         itemDeclaredValues?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           value?: number
>         }[]
>       } | {
>         locked?: boolean,
>         deliveryType?: string,
>         pickuppointId?: string,
>         pickupType?: number | null,
>         receiverCity?: string,
>         receiverCityRef?: string,
>         placesCount?: number | null,
>         services?: string[],
>         comment?: string,
>         itemDeclaredValues?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           value?: number
>         }[]
>       } | {
>         trackNumber?: string,
>         locked?: boolean
>       },
>       service?: {
>         name?: string | null,
>         code?: string | null,
>         active?: boolean,
>         deliveryType?: string
>       },
>       cost?: number,
>       netCost?: number,
>       date?: string,
>       time?: {
>         from?: string | null,
>         to?: string | null,
>         custom?: string | null
>       },
>       address?: {
>         index?: string | null,
>         countryIso?: string | null,
>         region?: string | null,
>         regionId?: number | null,
>         city?: string | null,
>         cityId?: number | null,
>         cityType?: string,
>         street?: string | null,
>         streetId?: number | null,
>         streetType?: string,
>         building?: string | null,
>         flat?: string | null,
>         floor?: number | null,
>         block?: number | null,
>         house?: string | null,
>         housing?: string,
>         metro?: string | null,
>         notes?: string | null,
>         text?: string
>       },
>       vatRate?: string | null
>     },
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     shipmentStore?: string,
>     payments?: {
>       externalId?: string,
>       amount?: number,
>       paidAt?: string | null,
>       comment?: string | null,
>       type: string,
>       status?: string
>     }[],
>     loyaltyEventDiscountId?: number,
>     applyRound?: boolean,
>     isFromCart?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created order |
| `order` | `object` | No | Order |

> [accordion] order full type
>
> ```ts theme={null}
> {
>   slug?: number,
>   bonusesCreditTotal?: number,
>   bonusesChargeTotal?: number,
>   summ?: number,
>   currency?: string,
>   id?: number,
>   number?: string,
>   externalId?: string,
>   orderType?: string,
>   orderMethod?: string,
>   privilegeType?: string | null,
>   countryIso?: string,
>   createdAt?: string,
>   statusUpdatedAt?: string,
>   totalSumm?: number,
>   prepaySum?: number,
>   purchaseSumm?: number,
>   personalDiscountPercent?: number,
>   loyaltyLevel?: {
>     id?: number,
>     name: string
>   },
>   loyaltyEventDiscount?: {
>     id?: number
>   },
>   mark?: number,
>   markDatetime?: string,
>   lastName?: string,
>   firstName?: string,
>   patronymic?: string,
>   phone?: string,
>   additionalPhone?: string,
>   email?: string,
>   call?: boolean,
>   expired?: boolean,
>   customerComment?: string | null,
>   managerComment?: string | null,
>   managerId?: number,
>   customer?: {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   } | {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   } | {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     mainAddress?: {
>       id?: number,
>       externalId?: string,
>       name?: string
>     },
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     mainCustomerContact?: {
>       id?: number,
>       customer?: {
>         id?: number,
>         externalId?: string,
>         browserId?: string
>       } | null,
>       companies?: {
>         id?: number,
>         company?: {
>           id?: number,
>           externalId?: string,
>           name?: string
>         } | null
>       }[]
>     },
>     mainCompany?: {
>       id?: number,
>       externalId?: string,
>       name?: string
>     },
>     nickName?: string
>   },
>   contact?: {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   },
>   company?: {
>     id?: number,
>     externalId?: string,
>     customer?: {
>       site?: string,
>       id?: number,
>       externalId?: string,
>       type?: string
>     } | null,
>     active?: boolean,
>     name?: string,
>     brand?: string,
>     site?: string,
>     createdAt?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     } | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     } | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     costSumm?: number | null,
>     ordersCount?: number | null,
>     customFields?: custom[] | {
>     }
>   },
>   contragent?: {
>     contragentType?: string | null,
>     legalName?: string,
>     legalAddress?: string,
>     INN?: string,
>     OKPO?: string,
>     KPP?: string,
>     OGRN?: string,
>     OGRNIP?: string,
>     certificateNumber?: string,
>     certificateDate?: string | null,
>     BIK?: string,
>     bank?: string,
>     bankAddress?: string,
>     corrAccount?: string,
>     bankAccount?: string
>   },
>   delivery?: {
>     code?: string,
>     integrationCode?: string,
>     data?: {
>       externalId?: string,
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppointAddress?: string,
>       days?: string,
>       statusText?: string,
>       statusDate?: string,
>       tariff?: string,
>       tariffName?: string,
>       pickuppointId?: string,
>       pickuppointSchedule?: string,
>       pickuppointPhone?: string,
>       payerType?: string,
>       statusComment?: string,
>       cost?: number | null,
>       minTerm?: number,
>       maxTerm?: number,
>       shipmentpointId?: string,
>       shipmentpointName?: string,
>       shipmentpointAddress?: string,
>       shipmentpointSchedule?: string,
>       shipmentpointPhone?: string,
>       shipmentpointCoordinateLatitude?: string,
>       shipmentpointCoordinateLongitude?: string,
>       pickuppointName?: string,
>       pickuppointCoordinateLatitude?: string,
>       pickuppointCoordinateLongitude?: string,
>       extraData?: custom[] | {
>       },
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[],
>       packages?: {
>         packageId?: string,
>         weight?: number,
>         length?: number,
>         width?: number,
>         height?: number,
>         items?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           quantity?: number
>         }[] | null
>       }[] | null
>     } | {
>       externalId?: string,
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppointAddress?: string,
>       days?: string,
>       statusText?: string,
>       statusDate?: string,
>       tariff?: string,
>       tariffName?: string,
>       pickuppointId?: string,
>       pickuppointSchedule?: string,
>       pickuppointPhone?: string,
>       payerType?: string,
>       statusComment?: string,
>       cost?: number | null,
>       minTerm?: number,
>       maxTerm?: number,
>       shipmentpointId?: string,
>       shipmentpointName?: string,
>       shipmentpointAddress?: string,
>       shipmentpointSchedule?: string,
>       shipmentpointPhone?: string,
>       shipmentpointCoordinateLatitude?: string,
>       shipmentpointCoordinateLongitude?: string,
>       pickuppointName?: string,
>       pickuppointCoordinateLatitude?: string,
>       pickuppointCoordinateLongitude?: string,
>       extraData?: custom[] | {
>       },
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[],
>       packages?: {
>         packageId?: string,
>         weight?: number,
>         length?: number,
>         width?: number,
>         height?: number,
>         items?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           quantity?: number
>         }[] | null
>       }[] | null
>     } | {
>       locked?: boolean,
>       id?: number,
>       firstName?: string,
>       lastName?: string,
>       patronymic?: string,
>       active?: boolean,
>       email?: string,
>       phone?: {
>         number?: string | null
>       },
>       description?: string,
>       courierId?: number
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       statusDate?: string,
>       serviceType?: string,
>       days?: string,
>       pickuppoint?: string,
>       pickuppointId?: string,
>       receiverWarehouseTypeRef?: string,
>       statusName?: string,
>       price?: number | null,
>       shipmentpointId?: string,
>       receiverCity?: string,
>       receiverCityRef?: string,
>       receiverStreet?: string,
>       receiverStreetRef?: string,
>       seatsAmount?: number,
>       cargoType?: string,
>       cargoDescription?: string,
>       payerType?: string,
>       cashPayerType?: string,
>       paymentForm?: string,
>       ownershipForm?: string,
>       packageNumber?: string,
>       accompanyingDocument?: string,
>       notes?: string,
>       preferredDeliveryDate?: string | null,
>       timeInterval?: string,
>       saturdayDelivery?: boolean,
>       deliveryDate?: string,
>       denieReason?: string | null,
>       backwardDelivery?: boolean,
>       backwardDeliveryCargoType?: string,
>       backwardDeliveryPayerType?: string,
>       backwardDeliveryRedeliveryString?: string,
>       afterpaymentOnGoodsCost?: number,
>       declaredValue?: number,
>       sendDate?: string,
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[]
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppoint?: string,
>       statusText?: string,
>       deliveryType?: string,
>       deliveryName?: string,
>       pickuppointId?: string,
>       days?: string,
>       pickupType?: number | null,
>       cost?: number | null,
>       receiverCity?: string,
>       receiverCityRef?: string,
>       pickuppointSchedule?: string,
>       pickuppointDescription?: string,
>       placesCount?: number | null,
>       services?: string[],
>       comment?: string,
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[]
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       statusText?: string
>     },
>     service?: {
>       name?: string | null,
>       code?: string | null,
>       active?: boolean
>     },
>     cost?: number,
>     netCost?: number,
>     date?: string,
>     time?: {
>       from?: string | null,
>       to?: string | null,
>       custom?: string | null
>     },
>     address?: {
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string
>     },
>     vatRate?: string | null
>   },
>   site?: string,
>   status?: string,
>   statusComment?: string,
>   source?: {
>     source?: string,
>     medium?: string,
>     campaign?: string,
>     keyword?: string,
>     content?: string
>   },
>   items?: {
>     externalId?: string,
>     bonusesChargeTotal?: number,
>     bonusesCreditTotal?: number,
>     markingCodes?: string[],
>     markingObjects?: {
>       code: string,
>       provider?: custom
>     }[],
>     id?: number | null,
>     externalIds?: {
>       code?: string,
>       value?: string
>     }[],
>     priceType?: {
>       code?: string
>     },
>     initialPrice?: number | null,
>     discounts?: {
>       type?: string,
>       amount?: number
>     }[],
>     discountTotal?: number | null,
>     prices?: {
>       price?: number,
>       quantity?: number
>     }[] | null,
>     vatRate?: string | null,
>     createdAt?: string,
>     quantity?: number | null,
>     status?: string,
>     comment?: string,
>     offer?: {
>       displayName?: string,
>       id?: number | null,
>       externalId?: string,
>       xmlId?: string,
>       name: string,
>       article?: string,
>       vatRate?: string,
>       properties?: custom[] | {
>       },
>       quantity?: number,
>       unit?: {
>         code?: string,
>         name?: string,
>         sym?: string
>       },
>       barcode?: string
>     },
>     isCanceled?: boolean,
>     properties?: {
>       code: string,
>       name: string,
>       value: string
>     }[],
>     purchasePrice?: number | null,
>     ordering?: number
>   }[],
>   fullPaidAt?: string,
>   payments?: {
>     id?: number,
>     status?: string,
>     type?: string,
>     externalId?: string,
>     amount?: number,
>     paidAt?: string | null,
>     comment?: string | null
>   }[],
>   fromApi?: boolean,
>   weight?: number | null,
>   length?: number,
>   width?: number,
>   height?: number,
>   shipmentStore?: string,
>   shipmentDate?: string | null,
>   shipped?: boolean,
>   links?: {
>     order?: {
>       id?: number,
>       number?: string,
>       externalId?: string
>     },
>     createdAt?: string,
>     comment?: string
>   }[],
>   customFields?: custom[] | {
>   },
>   clientId?: string
> }
> ```

***

### fixExternalIds.post

`orders.fixExternalIds.post`

The mass recording of orders external ID

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.orders.fixExternalIds.post({
	body: {
		orders: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   orders?: {
>     id: number,
>     externalId: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### getByExternalid.get

`orders.getByExternalid.get`

Getting information on order

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.orders.getByExternalid.get({
	path: { externalId: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `order` | `object` | No | Order |

> [accordion] order full type
>
> ```ts theme={null}
> {
>   slug?: number,
>   bonusesCreditTotal?: number,
>   bonusesChargeTotal?: number,
>   summ?: number,
>   currency?: string,
>   id?: number,
>   number?: string,
>   externalId?: string,
>   orderType?: string,
>   orderMethod?: string,
>   privilegeType?: string | null,
>   countryIso?: string,
>   createdAt?: string,
>   statusUpdatedAt?: string,
>   totalSumm?: number,
>   prepaySum?: number,
>   purchaseSumm?: number,
>   personalDiscountPercent?: number,
>   loyaltyLevel?: {
>     id?: number,
>     name: string
>   },
>   loyaltyEventDiscount?: {
>     id?: number
>   },
>   mark?: number,
>   markDatetime?: string,
>   lastName?: string,
>   firstName?: string,
>   patronymic?: string,
>   phone?: string,
>   additionalPhone?: string,
>   email?: string,
>   call?: boolean,
>   expired?: boolean,
>   customerComment?: string | null,
>   managerComment?: string | null,
>   managerId?: number,
>   customer?: {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   } | {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   } | {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     mainAddress?: {
>       id?: number,
>       externalId?: string,
>       name?: string
>     },
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     mainCustomerContact?: {
>       id?: number,
>       customer?: {
>         id?: number,
>         externalId?: string,
>         browserId?: string
>       } | null,
>       companies?: {
>         id?: number,
>         company?: {
>           id?: number,
>           externalId?: string,
>           name?: string
>         } | null
>       }[]
>     },
>     mainCompany?: {
>       id?: number,
>       externalId?: string,
>       name?: string
>     },
>     nickName?: string
>   },
>   contact?: {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   },
>   company?: {
>     id?: number,
>     externalId?: string,
>     customer?: {
>       site?: string,
>       id?: number,
>       externalId?: string,
>       type?: string
>     } | null,
>     active?: boolean,
>     name?: string,
>     brand?: string,
>     site?: string,
>     createdAt?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     } | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     } | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     costSumm?: number | null,
>     ordersCount?: number | null,
>     customFields?: custom[] | {
>     }
>   },
>   contragent?: {
>     contragentType?: string | null,
>     legalName?: string,
>     legalAddress?: string,
>     INN?: string,
>     OKPO?: string,
>     KPP?: string,
>     OGRN?: string,
>     OGRNIP?: string,
>     certificateNumber?: string,
>     certificateDate?: string | null,
>     BIK?: string,
>     bank?: string,
>     bankAddress?: string,
>     corrAccount?: string,
>     bankAccount?: string
>   },
>   delivery?: {
>     code?: string,
>     integrationCode?: string,
>     data?: {
>       externalId?: string,
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppointAddress?: string,
>       days?: string,
>       statusText?: string,
>       statusDate?: string,
>       tariff?: string,
>       tariffName?: string,
>       pickuppointId?: string,
>       pickuppointSchedule?: string,
>       pickuppointPhone?: string,
>       payerType?: string,
>       statusComment?: string,
>       cost?: number | null,
>       minTerm?: number,
>       maxTerm?: number,
>       shipmentpointId?: string,
>       shipmentpointName?: string,
>       shipmentpointAddress?: string,
>       shipmentpointSchedule?: string,
>       shipmentpointPhone?: string,
>       shipmentpointCoordinateLatitude?: string,
>       shipmentpointCoordinateLongitude?: string,
>       pickuppointName?: string,
>       pickuppointCoordinateLatitude?: string,
>       pickuppointCoordinateLongitude?: string,
>       extraData?: custom[] | {
>       },
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[],
>       packages?: {
>         packageId?: string,
>         weight?: number,
>         length?: number,
>         width?: number,
>         height?: number,
>         items?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           quantity?: number
>         }[] | null
>       }[] | null
>     } | {
>       externalId?: string,
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppointAddress?: string,
>       days?: string,
>       statusText?: string,
>       statusDate?: string,
>       tariff?: string,
>       tariffName?: string,
>       pickuppointId?: string,
>       pickuppointSchedule?: string,
>       pickuppointPhone?: string,
>       payerType?: string,
>       statusComment?: string,
>       cost?: number | null,
>       minTerm?: number,
>       maxTerm?: number,
>       shipmentpointId?: string,
>       shipmentpointName?: string,
>       shipmentpointAddress?: string,
>       shipmentpointSchedule?: string,
>       shipmentpointPhone?: string,
>       shipmentpointCoordinateLatitude?: string,
>       shipmentpointCoordinateLongitude?: string,
>       pickuppointName?: string,
>       pickuppointCoordinateLatitude?: string,
>       pickuppointCoordinateLongitude?: string,
>       extraData?: custom[] | {
>       },
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[],
>       packages?: {
>         packageId?: string,
>         weight?: number,
>         length?: number,
>         width?: number,
>         height?: number,
>         items?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           quantity?: number
>         }[] | null
>       }[] | null
>     } | {
>       locked?: boolean,
>       id?: number,
>       firstName?: string,
>       lastName?: string,
>       patronymic?: string,
>       active?: boolean,
>       email?: string,
>       phone?: {
>         number?: string | null
>       },
>       description?: string,
>       courierId?: number
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       statusDate?: string,
>       serviceType?: string,
>       days?: string,
>       pickuppoint?: string,
>       pickuppointId?: string,
>       receiverWarehouseTypeRef?: string,
>       statusName?: string,
>       price?: number | null,
>       shipmentpointId?: string,
>       receiverCity?: string,
>       receiverCityRef?: string,
>       receiverStreet?: string,
>       receiverStreetRef?: string,
>       seatsAmount?: number,
>       cargoType?: string,
>       cargoDescription?: string,
>       payerType?: string,
>       cashPayerType?: string,
>       paymentForm?: string,
>       ownershipForm?: string,
>       packageNumber?: string,
>       accompanyingDocument?: string,
>       notes?: string,
>       preferredDeliveryDate?: string | null,
>       timeInterval?: string,
>       saturdayDelivery?: boolean,
>       deliveryDate?: string,
>       denieReason?: string | null,
>       backwardDelivery?: boolean,
>       backwardDeliveryCargoType?: string,
>       backwardDeliveryPayerType?: string,
>       backwardDeliveryRedeliveryString?: string,
>       afterpaymentOnGoodsCost?: number,
>       declaredValue?: number,
>       sendDate?: string,
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[]
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppoint?: string,
>       statusText?: string,
>       deliveryType?: string,
>       deliveryName?: string,
>       pickuppointId?: string,
>       days?: string,
>       pickupType?: number | null,
>       cost?: number | null,
>       receiverCity?: string,
>       receiverCityRef?: string,
>       pickuppointSchedule?: string,
>       pickuppointDescription?: string,
>       placesCount?: number | null,
>       services?: string[],
>       comment?: string,
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[]
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       statusText?: string
>     },
>     service?: {
>       name?: string | null,
>       code?: string | null,
>       active?: boolean
>     },
>     cost?: number,
>     netCost?: number,
>     date?: string,
>     time?: {
>       from?: string | null,
>       to?: string | null,
>       custom?: string | null
>     },
>     address?: {
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string
>     },
>     vatRate?: string | null
>   },
>   site?: string,
>   status?: string,
>   statusComment?: string,
>   source?: {
>     source?: string,
>     medium?: string,
>     campaign?: string,
>     keyword?: string,
>     content?: string
>   },
>   items?: {
>     externalId?: string,
>     bonusesChargeTotal?: number,
>     bonusesCreditTotal?: number,
>     markingCodes?: string[],
>     markingObjects?: {
>       code: string,
>       provider?: custom
>     }[],
>     id?: number | null,
>     externalIds?: {
>       code?: string,
>       value?: string
>     }[],
>     priceType?: {
>       code?: string
>     },
>     initialPrice?: number | null,
>     discounts?: {
>       type?: string,
>       amount?: number
>     }[],
>     discountTotal?: number | null,
>     prices?: {
>       price?: number,
>       quantity?: number
>     }[] | null,
>     vatRate?: string | null,
>     createdAt?: string,
>     quantity?: number | null,
>     status?: string,
>     comment?: string,
>     offer?: {
>       displayName?: string,
>       id?: number | null,
>       externalId?: string,
>       xmlId?: string,
>       name: string,
>       article?: string,
>       vatRate?: string,
>       properties?: custom[] | {
>       },
>       quantity?: number,
>       unit?: {
>         code?: string,
>         name?: string,
>         sym?: string
>       },
>       barcode?: string
>     },
>     isCanceled?: boolean,
>     properties?: {
>       code: string,
>       name: string,
>       value: string
>     }[],
>     purchasePrice?: number | null,
>     ordering?: number
>   }[],
>   fullPaidAt?: string,
>   payments?: {
>   },
>   fromApi?: boolean,
>   weight?: number | null,
>   length?: number,
>   width?: number,
>   height?: number,
>   shipmentStore?: string,
>   shipmentDate?: string | null,
>   shipped?: boolean,
>   links?: {
>     order?: {
>       id?: number,
>       number?: string,
>       externalId?: string
>     },
>     createdAt?: string,
>     comment?: string
>   }[],
>   customFields?: custom[] | {
>   },
>   clientId?: string
> }
> ```

***

### history.get

`orders.history.get`

Getting the order change history

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.orders.history.get({
	query: { filter[orderId]: 0, filter[sinceId]: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     startDate
>   ]?: string,
>   filter[
>     endDate
>   ]?: string,
>   filter[
>     orderId
>   ]?: number,
>   filter[
>     orderExternalId
>   ]?: string,
>   filter[
>     sinceId
>   ]?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `generatedAt` | `string` | No | Time of response formation |
| `history` | `object[]` | No | — |
| `pagination` | `object` | No | Pagination |

> [accordion] history full type
>
> ```ts theme={null}
> {
>   id?: number,
>   createdAt?: string,
>   created?: boolean,
>   deleted?: boolean,
>   source?: string,
>   user?: {
>     id?: number
>   },
>   field?: string,
>   oldValue?: custom,
>   newValue?: custom,
>   apiKey?: {
>     current?: boolean,
>     id?: number
>   },
>   order?: {
>     id?: number,
>     externalId?: string,
>     managerId?: number,
>     site?: string,
>     status?: string
>   },
>   ancestor?: {
>     id?: number,
>     externalId?: string,
>     managerId?: number,
>     site?: string,
>     status?: string
>   },
>   item?: {
>     externalId?: string,
>     id?: number | null,
>     externalIds?: {
>       code?: string,
>       value?: string
>     }[],
>     discounts?: {
>       type?: string,
>       amount?: number
>     }[],
>     offer?: {
>       id?: number | null,
>       externalId?: string,
>       xmlId?: string,
>       properties?: custom[] | {
>       }
>     },
>     properties?: {
>       code: string,
>       name: string,
>       value: string
>     }[],
>     ordering?: number
>   },
>   payment?: {
>     id?: number,
>     type?: string,
>     externalId?: string
>   },
>   combinedTo?: {
>     id?: number,
>     externalId?: string,
>     managerId?: number,
>     site?: string,
>     status?: string
>   }
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

***

### linksCreate.post

`orders.linksCreate.post`

Creating a link between orders

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.orders.linksCreate.post({
	body: {
		link: { comment: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   link?: {
>     comment?: string,
>     orders?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     }[]
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### list.get

`orders.list.get`

Getting the list of orders matched the specified filter

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.orders.list.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     externalIds
>   ][]?: string[],
>   filter[
>     numbers
>   ][]?: string[],
>   filter[
>     customerId
>   ]?: number,
>   filter[
>     customerExternalId
>   ]?: string,
>   filter[
>     customer
>   ]?: string,
>   filter[
>     segment
>   ]?: string,
>   filter[
>     customerType
>   ]?: custom,
>   filter[
>     email
>   ]?: string,
>   filter[
>     managers
>   ][]?: number[],
>   filter[
>     managerGroups
>   ][]?: string[],
>   filter[
>     paymentStatuses
>   ][]?: string[],
>   filter[
>     orderTypes
>   ][]?: string[],
>   filter[
>     orderMethods
>   ][]?: string[],
>   filter[
>     product
>   ]?: string,
>   filter[
>     productSearchType
>   ]?: string,
>   filter[
>     extendedStatus
>   ][]?: string[],
>   filter[
>     statusHistorySequence
>   ][]?: string[],
>   filter[
>     statusComment
>   ]?: string,
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     vip
>   ]?: boolean,
>   filter[
>     bad
>   ]?: boolean,
>   filter[
>     expired
>   ]?: boolean,
>   filter[
>     call
>   ]?: boolean,
>   filter[
>     online
>   ]?: boolean,
>   filter[
>     paymentTypes
>   ][]?: string[],
>   filter[
>     deliveryStates
>   ][]?: custom[],
>   filter[
>     deliveryTypes
>   ][]?: string[],
>   filter[
>     deliveryServices
>   ][]?: string[],
>   filter[
>     countries
>   ][]?: string[],
>   filter[
>     region
>   ]?: string,
>   filter[
>     city
>   ]?: string,
>   filter[
>     index
>   ]?: string,
>   filter[
>     metro
>   ]?: string,
>   filter[
>     sourceName
>   ]?: string,
>   filter[
>     mediumName
>   ]?: string,
>   filter[
>     campaignName
>   ]?: string,
>   filter[
>     keywordName
>   ]?: string,
>   filter[
>     adContentName
>   ]?: string,
>   filter[
>     managerComment
>   ]?: string,
>   filter[
>     customerComment
>   ]?: string,
>   filter[
>     trackNumber
>   ]?: string,
>   filter[
>     deliveryExternalId
>   ]?: string,
>   filter[
>     couriers
>   ][]?: number[],
>   filter[
>     contragentName
>   ]?: string,
>   filter[
>     contragentTypes
>   ][]?: custom[],
>   filter[
>     contragentInn
>   ]?: string,
>   filter[
>     contragentKpp
>   ]?: string,
>   filter[
>     contragentBik
>   ]?: string,
>   filter[
>     contragentCorrAccount
>   ]?: string,
>   filter[
>     contragentBankAccount
>   ]?: string,
>   filter[
>     companyName
>   ]?: string,
>   filter[
>     deliveryAddressNotes
>   ]?: string,
>   filter[
>     productGroups
>   ][]?: number[],
>   filter[
>     shipmentStores
>   ][]?: string[],
>   filter[
>     shipped
>   ]?: boolean,
>   filter[
>     attachments
>   ]?: custom,
>   filter[
>     receiptFiscalDocumentAttribute
>   ]?: string,
>   filter[
>     receiptStatus
>   ]?: custom,
>   filter[
>     receiptOperation
>   ]?: custom,
>   filter[
>     receiptOrderStatus
>   ]?: custom,
>   filter[
>     mgChannels
>   ][]?: number[],
>   filter[
>     tasksCounts
>   ]?: custom,
>   filter[
>     tags
>   ][]?: string[],
>   filter[
>     attachedTags
>   ][]?: string[],
>   filter[
>     createdAtFrom
>   ]?: string,
>   filter[
>     createdAtTo
>   ]?: string,
>   filter[
>     fullPaidAtFrom
>   ]?: string,
>   filter[
>     fullPaidAtTo
>   ]?: string,
>   filter[
>     deliveryDateFrom
>   ]?: string,
>   filter[
>     deliveryDateTo
>   ]?: string,
>   filter[
>     statusUpdatedAtFrom
>   ]?: string,
>   filter[
>     statusUpdatedAtTo
>   ]?: string,
>   filter[
>     shipmentDateFrom
>   ]?: string,
>   filter[
>     shipmentDateTo
>   ]?: string,
>   filter[
>     firstWebVisitFrom
>   ]?: string,
>   filter[
>     firstWebVisitTo
>   ]?: string,
>   filter[
>     lastWebVisitFrom
>   ]?: string,
>   filter[
>     lastWebVisitTo
>   ]?: string,
>   filter[
>     firstOrderFrom
>   ]?: string,
>   filter[
>     firstOrderTo
>   ]?: string,
>   filter[
>     lastOrderFrom
>   ]?: string,
>   filter[
>     lastOrderTo
>   ]?: string,
>   filter[
>     paidAtFrom
>   ]?: string,
>   filter[
>     paidAtTo
>   ]?: string,
>   filter[
>     deliveryTimeFrom
>   ]?: string,
>   filter[
>     deliveryTimeTo
>   ]?: string,
>   filter[
>     minPrice
>   ]?: number,
>   filter[
>     maxPrice
>   ]?: number,
>   filter[
>     minCostSumm
>   ]?: number,
>   filter[
>     maxCostSumm
>   ]?: number,
>   filter[
>     minPrepaySumm
>   ]?: number,
>   filter[
>     maxPrepaySumm
>   ]?: number,
>   filter[
>     minDeliveryCost
>   ]?: number,
>   filter[
>     maxDeliveryCost
>   ]?: number,
>   filter[
>     minDeliveryNetCost
>   ]?: number,
>   filter[
>     maxDeliveryNetCost
>   ]?: number,
>   filter[
>     minMarginSumm
>   ]?: number,
>   filter[
>     maxMarginSumm
>   ]?: number,
>   filter[
>     minPurchaseSumm
>   ]?: number,
>   filter[
>     maxPurchaseSumm
>   ]?: number,
>   filter[
>     customFields
>   ]?: custom[] | {
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `orders` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] orders full type
>
> ```ts theme={null}
> {
>   slug?: number,
>   bonusesCreditTotal?: number,
>   bonusesChargeTotal?: number,
>   summ?: number,
>   currency?: string,
>   id?: number,
>   number?: string,
>   externalId?: string,
>   orderType?: string,
>   orderMethod?: string,
>   privilegeType?: string | null,
>   countryIso?: string,
>   createdAt?: string,
>   statusUpdatedAt?: string,
>   totalSumm?: number,
>   prepaySum?: number,
>   purchaseSumm?: number,
>   personalDiscountPercent?: number,
>   loyaltyLevel?: {
>     id?: number,
>     name: string
>   },
>   loyaltyEventDiscount?: {
>     id?: number
>   },
>   mark?: number,
>   markDatetime?: string,
>   lastName?: string,
>   firstName?: string,
>   patronymic?: string,
>   phone?: string,
>   additionalPhone?: string,
>   email?: string,
>   call?: boolean,
>   expired?: boolean,
>   customerComment?: string | null,
>   managerComment?: string | null,
>   managerId?: number,
>   customer?: {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   } | {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   } | {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     mainAddress?: {
>       id?: number,
>       externalId?: string,
>       name?: string
>     },
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     mainCustomerContact?: {
>       id?: number,
>       customer?: {
>         id?: number,
>         externalId?: string,
>         browserId?: string
>       } | null,
>       companies?: {
>         id?: number,
>         company?: {
>           id?: number,
>           externalId?: string,
>           name?: string
>         } | null
>       }[]
>     },
>     mainCompany?: {
>       id?: number,
>       externalId?: string,
>       name?: string
>     },
>     nickName?: string
>   },
>   contact?: {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   },
>   company?: {
>     id?: number,
>     externalId?: string,
>     customer?: {
>       site?: string,
>       id?: number,
>       externalId?: string,
>       type?: string
>     } | null,
>     active?: boolean,
>     name?: string,
>     brand?: string,
>     site?: string,
>     createdAt?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     } | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     } | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     costSumm?: number | null,
>     ordersCount?: number | null,
>     customFields?: custom[] | {
>     }
>   },
>   contragent?: {
>     contragentType?: string | null,
>     legalName?: string,
>     legalAddress?: string,
>     INN?: string,
>     OKPO?: string,
>     KPP?: string,
>     OGRN?: string,
>     OGRNIP?: string,
>     certificateNumber?: string,
>     certificateDate?: string | null,
>     BIK?: string,
>     bank?: string,
>     bankAddress?: string,
>     corrAccount?: string,
>     bankAccount?: string
>   },
>   delivery?: {
>     code?: string,
>     integrationCode?: string,
>     data?: {
>       externalId?: string,
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppointAddress?: string,
>       days?: string,
>       statusText?: string,
>       statusDate?: string,
>       tariff?: string,
>       tariffName?: string,
>       pickuppointId?: string,
>       pickuppointSchedule?: string,
>       pickuppointPhone?: string,
>       payerType?: string,
>       statusComment?: string,
>       cost?: number | null,
>       minTerm?: number,
>       maxTerm?: number,
>       shipmentpointId?: string,
>       shipmentpointName?: string,
>       shipmentpointAddress?: string,
>       shipmentpointSchedule?: string,
>       shipmentpointPhone?: string,
>       shipmentpointCoordinateLatitude?: string,
>       shipmentpointCoordinateLongitude?: string,
>       pickuppointName?: string,
>       pickuppointCoordinateLatitude?: string,
>       pickuppointCoordinateLongitude?: string,
>       extraData?: custom[] | {
>       },
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[],
>       packages?: {
>         packageId?: string,
>         weight?: number,
>         length?: number,
>         width?: number,
>         height?: number,
>         items?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           quantity?: number
>         }[] | null
>       }[] | null
>     } | {
>       externalId?: string,
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppointAddress?: string,
>       days?: string,
>       statusText?: string,
>       statusDate?: string,
>       tariff?: string,
>       tariffName?: string,
>       pickuppointId?: string,
>       pickuppointSchedule?: string,
>       pickuppointPhone?: string,
>       payerType?: string,
>       statusComment?: string,
>       cost?: number | null,
>       minTerm?: number,
>       maxTerm?: number,
>       shipmentpointId?: string,
>       shipmentpointName?: string,
>       shipmentpointAddress?: string,
>       shipmentpointSchedule?: string,
>       shipmentpointPhone?: string,
>       shipmentpointCoordinateLatitude?: string,
>       shipmentpointCoordinateLongitude?: string,
>       pickuppointName?: string,
>       pickuppointCoordinateLatitude?: string,
>       pickuppointCoordinateLongitude?: string,
>       extraData?: custom[] | {
>       },
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[],
>       packages?: {
>         packageId?: string,
>         weight?: number,
>         length?: number,
>         width?: number,
>         height?: number,
>         items?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           quantity?: number
>         }[] | null
>       }[] | null
>     } | {
>       locked?: boolean,
>       id?: number,
>       firstName?: string,
>       lastName?: string,
>       patronymic?: string,
>       active?: boolean,
>       email?: string,
>       phone?: {
>         number?: string | null
>       },
>       description?: string,
>       courierId?: number
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       statusDate?: string,
>       serviceType?: string,
>       days?: string,
>       pickuppoint?: string,
>       pickuppointId?: string,
>       receiverWarehouseTypeRef?: string,
>       statusName?: string,
>       price?: number | null,
>       shipmentpointId?: string,
>       receiverCity?: string,
>       receiverCityRef?: string,
>       receiverStreet?: string,
>       receiverStreetRef?: string,
>       seatsAmount?: number,
>       cargoType?: string,
>       cargoDescription?: string,
>       payerType?: string,
>       cashPayerType?: string,
>       paymentForm?: string,
>       ownershipForm?: string,
>       packageNumber?: string,
>       accompanyingDocument?: string,
>       notes?: string,
>       preferredDeliveryDate?: string | null,
>       timeInterval?: string,
>       saturdayDelivery?: boolean,
>       deliveryDate?: string,
>       denieReason?: string | null,
>       backwardDelivery?: boolean,
>       backwardDeliveryCargoType?: string,
>       backwardDeliveryPayerType?: string,
>       backwardDeliveryRedeliveryString?: string,
>       afterpaymentOnGoodsCost?: number,
>       declaredValue?: number,
>       sendDate?: string,
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[]
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppoint?: string,
>       statusText?: string,
>       deliveryType?: string,
>       deliveryName?: string,
>       pickuppointId?: string,
>       days?: string,
>       pickupType?: number | null,
>       cost?: number | null,
>       receiverCity?: string,
>       receiverCityRef?: string,
>       pickuppointSchedule?: string,
>       pickuppointDescription?: string,
>       placesCount?: number | null,
>       services?: string[],
>       comment?: string,
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[]
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       statusText?: string
>     },
>     service?: {
>       name?: string | null,
>       code?: string | null,
>       active?: boolean
>     },
>     cost?: number,
>     netCost?: number,
>     date?: string,
>     time?: {
>       from?: string | null,
>       to?: string | null,
>       custom?: string | null
>     },
>     address?: {
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string
>     },
>     vatRate?: string | null
>   },
>   site?: string,
>   status?: string,
>   statusComment?: string,
>   source?: {
>     source?: string,
>     medium?: string,
>     campaign?: string,
>     keyword?: string,
>     content?: string
>   },
>   items?: {
>     externalId?: string,
>     bonusesChargeTotal?: number,
>     bonusesCreditTotal?: number,
>     markingCodes?: string[],
>     markingObjects?: {
>       code: string,
>       provider?: custom
>     }[],
>     id?: number | null,
>     externalIds?: {
>       code?: string,
>       value?: string
>     }[],
>     priceType?: {
>       code?: string
>     },
>     initialPrice?: number | null,
>     discounts?: {
>       type?: string,
>       amount?: number
>     }[],
>     discountTotal?: number | null,
>     prices?: {
>       price?: number,
>       quantity?: number
>     }[] | null,
>     vatRate?: string | null,
>     createdAt?: string,
>     quantity?: number | null,
>     status?: string,
>     comment?: string,
>     offer?: {
>       displayName?: string,
>       id?: number | null,
>       externalId?: string,
>       xmlId?: string,
>       name: string,
>       article?: string,
>       vatRate?: string,
>       properties?: custom[] | {
>       },
>       unit?: {
>         code?: string,
>         name?: string,
>         sym?: string
>       },
>       barcode?: string
>     },
>     isCanceled?: boolean,
>     properties?: {
>       code: string,
>       name: string,
>       value: string
>     }[],
>     purchasePrice?: number | null,
>     ordering?: number
>   }[],
>   fullPaidAt?: string,
>   payments?: {
>   },
>   fromApi?: boolean,
>   weight?: number | null,
>   length?: number,
>   width?: number,
>   height?: number,
>   shipmentStore?: string,
>   shipmentDate?: string | null,
>   shipped?: boolean,
>   links?: {
>     order?: {
>       id?: number,
>       number?: string,
>       externalId?: string
>     },
>     createdAt?: string,
>     comment?: string
>   }[],
>   customFields?: custom[] | {
>   },
>   clientId?: string
> }[]
> ```

***

### loyaltyApply.post

`orders.loyaltyApply.post`

Applying bonuses according to the loyalty program

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.orders.loyaltyApply.post({
	body: {
		order: { id: 1 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   order?: {
>     id?: number,
>     externalId?: string,
>     number?: string,
>     applyRound?: boolean
>   },
>   bonuses?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `order` | `object` | No | — |
| `verification` | `object` | No | SMS-verification |

> [accordion] order full type
>
> ```ts theme={null}
> {
>   bonusesCreditTotal?: number,
>   bonusesChargeTotal?: number,
>   currency?: string,
>   privilegeType?: string | null,
>   totalSumm?: number,
>   personalDiscountPercent?: number,
>   loyaltyAccount?: {
>     id?: number,
>     amount?: number
>   },
>   loyaltyLevel?: {
>     id?: number,
>     name: string
>   },
>   loyaltyEventDiscount?: {
>     id?: number,
>     loyaltyEvent?: {
>       type?: string
>     } | {
>       type?: string
>     } | {
>       type?: string
>     } | {
>     }
>   },
>   customer?: {
>     id?: number,
>     externalId?: string,
>     personalDiscount?: number
>   },
>   delivery?: {
>     cost?: number
>   },
>   site?: string,
>   items?: {
>     bonusesChargeTotal?: number,
>     bonusesCreditTotal?: number,
>     id?: number | null,
>     externalIds?: {
>       code?: string,
>       value?: string
>     }[],
>     priceType?: {
>       code?: string
>     },
>     initialPrice?: number | null,
>     discounts?: {
>       type?: string,
>       amount?: number
>     }[],
>     discountTotal?: number | null,
>     prices?: {
>       price?: number,
>       quantity?: number
>     }[] | null,
>     vatRate?: string | null,
>     quantity?: number | null,
>     offer?: {
>       id?: number | null,
>       externalId?: string,
>       xmlId?: string
>     }
>   }[]
> }
> ```

> [accordion] verification full type
>
> ```ts theme={null}
> {
>   createdAt?: string,
>   expiredAt?: string,
>   verifiedAt?: string,
>   checkId?: string,
>   actionType?: string
> }
> ```

***

### loyaltyCancelBonusOperations.post

`orders.loyaltyCancelBonusOperations.post`

Cancellation of bonus operations on the Loyalty Program

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.orders.loyaltyCancelBonusOperations.post({
	body: {
		order: { id: 1 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   order?: {
>     id?: number,
>     externalId?: string,
>     number?: string,
>     applyRound?: boolean
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `order` | `object` | No | Order |

> [accordion] order full type
>
> ```ts theme={null}
> {
>   bonusesCreditTotal?: number,
>   bonusesChargeTotal?: number,
>   currency?: string,
>   privilegeType?: string | null,
>   totalSumm?: number,
>   personalDiscountPercent?: number,
>   loyaltyAccount?: {
>     id?: number,
>     amount?: number
>   },
>   loyaltyLevel?: {
>     id?: number,
>     name: string
>   },
>   loyaltyEventDiscount?: {
>     id?: number,
>     loyaltyEvent?: {
>       type?: string
>     } | {
>       type?: string
>     } | {
>       type?: string
>     } | {
>     }
>   },
>   delivery?: {
>     cost?: number
>   },
>   site?: string,
>   items?: {
>     bonusesChargeTotal?: number,
>     bonusesCreditTotal?: number,
>     id?: number | null,
>     externalIds?: {
>       code?: string,
>       value?: string
>     }[],
>     priceType?: {
>       code?: string
>     },
>     initialPrice?: number | null,
>     discounts?: {
>       type?: string,
>       amount?: number
>     }[],
>     discountTotal?: number | null,
>     prices?: {
>       price?: number,
>       quantity?: number
>     }[] | null,
>     vatRate?: string | null,
>     quantity?: number | null,
>     offer?: {
>       id?: number | null,
>       externalId?: string,
>       xmlId?: string
>     }
>   }[]
> }
> ```

***

### paymentsByIdDelete.post

`orders.paymentsByIdDelete.post`

Payment removing

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.orders.paymentsByIdDelete.post({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### paymentsByIdEdit.post

`orders.paymentsByIdEdit.post`

Payment editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.orders.paymentsByIdEdit.post({
	path: { id: 'demo' },
	body: {
		payment: { externalId: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   by?: string,
>   site?: string,
>   payment?: {
>     externalId?: string,
>     amount?: number,
>     paidAt?: string | null,
>     comment?: string | null,
>     status?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | ID of updated payment |

***

### paymentsCreate.post

`orders.paymentsCreate.post`

Payment creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.orders.paymentsCreate.post({
	body: {
		payment: {
			order: { id: 1 },
			type: 'demo',
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   payment?: {
>     externalId?: string,
>     amount?: number,
>     paidAt?: string | null,
>     comment?: string | null,
>     order: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     } | null,
>     type: string,
>     status?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | ID of created payment |

***

### statuses.get

`orders.statuses.get`

Getting the list of order statuses

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.orders.statuses.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   ids?: string[],
>   externalIds?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `orders` | `object[]` | No | — |

> [accordion] orders full type
>
> ```ts theme={null}
> {
>   id?: number,
>   externalId?: string,
>   status?: string,
>   group?: string,
>   number?: string
> }[]
> ```

***

### upload.post

`orders.upload.post`

Packet orders uploading

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.orders.upload.post({
	body: { site: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   orders?: {
>     number?: string,
>     externalId?: string,
>     privilegeType?: string | null,
>     countryIso?: string,
>     createdAt?: string,
>     statusUpdatedAt?: string,
>     discountManualAmount?: number | null,
>     discountManualPercent?: number | null,
>     mark?: number,
>     markDatetime?: string,
>     lastName?: string,
>     firstName?: string,
>     patronymic?: string,
>     phone?: string,
>     additionalPhone?: string,
>     email?: string,
>     call?: boolean,
>     expired?: boolean,
>     customerComment?: string | null,
>     managerComment?: string | null,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     statusComment?: string,
>     weight?: number | null,
>     length?: number,
>     width?: number,
>     height?: number,
>     shipmentDate?: string | null,
>     shipped?: boolean,
>     dialogId?: {
>     },
>     customFields?: custom[] | {
>     },
>     orderType?: string,
>     orderMethod?: string,
>     customer?: {
>       id?: number,
>       externalId?: string,
>       browserId?: string,
>       site?: string,
>       type?: string,
>       nickName?: string
>     },
>     contact?: {
>       id?: number,
>       externalId?: string,
>       browserId?: string,
>       site?: string
>     },
>     company?: {
>       id?: number,
>       externalId?: string
>     },
>     managerId?: number,
>     status?: string,
>     items?: {
>       markingCodes?: string[],
>       initialPrice?: number | null,
>       discountManualAmount?: number | null,
>       discountManualPercent?: number | null,
>       vatRate?: string | null,
>       createdAt?: string,
>       quantity?: number | null,
>       comment?: string,
>       properties?: {
>         code: string,
>         name: string,
>         value: string
>       }[],
>       purchasePrice?: number,
>       ordering?: number,
>       offer?: {
>         id?: number,
>         externalId?: string,
>         xmlId?: string
>       } | null,
>       productName?: string,
>       status?: string,
>       priceType?: {
>         code?: string
>       },
>       externalId?: string,
>       externalIds?: {
>         code?: string,
>         value?: string
>       }[] | null
>     }[],
>     delivery?: {
>       code?: string,
>       data?: {
>         externalId?: string,
>         trackNumber?: string,
>         locked?: boolean,
>         tariff?: string,
>         pickuppointId?: string,
>         payerType?: string,
>         shipmentpointId?: string,
>         extraData?: custom[] | {
>         },
>         itemDeclaredValues?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           value?: number
>         }[],
>         packages?: {
>           packageId?: string,
>           weight?: number,
>           length?: number,
>           width?: number,
>           height?: number,
>           items?: {
>             orderProduct?: {
>               id?: number,
>               externalId?: string,
>               externalIds?: {
>                 code?: string,
>                 value?: string
>               }[] | null
>             },
>             quantity?: number
>           }[] | null
>         }[] | null
>       } | {
>         externalId?: string,
>         trackNumber?: string,
>         locked?: boolean,
>         tariff?: string,
>         pickuppointId?: string,
>         payerType?: string,
>         shipmentpointId?: string,
>         extraData?: custom[] | {
>         },
>         itemDeclaredValues?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           value?: number
>         }[],
>         packages?: {
>           packageId?: string,
>           weight?: number,
>           length?: number,
>           width?: number,
>           height?: number,
>           items?: {
>             orderProduct?: {
>               id?: number,
>               externalId?: string,
>               externalIds?: {
>                 code?: string,
>                 value?: string
>               }[] | null
>             },
>             quantity?: number
>           }[] | null
>         }[] | null
>       } | {
>         locked?: boolean,
>         courierId?: number
>       } | {
>         trackNumber?: string,
>         locked?: boolean,
>         serviceType?: string,
>         pickuppoint?: string,
>         pickuppointId?: string,
>         receiverWarehouseTypeRef?: string,
>         shipmentpointId?: string,
>         receiverCity?: string,
>         receiverCityRef?: string,
>         receiverStreet?: string,
>         receiverStreetRef?: string,
>         seatsAmount?: number,
>         cargoType?: string,
>         cargoDescription?: string,
>         payerType?: string,
>         cashPayerType?: string,
>         paymentForm?: string,
>         ownershipForm?: string,
>         packageNumber?: string,
>         accompanyingDocument?: string,
>         notes?: string,
>         preferredDeliveryDate?: string | null,
>         backwardDelivery?: boolean,
>         backwardDeliveryCargoType?: string,
>         backwardDeliveryPayerType?: string,
>         backwardDeliveryRedeliveryString?: string,
>         afterpaymentOnGoodsCost?: number,
>         declaredValue?: number,
>         sendDate?: string,
>         itemDeclaredValues?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           value?: number
>         }[]
>       } | {
>         locked?: boolean,
>         deliveryType?: string,
>         pickuppointId?: string,
>         pickupType?: number | null,
>         receiverCity?: string,
>         receiverCityRef?: string,
>         placesCount?: number | null,
>         services?: string[],
>         comment?: string,
>         itemDeclaredValues?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           value?: number
>         }[]
>       } | {
>         trackNumber?: string,
>         locked?: boolean
>       },
>       service?: {
>         name?: string | null,
>         code?: string | null,
>         active?: boolean,
>         deliveryType?: string
>       },
>       cost?: number,
>       netCost?: number,
>       date?: string,
>       time?: {
>         from?: string | null,
>         to?: string | null,
>         custom?: string | null
>       },
>       address?: {
>         index?: string | null,
>         countryIso?: string | null,
>         region?: string | null,
>         regionId?: number | null,
>         city?: string | null,
>         cityId?: number | null,
>         cityType?: string,
>         street?: string | null,
>         streetId?: number | null,
>         streetType?: string,
>         building?: string | null,
>         flat?: string | null,
>         floor?: number | null,
>         block?: number | null,
>         house?: string | null,
>         housing?: string,
>         metro?: string | null,
>         notes?: string | null,
>         text?: string
>       },
>       vatRate?: string | null
>     },
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     shipmentStore?: string,
>     payments?: {
>       externalId?: string,
>       amount?: number,
>       paidAt?: string | null,
>       comment?: string | null,
>       type: string,
>       status?: string
>     }[],
>     loyaltyEventDiscountId?: number,
>     applyRound?: boolean,
>     isFromCart?: boolean
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `uploadedOrders` | `object[]` | No | — |
| `failedOrders` | `object[]` | No | — |
| `orders` | `object[] \| null` | No | — |

> [accordion] uploadedOrders full type
>
> ```ts theme={null}
> {
>   id: number,
>   externalId: string
> }[]
> ```

> [accordion] failedOrders full type
>
> ```ts theme={null}
> {
>   externalId?: string
> }[]
> ```

> [accordion] orders full type
>
> ```ts theme={null}
> {
>   slug?: number,
>   bonusesCreditTotal?: number,
>   bonusesChargeTotal?: number,
>   summ?: number,
>   currency?: string,
>   id?: number,
>   number?: string,
>   externalId?: string,
>   orderType?: string,
>   orderMethod?: string,
>   privilegeType?: string | null,
>   countryIso?: string,
>   createdAt?: string,
>   statusUpdatedAt?: string,
>   totalSumm?: number,
>   prepaySum?: number,
>   purchaseSumm?: number,
>   personalDiscountPercent?: number,
>   loyaltyLevel?: {
>     id?: number,
>     name: string
>   },
>   loyaltyEventDiscount?: {
>     id?: number
>   },
>   mark?: number,
>   markDatetime?: string,
>   lastName?: string,
>   firstName?: string,
>   patronymic?: string,
>   phone?: string,
>   additionalPhone?: string,
>   email?: string,
>   call?: boolean,
>   expired?: boolean,
>   customerComment?: string | null,
>   managerComment?: string | null,
>   managerId?: number,
>   customer?: {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   } | {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   } | {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     mainAddress?: {
>       id?: number,
>       externalId?: string,
>       name?: string
>     },
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     mainCustomerContact?: {
>       id?: number,
>       customer?: {
>         id?: number,
>         externalId?: string,
>         browserId?: string
>       } | null,
>       companies?: {
>         id?: number,
>         company?: {
>           id?: number,
>           externalId?: string,
>           name?: string
>         } | null
>       }[]
>     },
>     mainCompany?: {
>       id?: number,
>       externalId?: string,
>       name?: string
>     },
>     nickName?: string
>   },
>   contact?: {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     isContact?: boolean,
>     createdAt?: string,
>     managerId?: number,
>     vip?: boolean,
>     bad?: boolean,
>     site?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     },
>     tags?: {
>       color?: string,
>       name?: string,
>       colorCode?: string,
>       attached?: boolean
>     }[],
>     firstClientId?: string,
>     lastClientId?: string,
>     customFields?: custom[] | {
>     },
>     personalDiscount?: number,
>     cumulativeDiscount?: number,
>     discountCardNumber?: string | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     ordersCount?: number | null,
>     ticketsCount?: number,
>     costSumm?: number | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     },
>     segments?: {
>       id?: number,
>       code?: string,
>       name?: string,
>       createdAt?: string,
>       isDynamic?: boolean,
>       customersCount?: number,
>       active?: boolean
>     }[],
>     maturationTime?: number,
>     firstName?: string | null,
>     lastName?: string | null,
>     patronymic?: string | null,
>     sex?: string,
>     presumableSex?: string,
>     email?: string | null,
>     emailMarketingUnsubscribedAt?: string,
>     customerSubscriptions?: {
>       subscription?: {
>         id?: number,
>         channel?: string,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         autoSubscribe?: boolean,
>         ordering?: number
>       },
>       subscribed?: boolean,
>       changedAt?: string
>     }[],
>     phones?: {
>       number?: string | null
>     }[],
>     birthday?: string | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     },
>     mgCustomers?: {
>       id?: number,
>       externalId?: number,
>       mgChannel?: {
>         allowedSendByPhone?: boolean,
>         id?: number | null,
>         externalId?: number,
>         type?: string,
>         active?: boolean,
>         name?: string
>       }
>     }[],
>     photoUrl?: string
>   },
>   company?: {
>     id?: number,
>     externalId?: string,
>     customer?: {
>       site?: string,
>       id?: number,
>       externalId?: string,
>       type?: string
>     } | null,
>     active?: boolean,
>     name?: string,
>     brand?: string,
>     site?: string,
>     createdAt?: string,
>     contragent?: {
>       contragentType?: string | null,
>       legalName?: string,
>       legalAddress?: string,
>       INN?: string,
>       OKPO?: string,
>       KPP?: string,
>       OGRN?: string,
>       OGRNIP?: string,
>       certificateNumber?: string,
>       certificateDate?: string | null,
>       BIK?: string,
>       bank?: string,
>       bankAddress?: string,
>       corrAccount?: string,
>       bankAccount?: string
>     } | null,
>     address?: {
>       id?: number,
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string,
>       externalId?: string,
>       name?: string
>     } | null,
>     avgMarginSumm?: number | null,
>     marginSumm?: number,
>     totalSumm?: number,
>     averageSumm?: number | null,
>     costSumm?: number | null,
>     ordersCount?: number | null,
>     customFields?: custom[] | {
>     }
>   },
>   contragent?: {
>     contragentType?: string | null,
>     legalName?: string,
>     legalAddress?: string,
>     INN?: string,
>     OKPO?: string,
>     KPP?: string,
>     OGRN?: string,
>     OGRNIP?: string,
>     certificateNumber?: string,
>     certificateDate?: string | null,
>     BIK?: string,
>     bank?: string,
>     bankAddress?: string,
>     corrAccount?: string,
>     bankAccount?: string
>   },
>   delivery?: {
>     code?: string,
>     integrationCode?: string,
>     data?: {
>       externalId?: string,
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppointAddress?: string,
>       days?: string,
>       statusText?: string,
>       statusDate?: string,
>       tariff?: string,
>       tariffName?: string,
>       pickuppointId?: string,
>       pickuppointSchedule?: string,
>       pickuppointPhone?: string,
>       payerType?: string,
>       statusComment?: string,
>       cost?: number | null,
>       minTerm?: number,
>       maxTerm?: number,
>       shipmentpointId?: string,
>       shipmentpointName?: string,
>       shipmentpointAddress?: string,
>       shipmentpointSchedule?: string,
>       shipmentpointPhone?: string,
>       shipmentpointCoordinateLatitude?: string,
>       shipmentpointCoordinateLongitude?: string,
>       pickuppointName?: string,
>       pickuppointCoordinateLatitude?: string,
>       pickuppointCoordinateLongitude?: string,
>       extraData?: custom[] | {
>       },
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[],
>       packages?: {
>         packageId?: string,
>         weight?: number,
>         length?: number,
>         width?: number,
>         height?: number,
>         items?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           quantity?: number
>         }[] | null
>       }[] | null
>     } | {
>       externalId?: string,
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppointAddress?: string,
>       days?: string,
>       statusText?: string,
>       statusDate?: string,
>       tariff?: string,
>       tariffName?: string,
>       pickuppointId?: string,
>       pickuppointSchedule?: string,
>       pickuppointPhone?: string,
>       payerType?: string,
>       statusComment?: string,
>       cost?: number | null,
>       minTerm?: number,
>       maxTerm?: number,
>       shipmentpointId?: string,
>       shipmentpointName?: string,
>       shipmentpointAddress?: string,
>       shipmentpointSchedule?: string,
>       shipmentpointPhone?: string,
>       shipmentpointCoordinateLatitude?: string,
>       shipmentpointCoordinateLongitude?: string,
>       pickuppointName?: string,
>       pickuppointCoordinateLatitude?: string,
>       pickuppointCoordinateLongitude?: string,
>       extraData?: custom[] | {
>       },
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[],
>       packages?: {
>         packageId?: string,
>         weight?: number,
>         length?: number,
>         width?: number,
>         height?: number,
>         items?: {
>           orderProduct?: {
>             id?: number,
>             externalId?: string,
>             externalIds?: {
>               code?: string,
>               value?: string
>             }[] | null
>           },
>           quantity?: number
>         }[] | null
>       }[] | null
>     } | {
>       locked?: boolean,
>       id?: number,
>       firstName?: string,
>       lastName?: string,
>       patronymic?: string,
>       active?: boolean,
>       email?: string,
>       phone?: {
>         number?: string | null
>       },
>       description?: string,
>       courierId?: number
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       statusDate?: string,
>       serviceType?: string,
>       days?: string,
>       pickuppoint?: string,
>       pickuppointId?: string,
>       receiverWarehouseTypeRef?: string,
>       statusName?: string,
>       price?: number | null,
>       shipmentpointId?: string,
>       receiverCity?: string,
>       receiverCityRef?: string,
>       receiverStreet?: string,
>       receiverStreetRef?: string,
>       seatsAmount?: number,
>       cargoType?: string,
>       cargoDescription?: string,
>       payerType?: string,
>       cashPayerType?: string,
>       paymentForm?: string,
>       ownershipForm?: string,
>       packageNumber?: string,
>       accompanyingDocument?: string,
>       notes?: string,
>       preferredDeliveryDate?: string | null,
>       timeInterval?: string,
>       saturdayDelivery?: boolean,
>       deliveryDate?: string,
>       denieReason?: string | null,
>       backwardDelivery?: boolean,
>       backwardDeliveryCargoType?: string,
>       backwardDeliveryPayerType?: string,
>       backwardDeliveryRedeliveryString?: string,
>       afterpaymentOnGoodsCost?: number,
>       declaredValue?: number,
>       sendDate?: string,
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[]
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       pickuppoint?: string,
>       statusText?: string,
>       deliveryType?: string,
>       deliveryName?: string,
>       pickuppointId?: string,
>       days?: string,
>       pickupType?: number | null,
>       cost?: number | null,
>       receiverCity?: string,
>       receiverCityRef?: string,
>       pickuppointSchedule?: string,
>       pickuppointDescription?: string,
>       placesCount?: number | null,
>       services?: string[],
>       comment?: string,
>       itemDeclaredValues?: {
>         orderProduct?: {
>           id?: number,
>           externalId?: string,
>           externalIds?: {
>             code?: string,
>             value?: string
>           }[] | null
>         },
>         value?: number
>       }[]
>     } | {
>       trackNumber?: string,
>       status?: string,
>       locked?: boolean,
>       statusText?: string
>     },
>     service?: {
>       name?: string | null,
>       code?: string | null,
>       active?: boolean
>     },
>     cost?: number,
>     netCost?: number,
>     date?: string,
>     time?: {
>       from?: string | null,
>       to?: string | null,
>       custom?: string | null
>     },
>     address?: {
>       index?: string | null,
>       countryIso?: string | null,
>       region?: string | null,
>       regionId?: number | null,
>       city?: string | null,
>       cityId?: number | null,
>       cityType?: string,
>       street?: string | null,
>       streetId?: number | null,
>       streetType?: string,
>       building?: string | null,
>       flat?: string | null,
>       floor?: number | null,
>       block?: number | null,
>       house?: string | null,
>       housing?: string,
>       metro?: string | null,
>       notes?: string | null,
>       text?: string
>     },
>     vatRate?: string | null
>   },
>   site?: string,
>   status?: string,
>   statusComment?: string,
>   source?: {
>     source?: string,
>     medium?: string,
>     campaign?: string,
>     keyword?: string,
>     content?: string
>   },
>   items?: {
>     externalId?: string,
>     bonusesChargeTotal?: number,
>     bonusesCreditTotal?: number,
>     markingCodes?: string[],
>     id?: number | null,
>     externalIds?: {
>       code?: string,
>       value?: string
>     }[],
>     priceType?: {
>       code?: string
>     },
>     initialPrice?: number | null,
>     discounts?: {
>       type?: string,
>       amount?: number
>     }[],
>     discountTotal?: number | null,
>     prices?: {
>       price?: number,
>       quantity?: number
>     }[] | null,
>     vatRate?: string | null,
>     createdAt?: string,
>     quantity?: number | null,
>     status?: string,
>     comment?: string,
>     offer?: {
>       displayName?: string,
>       id?: number | null,
>       externalId?: string,
>       xmlId?: string,
>       name: string,
>       article?: string,
>       vatRate?: string,
>       properties?: custom[] | {
>       },
>       unit?: {
>         code?: string,
>         name?: string,
>         sym?: string
>       },
>       barcode?: string
>     },
>     isCanceled?: boolean,
>     properties?: {
>       code: string,
>       name: string,
>       value: string
>     }[],
>     purchasePrice?: number | null,
>     ordering?: number
>   }[],
>   fullPaidAt?: string,
>   payments?: {
>   },
>   fromApi?: boolean,
>   weight?: number | null,
>   length?: number,
>   width?: number,
>   height?: number,
>   shipmentStore?: string,
>   shipmentDate?: string | null,
>   shipped?: boolean,
>   links?: {
>     order?: {
>       id?: number,
>       number?: string,
>       externalId?: string
>     },
>     createdAt?: string,
>     comment?: string
>   }[],
>   customFields?: custom[] | {
>   },
>   clientId?: string
> }[] | null
> ```

***

## Orders Picking

### getPacksById.get

`ordersPicking.getPacksById.get`

Getting information on pack

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.ordersPicking.getPacksById.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pack` | `object` | No | Pack - items pack, within the one item position, from one warehouse |

> [accordion] pack full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   purchasePrice?: number | null,
>   quantity?: number | null,
>   unit?: {
>     code?: string,
>     name?: string,
>     sym?: string
>   },
>   store?: string,
>   item?: {
>     externalId?: string,
>     id?: number | null,
>     externalIds?: {
>     }[],
>     order?: {
>       id?: number
>     },
>     offer?: {
>       externalId?: string,
>       xmlId?: string
>     }
>   },
>   shipmentDate?: string | null,
>   invoiceNumber?: string,
>   deliveryNoteNumber?: string
> }
> ```

***

### packs.get

`ordersPicking.packs.get`

Getting the list of packs matched the specified filter

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.ordersPicking.packs.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ]?: number[],
>   filter[
>     stores
>   ]?: string[],
>   filter[
>     itemId
>   ]?: number,
>   filter[
>     offerXmlId
>   ]?: string,
>   filter[
>     offerExternalId
>   ]?: string,
>   filter[
>     orderId
>   ]?: number,
>   filter[
>     orderExternalId
>   ]?: string,
>   filter[
>     shipmentDateFrom
>   ]?: string,
>   filter[
>     shipmentDateTo
>   ]?: string,
>   filter[
>     invoiceNumber
>   ]?: string,
>   filter[
>     deliveryNoteNumber
>   ]?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `packs` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] packs full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   purchasePrice?: number | null,
>   quantity?: number | null,
>   unit?: {
>     code?: string,
>     name?: string,
>     sym?: string
>   },
>   store?: string,
>   item?: {
>     externalId?: string,
>     id?: number | null,
>     externalIds?: {
>     }[],
>     order?: {
>       id?: number
>     },
>     offer?: {
>       externalId?: string,
>       xmlId?: string
>     }
>   },
>   shipmentDate?: string | null,
>   invoiceNumber?: string,
>   deliveryNoteNumber?: string
> }[]
> ```

***

### packsByIdDelete.post

`ordersPicking.packsByIdDelete.post`

Pack removing

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.ordersPicking.packsByIdDelete.post({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### packsByIdEdit.post

`ordersPicking.packsByIdEdit.post`

Pack editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.ordersPicking.packsByIdEdit.post({
	path: { id: 1 },
	body: {
		pack: { purchasePrice: 0 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   pack?: {
>     purchasePrice?: number | null,
>     quantity?: number | null,
>     shipmentDate?: string | null,
>     invoiceNumber?: string,
>     deliveryNoteNumber?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Pack ID |

***

### packsCreate.post

`ordersPicking.packsCreate.post`

Pack creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.ordersPicking.packsCreate.post({
	body: {
		pack: { purchasePrice: 0 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   pack?: {
>     purchasePrice?: number | null,
>     quantity?: number | null,
>     store?: string,
>     shipmentDate?: string | null,
>     invoiceNumber?: string,
>     deliveryNoteNumber?: string,
>     itemId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Pack ID |

***

### packsHistory.get

`ordersPicking.packsHistory.get`

Getting the history of order packing

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.ordersPicking.packsHistory.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     startDate
>   ]?: string,
>   filter[
>     endDate
>   ]?: string,
>   filter[
>     orderId
>   ]?: number,
>   filter[
>     orderExternalId
>   ]?: string,
>   filter[
>     sinceId
>   ]?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `generatedAt` | `string` | No | Time of response formation |
| `history` | `object[]` | No | — |
| `pagination` | `object` | No | Pagination |

> [accordion] history full type
>
> ```ts theme={null}
> {
>   id?: number,
>   createdAt?: string,
>   created?: boolean,
>   deleted?: boolean,
>   field?: string,
>   oldValue?: {
>   },
>   newValue?: {
>   },
>   pack?: {
>     id?: number | null,
>     purchasePrice?: number | null,
>     quantity?: number | null,
>     store?: {
>       code?: string
>     } | null,
>     item?: {
>       externalId?: string,
>       id?: number | null,
>       externalIds?: {
>       }[],
>       order?: {
>         id?: number
>       },
>       offer?: {
>         externalId?: string,
>         xmlId?: string
>       }
>     },
>     shipmentDate?: string | null,
>     invoiceNumber?: string,
>     deliveryNoteNumber?: string
>   },
>   source?: string,
>   user?: {
>     id?: number
>   } | null
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

***

## Payments

### getPaymentInvoiceByInvoiceuuid.get

`payments.getPaymentInvoiceByInvoiceuuid.get`

Get the invoice

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.payments.getPaymentInvoiceByInvoiceuuid.get({
	path: { invoiceUuid: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   invoiceUuid: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `invoice` | `object` | No | — |

> [accordion] invoice full type
>
> ```ts theme={null}
> {
>   createdAt?: string,
>   customerId?: number,
>   orderId?: number,
>   paymentId?: number,
>   amount?: string,
>   currency?: string,
>   email?: string,
>   phone?: string,
>   status?: string,
>   statusMessage?: string,
>   externalId?: string,
>   invoiceUuid?: string,
>   invoiceType?: string,
>   link?: string,
>   errorMsg?: string,
>   paidAt?: string,
>   expiredAt?: string,
>   cancellationDetails?: string,
>   refundable?: boolean,
>   cancellable?: boolean,
>   refunds?: {
>     id?: number,
>     status?: string,
>     externalId?: string,
>     comment?: string,
>     amount?: string,
>     createdAt?: string
>   }[],
>   discountAmount?: string
> }
> ```

***

### paymentCheck.post

`payments.paymentCheck.post`

Checking the invoice

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.payments.paymentCheck.post({
	body: {
		check: { invoiceUuid: 'demo', amount: 1, currency: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   check?: {
>     invoiceUuid: string,
>     amount: number,
>     currency: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `result` | `object` | No | Object with the result of checking |

> [accordion] result full type
>
> ```ts theme={null}
> {
>   success?: boolean,
>   errorMsg?: string
> }
> ```

***

### paymentCreateInvoice.post

`payments.paymentCreateInvoice.post`

Creating an invoice

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.payments.paymentCreateInvoice.post({
	body: {
		createInvoice: { paymentId: 1 },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   createInvoice?: {
>     paymentId: number,
>     returnUrl?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `result` | `object` | No | JSON with data of the created invoice |

> [accordion] result full type
>
> ```ts theme={null}
> {
>   link?: string
> }
> ```

***

### paymentInvoiceImport.post

`payments.paymentInvoiceImport.post`

Import the invoice

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.payments.paymentInvoiceImport.post({
	body: {
		invoice: {
			paymentId: 1,
			externalId: 'demo',
			amount: 1,
			currency: 'demo',
			status: 'demo',
			createdAt: '2025-01-01 12:00:00',
			paidAt: '2025-01-01 12:00:00',
		},
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   invoice?: {
>     paymentId: number,
>     externalId: string,
>     amount: number,
>     currency: string,
>     status: string,
>     createdAt: string,
>     paidAt: string,
>     discountAmount?: number,
>     refundable?: boolean,
>     refunds?: {
>       externalId: string,
>       status: string,
>       comment?: string,
>       amount: number,
>       createdAt: string
>     }[]
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `invoice` | `object` | No | — |

> [accordion] invoice full type
>
> ```ts theme={null}
> {
>   invoiceUuid?: string
> }
> ```

***

### paymentUpdateInvoice.post

`payments.paymentUpdateInvoice.post`

Changing the invoice

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.payments.paymentUpdateInvoice.post({
	body: {
		updateInvoice: { invoiceUuid: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   updateInvoice?: {
>     paymentId?: string,
>     invoiceUrl?: string,
>     amount?: number,
>     status?: string,
>     paidAt?: string,
>     expiredAt?: string,
>     cancellationDetails?: string,
>     refundable?: boolean,
>     refund?: {
>       status?: custom | null,
>       id: string,
>       comment?: string,
>       amount: number
>     } | null,
>     cancellable?: boolean,
>     discountAmount?: number,
>     invoiceUuid: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

## Segments

### list.get

`segments.list.get`

Getting the list of customer segments

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.segments.list.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     name
>   ]?: string,
>   filter[
>     type
>   ]?: custom,
>   filter[
>     isTree
>   ]?: boolean,
>   filter[
>     active
>   ]?: boolean,
>   filter[
>     dateFrom
>   ]?: string,
>   filter[
>     dateTo
>   ]?: string,
>   filter[
>     minCustomersCount
>   ]?: number,
>   filter[
>     maxCustomersCount
>   ]?: number,
>   limit?: custom,
>   page?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `segments` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] segments full type
>
> ```ts theme={null}
> {
>   id?: number,
>   code?: string,
>   name?: string,
>   createdAt?: string,
>   isDynamic?: boolean,
>   customersCount?: number,
>   active?: boolean
> }[]
> ```

***

## Settings

### list.get

`settings.list.get`

Getting system settings

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.settings.list.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `settings` | `object` | No | System settings |

> [accordion] settings full type
>
> ```ts theme={null}
> {
>   default_currency?: {
>     value?: string,
>     updated_at?: string | null
>   },
>   system_language?: {
>     value?: string,
>     updated_at?: string | null
>   },
>   timezone?: {
>     value?: string,
>     updated_at?: string | null
>   },
>   work_times?: {
>     day_type?: string,
>     start_time?: string,
>     end_time?: string,
>     lunch_start_time?: string | null,
>     lunch_end_time?: string | null
>   }[],
>   non_working_days?: {
>     start_date?: string,
>     end_date?: string
>   }[],
>   mg?: {
>     order_creation?: {
>       default?: {
>         site?: string | null,
>         order_type?: string | null,
>         order_method?: string | null
>       },
>       channels?: {
>       }
>     }
>   },
>   order?: {
>     allow_duplicate_order_product?: {
>       value?: boolean,
>       updated_at?: string
>     }
>   }
> }
> ```

***

## Statistics

### statisticUpdate.get

`statistics.statisticUpdate.get`

Statistics updating

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.statistics.statisticUpdate.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

## Store

### inventories.get

`store.inventories.get`

Getting the leftover stocks and purchasing prices

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.store.inventories.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     catalogs
>   ][]?: number[],
>   filter[
>     productExternalId
>   ]?: string,
>   filter[
>     productArticle
>   ][]?: string[],
>   filter[
>     productActive
>   ]?: boolean,
>   filter[
>     offerExternalId
>   ][]?: string[],
>   filter[
>     offerXmlId
>   ][]?: string[],
>   filter[
>     offerArticle
>   ][]?: string[],
>   filter[
>     offerActive
>   ]?: boolean,
>   filter[
>     details
>   ]?: boolean,
>   filter[
>     productExternalIds
>   ][]?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `offers` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] offers full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   externalId?: string,
>   xmlId?: string,
>   site?: string,
>   purchasePrice?: number,
>   quantity?: number,
>   stores?: {
>     quantity?: number,
>     purchasePrice?: number,
>     store?: string
>   }[]
> }[]
> ```

***

### inventoriesUpload.post

`store.inventoriesUpload.post`

Updating the leftover stocks and purchasing prices

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.store.inventoriesUpload.post({
	body: {
		offers: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   offers?: {
>     id?: number | null,
>     externalId?: string,
>     xmlId?: string,
>     stores: {
>       code: string,
>       available?: number,
>       purchasePrice?: number
>     }[]
>   }[],
>   site?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `processedOffersCount` | `number` | No | Quantity of successfully processed SKUs |
| `notFoundOffers` | `object[]` | No | — |

> [accordion] notFoundOffers full type
>
> ```ts theme={null}
> {
>   id?: number | null,
>   externalId?: string,
>   xmlId?: string
> }[]
> ```

***

### offers.get

`store.offers.get`

Getting a list of offers that meet the specified filter

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.store.offers.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     externalIds
>   ][]?: string[],
>   filter[
>     xmlIds
>   ][]?: string[],
>   filter[
>     articles
>   ][]?: string[],
>   filter[
>     name
>   ]?: string,
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     catalogs
>   ][]?: number[],
>   filter[
>     groups
>   ][]?: number[],
>   filter[
>     priceType
>   ]?: string,
>   filter[
>     active
>   ]?: custom,
>   filter[
>     properties
>   ]?: custom[] | {
>   },
>   filter[
>     sinceId
>   ]?: number,
>   filter[
>     minPrice
>   ]?: number,
>   filter[
>     maxPrice
>   ]?: number,
>   filter[
>     minQuantity
>   ]?: number,
>   filter[
>     maxQuantity
>   ]?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `offers` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] offers full type
>
> ```ts theme={null}
> {
>   images?: string[],
>   id?: number | null,
>   externalId?: string,
>   xmlId?: string,
>   site?: string,
>   name: string,
>   article?: string,
>   prices?: {
>     priceType: string,
>     currency?: string,
>     price: number,
>     ordering?: number
>   }[],
>   purchasePrice?: number,
>   vatRate?: string,
>   product?: {
>     type?: custom,
>     minPrice?: number,
>     maxPrice?: number,
>     catalogId?: number,
>     id?: number,
>     article?: string,
>     name: string,
>     url?: string,
>     imageUrl?: string,
>     description?: string,
>     popular?: boolean,
>     stock?: boolean,
>     novelty?: boolean,
>     recommended?: boolean,
>     options?: custom[] | {
>     },
>     groups?: {
>       id?: number,
>       externalId?: string
>     }[],
>     externalId?: string,
>     manufacturer?: string,
>     updatedAt?: string,
>     active?: boolean,
>     quantity?: number,
>     markable?: boolean,
>     markingProvider?: custom
>   },
>   properties?: custom[] | {
>   },
>   quantity?: number,
>   weight?: number,
>   length?: number,
>   width?: number,
>   height?: number,
>   duration?: number,
>   active?: boolean,
>   unit?: {
>     code?: string,
>     name?: string,
>     sym?: string
>   },
>   barcode?: string
> }[]
> ```

***

### pricesUpload.post

`store.pricesUpload.post`

SKU prices updating

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.store.pricesUpload.post({
	body: {
		prices: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   prices?: {
>     externalId?: string,
>     xmlId?: string,
>     id?: number,
>     site?: string,
>     prices?: {
>       code?: string,
>       price?: number,
>       remove?: boolean
>     }[]
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `processedOffersCount` | `number` | No | — |
| `notFoundOffers` | `object[]` | No | — |

> [accordion] notFoundOffers full type
>
> ```ts theme={null}
> {
>   id?: string,
>   externalId?: string,
>   xmlId?: string
> }[]
> ```

***

### productGroups.get

`store.productGroups.get`

Getting the list of product groups

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.store.productGroups.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     name
>   ]?: string,
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     catalogs
>   ][]?: number[],
>   filter[
>     active
>   ]?: boolean,
>   filter[
>     parentGroupId
>   ]?: number,
>   filter[
>     loadFromYml
>   ]?: boolean,
>   filter[
>     minLevel
>   ]?: number,
>   filter[
>     maxLevel
>   ]?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `productGroup` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] productGroup full type
>
> ```ts theme={null}
> {
>   parentId?: number,
>   site?: string,
>   id?: number,
>   name: string,
>   lvl?: number,
>   externalId?: string,
>   active?: boolean
> }[]
> ```

***

### productGroupsByExternalidEdit.post

`store.productGroupsByExternalidEdit.post`

Editing a product group

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.store.productGroupsByExternalidEdit.post({
	path: { externalId: 'demo' },
	body: {
		productGroup: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   by?: string,
>   site?: string,
>   productGroup?: {
>     parentId?: number,
>     name: string,
>     description?: string,
>     externalId?: string,
>     active?: boolean,
>     parentExternalId?: string,
>     site?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | — |

***

### productGroupsCreate.post

`store.productGroupsCreate.post`

Adding a product group

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.store.productGroupsCreate.post({
	body: {
		productGroup: { name: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   productGroup?: {
>     parentId?: number,
>     name: string,
>     description?: string,
>     externalId?: string,
>     active?: boolean,
>     parentExternalId?: string,
>     site?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | — |

***

### products.get

`store.products.get`

Getting the list of products and SKU

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.store.products.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     name
>   ]?: string,
>   filter[
>     groups
>   ][]?: number[],
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     catalogs
>   ][]?: number[],
>   filter[
>     priceType
>   ]?: string,
>   filter[
>     manufacturer
>   ]?: string,
>   filter[
>     externalId
>   ]?: string,
>   filter[
>     xmlId
>   ]?: string,
>   filter[
>     url
>   ]?: string,
>   filter[
>     urlLike
>   ]?: string,
>   filter[
>     classSegment
>   ]?: string,
>   filter[
>     active
>   ]?: boolean,
>   filter[
>     popular
>   ]?: boolean,
>   filter[
>     stock
>   ]?: boolean,
>   filter[
>     novelty
>   ]?: boolean,
>   filter[
>     recommended
>   ]?: boolean,
>   filter[
>     properties
>   ]?: custom[] | {
>   },
>   filter[
>     markable
>   ]?: boolean,
>   filter[
>     productType
>   ]?: number,
>   filter[
>     offerIds
>   ][]?: number[],
>   filter[
>     offerExternalId
>   ]?: string,
>   filter[
>     offerXmlId
>   ]?: string,
>   filter[
>     groupExternalId
>   ]?: string,
>   filter[
>     externalIds
>   ][]?: string[],
>   filter[
>     articles
>   ][]?: string[],
>   filter[
>     sinceUpdatedAt
>   ]?: string,
>   filter[
>     sinceId
>   ]?: number,
>   filter[
>     minPrice
>   ]?: number,
>   filter[
>     maxPrice
>   ]?: number,
>   filter[
>     minPurchasePrice
>   ]?: number,
>   filter[
>     maxPurchasePrice
>   ]?: number,
>   filter[
>     minQuantity
>   ]?: number,
>   filter[
>     maxQuantity
>   ]?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `products` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] products full type
>
> ```ts theme={null}
> {
>   type?: custom,
>   minPrice?: number,
>   maxPrice?: number,
>   catalogId?: number,
>   id?: number,
>   article?: string,
>   name: string,
>   url?: string,
>   imageUrl?: string,
>   description?: string,
>   popular?: boolean,
>   stock?: boolean,
>   novelty?: boolean,
>   recommended?: boolean,
>   options?: custom[] | {
>   },
>   groups?: {
>     id?: number,
>     externalId?: string
>   }[],
>   externalId?: string,
>   manufacturer?: string,
>   offers?: {
>     name: string,
>     price?: number,
>     images?: string[],
>     id?: number | null,
>     externalId?: string,
>     xmlId?: string,
>     article?: string,
>     prices?: {
>       priceType: string,
>       currency?: string,
>       price: number,
>       ordering?: number
>     }[],
>     purchasePrice?: number,
>     vatRate?: string,
>     properties?: custom[] | {
>     },
>     quantity?: number,
>     weight?: number,
>     length?: number,
>     width?: number,
>     height?: number,
>     duration?: number,
>     active?: boolean,
>     unit?: {
>       code?: string,
>       name?: string,
>       sym?: string
>     },
>     barcode?: string
>   }[],
>   updatedAt?: string,
>   active?: boolean,
>   quantity?: number,
>   markable?: boolean,
>   markingProvider?: custom
> }[]
> ```

***

### productsBatchCreate.post

`store.productsBatchCreate.post`

Batch adding of products and services

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.store.productsBatchCreate.post({
	body: {
		products: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   products?: {
>     type?: custom,
>     catalogId?: number,
>     article?: string,
>     name: string,
>     url?: string,
>     imageUrl?: string,
>     description?: string,
>     popular?: boolean,
>     stock?: boolean,
>     novelty?: boolean,
>     recommended?: boolean,
>     groups?: {
>       externalId?: string,
>       id?: number
>     }[],
>     externalId?: string,
>     manufacturer?: string,
>     active?: boolean,
>     markable?: boolean,
>     markingProvider?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `processedProductsCount` | `number` | No | Number of successfully processed products |
| `addedProducts` | `number[]` | No | List of IDs of added products |

***

### productsBatchEdit.post

`store.productsBatchEdit.post`

Batch editing of products and services

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.store.productsBatchEdit.post({
	body: {
		products: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   products?: {
>     catalogId?: number,
>     id?: number,
>     article?: string,
>     name: string,
>     url?: string,
>     imageUrl?: string,
>     description?: string,
>     popular?: boolean,
>     stock?: boolean,
>     novelty?: boolean,
>     recommended?: boolean,
>     groups?: {
>       externalId?: string,
>       id?: number
>     }[],
>     externalId?: string,
>     manufacturer?: string,
>     active?: boolean,
>     markable?: boolean,
>     markingProvider?: string,
>     site?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `processedProductsCount` | `number` | No | Number of successfully processed products |
| `notFoundProducts` | `object[]` | No | — |

> [accordion] notFoundProducts full type
>
> ```ts theme={null}
> {
>   id?: string,
>   externalId?: string
> }[]
> ```

***

### productsProperties.get

`store.productsProperties.get`

Getting the list of item properties, matching the specified filter

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.store.productsProperties.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     name
>   ]?: string,
>   filter[
>     code
>   ]?: string,
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     visible
>   ]?: custom,
>   filter[
>     variative
>   ]?: custom,
>   filter[
>     catalogs
>   ][]?: number[],
>   filter[
>     groups
>   ][]?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `properties` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] properties full type
>
> ```ts theme={null}
> {
>   sites?: string[],
>   groups?: {
>     id?: number,
>     name?: string
>   }[],
>   code?: string,
>   name?: string,
>   isNumeric?: boolean,
>   visible?: boolean,
>   variative?: boolean
> }[]
> ```

***

### productsPropertiesValues.get

`store.productsPropertiesValues.get`

Getting a list of property values for products or services that match the specified filters

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.store.productsPropertiesValues.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     propertyName
>   ]?: string,
>   filter[
>     propertyCode
>   ]?: string,
>   filter[
>     groups
>   ][]?: number[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `productPropertyValues` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] productPropertyValues full type
>
> ```ts theme={null}
> {
>   property?: {
>     code?: string,
>     name?: string
>   },
>   value?: string,
>   offersCount?: number
> }[]
> ```

***

## Tasks

### byIdEdit.post

`tasks.byIdEdit.post`

Task editing

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.tasks.byIdEdit.post({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   task?: {
>     text?: string,
>     commentary?: string,
>     priority?: custom,
>     datetime?: string,
>     complete?: boolean,
>     phone?: string,
>     customer?: {
>       id?: number,
>       externalId?: string
>     } | null,
>     performerId?: number,
>     order?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     } | null,
>     ticket?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     },
>     phoneSite?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### create.post

`tasks.create.post`

Task creation

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.tasks.create.post({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   site?: string,
>   task?: {
>     text?: string,
>     commentary?: string,
>     priority?: custom,
>     datetime?: string,
>     complete?: boolean,
>     phone?: string,
>     customer?: {
>       id?: number,
>       externalId?: string
>     } | null,
>     performerId?: number,
>     order?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     } | null,
>     ticket?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     },
>     phoneSite?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of the created task |

***

### getById.get

`tasks.getById.get`

Getting information on task

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.tasks.getById.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `task` | `object` | No | Task |

> [accordion] task full type
>
> ```ts theme={null}
> {
>   id?: number,
>   text?: string,
>   commentary?: string,
>   priority?: string,
>   datetime?: string,
>   createdAt?: string,
>   complete?: boolean,
>   creator?: number | null,
>   performer?: number,
>   performerType?: string,
>   customer?: {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     site?: string
>   } | null,
>   order?: {
>     id?: number,
>     number?: string,
>     externalId?: string,
>     site?: string
>   } | null,
>   ticket?: {
>     id?: number,
>     number?: string,
>     externalId?: string,
>     site?: string
>   },
>   phone?: string,
>   phoneSite?: string,
>   completedAt?: string
> }
> ```

***

### getByIdComments.get

`tasks.getByIdComments.get`

Receiving comments on the task

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.tasks.getByIdComments.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `comments` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] comments full type
>
> ```ts theme={null}
> {
>   id?: number,
>   creator?: number,
>   text?: string,
>   createdAt?: string,
>   updatedAt?: string
> }[]
> ```

***

### history.get

`tasks.history.get`

Getting the task change history

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.tasks.history.get({
	query: { filter[taskId]: 0, filter[sinceId]: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     startDate
>   ]?: string,
>   filter[
>     endDate
>   ]?: string,
>   filter[
>     taskId
>   ]?: number,
>   filter[
>     sinceId
>   ]?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `generatedAt` | `string` | No | Time of response formation |
| `history` | `object[]` | No | — |
| `pagination` | `object` | No | Pagination |

> [accordion] history full type
>
> ```ts theme={null}
> {
>   id?: number,
>   createdAt?: string,
>   created?: boolean,
>   source?: string,
>   user?: {
>     id?: number
>   },
>   field?: string,
>   oldValue?: custom,
>   newValue?: custom,
>   apiKey?: {
>     current?: boolean,
>     id?: number
>   },
>   task?: {
>     id?: number,
>     ticket?: {
>       id?: number,
>       number?: string,
>       externalId?: string,
>       site?: string
>     }
>   },
>   comment?: {
>     id?: number,
>     text?: string
>   }
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

***

### list.get

`tasks.list.get`

Getting the task list

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.tasks.list.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     orderNumber
>   ]?: string,
>   filter[
>     orderId
>   ]?: number,
>   filter[
>     ticketNumber
>   ]?: string,
>   filter[
>     ticketId
>   ]?: number,
>   filter[
>     customer
>   ]?: string,
>   filter[
>     customerId
>   ]?: number,
>   filter[
>     mgCustomerId
>   ]?: number,
>   filter[
>     performers
>   ][]?: number[],
>   filter[
>     observers
>   ][]?: number[],
>   filter[
>     status
>   ]?: custom,
>   filter[
>     creators
>   ][]?: number[],
>   filter[
>     text
>   ]?: string,
>   filter[
>     priority
>   ]?: custom,
>   filter[
>     tagsFilter
>   ][
>     matchMode
>   ]?: string,
>   filter[
>     tagsFilter
>   ][
>     attached
>   ]?: boolean,
>   filter[
>     tagsFilter
>   ][
>     without
>   ]?: boolean,
>   filter[
>     tags
>   ][]?: string[],
>   filter[
>     attachedTags
>   ][]?: string[],
>   filter[
>     createdAtFrom
>   ]?: string,
>   filter[
>     createdAtTo
>   ]?: string,
>   filter[
>     dateFrom
>   ]?: string,
>   filter[
>     dateTo
>   ]?: string,
>   filter[
>     completedAtFrom
>   ]?: string,
>   filter[
>     completedAtTo
>   ]?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `tasks` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] tasks full type
>
> ```ts theme={null}
> {
>   id?: number,
>   text?: string,
>   commentary?: string,
>   priority?: string,
>   datetime?: string,
>   createdAt?: string,
>   complete?: boolean,
>   creator?: number | null,
>   performer?: number,
>   performerType?: string,
>   customer?: {
>     type?: string,
>     id?: number,
>     externalId?: string,
>     site?: string
>   } | null,
>   order?: {
>     id?: number,
>     number?: string,
>     externalId?: string,
>     site?: string
>   } | null,
>   ticket?: {
>     id?: number,
>     number?: string,
>     externalId?: string,
>     site?: string
>   },
>   phone?: string,
>   phoneSite?: string,
>   completedAt?: string
> }[]
> ```

***

## Telephony

### callEvent.post

`telephony.callEvent.post`

Call events

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.telephony.callEvent.post({
	body: { phone: '+15555550100', type: 'in', code: '101' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

The official OpenAPI marks `phone`, `type`, and `code` required but omits their types; the plugin enforces their presence, while their value shapes are unverified.

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   event?: {
>     phone: string,
>     type: custom,
>     codes?: string[],
>     userIds?: number[],
>     site?: string,
>     hangupStatus?: custom,
>     externalPhone?: string | null,
>     callExternalId?: string | null,
>     webAnalyticsData?: {
>       campaign?: {
>         name?: string,
>         code?: string
>       },
>       queryString?: string
>     } | null
>   },
>   phone: custom,
>   type: custom,
>   code: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `notExistCodes` | `custom[] \| object` | No | Array of extensions, which are absent in the system |
| `notExistUsers` | `custom[] \| object` | No | Array of userId, which are absent in the system |

> [accordion] notExistCodes full type
>
> ```ts theme={null}
> custom[] | {
> }
> ```

> [accordion] notExistUsers full type
>
> ```ts theme={null}
> custom[] | {
> }
> ```

***

### calls.get

`telephony.calls.get`

Getting a call list

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.telephony.calls.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   filter[
>     dateFrom
>   ]?: string,
>   filter[
>     dateTo
>   ]?: string,
>   limit?: custom,
>   cursor?: string,
>   filter[
>     type
>   ]?: custom,
>   filter[
>     code
>   ]?: string,
>   filter[
>     managerId
>   ]?: number,
>   filter[
>     result
>   ]?: custom,
>   filter[
>     includeMissed
>   ]?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `pagination` | `object` | No | Pagination information |
| `calls` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   nextCursor?: string
> }
> ```

> [accordion] calls full type
>
> ```ts theme={null}
> {
>   id?: number,
>   externalId?: string,
>   type?: string,
>   date?: string,
>   code?: string,
>   manager?: {
>     id?: string,
>     firstName?: string,
>     lastName?: string,
>     patronymic?: string,
>     email?: string,
>     code?: string
>   },
>   phone?: string,
>   result?: string,
>   duration?: number,
>   manualTags?: {
>     id?: number,
>     name?: string,
>     colorCode?: string,
>     color?: string
>   }[],
>   aiTags?: {
>     id?: number,
>     name?: string,
>     colorCode?: string,
>     color?: string
>   }[],
>   managerCriteriaTags?: {
>     id?: number,
>     name?: string,
>     colorCode?: string,
>     color?: string
>   }[],
>   orderNumber?: string,
>   ticket?: {
>     id?: number,
>     externalId?: string,
>     site?: string,
>     number?: string
>   } | null,
>   customer?: {
>     id?: string,
>     externalId?: string,
>     firstName?: string,
>     lastName?: string,
>     patronymic?: string,
>     email?: string,
>     phones?: {
>     }[]
>   },
>   transcriptStructure?: {
>     number?: number,
>     start?: number,
>     end?: number,
>     text?: string
>   }[],
>   shortSummary?: string,
>   fullSummary?: string,
>   isMissed?: boolean,
>   externalPhone?: string,
>   durationWaiting?: number
> }[]
> ```

***

### callsUpload.post

`telephony.callsUpload.post`

Calls uploading

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.telephony.callsUpload.post({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   calls?: {
>     date: string,
>     type: custom,
>     phone: string,
>     code?: string,
>     userId?: number,
>     result: custom,
>     duration?: number,
>     durationWaiting?: number,
>     externalId: string,
>     recordUrl?: string,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     } | null,
>     externalPhone?: string,
>     site?: string | null,
>     clientId?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `processedCallsCount` | `number` | No | Quantity of successfully processed calls |
| `duplicateCalls` | `custom[] \| object` | No | Array of externalId, which are present in the system |

> [accordion] duplicateCalls full type
>
> ```ts theme={null}
> custom[] | {
> }
> ```

***

### getCallsByIdRecord.get

`telephony.getCallsByIdRecord.get`

Getting call recording

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.telephony.getCallsByIdRecord.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

Returns call-recording bytes in a base64 envelope; maximum response size is capped by the client at 20 MiB.

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `kind` | `binary` | Yes | — |
| `contentType` | `string` | Yes | — |
| `base64` | `string` | Yes | — |

***

### manager.get

`telephony.manager.get`

Getting the responsible manager

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.telephony.manager.get({
	query: { phone: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | Yes | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   phone: string,
>   details?: custom,
>   ignoreStatus?: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `manager` | `object` | No | Manager |
| `customer` | `object` | No | Customer |
| `links` | `object` | No | Links |

> [accordion] manager full type
>
> ```ts theme={null}
> {
>   id?: string,
>   firstName?: string,
>   lastName?: string,
>   patronymic?: string,
>   email?: string,
>   code?: string
> }
> ```

> [accordion] customer full type
>
> ```ts theme={null}
> {
>   id?: string,
>   externalId?: string,
>   firstName?: string,
>   lastName?: string,
>   patronymic?: string,
>   email?: string,
>   phones?: {
>     number?: string | null
>   }[]
> }
> ```

> [accordion] links full type
>
> ```ts theme={null}
> {
>   newOrderLink?: string,
>   lastOrderLink?: string,
>   newCustomerLink?: string,
>   customerLink?: string
> }
> ```

***

## Tickets

### byExternalidEdit.post

`tickets.byExternalidEdit.post`

Editing a ticket

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.tickets.byExternalidEdit.post({
	path: { externalId: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticket: {
>     number?: string,
>     externalId?: string,
>     description?: string,
>     customer?: {
>       id?: number,
>       externalId?: string,
>       type?: custom,
>       site?: string
>     },
>     contact?: {
>       id?: number,
>       externalId?: string,
>       type?: custom,
>       site?: string
>     },
>     company?: {
>       id?: number,
>       externalId?: string
>     },
>     ticketChannel?: {
>       id: number
>     },
>     issues?: {
>       id?: number,
>       ticketType?: {
>         id: number
>       },
>       ticketSubtopic?: {
>         id: number
>       },
>       status?: {
>         id: number
>       },
>       responsible?: number
>     }[],
>     orders?: {
>       id?: number,
>       externalId?: string,
>       number?: string,
>       site?: string
>     }[],
>     orderProducts?: {
>       id: number
>     }[],
>     tags?: string[],
>     addTags?: string[],
>     removeTags?: string[],
>     attachedTag?: string,
>     customFields?: custom[] | {
>     },
>     callIds?: number[],
>     dialogIds?: number[]
>   },
>   by?: custom,
>   site?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `ticket` | `object` | No | — |
| `id` | `number` | No | — |

> [accordion] ticket full type
>
> ```ts theme={null}
> {
>   id?: number,
>   externalId?: string,
>   number?: string,
>   site?: string,
>   description?: string,
>   createdAt?: string,
>   fromApi?: boolean,
>   author?: number,
>   customer?: {
>     id?: number,
>     externalId?: string,
>     site?: string,
>     type?: custom
>   },
>   contact?: {
>     id?: number,
>     externalId?: string,
>     site?: string,
>     type?: custom
>   },
>   company?: {
>     id?: number,
>     externalId?: string
>   },
>   ticketChannel?: {
>     id?: number,
>     name?: string,
>     code?: string,
>     active?: boolean,
>     defaultForCrm?: boolean,
>     defaultForApi?: boolean,
>     ordering?: number
>   },
>   status?: {
>     id?: number,
>     name?: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     group?: {
>       color?: string,
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number
>     }
>   },
>   sla?: {
>     duration?: number,
>     status?: custom,
>     createdAt?: string,
>     warningAt?: string,
>     urgentAt?: string,
>     closedAt?: string,
>     remainingDuration?: number
>   },
>   issues?: {
>     id?: number,
>     ticketType?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       defaultForCrm?: boolean,
>       defaultForApi?: boolean,
>       ordering?: number
>     },
>     ticketSubtopic?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number,
>       topic?: {
>         id?: number,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         ordering?: number
>       }
>     },
>     status?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number,
>       group?: {
>         color?: string,
>         id?: number,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         ordering?: number
>       }
>     },
>     responsible?: number,
>     responsibleType?: custom,
>     closedAt?: string,
>     sla?: {
>       duration?: number,
>       status?: custom,
>       createdAt?: string,
>       warningAt?: string,
>       urgentAt?: string,
>       closedAt?: string,
>       remainingDuration?: number
>     }
>   }[],
>   orders?: {
>     id?: number,
>     externalId?: string,
>     number?: string,
>     site?: string
>   }[],
>   orderProducts?: {
>     id?: number,
>     externalIds?: {
>       code?: string,
>       value?: string
>     }[],
>     order?: {
>       id?: number,
>       externalId?: string,
>       number?: string,
>       site?: string
>     }
>   }[],
>   tags?: {
>     color?: string,
>     name?: string,
>     colorCode?: string
>   }[],
>   callIds?: number[],
>   dialogIds?: number[],
>   attachedTag?: string,
>   customFields?: custom[] | {
>   }
> }
> ```

***

### comments.get

`tickets.comments.get`

Get ticket comments

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.tickets.comments.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   cursor?: string,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     ticketIds
>   ][]?: number[],
>   filter[
>     ticketExternalIds
>   ][]?: string[],
>   filter[
>     authorIds
>   ][]?: number[],
>   filter[
>     text
>   ]?: string,
>   filter[
>     createdAtFrom
>   ]?: string,
>   filter[
>     createdAtTo
>   ]?: string,
>   filter[
>     sites
>   ][]?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination with cursors |
| `comments` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   nextCursor?: string
> }
> ```

> [accordion] comments full type
>
> ```ts theme={null}
> {
>   ticket?: {
>     id?: number,
>     externalId?: string,
>     number?: string,
>     site?: string
>   },
>   id?: number,
>   text?: string,
>   authorId?: number,
>   createdAt?: string,
>   updatedAt?: string
> }[]
> ```

***

### commentsByIdDelete.post

`tickets.commentsByIdDelete.post`

Delete a ticket comment

**Risk:** `destructive`

```ts theme={null}
await corsair.simlacom.api.tickets.commentsByIdDelete.post({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### commentsByIdEdit.post

`tickets.commentsByIdEdit.post`

Edit a ticket comment

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.tickets.commentsByIdEdit.post({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   comment: {
>     text: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### commentsCreate.post

`tickets.commentsCreate.post`

Create a ticket comment

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.tickets.commentsCreate.post({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   comment: {
>     text: string,
>     ticket: {
>       id?: number,
>       externalId?: string,
>       number?: string,
>       site?: string
>     },
>     authorId?: number
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `id` | `number` | No | Internal ID of created object |

***

### create.post

`tickets.create.post`

Creating a ticket

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.tickets.create.post({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   ticket: {
>     number?: string,
>     externalId?: string,
>     description?: string,
>     customer: {
>       id?: number,
>       externalId?: string,
>       type?: custom,
>       site?: string
>     },
>     contact?: {
>       id?: number,
>       externalId?: string,
>       type?: custom,
>       site?: string
>     },
>     company?: {
>       id?: number,
>       externalId?: string
>     },
>     ticketChannel?: {
>       id: number
>     },
>     issues?: {
>       id?: number,
>       ticketType?: {
>         id: number
>       },
>       ticketSubtopic?: {
>         id: number
>       },
>       status?: {
>         id: number
>       },
>       responsible?: number
>     }[],
>     orders?: {
>       id?: number,
>       externalId?: string,
>       number?: string,
>       site?: string
>     }[],
>     orderProducts?: {
>       id: number
>     }[],
>     tags?: string[],
>     addTags?: string[],
>     removeTags?: string[],
>     attachedTag?: string,
>     customFields?: custom[] | {
>     },
>     callIds?: number[],
>     dialogIds?: number[],
>     createdAt?: string
>   },
>   site?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `ticket` | `object` | No | — |
| `id` | `number` | No | — |

> [accordion] ticket full type
>
> ```ts theme={null}
> {
>   id?: number,
>   externalId?: string,
>   number?: string,
>   site?: string,
>   description?: string,
>   createdAt?: string,
>   fromApi?: boolean,
>   author?: number,
>   customer?: {
>     id?: number,
>     externalId?: string,
>     site?: string,
>     type?: custom
>   },
>   contact?: {
>     id?: number,
>     externalId?: string,
>     site?: string,
>     type?: custom
>   },
>   company?: {
>     id?: number,
>     externalId?: string
>   },
>   ticketChannel?: {
>     id?: number,
>     name?: string,
>     code?: string,
>     active?: boolean,
>     defaultForCrm?: boolean,
>     defaultForApi?: boolean,
>     ordering?: number
>   },
>   status?: {
>     id?: number,
>     name?: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     group?: {
>       color?: string,
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number
>     }
>   },
>   sla?: {
>     duration?: number,
>     status?: custom,
>     createdAt?: string,
>     warningAt?: string,
>     urgentAt?: string,
>     closedAt?: string,
>     remainingDuration?: number
>   },
>   issues?: {
>     id?: number,
>     ticketType?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       defaultForCrm?: boolean,
>       defaultForApi?: boolean,
>       ordering?: number
>     },
>     ticketSubtopic?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number,
>       topic?: {
>         id?: number,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         ordering?: number
>       }
>     },
>     status?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number,
>       group?: {
>         color?: string,
>         id?: number,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         ordering?: number
>       }
>     },
>     responsible?: number,
>     responsibleType?: custom,
>     closedAt?: string,
>     sla?: {
>       duration?: number,
>       status?: custom,
>       createdAt?: string,
>       warningAt?: string,
>       urgentAt?: string,
>       closedAt?: string,
>       remainingDuration?: number
>     }
>   }[],
>   orders?: {
>     id?: number,
>     externalId?: string,
>     number?: string,
>     site?: string
>   }[],
>   orderProducts?: {
>     id?: number,
>     externalIds?: {
>       code?: string,
>       value?: string
>     }[],
>     order?: {
>       id?: number,
>       externalId?: string,
>       number?: string,
>       site?: string
>     }
>   }[],
>   tags?: {
>     color?: string,
>     name?: string,
>     colorCode?: string
>   }[],
>   callIds?: number[],
>   dialogIds?: number[],
>   attachedTag?: string,
>   customFields?: custom[] | {
>   }
> }
> ```

***

### getByExternalid.get

`tickets.getByExternalid.get`

Get a ticket

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.tickets.getByExternalid.get({
	path: { externalId: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   externalId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   by?: custom,
>   site?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `ticket` | `object` | No | — |

> [accordion] ticket full type
>
> ```ts theme={null}
> {
>   id?: number,
>   externalId?: string,
>   number?: string,
>   site?: string,
>   description?: string,
>   createdAt?: string,
>   fromApi?: boolean,
>   author?: number,
>   customer?: {
>     id?: number,
>     externalId?: string,
>     site?: string,
>     type?: custom
>   },
>   contact?: {
>     id?: number,
>     externalId?: string,
>     site?: string,
>     type?: custom
>   },
>   company?: {
>     id?: number,
>     externalId?: string
>   },
>   ticketChannel?: {
>     id?: number,
>     name?: string,
>     code?: string,
>     active?: boolean,
>     defaultForCrm?: boolean,
>     defaultForApi?: boolean,
>     ordering?: number
>   },
>   status?: {
>     id?: number,
>     name?: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     group?: {
>       color?: string,
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number
>     }
>   },
>   sla?: {
>     duration?: number,
>     status?: custom,
>     createdAt?: string,
>     warningAt?: string,
>     urgentAt?: string,
>     closedAt?: string,
>     remainingDuration?: number
>   },
>   issues?: {
>     id?: number,
>     ticketType?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       defaultForCrm?: boolean,
>       defaultForApi?: boolean,
>       ordering?: number
>     },
>     ticketSubtopic?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number,
>       topic?: {
>         id?: number,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         ordering?: number
>       }
>     },
>     status?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number,
>       group?: {
>         color?: string,
>         id?: number,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         ordering?: number
>       }
>     },
>     responsible?: number,
>     responsibleType?: custom,
>     closedAt?: string,
>     sla?: {
>       duration?: number,
>       status?: custom,
>       createdAt?: string,
>       warningAt?: string,
>       urgentAt?: string,
>       closedAt?: string,
>       remainingDuration?: number
>     }
>   }[],
>   orders?: {
>     id?: number,
>     externalId?: string,
>     number?: string,
>     site?: string
>   }[],
>   orderProducts?: {
>     id?: number,
>     externalIds?: {
>       code?: string,
>       value?: string
>     }[],
>     order?: {
>       id?: number,
>       externalId?: string,
>       number?: string,
>       site?: string
>     }
>   }[],
>   tags?: {
>     color?: string,
>     name?: string,
>     colorCode?: string
>   }[],
>   callIds?: number[],
>   dialogIds?: number[],
>   attachedTag?: string,
>   customFields?: custom[] | {
>   }
> }
> ```

***

### history.get

`tickets.history.get`

Getting ticket change history

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.tickets.history.get({
	query: { filter[ticketId]: 0, filter[sinceId]: 0 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     startDate
>   ]?: string,
>   filter[
>     endDate
>   ]?: string,
>   filter[
>     ticketId
>   ]?: number,
>   filter[
>     ticketExternalId
>   ]?: string,
>   filter[
>     sinceId
>   ]?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `generatedAt` | `string` | No | — |
| `pagination` | `object` | No | Pagination |
| `history` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] history full type
>
> ```ts theme={null}
> {
>   id?: number,
>   createdAt?: string,
>   created?: boolean,
>   deleted?: boolean,
>   source?: string,
>   user?: {
>     id?: number
>   },
>   field?: string,
>   oldValue?: custom,
>   newValue?: custom,
>   apiKey?: {
>     current?: boolean,
>     id?: number
>   },
>   ticket?: {
>     id?: number,
>     externalId?: string,
>     number?: string,
>     site?: string,
>     description?: string,
>     createdAt?: string,
>     fromApi?: boolean,
>     author?: number,
>     customer?: {
>       id?: number,
>       externalId?: string,
>       site?: string,
>       type?: custom
>     },
>     contact?: {
>       id?: number,
>       externalId?: string,
>       site?: string,
>       type?: custom
>     },
>     company?: {
>       id?: number,
>       externalId?: string
>     },
>     ticketChannel?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       defaultForCrm?: boolean,
>       defaultForApi?: boolean,
>       ordering?: number
>     },
>     issues?: {
>       id?: number,
>       ticketType?: {
>         id?: number,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         defaultForCrm?: boolean,
>         defaultForApi?: boolean,
>         ordering?: number
>       },
>       ticketSubtopic?: {
>         id?: number,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         ordering?: number,
>         topic?: {
>           id?: number,
>           name?: string,
>           code?: string,
>           active?: boolean,
>           ordering?: number
>         }
>       },
>       status?: {
>         id?: number,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         ordering?: number,
>         group?: {
>           color?: string,
>           id?: number,
>           name?: string,
>           code?: string,
>           active?: boolean,
>           ordering?: number
>         }
>       },
>       responsible?: number,
>       responsibleType?: custom,
>       closedAt?: string
>     }[],
>     comments?: {
>       id?: number,
>       text?: string,
>       authorId?: number,
>       createdAt?: string,
>       updatedAt?: string
>     }[],
>     tags?: {
>       name?: string
>     }[],
>     customFields?: custom[] | {
>     }
>   },
>   issue?: {
>     id?: number,
>     ticketType?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       defaultForCrm?: boolean,
>       defaultForApi?: boolean,
>       ordering?: number
>     },
>     ticketSubtopic?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number,
>       topic?: {
>         id?: number,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         ordering?: number
>       }
>     },
>     status?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number,
>       group?: {
>         color?: string,
>         id?: number,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         ordering?: number
>       }
>     },
>     responsible?: number,
>     responsibleType?: custom,
>     closedAt?: string
>   },
>   comment?: {
>     id?: number,
>     text?: string,
>     authorId?: number,
>     createdAt?: string,
>     updatedAt?: string
>   }
> }[]
> ```

***

### list.get

`tickets.list.get`

get\_intaro\_crm\_api\_tickets\_list\_v5

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.tickets.list.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   filter[
>     customFields
>   ]?: custom[] | {
>   },
>   limit?: custom,
>   cursor?: string,
>   filter[
>     ids
>   ][]?: number[],
>   filter[
>     responsibles
>   ][]?: number[],
>   filter[
>     orderIds
>   ][]?: number[],
>   filter[
>     excludedOrderIds
>   ][]?: number[],
>   filter[
>     customerIds
>   ][]?: number[],
>   filter[
>     externalIds
>   ][]?: string[],
>   filter[
>     numbers
>   ][]?: string[],
>   filter[
>     orderNumbers
>   ][]?: string[],
>   filter[
>     customerExternalIds
>   ][]?: string[],
>   filter[
>     customerTags
>   ][]?: string[],
>   filter[
>     customerAttachedTags
>   ][]?: string[],
>   filter[
>     tags
>   ][]?: string[],
>   filter[
>     attachedTags
>   ][]?: string[],
>   filter[
>     sites
>   ][]?: string[],
>   filter[
>     channels
>   ][]?: string[],
>   filter[
>     types
>   ][]?: string[],
>   filter[
>     topics
>   ][]?: string[],
>   filter[
>     subtopics
>   ][]?: string[],
>   filter[
>     statuses
>   ][]?: string[],
>   filter[
>     segment
>   ][]?: string[],
>   filter[
>     createdAtFrom
>   ]?: string,
>   filter[
>     createdAtTo
>   ]?: string,
>   filter[
>     closedAtFrom
>   ]?: string,
>   filter[
>     closedAtTo
>   ]?: string,
>   filter[
>     ticketState
>   ]?: custom,
>   filter[
>     sla
>   ]?: custom,
>   filter[
>     customer
>   ]?: string,
>   filter[
>     email
>   ]?: string,
>   filter[
>     customerType
>   ]?: custom,
>   filter[
>     description
>   ]?: string,
>   filter[
>     comments
>   ]?: string,
>   filter[
>     vip
>   ]?: boolean,
>   filter[
>     bad
>   ]?: boolean,
>   filter[
>     tasks
>   ]?: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination with cursors |
| `tickets` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   nextCursor?: string
> }
> ```

> [accordion] tickets full type
>
> ```ts theme={null}
> {
>   id?: number,
>   externalId?: string,
>   number?: string,
>   site?: string,
>   description?: string,
>   createdAt?: string,
>   fromApi?: boolean,
>   author?: number,
>   customer?: {
>     id?: number,
>     externalId?: string,
>     site?: string,
>     type?: custom
>   },
>   contact?: {
>     id?: number,
>     externalId?: string,
>     site?: string,
>     type?: custom
>   },
>   company?: {
>     id?: number,
>     externalId?: string
>   },
>   ticketChannel?: {
>     id?: number,
>     name?: string,
>     code?: string,
>     active?: boolean,
>     defaultForCrm?: boolean,
>     defaultForApi?: boolean,
>     ordering?: number
>   },
>   status?: {
>     id?: number,
>     name?: string,
>     code?: string,
>     active?: boolean,
>     ordering?: number,
>     group?: {
>       color?: string,
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number
>     }
>   },
>   sla?: {
>     duration?: number,
>     status?: custom,
>     createdAt?: string,
>     warningAt?: string,
>     urgentAt?: string,
>     closedAt?: string,
>     remainingDuration?: number
>   },
>   issues?: {
>     id?: number,
>     ticketType?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       defaultForCrm?: boolean,
>       defaultForApi?: boolean,
>       ordering?: number
>     },
>     ticketSubtopic?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number,
>       topic?: {
>         id?: number,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         ordering?: number
>       }
>     },
>     status?: {
>       id?: number,
>       name?: string,
>       code?: string,
>       active?: boolean,
>       ordering?: number,
>       group?: {
>         color?: string,
>         id?: number,
>         name?: string,
>         code?: string,
>         active?: boolean,
>         ordering?: number
>       }
>     },
>     responsible?: number,
>     responsibleType?: custom,
>     closedAt?: string,
>     sla?: {
>       duration?: number,
>       status?: custom,
>       createdAt?: string,
>       warningAt?: string,
>       urgentAt?: string,
>       closedAt?: string,
>       remainingDuration?: number
>     }
>   }[],
>   orders?: {
>     id?: number,
>     externalId?: string,
>     number?: string,
>     site?: string
>   }[],
>   orderProducts?: {
>     id?: number,
>     externalIds?: {
>       code?: string,
>       value?: string
>     }[],
>     order?: {
>       id?: number,
>       externalId?: string,
>       number?: string,
>       site?: string
>     }
>   }[],
>   tags?: {
>     color?: string,
>     name?: string,
>     colorCode?: string
>   }[],
>   callIds?: number[],
>   dialogIds?: number[],
>   attachedTag?: string,
>   customFields?: custom[] | {
>   }
> }[]
> ```

***

## Users

### byIdStatus.post

`users.byIdStatus.post`

Change user status

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.users.byIdStatus.post({
	path: { id: 1 },
	body: { status: 'free' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   status?: custom
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |

***

### getById.get

`users.getById.get`

Getting information on user

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.users.getById.get({
	path: { id: 1 },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   id: number
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `user` | `object` | No | User |

> [accordion] user full type
>
> ```ts theme={null}
> {
>   id?: number,
>   createdAt?: string,
>   active?: boolean,
>   email?: string,
>   firstName?: string,
>   lastName?: string,
>   patronymic?: string,
>   position?: string,
>   photoUrl?: string,
>   phone?: string,
>   status?: string,
>   online?: boolean,
>   lastOnline?: string,
>   isAdmin?: boolean,
>   isManager?: boolean,
>   groups?: {
>     id: number,
>     name: string,
>     code: string
>   }[],
>   mgUserId?: number,
>   senderEmail?: string,
>   senderName?: string,
>   language?: string
> }
> ```

***

### list.get

`users.list.get`

Getting the list of users matched the specified filter

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.users.list.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number,
>   filter[
>     email
>   ]?: string,
>   filter[
>     active
>   ]?: custom,
>   filter[
>     online
>   ]?: custom,
>   filter[
>     status
>   ]?: custom,
>   filter[
>     isManager
>   ]?: custom,
>   filter[
>     isAdmin
>   ]?: custom,
>   filter[
>     groups
>   ][]?: string[],
>   filter[
>     createdAtFrom
>   ]?: string,
>   filter[
>     createdAtTo
>   ]?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `users` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] users full type
>
> ```ts theme={null}
> {
>   id?: number,
>   createdAt?: string,
>   active?: boolean,
>   email?: string,
>   firstName?: string,
>   lastName?: string,
>   patronymic?: string,
>   position?: string,
>   photoUrl?: string,
>   phone?: string,
>   status?: string,
>   online?: boolean,
>   lastOnline?: string,
>   isAdmin?: boolean,
>   isManager?: boolean,
>   groups?: {
>     id: number,
>     name: string,
>     code: string
>   }[],
>   mgUserId?: number,
>   senderEmail?: string,
>   senderName?: string,
>   language?: string
> }[]
> ```

***

### userGroups.get

`users.userGroups.get`

Getting the list of user groups

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.users.userGroups.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
>   limit?: custom,
>   page?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `pagination` | `object` | No | Pagination |
| `groups` | `object[]` | No | — |

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   limit?: number,
>   totalCount?: number,
>   currentPage?: number,
>   totalPageCount?: number
> }
> ```

> [accordion] groups full type
>
> ```ts theme={null}
> {
>   id?: number,
>   name: string,
>   signatureTemplate?: string,
>   code?: string,
>   isManager?: boolean,
>   isDeliveryMen?: boolean,
>   deliveryTypes?: custom[] | {
>   },
>   breakdownOrderTypes?: custom[] | {
>   },
>   breakdownStatusGroups?: custom[] | {
>   },
>   breakdownSites?: custom[] | {
>   },
>   breakdownOrderMethods?: custom[] | {
>   },
>   grantedOrderTypes?: custom[] | {
>   },
>   grantedStatusGroups?: custom[] | {
>   },
>   grantedSites?: custom[] | {
>   }
> }[]
> ```

***

## Verification

### getSmsByCheckidStatus.get

`verification.getSmsByCheckidStatus.get`

Checking the verification status

**Risk:** `read`

```ts theme={null}
await corsair.simlacom.api.verification.getSmsByCheckidStatus.get({
	path: { checkId: 'demo' },
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | Yes | — |
| `query` | `object` | No | — |
| `body` | `never` | No | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
>   checkId: unknown
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `verification` | `object` | No | SMS-verification |

> [accordion] verification full type
>
> ```ts theme={null}
> {
>   createdAt?: string,
>   expiredAt?: string,
>   verifiedAt?: string,
>   checkId?: string,
>   actionType?: string
> }
> ```

***

### smsConfirm.post

`verification.smsConfirm.post`

Confirmation of verification

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.verification.smsConfirm.post({
	body: {
		verification: { code: 'demo' },
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   verification?: {
>     code?: string,
>     checkId?: string
>   }
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `verification` | `object` | No | SMS-verification |

> [accordion] verification full type
>
> ```ts theme={null}
> {
>   createdAt?: string,
>   expiredAt?: string,
>   verifiedAt?: string,
>   checkId?: string,
>   actionType?: string
> }
> ```

***

## Web Analytics

### clientIdsUpload.post

`webAnalytics.clientIdsUpload.post`

Batch uploading of web analytics clientId

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.webAnalytics.clientIdsUpload.post({
	body: {
		clientIds: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   clientIds?: {
>     value?: string,
>     createdAt?: string,
>     order?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     } | null,
>     customer?: {
>       id?: number,
>       externalId?: string
>     } | null,
>     site?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `failedClientIds` | `object[]` | No | — |
| `errorMsg` | `string` | No | — |
| `errors` | `custom[] \| object` | No | — |

> [accordion] failedClientIds full type
>
> ```ts theme={null}
> {
>   value?: string,
>   createdAt?: string,
>   order?: {
>     id?: number,
>     externalId?: string,
>     number?: string
>   } | null,
>   customer?: {
>     site?: string,
>     id?: number,
>     externalId?: string,
>     type?: string
>   } | null,
>   site?: string
> }[]
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> custom[] | {
> }
> ```

***

### sourcesUpload.post

`webAnalytics.sourcesUpload.post`

Batch uploading of sources

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.webAnalytics.sourcesUpload.post({
	body: {
		sources: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   sources?: {
>     source?: string,
>     medium?: string,
>     campaign?: string,
>     keyword?: string,
>     content?: string,
>     clientId?: string,
>     order?: {
>       id?: number,
>       externalId?: string,
>       number?: string
>     } | null,
>     customer?: {
>       id?: number,
>       externalId?: string
>     } | null,
>     site?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `failedSources` | `object[]` | No | — |
| `errorMsg` | `string` | No | — |
| `errors` | `custom[] \| object` | No | — |

> [accordion] failedSources full type
>
> ```ts theme={null}
> {
>   source?: string,
>   medium?: string,
>   campaign?: string,
>   keyword?: string,
>   content?: string,
>   clientId?: string,
>   order?: {
>     id?: number,
>     externalId?: string,
>     number?: string
>   } | null,
>   customer?: {
>     site?: string,
>     id?: number,
>     externalId?: string,
>     type?: string
>   } | null,
>   site?: string
> }[]
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> custom[] | {
> }
> ```

***

### visitsUpload.post

`webAnalytics.visitsUpload.post`

Batch uploading of visits

**Risk:** `write`

```ts theme={null}
await corsair.simlacom.api.webAnalytics.visitsUpload.post({
	body: {
		visits: [],
	},
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `path` | `object` | No | — |
| `query` | `object` | No | — |
| `body` | `object` | Yes | — |

> [accordion] path full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] query full type
>
> ```ts theme={null}
> {
> }
> ```

> [accordion] body full type
>
> ```ts theme={null}
> {
>   visits?: {
>     createdAt?: string | null,
>     visitLength?: number | null,
>     exitPage?: string | null,
>     landingPage?: string | null,
>     pageViews?: number | null,
>     pageDepth?: number | null,
>     customer?: {
>       id?: number,
>       externalId?: string
>     } | null,
>     source?: {
>       source?: string,
>       medium?: string,
>       campaign?: string,
>       keyword?: string,
>       content?: string
>     } | null,
>     pages?: {
>       url?: string,
>       title?: string | null,
>       countViews?: number | null,
>       timeOnPage?: number | null
>     }[],
>     clientId?: string | null,
>     site?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | No | Query result (successful/unsuccessful) |
| `failedVisits` | `object[]` | No | — |
| `errorMsg` | `string` | No | — |
| `errors` | `custom[] \| object` | No | — |

> [accordion] failedVisits full type
>
> ```ts theme={null}
> {
>   createdAt?: string | null,
>   visitLength?: number | null,
>   exitPage?: string | null,
>   landingPage?: string | null,
>   pageViews?: number | null,
>   pageDepth?: number | null,
>   customer?: {
>     site?: string,
>     id?: number,
>     externalId?: string,
>     type?: string
>   } | null,
>   source?: {
>     source?: string,
>     medium?: string,
>     campaign?: string,
>     keyword?: string,
>     content?: string
>   } | null,
>   pages?: {
>     url?: string,
>     title?: string | null,
>     countViews?: number | null,
>     timeOnPage?: number | null
>   }[],
>   clientId?: string | null,
>   site?: string
> }[]
> ```

> [accordion] errors full type
>
> ```ts theme={null}
> custom[] | {
> }
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.