Заказ

Структура:

{
  "orders":[
    {
      "manager":{},
      "customer":{},
      "order":{},
      "delivery":{},
      "deliveryAddress":{},
      "orderPrice":{},
      "orderDiscount":[
        {...},
        {...}
      ],
      "customer":{},
      "customerAddress":{},
      "customerSource":{},
      "organization":{},
      "payment":[
        {...},
        {...}
      ],
      "receiver":{},
      "source":{},
      "external":{},
      "deliveryPrice":{},
      "position":[
        {...},
        {...}
      ],
      "status":{},
      "shipment":{},
      "shipmentAddress":{},
    },
    {
     ....
    }
  ]
}

Информация о менеджере (Manager)

# Наименование переменной Тип Комментарий
manager
1manager.idStringИдентификатор менеджера
2manager.firstNameStringИмя менеджера
3manager.secondNameStringОтчество менеджера
4manager.lastNameStringФамилия менеджера
5manager.emailStringЭлектронный адрес менеджера
6manager.commentStringКомментарий к менеджеру
7manager.phoneNumber1StringТелефон менеджера 1
8manager.phoneNumber2StringТелефон менеджера 2
9manager.phoneNumber3StringТелефон менеджера 3
10manager.phoneNumber4StringТелефон менеджера 4
11manager.phoneNumber5StringТелефон менеджера 5
12manager.otherPhonesStringЕщё телефоны
13manager.faxStringФакс менеджера
14manager.email2StringЭлектронный адрес менеджера 2

Информация о заказе (Order)

# Наименование переменной Тип Комментарий
order
1order.idStringИдентификатор заказа
2order.createDateTimeLocalDateTimeДата создания заказа у партнёра
3order.updateDateTimeLocalDateTimeДата обновления заказа у партнёра
4order.deleteDateTimeLocalDateTimeДата удаления/архивирования у партнёра
5order.acceptDateTimeLocalDateTimeДата-время согласования заказа
6order.closeDateTimeLocalDateTimeДата-время закрытия заказа
7order.typeStringТип заказа
8order.weightBigDecimalВес заказа
9order.widthBigDecimalШирина заказа
10order.heightBigDecimalВысота заказа
11order.lengthBigDecimalДлинна заказа/Глубина
12order.volumeBigDecimalОбъем заказ
13order.customerCommentStringКомменатрий клиента
14order.managerCommentStringКомментарий менеджера
15order.fullyPaidDateTimeLocalDateTimeДата полной оплаты заказа
16order.paymentMethodStringСпособ оплаты
17order.paymentStatusStringСтатус оплаты по заказу
18order.paymentDetailStringДетали оплаты по заказу
19order.paymentGatewayIdString
20order.addToGateDateTimeLocalDateTimeДата добавления заказа в Helpim
21order.updateInGateDateTimeLocalDateTimeДата обновления заказа в Helpim
22order.previousStatusStringПредыдущий статус заказа
23order.shopCodeStringКод магазина
24order.shopNameStringНазвание магазина
25order.shopUrlStringURL магазина
26order.methodStringСпособ оформления
27order.nameStringНазвание заказа
28order.callbackRequiredStringТребуется перезвонить (bool)
29order.expiredStringЗаказ просрочен
30order.scoreStringОценка заказа
31order.scoreDateTimeLocalDateTimeДата и время получение оценки от покупателя
32order.marketplaceCodeStringКод маркетплейс площадки (Яндекс?)
33order.marketplaceorderIdStringИдентификатор заказа на маркетплейс площадке (Яндекс?)
34order.fromApiStringЗаказ поступил через API (bool)
35order.uploadedToExternalStoreSystemStringЗаказ выгружен во внешнюю складскую систему (bool)
36order.keyString

Информация по доставке к заказу (Delivery)

