Skip to content
Мои токены Поддержка
Авторизоваться
Для подтверждения действия введите пароль
Чтобы продолжить, введите пароль для пользователя

Организации

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

Версия
Получение всех доступных организаций пользователя
get /v1.2/catalogs/organizations
Запрос
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Организации
Модель
[{...}]

Организация

id: guid

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

name: string

Название

ownership: int32

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

residency:
ONE-OF

(nullable)

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

(nullable)

all_departments_allowed: boolean

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

department_ids: [int32]

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

}]
Пример
[...]
{...}
"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":[...]
0
]
}
]
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Добавление организации
post /v1.2/catalogs/organizations
Запрос
Модель
{...}
name: string (nullable)

Название

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

(nullable)

address_ids: [guid]

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

contact_person_ids: [guid]

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

}
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"string","ownership":0,"all_departments_allowed":false,"department_ids":[0],"residency":0,"inn":"string","phone":"string","extra_phone":0,"docs_address":{"postcode":"string","city_id":0,"street_name":"string","house_no":"string","office_no":"string"},"address_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"],"contact_person_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"]}'
Ответ
200 Добавленная организация
Модель
{...}

Организация

id: guid

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

name: string

Название

ownership: int32

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

residency:
ONE-OF

(nullable)

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

(nullable)

all_departments_allowed: boolean

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

department_ids: [int32]

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

}
Пример
{...}
"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":[...]
0
]
}
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Получение организаций пользователя по подразделениям
post /v1.2/catalogs/organizations/filter
Запрос
Модель
{...}
departments: [int32]

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

}
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations/filter' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"departments":[0]}'
Ответ
200 Организации
Модель
[{...}]

Организация

id: guid

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

name: string

Название

ownership: int32

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

residency:
ONE-OF

(nullable)

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

(nullable)

all_departments_allowed: boolean

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

department_ids: [int32]

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

}]
Пример
[...]
{...}
"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":[...]
0
]
}
]
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Получение организации пользователя по id
get /v1.2/catalogs/organizations/{organizationId}
Запрос
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations/{organizationId}' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Организация
Модель
{...}

Организация

id: guid

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

name: string

Название

ownership: int32

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

residency:
ONE-OF

(nullable)

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

(nullable)

all_departments_allowed: boolean

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

department_ids: [int32]

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

}
Пример
{...}
"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":[...]
0
]
}
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Изменение организации
put /v1.2/catalogs/organizations/{organizationId}
Запрос
Модель
{...}
name: string (nullable)

Название

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

(nullable)

address_ids: [guid]

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

contact_person_ids: [guid]

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

}
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations/{organizationId}' \
-X 'PUT' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"string","ownership":0,"all_departments_allowed":false,"department_ids":[0],"residency":0,"inn":"string","phone":"string","extra_phone":0,"docs_address":{"postcode":"string","city_id":0,"street_name":"string","house_no":"string","office_no":"string"},"address_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"],"contact_person_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"]}'
Ответ
200 Измененная организация
Модель
{...}

Организация

id: guid

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

name: string

Название

ownership: int32

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

residency:
ONE-OF

(nullable)

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

(nullable)

all_departments_allowed: boolean

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

department_ids: [int32]

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

}
Пример
{...}
"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":[...]
0
]
}
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Удаление организации
delete /v1.2/catalogs/organizations/{organizationId}
Запрос
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations/{organizationId}' \
-X 'DELETE' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Успешное удаление организации
Модель
null
Пример
null
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}

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

Версия
Получение всех адресов пользователя
get /v1.2/catalogs/organizations/addresses
Запрос
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations/addresses' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Адреса
Модель
[{...}]

Адрес

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

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

address_latitude: double

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

address_longitude: double

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

note: string

Примечание

schedule_summary: string

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

address_type: enum
[1, 2, 3]

Тип адреса

  • 1 — Склад
  • 2 — Офис
  • 3 — Магазин
}]
Пример
[...]
{...}
"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
}
]
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Добавление адреса
post /v1.2/catalogs/organizations/addresses
Запрос
Модель
{...}
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 'https://api.ati.su/v1.2/catalogs/organizations/addresses' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"address":"string","address_city_id":0,"address_latitude":0.5,"address_longitude":0.5,"note":"string","schedule_summary":"string","address_type":0,"contact_person_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"]}'
Ответ
200 Добавленный адрес
Модель
{...}

Адрес

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

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

address_latitude: double

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

address_longitude: double

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

note: string

Примечание

schedule_summary: string

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

address_type: enum
[1, 2, 3]

Тип адреса

  • 1 — Склад
  • 2 — Офис
  • 3 — Магазин
}
Пример
{...}
"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
}
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Получение адреса пользователя по id
get /v1.2/catalogs/organizations/addresses/{addressId}
Запрос
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations/addresses/{addressId}' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Адрес
Модель
{...}

