APIs für Entwickler

Mit der Customix Integrations API holen Sie Ihre personalisierten Bestellungen in Ihre eigenen Systeme: die von Customix erzeugten Druckdateien und alles, was Ihre Kunden beim Personalisieren eingegeben haben, etwa Namen, individuelle Texte, Farben und gewählte Layouts. Nutzen Sie sie, wenn ein Produktionswerkzeug, eine Tabelle oder eine Automatisierungsplattform wie Make Ihre Bestelldaten benötigt, ohne dass sie jemand von Hand kopiert.

Um einen API-Schlüssel zu erhalten, gehen Sie in der linken Seitenleiste zu Einstellungen, öffnen Sie den Tab Integrationen und klicken Sie dann in der Karte API-Schlüssel auf Schlüssel erstellen. Details finden Sie unter So erhalten Sie den Customix-API-Schlüssel.

🔑 Authentifizierung

Alle Anfragen erfordern Ihren API-Schlüssel im Header:

Authorization: Bearer <your_api_key>

🌐 Base URL

https://app.customix.io/api/integrations/v1

📘 Endpunkte

1. Liste der Bestellungen abrufen

Endpunkt:

GET /orders

Beschreibung: Ruft Ihre personalisierten Bestellungen ab, standardmäßig die neuesten zuerst.

Parameter:

Header:

Beispielanfrage:

GET https://app.customix.io/api/integrations/v1/orders?shop=abcdef&limit=2

Antwort:

{
  "data": [
    {
      "shop": "abcdef.myshopify.com",
      "order_id": 123456789,
      "order_number": "#1001",
      "currency": "USD",
      "customer": "John Doe",
      "email": "[email protected]",
      "ip": "123.123.123.123",
      "total_price": 123.45,
      "financial_status": "paid",
      "fulfillment_status": "fulfilled",
      "ordered_at": "2025-01-21 01:01:01",
      "customizations": [
        {
          "id": "01jjavmg7t7vqj5z6qvxwie14b",
          "public_customization_id": "01jjavmg7t7vqj5z6qvxwpc9kd",
          "campaign_id": "01jphjdfmtxhaio94h0wd0kv0c",
          "shopify_line_item_id": 11106133639222,
          "shopify_product_id": 11179841648222,
          "shopify_variant_id": 11191300929074,
          "platform": "shopify",
          "line_item_quantity": 1,
          "files": [
            {
              "id": "01jb3092vabc7m8qw4cdqv09we",
              "name": "default",
              "path": "https://d6opbaohxg209.cloudfront.net/temp/extracted_67d7d664c7awe/Accessory/Laptop.png"
            }
          ],
          "values": [
            { "key": "100001", "label": "Name", "type": "text-field", "value": "Emma" },
            { "key": "layout_100003", "label": "Layout", "type": "layout-swatch", "value": "Portrait" },
            { "key": "100004", "label": "Color", "type": "color-picker", "value": "#1a2b3c" }
          ]
        }
      ]
    }
  ]
}

Fehlerantworten:

2. Bestimmte Bestellung abrufen

Endpunkt:

GET /orders/{id}

Beschreibung: Ruft eine Bestellung mit ihren Druckdateien und Personalisierungswerten ab.

Parameter:

Header:

Beispielanfrage:

GET https://app.customix.io/api/integrations/v1/orders/123456789?shop=abcdef

Antwort: eine einzelne Bestellung in data mit denselben Feldern wie ein Eintrag der obigen Liste:

{
  "data": {
    "shop": "abcdef.myshopify.com",
    "order_id": 123456789,
    "order_number": "#1001",
    "customizations": [
      {
        "id": "01jjavmg7t7vqj5z6qvxwie14b",
        "public_customization_id": "01jjavmg7t7vqj5z6qvxwpc9kd",
        "line_item_quantity": 1,
        "files": [
          { "id": "01jb3092vabc7m8qw4cdqv09we", "name": "default", "path": "https://d6opbaohxg209.cloudfront.net/temp/extracted_67d7d664c7awe/Accessory/Laptop.png" }
        ],
        "values": [
          { "key": "100001", "label": "Name", "type": "text-field", "value": "Emma" }
        ]
      }
    ]
  }
}

