Сущности Ассортимент Ассортимент
Сущность assortment представляет собой список всех товаров, услуг, комплектов, модификаций и серий с полями stock
,
reserve
, inTransit
, quantity
, показывающими остаток, резерв, ожидание и доступно каждой из сущностей (для комплектов и услуг эти поля не выводятся).
Данные поля могут быть рассчитаны в зависимости от даты и склада с использованием параметров фильтрации stockMoment
и stockStore
.
Атрибуты доступные для фильтрации
Результаты запроса можно отфильтровать, используя параметр filter.
Название
Описание
alcoholic.type
параметр для фильтрации по коду вида алкогольной продукции. Можно использовать операторы =
и !=
. Значение параметра - целое число. Можно передать пустое значение, тогда в выборку попадут товары с заполненным или незаполненным значением кода вида продукции.
archived
параметр для фильтрации по признаку архивности товаров. Возможные значения: true, false. Для выдачи как обычных, так и товаров в архиве, нужно передать сразу два значения true и false. По умолчанию в выдачу попадают только обычные товары.
article
параметр для фильтрации по артикулам товаров и комплектов. Можно использовать операторы =
, !=
, ~
, ~=
, =~
. Можно передать несколько значений. Можно указать пустое значение.
barcode
параметр для фильтрации по штрихкодам сущностей. Допустимый оператор - =
. Можно передать несколько значений. Можно указать пустое значение.
code
параметр для фильтрации по кодам сущностей. Можно использовать операторы =
, !=
, ~
, ~=
, =~
. Можно передать несколько значений. Можно указать пустое значение.
description
параметр для фильтрации по описаниям сущностей. Можно использовать операторы =
, !=
, ~
, ~=
, =~
. Можно передать несколько значений. Можно указать пустое значение.
externalCode
параметр для фильтрации по внешним кодам сущностей. Можно использовать операторы =
, !=
, ~
, ~=
, =~
. Можно передать несколько значений. Можно указать пустое значение.
group
параметр для фильтрации по владельцу-отделу. Можно использовать операторы =
и !=
. Значение параметра - ссылка на отдел. Можно передать несколько значений.
id
параметр для фильтрации по идентификаторам сущностей. Можно использовать операторы =
и !=
. Можно передать несколько значений.
isSerialTrackable
параметр для фильтрации по использованию серийных номеров
name
параметр для фильтрации по наименованиям сущностей. Можно использовать операторы =
, !=
, ~
, ~=
, =~
. Можно передать несколько значений.
owner
параметр для фильтрации по владельцу-сотруднику. Можно использовать операторы =
и !=
. Значение параметра - ссылка на сотрудника. Можно передать несколько значений. Можно указать пустое значение.
pathname
параметр для фильтрации по наименованию групп товаров. Можно использовать операторы =
, !=
, ~
, ~=
, =~
. Можно передать несколько значений. Можно указать пустое значение.
productFolder
параметр для фильтрации по нескольким группам товаров. Можно использовать операторы =
и !=
. Значение параметра - ссылка на группу товаров, которая должна быть включена в выборку или исключена из нее. Можно передать несколько значений. В выборку попадут товары, которые находятся (или не находятся) непосредственно в указанных группах.
quantityMode
параметр для фильтрации по значению доступно. Значение по умолчанию all. Доступные значения
search
префиксный поиск по строковым полям, выводимым в ассортименте. Для данного параметра нужно использовать оператор =
. Поиск по штрихкодам выполняется по полному соотвествию. Можно передать только одно значение.Подробнее тут
shared
параметр для фильтрации по признаку общего доступа. Возможные значения: true, false.
stockMode
параметр для фильтрации по значению остатка. Значение по умолчанию all. Доступные значения
stockMoment
момент времени, на который нужно вывести остатки. Передается в виде строки в формате дата-время
stockStore
параметр для фильтрации по нескольким складам. Можно использовать операторы =
и !=
. Значение параметра - ссылка на склад, который должен быть учтен в выборке или исключен из нее. Можно передать несколько значений.
supplier
параметр для фильтрации по нескольким поставщикам. Можно использовать операторы =
и !=
. Значение параметра - ссылка на контрагента или организацию. В выборку будут включены или исключены товары с указанными поставщиками. Можно передать пустое значение, тогда в выборку попадут товары с незаполненным или заполненным поставщиком.
type
параметр для фильтрации по типу сущности (product, service, bundle, variant, consignment). Используется с оператором =
. Можно передать несколько значений. Для фильтрации по типу consignment требуется использовать группировку (groupBy=consignment).
updated
параметр для фильтрации по времени последнего обновления сущностей. Можно использовать операторы =
, <
, <=
, >
, >=
. Действие строгих операторов синонимично нестрогим. Передается в виде строки в формате дата-время .
updatedBy
параметр для фильтрации по автору последнего обновления. Можно использовать операторы =
и !=
. Значение параметра - uid
(admin@admin
). Можно передать несколько значений.
weighed
параметр для фильтрации по признаку весового товара. Возможные значения: true, false.
withSubFolders
параметр учета вложенных подгрупп. Работает только при наличии непустого фильтра по productFolder
. По умолчанию true
, выводятся товары из дочерних подгрупп фильтруемой группы / групп товаров. При передаче false
выводятся только товары из фильтруемой группы / групп, без учета подгрупп.
доп. поле(url)
параметром фильтрации служит url дополнительного поля. Оператор фильтрации зависит от типа доп. поля. Подробнее тут .
Также доступна фильтрация по доп. полям. Подробнее про фильтрацию по доп. полям можно посмотреть в соответствующем разделе .
Доступные значения для stockMode
Значение по умолчанию all.
Значение
Описание
all
Любое значение остатка
positiveOnly
Положительный остаток
negativeOnly
Отрицательный остаток
empty
Нулевой остаток
nonEmpty
Ненулевой остаток
underMinimum
Остаток ниже неснижаемого остатка
Доступные значения для quantityMode
Значение по умолчанию all.
Значение
Описание
all
Любое значение остатка
positiveOnly
Положительный остаток
negativeOnly
Отрицательный остаток
empty
Нулевой остаток
nonEmpty
Ненулевой остаток
underMinimum
Остаток ниже неснижаемого остатка
Доступные значения для search
Для данного параметра нужно использовать оператор =
. Поиск по штрихкодам выполняется по полному соотвествию. Можно передать только одно значение.
по наименованию элемента Ассортимента name
по имени модификации name
по коду code
по коду модификации code
по артикулу article
по штрихкоду barcode
по штрихкоду модификации barcode
по штрихкоду упаковок товаров barcode
по штрихкоду упаковок модификаций barcode
При использовании фильтров alcoholic.type , weighed и фильтров stockMode , quantityMode со значениями, отличными от all, в выдачу не попадают услуги и комлекты.
Фильтрация доп. полей
Подробнее функциональность описана в разделе Фильтрация по дополнительным полям .
Примеры фильтрации:
filter=stockStore=https://api.moysklad.ru/api/remap/1.2/entity/store/656c4032-8667-11e6-8a84-bae500003321
filter=id=677c4032-8667-11e6-8a84-bae500003344
filter=name~див
filter=code~0002
filter=externalCode~xdls
filter=article~3456
filter=description~див
filter=shared=false
filter=updated>=2019-07-10 12:00:00;updated<=2019-07-12 12:00:00
filter=updatedBy=admin@company
filter=owner=https://api.moysklad.ru/api/remap/1.2/entity/employee/a88d0702-85c7-11e9-ac12-000d00000321
filter=group=https://api.moysklad.ru/api/remap/1.2/entity/group/a99d0702-85c7-11e9-ac12-000d00000551
filter=alcoholic.type=123
filter=productFolder=https://api.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1
filter=productFolder=https://api.moysklad.ru/api/remap/1.2/entity/productfolder/c56d0702-85c7-11e9-ac12-000d000000b1;withSubFolders=false
filter=stockMode=all
filter=quantityMode=all
filter=stockMode=all;quantityMode=all
filter=stockMoment=2019-07-10 12:00:00
filter=weighed=true
filter=archived=true
filter=archived=false;archived=true
filter=supplier=https://api.moysklad.ru/api/remap/1.2/entity/counterparty/656c4032-8667-11e6-8a84-bae5000033aa
filter=search=див
filter=https://api.moysklad.ru/api/remap/1.2/entity/product/metadata/attributes/b83c12e7-42bf-11ec-0a80-08bb00000161=color
filter=https://api.moysklad.ru/api/remap/1.2/entity/product/metadata/attributes/83386e05-51c0-11ec-0a83-0640000001bb>=2021-11-30 12:39:00
Параметры
Параметр
Описание
limit
number
(optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000
.
offset
number
(optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
groupBy
string
(optional) Параметр группировки. Принимает одно из значений: product
- будут выведены только товары, variant
- будут выведены товары и модификации (аналогично отсутствию параметра), consignment
- будут выведены все сущности
Настройки справочника
Под сущностями справочника товаров подразумеваются товары, услуги, комплекты и группы товаров.
Настройки справочника позволяют пользователю менять проверку уникальности кода, установку уникального кода при создании сущностей, установку уникального штрихкода EAN13, использование префиксов штрихкода для весовых товаров и настройку общего доступа к этим сущностям.
Атрибуты сущности
Название
Тип
Описание
meta
Meta
Метаданные Настроек справочникаОбязательное при ответе
uniqueCodeRules
Object
Настройки уникальности кода для сущностей справочника. Подробнее тут Обязательное при ответе
barcodeRules
Object
Настройки правил штрихкодов для сущностей справочника. Подробнее тут Обязательное при ответе
createdShared
Boolean
Создавать новые документы с меткой «Общий»Обязательное при ответе
Атрибуты вложенных сущностей Настройки уникальности кода для сущностей справочника
Название
Тип
Описание
checkUniqueCode
Boolean
Проверка уникальности кода сущностей справочника товаровОбязательное при ответе
fillUniqueCode
Boolean
Устанавливать уникальный код при создании создании сущностей справочника товаровОбязательное при ответе
Настройки правил штрихкодов для сущностей справочника
Название
Тип
Описание
fillEAN13Barcode
Boolean
Автоматически создавать штрихкод EAN13 для новых товаров, комплектов, модификаций и услугОбязательное при ответе
weightBarcode
Boolean
Использовать префиксы штрихкодов для весовых товаровОбязательное при ответе
weightBarcodePrefix
Int
Префикс штрихкодов для весовых товаров. Возможные значения: число формата X или XXОбязательное при ответе
Получить Ассортимент
Запрос на получение всех товаров, услуг, комплектов и модификаций в виде списка.
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/assortment"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json). Успешный запрос. Результат - JSON представление списка всех товаров, услуг и модификаций.
Показать Свернуть
{
"context" : {
"employee" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/employee" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
}
},
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/assortment" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/assortment/metadata" ,
"type" : "assortment" ,
"mediaType" : "application/json" ,
"size" : 7 ,
"limit" : 1000 ,
"offset" : 0
},
"rows" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/35427052-36e7-11e7-8a7f-40d0000000d1" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata" ,
"type" : "product" ,
"mediaType" : "application/json"
},
"id" : "35427052-36e7-11e7-8a7f-40d0000000d7" ,
"accountId" : "103bff1b-36e7-11e7-8a7f-40d000000004" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/105a788e-36e7-11e7-8a7f-40d000000069" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/103cca6f-36e7-11e7-8a7f-40d000000005" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2017-05-12 10:47:11" ,
"name" : "product" ,
"code" : "00001" ,
"externalCode" : "LsAGeHdbgyQ3oSlTzZUvH0" ,
"archived" : false ,
"pathName" : "" ,
"useParentVat" : false ,
"vat" : 18 ,
"vatEnabled" : true ,
"effectiveVat" : 18 ,
"effectiveVatEnabled" : true ,
"uom" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/metadata" ,
"type" : "uom" ,
"mediaType" : "application/json"
}
},
"images" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/35427052-36e7-11e7-8a7f-40d0000000d1/images" ,
"type" : "image" ,
"mediaType" : "application/json" ,
"size" : 0 ,
"limit" : 1000 ,
"offset" : 0
}
},
"minPrice" : {
"value" : 500.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"salePrices" : [
{
"value" : 1500.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
},
"priceType" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/companysettings/pricetype/672559f1-cbf3-11e1-9eb9-889ffa6f49fd" ,
"type" : "pricetype" ,
"mediaType" : "application/json"
},
"id" : "672559f1-cbf3-11e1-9eb9-889ffa6f49fd" ,
"name" : "Цена продажи" ,
"externalCode" : "cbcf493b-55bc-11d9-848a-00112f43529a"
}
}
],
"supplier" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/1076cf8b-36e7-11e7-8a7f-40d000000093" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json"
}
},
"buyPrice" : {
"value" : 500.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"article" : "100000000" ,
"weight" : 0 ,
"volume" : 0 ,
"barcodes" : [
{
"ean13" : "2000000000015"
}
],
"variantsCount" : 0 ,
"isSerialTrackable" : false ,
"stock" : 0 ,
"reserve" : 0 ,
"inTransit" : 0 ,
"quantity" : 0
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/service/437f2d67-36e7-11e7-8a7f-40d0000000df" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata" ,
"type" : "service" ,
"mediaType" : "application/json"
},
"id" : "437f2d67-36e7-11e7-8a7f-40d0000000df" ,
"accountId" : "103bff1b-36e7-11e7-8a7f-40d000000004" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/105a788e-36e7-11e7-8a7f-40d000000069" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/103cca6f-36e7-11e7-8a7f-40d000000005" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2017-05-12 10:47:35" ,
"name" : "service" ,
"code" : "00002" ,
"externalCode" : "DDBfxV4djLuOlbr80-I1A0" ,
"archived" : false ,
"pathName" : "" ,
"useParentVat" : false ,
"vat" : 18 ,
"vatEnabled" : true ,
"effectiveVat" : 18 ,
"effectiveVatEnabled" : true ,
"uom" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/metadata" ,
"type" : "uom" ,
"mediaType" : "application/json"
}
},
"minPrice" : {
"value" : 500.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"salePrices" : [
{
"value" : 1500.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
},
"priceType" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/companysettings/pricetype/672559f1-cbf3-11e1-9eb9-889ffa6f49fd" ,
"type" : "pricetype" ,
"mediaType" : "application/json"
},
"id" : "672559f1-cbf3-11e1-9eb9-889ffa6f49fd" ,
"name" : "Цена продажи" ,
"externalCode" : "cbcf493b-55bc-11d9-848a-00112f43529a"
}
}
],
"buyPrice" : {
"value" : 700.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"barcodes" : [
{
"ean13" : "34875834765872435"
}
]
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bundle/4f75d130-36e7-11e7-8a7f-40d0000000ef" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata" ,
"type" : "bundle" ,
"mediaType" : "application/json"
},
"id" : "4f75d130-36e7-11e7-8a7f-40d0000000ef" ,
"accountId" : "103bff1b-36e7-11e7-8a7f-40d000000004" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/105a788e-36e7-11e7-8a7f-40d000000069" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/103cca6f-36e7-11e7-8a7f-40d000000005" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2017-05-12 10:47:55" ,
"name" : "bundle" ,
"code" : "00003" ,
"externalCode" : "ndWrlXCZjm9uSyLk57KOD0" ,
"archived" : false ,
"pathName" : "" ,
"useParentVat" : false ,
"vat" : 18 ,
"vatEnabled" : true ,
"effectiveVat" : 18 ,
"effectiveVatEnabled" : true ,
"uom" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/metadata" ,
"type" : "uom" ,
"mediaType" : "application/json"
}
},
"images" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bundle/4f75d130-36e7-11e7-8a7f-40d0000000ef/images" ,
"type" : "image" ,
"mediaType" : "application/json" ,
"size" : 0 ,
"limit" : 1000 ,
"offset" : 0
}
},
"minPrice" : {
"value" : 500.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"salePrices" : [
{
"value" : 0.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
},
"priceType" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/companysettings/pricetype/672559f1-cbf3-11e1-9eb9-889ffa6f49fd" ,
"type" : "pricetype" ,
"mediaType" : "application/json"
},
"id" : "672559f1-cbf3-11e1-9eb9-889ffa6f49fd" ,
"name" : "Цена продажи" ,
"externalCode" : "cbcf493b-55bc-11d9-848a-00112f43529a"
}
}
],
"article" : "50000000" ,
"weight" : 0 ,
"volume" : 0 ,
"barcodes" : [
{
"ean13" : "2000000000046"
}
],
"components" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bundle/4f75d130-36e7-11e7-8a7f-40d0000000ef/components" ,
"type" : "bundlecomponent" ,
"mediaType" : "application/json" ,
"size" : 1 ,
"limit" : 1000 ,
"offset" : 0
}
}
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/6830a346-36e7-11e7-8a7f-40d0000000f8" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata" ,
"type" : "product" ,
"mediaType" : "application/json"
},
"id" : "6830a346-36e7-11e7-8a7f-40d0000000f8" ,
"accountId" : "103bff1b-36e7-11e7-8a7f-40d000000004" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/105a788e-36e7-11e7-8a7f-40d000000069" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/103cca6f-36e7-11e7-8a7f-40d000000005" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2017-05-12 10:48:37" ,
"name" : "product2" ,
"code" : "00004" ,
"externalCode" : "bxviUUtwg4C6y4RdOc2GS3" ,
"archived" : false ,
"pathName" : "" ,
"uom" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/metadata" ,
"type" : "uom" ,
"mediaType" : "application/json"
}
},
"images" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/6830a346-36e7-11e7-8a7f-40d0000000f8/images" ,
"type" : "image" ,
"mediaType" : "application/json" ,
"size" : 0 ,
"limit" : 1000 ,
"offset" : 0
}
},
"minPrice" : {
"value" : 500.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"salePrices" : [
{
"value" : 1800.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
},
"priceType" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/companysettings/pricetype/672559f1-cbf3-11e1-9eb9-889ffa6f49fd" ,
"type" : "pricetype" ,
"mediaType" : "application/json"
},
"id" : "672559f1-cbf3-11e1-9eb9-889ffa6f49fd" ,
"name" : "Цена продажи" ,
"externalCode" : "cbcf493b-55bc-11d9-848a-00112f43529a"
}
}
],
"buyPrice" : {
"value" : 700.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"article" : "2000000000000" ,
"weight" : 0 ,
"volume" : 0 ,
"barcodes" : [
{
"ean13" : "2000000000053"
}
],
"variantsCount" : 2 ,
"isSerialTrackable" : false ,
"stock" : 0 ,
"reserve" : 0 ,
"inTransit" : 0 ,
"quantity" : 0
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/68379863-36e7-11e7-8a7f-40d0000000fd" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/metadata" ,
"type" : "variant" ,
"mediaType" : "application/json"
},
"id" : "68379863-36e7-11e7-8a7f-40d0000000fd" ,
"accountId" : "103bff1b-36e7-11e7-8a7f-40d000000004" ,
"updated" : "2017-05-12 10:48:37" ,
"name" : "product2 (blue)" ,
"code" : "00002" ,
"externalCode" : "BrmW28jLhRMI-jOPUdfWW0" ,
"archived" : false ,
"characteristics" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/metadata/characteristics/682beecc-36e7-11e7-8a7f-40d0000000f5" ,
"type" : "attributemetadata" ,
"mediaType" : "application/json"
},
"id" : "682beecc-36e7-11e7-8a7f-40d0000000f5" ,
"name" : "color" ,
"value" : "blue"
}
],
"salePrices" : [
{
"value" : 1800.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
},
"priceType" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/companysettings/pricetype/672559f1-cbf3-11e1-9eb9-889ffa6f49fd" ,
"type" : "pricetype" ,
"mediaType" : "application/json"
},
"id" : "672559f1-cbf3-11e1-9eb9-889ffa6f49fd" ,
"name" : "Цена продажи" ,
"externalCode" : "cbcf493b-55bc-11d9-848a-00112f43529a"
}
}
],
"barcodes" : [
{
"ean13" : "2000000000060"
}
],
"product" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/6830a346-36e7-11e7-8a7f-40d0000000f8" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata" ,
"type" : "product" ,
"mediaType" : "application/json"
}
},
"stock" : 0 ,
"reserve" : 0 ,
"inTransit" : 0 ,
"quantity" : 0
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/6839f0fa-36e7-11e7-8a7f-40d000000101" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/metadata" ,
"type" : "variant" ,
"mediaType" : "application/json"
},
"id" : "6839f0fa-36e7-11e7-8a7f-40d000000101" ,
"accountId" : "103bff1b-36e7-11e7-8a7f-40d000000004" ,
"updated" : "2017-05-12 10:48:37" ,
"name" : "product2 (red)" ,
"code" : "00003" ,
"externalCode" : "i0u4rktiiVX6BWL60IVkJ1" ,
"archived" : false ,
"characteristics" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/metadata/characteristics/682beecc-36e7-11e7-8a7f-40d0000000f5" ,
"type" : "attributemetadata" ,
"mediaType" : "application/json"
},
"id" : "682beecc-36e7-11e7-8a7f-40d0000000f5" ,
"name" : "color" ,
"value" : "red"
}
],
"salePrices" : [
{
"value" : 1800.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/10772c12-36e7-11e7-8a7f-40d000000097" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
},
"priceType" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/companysettings/pricetype/672559f1-cbf3-11e1-9eb9-889ffa6f49fd" ,
"type" : "pricetype" ,
"mediaType" : "application/json"
},
"id" : "672559f1-cbf3-11e1-9eb9-889ffa6f49fd" ,
"name" : "Цена продажи" ,
"externalCode" : "cbcf493b-55bc-11d9-848a-00112f43529a"
}
}
],
"barcodes" : [
{
"ean13" : "2000000000077"
}
],
"product" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/6830a346-36e7-11e7-8a7f-40d0000000f8" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata" ,
"type" : "product" ,
"mediaType" : "application/json"
}
},
"stock" : 0 ,
"reserve" : 0 ,
"inTransit" : 0 ,
"quantity" : 0
}
]
}
Получение Ассортимента с сериями
Запрос на получение всех товаров, услуг, комплектов, модификаций и серий в виде списка.
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/assortment?groupBy=consignment"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json). Успешный запрос. Результат - JSON представление списка всех товаров, услуг, модификаций и серий.
Показать Свернуть
{
"context" : {
"employee" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/employee" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
}
},
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/assortment?groupBy=consignment" ,
"type" : "assortment" ,
"mediaType" : "application/json" ,
"size" : 6 ,
"limit" : 1000 ,
"offset" : 0
},
"rows" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/ba3c6d6d-3d33-11ef-ac15-0010000000ef" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata" ,
"type" : "product" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#good/edit?id=ba3a833f-3d33-11ef-ac15-0010000000ed"
},
"id" : "ba3c6d6d-3d33-11ef-ac15-0010000000ef" ,
"accountId" : "1e831ee5-3d33-11ef-ac15-000f00000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/2004c794-3d33-11ef-ac15-00100000004e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#employee/edit?id=2004c794-3d33-11ef-ac15-00100000004e"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/1e85f779-3d33-11ef-ac15-000f00000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2024-07-08 17:11:27.942" ,
"name" : "продукт" ,
"description" : "продукт" ,
"code" : "00001" ,
"externalCode" : "yO85GgFpgK5DFsmjJKdQ82" ,
"archived" : false ,
"pathName" : "" ,
"useParentVat" : true ,
"uom" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/metadata" ,
"type" : "uom" ,
"mediaType" : "application/json"
}
},
"images" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/ba3c6d6d-3d33-11ef-ac15-0010000000ef/images" ,
"type" : "image" ,
"mediaType" : "application/json" ,
"size" : 0 ,
"limit" : 1000 ,
"offset" : 0
}
},
"minPrice" : {
"value" : 0.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/2084dec0-3d33-11ef-ac15-00100000009d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#currency/edit?id=2084dec0-3d33-11ef-ac15-00100000009d"
}
}
},
"salePrices" : [
{
"value" : 0.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/2084dec0-3d33-11ef-ac15-00100000009d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#currency/edit?id=2084dec0-3d33-11ef-ac15-00100000009d"
}
},
"priceType" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/companysettings/pricetype/20cc4a52-3d33-11ef-ac15-00100000009e" ,
"type" : "pricetype" ,
"mediaType" : "application/json"
},
"id" : "20cc4a52-3d33-11ef-ac15-00100000009e" ,
"name" : "Цена продажи" ,
"externalCode" : "cbcf493b-55bc-11d9-848a-00112f43529a"
}
}
],
"buyPrice" : {
"value" : 0.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/2084dec0-3d33-11ef-ac15-00100000009d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#currency/edit?id=2084dec0-3d33-11ef-ac15-00100000009d"
}
}
},
"barcodes" : [
{
"ean13" : "2000000000015"
}
],
"paymentItemType" : "GOOD" ,
"discountProhibited" : false ,
"weight" : 0.0 ,
"volume" : 0.0 ,
"variantsCount" : 2 ,
"isSerialTrackable" : false ,
"trackingType" : "NOT_TRACKED" ,
"files" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/ba3c6d6d-3d33-11ef-ac15-0010000000ef/files" ,
"type" : "files" ,
"mediaType" : "application/json" ,
"size" : 0 ,
"limit" : 1000 ,
"offset" : 0
}
},
"stock" : 0.0 ,
"reserve" : 0.0 ,
"inTransit" : 0.0 ,
"quantity" : 0.0
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/consignment/95b97e84-3d34-11ef-ac15-000d00000000" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/consignment/metadata" ,
"type" : "consignment" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#consignment/edit?id=95b97e84-3d34-11ef-ac15-000d00000000"
},
"id" : "95b97e84-3d34-11ef-ac15-000d00000000" ,
"accountId" : "1e831ee5-3d33-11ef-ac15-000f00000001" ,
"updated" : "2024-07-08 17:15:52.881" ,
"name" : "продукт / consignment" ,
"code" : "1012" ,
"externalCode" : "g9BOLNRZglk9NMOHxcrVV0" ,
"label" : "consignment" ,
"barcodes" : [
{
"ean13" : "2000000000077"
}
],
"images" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/ba3c6d6d-3d33-11ef-ac15-0010000000ef/images" ,
"type" : "image" ,
"mediaType" : "application/json" ,
"size" : 0 ,
"limit" : 1000 ,
"offset" : 0
}
},
"assortment" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/ba3c6d6d-3d33-11ef-ac15-0010000000ef" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata" ,
"type" : "product" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#good/edit?id=ba3a833f-3d33-11ef-ac15-0010000000ed"
}
},
"stock" : 0.0 ,
"reserve" : 0.0 ,
"inTransit" : 0.0 ,
"quantity" : 0.0
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/f7954456-3d33-11ef-ac15-00100000011e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/metadata" ,
"type" : "variant" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#feature/edit?id=f7953353-3d33-11ef-ac15-00100000011c"
},
"id" : "f7954456-3d33-11ef-ac15-00100000011e" ,
"accountId" : "1e831ee5-3d33-11ef-ac15-000f00000001" ,
"updated" : "2024-07-08 17:11:27.799" ,
"name" : "продукт (мод А)" ,
"code" : "00002" ,
"externalCode" : "wc0O05KgiXC-4gxxp02DN0" ,
"archived" : false ,
"characteristics" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/metadata/characteristics/f78c41a6-3d33-11ef-ac15-00100000011b" ,
"type" : "attributemetadata" ,
"mediaType" : "application/json"
},
"id" : "f78c41a6-3d33-11ef-ac15-00100000011b" ,
"name" : "модификация" ,
"value" : "мод А"
}
],
"images" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/f7954456-3d33-11ef-ac15-00100000011e/images" ,
"type" : "image" ,
"mediaType" : "application/json" ,
"size" : 0 ,
"limit" : 1000 ,
"offset" : 0
}
},
"salePrices" : [
{
"value" : 0.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/2084dec0-3d33-11ef-ac15-00100000009d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#currency/edit?id=2084dec0-3d33-11ef-ac15-00100000009d"
}
},
"priceType" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/companysettings/pricetype/20cc4a52-3d33-11ef-ac15-00100000009e" ,
"type" : "pricetype" ,
"mediaType" : "application/json"
},
"id" : "20cc4a52-3d33-11ef-ac15-00100000009e" ,
"name" : "Цена продажи" ,
"externalCode" : "cbcf493b-55bc-11d9-848a-00112f43529a"
}
}
],
"barcodes" : [
{
"ean13" : "2000000000046"
}
],
"discountProhibited" : false ,
"product" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/ba3c6d6d-3d33-11ef-ac15-0010000000ef" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata" ,
"type" : "product" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#good/edit?id=ba3a833f-3d33-11ef-ac15-0010000000ed"
}
},
"stock" : 0.0 ,
"reserve" : 0.0 ,
"inTransit" : 0.0 ,
"quantity" : 0.0
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/f79dd660-3d33-11ef-ac15-001000000123" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/metadata" ,
"type" : "variant" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#feature/edit?id=f79db7c3-3d33-11ef-ac15-001000000121"
},
"id" : "f79dd660-3d33-11ef-ac15-001000000123" ,
"accountId" : "1e831ee5-3d33-11ef-ac15-000f00000001" ,
"updated" : "2024-07-08 17:11:27.870" ,
"name" : "продукт (мод Б)" ,
"code" : "00003" ,
"externalCode" : "3PFqcaJagqpvSiIgKLaCq1" ,
"archived" : false ,
"characteristics" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/metadata/characteristics/f78c41a6-3d33-11ef-ac15-00100000011b" ,
"type" : "attributemetadata" ,
"mediaType" : "application/json"
},
"id" : "f78c41a6-3d33-11ef-ac15-00100000011b" ,
"name" : "модификация" ,
"value" : "мод Б"
}
],
"images" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/variant/f79dd660-3d33-11ef-ac15-001000000123/images" ,
"type" : "image" ,
"mediaType" : "application/json" ,
"size" : 0 ,
"limit" : 1000 ,
"offset" : 0
}
},
"salePrices" : [
{
"value" : 0.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/2084dec0-3d33-11ef-ac15-00100000009d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#currency/edit?id=2084dec0-3d33-11ef-ac15-00100000009d"
}
},
"priceType" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/companysettings/pricetype/20cc4a52-3d33-11ef-ac15-00100000009e" ,
"type" : "pricetype" ,
"mediaType" : "application/json"
},
"id" : "20cc4a52-3d33-11ef-ac15-00100000009e" ,
"name" : "Цена продажи" ,
"externalCode" : "cbcf493b-55bc-11d9-848a-00112f43529a"
}
}
],
"barcodes" : [
{
"ean13" : "2000000000053"
}
],
"discountProhibited" : false ,
"product" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/ba3c6d6d-3d33-11ef-ac15-0010000000ef" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata" ,
"type" : "product" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#good/edit?id=ba3a833f-3d33-11ef-ac15-0010000000ed"
}
},
"stock" : 0.0 ,
"reserve" : 0.0 ,
"inTransit" : 0.0 ,
"quantity" : 0.0
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/service/c57dcc60-3d33-11ef-ac15-0010000000fc" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata" ,
"type" : "service" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#good/edit?id=c57db591-3d33-11ef-ac15-0010000000fa"
},
"id" : "c57dcc60-3d33-11ef-ac15-0010000000fc" ,
"accountId" : "1e831ee5-3d33-11ef-ac15-000f00000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/2004c794-3d33-11ef-ac15-00100000004e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#employee/edit?id=2004c794-3d33-11ef-ac15-00100000004e"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/1e85f779-3d33-11ef-ac15-000f00000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2024-07-08 17:10:03.751" ,
"name" : "услуга" ,
"description" : "услуга" ,
"code" : "00002" ,
"externalCode" : "60tB0R4Ui9PfsXhauKUP40" ,
"archived" : false ,
"pathName" : "" ,
"useParentVat" : true ,
"uom" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/metadata" ,
"type" : "uom" ,
"mediaType" : "application/json"
}
},
"minPrice" : {
"value" : 0.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/2084dec0-3d33-11ef-ac15-00100000009d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#currency/edit?id=2084dec0-3d33-11ef-ac15-00100000009d"
}
}
},
"salePrices" : [
{
"value" : 0.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/2084dec0-3d33-11ef-ac15-00100000009d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#currency/edit?id=2084dec0-3d33-11ef-ac15-00100000009d"
}
},
"priceType" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/companysettings/pricetype/20cc4a52-3d33-11ef-ac15-00100000009e" ,
"type" : "pricetype" ,
"mediaType" : "application/json"
},
"id" : "20cc4a52-3d33-11ef-ac15-00100000009e" ,
"name" : "Цена продажи" ,
"externalCode" : "cbcf493b-55bc-11d9-848a-00112f43529a"
}
}
],
"buyPrice" : {
"value" : 0.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/2084dec0-3d33-11ef-ac15-00100000009d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#currency/edit?id=2084dec0-3d33-11ef-ac15-00100000009d"
}
}
},
"barcodes" : [
{
"ean13" : "2000000000022"
}
],
"paymentItemType" : "SERVICE" ,
"discountProhibited" : false ,
"files" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/service/c57dcc60-3d33-11ef-ac15-0010000000fc/files" ,
"type" : "files" ,
"mediaType" : "application/json" ,
"size" : 0 ,
"limit" : 1000 ,
"offset" : 0
}
}
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bundle/da607138-3d33-11ef-ac15-00100000010d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata" ,
"type" : "bundle" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#good/edit?id=da60604b-3d33-11ef-ac15-00100000010b"
},
"id" : "da607138-3d33-11ef-ac15-00100000010d" ,
"accountId" : "1e831ee5-3d33-11ef-ac15-000f00000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/2004c794-3d33-11ef-ac15-00100000004e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#employee/edit?id=2004c794-3d33-11ef-ac15-00100000004e"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/1e85f779-3d33-11ef-ac15-000f00000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2024-07-08 17:10:38.791" ,
"name" : "комплект" ,
"code" : "00003" ,
"externalCode" : "pOjHkQ6mgLmQ9aI0dayiY0" ,
"archived" : false ,
"pathName" : "" ,
"useParentVat" : true ,
"uom" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/19f1edc0-fc42-4001-94cb-c9ec9c62ec10" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/uom/metadata" ,
"type" : "uom" ,
"mediaType" : "application/json"
}
},
"images" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bundle/da607138-3d33-11ef-ac15-00100000010d/images" ,
"type" : "image" ,
"mediaType" : "application/json" ,
"size" : 0 ,
"limit" : 1000 ,
"offset" : 0
}
},
"minPrice" : {
"value" : 0.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/2084dec0-3d33-11ef-ac15-00100000009d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#currency/edit?id=2084dec0-3d33-11ef-ac15-00100000009d"
}
}
},
"salePrices" : [
{
"value" : 0.0 ,
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/2084dec0-3d33-11ef-ac15-00100000009d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://api.moysklad.ru/app/#currency/edit?id=2084dec0-3d33-11ef-ac15-00100000009d"
}
},
"priceType" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/companysettings/pricetype/20cc4a52-3d33-11ef-ac15-00100000009e" ,
"type" : "pricetype" ,
"mediaType" : "application/json"
},
"id" : "20cc4a52-3d33-11ef-ac15-00100000009e" ,
"name" : "Цена продажи" ,
"externalCode" : "cbcf493b-55bc-11d9-848a-00112f43529a"
}
}
],
"barcodes" : [
{
"ean13" : "2000000000039"
}
],
"paymentItemType" : "GOOD" ,
"discountProhibited" : false ,
"weight" : 0.0 ,
"volume" : 0.0 ,
"trackingType" : "NOT_TRACKED" ,
"components" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bundle/da607138-3d33-11ef-ac15-00100000010d/components" ,
"type" : "bundlecomponent" ,
"mediaType" : "application/json" ,
"size" : 2 ,
"limit" : 1000 ,
"offset" : 0
}
},
"files" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bundle/da607138-3d33-11ef-ac15-00100000010d/files" ,
"type" : "files" ,
"mediaType" : "application/json" ,
"size" : 0 ,
"limit" : 1000 ,
"offset" : 0
}
}
}
]
}
Массовое удаление позиций в Ассортименте
В теле запроса нужно передать массив, содержащий JSON метаданных позиций в Ассортименте, которые вы хотите удалить.
Запрос на массовое удаление позиций в Ассортименте.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/assortment/delete"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/product/7944ef04-f831-11e5-7a69-971500188b1",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "product",
"mediaType": "application/json"
}
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/service/7944ef04-f831-11e5-7a69-971500188b2",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/product/metadata",
"type": "service",
"mediaType": "application/json"
}
}
]'
Успешный запрос. Результат - JSON информация об удалении позиций в Ассортименте.
Показать Свернуть
[
{
"info" : "Сущность 'service' с UUID: 7944ef04-f831-11e5-7a69-971500188b2 успешно удалена"
},
{
"info" : "Сущность 'product' с UUID: 7944ef04-f831-11e5-7a69-971500188b1 успешно удалена"
}
]
Получить Настройки справочника товаров
Запрос на получение настроек справочника товаров
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/assortment/settings"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление настроек компании.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/assortment/settings" ,
"type" : "assortmentsettings" ,
"mediaType" : "application/json"
},
"barcodeRules" : {
"fillEAN13Barcode" : true ,
"weightBarcode" : true ,
"weightBarcodePrefix" : 77
},
"uniqueCodeRules" : {
"checkUniqueCode" : true ,
"fillUniqueCode" : true
},
"createdShared" : true
}
Изменить настройки справочника товаров
В теле запроса нужно передать объект, содержащий новый JSON настроек справочника.
Изменять настройки можно частично, для этого в тело запроса нужно добавить лишь те поля, которые необходимо обновлять, остальные поля останутся прежними. Каждое поле является необязательным.
В ответе придет полная сущность, даже если обновление было частичным.
Запрос на изменение метаданных справочника товаров.
Показать Свернуть
curl -X PUT
"https://api.moysklad.ru/api/remap/1.2/entity/assortment/settings"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"uniqueCodeRules": {
"checkUniqueCodeBoolean": true,
"fillUniqueCode": true
},
"barcodeRules": {
"fillEAN13Barcode": true,
"weightBarcodePrefix": 55
},
"createdShared": false
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление настроек справочника товаров.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/assortment/settings" ,
"type" : "assortmentsettings" ,
"mediaType" : "application/json"
},
"uniqueCodeRules" : {
"checkUniqueCodeBoolean" : true ,
"fillUniqueCode" : true
},
"barcodeRules" : {
"fillEAN13Barcode" : true ,
"weightBarcodePrefix" : 55
},
"createdShared" : false
}
Бонусная операция Бонусные операции
Средствами JSON API можно создавать и обновлять сведения о Бонусных операциях, запрашивать списки Бонусных операций и сведения по отдельным Бонусым операциям. Кодом сущности для Бонусной операции в составе JSON API является ключевое слово bonustransaction .
Атрибуты сущности
Название
Тип
Фильтрация
Описание
accountId
UUID
=
!=
ID учетной записиОбязательное при ответе
Только для чтения
agent
Meta
=
!=
Метаданные Контрагента, связанного с бонусной операциейОбязательное при ответе
Expand
Необходимо при создании
applicable
Boolean
=
!=
Отметка о проведенииОбязательное при ответе
bonusProgram
Meta
=
!=
Метаданные бонусной программыExpand
bonusValue
Int
=
!=
<
>
<=
>=
Количество бонусных баллов
categoryType
Enum
Категория бонусной операции. Возможные значения: REGULAR
, WELCOME
Только для чтения
code
String(255)
=
!=
~
~=
=~
Код Бонусной операции
created
DateTime
=
!=
<
>
<=
>=
Момент создания Бонусной операцииОбязательное при ответе
executionDate
DateTime
Дата начисления бонусной операции.
externalCode
String(255)
=
!=
~
~=
=~
Внешний код Бонусной операцииОбязательное при ответе
group
Meta
=
!=
Отдел сотрудникаОбязательное при ответе
Expand
id
UUID
=
!=
ID Бонусной операцииОбязательное при ответе
Только для чтения
meta
Meta
Метаданные Бонусной операцииОбязательное при ответе
moment
DateTime
=
!=
<
>
<=
>=
Время проведения бонусной операции
name
String(255)
=
!=
~
~=
=~
Наименование Бонусной операции
organization
Meta
=
!=
Метаданные юрлицаExpand
owner
Meta
=
!=
Владелец (Сотрудник)Expand
parentDocument
Meta
Метаданные связанного документа бонусной операцииExpand
shared
Boolean
=
!=
Общий доступОбязательное при ответе
transactionStatus
Enum
Статус бонусной операции. Возможные значения: WAIT_PROCESSING
, COMPLETED
, CANCELED
Только для чтения
transactionType
Enum
Тип бонусной операции. Возможные значения: EARNING
, SPENDING
Обязательное при ответе
Необходимо при создании
updated
DateTime
=
!=
<
>
<=
>=
Момент последнего обновления Бонусной операцииОбязательное при ответе
updatedBy
UID
=
!=
Автор последнего обновления бонусной операции в формате uid
(admin@admin
) (Атрибут используется только для фильтрации)
Атрибут "executionDate".
При создании или редактировании бонусной операции начисления данный атрибут позволяет указать дату обработки операции.
Если атрибут не указан, то операция будет обработана сразу, без задержки.
Для возможности указания даты обработки в будущем должна быть включена тарифная опция "Расширенная бонусная программа".
Получить Бонусные операции
Запрос на получение списка всех Бонусных операций для данной учетной записи.
Результат: Объект JSON, включающий в себя поля:
Название
Тип
Описание
meta
Meta
Метаданные о выдаче,
context
Meta
Метаданные о сотруднике, выполнившем запрос.
rows
Array(Object)
Массив JSON объектов, представляющих Бонусные операции.
Параметры
Параметр
Описание
limit
number
(optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000
.
offset
number
(optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
Получить Бонусные операции
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление списка Бонусных операций.
Показать Свернуть
{
"context" : {
"employee" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/employee" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
}
},
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/?limit=5" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/metadata" ,
"type" : "bonustransaction" ,
"mediaType" : "application/json" ,
"size" : 4 ,
"limit" : 5 ,
"offset" : 0
},
"rows" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/7c6ecd51-b738-11e8-727d-307300000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/metadata" ,
"type" : "bonustransaction" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#bonustransaction/edit?id=7c6ecd51-b738-11e8-727d-307300000028"
},
"id" : "7c6ecd51-b738-11e8-727d-307300000028" ,
"accountId" : "ba5d8717-d6e7-4741-9f2e-4e343a447fb9" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/4a980e02-b685-11e8-727d-30730000002b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#employee/edit?id=4a980e02-b685-11e8-727d-30730000002b"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/4427b6f1-b685-11e8-727d-307300000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2018-09-13 12:36:26" ,
"name" : "d00001" ,
"externalCode" : "htdrUVpciRX4kldKIN7VL0" ,
"moment" : "2018-09-13 12:36:26" ,
"applicable" : true ,
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9fea1d90-d488-4271-97bc-a9ad1b9fbcc0" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#company/edit?id=9fea1d90-d488-4271-97bc-a9ad1b9fbcc0"
}
},
"created" : "2018-09-13 12:36:26" ,
"bonusProgram" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/956f6ff7-718f-4849-be47-7509fdd18db9" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=956f6ff7-718f-4849-be47-7509fdd18db9"
}
},
"bonusValue" : 15 ,
"transactionType" : "EARNING" ,
"transactionStatus" : "COMPLETED" ,
"executionDate" : "2021-05-03 12:20:32" ,
"categoryType" : "REGULAR"
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/7c6ecd51-b738-11e8-727d-307300000029" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/metadata" ,
"type" : "bonustransaction" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#bonustransaction/edit?id=7c6ecd51-b738-11e8-727d-307300000029"
},
"id" : "7c6ecd51-b738-11e8-727d-307300000029" ,
"accountId" : "ba5d8717-d6e7-4741-9f2e-4e343a447fb9" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/4a980e02-b685-11e8-727d-30730000002b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#employee/edit?id=4a980e02-b685-11e8-727d-30730000002b"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/4427b6f1-b685-11e8-727d-307300000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2018-09-13 12:36:26" ,
"name" : "updated_name" ,
"externalCode" : "atdrUVpciRX4kljKIN7iL8" ,
"moment" : "2018-09-13 12:36:26" ,
"applicable" : true ,
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9fea1d90-d488-4271-97bc-a9ad1b9fbcc0" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#company/edit?id=9fea1d90-d488-4271-97bc-a9ad1b9fbcc0"
}
},
"created" : "2018-09-13 12:36:26" ,
"bonusProgram" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/956f6ff7-718f-4849-be47-7509fdd18db9" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=956f6ff7-718f-4849-be47-7509fdd18db9"
}
},
"bonusValue" : 1235 ,
"transactionType" : "EARNING" ,
"transactionStatus" : "COMPLETED" ,
"executionDate" : "2021-05-03 12:20:32" ,
"categoryType" : "REGULAR"
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/7c6ecd51-b738-11e8-727d-307300000038" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/metadata" ,
"type" : "bonustransaction" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#bonustransaction/edit?id=7c6ecd51-b738-11e8-727d-307300000038"
},
"id" : "7c6ecd51-b738-11e8-727d-307300000038" ,
"accountId" : "ba5d8717-d6e7-4741-9f2e-4e343a447fb9" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/4a980e02-b685-11e8-727d-30730000002b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#employee/edit?id=4a980e02-b685-11e8-727d-30730000002b"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/4427b6f1-b685-11e8-727d-307300000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2018-09-13 12:36:26" ,
"name" : "d00003" ,
"externalCode" : "ald88VpciRX4kkklIN7123" ,
"moment" : "2018-09-13 12:36:26" ,
"applicable" : true ,
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9fea1d90-d488-4271-97bc-a9ad1b9fbcc0" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#company/edit?id=9fea1d90-d488-4271-97bc-a9ad1b9fbcc0"
}
},
"created" : "2018-09-13 12:36:26" ,
"bonusProgram" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/956f6ff7-718f-4849-be47-7509fdd18db9" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=956f6ff7-718f-4849-be47-7509fdd18db9"
}
},
"bonusValue" : 100500 ,
"transactionType" : "SPENDING" ,
"transactionStatus" : "COMPLETED" ,
"executionDate" : "2021-05-03 12:20:32" ,
"categoryType" : "REGULAR"
}
]
}
Создать Бонусную операцию
Запрос на создание новой бонусной операции на данной учетной записи.
Обязательные для создания поля:
Название
Тип
Описание
agent
Meta
Метаданные Контрагента, связанного с бонусной операциейОбязательное при ответе
Expand
Необходимо при создании
bonusProgram
Meta
Метаданные Бонусной программыОбязательное при ответе
Expand
Необходимо при создании
transactionType
Enum
Тип бонусной операцииОбязательное при ответе
Необходимо при создании
Пример запроса на создание новой бонусной операции.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"name": "d00001",
"applicable": true,
"agent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/45457cb8-f473-4618-ab19-2294c328f4ba",
"type": "counterparty",
"mediaType": "application/json"
}
},
"bonusProgram": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/fc2666ba-5d39-4a60-8105-4b678180b059",
"type": "bonusprogram",
"mediaType": "application/json"
}
},
"parentDocument": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/retaildemand/0b0b7d56-2a44-4aa2-adc2-a49dadd61af0",
"type": "retaildemand",
"mediaType": "application/json"
}
},
"transactionType": "EARNING",
"bonusValue": 15
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданной бонусной операции.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/7c6ecd51-b738-11e8-727d-307300000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/metadata" ,
"type" : "bonustransaction" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#bonustransaction/edit?id=7c6ecd51-b738-11e8-727d-307300000028"
},
"id" : "7c6ecd51-b738-11e8-727d-307300000028" ,
"accountId" : "44245b3a-b685-11e8-727d-307300000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/4a980e02-b685-11e8-727d-30730000002b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#employee/edit?id=4a980e02-b685-11e8-727d-30730000002b"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/4427b6f1-b685-11e8-727d-307300000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2018-09-13 12:36:26" ,
"name" : "d000001" ,
"externalCode" : "htdrUVpciRX4kldKIN7VL0" ,
"moment" : "2018-09-13 12:36:00" ,
"applicable" : true ,
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/341a6b49-b688-11e8-727d-307300000012" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#company/edit?id=341a6b49-b688-11e8-727d-307300000012"
}
},
"created" : "2018-09-13 12:36:26" ,
"parentDocument" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/retaildemand/e182ab48-b726-11e8-727d-3073000000b4" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/retaildemand/metadata" ,
"type" : "retaildemand" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#retaildemand/edit?id=e182ab48-b726-11e8-727d-3073000000b4"
}
},
"bonusProgram" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/3cc6edd8-b688-11e8-727d-30730000001b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=3cc6edd8-b688-11e8-727d-30730000001b"
}
},
"bonusValue" : 15 ,
"transactionType" : "EARNING" ,
"transactionStatus" : "COMPLETED" ,
"executionDate" : "2018-09-13 12:36:26" ,
"categoryType" : "REGULAR"
}
Массовое создание и обновление Бонусных операций
Массовое создание и обновление Бонусных операций.
В теле запроса нужно передать массив, содержащий JSON представления Бонусных операций, которые вы хотите создать или обновить.
Обновляемые Бонусные операции должны содержать идентификатор в виде метаданных.
Пример создания и обновления нескольких Бонусных операций
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"name": "d00001",
"applicable": true,
"agent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9fea1d90-d488-4271-97bc-a9ad1b9fbcc0",
"type": "counterparty",
"mediaType": "application/json"
}
},
"bonusProgram": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/956f6ff7-718f-4849-be47-7509fdd18db9",
"type": "bonusprogram",
"mediaType": "application/json"
}
},
"transactionType": "EARNING",
"bonusValue": 15
},
{
"agent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9fea1d90-d488-4271-97bc-a9ad1b9fbcc0",
"type": "counterparty",
"mediaType": "application/json"
}
},
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/956f6ff7-718f-4849-be47-7509fdd18db9",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/metadata",
"type": "bonustransaction",
"mediaType": "application/json"
},
"name": "updated_name",
"bonusValue": 1235
},
{
"name": "d00003",
"applicable": true,
"agent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9fea1d90-d488-4271-97bc-a9ad1b9fbcc0",
"type": "counterparty",
"mediaType": "application/json"
}
},
"bonusProgram": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/956f6ff7-718f-4849-be47-7509fdd18db9",
"type": "bonusprogram",
"mediaType": "application/json"
}
},
"transactionType": "SPENDING",
"bonusValue": 100500
}
]'
Response 200 (application/json)
Успешный запрос. Результат - массив JSON представлений созданных и обновленных Бонусных операций.
Показать Свернуть
[
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/7c6ecd51-b738-11e8-727d-307300000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/metadata" ,
"type" : "bonustransaction" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#bonustransaction/edit?id=7c6ecd51-b738-11e8-727d-307300000028"
},
"id" : "7c6ecd51-b738-11e8-727d-307300000028" ,
"accountId" : "ba5d8717-d6e7-4741-9f2e-4e343a447fb9" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/4a980e02-b685-11e8-727d-30730000002b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#employee/edit?id=4a980e02-b685-11e8-727d-30730000002b"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/4427b6f1-b685-11e8-727d-307300000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2018-09-13 12:36:26" ,
"name" : "d00001" ,
"externalCode" : "htdrUVpciRX4kldKIN7VL0" ,
"moment" : "2018-09-13 12:36:26" ,
"applicable" : true ,
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9fea1d90-d488-4271-97bc-a9ad1b9fbcc0" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#company/edit?id=9fea1d90-d488-4271-97bc-a9ad1b9fbcc0"
}
},
"created" : "2018-09-13 12:36:26" ,
"bonusProgram" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/956f6ff7-718f-4849-be47-7509fdd18db9" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=956f6ff7-718f-4849-be47-7509fdd18db9"
}
},
"bonusValue" : 15 ,
"transactionType" : "EARNING" ,
"transactionStatus" : "COMPLETED" ,
"executionDate" : "2018-09-13 12:36:26" ,
"categoryType" : "REGULAR"
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/7c6ecd51-b738-11e8-727d-307300000029" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/metadata" ,
"type" : "bonustransaction" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#bonustransaction/edit?id=7c6ecd51-b738-11e8-727d-307300000029"
},
"id" : "7c6ecd51-b738-11e8-727d-307300000029" ,
"accountId" : "ba5d8717-d6e7-4741-9f2e-4e343a447fb9" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/4a980e02-b685-11e8-727d-30730000002b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#employee/edit?id=4a980e02-b685-11e8-727d-30730000002b"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/4427b6f1-b685-11e8-727d-307300000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2018-09-13 12:36:26" ,
"name" : "updated_name" ,
"externalCode" : "atdrUVpciRX4kljKIN7iL8" ,
"moment" : "2018-09-13 12:36:26" ,
"applicable" : true ,
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9fea1d90-d488-4271-97bc-a9ad1b9fbcc0" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#company/edit?id=9fea1d90-d488-4271-97bc-a9ad1b9fbcc0"
}
},
"created" : "2018-09-13 12:36:26" ,
"bonusProgram" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/956f6ff7-718f-4849-be47-7509fdd18db9" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=956f6ff7-718f-4849-be47-7509fdd18db9"
}
},
"bonusValue" : 1235 ,
"transactionType" : "EARNING" ,
"transactionStatus" : "COMPLETED" ,
"executionDate" : "2018-09-13 12:36:26" ,
"categoryType" : "REGULAR"
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/7c6ecd51-b738-11e8-727d-307300000038" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/metadata" ,
"type" : "bonustransaction" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#bonustransaction/edit?id=7c6ecd51-b738-11e8-727d-307300000038"
},
"id" : "7c6ecd51-b738-11e8-727d-307300000038" ,
"accountId" : "ba5d8717-d6e7-4741-9f2e-4e343a447fb9" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/4a980e02-b685-11e8-727d-30730000002b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#employee/edit?id=4a980e02-b685-11e8-727d-30730000002b"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/4427b6f1-b685-11e8-727d-307300000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2018-09-13 12:36:26" ,
"name" : "d00003" ,
"externalCode" : "ald88VpciRX4kkklIN7123" ,
"moment" : "2018-09-13 12:36:26" ,
"applicable" : true ,
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9fea1d90-d488-4271-97bc-a9ad1b9fbcc0" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#company/edit?id=9fea1d90-d488-4271-97bc-a9ad1b9fbcc0"
}
},
"created" : "2018-09-13 12:36:26" ,
"bonusProgram" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/956f6ff7-718f-4849-be47-7509fdd18db9" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=956f6ff7-718f-4849-be47-7509fdd18db9"
}
},
"bonusValue" : 100500 ,
"transactionType" : "SPENDING" ,
"transactionStatus" : "COMPLETED" ,
"executionDate" : "2018-09-13 12:36:26" ,
"categoryType" : "REGULAR"
}
]
Удалить Бонусную операцию
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Бонусной операции.
Запрос на удаление бонусной операции.
Показать Свернуть
curl -X DELETE
"https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешное удаление Бонусной операции.
Массовое удаление Бонусных операций
В теле запроса нужно передать массив, содержащий JSON метаданных Бонусных операций, которые вы хотите удалить.
Запрос на массовое удаление Бонусных операций.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/delete"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/7944ef04-f831-11e5-7a69-971500188b1",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/metadata",
"type": "bonustransaction",
"mediaType": "application/json"
}
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/7944ef04-f831-11e5-7a69-971500188b2",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/metadata",
"type": "bonustransaction",
"mediaType": "application/json"
}
}
]'
Успешный запрос. Результат - JSON информация об удалении Бонусных операций.
Показать Свернуть
[
{
"info" : "Сущность 'bonustransaction' с UUID: 7944ef04-f831-11e5-7a69-971500188b1 успешно удалена"
},
{
"info" : "Сущность 'bonustransaction' с UUID: 7944ef04-f831-11e5-7a69-971500188b2 успешно удалена"
}
]
Бонусная операция Получить Бонусную операцию
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Бонусной операции.
Запрос на получение бонусной операции с указанным id.
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление Бонусной операции с указанным id.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/7c6ecd51-b738-11e8-727d-307300000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/metadata" ,
"type" : "bonustransaction" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#bonustransaction/edit?id=7c6ecd51-b738-11e8-727d-307300000028"
},
"id" : "7c6ecd51-b738-11e8-727d-307300000028" ,
"accountId" : "44245b3a-b685-11e8-727d-307300000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/4a980e02-b685-11e8-727d-30730000002b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#employee/edit?id=4a980e02-b685-11e8-727d-30730000002b"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/4427b6f1-b685-11e8-727d-307300000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2018-09-13 12:36:26" ,
"name" : "d000013" ,
"externalCode" : "htdrUVpciRX4kldKIN7VL0" ,
"moment" : "2018-09-13 12:36:00" ,
"applicable" : true ,
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/341a6b49-b688-11e8-727d-307300000012" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#company/edit?id=341a6b49-b688-11e8-727d-307300000012"
}
},
"created" : "2018-09-13 12:36:26" ,
"parentDocument" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/retaildemand/e182ab48-b726-11e8-727d-3073000000b4" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/retaildemand/metadata" ,
"type" : "retaildemand" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#retaildemand/edit?id=e182ab48-b726-11e8-727d-3073000000b4"
}
},
"bonusProgram" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/3cc6edd8-b688-11e8-727d-30730000001b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=3cc6edd8-b688-11e8-727d-30730000001b"
}
},
"bonusValue" : 15 ,
"transactionType" : "EARNING" ,
"transactionStatus" : "COMPLETED" ,
"executionDate" : "2018-09-13 12:36:26" ,
"categoryType" : "REGULAR"
}
Изменить Бонусную операцию
Запрос на изменение объекта, представляющего собой бонусную операцию. Невозможно изменение типа бонусной операции.
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Бонусной операции.
Пример запроса на обновление Бонусной операции.
Показать Свернуть
curl -X PUT
"https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"bonusValue": 15524
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление обновленной Бонусной операции.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/d8dda7b8-b76d-11e8-727d-3073000000a2" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonustransaction/metadata" ,
"type" : "bonustransaction" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#bonustransaction/edit?id=d8dda7b8-b76d-11e8-727d-3073000000a2"
},
"id" : "d8dda7b8-b76d-11e8-727d-3073000000a2" ,
"accountId" : "44245b3a-b685-11e8-727d-307300000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/4a980e02-b685-11e8-727d-30730000002b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#employee/edit?id=4a980e02-b685-11e8-727d-30730000002b"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/4427b6f1-b685-11e8-727d-307300000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2018-09-14 10:19:54" ,
"name" : "name_change" ,
"externalCode" : "dzmLEueIjUHccIa6GP6UX2" ,
"moment" : "2018-09-13 18:58:00" ,
"applicable" : true ,
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/4ac8d7ea-b685-11e8-727d-307300000056" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#company/edit?id=4ac8d7ea-b685-11e8-727d-307300000056"
}
},
"created" : "2018-09-13 18:58:25" ,
"parentDocument" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/retaildemand/90f4f8df-b76b-11e8-727d-307300000090" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/retaildemand/metadata" ,
"type" : "retaildemand" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#retaildemand/edit?id=90f4f8df-b76b-11e8-727d-307300000090"
}
},
"bonusProgram" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/3cc6edd8-b688-11e8-727d-30730000001b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=3cc6edd8-b688-11e8-727d-30730000001b"
}
},
"bonusValue" : 15524 ,
"transactionType" : "SPENDING" ,
"transactionStatus" : "COMPLETED" ,
"executionDate" : "2018-09-13 12:36:26" ,
"categoryType" : "REGULAR"
}
Бонусная программа Бонусные программы
Кодом сущности для Бонусных программ в составе JSON API является ключевое слово bonusprogram . Перед работой со скидками настоятельно рекомендуем вам прочитать вот эту статью на портале поддержки МоегоСклада.
Атрибуты сущности
Название
Тип
Описание
accountId
UUID
ID учетной записиОбязательное при ответе
Только для чтения
active
Boolean
Индикатор, является ли бонусная программа активной на данный моментОбязательное при ответе
agentTags
Array(String)
Тэги контрагентов, к которым применяется бонусная программа. В случае пустого значения контрагентов в результате выводится пустой массив.Обязательное при ответе
allAgents
Boolean
Индикатор, действует ли скидка на всех контрагентов (см. Скидки )Обязательное при ответе
allProducts
Boolean
Индикатор, действует ли бонусная программа на все товары (всегда true
, см. Скидки )Обязательное при ответе
earnRateRoublesToPoint
Int
Курс начисления
earnWhileRedeeming
Boolean
Разрешить одновременное начисление и списание бонусов. Если true
- бонусы будут начислены на денежную часть покупки, даже при частичной оплате покупки баллами.Обязательное при ответе
id
UUID
ID Бонусной программыОбязательное при ответе
Только для чтения
maxPaidRatePercents
Int
Максимальный процент оплаты баллами
meta
Meta
Метаданные Бонусной программыОбязательное при ответе
name
String(255)
Наименование Бонусной программы
postponedBonusesDelayDays
Int
Баллы начисляются через [N] днейТарифная опция «Расширенная бонусная программа»
spendRatePointsToRouble
Int
Курс списания
welcomeBonusesEnabled
Boolean
Возможность начисления приветственных балловОбязательное при ответе
welcomeBonusesMode
Enum
Условие начисления приветственных баллов. Не может быть пустым, если welcomeBonusesEnabled
= true. Подробнее тут
welcomeBonusesValue
Int
Количество приветственных баллов, начисляемых участникам бонусной программы. Не может быть отрицательным. Не может быть пустым, если welcomeBonusesEnabled
= true
Условия бонусных баллов
Название
Описание
REGISTRATION
Приветственные баллы начисляются участиникам после регистрации в бонусной программе.
FIRST_PURCHASE
Приветственные баллы начисляются участиникам бонусной программы после совершения первой покупки.
Получить все Бонусные программы
Запрос на получение всех бонусных программ учетной записи.
Результат: Объект JSON, включающий в себя поля:
Название
Тип
Описание
meta
Meta
Метаданные о выдаче,
context
Meta
Метаданные о сотруднике, выполнившем запрос.
rows
Array(Object)
Массив JSON объектов, представляющих Бонусные программы
Параметры
Параметр
Описание
limit
number
(optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000
.
offset
number
(optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
Получить все Бонусные программы
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - список всех бонусных программ для учетной записи.
Показать Свернуть
{
"context" : {
"employee" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/employee" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
}
},
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"size" : 2 ,
"limit" : 1000 ,
"offset" : 0
},
"rows" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/1223d051-ba76-11e8-3353-995e0000005a" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=1223d051-ba76-11e8-3353-995e0000005a"
},
"id" : "1223d051-ba76-11e8-3353-995e0000005a" ,
"accountId" : "dbb8cfc1-cbfa-11e1-6dfb-889ffa6f49fd" ,
"name" : "test" ,
"active" : true ,
"allAgents" : true ,
"agentTags" : [
"группа агентов"
],
"earnRateRoublesToPoint" : 1 ,
"spendRatePointsToRouble" : 1 ,
"maxPaidRatePercents" : 100 ,
"welcomeBonusesEnabled" : false ,
"postponedBonusesDelayDays" : 14 ,
"earnWhileRedeeming" : true
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/87c69fae-c1ad-4700-a852-f21939470760" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=1223d051-ba76-11e8-3353-995e0000005a"
},
"id" : "87c69fae-c1ad-4700-a852-f21939470760" ,
"accountId" : "dbb8cfc1-cbfa-11e1-6dfb-889ffa6f49fd" ,
"name" : "bonusprogram" ,
"active" : false ,
"allAgents" : true ,
"agentTags" : [
"группа агентов"
],
"earnRateRoublesToPoint" : 7 ,
"spendRatePointsToRouble" : 4 ,
"maxPaidRatePercents" : 50 ,
"welcomeBonusesEnabled" : true ,
"welcomeBonusesValue" : 100 ,
"welcomeBonusesMode" : "REGISTRATION" ,
"postponedBonusesDelayDays" : 7 ,
"earnWhileRedeeming" : true
}
]
}
Бонусная программа Создать Бонусную программу
Запрос на создание новой бонусной программы. Обязательные поля для заполнения: name (имя скидки), active (активна ли скидка), allProducts (действует ли скидка на все товары), allAgents (действует ли скидка на всех контрагентов) earnRateRoublesToPoint (курс начисления), spendRatePointsToRouble (курс списания), maxPaidRatePercents (максимальный процент оплаты баллами)
Пример создания новой бонусной программы
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"name": "bonusprogram",
"active": true,
"allProducts": true,
"allAgents": false,
"agentTags": ["tag1", "tag2"],
"earnRateRoublesToPoint": 7,
"spendRatePointsToRouble": 4,
"maxPaidRatePercents": 50,
"postponedBonusesDelayDays": 7,
"earnWhileRedeeming": false
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданной бонусной программы.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/87c69fae-c1ad-4700-a852-f21939470760" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=1223d051-ba76-11e8-3353-995e0000005a"
},
"id" : "87c69fae-c1ad-4700-a852-f21939470760" ,
"accountId" : "dbb8cfc1-cbfa-11e1-6dfb-889ffa6f49fd" ,
"name" : "bonusprogram" ,
"active" : false ,
"agentTags" : [ "tag1" , "tag2" ],
"earnRateRoublesToPoint" : 7 ,
"spendRatePointsToRouble" : 4 ,
"maxPaidRatePercents" : 50 ,
"welcomeBonusesEnabled" : false ,
"postponedBonusesDelayDays" : 7 ,
"earnWhileRedeeming" : false
}
Изменить Бонусную программу
Параметры
Параметр
Описание
id
string
(required) Example: 87c69fae-c1ad-4700-a852-f21939470760 id Бонусной программы.
Запрос на изменение бонусной программы. В теле запроса необходимо передать поля, которые будут изменены
Пример изменения бонусной программы
Показать Свернуть
curl -X PUT
"https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/87c69fae-c1ad-4700-a852-f21939470760"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"name": "updatedName",
"active": true,
"agentTags": ["tag2"]
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление измененной бонусной программы.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/87c69fae-c1ad-4700-a852-f21939470760" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=87c69fae-c1ad-4700-a852-f21939470760"
},
"id" : "87c69fae-c1ad-4700-a852-f21939470760" ,
"accountId" : "dbb8cfc1-cbfa-11e1-6dfb-889ffa6f49fd" ,
"name" : "bonusprogram" ,
"active" : true ,
"agentTags" : [ "tag2" ],
"earnRateRoublesToPoint" : 7 ,
"spendRatePointsToRouble" : 4 ,
"maxPaidRatePercents" : 50 ,
"welcomeBonusesEnabled" : false ,
"earnWhileRedeeming" : true
}
Получить Бонусную программу
Параметры
Параметр
Описание
id
string
(required) Example: 87c69fae-c1ad-4700-a852-f21939470760 id Бонусной программы.
Запрос на получение отдельной бонусной программы с указанным id
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/87c69fae-c1ad-4700-a852-f21939470760"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление Бонусной программы с указанным id.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/87c69fae-c1ad-4700-a852-f21939470760" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata" ,
"type" : "bonusprogram" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#discount/edit?id=1223d051-ba76-11e8-3353-995e0000005a"
},
"id" : "87c69fae-c1ad-4700-a852-f21939470760" ,
"accountId" : "dbb8cfc1-cbfa-11e1-6dfb-889ffa6f49fd" ,
"name" : "bonusprogram" ,
"active" : false ,
"agentTags" : [
"группа агентов"
],
"earnRateRoublesToPoint" : 7 ,
"spendRatePointsToRouble" : 4 ,
"maxPaidRatePercents" : 50 ,
"welcomeBonusesEnabled" : false ,
"postponedBonusesDelayDays" : 7 ,
"earnWhileRedeeming" : true
}
Удалить Бонусную программу
Параметры
Параметр
Описание
id
string
(required) Example: 87c69fae-c1ad-4700-a852-f21939470760 id Бонусной программы.
Запрос на удаление бонусной программы
Показать Свернуть
curl -X DELETE
"https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/87c69fae-c1ad-4700-a852-f21939470760"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешное удаление Бонусной программы
Массовое удаление Бонусных программ
В теле запроса нужно передать массив, содержащий JSON метаданных Бонусных программ, которые вы хотите удалить.
Запрос на массовое удаление Бонусных программ.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/delete"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/7944ef04-f831-11e5-7a69-971500188b1",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata",
"type": "bonusprogram",
"mediaType": "application/json"
}
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/7944ef04-f831-11e5-7a69-971500188b2",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/bonusprogram/metadata",
"type": "bonusprogram",
"mediaType": "application/json"
}
}
]'
Успешный запрос. Результат - JSON информация об удалении Бонусных программ.
Показать Свернуть
[
{
"info" : "Сущность 'bonusprogram' с UUID: 7944ef04-f831-11e5-7a69-971500188b1 успешно удалена"
},
{
"info" : "Сущность 'bonusprogram' с UUID: 7944ef04-f831-11e5-7a69-971500188b2 успешно удалена"
}
]
Валюта
Средствами JSON API можно запрашивать списки валют и сведения по отдельным валютам, а также создавать новые и обновлять сведения по уже существующим валютам. Кодом сущности для валют в составе JSON API является ключевое слово currency . Больше о валютах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по
этой ссылке .
По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search
. Подробнее можно узнать по ссылке . Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.
Поиск среди объектов валют на соответствие поисковой строке будет осуществлен по следующим полям:
по краткому наименованию Валюты name
Атрибуты Сущности
Название
Тип
Фильтрация
Описание
archived
Boolean
=
!=
Добавлена ли Валюта в архивОбязательное при ответе
code
String(255)
=
!=
~
~=
=~
Цифровой код ВалютыОбязательное при ответе
Необходимо при создании
default
Boolean
=
!=
Является ли валюта валютой учетаОбязательное при ответе
Только для чтения
fullName
String(255)
=
!=
~
~=
=~
Полное наименование Валюты
id
UUID
=
!=
ID ВалютыОбязательное при ответе
Только для чтения
indirect
Boolean
Признак обратного курса ВалютыОбязательное при ответе
isoCode
String(255)
=
!=
~
~=
=~
Буквенный код ВалютыОбязательное при ответе
Необходимо при создании
majorUnit
Object
Формы единиц целой части Валюты. Подробнее тут Обязательное при ответе
margin
Double
Наценка при автоматическом обновлении курсаОбязательное при ответе
meta
Meta
Метаданные ВалютыОбязательное при ответе
minorUnit
Object
Формы единиц дробной части Валюты. Подробнее тут Обязательное при ответе
multiplicity
Int
=
!=
<
>
<=
>=
Кратность курса ВалютыОбязательное при ответе
name
String(255)
=
!=
~
~=
=~
Краткое наименование ВалютыОбязательное при ответе
Необходимо при создании
rate
Double
Курс ВалютыОбязательное при ответе
rateUpdateType
String(255)
Способ обновления курса Валюты. auto или manual Обязательное при ответе
Только для чтения
system
Boolean
Основана ли валюта на валюте из системного справочникаТолько для чтения
Поля majorUnit и minorUnit содержат в себе следующие атрибуты:
Атрибут
Описание
gender
Грамматический род единицы валюты (допустимые значения masculine
- мужской, feminine
- женский)
s1
Форма единицы, используемая при числительном 1
s2
Форма единицы, используемая при числительном 2
s5
Форма единицы, используемая при числительном 5
В JSON API валюты в основном представлены в составе сущностей в формате Метаданные . Для того, чтобы раскрыть их в составе другого объекта нужно воспользоваться параметром expand
Получить Валюты
Результат успешного запроса - JSON представление списка валют с перечисленными полями:
Поле
Описание
meta
Метаданные о выдаче
context
Метаданные о сотруднике, выполнившем запрос
rows
Массив JSON объектов, представляющих собой валюты
Параметры
Параметр
Описание
limit
number
(optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000
.
offset
number
(optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
Запрос на получение списка всех валют на данной учетной записи.
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/currency/"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление списка Валют.
Показать Свернуть
{
"context" : {
"employee" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/employee" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
}
},
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"size" : 2 ,
"limit" : 1000 ,
"offset" : 0
},
"rows" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#currency/edit?id=6314188d-2c7f-11e6-8a84-bae500000055"
},
"id" : "6314188d-2c7f-11e6-8a84-bae500000055" ,
"system" : false ,
"name" : "руб" ,
"fullName" : "Рубль" ,
"rate" : 1.0 ,
"multiplicity" : 1 ,
"indirect" : false ,
"rateUpdateType" : "manual" ,
"code" : "643" ,
"isoCode" : "RUB" ,
"majorUnit" : {
"gender" : "masculine" ,
"s1" : "рубль" ,
"s2" : "рубля" ,
"s5" : "рублей"
},
"minorUnit" : {
"gender" : "feminine" ,
"s1" : "копейка" ,
"s2" : "копейки" ,
"s5" : "копеек"
},
"archived" : false ,
"default" : true
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/dc5f76ae-2c89-11e6-8a84-bae50000003f" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#currency/edit?id=dc5f76ae-2c89-11e6-8a84-bae50000003f"
},
"id" : "dc5f76ae-2c89-11e6-8a84-bae50000003f" ,
"system" : true ,
"name" : "доллар" ,
"fullName" : "Доллар США" ,
"rate" : 63.0 ,
"multiplicity" : 1 ,
"indirect" : false ,
"rateUpdateType" : "manual" ,
"code" : "840" ,
"isoCode" : "USD" ,
"majorUnit" : {
"gender" : "masculine" ,
"s1" : "доллар" ,
"s2" : "доллара" ,
"s5" : "долларов"
},
"minorUnit" : {
"gender" : "masculine" ,
"s1" : "цент" ,
"s2" : "цента" ,
"s5" : "центов"
},
"archived" : false ,
"default" : false
}
]
}
Создать новую Валюту
Обязательные поля для создания валюты: name , code и isoCode .
В теле запроса нельзя указать курс валюты (rate ) равным нулю.
Запрос на создание новой валюты.
Показать Свернуть
curl -X POST
https://api.moysklad.ru/api/remap/1.2/entity/currency/
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H 'Content-Type: application/json'
-d '{
"name": "доллар",
"rate": 63,
"code" : "840",
"isoCode": "USD"
}
'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданной Валюты.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/dc5f76ae-2c89-11e6-8a84-bae50000003f" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#currency/edit?id=dc5f76ae-2c89-11e6-8a84-bae50000003f"
},
"id" : "dc5f76ae-2c89-11e6-8a84-bae50000003f" ,
"system" : false ,
"name" : "доллар" ,
"rate" : 63.0 ,
"multiplicity" : 1 ,
"indirect" : false ,
"rateUpdateType" : "manual" ,
"code" : "840" ,
"isoCode" : "USD" ,
"majorUnit" : {
"gender" : "masculine"
},
"minorUnit" : {
"gender" : "masculine"
},
"archived" : false ,
"default" : false
}
Создать системную валюту
Системной является валюта, для которой в МоемСкладе уже есть все параметры и возможность автоматического обновления курса.
Для добавления системной валюты необходимо указать system =true и один из параметров code или isoCode .
Дополнительно можно указать rateUpdateType и margin
Запрос на создание системной валюты с автоматическим обновлением курса по ISO коду.
Показать Свернуть
curl -X POST
https://api.moysklad.ru/api/remap/1.2/entity/currency/
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H 'Content-Type: application/json'
-d '{
"system": true,
"isoCode": "EUR"
}
'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданной Валюты.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/03f1855b-43d7-11ec-ac13-000400000050" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#currency/edit?id=03f1855b-43d7-11ec-ac13-000400000050"
},
"id" : "03f1855b-43d7-11ec-ac13-000400000050" ,
"system" : true ,
"name" : "евро" ,
"fullName" : "Евро" ,
"rate" : 1.0 ,
"multiplicity" : 1 ,
"indirect" : false ,
"rateUpdateType" : "auto" ,
"code" : "978" ,
"isoCode" : "EUR" ,
"majorUnit" : {
"gender" : "masculine" ,
"s1" : "евро" ,
"s2" : "евро" ,
"s5" : "евро"
},
"minorUnit" : {
"gender" : "masculine" ,
"s1" : "цент" ,
"s2" : "цента" ,
"s5" : "центов"
},
"archived" : false ,
"default" : false
}
Запрос на создание системной валюты с ручным обновлением курса по цифровому коду.
Показать Свернуть
curl -X POST
https://api.moysklad.ru/api/remap/1.2/entity/currency/
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H 'Content-Type: application/json'
-d '{
"system": true,
"code": "978",
"rateUpdateType": "manual"
}
'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданной Валюты.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/03f1855b-43d7-11ec-ac13-000400000050" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#currency/edit?id=03f1855b-43d7-11ec-ac13-000400000050"
},
"id" : "03f1855b-43d7-11ec-ac13-000400000050" ,
"system" : true ,
"name" : "евро" ,
"fullName" : "Евро" ,
"rate" : 1.0 ,
"multiplicity" : 1 ,
"indirect" : false ,
"rateUpdateType" : "manual" ,
"code" : "978" ,
"isoCode" : "EUR" ,
"majorUnit" : {
"gender" : "masculine" ,
"s1" : "евро" ,
"s2" : "евро" ,
"s5" : "евро"
},
"minorUnit" : {
"gender" : "masculine" ,
"s1" : "цент" ,
"s2" : "цента" ,
"s5" : "центов"
},
"archived" : false ,
"default" : false
}
Массовое создание и обновление Валют
Массовое создание и обновление Валют.
В теле запроса нужно передать массив, содержащий JSON представления Валют, которые вы хотите создать или обновить.
Обновляемые Валюты должны содержать идентификатор в виде метаданных.
Массовое создание и обновление Валют
Показать Свернуть
curl -X POST
https://api.moysklad.ru/api/remap/1.2/entity/currency/
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H 'Content-Type: application/json'
-d '[
{
"name": "доллар",
"rate": 63,
"code" : "840",
"isoCode": "USD"
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/currency/dc5f76ae-2c89-11e6-8a84-bae50000003f",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
},
"name": "долл",
"rate": 66,
"code" : "dollarusd",
"isoCode": "USD"
}
]
'
Response 200 (application/json)
Успешный запрос. Результат - массив JSON представлений созданных и обновленных Валют.
Показать Свернуть
[
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/dc5f76ae-2c89-11e6-8a84-bae50000003f" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#currency/edit?id=dc5f76ae-2c89-11e6-8a84-bae50000003f"
},
"id" : "dc5f76ae-2c89-11e6-8a84-bae50000003f" ,
"system" : false ,
"name" : "доллар" ,
"rate" : 63.0 ,
"multiplicity" : 1 ,
"indirect" : false ,
"rateUpdateType" : "manual" ,
"code" : "840" ,
"isoCode" : "USD" ,
"majorUnit" : {
"gender" : "masculine"
},
"minorUnit" : {
"gender" : "masculine"
},
"archived" : false ,
"default" : false
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/dc5f76ae-2c89-11e6-8a84-bae50000003f" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#currency/edit?id=dc5f76ae-2c89-11e6-8a84-bae50000003f"
},
"id" : "dc5f76ae-2c89-11e6-8a84-bae50000003f" ,
"system" : false ,
"name" : "долл" ,
"rate" : 66.0 ,
"multiplicity" : 1 ,
"indirect" : false ,
"rateUpdateType" : "manual" ,
"code" : "dollarusd" ,
"isoCode" : "USD" ,
"majorUnit" : {
"gender" : "masculine"
},
"minorUnit" : {
"gender" : "masculine"
},
"archived" : false ,
"default" : false
}
]
Удалить Валюту
Запрос на удаление Валюты с указанным id. Валюту учета удалить нельзя.
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Валюты
Запрос на удаление Валюты
Показать Свернуть
curl -X DELETE
"https://api.moysklad.ru/api/remap/1.2/entity/currency/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешное удаление Валюты
Массовое удаление Валют
В теле запроса нужно передать массив, содержащий JSON метаданных Валют, которые вы хотите удалить.
Запрос на массовое удаление Валют
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/currency/delete"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/currency/7944ef04-f831-11e5-7a69-971500188b1",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/currency/7944ef04-f831-11e5-7a69-971500188b2",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
]'
Успешный запрос. Результат - JSON информация об удалении Валют.
Показать Свернуть
[
{
"info" : "Сущность 'currency' с UUID: 7944ef04-f831-11e5-7a69-971500188b1 успешно удалена"
},
{
"info" : "Сущность 'currency' с UUID: 7944ef04-f831-11e5-7a69-971500188b2 успешно удалена"
}
]
Валюта Получить Валюту
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Валюты
Получить Валюту
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/currency/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление запрошенной Валюты.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/6314188d-2c7f-11e6-8a84-bae500000055" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#currency/edit?id=6314188d-2c7f-11e6-8a84-bae500000055"
},
"id" : "6314188d-2c7f-11e6-8a84-bae500000055" ,
"system" : false ,
"name" : "руб" ,
"fullName" : "Рубль" ,
"rate" : 1.0 ,
"multiplicity" : 1 ,
"indirect" : false ,
"rateUpdateType" : "manual" ,
"code" : "643" ,
"isoCode" : "RUB" ,
"majorUnit" : {
"gender" : "masculine" ,
"s1" : "рубль" ,
"s2" : "рубля" ,
"s5" : "рублей"
},
"minorUnit" : {
"gender" : "feminine" ,
"s1" : "копейка" ,
"s2" : "копейки" ,
"s5" : "копеек"
},
"archived" : false ,
"default" : true
}
Изменить Валюту
Запрос на обновление существующей валюты.
В теле запроса нельзя указать курс валюты (rate ) равным нулю,
а также пустые поля name , code , isoCode .
Нельзя изменять значения полей name , fullName , code , isoCode , majorUnit , minorUnit
для валют, основанных на системном справочнике валют. Нельзя изменять курс валюты учета. Нельзя изменить курс валюты с автоматическим обновлением.
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 - id Валюты
Изменить Валюту
Показать Свернуть
curl -X PUT
"https://api.moysklad.ru/api/remap/1.2/entity/currency/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-d '{
"name": "долл",
"rate": 66,
"code" : "dollarusd",
"isoCode": "USD"
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление обновленной Валюты.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/dc5f76ae-2c89-11e6-8a84-bae50000003f" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json" ,
"uuidHref" : "https://online.moysklad.ru/app/#currency/edit?id=dc5f76ae-2c89-11e6-8a84-bae50000003f"
},
"id" : "dc5f76ae-2c89-11e6-8a84-bae50000003f" ,
"system" : false ,
"name" : "долл" ,
"rate" : 66.0 ,
"multiplicity" : 1 ,
"indirect" : false ,
"rateUpdateType" : "manual" ,
"code" : "dollarusd" ,
"isoCode" : "USD" ,
"majorUnit" : {
"gender" : "masculine"
},
"minorUnit" : {
"gender" : "masculine"
},
"archived" : false ,
"default" : false
}
Вебхуки
С помощью средств JSON API можно работать с вебхуками.
Вебхук — это механизм отправки уведомлений. Уведомление отправляется при наступлении в системе изменения, которое отслеживает вебхук. Например, если подключить вебхук на товары, при изменении наименования товара, вы получаете уведомление со ссылкой на измененный товар. Подробнее о работе с вебхуками читайте Вебхуки .
С помощью API версии 1.2 можно просматривать, изменять, удалять вебхуки, созданные только с помощью API версии 1.2.
Набор возможностей также зависит от вашего тарифа. При бесплатном тарифе отправка вебхуков не производится, нельзя создать новый или изменить существующий вебхук.
Управление вебхуками доступно администратору аккаунта и решениям со специальными правами.
Подробнее про работу решений с вебхуками см. в документации для вендоров .
Пример вебхука
Пример того, в каком виде будут передаваться данные:
POST https://example.com/webhook_path?requestId=640569eb-522d-427a-b07e-fa757c5d4217
Показать Свернуть
{
"auditContext" : {
"meta" : {
"type" : "audit" ,
"href" : "https://api.moysklad.ru/api/remap/1.2/audit/75fe3b73-db16-11eb-c0a8-800d00000004"
},
"moment" : "2021-07-21 15:51:16" ,
"uid" : "test@test"
},
"events" : [
{
"meta" : {
"type" : "product" ,
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/product/75c896d0-db16-11eb-c0a8-800d00000002"
},
"updatedFields" : [ "name" , "description" ],
"action" : "UPDATE" ,
"accountId" : "9171a53c-b719-11eb-c0a8-800d00000001"
}
]
}
Атрибуты сущности отправляемого вебхука
Название
Тип
Описание
events
Object
Данные о событии, вызвавшем срабатывание вебхукаОбязательное при ответе
auditContext
Object
Контекст аудита, соответствующий событию вебхука
Атрибуты сущности событие
Название
Тип
Описание
meta
Meta
Метаданные измененной сущностиОбязательное при ответе
action
Enum
Действие, которое вызвало срабатывание вебхука. Возможные значения: [CREATE, UPDATE, DELETE, PROCESSED]
Обязательное при ответе
accountId
UUID
ID учетной записи КассираОбязательное при ответе
updatedFields
Array(String)
Поля сущности, измененные пользователем
Для отображения атрибута сущности событие updatedFields нужно, чтобы вебхук имел diffType=FIELDS и action=UPDATE
Атрибуты сущности контекст аудита
Название
Тип
Описание
meta
Meta
Метаданные контекста аудитаОбязательное при ответе
uid
String(255)
Логин СотрудникаОбязательное при ответе
Только для чтения
moment
DateTime
Дата измененияОбязательное при ответе
Только для чтения
В массиве events может быть несколько объектов. Параметр запроса requestId - идентификатор уведомления.
В ответ на наш запрос мы ожидаем получить ответ с HTTP статусом 200 или 204 в течение 1500 миллисекунд.
При невалидном ответе от клиентского приложения наша система осуществляет еще 3 попытки отправки.
Данные попытки осуществляются последовательно, без таймаутов между ними. Если все попытки закончились неудачно или истекло время ожидания ответа -
данное уведомление считается неотправленным и в дальнейшем удаляется, в клиентское приложение оно отправлено не будет,
т.к. проблема на стороне клиентского приложения.
Чтобы попытки отправки уведомления не заканчивались неудачей из-за истечения времени ожидания ответа сервером, рекомендуется разделить прием вебхуков и их обработку.
Понять, что уведомление о событии было отправлено повторно, можно по параметру запроса requestId - при повторной отправке уведомления идентификатор останется прежним.
С помощью API версии 1.2 можно просматривать, изменять, удалять вебхуки созданные только с помощью API версии 1.2.
Заголовок временного отключения X-Lognex-WebHook-DisableByPrefix через API
Через JSON API при запросах можно выборочно отключить часть уведомлений вебхуков в контексте данного запроса. Для этого нужно указать заголовок X-Lognex-WebHook-DisableByPrefix
.
Этот заголовок позволяет указать набор префиксов url-адресов. Если адрес вебхука содержит один из указанных префиксов, то этот вебхук не будет инициирован по результатам запроса.
Префикс должен содержать протокол и доменное имя целиком: заголовки вида X-Lognex-WebHook-DisableByPrefix: https://
или X-Lognex-WebHook-DisableByPrefix: https://some_url
будут отклонены с ошибкой, заголовки вида X-Lognex-WebHook-DisableByPrefix: https://some_url.com
или X-Lognex-WebHook-DisableByPrefix: https://some_url.com/some_path
считаются валидными.
Чтобы указать не один префикс, а набор, нужно указать несколько заголовков X-Lognex-WebHook-DisableByPrefix
в запросе. Перечисление префиксов url-адресов через запятую в рамках одного заголовка не поддерживается.
Заголовок временного отключения X-Lognex-WebHook-Disable через API
Данный функционал в будущем будет удален.
Через JSON API или POS API при запросах можно отключить все уведомления вебхуков в контексте данного запроса. Для этого нужно указать заголовок X-Lognex-WebHook-Disable
с произвольным значением.
Отключать уведомления вебхуков следует только в случае крайней необходимости, так как это может повлиять на работу интеграций или отключить отправку критически важных уведомлений.
SSL Handshake
Если на адресе получателя используется SSL сертификат, то необходимо удостовериться, что сертификат имеет корректные Certification Paths. Проверить сертификат можно в сервисе https://www.ssllabs.com/ssltest/index.html
Атрибуты сущности
Название
Тип
Описание
accountId
UUID
ID учетной записиОбязательное при ответе
action
Enum
Действие, которое отслеживается вебхуком. Возможные значения: [CREATE, UPDATE, DELETE, PROCESSED]
. Задать значение PROCESSED
возможно только для асинхронных задач Обязательное при ответе
Необходимо при создании
authorApplication
Meta
Метаданные Решения, создавшего вебхук
diffType
Enum
Режим отображения изменения сущности. Указывается только для действия UPDATE
. Возможные значения: [NONE, FIELDS]
(по умолчанию NONE
)
enabled
Boolean
Флажок состояние вебхука (включен / отключен)Обязательное при ответе
entityType
String(255)
Тип сущности, к которой привязан вебхукОбязательное при ответе
Необходимо при создании
id
UUID
ID вебхукаОбязательное при ответе
meta
Meta
Метаданные вебхукаОбязательное при ответе
method
Enum
HTTP метод, с которым будет происходить запрос. Возможные значения: POST
Обязательное при ответе
url
URL
URL, по которому будет происходить запрос. Допустимая длина до 255 символовОбязательное при ответе
Необходимо при создании
Доступные типы сущностей
Создание вебхуков доступно для всех типов сущностей и документов, кроме следующих:
Получить список вебхуков
Запрос на получение всех вебхуков на данной учетной записи.
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/webhook"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление списка вебхуков.
Показать Свернуть
{
"context" : {
"employee" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/employee" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
}
},
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata" ,
"type" : "webhook" ,
"mediaType" : "application/json" ,
"size" : 3 ,
"limit" : 1000 ,
"offset" : 0
},
"rows" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/aec51463-bbd2-11e6-8a84-bae500000003" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata" ,
"type" : "webhook" ,
"mediaType" : "application/json"
},
"authorApplication" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/application/9e1ad712-3e45-4679-8896-7159973a8ef5" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/application/metadata" ,
"type" : "application" ,
"mediaType" : "application/json"
}
},
"id" : "aec51463-bbd2-11e6-8a84-bae500000003" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"entityType" : "demand" ,
"url" : "http://www.example.com" ,
"method" : "POST" ,
"enabled" : true ,
"action" : "CREATE"
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/d08f9217-bbd2-11e6-8a84-bae500000004" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata" ,
"type" : "webhook" ,
"mediaType" : "application/json"
},
"id" : "d08f9217-bbd2-11e6-8a84-bae500000004" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"entityType" : "supply" ,
"url" : "http://www.example.com" ,
"method" : "POST" ,
"enabled" : true ,
"action" : "CREATE"
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/d946c7ff-bbd2-11e6-8a84-bae500000005" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata" ,
"type" : "webhook" ,
"mediaType" : "application/json"
},
"id" : "d946c7ff-bbd2-11e6-8a84-bae500000005" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"entityType" : "cashin" ,
"url" : "http://www.example.com" ,
"method" : "POST" ,
"enabled" : true ,
"action" : "UPDATE" ,
"diffType" : "NONE"
}
]
}
Создать вебхук
Пример запроса на создание нового вебхука. Убедитесь, что создаете еще не существующий вебхук:
сочетание entityType , action , url должно быть уникальным. Всего на одно уникальное сочетание entityType ,
action может быть создано не более 5 вебхуков с разными url для пользователей и не более 1 для решения.
Пример запроса на создание нового вебхука.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/webhook"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"url": "http://www.example.com",
"action": "CREATE",
"entityType": "supply"
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданного вебхука.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/d08f9217-bbd2-11e6-8a84-bae500000004" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata" ,
"type" : "webhook" ,
"mediaType" : "application/json"
},
"id" : "d08f9217-bbd2-11e6-8a84-bae500000004" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"entityType" : "supply" ,
"url" : "http://www.example.com" ,
"method" : "POST" ,
"enabled" : true ,
"action" : "CREATE"
}
Пример запроса на создание нового вебхука с отображением измененных полей.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/webhook"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"url": "http://www.example.com",
"action": "UPDATE",
"entityType": "supply",
"diffType": "FIELDS"
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданного вебхука.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/d08f9217-bbd2-11e6-8a84-bae500000004" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata" ,
"type" : "webhook" ,
"mediaType" : "application/json"
},
"id" : "d08f9217-bbd2-11e6-8a84-bae500000004" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"entityType" : "supply" ,
"url" : "http://www.example.com" ,
"method" : "POST" ,
"enabled" : true ,
"action" : "UPDATE" ,
"diffType" : "FIELDS"
}
Массовое создание и обновление вебхуков
Массовое создание и обновление вебхуков.
В теле запроса нужно передать массив, содержащий JSON представления вебхуков, которые вы хотите создать или обновить.
Обновляемые вебхуки должны содержать идентификатор в виде метаданных.
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука.
Пример создания и обновления нескольких вебхуков
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/webhook/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"url": "http://www.example.com",
"action": "CREATE",
"entityType": "supply"
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/webhook/aec51463-bbd2-11e6-8a84-bae500000003",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata",
"type": "webhook",
"mediaType": "application/json"
},
"url": "http://www.example.com",
"action": "DELETE"
}
]'
Response 200 (application/json)
Успешный запрос. Результат - массив JSON представлений созданных и обновленных вебхуков.
Показать Свернуть
[
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/d08f9217-bbd2-11e6-8a84-bae500000004" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata" ,
"type" : "webhook" ,
"mediaType" : "application/json"
},
"id" : "d08f9217-bbd2-11e6-8a84-bae500000004" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"entityType" : "supply" ,
"url" : "http://www.example.com" ,
"method" : "POST" ,
"enabled" : true ,
"action" : "CREATE"
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/aec51463-bbd2-11e6-8a84-bae500000003" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata" ,
"type" : "webhook" ,
"mediaType" : "application/json"
},
"id" : "aec51463-bbd2-11e6-8a84-bae500000003" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"entityType" : "demand" ,
"url" : "http://www.example.com" ,
"method" : "POST" ,
"enabled" : true ,
"action" : "DELETE"
}
]
Получить отдельный вебхук
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука.
Запрос на получение отдельного вебхука с указанным id.
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/webhook/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление вебхука с указанным id.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/aec51463-bbd2-11e6-8a84-bae500000003" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata" ,
"type" : "webhook" ,
"mediaType" : "application/json"
},
"id" : "aec51463-bbd2-11e6-8a84-bae500000003" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"entityType" : "demand" ,
"url" : "http://www.example.com" ,
"method" : "POST" ,
"enabled" : true ,
"action" : "CREATE"
}
Изменить вебхук
Пример запроса на изменение сведений о вебхуке.
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука.
Пример запроса на изменение вебхука.
Показать Свернуть
curl -X PUT
"https://api.moysklad.ru/api/remap/1.2/entity/webhook/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"url": "http://www.example.com",
"action": "DELETE"
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление измененного вебхука.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/aec51463-bbd2-11e6-8a84-bae500000003" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata" ,
"type" : "webhook" ,
"mediaType" : "application/json"
},
"id" : "aec51463-bbd2-11e6-8a84-bae500000003" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"entityType" : "demand" ,
"url" : "http://www.example.com" ,
"method" : "POST" ,
"enabled" : true ,
"action" : "DELETE"
}
Отключить вебхук
Пример запроса на отключение вебхука.
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука.
Пример запроса на отключение вебхука.
Показать Свернуть
curl -X PUT
"https://api.moysklad.ru/api/remap/1.2/entity/webhook/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"enabled": false
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отключенного вебхука.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/aec51463-bbd2-11e6-8a84-bae500000003" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata" ,
"type" : "webhook" ,
"mediaType" : "application/json"
},
"id" : "aec51463-bbd2-11e6-8a84-bae500000003" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"entityType" : "demand" ,
"url" : "http://www.example.com" ,
"method" : "POST" ,
"enabled" : false ,
"action" : "DELETE"
}
Удалить вебхук
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука.
Пример запроса на удаление вебхука с указанным id.
Показать Свернуть
curl -X DELETE
"https://api.moysklad.ru/api/remap/1.2/entity/webhook/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешное удаление вебхука.
Массовое удаление вебхуков
В теле запроса нужно передать массив, содержащий JSON метаданных вебхуков, которые вы хотите удалить.
Запрос на массовое удаление вебхуков.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/webhook/delete"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/webhook/7944ef04-f831-11e5-7a69-971500188b1",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata",
"type": "webhook",
"mediaType": "application/json"
}
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/webhook/7944ef04-f831-11e5-7a69-971500188b2",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/webhook/metadata",
"type": "webhook",
"mediaType": "application/json"
}
}
]'
Успешный запрос. Результат - JSON информация об удалении вебхуков.
Показать Свернуть
[
{
"info" : "Сущность 'webhook' с UUID: 7944ef04-f831-11e5-7a69-971500188b1 успешно удалена"
},
{
"info" : "Сущность 'webhook' с UUID: 7944ef04-f831-11e5-7a69-971500188b2 успешно удалена"
}
]
Вебхук на изменение остатков
Вебхуки позволяют получать уведомления об изменениях остатков товаров. Уведомления отправляются пользователю каждые 1-5 минут, если произошло изменение остатков. Чтобы получать уведомления, создайте вебхук на изменения остатков и включите его. Ключевое слово для вебхуков на изменение остатков в рамках JSON API — webhookstock .
Набор возможностей также зависит от вашего тарифа:
При платных тарифах можно: получать, создавать, обновлять, отключать и удалять вебхуки на изменение остатков.
При бесплатном тарифе отправка вебхуков не производится, нельзя создать новый или изменить существующий вебхук.
Описание вебхука на изменение остатков
Пример того, в каком виде будут передаваться данные: POST https://example.com/webhook_path?requestId=640569eb-522d-427a-b07e-fa757c5d4217
Показать Свернуть
{
"accountId" : "f71cb8b6-f7b5-11ec-ac12-000f000000eb" ,
"stockType" : "stock" ,
"reportType" : "all" ,
"reportUrl" : "https://api.moysklad.ru/api/remap/1.2/report/stock/all/current?changedSince=2022-09-24 19:14:32"
}
Атрибуты отправляемого сообщения
Название
Тип
Описание
accountId
UUID
ID учетной записиОбязательное при ответе
stockType
Enum
Тип остатков, изменение которых вызывает вебхук на изменение остатков. Возможные значения: [stock]
Обязательное при ответе
reportType
Enum
Тип отчета остатков, к которым привязан вебхук на изменение остатков. Возможные значения: [all, bystore]
Обязательное при ответе
reportUrl
String(255)
URL на получения данных по изменившейся номенклатуре за указанный период Обязательное при ответе
Параметр запроса requestId — идентификатор уведомления.
При отправке запроса система ожидает получить ответ от клиентского приложения с HTTP-статусом 200 или 204 в течение 1500 миллисекунд. Если система получает неверный ответ, она осуществляет еще 3 попытки отправки. Попытки осуществляются последовательно, без таймаутов между ними. Если все попытки закончились неудачно или истекло время ожидания ответа, уведомление считается неотправленным и удаляется.
Чтобы попытки отправки уведомления не заканчивались неудачей из-за истечения времени ожидания ответа сервером, разделите прием вебхуков и их обработку. Параметр запроса requestId говорит о том, что уведомление о событии было отправлено повторно. При повторной отправке уведомления идентификатор останется прежним.
SSL Handshake
Если на адресе получателя используется SSL сертификат, то необходимо удостовериться, что сертификат имеет корректные Certification Paths. Проверить сертификат можно в сервисе https://www.ssllabs.com/ssltest/index.html
Атрибуты сущности
Название
Тип
Описание
accountId
UUID
ID учетной записиОбязательное при ответе
authorApplication
Meta
Метаданные Решения, создавшего вебхук на изменение остатковТолько для чтения
enabled
Boolean
Флажок состояния вебхука на изменение остатков (включен / отключен)Обязательное при ответе
stockType
Enum
Тип остатков, изменение которых вызывает вебхук. Возможные значения: [stock]
Обязательное при ответе
Необходимо при создании
reportType
Enum
Тип отчета остатков, к которым привязан вебхук на изменение остатков. Возможные значения: [all, bystore]
Обязательное при ответе
Необходимо при создании
id
UUID
ID вебхука на изменение остатковОбязательное при ответе
meta
Meta
Метаданные вебхука на изменение остатковОбязательное при ответе
url
URL
URL, по которому будет происходить обработка вебхука. Допустимая длина до 255 символовОбязательное при ответе
Необходимо при создании
Получить список вебхуков на изменение остатков
Запрос на получение всех вебхуков на изменение остатков на данной учетной записи.
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/webhookstock"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление списка вебхуков на изменение остатков.
Показать Свернуть
{
"context" : {
"employee" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/employee" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
}
},
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/metadata" ,
"type" : "webhookstock" ,
"mediaType" : "application/json" ,
"size" : 3 ,
"limit" : 1000 ,
"offset" : 0
},
"rows" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/aec51463-bbd2-11e6-8a84-bae500000003" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/metadata" ,
"type" : "webhookstock" ,
"mediaType" : "application/json"
},
"authorApplication" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/application/9e1ad712-3e45-4679-8896-7159973a8ef5" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/application/metadata" ,
"type" : "application" ,
"mediaType" : "application/json"
}
},
"id" : "aec51463-bbd2-11e6-8a84-bae500000003" ,
"accountId" : "8afc8c88-38a5-11ed-ac14-000f00000001" ,
"stockType" : "stock" ,
"reportType" : "all" ,
"url" : "http://www.example.com" ,
"enabled" : true
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/d08f9217-bbd2-11e6-8a84-bae500000004" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/metadata" ,
"type" : "webhookstock" ,
"mediaType" : "application/json"
},
"id" : "d08f9217-bbd2-11e6-8a84-bae500000004" ,
"accountId" : "8afc8c88-38a5-11ed-ac14-000f00000001" ,
"stockType" : "stock" ,
"reportType" : "all" ,
"url" : "http://www.example.com" ,
"enabled" : true
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/d946c7ff-bbd2-11e6-8a84-bae500000005" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/metadata" ,
"type" : "webhookstock" ,
"mediaType" : "application/json"
},
"id" : "d946c7ff-bbd2-11e6-8a84-bae500000005" ,
"accountId" : "8afc8c88-38a5-11ed-ac14-000f00000001" ,
"stockType" : "stock" ,
"reportType" : "all" ,
"url" : "http://www.example.com" ,
"enabled" : true
}
]
}
Создать вебхук на изменение остатков
Сочетание stockType , reportType , url должно быть уникальным.
Всего на одно уникальное сочетание stockType , reportType может быть создано не более 5 вебхуков на изменение
остатков с разными url для пользователей и не более 1 для решения.
Пример запроса на создание нового вебхука на изменение остатков.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/webhookstock"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"url": "http://www.example.com",
"enabled": true,
"reportType": "all",
"stockType": "stock"
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданного вебхука на изменение остатков.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/d08f9217-bbd2-11e6-8a84-bae500000004" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/metadata" ,
"type" : "webhookstock" ,
"mediaType" : "application/json"
},
"id" : "d08f9217-bbd2-11e6-8a84-bae500000004" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"stockType" : "stock" ,
"reportType" : "all" ,
"url" : "http://www.example.com" ,
"enabled" : true
}
Массовое создание и обновление вебхуков на изменение остатков
Массовое создание и обновление вебхуков на изменение остатков.
В теле запроса нужно передать массив, содержащий JSON представления вебхуков на изменение остатков, которые вы хотите создать или обновить.
Обновляемые вебхуки на изменение остатков должны содержать идентификатор в виде метаданных.
Пример создания и обновления нескольких вебхуков на изменение остатков
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/webhookstock"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"url": "http://www.example.com",
"stockType": "stock",
"reportType": "all",
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/aec51463-bbd2-11e6-8a84-bae500000003",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/metadata",
"type": "webhookstock",
"mediaType": "application/json"
},
"url": "http://www.example.com",
"stockType": "stock",
"reportType": "bystore",
}
]'
Response 200 (application/json)
Успешный запрос. Результат - массив JSON представлений созданных и обновленных вебхуков на изменение остатков.
Показать Свернуть
[
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/d08f9217-bbd2-11e6-8a84-bae500000004" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/metadata" ,
"type" : "webhookstock" ,
"mediaType" : "application/json"
},
"id" : "d08f9217-bbd2-11e6-8a84-bae500000004" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"stockType" : "stock" ,
"reportType" : "all" ,
"url" : "http://www.example.com" ,
"enabled" : true
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/aec51463-bbd2-11e6-8a84-bae500000003" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/metadata" ,
"type" : "webhookstock" ,
"mediaType" : "application/json"
},
"id" : "aec51463-bbd2-11e6-8a84-bae500000003" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"stockType" : "stock" ,
"reportType" : "bystore" ,
"url" : "http://www.example.com" ,
"enabled" : true
}
]
Получить отдельный вебхук на изменение остатков
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука на изменение остатков.
Запрос на получение отдельного вебхука на изменение остатков с указанным id.
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление вебхука на изменение остатков с указанным id.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/7944ef04-f831-11e5-7a69-971500188b19" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/metadata" ,
"type" : "webhookstock" ,
"mediaType" : "application/json"
},
"id" : "7944ef04-f831-11e5-7a69-971500188b19" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"stockType" : "stock" ,
"reportType" : "bystore" ,
"url" : "http://www.example.com" ,
"enabled" : true
}
Изменить вебхук на изменение остатков
Пример запроса на изменение сведений о вебхуке на изменение остатков.
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука на изменение остатков.
Пример запроса на изменение вебхука на изменение остатков.
Показать Свернуть
curl -X PUT
"https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"url": "http://www.example.com",
"stockType": "stock",
"reportType": "bystore"
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление измененного вебхука на изменение остатков.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/7944ef04-f831-11e5-7a69-971500188b19" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/metadata" ,
"type" : "webhookstock" ,
"mediaType" : "application/json"
},
"id" : "7944ef04-f831-11e5-7a69-971500188b19" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"stockType" : "stock" ,
"reportType" : "bystore" ,
"url" : "http://www.example.com" ,
"enabled" : true
}
Отключить вебхук на изменение остатков
Пример запроса на отключение вебхука на изменение остатков.
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука на изменение остатков.
Пример запроса на отключение вебхука на изменение остатков.
Показать Свернуть
curl -X PUT
"https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"enabled": false
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отключенного вебхука на изменение остатков.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/7944ef04-f831-11e5-7a69-971500188b19" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/metadata" ,
"type" : "webhookstock" ,
"mediaType" : "application/json"
},
"id" : "7944ef04-f831-11e5-7a69-971500188b19" ,
"accountId" : "b8b74698-9128-11e6-8a84-bae500000001" ,
"stockType" : "stock" ,
"reportType" : "bystore" ,
"url" : "http://www.example.com" ,
"enabled" : false
}
Удалить вебхук на изменение остатков
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id вебхука на изменение остатков.
Пример запроса на удаление вебхука на изменение остатков с указанным id.
Показать Свернуть
curl -X DELETE
"https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешное удаление вебхука на изменение остатков.
Массовое удаление вебхуков на изменение остатков
В теле запроса нужно передать массив, содержащий JSON метаданных вебхуков на изменение остатков, которые вы хотите удалить.
Запрос на массовое удаление вебхука на изменение остатков.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/delete"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/7944ef04-f831-11e5-7a69-971500188b1",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/metadata",
"type": "webhookstock",
"mediaType": "application/json"
}
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/7944ef04-f831-11e5-7a69-971500188b2",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/webhookstock/metadata",
"type": "webhookstock",
"mediaType": "application/json"
}
}
]'
Успешный запрос. Результат - JSON информация об удалении вебхука на изменение остатков.
Показать Свернуть
[
{
"info" : "Сущность 'webhookstock' с UUID: 7944ef04-f831-11e5-7a69-971500188b1 успешно удалена"
},
{
"info" : "Сущность 'webhookstock' с UUID: 7944ef04-f831-11e5-7a69-971500188b2 успешно удалена"
}
]
Грузовая таможенная декларация (ГТД) Грузовая таможенная декларация (ГТД)
Название
Тип
Описание
name
String(255)
Номер ГТД
В версии API 1.2 отсутствует отдельный ресурс для работы с ГТД. ГТД - вложенная сущность документа.
Группа техкарт
Средствами JSON API можно создавать и обновлять сведения о Группах техкарт, запрашивать списки Групп техкарт и сведения по отдельным Группам техкарт. Кодом сущности для Группы техкарт в составе JSON API является ключевое слово processingplanfolder .
Группы техкарт Атрибуты сущности
Название
Тип
Описание
accountId
UUID
ID учетной записиОбязательное при ответе
Только для чтения
archived
Boolean
Добавлена ли Группа техкарт в архивОбязательное при ответе
externalCode
String(255)
Внешний код Группы техкартОбязательное при ответе
code
String(255)
Код Группы техкарт
description
String(4096)
Описание Группы техкарт
group
Meta
Метаданные отдела сотрудникаОбязательное при ответе
Expand
id
UUID
ID Группы техкартОбязательное при ответе
Только для чтения
meta
Meta
Метаданные Группы техкартОбязательное при ответе
name
String(255)
Наименование Группы техкартОбязательное при ответе
Необходимо при создании
owner
Meta
Метаданные владельца (Сотрудника)Expand
pathName
String
Наименование Группы техкарт, в которую входит данная Группа техкартОбязательное при ответе
Только для чтения
shared
Boolean
Общий доступОбязательное при ответе
updated
DateTime
Момент последнего обновления сущностиОбязательное при ответе
Только для чтения
Получить список Групп техкарт
Запрос всех Групп техкарт на данной учетной записи.
Результат: Объект JSON, включающий в себя поля:
Название
Тип
Описание
meta
Meta
Метаданные о выдаче
context
Meta
Метаданные о сотруднике, выполнившем запрос
rows
Array(Object)
Массив JSON объектов, представляющих собой Группы техкарт
Параметры
Параметр
Описание
limit
number
(optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000
.
offset
number
(optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
Получить список Групп техкарт
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление списка Групп техкарт.
Показать Свернуть
{
"context" : {
"employee" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/employee" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
}
},
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/metadata" ,
"type" : "processingplanfolder" ,
"mediaType" : "application/json" ,
"size" : 1 ,
"limit" : 1000 ,
"offset" : 0
},
"rows" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/metadata" ,
"type" : "processingplanfolder" ,
"mediaType" : "application/json"
},
"id" : "3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2022-04-18 09:48:28.563" ,
"name" : "ГруппаТехКарт" ,
"externalCode" : "gt6UOfuXgb2ChJBcVn55H2" ,
"archived" : false ,
"pathName" : ""
}
]
}
Создать новую Группу техкарт
Запрос на создание новой Группы техкарт
Обязательные для создания Группы техкарт поля:
Название
Описание
name
Наименование Группы техкарт
Пример создания новой Группы техкарт с телом запроса, содержащим только поле name.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"name": "Группа 1"
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданной Группы техкарт.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/metadata" ,
"type" : "processingplanfolder" ,
"mediaType" : "application/json"
},
"id" : "3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-06-07 15:42:07" ,
"name" : "Группа 1" ,
"externalCode" : "mRQao-5IgY3soIY1EaI083" ,
"archived" : false ,
"pathName" : ""
}
Пример создания новой Группы техкарт с более насыщенным телом запроса.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"name": "Группа 2",
"code": "13321",
"externalCode": "extGroup"
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданной Группы техкарт.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/275961ab-2cad-11e6-8a84-bae50000001a" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/metadata" ,
"type" : "processingplanfolder" ,
"mediaType" : "application/json"
},
"id" : "275961ab-2cad-11e6-8a84-bae50000001a" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-06-07 15:41:28" ,
"name" : "Группа 2" ,
"code" : "13321" ,
"externalCode" : "extGroup" ,
"archived" : false ,
"pathName" : ""
}
Массовое создание и обновление Групп техкарт
Массовое создание и обновление Групп техкарт.
В теле запроса нужно передать массив, содержащий JSON представления Групп техкарт, которые вы хотите создать или обновить.
Обновляемые Группы техкарт должны содержать идентификатор в виде метаданных.
Пример создания и обновления нескольких Групп техкарт
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"name": "Группа Мебель",
"externalCode": "furnitureCode"
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/3ea73e1a-2cad-11e6-8a84-bae50000001d",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/metadata",
"type": "processingplanfolder",
"mediaType": "application/json"
},
"name": "Группа Авто"
}
]'
Response 200 (application/json)
Успешный запрос. Результат - массив JSON представлений созданных и обновленных Групп техкарт.
Показать Свернуть
[
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/metadata" ,
"type" : "processingplanfolder" ,
"mediaType" : "application/json"
},
"id" : "3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2022-04-19 09:48:28.563" ,
"name" : "Группа Авто" ,
"externalCode" : "HiQQWfW-jK5Z8e5KxjkCb2" ,
"archived" : false ,
"pathName" : ""
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/d071992d-bee8-11ec-0a82-031400000004" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/metadata" ,
"type" : "processingplanfolder" ,
"mediaType" : "application/json"
},
"id" : "d071992d-bee8-11ec-0a82-031400000004" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2022-04-19 09:48:28.563" ,
"name" : "Группа Мебель" ,
"externalCode" : "furnitureCode" ,
"archived" : false ,
"pathName" : ""
}
]
Удалить Группу техкарт
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Группы техкарт.
Запрос на удаление Группы техкарт с указанным id.
Показать Свернуть
curl -X DELETE
"https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешное удаление Группы техкарт.
Массовое удаление Групп техкарт
В теле запроса нужно передать массив, содержащий JSON метаданных Групп техкарт, которые вы хотите удалить.
Запрос на массовое удаление Групп техкарт.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/delete"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/7944ef04-f831-11e5-7a69-971500188b1",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/metadata",
"type": "processingplanfolder",
"mediaType": "application/json"
}
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/7944ef04-f831-11e5-7a69-971500188b2",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/metadata",
"type": "processingplanfolder",
"mediaType": "application/json"
}
}
]'
Успешный запрос. Результат - JSON информация об удалении Групп техкарт.
Показать Свернуть
[
{
"info" : "Сущность 'processingplanfolder' с UUID: 7944ef04-f831-11e5-7a69-971500188b1 успешно удалена"
},
{
"info" : "Сущность 'processingplanfolder' с UUID: 7944ef04-f831-11e5-7a69-971500188b2 успешно удалена"
}
]
Запрос на получение метаданных Групп техкарт. Результат - объект JSON, включающий в себя:
Название
Тип
Описание
meta
Meta
Метаданные Групп техкартОбязательное при ответе
Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями .
Получить метаданные Групп техкарт
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/metadata"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление доп. полей Групп техкарт.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/metadata" ,
"mediaType" : "application/json"
}
}
Группа техкарт
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Группы техкарты
Получить Группу техкарт
Запрос на получение отдельной Группы техкарт с указанным id.
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/8c329385-bee9-11ec-0a82-04c500000102"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление Группы техкарт.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/8c329385-bee9-11ec-0a82-04c500000102" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/metadata" ,
"type" : "processingplanfolder" ,
"mediaType" : "application/json"
},
"id" : "8c329385-bee9-11ec-0a82-04c500000102" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2022-04-19 09:48:28.563" ,
"name" : "Группа Мебель" ,
"externalCode" : "furnitureCode" ,
"archived" : false ,
"pathName" : ""
}
Изменить Группу техкарт
Запрос на обновление Группы техкарт с указанным id.
В теле запроса можно указать только те поля, которые необходимо изменить у Группы техкарт, кроме тех, что
помечены Только для чтения
в описании атрибутов Группы техкарт .
Для обновления поля pathName нужно обновить ссылку на родительскую Группу техкарт, т.е. обновить поле
processingplanfolder
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Группы техкарт.
Пример запроса на обновление конкретной Группы техкарт.
Показать Свернуть
curl -X PUT
"https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"name": "Группа 1",
"code": "groupCode",
"externalCode": "extGroupCode"
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление обновленной Группы техкарт.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/processingplanfolder/metadata" ,
"type" : "processingplanfolder" ,
"mediaType" : "application/json"
},
"id" : "3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-06-07 15:45:28" ,
"name" : "Группа 1" ,
"code" : "groupCode" ,
"externalCode" : "extGroupCode" ,
"archived" : false ,
"pathName" : ""
}
Группа товаров Группы товаров
Средствами JSON API можно создавать и обновлять сведения о Группах товаров, запрашивать списки Групп товаров и сведения по отдельным Группам товаров. Кодом сущности для Группы товаров в составе JSON API является ключевое слово productfolder .
По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search
. Подробнее можно узнать по ссылке .
Поиск среди объектов групп товаров на соответствие поисковой строке будет осуществлен по следующим полям:
по наименованию Группы товаров (name)
по коду Группы товаров (code)
Атрибуты сущности
Название
Тип
Фильтрация
Описание
accountId
UUID
=
!=
ID учетной записиОбязательное при ответе
Только для чтения
archived
Boolean
=
!=
Добавлена ли Группа товаров в архивОбязательное при ответе
Только для чтения
code
String(255)
=
!=
~
~=
=~
Код Группы товаров
description
String(4096)
=
!=
~
~=
=~
Описание Группы товаров
effectiveVat
Int
Реальный НДС %Только для чтения
effectiveVatEnabled
Boolean
Дополнительный признак для определения разграничения реального НДС = 0 или "без НДС". (effectiveVat = 0, effectiveVatEnabled = false) -> "без НДС", (effectiveVat = 0, effectiveVatEnabled = true) -> 0%.Только для чтения
externalCode
String(255)
=
!=
~
~=
=~
Внешний код Группы товаровОбязательное при ответе
group
Meta
=
!=
Метаданные отдела сотрудникаОбязательное при ответе
Expand
id
UUID
=
!=
ID Группы товаровОбязательное при ответе
Только для чтения
meta
Meta
Метаданные Группы товаровОбязательное при ответе
name
String(255)
=
!=
~
~=
=~
Наименование Группы товаровОбязательное при ответе
Необходимо при создании
owner
Meta
=
!=
Метаданные владельца (Сотрудника)Expand
pathName
String
=
!=
~
~=
=~
Наименование Группы товаров, в которую входит данная Группа товаровОбязательное при ответе
Только для чтения
productFolder
Meta
Ссылка на Группу товаров, в которую входит данная Группа товаров, в формате МетаданныхExpand
shared
Boolean
=
!=
Общий доступОбязательное при ответе
taxSystem
Enum
Код системы налогообложения. Подробнее тут
updated
DateTime
=
!=
<
>
<=
>=
Момент последнего обновления сущностиОбязательное при ответе
Только для чтения
useParentVat
Boolean
Используется ли ставка НДС родительской группы. Если true для единицы ассортимента будет применена ставка, установленная для родительской группы.Обязательное при ответе
vat
Int
НДС %
vatEnabled
Boolean
Включен ли НДС для группы. С помощью этого флага для группы можно выставлять НДС = 0 или НДС = "без НДС". (vat = 0, vatEnabled = false) -> vat = "без НДС", (vat = 0, vatEnabled = true) -> vat = 0%.
Код системы налогообложения
Значения поля taxSystem.
Значение
Описание
GENERAL_TAX_SYSTEM
ОСН
PATENT_BASED
Патент
PRESUMPTIVE_TAX_SYSTEM
ЕНВД
SIMPLIFIED_TAX_SYSTEM_INCOME
УСН. Доход
SIMPLIFIED_TAX_SYSTEM_INCOME_OUTCOME
УСН. Доход-Расход
TAX_SYSTEM_SAME_AS_GROUP
Совпадает с группой
UNIFIED_AGRICULTURAL_TAX
ЕСХН
Получить список групп товаров
Запрос всех Групп товаров на данной учетной записи.
Результат: Объект JSON, включающий в себя поля:
Название
Тип
Описание
meta
Meta
Метаданные о выдаче,
context
Meta
Метаданные о сотруднике, выполнившем запрос.
rows
Array(Object)
Массив JSON объектов, представляющих собой группы товаров.
Параметры
Параметр
Описание
limit
number
(optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000
.
offset
number
(optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
Получить список групп товаров
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/productfolder"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление списка Групп товаров.
Показать Свернуть
{
"context" : {
"employee" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/employee" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
}
},
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/productFolder" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/productFolder/metadata" ,
"type" : "productfolder" ,
"mediaType" : "application/json" ,
"size" : 2 ,
"limit" : 1000 ,
"offset" : 0
},
"rows" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata" ,
"type" : "productfolder" ,
"mediaType" : "application/json"
},
"id" : "3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-06-07 15:42:07" ,
"name" : "Овощи" ,
"code" : "13321Fruits1" ,
"externalCode" : "mRQao-5IgY3soIY1EaI083" ,
"archived" : false ,
"pathName" : "" ,
"vatEnabled" : false ,
"useParentVat" : true
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/275961ab-2cad-11e6-8a84-bae50000001a" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata" ,
"type" : "productfolder" ,
"mediaType" : "application/json"
},
"id" : "275961ab-2cad-11e6-8a84-bae50000001a" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"updated" : "2016-06-07 15:41:28" ,
"name" : "Фрукты" ,
"code" : "13321Fruits" ,
"externalCode" : "extFruits" ,
"archived" : false ,
"pathName" : "" ,
"vat" : 3 ,
"vatEnabled" : true ,
"useParentVat" : false ,
"effectiveVat" : 3 ,
"effectiveVatEnabled" : true ,
"taxSystem" : "GENERAL_TAX_SYSTEM"
}
]
}
Создать новую группу товаров
Запрос на создание новой Группы товаров.
Обязательные для создания Группы товаров поля:
Название
Описание
name
Наименование Группы товаров
Пример создания новой Группы товаров с телом запроса, содержащим только поле name.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/productfolder"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"name": "Овощи"
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданной Группы товаров.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata" ,
"type" : "productfolder" ,
"mediaType" : "application/json"
},
"id" : "3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-06-07 15:42:07" ,
"name" : "Овощи" ,
"code" : "13321Fruits1" ,
"externalCode" : "mRQao-5IgY3soIY1EaI083" ,
"archived" : false ,
"pathName" : "" ,
"vatEnabled" : false ,
"useParentVat" : true
}
Пример создания новой Группы товаров с более насыщенным телом запроса.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/productfolder"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"name": "Фрукты",
"code": "13321Fruits",
"externalCode": "extFruits",
"vat": 3,
"effectiveVat": 3
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданной Группы товаров.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/275961ab-2cad-11e6-8a84-bae50000001a" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata" ,
"type" : "productfolder" ,
"mediaType" : "application/json"
},
"id" : "275961ab-2cad-11e6-8a84-bae50000001a" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-06-07 15:41:28" ,
"name" : "Фрукты" ,
"code" : "13321Fruits" ,
"externalCode" : "extFruits" ,
"archived" : false ,
"pathName" : "" ,
"vat" : 3 ,
"vatEnabled" : true ,
"useParentVat" : false ,
"effectiveVat" : 3 ,
"effectiveVatEnabled" : true
}
Массовое создание и обновление Групп товаров
Массовое создание и обновление Групп товаров.
В теле запроса нужно передать массив, содержащий JSON представления Групп товаров, которые вы хотите создать или обновить.
Обновляемые Группы товаров должны содержать идентификатор в виде метаданных.
Пример создания и обновления нескольких Групп товаров
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/productfolder"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"name": "Овощи"
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/3ea73e1a-2cad-11e6-8a84-bae50000001d",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata",
"type": "productfolder",
"mediaType": "application/json"
},
"name": "Группа Овощи",
"code": "vegetableFolderCode",
"externalCode": "extVegCode",
"vat": 5,
"effectiveVat": 5
}
]'
Response 200 (application/json)
Успешный запрос. Результат - массив JSON представлений созданных и обновленных Групп товаров.
Показать Свернуть
[
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata" ,
"type" : "productfolder" ,
"mediaType" : "application/json"
},
"id" : "3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-06-07 15:42:07" ,
"name" : "Овощи" ,
"code" : "13321Fruits1" ,
"externalCode" : "mRQao-5IgY3soIY1EaI083" ,
"archived" : false ,
"pathName" : "" ,
"vatEnabled" : false ,
"useParentVat" : true ,
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata" ,
"type" : "productfolder" ,
"mediaType" : "application/json"
},
"id" : "3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-06-07 15:45:28" ,
"name" : "Группа Овощи" ,
"code" : "vegetableFolderCode" ,
"externalCode" : "extVegCode" ,
"archived" : false ,
"pathName" : "" ,
"vat" : 5 ,
"vatEnabled" : true ,
"useParentVat" : false ,
"effectiveVat" : 5 ,
"effectiveVatEnabled" : true
}
]
Удалить Группу товаров
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Группы товаров.
Запрос на удаление Группы товаров с указанным id.
Показать Свернуть
curl -X DELETE
"https://api.moysklad.ru/api/remap/1.2/entity/productfolder/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешное удаление Группы товаров.
Массовое удаление Групп товаров
В теле запроса нужно передать массив, содержащий JSON метаданных Групп товаров, которые вы хотите удалить.
Запрос на массовое удаление Групп товаров.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/productfolder/delete"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/7944ef04-f831-11e5-7a69-971500188b1",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata",
"type": "productfolder",
"mediaType": "application/json"
}
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/7944ef04-f831-11e5-7a69-971500188b2",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata",
"type": "productfolder",
"mediaType": "application/json"
}
}
]'
Успешный запрос. Результат - JSON информация об удалении Групп товаров.
Показать Свернуть
[
{
"info" : "Сущность 'productfolder' с UUID: 7944ef04-f831-11e5-7a69-971500188b1 успешно удалена"
},
{
"info" : "Сущность 'productfolder' с UUID: 7944ef04-f831-11e5-7a69-971500188b2 успешно удалена"
}
]
Запрос на получение метаданных Групп товаров. Результат - объект JSON, включающий в себя:
Название
Тип
Описание
meta
Meta
Метаданные Групп товаровОбязательное при ответе
attributes
Array(Object)
Коллекция доп. полей
Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями .
Получить метаданные Групп товаров
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление доп. полей Групп товаров.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata" ,
"mediaType" : "application/json"
},
"attributes" : [
{
"id" : "5290a290-0313-11e6-9464-e4de00000020" ,
"name" : "attribute_name" ,
"type" : "boolean" ,
"required" : false
}
]
}
Отдельное доп. поле
Параметры
Параметр
Описание
id
string
(required) Example: 5290a290-0313-11e6-9464-e4de00000020 id Доп. поля.
Отдельное доп. поле
Запрос на получение информации по отдельному дополнительному полю.
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata/attributes/5290a290-0313-11e6-9464-e4de00000020"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отдельного доп. поля.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata/attributes/5290a290-0313-11e6-9464-e4de00000020" ,
"type" : "attributemetadata" ,
"mediaType" : "application/json"
},
"id" : "5290a290-0313-11e6-9464-e4de00000020" ,
"name" : "attribute_name" ,
"type" : "boolean" ,
"required" : false
}
Группа товаров
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Группы товаров.
Получить Группу товаров
Запрос на получение отдельной группы товаров с указанным id.
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/productfolder/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление Группы товаров.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata" ,
"type" : "productfolder" ,
"mediaType" : "application/json"
},
"id" : "3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-06-07 15:42:07" ,
"name" : "Овощи" ,
"code" : "13321Fruits1" ,
"externalCode" : "mRQao-5IgY3soIY1EaI083" ,
"archived" : false ,
"pathName" : "" ,
"vatEnabled" : false ,
"useParentVat" : true ,
}
Изменить Группу товаров
Запрос на обновление Группы товаров с указанным id.
В теле запроса можно указать только те поля, которые необходимо изменить у Группы товаров, кроме тех, что
помечены Только для чтения
в описании атрибутов Группы товаров .
Для обновления поля pathName нужно обновить ссылку на родительскую Группу товаров, т.е. обновить поле
productFolder
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Группы товаров.
Пример запроса на обновление конкретной Группы товаров.
Показать Свернуть
curl -X PUT
"https://api.moysklad.ru/api/remap/1.2/entity/productfolder/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"name": "Группа Овощи",
"code": "vegetableFolderCode",
"externalCode": "extVegCode",
"vat": 5,
"effectiveVat": 5
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление обновленной Группы товаров.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/productfolder/metadata" ,
"type" : "productfolder" ,
"mediaType" : "application/json"
},
"id" : "3ea73e1a-2cad-11e6-8a84-bae50000001d" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : false ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-06-07 15:45:28" ,
"name" : "Группа Овощи" ,
"code" : "vegetableFolderCode" ,
"externalCode" : "extVegCode" ,
"archived" : false ,
"pathName" : "" ,
"vat" : 5 ,
"vatEnabled" : true ,
"useParentVat" : false ,
"effectiveVat" : 5 ,
"effectiveVatEnabled" : true
}
Договор Договоры
Средствами JSON API можно создавать и обновлять сведения о Договорах, запрашивать списки Договоров и сведения по отдельным Договорам. Кодом сущности для Договора в составе JSON API является ключевое слово contract . Больше о Договорах и работе с ними в основном интерфейсе вы можете прочитать в нашей службе поддержки по этой ссылке .
По данной сущности можно осуществлять контекстный поиск с помощью специального параметра search
. Подробнее можно узнать по ссылке . Поиск с параметром search отличается от других тем, что поиск не префиксный, без токенизации и идет только по одному полю одновременно. Ищет такие строки, в которые входит значение строки поиска.
Поиск среди объектов Договора на соответствие поисковой строке будет осуществлен по следующим полям:
по номеру Договора name
по комментарию к Договору description
Атрибуты сущности
Название
Тип
Фильтрация
Описание
accountId
UUID
=
!=
ID учетной записиОбязательное при ответе
Только для чтения
agent
Meta
=
!=
Метаданные КонтрагентаОбязательное при ответе
Expand
Необходимо при создании
agentAccount
Meta
Метаданные счета контрагентаОбязательное при ответе
Expand
archived
Boolean
=
!=
Добавлен ли Договор в архивОбязательное при ответе
attributes
Array(Object)
Операторы доп. полей
Коллекция доп. полей
code
String(255)
=
!=
~
~=
=~
Код Договора
contractType
Enum
Тип Договора. Возможные значения: Договор комиссии
, Договор купли-продажи
Обязательное при ответе
description
String(4096)
=
!=
~
~=
=~
Описание Договора
externalCode
String(255)
=
!=
~
~=
=~
Внешний код ДоговораОбязательное при ответе
group
Meta
=
!=
Метаданные отдела сотрудникаОбязательное при ответе
Expand
id
UUID
=
!=
ID ДоговораОбязательное при ответе
Только для чтения
meta
Meta
Метаданные ДоговораОбязательное при ответе
moment
DateTime
=
!=
<
>
<=
>=
Дата ДоговораОбязательное при ответе
name
String(255)
=
!=
~
~=
=~
Номер договораОбязательное при ответе
organizationAccount
Meta
Метаданные счета вашего юрлицаExpand
ownAgent
Meta
=
!=
Метаданные вашего юрлицаОбязательное при ответе
Expand
Необходимо при создании
owner
Meta
=
!=
Метаданные владельца (Сотрудника)Expand
rate
Meta
Метаданные валютыОбязательное при ответе
Expand
rewardPercent
Int
Вознаграждение в процентах (от 0 до 100)
rewardType
Enum
Тип Вознаграждения. Возможные значения: Процент от суммы продажи
, Не рассчитывать
shared
Boolean
=
!=
Общий доступОбязательное при ответе
state
Meta
=
!=
Метаданные статуса договораExpand
sum
Int
Сумма ДоговораОбязательное при ответе
printed
Boolean
Напечатан ли документОбязательное при ответе
Только для чтения
published
Boolean
Опубликован ли документОбязательное при ответе
Только для чтения
updated
DateTime
=
!=
<
>
<=
>=
Момент последнего обновления сущностиОбязательное при ответе
Только для чтения
Таблица полей, их значений и их значений в JSON представлении:
Имя поля
Возможные Значения
Соответствующее значение в JSON
Значение по умолчанию
contractType
Договор комиссии
Commission
Договор купли-продажи
Договор купли-продажи
Sales
rewardType
Процент от суммы продажи
PercentOfSales
Не рассчитывать
Не рассчитывать
None
О работе с доп. полями Договоров можно прочитать здесь
Получить список Договоров
Запрос на получение списка всех договоров на данной учетной записи.
Результат: Объект JSON, включающий в себя поля:
Название
Тип
Описание
meta
Meta
Метаданные о выдаче,
context
Meta
Метаданные о сотруднике, выполнившем запрос.
rows
Array(Object)
Массив JSON объектов, представляющих собой договора.
Параметры
Параметр
Описание
limit
number
(optional) Default: 1000 Example: 1000 Максимальное количество сущностей для извлечения.Допустимые значения 1 - 1000
.
offset
number
(optional) Default: 0 Example: 40 Отступ в выдаваемом списке сущностей.
Получить список договоров
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/contract"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление списка Договоров.
Показать Свернуть
{
"context" : {
"employee" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/context/employee" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
}
},
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"type" : "contract" ,
"mediaType" : "application/json" ,
"size" : 3 ,
"limit" : 1000 ,
"offset" : 0
},
"rows" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/498b8673-0308-11e6-9464-e4de00000089" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"type" : "contract" ,
"mediaType" : "application/json"
},
"id" : "498b8673-0308-11e6-9464-e4de00000089" ,
"accountId" : "84e60e93-f504-11e5-8a84-bae500000008" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-04-15 15:48:00" ,
"name" : "14212412" ,
"externalCode" : "WEhvl5LFgyYqa5l6yKRzu3" ,
"archived" : false ,
"moment" : "2016-04-15 15:47:00" ,
"sum" : 0 ,
"contractType" : "Sales" ,
"ownAgent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata" ,
"type" : "organization" ,
"mediaType" : "application/json"
}
},
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/78f75b89-fd86-11e5-9464-e4de0000000b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json"
}
},
"state" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069" ,
"type" : "state" ,
"mediaType" : "application/json"
}
},
"organizationAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"agentAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"rate" : {
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/baac25f0-50ac-11e5-300d-c79b00000055" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"printed" : false ,
"published" : false
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/8c2cab84-0ac0-11e6-9464-e4de00000100" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"type" : "contract" ,
"mediaType" : "application/json"
},
"id" : "8c2cab84-0ac0-11e6-9464-e4de00000100" ,
"accountId" : "84e60e93-f504-11e5-8a84-bae500000008" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-04-25 11:34:38" ,
"name" : "Привет, Имя договора" ,
"description" : "Коммент" ,
"code" : "KOOOOD" ,
"externalCode" : "GIpDXPPIh4ytzI9svfcyS3" ,
"archived" : false ,
"moment" : "2016-04-25 11:33:00" ,
"sum" : 9999999000 ,
"contractType" : "Commission" ,
"rewardType" : "PercentOfSales" ,
"rewardPercent" : 0 ,
"ownAgent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata" ,
"type" : "organization" ,
"mediaType" : "application/json"
}
},
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json"
}
},
"rate" : {
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/baac25f0-50ac-11e5-300d-c79b00000055" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
}
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/8ce3c179-015e-11e6-9464-e4de0000007a" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"type" : "contract" ,
"mediaType" : "application/json"
},
"id" : "8ce3c179-015e-11e6-9464-e4de0000007a" ,
"accountId" : "84e60e93-f504-11e5-8a84-bae500000008" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-04-13 13:00:28" ,
"name" : "12" ,
"description" : "asdwqeqr" ,
"code" : "cjhjr" ,
"externalCode" : "jTNl4F6WhxgFTcczKRT6i2" ,
"archived" : false ,
"moment" : "2016-04-13 13:00:00" ,
"sum" : 0 ,
"contractType" : "Sales" ,
"ownAgent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata" ,
"type" : "organization" ,
"mediaType" : "application/json"
}
},
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json"
}
},
"state" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069" ,
"type" : "state" ,
"mediaType" : "application/json"
}
},
"organizationAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"agentAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"rate" : {
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/faf45b9a-2e58-11e6-8a84-bae500000055" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"printed" : false ,
"published" : false
}
]
}
Создать новый Договор
Запрос на создание нового Договора.
Обязательные для создания Договора поля:
Название
Тип
Описание
name
String(255)
Номер договораОбязательное при ответе
ownAgent
Meta
Метаданные вашего юрлицаОбязательное при ответе
Expand
Необходимо при создании
agent
Meta
Метаданные КонтрагентаОбязательное при ответе
Expand
Необходимо при создании
Пример создания нового Договора, с запросом, Тело которого содержит только обязательные поля.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/contract"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"ownAgent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata",
"type": "organization",
"mediaType": "application/json"
}
},
"agent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
}
}
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданного Договора.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/8df02031-0ac4-11e6-9464-e4de00000008" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"type" : "contract" ,
"mediaType" : "application/json"
},
"id" : "8df02031-0ac4-11e6-9464-e4de00000008" ,
"accountId" : "84e60e93-f504-11e5-8a84-bae500000008" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-04-25 12:03:19" ,
"name" : "666" ,
"externalCode" : "y8j8uYVuhd04K8ZGOuu2a1" ,
"archived" : false ,
"moment" : "2016-04-25 12:03:19" ,
"sum" : 0 ,
"contractType" : "Sales" ,
"ownAgent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata" ,
"type" : "organization" ,
"mediaType" : "application/json"
}
},
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json"
}
},
"organizationAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"agentAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"rate" : {
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/faf45b9a-2e58-11e6-8a84-bae500000055" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"printed" : false ,
"published" : false
}
Пример создания нового Договора с более насыщенным телом запроса.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/contract"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"name": "00000011111",
"description": "Договор с партнерской организацией ООО Солнышко",
"code": "contractWithPartner",
"externalCode": "extC12fd12a",
"moment": "2016-07-06 12:53:22",
"sum": 200000,
"contractType": "Sales",
"ownAgent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/organization/db141159-2c97-11e6-8a84-bae50000004e",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata",
"type": "organization",
"mediaType": "application/json"
}
},
"agent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/2e6aa620-2c98-11e6-8a84-bae500000004",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"state": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069",
"type": "state",
"mediaType": "application/json"
}
}
}'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданного Договора.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/3bba8d2a-2cb6-11e6-8a84-bae50000002c" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"type" : "contract" ,
"mediaType" : "application/json"
},
"id" : "3bba8d2a-2cb6-11e6-8a84-bae50000002c" ,
"accountId" : "da7d9bbe-2c97-11e6-8a84-bae500000001" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-06-07 16:46:27" ,
"name" : "00000011111" ,
"description" : "Договор с партнерской организацией ООО Солнышко" ,
"code" : "contractWithPartner" ,
"externalCode" : "extC12fd12a" ,
"archived" : false ,
"moment" : "2016-07-06 12:53:22" ,
"sum" : 200000 ,
"contractType" : "Sales" ,
"ownAgent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/db141159-2c97-11e6-8a84-bae50000004e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata" ,
"type" : "organization" ,
"mediaType" : "application/json"
}
},
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/2e6aa620-2c98-11e6-8a84-bae500000004" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json"
}
},
"state" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069" ,
"type" : "state" ,
"mediaType" : "application/json"
}
},
"agentAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/2e6aa620-2c98-11e6-8a84-bae500000004/accounts/2e6ab6ca-2c98-11e6-8a84-bae500000005" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"rate" : {
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/baac25f0-50ac-11e5-300d-c79b00000055" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"printed" : false ,
"published" : false
}
Пример создания нового Договора, с запросом, Тело которого содержит дополнительные поля.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/contract"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"name": "666",
"ownAgent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata",
"type": "organization",
"mediaType": "application/json"
}
},
"agent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"rate": {
"currency": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/currency/faf45b9a-2e58-11e6-8a84-bae500000055",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
}
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/contract/73fa8fb0-0ac5-11e6-9464-e4de0000000b",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata",
"type": "contract",
"mediaType": "application/json"
},
"name": "666_02",
"ownAgent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata",
"type": "organization",
"mediaType": "application/json"
}
},
"contractType": "Sales",
"code": "code333",
"externalCode": "exCode333",
"moment": "2017-02-25 12:03:19",
"description": "Договор с контрагентом ООО Поставщик",
"rate": {
"currency": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/currency/faf45b9a-2e58-11e6-8a84-bae500000055",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
}
}
]'
Response 200 (application/json)
Успешный запрос. Результат - JSON представление созданного Договора.
Показать Свернуть
[
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/8df02031-0ac4-11e6-9464-e4de00000008" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"type" : "contract" ,
"mediaType" : "application/json"
},
"id" : "8df02031-0ac4-11e6-9464-e4de00000008" ,
"accountId" : "84e60e93-f504-11e5-8a84-bae500000008" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-04-25 12:03:19" ,
"name" : "666" ,
"externalCode" : "y8j8uYVuhd04K8ZGOuu2a1" ,
"archived" : false ,
"moment" : "2016-04-25 12:03:19" ,
"sum" : 0 ,
"contractType" : "Sales" ,
"ownAgent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata" ,
"type" : "organization" ,
"mediaType" : "application/json"
}
},
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json"
}
},
"organizationAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"agentAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"rate" : {
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/faf45b9a-2e58-11e6-8a84-bae500000055" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"printed" : false ,
"published" : false
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/73fa8fb0-0ac5-11e6-9464-e4de0000000b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"type" : "contract" ,
"mediaType" : "application/json"
},
"id" : "73fa8fb0-0ac5-11e6-9464-e4de0000000b" ,
"accountId" : "84e60e93-f504-11e5-8a84-bae500000008" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-04-25 12:22:17" ,
"name" : "666_02" ,
"description" : "Договор с контрагентом ООО Поставщик" ,
"code" : "code333" ,
"externalCode" : "exCode333" ,
"archived" : false ,
"moment" : "2017-02-25 12:03:19" ,
"sum" : 0 ,
"contractType" : "Sales" ,
"ownAgent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata" ,
"type" : "organization" ,
"mediaType" : "application/json"
}
},
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json"
}
},
"organizationAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"agentAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"rate" : {
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/faf45b9a-2e58-11e6-8a84-bae500000055" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"printed" : false ,
"published" : false
}
]
Массовое создание и обновление Договоров
Массовое создание и обновление Договоров.
В теле запроса нужно передать массив, содержащий JSON представления Договоров, которые вы хотите создать или обновить.
Обновляемые Договора должны содержать идентификатор в виде метаданных.
Пример создания и обновления нескольких Договоров
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/contract"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"name": "666",
"ownAgent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata",
"type": "organization",
"mediaType": "application/json"
}
},
"agent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata",
"type": "counterparty",
"mediaType": "application/json"
}
},
"rate": {
"currency": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/currency/faf45b9a-2e58-11e6-8a84-bae500000055",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
}
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/contract/73fa8fb0-0ac5-11e6-9464-e4de0000000b",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata",
"type": "contract",
"mediaType": "application/json"
},
"name": "666_02",
"ownAgent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata",
"type": "organization",
"mediaType": "application/json"
}
},
"contractType": "Sales",
"code": "code333",
"externalCode": "exCode333",
"moment": "2017-02-25 12:03:19",
"description": "Договор с контрагентом ООО Поставщик",
"rate": {
"currency": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/currency/faf45b9a-2e58-11e6-8a84-bae500000055",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
}
}
]'
Response 200 (application/json)
Успешный запрос. Результат - массив JSON представлений созданных и обновленных Договоров.
Показать Свернуть
[
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/8df02031-0ac4-11e6-9464-e4de00000008" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"type" : "contract" ,
"mediaType" : "application/json"
},
"id" : "8df02031-0ac4-11e6-9464-e4de00000008" ,
"accountId" : "84e60e93-f504-11e5-8a84-bae500000008" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-04-25 12:03:19" ,
"name" : "666" ,
"externalCode" : "y8j8uYVuhd04K8ZGOuu2a1" ,
"archived" : false ,
"moment" : "2016-04-25 12:03:19" ,
"sum" : 0 ,
"contractType" : "Sales" ,
"ownAgent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata" ,
"type" : "organization" ,
"mediaType" : "application/json"
}
},
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json"
}
},
"organizationAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"agentAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"rate" : {
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/faf45b9a-2e58-11e6-8a84-bae500000055" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"printed" : false ,
"published" : false
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/73fa8fb0-0ac5-11e6-9464-e4de0000000b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"type" : "contract" ,
"mediaType" : "application/json"
},
"id" : "73fa8fb0-0ac5-11e6-9464-e4de0000000b" ,
"accountId" : "84e60e93-f504-11e5-8a84-bae500000008" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-04-25 12:22:17" ,
"name" : "666_02" ,
"description" : "Договор с контрагентом ООО Поставщик" ,
"code" : "code333" ,
"externalCode" : "exCode333" ,
"archived" : false ,
"moment" : "2017-02-25 12:03:19" ,
"sum" : 0 ,
"contractType" : "Sales" ,
"ownAgent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata" ,
"type" : "organization" ,
"mediaType" : "application/json"
}
},
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json"
}
},
"organizationAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"agentAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"rate" : {
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/faf45b9a-2e58-11e6-8a84-bae500000055" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"printed" : false ,
"published" : false
}
]
Удалить договор
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Договора.
Запрос на удаление Договора с указанным id.
Показать Свернуть
curl -X DELETE
"https://api.moysklad.ru/api/remap/1.2/entity/contract/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешное удаление Договора.
Массовое удаление Договоров
В теле запроса нужно передать массив, содержащий JSON метаданных Договоров, которые вы хотите удалить.
Запрос на массовое удаление Договоров.
Показать Свернуть
curl -X POST
"https://api.moysklad.ru/api/remap/1.2/entity/contract/delete"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '[
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/contract/7944ef04-f831-11e5-7a69-971500188b1",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata",
"type": "contract",
"mediaType": "application/json"
}
},
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/contract/7944ef04-f831-11e5-7a69-971500188b2",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata",
"type": "contract",
"mediaType": "application/json"
}
}
]'
Успешный запрос. Результат - JSON информация об удалении Договоров.
Показать Свернуть
[
{
"info" : "Сущность 'contract' с UUID: 7944ef04-f831-11e5-7a69-971500188b1 успешно удалена"
},
{
"info" : "Сущность 'contract' с UUID: 7944ef04-f831-11e5-7a69-971500188b2 успешно удалена"
}
]
Запрос на получение метаданных Договоров. Результат - объект JSON, включающий в себя:
Название
Тип
Описание
meta
Meta
Метаданные Заказа покупателяОбязательное при ответе
attributes
Array(Object)
Коллекция доп. полей
states
Array(Object)
Массив статусов договоров
createShared
Boolean
Создавать новые договора с меткой "Общий"Обязательное при ответе
Структура отдельного объекта, представляющего доп. поле подробно описана в разделе Работа с дополнительными полями .
Получение методанных Договора
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление доп. полей Договоров.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"mediaType" : "application/json"
},
"attributes" : [
{
"id" : "5290a290-0313-11e6-9464-e4de00000020" ,
"name" : "AttributeName1" ,
"type" : "boolean" ,
"required" : false
}
],
"states" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069" ,
"type" : "state" ,
"mediaType" : "application/json"
},
"id" : "fb56c504-2e58-11e6-8a84-bae500000069" ,
"accountId" : "f976ed28-2e58-11e6-8a84-bae500000001" ,
"name" : "Новый" ,
"color" : 15106326 ,
"stateType" : "Regular" ,
"entityType" : "contract"
},
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata/states/fb56cae3-2e58-11e6-8a84-bae50000006a" ,
"type" : "state" ,
"mediaType" : "application/json"
},
"id" : "fb56cae3-2e58-11e6-8a84-bae50000006a" ,
"accountId" : "f976ed28-2e58-11e6-8a84-bae500000001" ,
"name" : "Подтвержден" ,
"color" : 40931 ,
"stateType" : "Regular" ,
"entityType" : "contract"
}
],
"createShared" : false
}
Отдельное доп. поле
Параметры
Параметр
Описание
id
string
(required) Example: 5290a290-0313-11e6-9464-e4de00000020 id Доп. поля.
Отдельное доп. поле
Запрос на получение информации по отдельному дополнительному полю.
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata/attributes/5290a290-0313-11e6-9464-e4de00000020"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление отдельного доп. поля.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata/attributes/5290a290-0313-11e6-9464-e4de00000020" ,
"type" : "attributemetadata" ,
"mediaType" : "application/json"
},
"id" : "5290a290-0313-11e6-9464-e4de00000020" ,
"name" : "AttributeName1" ,
"type" : "boolean" ,
"required" : false
}
Договор
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Договора.
Получить Договор
Запрос на получение отдельного Договора с указанным id.
Показать Свернуть
curl -X GET
"https://api.moysklad.ru/api/remap/1.2/entity/contract/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
Response 200 (application/json)
Успешный запрос. Результат - JSON представление Договора.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/8ce3c179-015e-11e6-9464-e4de0000007a" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"type" : "contract" ,
"mediaType" : "application/json"
},
"id" : "8ce3c179-015e-11e6-9464-e4de0000007a" ,
"accountId" : "84e60e93-f504-11e5-8a84-bae500000008" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-04-13 13:00:28" ,
"name" : "12" ,
"description" : "asdwqeqr" ,
"code" : "cjhjr" ,
"externalCode" : "jTNl4F6WhxgFTcczKRT6i2" ,
"archived" : false ,
"moment" : "2016-04-13 13:00:00" ,
"sum" : 0 ,
"contractType" : "Sales" ,
"ownAgent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata" ,
"type" : "organization" ,
"mediaType" : "application/json"
}
},
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json"
}
},
"state" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata/states/fb56c504-2e58-11e6-8a84-bae500000069" ,
"type" : "state" ,
"mediaType" : "application/json"
}
},
"organizationAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"agentAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"rate" : {
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/faf45b9a-2e58-11e6-8a84-bae500000055" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"printed" : false ,
"published" : false ,
"attributes" : [
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata/attributes/0cd74e1e-2e59-11e6-8a84-bae50000008a" ,
"type" : "attributemetadata" ,
"mediaType" : "application/json"
},
"id" : "25b6f76c-12d5-11e6-9464-e4de00000068" ,
"name" : "AttributeName1" ,
"type" : "boolean" ,
"value" : false
}
]
}
Изменить Договор
Запрос на обновление отдельного Договора с указанным id.
При обновлении полей organization и agent нужно также обновить поля organizationAccount и
agentAccount соответственно, иначе произойдет ошибка.
Параметры
Параметр
Описание
id
string
(required) Example: 7944ef04-f831-11e5-7a69-971500188b19 id Договора.
Пример запроса на обновление отдельного Договора.
Показать Свернуть
curl -X PUT
"https://api.moysklad.ru/api/remap/1.2/entity/contract/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"name": "666_02",
"ownAgent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata",
"type": "organization",
"mediaType": "application/json"
}
},
"contractType": "Sales",
"code": "code333",
"externalCode": "exCode333",
"moment": "2017-02-25 12:03:19",
"description": "Договор с контрагентом ООО Поставщик",
"rate": {
"currency": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/currency/faf45b9a-2e58-11e6-8a84-bae500000055",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata",
"type": "currency",
"mediaType": "application/json"
}
}
}
}'
Response 200 (application/json)
Удачный запрос. Результат - JSON представление обновленного Договора.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/73fa8fb0-0ac5-11e6-9464-e4de0000000b" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"type" : "contract" ,
"mediaType" : "application/json"
},
"id" : "73fa8fb0-0ac5-11e6-9464-e4de0000000b" ,
"accountId" : "84e60e93-f504-11e5-8a84-bae500000008" ,
"owner" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/faba7f37-2e58-11e6-8a84-bae500000028" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/employee/metadata" ,
"type" : "employee" ,
"mediaType" : "application/json"
}
},
"shared" : true ,
"group" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/group/f97aa1fb-2e58-11e6-8a84-bae500000002" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/group/metadata" ,
"type" : "group" ,
"mediaType" : "application/json"
}
},
"updated" : "2016-04-25 12:22:17" ,
"name" : "666_02" ,
"description" : "Договор с контрагентом ООО Поставщик" ,
"code" : "code333" ,
"externalCode" : "exCode333" ,
"archived" : false ,
"moment" : "2017-02-25 12:03:19" ,
"sum" : 0 ,
"contractType" : "Sales" ,
"ownAgent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata" ,
"type" : "organization" ,
"mediaType" : "application/json"
}
},
"agent" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/9794d400-f689-11e5-8a84-bae500000078" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/metadata" ,
"type" : "counterparty" ,
"mediaType" : "application/json"
}
},
"organizationAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/organization/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"agentAccount" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/counterparty/342dc6f5-0bbb-11e6-d219-b9d90000004e/accounts/342e096d-0bbb-11e6-d219-b9d90000004f" ,
"type" : "account" ,
"mediaType" : "application/json"
}
},
"rate" : {
"currency" : {
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/faf45b9a-2e58-11e6-8a84-bae500000055" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/currency/metadata" ,
"type" : "currency" ,
"mediaType" : "application/json"
}
}
},
"printed" : false ,
"published" : false
}
Пример запроса на обновление отдельного Договора с телом запроса, содержащим доп. поля.
Показать Свернуть
curl -X PUT
"https://api.moysklad.ru/api/remap/1.2/entity/contract/7944ef04-f831-11e5-7a69-971500188b19"
-H "Authorization: Basic <Credentials>"
-H "Accept-Encoding: gzip"
-H "Content-Type: application/json"
-d '{
"name": "123_456",
"ownAgent": {
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/organization/850c8195-f504-11e5-8a84-bae50000015e",
"metadataHref": "https://api.moysklad.ru/api/remap/1.2/entity/organization/metadata",
"type": "organization",
"mediaType": "application/json"
}
},
"contractType": "Sales",
"code": "не код 333",
"externalCode": "exC22ode333",
"moment": "2019-03-15 21:03:19",
"description": "Новый договор",
"attributes": [
{
"meta": {
"href": "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata/attributes/0cd74e1e-2e59-11e6-8a84-bae50000008a",
"type": "attributemetadata",
"mediaType": "application/json"
},
"value": false
}
]
}'
Response 200 (application/json)
Удачный запрос. Результат - JSON представление обновленного Договора.
Показать Свернуть
{
"meta" : {
"href" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/7c0c5b6d-12d5-11e6-9464-e4de0000000c" ,
"metadataHref" : "https://api.moysklad.ru/api/remap/1.2/entity/contract/metadata" ,
"type" : "contract" ,
"m