Платформы электронной коммерции

Shopify PDF API для apps и backend workflows

Вызывайте gPdf из Shopify app или backend workflow, чтобы генерировать order PDFs, invoices, packing slips, returns и labels из mapped Shopify data.

ОСНОВНАЯ API JSON Render
ENDPOINT /api/v1/pdf/render
СИСТЕМЫ Shopify app backend / ecommerce backend / OMS / fulfillment workflow
Задача сценария

Использовать Shopify app или ecommerce backend для mapping order, customer, product, fulfillment и return data в gPdf JSON или template data, затем возвращать детерминированные PDF без заявления native Shopify app-store integration.

Когда использовать эту API

  • Вы создаете Shopify app, private backend или fulfillment workflow, который может вызывать external APIs.
  • Ваш app уже получает Shopify order, fulfillment, customer или product data.
  • Нужны invoices, packing slips, return documents, warehouse labels или PDF attachments.
  • Нужен стабильный контракт `template_id` для merchant-specific document layouts.

Что она не заменяет

  • Вы ожидаете, что gPdf будет official Shopify app или app-store listing.
  • Нужно, чтобы gPdf устанавливался в merchant store, обрабатывал OAuth или напрямую подписывался на webhooks.
  • Нужны shipping rates, postage purchase, inventory management или merchant UI features от gPdf.

Какой endpoint вызывать

ОСНОВНОЙ

/api/v1/pdf/render

JSON Render — путь по умолчанию для этого сценария.

ДОПОЛНИТЕЛЬНЫЙ 1

/api/v1/template-render

Используйте, когда сценарию нужен связанный API-путь, контракт шаблона или проверка возможностей.

Минимальный запрос

POST /api/v1/template-render - app backend отправляет mapped Shopify order data в published template.

{
  "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 rendering из Shopify-derived JSON, mapped by your app backend.
  • Template Render для merchant или brand-specific document layouts.
  • Barcodes, QR codes, tables, totals, images, labels и packing-slip structures.
  • Stateless PDF generation через публичные gPdf APIs.

Что контролирует ваша система

  • Shopify app code, OAuth, webhooks, merchant UI и app-store distribution.
  • Order, fulfillment, customer, return, product и tax data mapping.
  • Merchant configuration, template selection, delivery, storage и retries.

Production-чеклист

  1. Храните Shopify credentials и gPdf API tokens в backend, а не в browser code.
  2. Мапьте Shopify data в явный render payload или template data schema.
  3. Используйте Template Render для merchant-specific layouts после approval.
  4. Храните generated PDFs или source data согласно merchant workflow.
  5. Задокументируйте, что integration — это ваш app calling gPdf, а не official gPdf Shopify app.

Границы заявлений

  • Не заявляйте public official Shopify app, если он не существует.
  • gPdf не выполняет Shopify OAuth, app installation, webhooks или merchant settings.
  • Caller отвечает за Shopify data mapping и ecommerce business rules.

Integration model

Чистая модель Shopify integration — backend-to-backend. Ваш app получает или fetches Shopify data, мапит ее в gPdf DocumentRequest или template data object, вызывает gPdf и возвращает или сохраняет PDF согласно merchant workflow.

Так public claim остается точным: gPdf — PDF generation API, который может вызывать ваш Shopify app. Это не public official Shopify app, если отдельный app product не существует.

Template Render подходит для merchant layouts

Ecommerce PDFs часто становятся merchant-specific: branding, item tables, return instructions, label blocks, gift notes и localized text. Template Render позволяет app держать эти layouts в published templates, а самому app отправлять только mapped order data.

Platform logic остается в app

OAuth, webhooks, merchant settings, fulfillment state, inventory, return rules и app-store distribution остаются в вашем Shopify app. gPdf должен получать final render data и производить PDF.

FAQ

gPdf — официальный Shopify app?
Нет. Эта страница для apps и backends, которые вызывают gPdf. Не представляйте gPdf как official Shopify app-store integration, если такого продукта нет.
Где должен происходить gPdf API call?
Вызывайте gPdf из backend или app server, где Shopify credentials и gPdf API tokens защищены.
Shopify PDFs лучше делать через JSON Render или Template Render?
Используйте JSON Render для custom generated layouts. Используйте Template Render, когда merchant или brand layout утвержден и callers должны отправлять только data.
Обрабатывает ли gPdf Shopify webhooks?
Нет. Ваш app получает webhooks, мапит data и решает, когда рендерить. gPdf только рендерит PDF request, который получает.