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

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: fae7d436-3bf6-4b0a-86e5-4a2f0083f6e4

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

application/json

Schema
Example (from schema)

Schema

items

object[]

nullable

Array [

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

]

next_page_token stringnullable

page_number int32

pages_total int32

items_per_page int32

items_total int32

type_of stringnullable

{
  "items": [
    {
      "name": "string",
      "address": "string",
      "legal_entity": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "brand": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "permissions": [
        {
          "role": {
            "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "type_of": "string"
          },
          "can_open_new_sale": true,
          "can_add_free_position_to_sale": true,
          "can_add_positions_from_catalog": true,
          "can_add_positions_using_scanner": true,
          "can_register_correction_receipt": true,
          "default_preferred_input_method": "Catalog",
          "type_of": "string"
        }
      ],
      "organization": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "extensions": {
        "retail_app": {
          "permissions": [
            {
              "role": {
                "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "type_of": "string"
              },
              "can_open_new_sale": false,
              "can_add_free_position_to_sale": false,
              "can_add_positions_using_scanner": false,
              "can_add_positions_from_catalog": false,
              "can_register_correction_receipt": false,
              "default_preferred_input_method": "Catalog"
            }
          ],
          "mandatory_sales_filter_by_current_employee": true,
          "mandatory_sales_filter_by_current_workplace": true,
          "mode": "Full",
          "fiscalization_turned_on": true,
          "fast_payment_acceptance_turned_on": true,
          "mandatory_sync_after_payment_turned_on": true,
          "local_sales_report_turned_on": true,
          "version": "string"
        },
        "lifepay_cloud_fiscalization": {
          "turned_on": true,
          "available_registrars": [
            {
              "id": "string",
              "friendly_name": "string",
              "environment": "production",
              "api_key": "string",
              "target_kkt_group_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            }
          ],
          "version": "string"
        },
        "external_discount_calculator": {
          "usage_variant": "Internet",
          "wifi_hotspot": "string",
          "url": "string",
          "timeout": 0,
          "turned_on": true,
          "http_headers": {},
          "version": "string"
        },
        "lifepay_quick_payments": {
          "available_quick_payments_terminal_settings": [
            {
              "id": "string",
              "environment": "production",
              "api_key": "string",
              "friendly_name": "string"
            }
          ],
          "turned_on": true,
          "version": "string"
        },
        "payment_methods": {
          "availabilities": [
            {
              "role": {
                "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "type_of": "string"
              },
              "cash_payments_available": true,
              "cashless_payments_available": true,
              "card_payments_available": true,
              "split_payments_available": true,
              "quick_payments_available": true,
              "bnpl_payments_available": true
            }
          ],
          "version": "string"
        },
        "ckt_soft_pos": {
          "for_inn": "string",
          "juridical_name": "string",
          "juridical_address": "string",
          "operator_email": "user@example.com",
          "mid": "string",
          "tids": [
            "string"
          ],
          "host": "alfa",
          "app_package_name": "string",
          "device_vendor": "string",
          "device_model": "string",
          "version": "string"
        },
        "discounts": {
          "manual_discount_settings": {},
          "version": "string"
        },
        "bnpl_podeli": {
          "login": "string",
          "pass": "string",
          "turned_on": true,
          "version": "string"
        },
        "lifepos_quick_payments": {
          "quick_payments_terminal_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "turned_on": true,
          "version": "string"
        }
      },
      "created_at": "2024-08-06T11:29:10.945Z",
      "updated_at": "2024-08-06T11:29:10.945Z",
      "deleted_at": "2024-08-06T11:29:10.945Z",
      "meta": "string",
      "meta_data": {},
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type_of": "string"
    }
  ],
  "next_page_token": "string",
  "page_number": 0,
  "pages_total": 0,
  "items_per_page": 0,
  "items_total": 0,
  "type_of": "string"
}

Unauthorized

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

Possible values: [InternalServerError, TooManyRequests, RequestIsNotValid, BadRequest, NoPermissions, Unauthorized, NotFound, ReferenceNotFound, Duplicate, NotUnique, NotNullOrUnique, NotAllowed, NotAllowedForArchived, TryLater, OperationCannotBePerformed, NotificationsAreOutOfService, TrySendCodeLater, UsernameIsAlreadyTaken, PhoneIsNotFound, PhoneIsNotFoundInOrganization, PhoneIsAlreadyTaken, InvalidConfirmationCode, ConfirmationCodeWasCanceled, ConfirmationCodeWasNotSend, UsernameDoesNotExist, WrongUsernameOrPassword, WrongActivationCode, TryActivateLater, AliasIsNotFound, AliasIsAlreadyTaken, NotAllowedForOwner, DealPositionHasInvalidQuantity, CheckMarkingCodeMustBeDisabled, LegalEntityCrptTokenNotSpecified]

message stringnullable

info stringnullable

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Forbidden

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Not Found

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Client Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Too Many Requests

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

Server Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

info stringnullable

{
  "code": "InternalServerError",
  "message": "string",
  "info": "string"
}

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

/v5/orgs/:org_guid/outlets

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

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

Request​

Path Parameters

Query Parameters

Header Parameters

Responses​

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

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

Request

Responses