Организации

Методы для работы с организациями

Получение всех доступных организаций пользователя

get

/v1.2/catalogs/organizations

CURL

Копировать

Пример ответа

Ответ

200 Организации

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"ownership":0,

"residency":{},

"inn":"string",

"phone":"string",

"extra_phone":0,

"docs_address":{...},

"postcode":"string",

"city_id":0,

"street_name":"string",

"house_no":"string",

"office_no":"string"

"addresses":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"all_departments_allowed":false,

"department_ids":[...]

]

}

]

[{...}]

Организация

id: guid

ID организации

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

residency:

ONE-OF

prop0: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

Регистрационный номер (ИНН, ЕДРПОУ, УНП, БИН или их аналоги)

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string (nullable)

Почтовый индекс

city_id: int32 (nullable)

Id населенного пункта
Значение из словаря

street_name: string (nullable)

Улица, проспект, переулок, бульвар и пр.

house_no: string (nullable)

Дом, строение, корпус, литера

office_no: string (nullable)

Офис, помещение и пр.

}

addresses:[{...}]

Адреса

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}]

contact_persons:[{...}]

Контакты организации

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

all_departments_allowed: boolean

Организация доступна всем подразделениям

department_ids: [int32]

Подразделения, которым доступна организация

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение всех доступных организаций пользователя

get

/gw/oauth2/catalogs/v1.2/organizations

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

CURL

Копировать

Пример ответа

Ответ

200 Организации

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"ownership":0,

"residency":{},

"inn":"string",

"phone":"string",

"extra_phone":0,

"docs_address":{...},

"postcode":"string",

"city_id":0,

"street_name":"string",

"house_no":"string",

"office_no":"string"

"addresses":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"all_departments_allowed":false,

"department_ids":[...]

]

}

]

[{...}]

Организация

id: guid

ID организации

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

residency:

ONE-OF

prop0: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

Регистрационный номер (ИНН, ЕДРПОУ, УНП, БИН или их аналоги)

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string (nullable)

Почтовый индекс

city_id: int32 (nullable)

Id населенного пункта
Значение из словаря

street_name: string (nullable)

Улица, проспект, переулок, бульвар и пр.

house_no: string (nullable)

Дом, строение, корпус, литера

office_no: string (nullable)

Офис, помещение и пр.

}

addresses:[{...}]

Адреса

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}]

contact_persons:[{...}]

Контакты организации

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

all_departments_allowed: boolean

Организация доступна всем подразделениям

department_ids: [int32]

Подразделения, которым доступна организация

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Добавление организации

post

/v1.2/catalogs/organizations

Развернуть все Свернуть все

body

Данные организации

{...}

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

all_departments_allowed: boolean

Организация доступна всем подразделениям? Если нет, то в параметре department_ids необходимо указать, каким подразделениям доступна

department_ids: [int32]

Подразделения, которым доступна организация

residency: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

Регистрационный номер (ИНН, ЕДРПОУ, УНП, БИН или их аналоги). Используйте номер в соответствии со своим резидентством

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string

Почтовый индекс

city_id: int32

Id населенного пункта
Значение из словаря

street_name: string

Улица, проспект, переулок, бульвар и пр.

house_no: string

Дом, строение, корпус, литера

office_no: string

Офис, помещение и пр.

}

address_ids: [guid]

Адреса организации, id

contact_person_ids: [guid]

Контактные лица организации, id

}

CURL

Копировать

Пример ответа

Ответ

200 Добавленная организация

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"ownership":0,

"residency":{},

"inn":"string",

"phone":"string",

"extra_phone":0,

"docs_address":{...},

"postcode":"string",

"city_id":0,

"street_name":"string",

"house_no":"string",

"office_no":"string"

"addresses":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"all_departments_allowed":false,

"department_ids":[...]

]

}

{...}

Организация

id: guid

ID организации

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

residency:

ONE-OF

prop0: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

Регистрационный номер (ИНН, ЕДРПОУ, УНП, БИН или их аналоги)

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string (nullable)

Почтовый индекс

city_id: int32 (nullable)

Id населенного пункта
Значение из словаря

street_name: string (nullable)

Улица, проспект, переулок, бульвар и пр.