# Наименование переменной Тип Комментарий
delivery
1delivery.idStringИдентификатор доставки
2delivery.serviceStringВид услуги
3delivery.methodStringМетод доставки
4delivery.typeStringТип отправления
5delivery.codeStringКод службы доставки
6delivery.nameStringНазвание службы доставки
7delivery.descriptionStringОписание доставки
8delivery.barCodeStringШтрих-код курьерской компании
9delivery.sendOrderdateStringДата отправки заказа в сервис доставки
10delivery.trackingCodeStringКод отслеживания
11delivery.orderIdStringID заказа в КК
12delivery.statusStringСтатус заказа в КК
13delivery.statusCommentStringКомментарий к статусу в КК
14delivery.statusdateTimeLocalDateTimeДата смены на текущий статус
15delivery.contentDescriptionStringТип содержимого (мартас, игрушки)
16delivery.dateStringЖелаемая дата доставки
17delivery.plannedDateStringПланируемая дата доставки
18delivery.factDateTimeLocalDateTimeФактическая дата доставки
19delivery.factTimeStringФактическое время доставки
20delivery.timeFrom1StringВремя доставки от
21delivery.timeTo1StringВремя доставки до
22delivery.timeFrom2StringВремя доставки от 2
23delivery.timeTo2StringВремя доставки до 2
24delivery.timeTextStringВремя доставки (вольная форма)
25delivery.commentStringКомментарий для КК
26delivery.labelStringСсылки на наклейки
27delivery.stickerStringСсылки на наклейки
28delivery.stateStringДоп. параметр к статус доставки
29delivery.stateCommentStringКомментарий к дополнительному параметру
30delivery.cashReceiptAmountStringСумма полученная по заказу
31delivery.returnStatusStringВозврат (boolen)
32delivery.selfPickupStringСамовывоз (boolen)
33delivery.docStringСсылка на документы(акты)
34delivery.isVolumetricStringОбъёмный заказ (boolen)
35delivery.packingStringДополнительная упаковка (boolen)
36delivery.extraServiceStringДополнительные сервисы
37delivery.itemsCountStringКол-во предметов в заказе
38delivery.partialGiveoutdeniedStringЧастичная выдача запрещена (boolen)
39delivery.liftingPayedStringПодъём на этаж оплачен (boolen)
40delivery.courierCarNumberStringНомер а/м курьера
41delivery.courierPhoneStringТелефон курьера
42delivery.courierNameStringИмя курьера
43delivery.courierPhotoUrlStringФото курьера
44delivery.partiallyStringВыдано частично
45delivery.serviceActiveStringСтатус активности службы доставки(?) (bool)
46delivery.integrationCodeStringИнтеграционный код типа доставки
47delivery.payerTypeStringТип плательщика за доставку (получатель/отправитель)
48delivery.piecesOfFreightStringКоличество мест
49delivery.notifyReceiverBySmsStringТребуется оповестить покупателя через SMS
50delivery.notifyReceiverByCallStringТребуется оповестить покупателя звонком
51delivery.coordinationRequiredStringТребуется согласование доставки
52delivery.callsAllowedIntervalStringВременной интервал, когда можно звонить покупателю
53delivery.paymentTransferedStringПризнак перечисления денежных средств

Адрес доставки (DeliveryAddress)

