GetSaleById

GET /orgs/:org_guid/deals/sales/:deal_guid

GetSaleById

Request

Path Parameters

org_guid uuidrequired

deal_guid uuidrequired

Query Parameters

presentation PresentationModes

Possible values: [compact, full]

Header Parameters

X-LP-Client-Identifier stringrequired

ClientIdentifier

Example: da07a92b-d540-41a4-b697-b21456abcb96

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

Success

application/json

Schema
Example (from schema)
Example

Schema

outlet

object

required

guid uuid

guid

type_of string

type_of

workplace

object

guid uuid

guid

type_of string

type_of

opened_by

object

required

guid uuid

guid

type_of string

type_of

opened_at date-timerequired

opened_at

number stringrequired

Possible values: non-empty and <= 36 characters

number

comment stringnullable

Possible values: <= 512 characters

comment

state DealStates (string)

Possible values: [New, InProgress, Completed, Cancelled]

payment_status DealPaymentStatus (string)

Possible values: [NotPaid, Paid, PartiallyPaid, Refunded, PartiallyRefunded]

shipping_status DealShippingStatus (string)

Possible values: [NotShipped, Shipped, PartiallyShipped, Returned, PartiallyReturned]

total_sum

object

required

value int64

value

currency CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

type_of string

type_of

positions

object[]

nullable

positions