house_no: string (nullable)

Дом, строение, корпус, литера

office_no: string (nullable)

Офис, помещение и пр.

}

addresses:[{...}]

Адреса

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}]

contact_persons:[{...}]

Контакты организации

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

all_departments_allowed: boolean

Организация доступна всем подразделениям

department_ids: [int32]

Подразделения, которым доступна организация

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Добавление организации

post

/gw/oauth2/catalogs/v1.2/organizations

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Развернуть все Свернуть все

body

Данные организации

{...}

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

all_departments_allowed: boolean

department_ids: [int32]

Подразделения, которым доступна организация

residency: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string

Почтовый индекс

city_id: int32

Id населенного пункта
Значение из словаря

street_name: string

Улица, проспект, переулок, бульвар и пр.

house_no: string

Дом, строение, корпус, литера

office_no: string

Офис, помещение и пр.

}

address_ids: [guid]

Адреса организации, id

contact_person_ids: [guid]

Контактные лица организации, id

}

CURL

Копировать

Пример ответа

Ответ

200 Добавленная организация

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"ownership":0,

"residency":{},

"inn":"string",

"phone":"string",

"extra_phone":0,

"docs_address":{...},

"postcode":"string",

"city_id":0,

"street_name":"string",

"house_no":"string",

"office_no":"string"

"addresses":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"all_departments_allowed":false,

"department_ids":[...]

]

}

{...}

Организация

id: guid

ID организации

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

residency:

ONE-OF

prop0: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

Регистрационный номер (ИНН, ЕДРПОУ, УНП, БИН или их аналоги)

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string (nullable)

Почтовый индекс

city_id: int32 (nullable)

Id населенного пункта
Значение из словаря

street_name: string (nullable)

Улица, проспект, переулок, бульвар и пр.

house_no: string (nullable)

Дом, строение, корпус, литера

office_no: string (nullable)

Офис, помещение и пр.

}

addresses:[{...}]

Адреса

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}]

contact_persons:[{...}]

Контакты организации

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

all_departments_allowed: boolean

Организация доступна всем подразделениям

department_ids: [int32]

Подразделения, которым доступна организация

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение организаций пользователя по подразделениям

post

/v1.2/catalogs/organizations/filter

Развернуть все Свернуть все

body

object

Модель для фильтрации

{...}

departments: [int32]

Список подразделений, по которым необходимо отфильтровать организации

}

CURL

Копировать

Пример ответа

Ответ

200 Организации

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"ownership":0,

"residency":{},

"inn":"string",

"phone":"string",

"extra_phone":0,

"docs_address":{...},

"postcode":"string",

"city_id":0,

"street_name":"string",

"house_no":"string",

"office_no":"string"

"addresses":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"all_departments_allowed":false,

"department_ids":[...]

]

}

]

[{...}]

Организация

id: guid

ID организации

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

residency:

ONE-OF

prop0: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

Регистрационный номер (ИНН, ЕДРПОУ, УНП, БИН или их аналоги)

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string (nullable)

Почтовый индекс

city_id: int32 (nullable)

Id населенного пункта
Значение из словаря

street_name: string (nullable)

Улица, проспект, переулок, бульвар и пр.

house_no: string (nullable)

Дом, строение, корпус, литера

office_no: string (nullable)

Офис, помещение и пр.

}

addresses:[{...}]

Адреса

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}]

contact_persons:[{...}]

Контакты организации

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

all_departments_allowed: boolean

Организация доступна всем подразделениям

department_ids: [int32]

Подразделения, которым доступна организация

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение организаций пользователя по подразделениям

post

/gw/oauth2/catalogs/v1.2/organizations/filter

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Развернуть все Свернуть все

body

object

Модель для фильтрации

{...}

departments: [int32]

Список подразделений, по которым необходимо отфильтровать организации

}

CURL

Копировать

Пример ответа

Ответ

200 Организации

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"ownership":0,

"residency":{},

"inn":"string",

"phone":"string",

"extra_phone":0,

"docs_address":{...},

"postcode":"string",

"city_id":0,

"street_name":"string",

"house_no":"string",

"office_no":"string"

"addresses":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"all_departments_allowed":false,