Адрес

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

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

address_latitude: double

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

address_longitude: double

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

note: string

Примечание

schedule_summary: string

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

address_type: enum
[1, 2, 3]

Тип адреса

  • 1 — Склад
  • 2 — Офис
  • 3 — Магазин
}
Пример
{...}
"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
}
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Изменение адреса
put /v1.2/catalogs/organizations/addresses/{addressId}
Запрос
Модель
{...}
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 'https://api.ati.su/v1.2/catalogs/organizations/addresses/{addressId}' \
-X 'PUT' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"address":"string","address_city_id":0,"address_latitude":0.5,"address_longitude":0.5,"note":"string","schedule_summary":"string","address_type":0,"contact_person_ids":["3fa85f64-5717-4562-b3fc-2c963f66afa6"]}'
Ответ
200 Измененный адрес
Модель
{...}

Адрес

id: guid

ID адреса

address: string

Адрес

address_city_id: int32

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

address_latitude: double

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

address_longitude: double

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

note: string

Примечание

schedule_summary: string

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

address_type: enum
[1, 2, 3]

Тип адреса

  • 1 — Склад
  • 2 — Офис
  • 3 — Магазин
}
Пример
{...}
"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
}
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Удаление адреса
delete /v1.2/catalogs/organizations/addresses/{addressId}
Запрос
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations/addresses/{addressId}' \
-X 'DELETE' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Удаление адреса
Модель
null
Пример
null
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Получение типов адресов
get /v1.2/catalogs/organizations/addresses/types
Запрос
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations/addresses/types' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Типы адресов
Модель
[{...}]
id: enum
[1, 2, 3]

Тип адреса

  • 1 — Склад
  • 2 — Офис
  • 3 — Магазин
name: string
name_eng: string
}]
Пример
[...]
{...}
"id":0,
"name":"string",
"name_eng":"string"
}
]
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}

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

Версия
Получение всех контактных лиц пользователя
get /v1.2/catalogs/organizations/contactPersons
Запрос
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations/contactPersons' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Контактные лица
Модель
[{...}]

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

id: guid

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

name: string

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

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

email: string

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

}]
Пример
[...]
{...}
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name":"string",
"phone":"string",
"extra_phone":0,
"email":"string"
}
]
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Добавление контактного лица пользователя
post /v1.2/catalogs/organizations/contactPersons
Запрос
Модель
{...}
name: string (nullable)

ФИО

phone: string (nullable)

Телефон

extra_phone: int32 (nullable)

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

email: string (nullable)

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

}
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations/contactPersons' \
-X 'POST' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"string","phone":"string","extra_phone":0,"email":"string"}'
Ответ
200 Добавленное контактное лицо
Модель
{...}

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

id: guid

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

name: string

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

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

email: string

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

}
Пример
{...}
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name":"string",
"phone":"string",
"extra_phone":0,
"email":"string"
}
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Получение контактного лица пользователя по id
get /v1.2/catalogs/organizations/contactPersons/{contactPersonId}
Запрос
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations/contactPersons/{contactPersonId}' \
-X 'GET' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Контактное лицо
Модель
{...}

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

id: guid

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

name: string

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

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

email: string

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

}
Пример
{...}
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name":"string",
"phone":"string",
"extra_phone":0,
"email":"string"
}
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Изменение контактного лица пользователя
put /v1.2/catalogs/organizations/contactPersons/{contactPersonId}
Запрос
Модель
{...}
name: string (nullable)

ФИО

phone: string (nullable)

Телефон

extra_phone: int32 (nullable)

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

email: string (nullable)

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

}
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations/contactPersons/{contactPersonId}' \
-X 'PUT' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"string","phone":"string","extra_phone":0,"email":"string"}'
Ответ
200 Измененное контактное лицо
Модель
{...}

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

id: guid

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

name: string

ФИО

phone: string

Телефон

extra_phone: int32 (nullable)

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

email: string

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

}
Пример
{...}
"id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name":"string",
"phone":"string",
"extra_phone":0,
"email":"string"
}
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}
Версия
Удаление контактного лица пользователя
delete /v1.2/catalogs/organizations/contactPersons/{contactPersonId}
Запрос
Пример запроса
curl 'https://api.ati.su/v1.2/catalogs/organizations/contactPersons/{contactPersonId}' \
-X 'DELETE' \
-H 'Authorization: Bearer {authorizationToken}' \
-H 'Content-Type: application/json'
Ответ
200 Удаление контактного лица пользователя
Модель
null
Пример
null
4XX Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)
Модель
{...}
error_code: string

Код ошибки

reason: string

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

}
Пример
{...}
"error_code":"string",
"reason":"string"
}