Перейти до основного вмісту

Типи даних інтеграції

Кожен елемент, який зовнішня система надсилає чи читає, має тип даних. Код типу (наприклад PRODUCT) вказують у полі entityType елемента імпорту, і він повертається в кожній події стрічки змін. На цій сторінці перелічено всі типи та що можна робити з кожним.

  • Довідники — списки на кшталт товарів чи контрагентів. Зіставляються за вашими власними кодами; див. Формування payload.
  • Документи — заявки на надходження, приймання, відвантаження тощо.
  • Лише читання — документи, які створюються тільки у WMS; ваша система може їх читати, але не надсилати.

Структура кожного типу — така сама, як у звичайному API: посилання в кожному розділі відкривають відповідну операцію у Swagger. Чим відрізняються ідентифікатори, описано в Формуванні payload.

ТипКодРізновидІмпортСтрічка змінРесинхронізація
СкладWAREHOUSEДовідниктак——
КонтрагентPARTYДовідниктактактак
ТоварPRODUCTДовідниктактактак
Набір товарівPRODUCT_SETДовідниктактактак
Характеристика товаруPRODUCT_FEATUREДовідниктактактак
Категорія товарівPRODUCT_CATEGORYДовідниктак—так
Група обробки товарівPRODUCT_HANDLING_GROUPДовідниктактактак
АтрибутATTRIBUTEДовідниктактактак
Одиниця виміруUNIT_OF_MEASUREДовідниктак—так
Тип упаковкиPACK_TYPEДовідниктак—так
Набір типів упаковкиPACK_TYPE_SETДовідниктак—так
Група обробки упаковокPACK_TYPE_HANDLING_GROUPДовідниктактактак
Місце зберіганняLOCATIONДовідниктактак—
Тип контейнераCONTAINER_TYPEДовідниктактак—
КонтейнерCONTAINERДовідниктактактак
Політика обліку партійLOT_TRACKING_POLICYДовідниктактак—
ПартіяLOTДовідниктактактак
ШтрихкодBARCODEДовідниктак—так
Заявка на надходженняINBOUND_ORDERДокументтактак—
ПрийманняRECEIPTДокументтактак—
Заявка на відвантаженняOUTBOUND_ORDERДокументтактак—
Початкові залишкиOPENING_BALANCEДокументтак——
ВідвантаженняDISPATCHДокументтактактак
Початкові залишки зворотної тариRETURNABLE_CONTAINER_OPENING_BALANCEДокументтак——
Врегулювання боргу за таруCONTAINER_DEBT_SETTLEMENTДокументтактак—
ПерерахунокINVENTORY_COUNTЛише читання—тактак
Незапланований відбірUNPLANNED_PICKINGЛише читання—тактак

Залишки на дату — не тип даних: це запит, що повертає залишки на дату; їх не імпортують і вони не публікуються в стрічці змін.

Склад (WAREHOUSE)​

Склад. Зазвичай його налаштовують у WMS, а зовнішня система переважно зіставляє з ним свої склади.

WMS не публікує цей тип. Він потрапляє до вашої системи лише як ідентифікатор усередині інших даних.

Контрагент (PARTY)​

Контрагент: постачальник, клієнт, перевізник чи власник товару.

Товар (PRODUCT)​

Товар (номенклатура) каталогу.

Набір товарів (PRODUCT_SET)​

Набір товарів, з якими працюють разом.

Характеристика товару (PRODUCT_FEATURE)​

Характеристика (варіант) товару, наприклад розмір чи колір.

Прапорець deleted не підтримується; використовуйте режим видалення.

Категорія товарів (PRODUCT_CATEGORY)​

Категорія каталогу товарів.

Група обробки товарів (PRODUCT_HANDLING_GROUP)​

Група товарів з однаковими правилами обробки.

Атрибут (ATTRIBUTE)​

Додатковий атрибут, який можна додавати до записів каталогу.

Одиниця виміру (UNIT_OF_MEASURE)​

Одиниця виміру.

Тип упаковки (PACK_TYPE)​

Тип упаковки: коробка, палета тощо, з кількістю базових одиниць.

Набір типів упаковки (PACK_TYPE_SET)​

Набір типів упаковки, якими користується товар.

Група обробки упаковок (PACK_TYPE_HANDLING_GROUP)​

Група типів упаковки з однаковими правилами обробки.

Місце зберігання (LOCATION)​

Місце зберігання (комірка чи зона) складу.

Тип контейнера (CONTAINER_TYPE)​

Тип контейнера: палета, ящик, тара тощо.

Контейнер (CONTAINER)​

Контейнер з власним кодом.

Політика обліку партій (LOT_TRACKING_POLICY)​

Правила обліку партій товару.

Партія (LOT)​

Партія товару.

Штрихкод (BARCODE)​

Штрихкод товару чи упаковки.

Зміни цього типу не публікуються в стрічці змін. Щоб отримати їх, запустіть ресинхронізацію цього типу.

Ідентифікатор штрихкоду у WMS — число, а не UUID; {"wmsId": …} для штрихкоду містить це число рядком.

Прапорець deleted не підтримується; використовуйте режим видалення.

Заявка на надходження (INBOUND_ORDER)​

Заявка на надходження: товар, який склад очікує прийняти.

Приймання (RECEIPT)​

Приймання: фактично прийнятий товар.

Заявка на відвантаження (OUTBOUND_ORDER)​

Заявка на відвантаження: товар, який треба відібрати й відвантажити.

Початкові залишки (OPENING_BALANCE)​

Початкові залишки, які завантажують на старті роботи з WMS.

WMS не публікує цей тип. Він потрапляє до вашої системи лише як ідентифікатор усередині інших даних.

Відвантаження (DISPATCH)​

Відвантаження: товар, що фактично залишив склад.

Початкові залишки зворотної тари (RETURNABLE_CONTAINER_OPENING_BALANCE)​

Початкові залишки зворотної тари в контрагентів.

WMS не публікує цей тип. Він потрапляє до вашої системи лише як ідентифікатор усередині інших даних.

Врегулювання боргу за тару (CONTAINER_DEBT_SETTLEMENT)​

Врегулювання боргу контрагента за зворотну тару.

Перерахунок (INVENTORY_COUNT)​

Перерахунок (інвентаризація), проведений у WMS.

  • Різновид: Лише читання
  • Режими імпорту: не імпортується
  • Читання: стрічка змін і ресинхронізація; обидва потребують Читання change feed
  • Що ви читаєте: GET /api/v1/inventory/counts/{id} (InventoryCountFullResponseDto)

Незапланований відбір (UNPLANNED_PICKING)​

Незапланований відбір, проведений у WMS.

  • Різновид: Лише читання
  • Режими імпорту: не імпортується
  • Читання: стрічка змін і ресинхронізація; обидва потребують Читання change feed
  • Що ви читаєте: GET /api/v1/outbound/pickings/{id} (PickingFullResponseDto)