# Наименование переменной Тип Комментарий
deliveryAddress
1deliveryAddress.idStringИдентификатор адреса доставки
2deliveryAddress.kladrCodeStringКод КЛАДР
3deliveryAddress.countryStringСтрана
4deliveryAddress.countryIdStringИдентификатор страны доставки
5deliveryAddress.countryIso2StringISO-код страны 2-символьный
6deliveryAddress.countryIso3StringISO-код страны 3-символьный
7deliveryAddress.indexStringИндекс доставки
8deliveryAddress.index2StringИндекс доставки 2
9deliveryAddress.regionStringРегион доставки
10deliveryAddress.regionIdStringИдентификатор региона
11deliveryAddress.regionCodeStringКод региона
12deliveryAddress.regionTypeStringТип региона
13deliveryAddress.regionNameStringНазвание региона
14deliveryAddress.cityStringГород доставки
15deliveryAddress.cityIdStringИдентификатор города доставки
16deliveryAddress.cityTypeStringТип города доставки
17deliveryAddress.cityNameStringНазвание города доставки
18deliveryAddress.settlementStringПоселение
19deliveryAddress.settlementTypeString
20deliveryAddress.areaStringРайон/Микрорайон
21deliveryAddress.areaTypeStringТип района
22deliveryAddress.streetStringУлица
23deliveryAddress.streetIdStringИдентификатор улицы
24deliveryAddress.streetTypeStringТип улицы
25deliveryAddress.streetNameStringНазвание улицы
26deliveryAddress.buildingStringДом
27deliveryAddress.houseStringСтроение/Корпус/Литера
28deliveryAddress.caseStringСтроение
29deliveryAddress.blockStringПодъезд
30deliveryAddress.floorStringЭтаж
31deliveryAddress.flatStringКвартира
32deliveryAddress.intercomStringДомофон
33deliveryAddress.metroStringСтанция метро
34deliveryAddress.metroIdStringИдентификатор станции метро
35deliveryAddress.textStringУлица, дом и т.д. одной строкой
36deliveryAddress.line1StringУлица, дом и т.д. двумя строками (1/2)
37deliveryAddress.line2StringУлица, дом и т.д. двумя строками (2/2)
38deliveryAddress.fullStringПолный адрес доставки
39deliveryAddress.noteStringПримечание к адресу
40deliveryAddress.fullWithNoteStringПолный адрес доставки с примечанием
41deliveryAddress.pvzIdStringТерминал/ПВЗ (id/код)
42deliveryAddress.pvzAddressStringТерминал/ПВЗ (адрес)
43deliveryAddress.postCodeStringИндекс доставки почтой
44deliveryAddress.postRegionStringРегион доставки почтой
45deliveryAddress.postAreaStringРайон доставки почтой

Общие данные по стоимости заказа (OrderPrice)

# Наименование переменной Тип Комментарий
orderPrice
1orderPrice.idStringИдентификатор стоимости заказа
2orderPrice.baseBigDecimalБазовая стоимость заказа
3orderPrice.totalBigDecimalИтоговая стоимость заказа с учетом скидок/налога/доставки
4orderPrice.discountAmountBigDecimalСкидка по заказу в валюте
5orderPrice.discountPercentBigDecimalСкидка по заказу в %
6orderPrice.purchaseBigDecimalЗакупочная стоимость по заказу
7orderPrice.estimatedBigDecimalОценочная стоимость по заказу
8orderPrice.vatAmountBigDecimalЗначение налога
9orderPrice.vatEnabledStringАктивность поля налога (bool)
10orderPrice.vatIncludedStringВходит вOrderPriceTotal или нет (bool)
11orderPrice.currencyStringВалюта
12orderPrice.prepaidStringПредоплаченная сумма
13orderPrice.marginStringМаржа

Информация о скидках (orderDiscount)

# Наименование переменной Тип Комментарий
orderDiscount[]
1orderDiscount.idStringИдентификатор скидки
2orderDiscount.descriptionStringОписание скидки
3orderDiscount.typeIdStringТип скидки
4orderDiscount.amountBigDecimalСкидка в валюте
5orderDiscount.fullAmountBigDecimalПолнаяскидка в валюте
6orderDiscount.percentBigDecimalСкидка в %
7orderDiscount.valueBigDecimalВеличина скидки (в % или валюте)
8orderDiscount.referenceIdString
9orderDiscount.referenceTypeString
10orderDiscount.discountCodeIdStringКод сидки
11orderDiscount.createDateTimeLocalDateTimeДата-время создания
12orderDiscount.updateDateTimeLocalDateTimeДата-время обновления
13orderDiscount.couponCodeStringКод купона на скидку

Информация о покупателе (Customer)

