Платформи електронної комерції

Shopify PDF API для застосунків і бекенд-процесів

Викликайте gPdf із Shopify app або бекенд-процесу, щоб генерувати PDF замовлень, рахунки, пакувальні листи, повернення й етикетки з маплених даних Shopify.

ОСНОВНА API JSON Render
ШЛЯХ API /api/v1/pdf/render
СИСТЕМИ бекенд Shopify-застосунку / бекенд електронної комерції / OMS / процес виконання замовлень
Задача сценарію

Використати Shopify app або бекенд електронної комерції, щоб замапити дані замовлення, клієнта, товарів, виконання й повернення в gPdf JSON або дані шаблону, а потім повернути детерміновані PDF без заяви про офіційну інтеграцію Shopify App Store.

Коли використовувати цю API

  • Ви будуєте Shopify app, приватний бекенд або процес виконання замовлень, який може викликати зовнішні API.
  • Ваш застосунок уже отримує дані Shopify про замовлення, виконання, клієнта або товари.
  • Потрібні рахунки, пакувальні листи, документи повернення, складські етикетки або PDF-вкладення.
  • Потрібен стабільний контракт template_id для макетів документів конкретного продавця.

Що вона не замінює

  • Очікуєте, що gPdf буде офіційним Shopify app або listing у Shopify App Store.
  • Потрібно, щоб gPdf встановлювався в магазин продавця, обробляв OAuth або напряму підписувався на webhooks.
  • Потрібні тарифи доставки, купівля поштових послуг, керування залишками або UI-функції продавця від gPdf.

Який шлях API викликати

ОСНОВНИЙ

/api/v1/pdf/render

JSON Render — типовий шлях для цього сценарію.

ДОДАТКОВИЙ 1

/api/v1/template-render

Використовуйте, коли сценарію потрібен пов’язаний API-шлях, контракт шаблону або перевірка можливостей.

Мінімальний запит

POST /api/v1/template-render - бекенд застосунку надсилає маплені дані замовлення Shopify до опублікованого шаблону.

{
  "template_id": "packing_list",
  "data": [
    {
      "order_number": "#1042",
      "customer_name": "Example Buyer",
      "ship_to": "1200 Market St, San Francisco, CA",
      "items": [
        { "sku": "TSHIRT-BLK-M", "name": "Black T-shirt", "quantity": 2 },
        { "sku": "MUG-WHT", "name": "White mug", "quantity": 1 }
      ]
    }
  ]
}

Що виконує gPdf

  • PDF-рендеринг із JSON на основі даних Shopify, який мапить бекенд вашого застосунку.
  • Template Render для макетів документів конкретного продавця або бренду.
  • Штрихкоди, QR-коди, таблиці, підсумки, зображення, етикетки й структури packing slip.
  • Stateless-створення PDF через публічні API gPdf.

Що контролює ваша система

  • Код Shopify-застосунку, OAuth, webhooks, інтерфейс продавця й розповсюдження через каталог застосунків.
  • Мапінг даних замовлення, виконання, клієнта, повернення, товару й податків.
  • Конфігурацію продавця, вибір шаблону, доставку, зберігання й повторні спроби.

Чеклист для робочого запуску

  1. Тримайте облікові дані Shopify і gPdf API tokens у бекенді, а не в браузерному коді.
  2. Мапте дані Shopify в явне тіло запиту рендерингу або схему даних шаблону.
  3. Використовуйте Template Render для макетів конкретного продавця після затвердження.
  4. Зберігайте згенеровані PDF або вихідні дані відповідно до процесу продавця.
  5. Задокументуйте, що інтеграція — це ваш app, який викликає gPdf, а не офіційний gPdf Shopify app.

Межі заявлених можливостей

  • Не заявляйте офіційний публічний Shopify app, якщо такого продукту не існує.
  • gPdf не виконує Shopify OAuth, встановлення застосунку, webhooks або налаштування продавця.
  • Сервіс-викликач відповідає за мапінг даних Shopify і бізнес-правила електронної комерції.

Модель інтеграції

Чиста модель Shopify-інтеграції — backend-to-backend. Ваш застосунок отримує або завантажує дані Shopify, мапить їх у gPdf DocumentRequest або об’єкт даних шаблону, викликає gPdf і повертає або зберігає PDF відповідно до процесу продавця.

Так публічне твердження лишається точним: gPdf — це API створення PDF, який може викликати ваш Shopify app. Він не є офіційним публічним Shopify app, якщо такий окремий продукт-застосунок не існує.

Template Render пасує макетам продавців

PDF електронної комерції часто стають специфічними для продавця: брендинг, таблиці товарів, інструкції повернення, блоки етикеток, подарункові примітки й локалізований текст. Template Render дозволяє вашому застосунку тримати ці макети в опублікованих шаблонах, а самому застосунку надсилати лише маплені дані замовлення.

Тримайте логіку платформи в застосунку

OAuth, webhooks, налаштування продавця, стан виконання замовлення, залишки, правила повернення й розповсюдження через каталог застосунків залишаються у вашому Shopify app. gPdf має отримувати фінальні дані рендерингу й створювати PDF.

FAQ

Чи є gPdf офіційним Shopify app?
Ні. Ця сторінка для застосунків і бекендів, які викликають gPdf. Не представляйте gPdf як офіційну інтеграцію Shopify App Store, якщо такого продукту не існує.
Де має відбуватися виклик gPdf API?
Викликайте gPdf із вашого бекенду або сервера застосунку, де облікові дані Shopify і gPdf API tokens захищені.
PDF для Shopify мають використовувати JSON Render чи Template Render?
Використовуйте JSON Render для власних згенерованих макетів. Використовуйте Template Render, коли макет продавця або бренду затверджено і сервіси-викликачі мають надсилати лише дані.
Чи обробляє gPdf Shopify webhooks?
Ні. Ваш застосунок отримує webhooks, мапить дані й вирішує, коли рендерити. gPdf лише рендерить PDF-запит, який отримує.