Live.CRM
До всіх інструкцій

Store API

Точний довідник зовнішнього API

Тут показані лише маршрути, які призначені для вітрин і дозволених інтеграцій магазину. Список згенеровано з чинного OpenAPI-контракту, тому шлях, метод, DTO та scope не вигадані вручну.

Компанія та команда

Створюються після входу через кабінет. Store API key не створює компанії й не дає прав адміністратора.

Вітрина магазину

Працює через окремий Api-Key, прив’язаний до tenant, store, sales surface і найменших потрібних scopes.

Webhooks провайдерів

Активуються через конкретне підключення. Їхні секрети, token paths і внутрішні callback-и не є публічним Store API.

Знайдено операцій: 24 із 24

POSTАналітика вітрини

Передати події вітрини

Приймає пакет клієнтських подій для аналітики та відсіює дублікати.

/api/v1/external/stores/{store_id}/analytics/eventsПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: analytics:write

Тіло запиту

application/json · StorefrontAnalyticsBatchRequest

Параметри

  • store_idшлях · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200StorefrontAnalyticsBatchResponse
GETКонтекст магазину

Перевірити можливості Store API

Показує готові та заплановані ресурси чинної версії контракту.

/api/v1/external/stores/{store_id}/capabilitiesПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: stores:read

Тіло запиту

Тіло не потрібне.

Параметри

  • store_idшлях · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200StoreApiCapabilitiesResponse
GETКаталог

Отримати каталог

Повертає сторінку товарів із пошуком, категорією та cursor pagination.

/api/v1/external/stores/{store_id}/catalogПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: catalog:read

Тіло запиту

Тіло не потрібне.

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • searchquery · string | null · необов’язковий
  • category_idquery · string | null · необов’язковий
  • cursorquery · string | null · необов’язковий
  • limitquery · integer · необов’язковий
  • pagequery · integer | null · необов’язковий
  • min_price_minorquery · integer | null · необов’язковий
  • max_price_minorquery · integer | null · необов’язковий
  • availabilityquery · policy | in_stock | incoming | out_of_stock · необов’язковий
  • sortquery · relevance | price_asc | price_desc | name_asc | newest | popular · необов’язковий
  • characteristicquery · string[] | null · необов’язковий

Успішна відповідь

  • HTTP 200StorefrontCatalogPage
GETКаталог

Отримати картку товару

Повертає дозволені для вітрини дані одного товару.

/api/v1/external/stores/{store_id}/catalog/products/{product_id}Показати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: catalog:read

Тіло запиту

Тіло не потрібне.

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • product_idшлях · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200StorefrontCatalogDetail
POSTОформлення

Створити платіжну сесію

Готує дозволений сценарій оплати для чинного checkout.

/api/v1/external/stores/{store_id}/checkout/payment-sessionsПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: orders:write

Тіло запиту

application/json · StorefrontPaymentSessionRequest

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • Idempotency-Keyзаголовок · string · обов’язковий

Успішна відповідь

  • HTTP 201StorefrontPaymentSessionResponse
POSTОформлення

Розрахувати оформлення

Фіксує серверну ціну, доставку та доступність перед створенням замовлення.

/api/v1/external/stores/{store_id}/checkout/quotesПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: orders:write

Тіло запиту

application/json · StorefrontQuoteRequest

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • Idempotency-Keyзаголовок · string · обов’язковий

Успішна відповідь

  • HTTP 200StorefrontQuoteResponse
POSTОформлення

Створити замовлення

Приймає перевірене оформлення та створює одну операцію за idempotency key.

/api/v1/external/stores/{store_id}/checkout/submissionsПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: orders:write

Тіло запиту

application/json · CommerceOrderSubmissionRequest

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • Idempotency-Keyзаголовок · string · обов’язковий

Успішна відповідь

  • HTTP 201CommerceOrderSubmissionAccepted
GETКонтекст магазину