# Наименование переменной Тип Комментарий
customer
1customer.idStringИдентификатор объекта (нужен для списковых объектов)
2customer.typeStringТип клиета
3customer.codeStringКод клиента
4customer.externalcodeStringВнешний код клиента
5customer.fullNameStringФИО
6customer.firstNameStringИмя
7customer.secondNameStringОтчество
8customer.lastNameStringФамилия
9customer.commentStringКомментарий
10customer.descriptionStringОписание
11customer.emailStringЭлектронный адрес
12customer.phoneNumber1StringНомер телефона
13customer.phoneNumber2StringНомер телефона 2
14customer.phoneNumber3StringНомер телефона 3
15customer.phoneNumber4StringНомер телефона 4
16customer.phoneNumber5StringНомер телефона 5
17customer.otherPhonesStringМассив дополнительных телефонов
18customer.faxStringФакс
19customer.companyTypeStringТип компании(юридическое лицо, индивидуальный предприниматель)
20customer.legalNameStringЮридическое наименование
21customer.legalAddressStringЮридический адрес
22customer.actualAddressStringПочтовый адрес
23customer.innStringИНН
24customer.okpoStringОКП
25customer.kppStringКПП
26customer.ogrnStringОГРН
27customer.ogrnipStringОГРНИП
28customer.bikStringБИК
29customer.bankStringНаименование банка
30customer.bankAddressStringАдрес банка
31customer.corrAccountStringКорреспондентский счет
32customer.bankAccountStringРасчётный счет
33customer.certificateNumberStringНомер свидетельства о регистрации
34customer.certificateDateStringДата регистрации
35customer.browserIdStringИдентификатор устройства в Collector (RetailCRM)
36customer.sexStringПол клиента
37customer.createDateTimeLocalDateTimeДата-время создания клиента
38customer.updateDateTimeLocalDateTimeДата-время обновления клиента
39customer.birthdayDateLocalDateTimeДень рождения клиента
40customer.managerIdStringМенеджер клиента
41customer.vipStringВажный клиент
42customer.badStringПлохой клиент
43customer.sitecodeStringМагазин, с которого пришел клиент
44customer.discountGroupStringДисконтная группа
45customer.personalDiscountStringПерсональная скидка
46customer.cumulativeDiscountStringНакопительная скидка
47customer.discountcardNumberStringНомер дисконтной карты
48customer.emailMarketingUnsubscribedAtStringДата отписки от email рассылок
49customer.avgMarginSummBigDecimalСредняя валовая прибыль по заказам клиента
50customer.marginSummBigDecimalLTV
51customer.totalSummBigDecimalОбщая сумма заказов
52customer.averageSummBigDecimalСредняя сумма заказа
53customer.orderscountStringКоличество заказов
54customer.maturationTimeStringВремя «созревания», в секундах
55customer.firstclientIdStringПервая метка клиента Google Analytics
56customer.lastclientIdStringПоследняя метка клиента Google Analytics
57customer.clientIdStringМетка клиента Google Analytics
58customer.bonusPointsStringБонусные баллы
59customer.groupStringГруппа/категория
60customer.isRegisteredStringЗарегистрированный клиент (bool)

Адрес покупателя (CustomerAddress)

# Наименование переменной Тип Комментарий
customerAddress
1customerAddress.idStringИдентификатор адреса
2customerAddress.countryStringСтрана
3customerAddress.countryIdStringИдентификатор страны
4customerAddress.countryIso2StringISO-код страны 2-символьный
5customerAddress.countyIso3StringISO-код страны 3-символьный
6customerAddress.indexStringИндекс
7customerAddress.regionStringРегион
8customerAddress.regionIdStringИдентификатор региона
9customerAddress.regionCodeStringКод региона
10customerAddress.cityStringГород
11customerAddress.cityIdStringИдентификатор города
12customerAddress.cityTypeStringТип города
13customerAddress.settlementStringПоселение
14customerAddress.areaStringРайон/Микрорайон
15customerAddress.streetStringНаименование улицы
16customerAddress.streetIdStringИдентификатор улицы
17customerAddress.streetTypeStringТип улицы
18customerAddress.buildingStringДом
19customerAddress.blockStringПодъезд
20customerAddress.houseStringСтроение/Корпус/Литера
21customerAddress.caseStringСтроение
22customerAddress.floorStringЭтаж
23customerAddress.flatStringКвартира
24customerAddress.intercomStringДомофон
25customerAddress.metroStringМетро
26customerAddress.textStringУлица, дом и т.п. одной строкой
27customerAddress.line1StringУлица, дом и т.п. двумя строками (1/2)
28customerAddress.line2StringУлица, дом и т.п. двумя строками (2/2)
29customerAddress.fullStringПолный адрес
30customerAddress.noteStringПримечание к адресу

