1. Saby
  2. База знаний
  3. API
  4. API Saby Retail
  5. Получить данные о продажах

Получить данные о продажах по API

Получить данные о продажах по API

Метод возвращает информацию о продажах.

Выполните сервисную авторизацию и в заголовке передайте полученный токен.

Структура запроса

Метод запроса: GET

Адрес запроса: https://api.sbis.ru/retail/order/list?

Параметр
* — обязательный
ТипОписание

pointId

integer

идентификатор точки продаж

fromDateTime*

string
YYYY-MM-DD hh:mm:ss

дата начала выборки

toDateTime

string
YYYY-MM-DD hh:mm:ss

дата окончания выборки

page

integer

номер страницы

pageSize

integer

количество записей на странице. Максимальное возможное значение — 100. Если параметр не передан, вернется 30 записей

needDiscountInfo

boolean

признак для получения информации о скидках на продажу. Возможные значения: true — в ответе возвращаются сведения о скидке, примененной на продаже, false — по умолчанию

Результат

ПараметрТипОписание

orders

array[{...}]

список продаж

 

ClosedWTZ

string

дата закрытия

Company

integer

идентификатор компании

CompanyINN

string

ИНН компании

CompanyKPP

string

КПП компании

CompanyName

string

название компании

Customer

integer

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

CustomerName

string

наименование клиента

DateWTZ

string
YYYY-MM-DD hh:mm:ss

дата продажи

Deleted

boolean

признак, что продажа удалена

DiscountInfo

array[{...}]

массив скидок, примененных для продажи. Вернется, если в запросе передан параметр needDiscountInfo = true

 

Name

string

название скидки

PercentValue

number

процент скидки

Value

number

сумма скидки

Key

string

ключ продажи

Number

string

номер продажи

OpenedWTZ

string

дата создания продажи

Payments

array[{...}]

массив платежей

 

Amount

number

сумма платежа

BankSum

number

сумма безналичной оплаты

BankType

string

тип безналичной оплаты. Возможные значения

CarriedWTZ

string

дата, когда пробит чек

CashSum

number

сумма оплаты наличными

CertificateSum

number

сумма оплаты сертификатом

CheckNumber

string

номер чека

ClosedWTZ

string

дата закрытия чека

Comment

string

комментарий

Company

integer

идентификатор компании

CompanyINN

string

ИНН компании

CompanyName

string

название компании

FiscalNumber

string

фискальный номер

FiscalSign

string

фискальный знак

KKM

integer

идентификатор кассы

KKMName

string

название кассы

KKTFiscalNumber

string

фискальный номер кассы

KKTNumber

string

номер кассы

Key

string

ключ чека

Nonfiscal

boolean

признак нефискального чека

OpenedWTZ

string

дата открытия чека

PayBank

number

сумма безналичной оплаты

PayCash

number

сумма оплаты наличными

PayCertificate

number

сумма оплаты сертификатом

PaySalary

number

сумма оплаты под зарплату

Payment

integer

идентификатор чека

Positions

array[integer]

идентификаторы позиций в чеке

 

Barcode

string

штрихкод

CatalogPrice

number

сумма по каталогу

CheckDiscount

number

скидка в чеке

CheckPrice

number

цена в чеке

CheckSum

number

сумма в чеке

ClosedWTZ

string

дата закрытия продажи

Company

integer

компания

Folder@

boolean

признак, что в товар включены другие позиции. Возможные значения: true, false

FolderKey

string

ключ позиции

FolderPrice

number

сумма по иерархии

Fraction

number

кратность тары/упаковки в базовых единицах товара

FullNumber

string

полный серийный номер

IsKit

boolean

признак комплекта

IsModifier

boolean

признак модификатора

IsReturn

boolean

признак возврата

KKM

integer

идентификатор кассы

Key

string

ключ позиции

KitSettings

integer

настройки комплекта

ManualPrice

number

цена, указанная вручную

MinPrice

number

минимальная цена

Name

string

имя позиции

Nomenclature

integer

идентификатор номенклатуры

NomenclatureNumber

string

код товара

NomenclatureUUID

string

ключ номенклатуры

Number

integer

номер позиции в продаже

Package

object

настройки упаковки

Positions

array[{...}]

массив дочерних позиций

Quantity

number

количество

ReasonName

string

причина отказа

Refused

boolean

признак отказа

ReturnedSerialNumbers