"department_ids":[...]

]

}

]

[{...}]

Организация

id: guid

ID организации

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

residency:

ONE-OF

prop0: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

Регистрационный номер (ИНН, ЕДРПОУ, УНП, БИН или их аналоги)

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string (nullable)

Почтовый индекс

city_id: int32 (nullable)

Id населенного пункта
Значение из словаря

street_name: string (nullable)

Улица, проспект, переулок, бульвар и пр.

house_no: string (nullable)

Дом, строение, корпус, литера

office_no: string (nullable)

Офис, помещение и пр.

}

addresses:[{...}]

Адреса

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}]

contact_persons:[{...}]

Контакты организации

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

all_departments_allowed: boolean

Организация доступна всем подразделениям

department_ids: [int32]

Подразделения, которым доступна организация

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение организации пользователя по id

get

/v1.2/catalogs/organizations/{organizationId}

organizationId

guid

Id организации

CURL

Копировать

Пример ответа

Ответ

200 Организация

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"ownership":0,

"residency":{},

"inn":"string",

"phone":"string",

"extra_phone":0,

"docs_address":{...},

"postcode":"string",

"city_id":0,

"street_name":"string",

"house_no":"string",

"office_no":"string"

"addresses":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"all_departments_allowed":false,

"department_ids":[...]

]

}

{...}

Организация

id: guid

ID организации

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

residency:

ONE-OF

prop0: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

Регистрационный номер (ИНН, ЕДРПОУ, УНП, БИН или их аналоги)

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string (nullable)

Почтовый индекс

city_id: int32 (nullable)

Id населенного пункта
Значение из словаря

street_name: string (nullable)

Улица, проспект, переулок, бульвар и пр.

house_no: string (nullable)

Дом, строение, корпус, литера

office_no: string (nullable)

Офис, помещение и пр.

}

addresses:[{...}]

Адреса

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}]

contact_persons:[{...}]

Контакты организации

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

all_departments_allowed: boolean

Организация доступна всем подразделениям

department_ids: [int32]

Подразделения, которым доступна организация

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение организации пользователя по id

get

/gw/oauth2/catalogs/v1.2/organizations/{organizationId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

organizationId

guid

Id организации

CURL

Копировать

Пример ответа

Ответ

200 Организация

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"ownership":0,

"residency":{},

"inn":"string",

"phone":"string",

"extra_phone":0,

"docs_address":{...},

"postcode":"string",

"city_id":0,

"street_name":"string",

"house_no":"string",

"office_no":"string"

"addresses":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"all_departments_allowed":false,

"department_ids":[...]

]

}

{...}

Организация

id: guid

ID организации

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

residency:

ONE-OF

prop0: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

Регистрационный номер (ИНН, ЕДРПОУ, УНП, БИН или их аналоги)

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string (nullable)

Почтовый индекс

city_id: int32 (nullable)

Id населенного пункта
Значение из словаря

street_name: string (nullable)

Улица, проспект, переулок, бульвар и пр.

house_no: string (nullable)

Дом, строение, корпус, литера

office_no: string (nullable)

Офис, помещение и пр.

}

addresses:[{...}]

Адреса

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}]

contact_persons:[{...}]

Контакты организации

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

all_departments_allowed: boolean

Организация доступна всем подразделениям

department_ids: [int32]

Подразделения, которым доступна организация

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Изменение организации

put

/v1.2/catalogs/organizations/{organizationId}

organizationId

guid

Id организации

Развернуть все Свернуть все

body

Данные организации

{...}

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

all_departments_allowed: boolean

department_ids: [int32]

Подразделения, которым доступна организация

residency: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string

Почтовый индекс

city_id: int32

Id населенного пункта
Значение из словаря

street_name: string

Улица, проспект, переулок, бульвар и пр.

house_no: string

Дом, строение, корпус, литера

office_no: string

Офис, помещение и пр.

}

address_ids: [guid]

Адреса организации, id

contact_person_ids: [guid]

Контактные лица организации, id

}

CURL

Копировать

Пример ответа

Ответ

200 Измененная организация

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"ownership":0,

"residency":{},

"inn":"string",

"phone":"string",

"extra_phone":0,

"docs_address":{...},

