Skip to main content

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

GET 
/v5/orgs/:org_guid/outlets

Коды возможных ошибок:​

[500]: "InternalServerError" - внутренняя ошибка сервера [429]: "TooManyRequests" - превышено ограничение на количество запросов в секунду [401]: "Unauthorized" - для выполнения операции требуется авторизация [403]: "NoPermissions" - нет прав на выполнение этой операции [404]: "NotFound" - запрашиваемый объект или его родительский объект не найдены [422]: "RequestIsNotValid" - параметры запроса не прошли валидацию

Важная информация!​

Поиск по списку производится по полям: "name" и "address".

Request​

Path Parameters

    org_guid uuidrequired

    Уникальный идентификатор организации

Query Parameters

    created_from date-time

    Создание объекта произошло позже чем указанные дата и время (включая эти дату и время)

    created_to date-time

    Создание объекта произошло раньше чем указанные дата и время

    updated_from date-time

    Последнее изменение объекта произошло позже чем указанные дата и время (включая эти дату и время)

    updated_to date-time

    Последнее изменение объекта произошло раньше чем указанные дата и время

    query string

    Possible values: non-empty and <= 64 characters

    Поиск производится по полям: name, address, outlet_permissions, meta, metadata

    order_by OutletOrderings

    Possible values: [created_at_asc, created_at_desc, updated_at_asc, updated_at_desc, name_asc, name_desc]

    Вариант сортировки результатов запроса

    page_token string

    Токен (курсор, ссылка) запрашиваемой страницы результатов списка. Если он не задан, то возвращается первая страница результатов. Размер страницы списка регулируется сервером.

    selection SelectionModes

    Possible values: [alive_only, archived_only, all]

    Режим выборки объектов из списка

    presentation PresentationModes

    Possible values: [compact, full]

    Режим представления результатов запроса

Header Parameters

    Accept-Language stringrequired

    Язык используемый для ответов

    Example: ru-RU
    X-LP-Client-Identifier stringrequired

    Идентификатор клиента

    Example: 9787252f-0f46-4d44-a791-b92e4aaefafb
    X-LP-Client-Type stringrequired

    Possible values: [Unknown, App, WebApp, Service]

    Тип клиента

    Example: App
    X-LP-Client-Name string

    Имя клиента

    Example: Swagger
    X-LP-Client-OS-Name string

    ОС клиента

    Example: SwaggerDoc
    X-LP-Client-OS-Version string

    Версия ОС клиента

    Example: 1.0
    X-LP-Client-Screen-Resolution string

    Разрешение экрана ОС клиента

    Example: 1280x0900
    X-LP-Client-Model string

    Модель оборудования клиента

    Example: Chrome 75
    X-LP-Organization-Alias string

    Организация по умолчанию

    X-LP-Client-Extensions csv

    Поддерживаемые клиентом расширения моделей

Responses​

Success