array[string]

возвращенные серийные номера

Returns

array[integer]

массив идентификаторов возврата

Sale

integer

идентификатор продажи

SaleNomenclature

integer

идентификатор позиции

SerialNumber

SerialNumber

серийный номер

SerialNumbers

array[string]

массив серийных номеров

ShortName

string

краткое название товара

TotalCatalog

number

стоимость по каталогу

TotalCertificate

number

сумма оплаты сертификатом

TotalDiscount

number

сумма скидки

TotalPrice

number

сумма по позиции

TotalVAT

number

итоговая сумма НДС

Unit

string

код упаковки

UnitName

string

наименование упаковки

UnitPrice

number

стоимость упаковки

UnitVAT

string

НДС упаковки

Warehouse

integer

склад

PlannedCost

number

плановая себестоимость

TotalCost

number

фактическая себестоимость

PositionsKeys

array[string]

список ключей позиций в чеке

SalarySum

number

сумма оплаты под зарплату

Sale

integer

идентификатор продажи

Shift

integer

идентификатор смены

ShiftNumber

string

номер смены

Teller

integer

кассир

ReservedWTZ

string

дата, на которую забронирован заказ

Return

boolean

признак, что продажа является возвратом

ReturnComment

string

комментарий к возврату

ReturnReasonName

string

причина возврата

ReturnSale

integer

продажа, по которой был осуществлен возврат

ReturnSaleKey

string

ключ продажи, по которой был совершен возврат

Sale

integer

идентификатор продажи

SaleName

string

имя продажи

SaleNomenclatures

array[{...}]

массив позиций продажи

 

Barcode

string

штрихкод

CatalogPrice

number

сумма по каталогу

CheckDiscount

number

скидка в чеке

CheckPrice

number

цена в чеке

CheckSum

number

сумма в чеке

ClosedWTZ

string

дата закрытия продажи

Company

integer

компания

Folder@

boolean

признак, что в товар включены другие позиции. Возможные значения: true, false

FolderKey

string

Ключ позиции

FolderPrice

number

сумма по иерархии

Fraction

number

кратность тары/упаковки в базовых единицах товара

FullNumber

string

полный серийный номер

IsKit

boolean

признак комплекта

IsModifier

boolean

признак модификатора

IsReturn

boolean

признак возврата

KKM

integer

идентификатор кассы

Key

string

ключ позиции

KitSettings

integer

настройки комплекта

ManualPrice

number

цена, указанная вручную

MinPrice

number

минимальная цена

Name

string

имя позиции

Nomenclature

integer

идентификатор номенклатуры

NomenclatureNumber

string

номер номенклатуры

NomenclatureUUID

string

ключ номенклатуры

Number

integer

номер позиции

Package

object

настройки упаковки

Positions

array[{...}]

массив дочерних позиций

Quantity

number

количество

ReasonName

string

причина отказа

Refused

boolean

признак отказа

ReturnedSerialNumbers

array[string]

возвращенные серийные номера

Returns

array[integer]

массив идентификаторов возврата

Sale

integer

идентификатор продажи

SaleNomenclature

integer

идентификатор позиции

SerialNumber

SerialNumber

серийный номер

SerialNumbers

array[string]

массив серийных номеров

ShortName

string

короткое имя

TotalCatalog

number

стоимость по каталогу

TotalCertificate

number

сумма оплаты сертификатом

TotalDiscount

number

сумма скидки

TotalPrice

number

сумма по позиции

TotalVAT

number

итоговая сумма НДС

Unit

string

код упаковки

UnitName

string

наименование упаковки

UnitPrice

number

стоимость упаковки

UnitVAT

string

НДС упаковки

Warehouse

integer

склад

PlannedCost

number

плановая себестоимость

TotalCost

number

фактическая себестоимость

Seller

Seller

идентификатор продавца

SellerINN

string

ИНН продавца

SellerName

string

имя продавца

TotalDiscount

number

сумма скидки

TotalPrice

number

сумма продажи

Updated

string

дата обновления продажи

Warehouse

integer

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

WarehouseName

string

имя склада

Примеры

Запрос

*.php
*.php
*.py
*.py

Запрос данных с помощью функции «cURL».

Запрос данных с помощью библиотеки «Requests»

Ответ

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.
Продолжая пользоваться сайтом, вы даете согласие на обработку персональных данных. Если вы не согласны, покиньте сайт.