Skip to main content

Получить данные торговой точки

GET 

/v5/orgs/:org_guid/outlets/:outlet_guid

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

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

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

Если указанный объект удален (помещен в архив) данный метод всё равно вернет данные по нему.

Request

Path Parameters

    org_guid uuidrequired

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

    outlet_guid uuidrequired

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

Query Parameters

    presentation PresentationModes

    Possible values: [compact, full]

Header Parameters

    Accept-Language stringrequired

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

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

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

    Example: 16425d0e-1e51-4c6b-a40f-38efaaf25cbe
    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

    name stringrequired

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

    address stringrequired

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

    legal_entity

    object

    required

    guid uuid
    type_of stringnullable

    brand

    object

    guid uuid
    type_of stringnullable

    permissions

    object[]

    nullable

  • Array [

  • role

    object

    required

    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

    guid uuid
    type_of stringnullable

    extensions

    OutletExtensions

    Расширения

    retail_app

    object

    permissions

    object[]

    nullable

  • Array [

  • role

    object

    required

    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]

  • ]

  • mandatory_sales_filter_by_current_employee booleannullable
    mandatory_sales_filter_by_current_workplace booleannullable
    mode RetailAppModes (string)

    Possible values: [Full, Lite]

    fiscalization_turned_on booleannullable
    fast_payment_acceptance_turned_on booleannullable
    mandatory_sync_after_payment_turned_on booleannullable
    local_sales_report_turned_on booleannullable
    version stringrequired

    Possible values: non-empty and <= 8 characters

    lifepay_cloud_fiscalization

    object

    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]

    api_key stringrequired

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

    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

    url urirequired
    timeout int32required

    Possible values: >= 100 and <= 60000

    turned_on booleanrequired

    http_headers

    object

    nullable

    property name* stringnullable
    version stringrequired

    Possible values: non-empty and <= 8 characters

    lifepay_quick_payments

    object

    available_quick_payments_terminal_settings

    object[]

    required

  • Array [

  • id stringrequired

    Possible values: <= 32 characters

    environment LifePayQuickPaymentsEnvironments (string)required

    Possible values: [production, test]

    api_key stringrequired

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

    friendly_name stringnullable

    Possible values: <= 32 characters

  • ]

  • turned_on booleanrequired
    version stringrequired

    Possible values: non-empty and <= 8 characters

    payment_methods

    object

    availabilities

    object[]

    nullable

  • Array [

  • role

    object

    required

    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
  • ]

  • version stringrequired

    Possible values: non-empty and <= 8 characters

    ckt_soft_pos

    object

    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

    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

    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
Loading...