(Hier gekürzt – die tatsächliche Antwort enthält jedes im Listenbeispiel gezeigte Feld.)

Fehlerantworten:

3. Personalisierung einer bestimmten Bestellung abrufen

Endpunkt:

GET /orders/{order_id}/customizations/{public_customization_id}

Beschreibung: Ruft eine Personalisierung einer Bestellung ab.

Parameter:

Header:

Beispielanfrage:

GET https://app.customix.io/api/integrations/v1/orders/123456789/customizations/01jjavmg7t7vqj5z6qvxwpc9kd?shop=abcdef

Antwort: die Personalisierung für sich allein, nicht in data eingebettet:

{
  "id": "01jjavmg7t7vqj5z6qvxwie14b",
  "public_customization_id": "01jjavmg7t7vqj5z6qvxwpc9kd",
  "campaign_id": "01jphjdfmtxhaio94h0wd0kv0c",
  "shopify_line_item_id": 11106133639222,
  "shopify_product_id": 11179841648222,
  "shopify_variant_id": 11191300929074,
  "platform": "shopify",
  "line_item_quantity": 1,
  "files": [
    {
      "id": "01jb3092vabc7m8qw4cdqv09we",
      "name": "default",
      "path": "https://d6opbaohxg209.cloudfront.net/temp/extracted_67d7d664c7awe/Accessory/Laptop.png"
    }
  ],
  "values": [
    { "key": "100001", "label": "Name", "type": "text-field", "value": "Emma" },
    { "key": "layout_100003", "label": "Layout", "type": "layout-swatch", "value": "Portrait" }
  ]
}

Fehlerantworten:

🖊️ Personalisierungswerte

Jede Personalisierung enthält values: einen Eintrag für jedes mit der Bestellung gespeicherte Personalisierungsfeld, dieselben Angaben, die Sie in Shopify als Artikeleigenschaften der Bestellung sehen. Jeder Eintrag enthält:

• key: die Kennung des Feldes in Ihrer Vorlage. Sie bleibt von Bestellung zu Bestellung für dasselbe Feld derselben Vorlage gleich, nutzen Sie sie daher, um Felder in Ihrer Integration zuzuordnen.
• label: der Optionsname, den Ihre Kunden gesehen haben, zum Beispiel „Name“. Bei älteren Bestellungen kann er leer sein.
• type: die Art der Option, zum Beispiel text-field, color-picker, font-swatch, image-swatch, layout-swatch, date-picker oder file-upload.
• value: was Ihr Kunde ausgewählt oder eingegeben hat, immer als Text.

So sieht value bei den einzelnen Optionsarten aus:

• Text: genau das, was Ihr Kunde eingegeben hat.
• Farbwähler: der vom Kunden gewählte Farbcode.
• Schrift-, Bild-, Farb- und Konturfarbfelder: der Wert des Farbfelds, das Ihr Kunde gewählt hat.
• Layout-Farbfelder: der Name des vom Kunden gewählten Layouts, so wie er bei der Bestellung lautete.
• Datums- und Zeitauswahl: das vom Kunden gewählte Datum bzw. die gewählte Uhrzeit.
• Datei- und Vektor-Uploads: ein Link zur vom Kunden hochgeladenen Datei.
• Paletten und Wortwolken-Schriften: die vom Kunden gewählten Farben bzw. Schriften, durch Kommas getrennt.
• Optionen ohne Textform, etwa Kartenstile, Standorte oder Spotify-Titel, werden mit leerem Wert zurückgegeben. Nutzen Sie für diese die Druckdateien.

⚠️ Häufige Fehlercodes

📌 Hinweise

• Alle Antworten erfolgen im Format JSON.
• Ratenbegrenzung: 2 requests/second.
• Bei Fragen wenden Sie sich an [email protected].

Aktualisiert am: 14.09.2026