"postcode":"string",

"city_id":0,

"street_name":"string",

"house_no":"string",

"office_no":"string"

"addresses":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"all_departments_allowed":false,

"department_ids":[...]

]

}

{...}

Организация

id: guid

ID организации

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

residency:

ONE-OF

prop0: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

Регистрационный номер (ИНН, ЕДРПОУ, УНП, БИН или их аналоги)

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string (nullable)

Почтовый индекс

city_id: int32 (nullable)

Id населенного пункта
Значение из словаря

street_name: string (nullable)

Улица, проспект, переулок, бульвар и пр.

house_no: string (nullable)

Дом, строение, корпус, литера

office_no: string (nullable)

Офис, помещение и пр.

}

addresses:[{...}]

Адреса

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}]

contact_persons:[{...}]

Контакты организации

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

all_departments_allowed: boolean

Организация доступна всем подразделениям

department_ids: [int32]

Подразделения, которым доступна организация

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Изменение организации

put

/gw/oauth2/catalogs/v1.2/organizations/{organizationId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

organizationId

guid

Id организации

Развернуть все Свернуть все

body

Данные организации

{...}

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

all_departments_allowed: boolean

department_ids: [int32]

Подразделения, которым доступна организация

residency: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string

Почтовый индекс

city_id: int32

Id населенного пункта
Значение из словаря

street_name: string

Улица, проспект, переулок, бульвар и пр.

house_no: string

Дом, строение, корпус, литера

office_no: string

Офис, помещение и пр.

}

address_ids: [guid]

Адреса организации, id

contact_person_ids: [guid]

Контактные лица организации, id

}

CURL

Копировать

Пример ответа

Ответ

200 Измененная организация

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"ownership":0,

"residency":{},

"inn":"string",

"phone":"string",

"extra_phone":0,

"docs_address":{...},

"postcode":"string",

"city_id":0,

"street_name":"string",

"house_no":"string",

"office_no":"string"

"addresses":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"all_departments_allowed":false,

"department_ids":[...]

]

}

{...}

Организация

id: guid

ID организации

Название

ownership: int32

Организационно-правовая форма собственности. Значение из словаря

residency:

ONE-OF

prop0: enum

[1, 2, 3, 10, 200]

Резидентство

1 — Россия
2 — Украина
3 — Беларусь
10 — Казахстан
200 — Международное (другое)

inn: string (nullable)

Регистрационный номер (ИНН, ЕДРПОУ, УНП, БИН или их аналоги)

phone: string (nullable)

Номер телефона организации

extra_phone: int32 (nullable)

Добавочный номер

docs_address:

Адрес местонахождения для документов

ONE-OF

1:{...}

Адрес местонахождения для документов

postcode: string (nullable)

Почтовый индекс

city_id: int32 (nullable)

Id населенного пункта
Значение из словаря

street_name: string (nullable)

Улица, проспект, переулок, бульвар и пр.

house_no: string (nullable)

Дом, строение, корпус, литера

office_no: string (nullable)

Офис, помещение и пр.

}

addresses:[{...}]

Адреса

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}]

contact_persons:[{...}]

Контакты организации

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

all_departments_allowed: boolean

Организация доступна всем подразделениям

department_ids: [int32]

Подразделения, которым доступна организация

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Удаление организации

delete

/v1.2/catalogs/organizations/{organizationId}

organizationId

guid

Id организации

CURL

Копировать

Пример ответа

Ответ

200 Успешное удаление организации

Развернуть все Свернуть все

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Удаление организации

delete

/gw/oauth2/catalogs/v1.2/organizations/{organizationId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

organizationId

guid

Id организации

CURL

Копировать

Пример ответа

Ответ

200 Успешное удаление организации

Развернуть все Свернуть все

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Методы для работы с адресами организаций

Получение всех адресов пользователя

get

/v1.2/catalogs/organizations/addresses

CURL

Копировать

Пример ответа

Ответ

200 Адреса

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

]

[{...}]

Адрес

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение всех адресов пользователя

get

/gw/oauth2/catalogs/v1.2/organizations/addresses

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

CURL

Копировать

Пример ответа

Ответ

200 Адреса

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

]

[{...}]

Адрес

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Добавление адреса