Информация о рекламной кампании/источнике по которой оформил заказ покупатель (CustomerSource)

# Наименование переменной Тип Комментарий
customerSource
1customerSource.nameStringИсточник
2customerSource.mediumStringКанал
3customerSource.campaignStringКампания
4customerSource.keywordStringКлючевое слово
5customerSource.contentStringСодержание кампании
6customerSource.refererString
7customerSource.currentLocationStringМестонахождение
8customerSource.queryStringСтрока запроса
9customerSource.domainStringДомен

Данные об организации, юридическом лице, заказчике (Organization)

# Наименование переменной Тип Комментарий
organization
1organization.idStringИдентификатор организации
2organization.typeStringТип компании(юридическое лицо, индивидуальный предприниматель)
3organization.codeStringКод организации
4organization.externalCodeStringВнешний код организации
5organization.nameStringНаименование
6organization.descriptionStringОписание
7organization.emailStringЭлектронный адрес
8organization.phoneStringТелефон
9organization.faxStringФакс
10organization.companyTypeStringФорма собственности
11organization.legalNameStringЮридическое наименование
12organization.legalAddressStringЮридический адрес
13organization.actualAddressStringПочтовый адрес
14organization.innStringИНН
15organization.okpoStringОКП
16organization.kppStringКПП
17organization.ogrnStringОГРН
18organization.ogrnipStringОГРНИП
19organization.bikStringБИК
20organization.bankStringНаименование банка
21organization.bankAddressStringАдрес банка
22organization.corrAccountStringКорреспондентский счет
23organization.bankAccountStringРасчётный счет
24organization.certificateNumberStringНомер свидетельства о регистрации
25organization.certificateDateStringДата регистрации
26organization.metaHrefString
27organization.metaTypeString
28organization.metaMediaTypeString

Информация о платежах по заказу (Payment)

# Наименование переменной Тип Комментарий
payment[]
1payment.idStringИндентификатор платежа
2payment.externalIdStringИдентификатор в сервисе
3payment.totalBigDecimalСумма платежа
4payment.subTotalBigDecimalСтоимость без учета дополнительных услуг
5payment.typeStringТип платежа
6payment.statusStringСтатус платежа
7payment.detailStringДетали платежа
8payment.returnStringВозврат(true/false)
9payment.prepaidBigDecimalПредоплата(true/false)
10payment.dateTimeLocalDateTimeДата платежа
11payment.currencyStringВалюта платежа

Информация о получателе заказа (ReceiverData)

# Наименование переменной Тип Комментарий
receiverЕсли не указана информация по получателю, то используются данные покупателя (customer)
1receiver.idStringИдентификатор объекта (нужен для списковых объектов)
2receiver.typeStringТип получателя
3receiver.codeStringКод получателя
4receiver.externalCodeStringВнешний код получателя
5receiver.nameFullStringФИО
6receiver.firstNameStringИмя
7receiver.secondNameStringОтчество
8receiver.lastNameStringФамилия
9receiver.commentStringКомментарий
10receiver.descriptionStringОписание
11receiver.emailStringЭлектронный адрес
12receiver.phoneNumber1StringНомер телефона
13receiver.phoneNumber2StringНомер телефона 2
14receiver.phoneNumber3StringНомер телефона 3
15receiver.phoneNumber4StringНомер телефона 4
16receiver.phoneNumber5StringНомер телефона 5
17receiver.otherPhonesStringМассив дополнительных телефонов
18receiver.faxStringФакс
19receiver.companyTypeStringТип компании(юридическое лицо, индивидуальный предприниматель)
20receiver.legalNameStringЮридическое наименование
21receiver.legalAddressStringЮридический адрес
22receiver.actualAddressStringПочтовый адрес
23receiver.innStringИНН
24receiver.okpoStringОКП
25receiver.kppStringКПП
26receiver.ogrnStringОГРН
27receiver.ogrnipStringОГРНИП
28receiver.bikStringБИК
29receiver.bankStringНаименование банка
30receiver.bankAddressStringАдрес банка
31receiver.corrAccountStringКорреспондентский счет
32receiver.bankAccountStringРасчётный счет
33receiver.certificateNumberStringНомер свидетельства о регистрации
34receiver.certificateDateStringДата регистрации
35receiver.metaHrefString
36receiver.metaTypeString
37receiver.metaMediaTypeString

