GetOutletById

GET 
/orgs/:org_guid/outlets/:outlet_guid

GetOutletById

Request

Path Parameters

org_guid uuidrequired
outlet_guid uuidrequired

Query Parameters

presentation PresentationModes

Possible values: [compact, full]

Header Parameters

X-LP-Client-Identifier stringrequired
ClientIdentifier
Example: 581eca71-b644-40d2-be78-8f5dc17e5b1c
X-LP-Client-Type stringrequired
Possible values: [Unknown, App, WebApp, Service]
ClientType
Example: App
X-LP-Client-Name string
ClientName
Example: Swagger
X-LP-Client-OS-Name string
ClientOSName
Example: SwaggerDoc
X-LP-Client-OS-Version string
ClientOSVersion
Example: 1.0
X-LP-Client-Screen-Resolution string
ClientScreenResolution
Example: 1280x0900
X-LP-Client-Model string
ClientModel
Example: Chrome 75
X-LP-Organization-Alias string

OrganizationAlias

X-LP-Client-Extensions csv

ClientExtensions

Accept-Language stringrequired
Language
Example: en-US

Responses

200

Success

application/json

Schema

Schema

name stringrequired

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

name

address stringrequired

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

address

legal_entity

object

required

guid uuid

guid

type_of string

type_of

brand

object

guid uuid

guid

type_of string

type_of

organization

object

guid uuid

guid

type_of string

type_of

extensions

OutletExtensions

Расширения

retail_app

object

permissions

object[]

nullable

permissions

Array [

role

object

required

guid uuid

guid

type_of string

type_of

can_open_new_sale boolean

can_open_new_sale

can_add_free_position_to_sale boolean

can_add_free_position_to_sale

can_add_positions_using_scanner boolean

can_add_positions_using_scanner

can_add_positions_from_catalog boolean

can_add_positions_from_catalog

can_register_correction_receipt boolean

can_register_correction_receipt

can_refund_sales boolean

Default value: true

can_refund_sales

can_print_slip_copy boolean

can_print_slip_copy

can_print_receipt_copy boolean

can_print_receipt_copy

default_preferred_input_method RetailAppPreferredInputMethods (string)

Possible values: [Catalog, Scanner, FreePosition]

]

mandatory_sales_filter_by_current_employee booleannullable

mandatory_sales_filter_by_current_employee

mandatory_sales_filter_by_current_workplace booleannullable

mandatory_sales_filter_by_current_workplace

mode RetailAppModes (string)

Possible values: [Full, Lite]

fiscalization_turned_on booleannullable

fiscalization_turned_on

fast_payment_acceptance_turned_on booleannullable

fast_payment_acceptance_turned_on

mandatory_sync_after_payment_turned_on booleannullable

mandatory_sync_after_payment_turned_on

local_sales_report_turned_on booleannullable

local_sales_report_turned_on

check_marking_code_turned_on booleannullable

check_marking_code_turned_on

version stringrequired

Possible values: non-empty and <= 8 characters

version

settlement_methods

object

is_full_prepayment_available boolean

is_full_prepayment_available

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepay_cloud_fiscalization

object

turned_on boolean

Default value: true

turned_on

available_registrars

object[]

required

available_registrars

Array [

id stringrequired

Possible values: non-empty and <= 32 characters

id

friendly_name stringnullable

Possible values: <= 32 characters

friendly_name

environment LifePayCloudFiscalizationEnvironments (string)required

Possible values: [production, test]

api_key stringrequired

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

api_key

target_kkt_group_uuid uuidnullable

target_kkt_group_uuid

]

version stringrequired

Possible values: non-empty and <= 8 characters

version

external_discount_calculator

object

usage_variant ExternalDiscountCalculatorUsageVariants (string)

Possible values: [Internet, WiFi, SpecifiedWiFi]

wifi_hotspot stringnullable

Possible values: <= 64 characters

wifi_hotspot

url urirequired

Possible values: non-empty

url

timeout int32required

Possible values: >= 100 and <= 60000

timeout

turned_on booleanrequired

turned_on

http_headers

object

nullable

http_headers

property name* stringnullable

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepay_quick_payments

object

available_quick_payments_terminal_settings

object[]

required

available_quick_payments_terminal_settings

Array [

id stringrequired

Possible values: non-empty and <= 32 characters

id

environment LifePayQuickPaymentsEnvironments (string)required

Possible values: [production, test]

api_key stringrequired

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

api_key

friendly_name stringnullable

Possible values: <= 32 characters

friendly_name

]

