API PDF Shopify est-elle un endpoint séparé ?

Non. Cette page explique comment utiliser /api/v1/pdf/render et les API gPdf associées pour ce flux.

Que doit fournir mon système ?

Votre système fournit les données métier, le mapping, la validation et les règles avant rendu. gPdf prend en charge la génération PDF.

Quand utiliser Template Render ?

Utilisez Template Render lorsque la mise en page est stable et que les appelants doivent seulement envoyer template_id et data[].

Que vérifier avant la production ?

Testez les données réelles, cas limites, validations et systèmes aval qui lisent, impriment ou archivent le PDF.

Plateformes e-commerce

API PDF Shopify pour backends d’apps

API PDF Shopify : générer des PDF depuis les données de commandes et fulfillment Shopify, sans rendu navigateur et avec une frontière claire entre le rendu gPdf et vos données métier.

API PRINCIPALE JSON Render

ENDPOINT /api/v1/pdf/render

SYSTÈMES backend d’app Shopify / backend e-commerce / OMS / flux fulfillment

Essayer dans le Playground Lire la documentation

Tâche à accomplir

générer des PDF depuis les données de commandes et fulfillment Shopify. Votre système fournit les données et règles ; gPdf les rend en PDF de manière reproductible.

Quand utiliser cette API

Votre système possède déjà les données nécessaires pour PDF Shopify et attend une réponse PDF.
Vous voulez utiliser JSON Render via /api/v1/pdf/render plutôt qu'un flux HTML vers PDF basé sur navigateur.
Mise en page, codes-barres, texte et métadonnées doivent être reproductibles depuis des données structurées.
Les payloads doivent pouvoir être testés dans le Playground ou en CI avant production.

Ce qu'elle ne remplace pas

Vous avez besoin d'une conversion HTML vers PDF arbitraire avec Chromium.
Vous attendez de gPdf qu'il déduise un sens métier ou légal depuis des données brutes.
Un contrat template_id publié serait plus adapté que l'envoi du layout à chaque requête.

Quel endpoint appeler

PRINCIPAL

/api/v1/pdf/render

JSON Render est le chemin par défaut pour ce flux.

SECONDAIRE 1

/api/v1/template-render

À utiliser si le flux a besoin d'un chemin API lié, d'un contrat de modèle ou d'une recherche de capacités.

Requête minimale

/api/v1/pdf/render - requête minimale pour PDF 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 }
      ]
    }
  ]
}

Ce que gPdf prend en charge

Rendu de PDF Shopify depuis des requêtes structurées.
Pages PDF, texte, tableaux, lignes, formes, images et codes-barres vectoriels selon le besoin.
Sortie PDF déterministe pour réimpression, audit et automatisation backend.
Surface d'erreur API unifiée avec code API-XXX et req_id en cas d'échec.

Ce que votre système garde

Données métier, mapping des champs et sémantique du document.
Validation, idempotence, nommage, stockage et traçabilité après la réponse.
Règles fiscales, conformité, client ou plateforme avant le rendu.

Checklist de production

Ajouter request IDs et timeouts aux appels de production.
Valider les payloads avec OpenAPI, la documentation ou des tests Golden PDF.
Garder l'URL de base API et le bearer token configurables, hors du code source.
Tester les layouts critiques avec données réelles et cas limites.
Conserver les preuves de validation et de réimpression dans le système qui en a besoin.

Limites de la promesse

gPdf rend PDF Shopify ; l'exactitude métier reste dans votre système.
Cette page décrit le bon chemin d'API gPdf, pas un endpoint spécifique supplémentaire.
Certification externe, acceptation et validations opérationnelles restent hors du renderer.

Modèle d’intégration

Le modèle Shopify le plus propre est backend à backend. Votre app reçoit ou récupère les données Shopify, les mappe vers un DocumentRequest gPdf ou un objet de données de modèle, appelle gPdf, puis renvoie ou stocke le PDF selon le flux marchand.

La promesse publique reste ainsi exacte : gPdf est l’API de génération de PDF que votre app Shopify peut appeler. Ce n’est pas une app Shopify officielle publique, sauf si ce produit d’app séparé existe.

Template Render convient aux mises en page marchand

Les PDF e-commerce deviennent souvent propres à chaque marchand : branding, tableaux d’articles, consignes de retour, blocs d’étiquette, messages cadeau et texte localisé. Template Render permet à votre app de garder ces mises en page dans des modèles publiés pendant que l’app envoie seulement les données de commande mappées.

Garder la logique plateforme dans l’app

OAuth, webhooks, paramètres marchand, état de fulfillment, inventaire, règles de retour et distribution app store restent dans votre app Shopify. gPdf doit recevoir les données finales de rendu et produire le PDF.

FAQ

API PDF Shopify est-elle un endpoint séparé ?: Non. Cette page explique comment utiliser /api/v1/pdf/render et les API gPdf associées pour ce flux.
Que doit fournir mon système ?: Votre système fournit les données métier, le mapping, la validation et les règles avant rendu. gPdf prend en charge la génération PDF.
Quand utiliser Template Render ?: Utilisez Template Render lorsque la mise en page est stable et que les appelants doivent seulement envoyer template_id et data[].
Que vérifier avant la production ?: Testez les données réelles, cas limites, validations et systèmes aval qui lisent, impriment ou archivent le PDF.