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

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

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

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

Метод запроса: 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	Количество записей на странице. Если параметр не передан, вернется 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

*.py

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

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

Ответ

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.