List
GET/orgs/:org_guid/deals/sales
List
Request
Path Parameters
Уникальный идентификатор организации
Query Parameters
Possible values: [compact
, full
]
Параметры представления результатов
Possible values: [created_at_asc
, created_at_desc
, updated_at_asc
, updated_at_desc
, opened_at_asc
, opened_at_desc
, number_asc
, number_desc
]
Possible values: non-empty
and <= 64 characters
Поиск производится по полям: number, comment, custom_properties, deal_permissions, meta, metadata
Possible values: [alive_only
, archived_only
, all
]
Possible values: [New
, InProgress
, Completed
, Cancelled
]
Possible values: [NotPaid
, Paid
, PartiallyPaid
, Refunded
, PartiallyRefunded
]
Possible values: [NotShipped
, Shipped
, PartiallyShipped
, Returned
, PartiallyReturned
]
Header Parameters
Идентификатор клиента
Possible values: [Unknown
, App
, WebApp
, Service
]
Тип клиента
Имя клиента
ОС клиента
Версия ОС клиента
Разрешение экрана ОС клиента
Модель оборудования клиента
Организация по умолчанию
Поддерживаемые клиентом расширения моделей
Язык используемый для ответов
Responses
- 200
- 401
- 403
- 404
- 422
- 429
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
]
items
object[]
nullable
items
outlet
object
required
guid
type_of
workplace
object
guid
type_of
opened_by
object
required
guid
type_of
opened_at
Possible values: non-empty
and <= 36 characters
number
Possible values: <= 512 characters
comment
Possible values: [New
, InProgress
, Completed
, Cancelled
]
Possible values: [NotPaid
, Paid
, PartiallyPaid
, Refunded
, PartiallyRefunded
]
Possible values: [NotShipped
, Shipped
, PartiallyShipped
, Returned
, PartiallyReturned
]
total_sum
object
required
value
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
type_of
positions
object[]
nullable
positions
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
]
Possible values: non-empty
and <= 128 characters
name
uom
object
required
guid
type_of
Possible values: [Tax20
, Tax10
, Tax0
, TaxFree
]
sale_price
object
required
value
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
type_of
quantity
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
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
type_of
barcode (*Required when is_markable=true
)
is_markable
marking_attributes
object
Possible values: >= 2
and <= 99999999
is_part_of_package_of
marks
object[]
required
Possible values: >= 1
marks
Possible values: <= 256 characters
marking_code
Possible values: [KMChecked
, KPKMCorrect
, OISMStatusChecked
, OISMStatusCorrect
, KPKMCheckedAutonomously
]
checking_result
for_quantity
additional_attributes
object
Possible values: [BankPayingAgent
, BankPayingSubagent
, PayingAgent
, PayingSubagent
, Attorney
, Consignee
, Agent
]
Possible values: <= 64 characters
transfer_operator_name
transfer_operator_phones
Possible values: <= 256 characters
transfer_operator_address
transfer_operator_inn
Possible values: <= 24 characters
paying_agent_operation
paying_agent_phones
payment_operator_phones
Possible values: <= 256 characters
supplier_name
supplier_inn
supplier_phones
Possible values: <= 32 characters
declaration_number
excise_fee
Possible values: <= 128 characters
meta
meta_data
object
nullable
meta_data
type_of
customer_data
object
Possible values: <= 256 characters
name
inn
Possible values: <= 64 characters
contacts
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
]
Possible values: [RFPassport
, RFSpecialPassport
, RFTemporaryIdentity
, RFBirthCertificate
, RFOtherDocuments
, ForeignPassport
, ForeignOtherDocuments
, ForeignIdentity
, ForeignResidence
, ForeignTemporaryResidence
, RefugeeApplication
, RefugeeIdentity
, RefugeeOtherDocuments
, ForeignTemporaryIdentity
]
Possible values: <= 64 characters
identity_document_data
date_of_birth
Possible values: <= 256 characters
address
additional_attributes
object
Possible values: <= 256 characters
settlement_location
printable_header
printable_footer
organization
object
guid
type_of
extensions
SaleExtensions
Расширения
retail_app
object
deal_permissions
object[]
nullable
deal_permissions
role
object
required
guid
type_of
can_edit_comment
can_edit_customer_name
can_edit_customer_contacts
can_edit_customer_inn
can_add_offer_position
can_add_free_position
can_delete
can_refund
can_cancel
deal_position_permissions
object[]
nullable
deal_position_permissions
position
object
required
guid
type_of
role
object
required
guid
type_of
can_edit_name
can_edit_good_type
can_edit_uom
can_edit_quantity
can_edit_tax
can_edit_sale_price
can_delete
Possible values: <= 10000000
allowed_max_quantity
Possible values: <= 10000000
allowed_min_quantity
allowed_max_sale_price
object
value
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
type_of
allowed_min_sale_price
object
value
Possible values: [RUB
, GBP
, USD
, EUR
, Unknown
]
type_of
Possible values: non-empty
and <= 8 characters
version
payment_methods
object
availabilities
object[]
nullable
availabilities
role
object
required
guid
type_of
cash_payments_available
cashless_payments_available
card_payments_available
split_payments_available
quick_payments_available
bnpl_payments_available
Possible values: non-empty
and <= 8 characters
version
payment_recipients
object
Possible values: non-empty
payment_recipient_inn
agent_inn
Possible values: non-empty
and <= 8 characters
version
discounts
object
deal_position_discounts
object[]
nullable
deal_position_discounts
deal_position_guid
sale_price_discount
object
Possible values: [Absolute
, Percentage
]
amount
original_sale_price_value
sale_discount_percentage
Possible values: non-empty
and <= 8 characters
version
created_at
updated_at
deleted_at
Possible values: <= 128 characters
meta
meta_data
object
nullable
meta_data
guid
type_of
next_page_token
page_number
pages_total
items_per_page
items_total
type_of
{
"items": [
{
"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-08-06T11:29:24.822Z",
"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-08-06T11:29:24.824Z",
"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
}
],
"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-08-06T11:29:24.825Z",
"updated_at": "2024-08-06T11:29:24.825Z",
"deleted_at": "2024-08-06T11:29:24.825Z",
"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
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
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
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
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
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
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Client Error
- application/json
- Schema
- Example (from schema)
Schema
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
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
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
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}
Server Error
- application/json
- Schema
- Example (from schema)
Schema
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
info
{
"code": "InternalServerError",
"message": "string",
"info": "string"
}