Информация о источнике заказа (Source)

# Наименование переменной Тип Комментарий
source
1source.idStringИдентификатор источника
2source.nameStringНазвание источника
3source.mediumStringТип трафика
4source.campaignStringНазвание компании
5source.keywordStringКлючевые слова
6source.contentStringСодержание
7source.customerIpStringIP-адрес клиента
8source.domainStringХост реферальной ссылки
9source.refererStringURL реферальной ссылки
10source.pageUrlStringСтраница, с которой отправлена заявка
11source.pageNameStringСтраница, с которой отправлена заявка
12source.currentLocationStringМестонахождение
13source.queryStringСтрока запроса

Идентификатор заказа в различных системах (External)

# Наименование переменной Тип Комментарий
external
1external.processingUuidUUID процессинга в Helpim
2external.idВнешний ID
3external.codeВнешний код
4external.numberВнешний номер заказа
5external.customerIdВнешний id клиента
6external.managerIdВнешний id менеджера
7external.organizationIdВнешний id организации

Данные о стоимости доставки (DeliveryPrice)

# Наименование переменной Тип Комментарий
deliveryPrice
1deliveryPrice.idStringИдентификатор стоимости доставки
2deliveryPrice.partnerString
3deliveryPrice.jobString
4deliveryPrice.cashServicesString
5deliveryPrice.targetString
6deliveryPrice.targetStartString
7deliveryPrice.sumToGetStringСумма к получению с клиента
8deliveryPrice.totalBigDecimalИтоговая цена доставки
9deliveryPrice.insuranceBigDecimalСтраховая сумма
10deliveryPrice.baseBigDecimalБазовая цена доставки
11deliveryPrice.specialCodeString
12deliveryPrice.resultString
13deliveryPrice.msgString
14deliveryPrice.errorString
15deliveryPrice.errorMsgString
16deliveryPrice.flagErrorString
17deliveryPrice.nameString
18deliveryPrice.priceB2CPLBigDecimal
19deliveryPrice.insuranceFeeBigDecimalСтраховой взнос
20deliveryPrice.agencyFeeBigDecimalАгентский сбор
21deliveryPrice.weightFeeStringНаценка за вес
22deliveryPrice.codeString
23deliveryPrice.nameWorkTimeString
24deliveryPrice.gpsString
25deliveryPrice.locationString
26deliveryPrice.addressString
27deliveryPrice.descriptionString
28deliveryPrice.partialReturnString
29deliveryPrice.partialdateString
30deliveryPrice.partialFirstdateString
31deliveryPrice.vatRateBigDecimalСтавка НДС (%)

Данные о товарах в заказе (Position)

