LOKO Merchant API
  • Getting Started
    • 🔌Процес інтеграції
    • 💂Отримання токену
    • 🪃Опрацювання Callback(Webhook)
  • General Terms & Conditions
    • 🔓Scope
    • ⚙️Environment
    • 🔑Company & Store
  • API Reference
    • Orders
    • Stores
    • Menu
      • Separate Product & Offer
      • Common Product + Offer (deprecated)
      • Common Menu Import
      • Stop-list
      • Import categories
    • Callbacks (webhooks)
Powered by GitBook
On this page
  1. API Reference
  2. Menu

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 – пропозиція неактуальна та не відображається на вітрині.

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 - ідентифікатор компанії, який має надати інтегруюча сторона.

PreviousCommon Product + Offer (deprecated)NextStop-list

Last updated 14 hours ago

Import company menu

post

Import company menu

Authorizations
Path parameters
idstring · uuidRequired

Internal identifier

Example: 569e7427-14ca-43f1-8d4b-ed3b7f1fd197
Body
Responses
202
Accepted
application/json
400
Bad request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
post
POST /v1/merchant/companies/{id}/import HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 2015

{
  "categories": [
    {
      "externalId": "66742",
      "name": "Burgers",
      "position": 1,
      "workSchedule": {
        "dailyWorkingHours": [
          {
            "weekDay": "monday",
            "open": "09:00",
            "closed": "18:00"
          },
          {
            "weekDay": "tuesday",
            "open": "09:00",
            "closed": "18:00"
          },
          {
            "weekDay": "wednesday",
            "open": "09:00",
            "closed": "18:00"
          },
          {
            "weekDay": "thursday",
            "open": "09:00",
            "closed": "18:00"
          },
          {
            "weekDay": "friday",
            "open": "09:00",
            "closed": "18:00"
          },
          {
            "weekDay": "saturday",
            "open": "10:00",
            "closed": "16:00"
          },
          {
            "weekDay": "sunday",
            "open": "10:00",
            "closed": "16:00"
          }
        ]
      }
    },
    {
      "externalId": "23456",
      "name": "Salads",
      "position": 2,
      "workSchedule": {
        "start": "2025-04-01",
        "end": "2025-07-01",
        "weeklyWorkingHours": {
          "open": "09:00",
          "closed": "18:00"
        }
      }
    },
    {
      "externalId": "77280",
      "name": "Soups",
      "position": 3,
      "workSchedule": {
        "start": "2025-04-01",
        "end": "2025-07-01"
      }
    }
  ],
  "options": [
    {
      "sku": "0000040369",
      "title": "Sauce",
      "media": "https://example.com/berry.png",
      "offers": [
        {
          "storeId": "c6036747-f91c-4142-891d-c39104ece507",
          "listPrice": 10,
          "oldPrice": 12,
          "stock": 55,
          "status": "enabled"
        }
      ]
    },
    {
      "sku": "0000040370",
      "title": "Crispy Onions",
      "media": "https://example.com/onion.png",
      "offers": [
        {
          "storeId": "c6036747-f91c-4142-891d-c39104ece507",
          "listPrice": 18,
          "oldPrice": 24,
          "stock": 13,
          "status": "enabled"
        }
      ]
    }
  ],
  "optionGroups": [
    {
      "externalId": "G_0001",
      "title": "Choose Your Sauce",
      "type": "complex",
      "min": 1,
      "max": 7,
      "options": [
        {
          "sku": "0000040369",
          "sortOrder": 1,
          "max": 4
        }
      ]
    },
    {
      "externalId": "G_0002",
      "title": "Add Some Crunch",
      "type": "single",
      "min": 1,
      "max": 1,
      "options": [
        {
          "sku": "0000040370",
          "sortOrder": 1,
          "max": 1
        }
      ]
    }
  ],
  "products": [
    {
      "sku": "0000040367",
      "title": "Creamy Pumpkin Soup",
      "description": "Made with roasted squash, coconut milk and curry spices, it's healthy, comforting and delicious. Vegan.",
      "categories": {
        "mainExternalId": "66742",
        "extraExternalIds": [
          "23456",
          "77280"
        ]
      },
      "media": "https://example.com/berry.png",
      "unit": "caps.",
      "optionGroups": [
        {
          "externalId": "G_0001",
          "sortOrder": 1
        },
        {
          "externalId": "G_0002",
          "sortOrder": 2
        }
      ],
      "offers": [
        {
          "storeId": "c6036747-f91c-4142-891d-c39104ece507",
          "listPrice": 100,
          "oldPrice": 120,
          "sortOrder": 1,
          "stock": 55,
          "status": "enabled"
        }
      ]
    }
  ]
}
{
  "id": "62a718ef7706fa4aab180bf2"
}