turned_on booleanrequired

turned_on

version stringrequired

Possible values: non-empty and <= 8 characters

version

payment_methods

object

availabilities

object[]

nullable

availabilities

Array [

role

object

required

guid uuid

guid

type_of string

type_of

cash_payments_available boolean

cash_payments_available

cashless_payments_available boolean

cashless_payments_available

card_payments_available boolean

card_payments_available

split_payments_available boolean

split_payments_available

quick_payments_available boolean

quick_payments_available

bnpl_payments_available boolean

bnpl_payments_available

split_payments_available_methods

object

cash_payments_available boolean

cash_payments_available

cashless_payments_available boolean

cashless_payments_available

card_payments_available boolean

card_payments_available

quick_payments_available boolean

quick_payments_available

]

version stringrequired

Possible values: non-empty and <= 8 characters

version

ckt_soft_pos

object

for_inn stringrequired

Possible values: non-empty

for_inn

juridical_name stringrequired

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

juridical_name

juridical_address stringrequired

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

juridical_address

operator_email emailrequired

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

operator_email

mid stringrequired

Possible values: non-empty and <= 24 characters

mid

tids string[]required

tids

host CktHost (string)

Possible values: [alfa, vtb, open]

app_package_name stringrequired

Possible values: non-empty and <= 1024 characters

app_package_name

device_vendor stringrequired

Possible values: non-empty and <= 24 characters

device_vendor

device_model stringrequired

Possible values: non-empty and <= 24 characters

device_model

version stringrequired

Possible values: non-empty and <= 8 characters

version

discounts

object

manual_discount_settings

object

manual_discount_settings

property name*

DiscountSettings

turned_on booleanrequired

turned_on

max_value_percentage int32nullable

Possible values: >= 1 and <= 99

max_value_percentage

version stringrequired

Possible values: non-empty and <= 8 characters

version

bnpl_podeli

object

login stringrequired

Possible values: non-empty and <= 256 characters

login

pass stringrequired

Possible values: non-empty and <= 256 characters

pass

turned_on boolean

turned_on

version stringrequired

Possible values: non-empty and <= 8 characters

version

lifepos_quick_payments

object

quick_payments_terminal_guid uuidrequired

quick_payments_terminal_guid

turned_on booleanrequired

turned_on

version stringrequired

Possible values: non-empty and <= 8 characters

version

online_type PTOnlineType (string)

Possible values: [Offline, Online]

created_at date-time

created_at

updated_at date-time

updated_at

deleted_at date-timenullable

deleted_at

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string
guid uuid

guid

type_of string

type_of

Example (from schema)

{
  "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"
  },
  "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,
          "can_refund_sales": true,
          "can_print_slip_copy": false,
          "can_print_receipt_copy": 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,
      "check_marking_code_turned_on": true,
      "version": "string"
    },
    "settlement_methods": {
      "is_full_prepayment_available": 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,
          "split_payments_available_methods": {
            "cash_payments_available": true,
            "cashless_payments_available": true,
            "card_payments_available": true,
            "quick_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"
    }
  },
  "online_type": "Offline",
  "created_at": "2024-11-18T08:30:47.176Z",
  "updated_at": "2024-11-18T08:30:47.176Z",
  "deleted_at": "2024-11-18T08:30:47.176Z",
  "meta": "string",
  "meta_data": {},
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type_of": "string"
}

Example

{
  "name": "Планета обуви",
  "address": "ул. пушкина, д. 1",
  "legal_entity": {
    "guid": "00000000-0000-0000-0000-000000000000",
    "type_of": "LegalEntity"
  },
  "online_type": "Offline",
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "0001-01-01T00:00:00Z",
  "guid": "54fcf664-a2ed-43ad-9abf-4b45bde9e387",
  "type_of": "Outlet"
}

401

Unauthorized

application/json

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

message

info stringnullable

info

Example (from schema)

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

403

Forbidden

application/json

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

message

info stringnullable

info

Example (from schema)

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

404

Not Found

application/json

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

message

info stringnullable

info

Example (from schema)

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

422

Client Error

application/json

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

message

info stringnullable

info

Example (from schema)

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

429

Too Many Requests

application/json

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

message

info stringnullable

info

Example (from schema)

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

500

Server Error

application/json

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

message

info stringnullable

info

Example (from schema)

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

Loading...