Главная

api.skus

Работа с товарами. Приведенные методы нельзя применять к оборудованию и вопросам опросного листа.

Methods

api.skus.baseUnitId(skuId)ID
api.skus.imagePath(idSku) → String
api.skus.quantityConvert(originQuantity, originSkuId, originUnitId, requiredSkuId, requiredUnitId) → Number
api.skus.sku(skuId)Sku
api.skus.skuIdList(typeOrTypeList, distrOrDistrList, isOnlyActive)IDList
api.skus.skuIdListByCO(skuId, distributorId)IDList
api.skus.skuImages(idSku) → Array.<String>
api.skus.skuQtyWithRemainder(skuId, unitId, storeRest)SkuQtysByUnits
api.skus.title(skuId) → String
api.skus.unitFactor(skuId, unitId) → Number
api.skus.unitIdByBarcode(skuId, barcode)ID
api.skus.unitIdList(skuId)IDList
api.skus.unitTitle(unitId) → String

Methods description

baseUnitId(skuId)ID

Получить базовую единицу измерения товара

Parameters:
Name Type Description
skuId ID

Идентификатор товара

Return:
ID

imagePath(idSku) → String

Получить первое изображение товара

Parameters:
Name Type Description
idSku ID

Идентификатор товара

Return:
String -

Ссылка на первое изображение товара

Example
"file:///sdcard/STMobile/db/images/17797.jpg"

quantityConvert(originQuantity, originSkuId, originUnitId, requiredSkuId, requiredUnitId) → Number

Конвертировать количество товара между различными единицами измерения

Parameters:
Name Type Description
originQuantity Number

Количество в исходных единицах измерения

originSkuId ID

Идентификатор исходного товара

originUnitId ID

Идентификатор единицы измерения исходного товара

requiredSkuId ID

Идентификатор товара для конвертации

requiredUnitId ID

Идентификатор единицы измерения для конвертации

Return:
Number -

Сконвертированное количество

sku(skuId)Sku

Получить данные товара. Применение данного метода к оборудованию или вопросам опросного листа приведет к получению неверных данных.

Parameters:
Name Type Description
skuId ID

Идентификатор товара

Return:
Sku

skuIdList(typeOrTypeList, distrOrDistrList, isOnlyActive)IDList

Получить список идентификаторов товара

Parameters:
Name Type Argument Default Description
typeOrTypeList SkuType | Array.<SkuType>

Тип или список типов товара

distrOrDistrList ID | IDList optional 

Дистрибьютор или список дистрибьюторов, если не задан, дистр маршрута

isOnlyActive Boolean optional  true

Только активные товары

Return:

skuIdListByCO(skuId, distributorId)IDList

Получить список товаров сопоставленных товару или списку товаров для заданного дистрибьютора.

Parameters:
Name Type Description
skuId ID | IDList

Идентификаторы товаров

distributorId ID

Идентификатор дистрибьютора

Return:

skuImages(idSku) → Array.<String>

Получить все изображения товара

Parameters:
Name Type Description
idSku ID

Идентификатор товара

Return:
Array.<String> -

Массив ссылок на изображения товара. Пути сортируются согласно приоритету. Возращаются только загруженные изображения.

Example
[
    "file:///sdcard/STMobile/db/images/17797.jpg",
    "file:///sdcard/STMobile/db/images/17798.jpg"
]

skuQtyWithRemainder(skuId, unitId, storeRest)SkuQtysByUnits

Возращает количество товара в указанных и минимальных единицах

Parameters:
Name Type Description
skuId ID

Идентификатор товара

unitId ID

Идентификатор единицы измерения

storeRest Number

Количество товара в базовых единицах (с коэф. 1)

Return:

title(skuId) → String

Получить наименование товара

Parameters:
Name Type Description
skuId ID

Идентификатор товара

Return:
String

unitFactor(skuId, unitId) → Number

Получить фактор единицы измерения

Parameters:
Name Type Description
skuId ID

Идентификатор товара

unitId ID

Идентификатор единицы измерения

Return:
Number

unitIdByBarcode(skuId, barcode)ID

Получить единицу измерения товара по баркоду

Parameters:
Name Type Description
skuId ID

Идентификатор товара

barcode String

Баркод

Return:
ID

unitIdList(skuId)IDList

Получить список единиц измерения товара

Parameters:
Name Type Description
skuId ID

Идентификатор товара

Return:

unitTitle(unitId) → String

Получить название единицы измерения

Parameters:
Name Type Description
unitId ID

Идентификатор единицы измерения

Return:
String