post

/v1.2/catalogs/organizations/addresses

Развернуть все Свернуть все

body

object

Модель добавляемого адреса

{...}

address: string (nullable)

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double (nullable)

Координаты адреса: широта

address_longitude: double (nullable)

Координаты адреса: долгота

note: string (nullable)

Примечание

schedule_summary: string (nullable)

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

contact_person_ids: [guid]

ID контактных лиц

}

CURL

Копировать

Пример ответа

Ответ

200 Добавленный адрес

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

{...}

Адрес

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Добавление адреса

post

/gw/oauth2/catalogs/v1.2/organizations/addresses

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Развернуть все Свернуть все

body

object

Модель добавляемого адреса

{...}

address: string (nullable)

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double (nullable)

Координаты адреса: широта

address_longitude: double (nullable)

Координаты адреса: долгота

note: string (nullable)

Примечание

schedule_summary: string (nullable)

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

contact_person_ids: [guid]

ID контактных лиц

}

CURL

Копировать

Пример ответа

Ответ

200 Добавленный адрес

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

{...}

Адрес

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение адреса пользователя по id

get

/v1.2/catalogs/organizations/addresses/{addressId}

addressId

guid

Id адреса

CURL

Копировать

Пример ответа

Ответ

200 Адрес

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

{...}

Адрес

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение адреса пользователя по id

get

/gw/oauth2/catalogs/v1.2/organizations/addresses/{addressId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

addressId

guid

Id адреса

CURL

Копировать

Пример ответа

Ответ

200 Адрес

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

{...}

Адрес

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Изменение адреса

put

/v1.2/catalogs/organizations/addresses/{addressId}

addressId

guid

Id изменяемого адреса

Развернуть все Свернуть все

body

object

Модель изменяемого адреса

{...}

address: string (nullable)

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double (nullable)

Координаты адреса: широта

address_longitude: double (nullable)

Координаты адреса: долгота

note: string (nullable)

Примечание

schedule_summary: string (nullable)

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

contact_person_ids: [guid]

ID контактных лиц

}

CURL

Копировать

Пример ответа

Ответ

200 Измененный адрес

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

{...}

Адрес

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Изменение адреса

put

/gw/oauth2/catalogs/v1.2/organizations/addresses/{addressId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

addressId

guid

Id изменяемого адреса

Развернуть все Свернуть все

body

object

Модель изменяемого адреса

{...}

address: string (nullable)

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double (nullable)

Координаты адреса: широта

address_longitude: double (nullable)

Координаты адреса: долгота

note: string (nullable)

Примечание

schedule_summary: string (nullable)

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

contact_person_ids: [guid]

ID контактных лиц

}

CURL

Копировать

Пример ответа

Ответ

200 Измененный адрес

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"address":"string",

"address_city_id":0,

"address_latitude":0.5,

"address_longitude":0.5,

"note":"string",

"contact_persons":[...],

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

"schedule_summary":"string",

"address_type":0

}

{...}

Адрес

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

ID города. Значение из словаря

address_latitude: double

Координаты адреса: широта

address_longitude: double

Координаты адреса: долгота

note: string

Примечание

contact_persons:[{...}]

Контакты адреса

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

schedule_summary: string

Текстовое описание времени работы

address_type: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Удаление адреса

delete

/v1.2/catalogs/organizations/addresses/{addressId}

addressId

guid

Id удаляемого адреса

CURL

Копировать

Пример ответа

Ответ

200 Удаление адреса

Развернуть все Свернуть все

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Удаление адреса

delete

/gw/oauth2/catalogs/v1.2/organizations/addresses/{addressId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

addressId

guid

Id удаляемого адреса

CURL

Копировать

Пример ответа

Ответ

200 Удаление адреса

Развернуть все Свернуть все

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение типов адресов

get

/v1.2/catalogs/organizations/addresses/types

CURL

Копировать

Пример ответа

Ответ

200 Типы адресов

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"id":0,

"name":"string",

"name_eng":"string"

}

]

[{...}]

id: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

name_eng: string

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение типов адресов

get

/gw/oauth2/catalogs/v1.2/organizations/addresses/types

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

CURL

Копировать

Пример ответа