# Наименование переменной Тип Комментарий
position[]
1position.idStringИдентификатор
2position.archivedStringАктивная/архивная позиция (boolen)
3position.externalIdStringВнешний идентификатор товара
4position.articleStringАртикул товара
5position.codeStringКод товара
6position.externalCodeStringВнешний код товара
7position.barCodeStringШтрих-код товара
8position.serialNumberTrackableStringУчёт по серийным номерам (bool) (Мой Склад)
9position.variantStringВариант товара (размер, цвет и т.д)
10position.nameStringНаименование
11position.descriptionStringОписание
12position.imageStringСсылка на изображение
13position.weightBigDecimalВес
14position.volumeBigDecimalОбъем
15position.dimensionsStringРазмеры
16position.createDateTimeLocalDateTimeДата добавления
17position.updateDateTimeLocalDateTimeДата обновления
18position.groupStringГруппа товаров
19position.minpriceBigDecimalМинимальная стоимость
20position.accountIdString
21position.ownerString
22position.sharedString
23position.versionString
24position.couponCodeStringНомер купона
25position.initialpriceBigDecimalНачальная стоимость за единицу
26position.priceBigDecimalИтоговая стоимость за единицу
27position.totalPriceBigDecimalИтоговая стоимость за количество
28position.discountAmountBigDecimalСумма скидки
29position.discountPercentBigDecimalСкидка в %
30position.vatRateStringСтавка НДС (%)
31position.vatAmountBigDecimalСумма НДС
32position.offerVatRateBigDecimalСтавка НДС (%) (инф из номенклатуры)
33position.offerVatAmountBigDecimalСумма НДС (инф из номенклатуры)
34position.shippedStringФлаг в доставке
35position.reserveStringФлаг в резерве
36position.statusStringСтатус товара
37position.estimatedpriceBigDecimalОценочная стоимость
38position.quantityBigDecimalКоличество
39position.reservedQuantityBigDecimalЗарезервированное количество
40position.deliveredQuantityBigDecimalВыданное количество
41position.returnedQuantityBigDecimalВозвращенное количество
42position.noRefusalStringЗапрет отказа от позиции при частичной выдаче заказа
43position.typeStringТип товара
44position.commentStringКомментарий к позиции
45position.deliveryCommentStringКомментарий к позиции для КК
46position.allowedStringДополнительные условия выдачи позиции
47position.purchasepriceBigDecimalЗакупочная стоимость
48position.priceTypeStringТип цены
49position.unitStringЕдиница измерения
50position.conditionStringСостояние товара (кондиция/брак/etc)
51position.widthBigDecimalШирина
52position.heightBigDecimalВысота
53position.lengthBigDecimalДлина
54position.canceledStringДанный товар в заказе является отмененным

Статус заказа (Status)

# Наименование переменной Тип Комментарий
status
1status.idStringИдентификатор
2status.nameStringНаименование статуса
3status.codeStringКод статуса
4status.activeStringАктивен (boolen)
5status.groupStringГруппа к которой относится статус
6status.commentStringКомментарий к статусу
7status.dateTimeLocalDateTimeДата/время изменения статуса

Пользовательские поля (CustomField)

# Наименование переменной Тип Комментарий
customField[]
1customField.idStringИдентификатор
2customField.parentExtIdStringИдентификатор «родителя»
3customField.parentTypeStringТип «родителя»
4customField.nameStringНаименование
5customField.valueStringЗначение

Данные об отгрузке (Shipment)

# Наименование переменной Тип Комментарий
shipment
1shipment.idStringИдентификатор
2shipment.nameStringНаименование
3shipment.storeStringКод/ID склада
4shipment.orderIdStringID заказа в месте отгрузки
5shipment.statusDateTimeLocalDateTimeДата и время присвоение статуса
6shipment.plannedDateTimeLocalDateTimeПланируемая дата отгрузки
7shipment.factDateTimeLocalDateTimeФактическая дата отгрузки
8shipment.timeFromStringВремя отгрузки От
9shipment.timeToStringВремя отгрузки До
10shipment.commentStringКомментарий
11shipment.statusStringСтатус
12shipment.statusGroupStringГруппа статусов
13shipment.statusCommentStringКомментарий к статусу
14shipment.shippedStringОтгружено (boolen)
15shipment.labelStringЭтикетка/наклейка
16shipment.docStringСсылки на документы
17shipment.packingStringУпаковка (boolen)
18shipment.servicesStringУслуги в месте отгрузки
19shipment.itemsCountStringКоличество
20shipment.contactNameStringФИО ответственного
21shipment.contactPhoneStringТелефон ответственного

Адрес отгрузки, склада (ShipmentAddress)