Отримати контекст магазину

Повертає магазин, точку продажу та scopes поточного API-ключа.

/api/v1/external/stores/{store_id}/contextПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: stores:read

Тіло запиту

Тіло не потрібне.

Параметри

  • store_idшлях · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200StoreApiContextResponse
GETЗамовлення покупця

Отримати замовлення покупця

Повертає лише замовлення підтвердженої Telegram identity цієї вітрини.

/api/v1/external/stores/{store_id}/customer-ordersПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: orders:read

Тіло запиту

Тіло не потрібне.

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • identity_typequery · "telegram" · обов’язковий
  • identity_valuequery · string · обов’язковий
  • limitquery · integer · необов’язковий
  • cursorquery · string:uuid | null · необов’язковий

Успішна відповідь

  • HTTP 200StorefrontCustomerOrderPage
GETЗамовлення покупця

Отримати одне замовлення

Повертає деталі замовлення після перевірки identity та точки продажу.

/api/v1/external/stores/{store_id}/customer-orders/{order_id}Показати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: orders:read

Тіло запиту

Тіло не потрібне.

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • order_idшлях · string:uuid · обов’язковий
  • identity_typequery · "telegram" · обов’язковий
  • identity_valuequery · string · обов’язковий

Успішна відповідь

  • HTTP 200StorefrontCustomerOrderDetail
POSTЗамовлення покупця

Скасувати замовлення покупцем

Виконує дозволений перехід стану без повторної бізнес-операції.

/api/v1/external/stores/{store_id}/customer-orders/{order_id}/cancelПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: orders:write

Тіло запиту

application/json · StorefrontCustomerOrderIdentity

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • order_idшлях · string:uuid · обов’язковий
  • Idempotency-Keyзаголовок · string · обов’язковий

Успішна відповідь

  • HTTP 200StorefrontCustomerOrderDetail
POSTПеревірка оплати

Запросити перевірку оплати

Приймає повторюваний запит перевірки власного замовлення; прийнятий запит ще не означає підтверджену оплату.

/api/v1/external/stores/{store_id}/customer-orders/{order_id}/payment-check-requestsПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: orders:write

Тіло запиту

application/json · StorefrontCustomerOrderIdentity

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • order_idшлях · string:uuid · обов’язковий
  • Idempotency-Keyзаголовок · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200CommercePaymentCheckResponse
POSTЗамовлення покупця

Отримати реквізити оплати замовлення

Читає чинні реквізити власного замовлення після його передавання в KeyCRM; не змінює стан оплати.

/api/v1/external/stores/{store_id}/customer-orders/{order_id}/payment-instructionПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: orders:read

Тіло запиту

application/json · StorefrontCustomerOrderIdentity

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • order_idшлях · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200CommercePaymentInstruction
POSTЗамовлення покупця

Передати підтвердження оплати

Приймає коментар або файл квитанції у контрольованому payment flow.

/api/v1/external/stores/{store_id}/customer-orders/{order_id}/payment-proofsПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: orders:write

Тіло запиту

multipart/form-data · Body_post_customer_order_payment_proof_api_v1_external_stores__store_id__customer_orders__order_id__payment_proofs_post

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • order_idшлях · string:uuid · обов’язковий
  • Idempotency-Keyзаголовок · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200CustomerPaymentProofResponse
POSTПеревірка оплати

Повідомити про здійснену оплату

Приймає повідомлення покупця з необов’язковими коментарем і квитанцією; отримання повідомлення не підтверджує надходження коштів.

/api/v1/external/stores/{store_id}/customer-orders/{order_id}/payment-reportsПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: orders:write

Тіло запиту

multipart/form-data · Body_post_customer_order_payment_report_api_v1_external_stores__store_id__customer_orders__order_id__payment_reports_post

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • order_idшлях · string:uuid · обов’язковий
  • Idempotency-Keyзаголовок · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200StorefrontPaymentReportResponse
  • HTTP 201StorefrontPaymentReportResponse
