Install-ShopifyOrderDocumentDownload

EulandaXtools — Funktionsreferenz

Install-ShopifyOrderDocumentDownload

ÜBERSICHT

Generiert und installiert ein Liquid-Snippet für Bestelldokumente im Shopify-Theme.

SYNTAX

Install-ShopifyOrderDocumentDownload [-Shop] <string> [-Token] <string> [-ApiVersion] <string>
    [-DocumentTypes] <hashtable[]> [[-ThemeId] <long>] [[-MaxRetries] <int>] [[-TimeoutSec] <int>]
    [<CommonParameters>]

BESCHREIBUNG

Erzeugt ein Liquid-Snippet, das Metafield-basierte Dokument-Downloads (PDF-Rechnungen, Lieferscheine, XRechnungen etc.) auf der Bestellstatus-Seite anzeigt. Der Prozess umfasst:

1. Aktives Theme ermitteln (falls ThemeId nicht angegeben)

2. Metafield-Definitionen für alle DocumentTypes anlegen (idempotent)

3. Liquid-Snippet generieren und als Theme-Asset schreiben

4. Render-Tag im Order-Template einfügen (falls nicht vorhanden)

Voraussetzung: Klassische Kundenkonten (Liquid-Templates). Beim erneuten Aufruf wird das Snippet aktualisiert, der Render-Tag im Template bleibt unverändert.

PARAMETER

-Shop

Type: string

Shopify-Shop-Domain, z.B. 'mein-shop.myshopify.com'.

-Token

Type: string

Admin API Access Token (shpat_...) der Custom App.

-ApiVersion

Type: string

API-Version, z.B. '2025-01'.

-DocumentTypes

Type: hashtable[]

Array von Hashtables. Jeder Eintrag beschreibt einen Dokumenttyp: @{ Namespace = 'custom'; Key = 'invoice_pdf'; Label = 'Rechnung' }

-ThemeId

Type: long

Optionale Theme-ID. Wenn nicht angegeben, wird das aktive Theme verwendet.

-MaxRetries

Type: int
Default: 3

Maximale Anzahl Wiederholungen bei Rate-Limit.

-TimeoutSec

Type: int
Default: 60

HTTP Timeout in Sekunden.

AUSGABEN

pscustomobject -- Objekt mit ThemeId, SnippetKey, RenderTagInserted, DefinitionsCreated.

BEISPIELE

$docTypes = @(
  @{ Namespace = 'custom'; Key = 'invoice_pdf';   Label = 'Rechnung' }
  @{ Namespace = 'custom'; Key = 'delivery_note'; Label = 'Lieferschein' }
  @{ Namespace = 'custom'; Key = 'xrechnung_xml'; Label = 'XRechnung (XML)' }
)
Install-ShopifyOrderDocumentDownload -Shop 'mein-shop.myshopify.com' `
  -Token 'shpat_abc123' -ApiVersion '2025-01' -DocumentTypes $docTypes