Array [

settlement_subject SettlementSubjects (string)required

Possible values: [Product, ExciseProduct, Work, Service, GamblingBet, GamblingWinning, LotteryBet, LotteryWinning, IntellectualProperty, Payment, AgentFee, Payout, Other, PropertyRights, NonRealizationIncome, OtherPayments, TradeFee, ResortFee, Bail, Outflow, ContributionForOPSIP, ContributionForOPS, ContributionForOMSIP, ContributionForOMS, ContributionForOSS, CasinoPayment, Cashout, ATNM, ATM, TNM, TM]

name stringrequired

Possible values: non-empty and <= 128 characters

name

uom

object

required

guid uuid

guid

type_of string

type_of

tax ValueAddedTaxRates (string)required

Possible values: [Tax20, Tax10, Tax0, TaxFree]

sale_price

object

required

value int64

value

currency CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

type_of string

type_of

quantity doublerequired

quantity

made_in CountryCodes (string)

Possible values: [AFG, ALB, ATA, DZA, ASM, AND, AGO, ATG, AZE, ARG, AUS, AUT, BHS, BHR, BGD, ARM, BRB, BEL, BMU, BTN, BOL, BIH, BWA, BVT, BRA, BLZ, IOT, SLB, VGB, BRN, BGR, MMR, BDI, BLR, KHM, CMR, CAN, CPV, CYM, CAF, LKA, TCD, CHL, CHN, TWN, CXR, CCK, COL, COM, MYT, COG, COD, COK, CRI, HRV, CUB, CYP, CZE, BEN, DNK, DMA, DOM, ECU, SLV, GNQ, ETH, ERI, EST, FRO, FLK, SGS, FJI, FIN, ALA, FRA, GUF, PYF, ATF, DJI, GAB, GEO, GMB, PSE, DEU, GHA, GIB, KIR, GRC, GRL, GRD, GLP, GUM, GTM, GIN, GUY, HTI, HMD, VAT, HND, HKG, HUN, ISL, IND, IDN, IRN, IRQ, IRL, ISR, ITA, CIV, JAM, JPN, KAZ, JOR, KEN, PRK, KOR, KWT, KGZ, LAO, LBN, LSO, LVA, LBR, LBY, LIE, LTU, LUX, MAC, MDG, MWI, MYS, MDV, MLI, MLT, MTQ, MRT, MUS, MEX, MCO, MNG, MDA, MNE, MSR, MAR, MOZ, OMN, NAM, NRU, NPL, NLD, CUW, ABW, SXM, BES, NCL, VUT, NZL, NIC, NER, NGA, NIU, NFK, NOR, MNP, UMI, FSM, MHL, PLW, PAK, PAN, PNG, PRY, PER, PHL, PCN, POL, PRT, GNB, TLS, PRI, QAT, REU, ROU, RUS, RWA, BLM, SHN, KNA, AIA, LCA, MAF, SPM, VCT, SMR, STP, SAU, SEN, SRB, SYC, SLE, SGP, SVK, VNM, SVN, SOM, ZAF, ZWE, ESP, SSD, SDN, ESH, SUR, SJM, SWZ, SWE, CHE, SYR, TJK, THA, TGO, TKL, TON, TTO, ARE, TUN, TUR, TKM, TCA, TUV, UGA, UKR, MKD, EGY, GBR, GGY, JEY, IMN, TZA, USA, VIR, BFA, URY, UZB, VEN, WLF, WSM, YEM, ZMB]

total_sum

object

required

value int64

value

currency CurrencyCodes (string)required

Possible values: [RUB, GBP, USD, EUR, Unknown]

type_of string

type_of

barcode stringnullable

barcode (*Required when is_markable=true)

is_markable boolean

is_markable

marking_attributes

object

is_part_of_package_of int32nullable

Possible values: >= 2 and <= 99999999

is_part_of_package_of

marks

object[]

required

Possible values: >= 1

marks

Array [

marking_code stringnullable

Possible values: <= 256 characters

marking_code

checking_result FEGoodDataCheckingResult (string)[]nullable

Possible values: [KMChecked, KPKMCorrect, OISMStatusChecked, OISMStatusCorrect, KPKMCheckedAutonomously]

checking_result

for_quantity doublerequired

for_quantity

]

additional_attributes

object

as_agent_type_of FEAgentTypes (string)

Possible values: [BankPayingAgent, BankPayingSubagent, PayingAgent, PayingSubagent, Attorney, Consignee, Agent]

transfer_operator_name stringnullable

Possible values: <= 64 characters

transfer_operator_name

transfer_operator_phones string[]nullable

transfer_operator_phones

transfer_operator_address stringnullable

Possible values: <= 256 characters

transfer_operator_address

transfer_operator_inn stringnullable

transfer_operator_inn

paying_agent_operation stringnullable

Possible values: <= 24 characters

paying_agent_operation

paying_agent_phones string[]nullable

paying_agent_phones

payment_operator_phones string[]nullable

payment_operator_phones

supplier_name stringnullable

Possible values: <= 256 characters

supplier_name

supplier_inn stringnullable

supplier_inn

supplier_phones string[]nullable

supplier_phones

declaration_number stringnullable

Possible values: <= 32 characters

declaration_number

excise_fee int32nullable

excise_fee

meta stringnullable

Possible values: <= 128 characters

meta

meta_data

object

nullable

meta_data

property name* string

guid uuid

guid

type_of string

type_of

{
  "outlet": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "workplace": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "opened_by": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "opened_at": "2024-11-18T08:30:48.174Z",
  "number": "string",
  "comment": "string",
  "state": "New",
  "payment_status": "NotPaid",
  "shipping_status": "NotShipped",
  "total_sum": {
    "value": 0,
    "currency": "RUB",
    "type_of": "string"
  },
  "positions": [
    {
      "settlement_subject": "Product",
      "name": "string",
      "uom": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type_of": "string"
      },
      "tax": "Tax20",
      "sale_price": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "quantity": 0,
      "made_in": "AFG",
      "total_sum": {
        "value": 0,
        "currency": "RUB",
        "type_of": "string"
      },
      "barcode": "string",
      "is_markable": true,
      "marking_attributes": {
        "is_part_of_package_of": 0,
        "marks": [
          {
            "marking_code": "string",
            "checking_result": [
              "KMChecked"
            ],
            "for_quantity": 0
          }
        ]
      },
      "additional_attributes": {
        "as_agent_type_of": "BankPayingAgent",
        "transfer_operator_name": "string",
        "transfer_operator_phones": [
          "string"
        ],
        "transfer_operator_address": "string",
        "transfer_operator_inn": "string",
        "paying_agent_operation": "string",
        "paying_agent_phones": [
          "string"
        ],
        "payment_operator_phones": [
          "string"
        ],
        "supplier_name": "string",
        "supplier_inn": "string",
        "supplier_phones": [
          "string"
        ],
        "declaration_number": "string",
        "excise_fee": 0
      },
      "meta": "string",
      "meta_data": {},
      "type_of": "string"
    }
  ],
  "customer_data": {
    "name": "string",
    "inn": "string",
    "contacts": "string",
    "citizenship": "AFG",
    "identity_document_type": "RFPassport",
    "identity_document_data": "string",
    "date_of_birth": "2024-11-18T08:30:48.175Z",
    "address": "string"
  },
  "additional_attributes": {
    "settlement_location": "string",
    "printable_header": [
      "string"
    ],
    "printable_footer": [
      "string"
    ]
  },
  "organization": {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type_of": "string"
  },
  "extensions": {
    "retail_app": {
      "deal_permissions": [
        {
          "role": {
            "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "type_of": "string"
          },
          "can_edit_comment": false,
          "can_edit_customer_name": false,
          "can_edit_customer_contacts": false,
          "can_edit_customer_inn": false,
          "can_add_offer_position": false,
          "can_add_free_position": false,
          "can_delete": false,
          "can_refund": false,
          "can_cancel": false
        }
      ],
      "deal_position_permissions": [
        {
          "position": {
            "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "type_of": "string"
          },
          "role": {
            "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "type_of": "string"
          },
          "can_edit_name": false,
          "can_edit_good_type": false,
          "can_edit_uom": false,
          "can_edit_quantity": false,
          "can_edit_tax": false,
          "can_edit_sale_price": false,
          "can_delete": false,
          "allowed_max_quantity": 0,
          "allowed_min_quantity": 0,
          "allowed_max_sale_price": {
            "value": 0,
            "currency": "RUB",
            "type_of": "string"
          },
          "allowed_min_sale_price": {
            "value": 0,
            "currency": "RUB",
            "type_of": "string"
          }
        }
      ],
      "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"
    },
    "payment_recipients": {
      "payment_recipient_inn": "string",
      "agent_inn": "string",
      "version": "string"
    },
    "discounts": {
      "deal_position_discounts": [
        {
          "deal_position_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "sale_price_discount": {
            "type": "Absolute",
            "amount": 0
          },
          "original_sale_price_value": 0
        }
      ],
      "sale_discount_percentage": 0,
      "version": "string"
    }
  },
  "created_at": "2024-11-18T08:30:48.175Z",
  "updated_at": "2024-11-18T08:30:48.175Z",
  "deleted_at": "2024-11-18T08:30:48.175Z",
  "meta": "string",
  "meta_data": {},
  "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type_of": "string"
}