GETДоставка

Знайти населений пункт

Шукає міста у підтриманому довіднику служби доставки.

/api/v1/external/stores/{store_id}/delivery/citiesПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: delivery:read

Тіло запиту

Тіло не потрібне.

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • providerquery · nova_poshta | ukrposhta · обов’язковий
  • qquery · string · обов’язковий
  • cursorquery · string | null · необов’язковий
  • limitquery · integer · необов’язковий

Успішна відповідь

  • HTTP 200DeliveryCitiesResponse
GETДоставка

Отримати відділення й поштомати

Повертає точки доставки міста та враховує обмеження вантажу з quote.

/api/v1/external/stores/{store_id}/delivery/pointsПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: delivery:read

Тіло запиту

Тіло не потрібне.

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • providerquery · nova_poshta | ukrposhta · обов’язковий
  • city_refquery · string · обов’язковий
  • typequery · branch | parcel_locker | null · необов’язковий
  • cursorquery · string | null · необов’язковий
  • limitquery · integer · необов’язковий
  • quote_idquery · string:uuid | null · необов’язковий

Успішна відповідь

  • HTTP 200DeliveryPointsResponse
POSTПідтримка

Створити звернення

Відкриває звернення підтримки у межах конкретної точки продажу.

/api/v1/external/stores/{store_id}/support/ticketsПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: support:write

Тіло запиту

application/json · StorefrontSupportTicketCreate

Параметри

  • store_idшлях · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 201StorefrontSupportTicketView
POSTПідтримка

Закрити звернення зі спільного каналу

Ідемпотентно закриває звернення й зберігає службовий audit каналу.

/api/v1/external/stores/{store_id}/support/tickets/{ticket_id}/channel-closeПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: support:write

Тіло запиту

application/json · StorefrontSupportChannelClose

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • ticket_idшлях · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200StorefrontSupportTicketView
POSTПідтримка

Відповісти зі спільного каналу

Фіксує відповідь перевіреного transport без вигаданого персонального менеджера.

/api/v1/external/stores/{store_id}/support/tickets/{ticket_id}/channel-repliesПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: support:write

Тіло запиту

application/json · StorefrontSupportChannelReply

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • ticket_idшлях · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200StorefrontSupportTicketView
POSTПідтримка

Взяти звернення в роботу

Закріплює звернення за дозволеною service identity.

/api/v1/external/stores/{store_id}/support/tickets/{ticket_id}/claimПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: support:write

Тіло запиту

application/json · StorefrontSupportClaim

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • ticket_idшлях · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200StorefrontSupportTicketView
POSTПідтримка

Закрити звернення

Завершує звернення контрольованим переходом стану.

/api/v1/external/stores/{store_id}/support/tickets/{ticket_id}/closeПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: support:write

Тіло запиту

application/json · StorefrontSupportClose

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • ticket_idшлях · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200StorefrontSupportTicketView
POSTПідтримка

Додати повідомлення до звернення

Додає повідомлення до наявного звернення цього магазину.

/api/v1/external/stores/{store_id}/support/tickets/{ticket_id}/messagesПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: support:write

Тіло запиту

application/json · StorefrontSupportMessageCreate

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • ticket_idшлях · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200StorefrontSupportTicketView
POSTПідтримка

Передати звернення

Передає звернення іншому дозволеному отримувачу з audit trail.

/api/v1/external/stores/{store_id}/support/tickets/{ticket_id}/transferПоказати контракт ↓

Доступ

Заголовок Authorization: Api-Key …

Потрібний scope: support:write

Тіло запиту

application/json · StorefrontSupportTransfer

Параметри

  • store_idшлях · string:uuid · обов’язковий
  • ticket_idшлях · string:uuid · обов’язковий

Успішна відповідь

  • HTTP 200StorefrontSupportTicketView