Ответ

200 Типы адресов

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"id":0,

"name":"string",

"name_eng":"string"

}

]

[{...}]

id: enum

[1, 2, 3]

Тип адреса

1 — Склад
2 — Офис
3 — Магазин

name_eng: string

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Методы для работы с контактными лицами организаций

Получение всех контактных лиц пользователя

get

/v1.2/catalogs/organizations/contactPersons

CURL

Копировать

Пример ответа

Ответ

200 Контактные лица

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

]

[{...}]

Контактное лицо

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение всех контактных лиц пользователя

get

/gw/oauth2/catalogs/v1.2/organizations/contactPersons

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

CURL

Копировать

Пример ответа

Ответ

200 Контактные лица

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

]

[{...}]

Контактное лицо

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}]

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Добавление контактного лица пользователя

post

/v1.2/catalogs/organizations/contactPersons

Развернуть все Свернуть все

body

object

Модель контактного лица

{...}

ФИО

phone: string (nullable)

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string (nullable)

Электронная почта

}

CURL

Копировать

Пример ответа

Ответ

200 Добавленное контактное лицо

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

{...}

Контактное лицо

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Добавление контактного лица пользователя

post

/gw/oauth2/catalogs/v1.2/organizations/contactPersons

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

Развернуть все Свернуть все

body

object

Модель контактного лица

{...}

ФИО

phone: string (nullable)

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string (nullable)

Электронная почта

}

CURL

Копировать

Пример ответа

Ответ

200 Добавленное контактное лицо

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

{...}

Контактное лицо

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение контактного лица пользователя по id

get

/v1.2/catalogs/organizations/contactPersons/{contactPersonId}

contactPersonId

guid

Id контактного лица

CURL

Копировать

Пример ответа

Ответ

200 Контактное лицо

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

{...}

Контактное лицо

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение контактного лица пользователя по id

get

/gw/oauth2/catalogs/v1.2/organizations/contactPersons/{contactPersonId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

contactPersonId

guid

Id контактного лица

CURL

Копировать

Пример ответа

Ответ

200 Контактное лицо

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

{...}

Контактное лицо

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Изменение контактного лица пользователя

put

/v1.2/catalogs/organizations/contactPersons/{contactPersonId}

contactPersonId

guid

Id контактного лица

Развернуть все Свернуть все

body

object

Модель контактного лица

{...}

ФИО

phone: string (nullable)

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string (nullable)

Электронная почта

}

CURL

Копировать

Пример ответа

Ответ

200 Измененное контактное лицо

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

{...}

Контактное лицо

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Изменение контактного лица пользователя

put

/gw/oauth2/catalogs/v1.2/organizations/contactPersons/{contactPersonId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

contactPersonId

guid

Id контактного лица

Развернуть все Свернуть все

body

object

Модель контактного лица

{...}

ФИО

phone: string (nullable)

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string (nullable)

Электронная почта

}

CURL

Копировать

Пример ответа

Ответ

200 Измененное контактное лицо

Развернуть все Свернуть все

Пример

Модель

{...}

"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"name":"string",

"phone":"string",

"extra_phone":0,

"email":"string"

}

{...}

Контактное лицо

id: guid

ID контакного лица

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

Добавочный номер

email: string

Электронная почта

}

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Удаление контактного лица пользователя

delete

/v1.2/catalogs/organizations/contactPersons/{contactPersonId}

contactPersonId

guid

Id контактного лица

CURL

Копировать

Пример ответа

Ответ

200 Удаление контактного лица пользователя

Развернуть все Свернуть все

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Удаление контактного лица пользователя

delete

/gw/oauth2/catalogs/v1.2/organizations/contactPersons/{contactPersonId}

Отправка запросов с авторизацией OAuth2.0 v2 временно недоступна

contactPersonId

guid

Id контактного лица

CURL

Копировать

Пример ответа

Ответ

200 Удаление контактного лица пользователя

Развернуть все Свернуть все

4XX Ошибка запроса. Подробнее про ошибки API

Развернуть все Свернуть все

Пример

Модель

{...}

"error_code":"string",

"reason":"string"

}

{...}

error_code: string

Код ошибки

reason: string

Причина ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...