# Наименование переменной Тип Комментарий
shipmentAddress
1shipmentAddress.idStringИдентификатор
2shipmentAddress.countyStringСтрана
3shipmentAddress.countyIdStringИдентификатор страны
4shipmentAddress.countyIso2StringISO-код страны 2-символьный
5shipmentAddress.countyIso3StringISO-код страны 3-символьный
6shipmentAddress.indexStringИндекс
7shipmentAddress.regionStringРегион
8shipmentAddress.regionIdStringИдентификатор региона
9shipmentAddress.cityStringГород
10shipmentAddress.cityIdStringИдентификатор города доставки
11shipmentAddress.cityTypeStringТип города доставки
12shipmentAddress.settlementStringПоселение
13shipmentAddress.areaStringРайон/Микрорайон
14shipmentAddress.streetStringНаименование улицы
15shipmentAddress.streetIdStringИдентификатор улицы
16shipmentAddress.streetTypeStringТип улицы
17shipmentAddress.buildingStringДом
18shipmentAddress.houseStringСтроение/Корпус/Литера
19shipmentAddress.blockStringПодъезд
20shipmentAddress.floorStringЭтаж
21shipmentAddress.flatStringКвартира
22shipmentAddress.intercomStringДомофон
23shipmentAddress.metroStringМетро
24shipmentAddress.textStringУлица, дом, корпус и т.п. одной строкой
25shipmentAddress.fullStringПолный адрес
26shipmentAddress.noteStringПримечание к адресу
27shipmentAddress.pvzIdStringТерминал/ПВЗ

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

Структура:

{
  "nomenclature":[
    {...},
    {...}
   ]
}

Номенклатура (Nomenclature)

# Наименование переменной Тип Комментарий
nomenclature[]
1nomenclature.idStringИдентификатор
2nomenclature.activeStringАктивность
3nomenclature.archivedStringАктивная/архивная позиция (boolen)
4nomenclature.externalIdStringВнешний ID товара
5nomenclature.articleStringАртикул
6nomenclature.codeStringКод
7nomenclature.barCodeStringШтрихкод номенклатуры
8nomenclature.serialnumberStringСерийный номер
9nomenclature.serialnumberTrackableStringУчет по серийным номерам. Не может быть указан вместе с alcoholic и weighed
10nomenclature.nameStringНазвание
11nomenclature.descriptionStringОписание
12nomenclature.manufacturerStringПроизводитель
13nomenclature.urlStringСсылка на страницу товара в магазине
14nomenclature.imageStringСсылка на изображение товара
15nomenclature.supplierStringКонтрагент-поставщик
16nomenclature.popularStringМетка Лидер продаж
17nomenclature.bestPriceStringМетка Лучшая цена
18nomenclature.newStringМетка Новинка
19nomenclature.recommendedStringМетка Рекомендуем
20nomenclature.weightBigDecimalВес
21nomenclature.volumeBigDecimalОбъем
22nomenclature.groupStringГруппа номенклатуры
23nomenclature.priceBigDecimalЦена
24nomenclature.minPriceBigDecimalМинимальная цена на товар
25nomenclature.maxPriceBigDecimalМаксимальная цена на товар
26nomenclature.purchasePriceBigDecimalСтоимость закупки
27nomenclature.vatBigDecimalНДС %
28nomenclature.effectiveVatBigDecimalРеальный НДС %
29nomenclature.accountIdStringID учетной записи
30nomenclature.ownerStringВладелец (Сотрудник)
31nomenclature.sharedStringОбщий доступ
32nomenclature.versionStringВерсия сущности
33nomenclature.minimumBalanceBigDecimalНеснижаемый остаток
34nomenclature.weighedStringВесовой товар
35nomenclature.measureShortnameStringМера. Короткое наименование(кг., л., шт. и т.д.)
36nomenclature.measureFullnameStringМера. Полное наименование(литр, штук и т.д.)
37nomenclature.updatedLocalDateTime
38nomenclature.unitStringЕдиница учёта
39nomenclature.palletTypeString
40nomenclature.inBoxCountString
41nomenclature.validDaysString
42nomenclature.inPalletCountString

Структура:

{
  "nomenclatureRemains":[
    {...},
    {...}
   ]
}

Данные об остатках товара (NomenclatureRemains)

# Наименование переменной Тип Комментарий
nomenclatureRemains[]
1nomenclatureRemains.idStringИдентификатор
2nomenclatureRemains.warehouseCodeStringКод склада
3nomenclatureRemains.itemCodeStringКод товара
4nomenclatureRemains.itemNameStringНаименование товара
5nomenclatureRemains.itemCountStringКоличество товара
6nomenclatureRemains.itemreserveCountStringКоличество товара в резерве
7nomenclatureRemains.itemShippedCountStringКоличество товара в пути