Schema

    items

    object[]

    nullable

    Список лементов типа <typeparamref name="T" />

  • Array [

    • name stringrequired

    Possible values: >= 2 characters and <= 256 characters

    Наименование

    address stringrequired

    Possible values: >= 2 characters and <= 256 characters

    Физический адрес

    legal_entity

    object

    required

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    brand

    object

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    permissions

    object[]

    nullable

    Список разрешений на определенные операции в кассовом приложении для

    конкретных ролей

  • Array [

    • role

    object

    required

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    can_open_new_sale boolean

    Разрешено ли создавать новую продажу

    can_add_free_position_to_sale boolean

    Разрешено ли добавлять к продаже свободные позиции

    can_add_positions_from_catalog boolean

    Разрешено ли добавлять к продаже позиции из каталога

    can_add_positions_using_scanner boolean

    Разрешено ли добавлять к продаже позиции со сканера

    can_register_correction_receipt boolean

    Разрешено ли регистрировать чек коррекции

    default_preferred_input_method PreferredInputMethods (string)

    Possible values: [Catalog, CameraScanner, FreePosition]

    Предпочитаемый метод ввода позиции

    type_of stringnullable

    Тип объекта

  • ]

    • organization

    object

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    extensions

    OutletExtensions

    Расширения

    retail_app

    object

    Расширение LIFE POS Retail для торговой точки

    permissions

    object[]

    nullable

    Разрешения

  • Array [

    • role

    object

    required

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    can_open_new_sale boolean

    Разрешено ли создавать новую продажу

    can_add_free_position_to_sale boolean

    Разрешено ли добавлять к продаже свободные позиции

    can_add_positions_using_scanner boolean

    Разрешено ли добавлять к продаже позиции со сканера

    can_add_positions_from_catalog boolean

    Разрешено ли добавлять к продаже позиции из каталога

    can_register_correction_receipt boolean

    Разрешено ли регистрировать чек коррекции

    default_preferred_input_method RetailAppPreferredInputMethods (string)

    Possible values: [Catalog, Scanner, FreePosition]

    Методы ввода позиции в LIFE POS Retail

  • ]

    • mandatory_sales_filter_by_current_employee booleannullable

    Использовать обязательный фильтр продаж по текущему сотруднику

    mandatory_sales_filter_by_current_workplace booleannullable

    Использовать обязательный фильтр продаж по текущему рабочему месту

    mode RetailAppModes (string)

    Possible values: [Full, Lite]

    Перечисляет режимы работы приложения LIFE POS Retail.

    fiscalization_turned_on booleannullable

    Включено или нет выполнение фискальных команд

    fast_payment_acceptance_turned_on booleannullable
    mandatory_sync_after_payment_turned_on booleannullable

    Обязательная синхронизация после оплаты

    local_sales_report_turned_on booleannullable

    Отчет о локальных продажах

    check_marking_code_turned_on booleannullable

    Выполнять проверку товаров в Честном Знаке

    version stringrequired

    Possible values: non-empty and <= 8 characters

    Версия расширения

    lifepay_cloud_fiscalization

    object

    Расширение LIFE PAY ОФ для торговой точки

    turned_on boolean

    Default value: true

    Включена

    available_registrars

    object[]

    required

    Доступные фискальные регистраторы

  • Array [

    • id stringrequired

    Possible values: <= 32 characters

    Идентификатор

    friendly_name stringnullable

    Possible values: <= 32 characters

    Наименование

    environment LifePayCloudFiscalizationEnvironments (string)required

    Possible values: [production, test]

    Контуры LIFE PAY ОФ

    api_key stringrequired

    Possible values: >= 32 characters and <= 32 characters

    API-ключ

    target_kkt_group_uuid uuidnullable

    Идентификатор группы ККТ

  • ]

    • version stringrequired

    Possible values: non-empty and <= 8 characters

    Версия расширения

    external_discount_calculator

    object

    Расширение для настройки внешнего калькулятора

    usage_variant ExternalDiscountCalculatorUsageVariants (string)

    Possible values: [Internet, WiFi, SpecifiedWiFi]

    Варианты использования внешнего калькулятора скидок

    wifi_hotspot stringnullable

    Possible values: <= 64 characters

    Имя Wi-Fi сети

    url urirequired

    URL метода для расчета скидок

    timeout int32required

    Possible values: >= 100 and <= 60000

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

    turned_on booleanrequired

    Включен

    http_headers

    object

    nullable

    Заголовки HTTP

    property name* stringnullable
    version stringrequired

    Possible values: non-empty and <= 8 characters

    Версия расширения

    lifepay_quick_payments

    object

    ���������� LIFE PAY ��� ��� �������� �����

    available_quick_payments_terminal_settings

    object[]

    required

    ��������� ��������� ��� ����������

  • Array [

    • id stringrequired

    Possible values: <= 32 characters

    �������������

    environment LifePayQuickPaymentsEnvironments (string)required

    Possible values: [production, test]

    ����������� ��������� ������� (���������) ��������� ��� LIFE PAY ���.

    api_key stringrequired

    Possible values: >= 32 characters and <= 32 characters

    API-����

    friendly_name stringnullable

    Possible values: <= 32 characters

    ������������

  • ]

    • turned_on booleanrequired

    ��������

    version stringrequired

    Possible values: non-empty and <= 8 characters

    Версия расширения

    payment_methods

    object

    Расширение в котором хранится информация о том какие способы оплаты из поддерживаемых системой LIFE POS для

    каких ролей сотрудников должны быть доступны на конкретной торговой точке

    availabilities

    object[]

    nullable

    Настройки доступности способов оплаты

  • Array [

    • role

    object

    required

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    cash_payments_available boolean

    Наличные платежи доступны

    cashless_payments_available boolean

    Безналичные платежи доступны

    card_payments_available boolean

    Платежи по банковской карте доступны

    split_payments_available boolean

    Раздельные платежи доступны

    quick_payments_available boolean

    Платежи через СБП доступны

    bnpl_payments_available boolean

    Платежи через bnpl Подели доступны

  • ]

    • version stringrequired

    Possible values: non-empty and <= 8 characters

    Версия расширения

    ckt_soft_pos

    object

    Расширение, в котором хранятся настройки для работы с платежным решением SoftPOS от ЦКТ

    на рабочих местах привязанных к торговой точке для которой было задано это расширение.

    for_inn stringrequired

    Для юр. лица с ИНН

    juridical_name stringrequired

    Possible values: >= 2 characters and <= 256 characters

    Наименование юр. лица

    juridical_address stringrequired

    Possible values: >= 2 characters and <= 256 characters

    Адрес юр. лица

    operator_email emailrequired

    Possible values: >= 6 characters and <= 92 characters

    Email оператора

    mid stringrequired

    Possible values: non-empty and <= 24 characters

    Идентификатор мерчанта

    tids string[]required

    Идентификаторы терминалов

    host CktHost (string)

    Possible values: [alfa, vtb, open]

    Авторизационный хост

    app_package_name stringrequired

    Possible values: non-empty and <= 1024 characters

    Имя пакета Android приложения, которое должно вызываться по интенту при проведении транзакции

    device_vendor stringrequired

    Possible values: non-empty and <= 24 characters

    Вендор устройства, который используется как часть имени банковского терминала в разделе Оборудование кассовых приложений

    device_model stringrequired

    Possible values: non-empty and <= 24 characters

    Модель устройства, которая используется как часть имени банковского терминала в разделе Оборудование кассовых приложений

    version stringrequired

    Possible values: non-empty and <= 8 characters

    Версия расширения

    discounts

    object

    Расширение скидок торговой точки

    manual_discount_settings

    object

    nullable

    Настройки ручных скидок

    property name*

    DiscountSettings

    nullable

    Настройки скидок для торговой точки

    turned_on booleanrequired

    Признак включения ссылки

    max_value_percentage int32nullable

    Possible values: >= 1 and <= 99

    Максимальное значение скидки в процентах

    version stringrequired

    Possible values: non-empty and <= 8 characters

    Версия расширения

    bnpl_podeli

    object

    login stringrequired

    Possible values: <= 256 characters

    pass stringrequired

    Possible values: <= 256 characters

    turned_on boolean
    version stringrequired

    Possible values: non-empty and <= 8 characters

    Версия расширения

    lifepos_quick_payments

    object

    quick_payments_terminal_guid uuidrequired
    turned_on booleanrequired
    version stringrequired

    Possible values: non-empty and <= 8 characters

    Версия расширения

    created_at date-time

    Дата создания

    updated_at date-time

    Дата последнего обновления

    deleted_at date-timenullable

    Дата удаления (архивации)

    meta stringnullable

    Possible values: <= 128 characters

    Метаданные объекта (нарпимер, идентификатор в сторонней системе)

    meta_data

    object

    nullable

    Метаданные объекта в формате ключ-значение

    property name* string
    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

  • ]

    • next_page_token stringnullable

    Токен следующей страницы результатов списка

    page_number int32

    Номер текущей страницы. Если нумерация страниц не поддерживается, принимает значение -1 либо отсутствует. В остальных случаях принимает значения от 1 до total_pages включительно.

    pages_total int32

    общее кол-во страниц (>= 0)

    items_per_page int32

    кол-во элементов на странице (постоянное значение с сервера)

    items_total int32

    общее кол-во элементов списка

    type_of stringnullable

    Тип объекта

Loading...