Ecommerce platform

App ও backend workflow-এর জন্য Shopify PDF API

Shopify app বা backend workflow থেকে gPdf call করে mapped Shopify data থেকে order PDF, invoice, packing slip, return document এবং label তৈরি করুন।

প্রাথমিক API JSON Render
Endpoint /api/v1/pdf/render
System Shopify app backend / ecommerce backend / OMS / fulfillment workflow
যে কাজটি করতে হবে

Shopify app বা ecommerce backend দিয়ে order, customer, product, fulfillment এবং return data-কে gPdf JSON বা template data-তে map করুন, তারপর native Shopify app-store integration দাবি না করে deterministic PDF return করুন।

কখন এই API ব্যবহার করবেন

  • আপনি এমন Shopify app, private backend বা fulfillment workflow বানাচ্ছেন যা external API call করতে পারে।
  • আপনার app আগে থেকেই Shopify order, fulfillment, customer বা product data পায়।
  • Invoice, packing slip, return document, warehouse label বা PDF attachment দরকার।
  • Merchant-specific document layout-এর জন্য stable template_id contract চান।

এটি কী replace করে না

  • gPdf official Shopify app বা app-store listing হবে বলে আশা করছেন।
  • Merchant store-এ install, OAuth handle বা webhook সরাসরি subscribe করার কাজ gPdf-কে দিতে চান।
  • gPdf থেকে shipping rate, postage purchase, inventory management বা merchant UI feature দরকার।

কোন endpoint call করবেন

প্রাথমিক

/api/v1/pdf/render

JSON Render এই workflow-এর default path।

সহায়ক 1

/api/v1/template-render

Workflow-তে related API path, template contract অথবা capabilities lookup দরকার হলে ব্যবহার করুন।

নূন্যতম request

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 কী করে

  • আপনার app backend map করা Shopify-derived JSON থেকে PDF rendering।
  • Merchant বা brand-specific document layout-এর জন্য Template Render।
  • Barcode, QR code, table, total, image, label এবং packing-slip structure।
  • Public gPdf API দিয়ে stateless PDF generation।

আপনার system-এর দায়িত্ব

  • Shopify app code, OAuth, webhook, merchant UI এবং app-store distribution।
  • Order, fulfillment, customer, return, product এবং tax data mapping।
  • Merchant configuration, template selection, delivery, storage এবং retry।

Production checklist

  1. Shopify credential এবং gPdf API token browser code নয়, backend-এ রাখুন।
  2. Shopify data-কে explicit render payload বা template data schema-তে map করুন।
  3. Approval-এর পরে merchant-specific layout-এর জন্য Template Render ব্যবহার করুন।
  4. Merchant workflow অনুযায়ী generated PDF বা source data store করুন।
  5. Document করুন যে integration হলো আপনার app-এর gPdf call, official gPdf Shopify app নয়।

দাবির সীমা

  • Public official Shopify app না থাকলে এমন claim করবেন না।
  • gPdf Shopify OAuth, app installation, webhook বা merchant setting চালায় না।
  • Shopify data mapping এবং ecommerce business rule caller own করে।

Integration model

Clean Shopify integration model হলো backend-to-backend। আপনার app Shopify data receive বা fetch করে, সেটিকে gPdf DocumentRequest বা template data object-এ map করে, gPdf call করে, তারপর merchant workflow অনুযায়ী PDF return বা store করে।

Public claim এতে accurate থাকে: gPdf হলো PDF generation API যা আপনার Shopify app call করতে পারে। আলাদা app product না থাকলে এটি public official Shopify app নয়।

Template Render merchant layout-এর সাথে মানায়

Ecommerce PDF প্রায়ই merchant-specific হয়ে যায়: branding, item table, return instruction, label block, gift note এবং localized text। Template Render আপনার app-কে published template-এ layout রাখতে দেয়, আর app শুধু mapped order data পাঠায়।

Platform logic app-এ রাখুন

OAuth, webhook, merchant setting, fulfillment state, inventory, return rule এবং app-store distribution আপনার Shopify app-এ থাকে। gPdf-এর পাওয়া উচিত final render data, এবং তার কাজ PDF তৈরি করা।

FAQ

gPdf কি official Shopify app?
না। এই page এমন app ও backend-এর জন্য, যেগুলো gPdf call করে। আলাদা product না থাকলে gPdf-কে official Shopify app-store integration হিসেবে উপস্থাপন করবেন না।
gPdf API call কোথায় হওয়া উচিত?
Shopify credential এবং gPdf API token protected থাকে এমন backend বা app server থেকে gPdf call করুন।
Shopify PDF কি JSON Render নাকি Template Render ব্যবহার করবে?
Custom generated layout-এর জন্য JSON Render ব্যবহার করুন। Merchant বা brand layout approved হলে এবং caller-দের শুধু data পাঠানো উচিত হলে Template Render ব্যবহার করুন।
gPdf কি Shopify webhook handle করে?
না। আপনার app webhook গ্রহণ করে, data map করে এবং কখন render হবে তা সিদ্ধান্ত নেয়। gPdf শুধু পাওয়া PDF request render করে।