Common Menu Import

Імпортування продуктів, офферів, опцій, груп опцій та категорій одним запитом

Ми розраховуємо на отримання від наших партнерів повної та актуальної інформації про їхнє меню для застосунку LOKO:

  • У рамках нашої системи інтеграції ми порівнюємо нові дані з попередньо наданими, щоб виявити зміни та адаптувати наше відображення меню.

  • Якщо інформації про конкретну категорію або її пропозицію немає, ми вважатимемо її недоступною і вимкнемо в нашому застосунку.

Categories

  • externalId – ідентифікатор вашої категорії.

  • name – назва категорії, яка відображатиметься на вітрині.

  • position – порядок відображення категорії на вітрині.

  • workSchedule – графік доступності товарів категорії на вітрині. Може мати лише один із двох параметрів: dailyWorkingHours або weeklyWorkingHours.

    • dailyWorkingHours – години доступності товарів категорії у визначені дні тижня:

      • weekDay – день тижня;

      • open – час, з якого товари категорії стають доступними на вітрині;

      • closed – час, з якого товари категорії стають недоступними на вітрині.

    • weeklyWorkingHours – години, у які товари категорії доступні щодня:

      • open – час, з якого товари категорії стають доступними на вітрині;

      • closed – час, з якого товари категорії стають недоступними на вітрині;

    • start – дата початку роботи категорії;

    • end – дата завершення роботи категорії.

    *start та end використовуються лише разом із weeklyWorkingHours.

Product

  • sku – артикул продукту, який має бути унікальним для закладу та не може повторюватися.

  • title – назва продукту, яка відображатиметься на вітрині.

  • description – опис продукту.

  • categories – ваші категорії продукту:

    • mainExternalId – головна категорія продукту;

    • extraExternalIds – додаткові категорії продукту.

  • optionGroups – модифікатори продукту:

    • externalId – ідентифікатор модифікатора в межах закладу;

    • sortOrder – позиція модифікатора відносно інших у загальному переліку модифікаторів при відображенні на вітрині.

  • media – посилання на зображення продукту.

  • unit – одиниця вимірювання продукту (наприклад: шт, упаковка, літр тощо).

Offer

  • storeId – ідентифікатор закладу в рамках компанії, який має надати інтегруюча сторона.

  • listPrice – ціна, яку сплачує Гість.

  • oldPrice – акційна ціна, що відображається на вітрині ( використовується виключно для відображення ).

  • sortOrder – значення, за яким будуть сортуватися пропозиції на вітрині.

  • stock – кількість продукту в рамках закладу.

  • status – може приймати enabled, або disabled.

    • enabled – пропозиція актуальна та відображається на вітрині;

    • disabled – пропозиція неактуальна та не відображається на вітрині.

Поле sortOrder має сортування по ASC. Тобто 0 буде мати найбільшу вагу, такі пропозиції будуть відображатися найвище на вітрині.

Option (інгредієнт)

  • sku – артикул інгредієнта, завжди унікальний у межах закладу, не може повторюватися.

  • title – назва інгредієнта, яка відображатиметься на вітрині.

  • media – посилання на зображення інгредієнта.

OptionGroup (модифікатор)

  • externalId – ідентифікатор модифікатора, який має бути унікальним для закладу та не може повторюватися.

  • title – назва модифікатора, яка відображатиметься на вітрині.

  • type – тип модифікатора:

    • single – дозволяє обрати лише один окремий інгредієнт групи;

    • multiple – дозволяє обрати будь-яку кількість окремих інгредієнтів групи;

    • complex - дозволяє обрати обмежену кількість інгредієнтів із вказаними параметрами min та max.

  • min – мінімальна кількість інгредієнтів, обовʼязкова для вибору (застосовується лише для модифікаторів типу complex).

  • max – максимальна кількість інгредієнтів, доступних для вибору (не може перевищувати 99; застосовується лише до модифікаторів типу complex та multiple).

  • options – перелік інгредієнтів, що входять до складу модифікатора:

    • sku – артикул інгредієнта;

    • sortOrder - позиція інгредієнта відносно інших у загальному переліку при відображенні на вітрині;

    • max - максимальна кількість одиниць інгредієнта, доступна для вибору (для типу complex).

Path parameters

  • id - ідентифікатор компанії, який має надати інтегруюча сторона.

Import company menu

post

Import company menu

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired

Internal identifier

Example: 569e7427-14ca-43f1-8d4b-ed3b7f1fd197
Body
Responses
202

Accepted

application/json
post
/v1/merchant/companies/{id}/import
PreviousMenuNextStop-list

Last updated