{
  "outlet": {
    "guid": "00000000-0000-0000-0000-000000000000",
    "type_of": "Outlet"
  },
  "opened_by": {
    "guid": "00000000-0000-0000-0000-000000000000",
    "type_of": "Employee"
  },
  "opened_at": "2024-11-18T08:30:37.4769013Z",
  "state": "New",
  "payment_status": "NotPaid",
  "shipping_status": "NotShipped",
  "total_sum": {
    "value": 10000,
    "currency": "RUB",
    "type_of": "Money"
  },
  "positions": [
    {
      "settlement_subject": 0,
      "name": "Конфеты",
      "tax": "Tax20",
      "sale_price": {
        "value": 1000,
        "currency": "RUB",
        "type_of": "Money"
      },
      "quantity": 5,
      "total_sum": {
        "value": 5000,
        "currency": "RUB",
        "type_of": "Money"
      },
      "is_markable": false,
      "guid": "00000000-0000-0000-0000-000000000000",
      "type_of": "DealPosition"
    }
  ],
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "0001-01-01T00:00:00Z",
  "guid": "6cd31676-ce64-4a25-a499-471d0edcc7d4",
  "type_of": "Sale"
}

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

message

info stringnullable

info

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

Forbidden

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

Not Found

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

Client Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

Too Many Requests

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

Server Error

application/json

Schema
Example (from schema)

Schema

code ErrorCodes (string)

message stringnullable

message

info stringnullable

info

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

GetSaleById

/orgs/:org_guid/deals/sales/:deal_guid

Request​

Path Parameters

Query Parameters

Header Parameters

Responses​

Request

Responses