Geliştiriciler için API'ler

Customix Integrations API, kişiselleştirilmiş siparişlerinizi kendi sistemlerinize aktarmanızı sağlar: Customix'in oluşturduğu baskı dosyaları ve müşterilerinizin kişiselleştirme sırasında girdiği her şey (adlar, özel metinler, renkler ve seçilen düzenler gibi). Bir üretim aracının, bir e-tablonun veya Make gibi bir otomasyon platformunun sipariş ayrıntılarına kimse elle kopyalamadan ihtiyaç duyduğu durumlarda bu API'yi kullanın.

API anahtarı almak için sol kenar çubuğunda Ayarlar öğesine gidin, Entegrasyonlar sekmesini açın, ardından API anahtarı kartında Anahtar oluşturun düğmesine tıklayın. Ayrıntılar için Customix API anahtarı nasıl alınır makalesine bakın.

🔑 Kimlik doğrulama

Tüm isteklerde API anahtarınız başlıkta (header) yer almalıdır:

Authorization: Bearer <your_api_key>

🌐 Temel URL

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

📘 Uç noktalar

1. Siparişlerin listesini alma

Uç nokta:

GET /orders

Açıklama: Kişiselleştirilmiş siparişlerinizi varsayılan olarak en yeniden en eskiye doğru getirir.

Parametreler:

Başlıklar:

Örnek istek:

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

Yanıt:

{
  "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" }
          ]
        }
      ]
    }
  ]
}

Hata yanıtları:

2. Belirli bir siparişi alma

Uç nokta:

GET /orders/{id}

Açıklama: Tek bir siparişi baskı dosyaları ve kişiselleştirme değerleriyle birlikte getirir.

Parametreler:

Başlıklar:

Örnek istek:

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

Yanıt: data içinde, yukarıdaki listenin tek bir girdisiyle aynı alanlara sahip tek bir sipariş:

{
  "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" }
        ]
      }
    ]
  }
}

(Burada kısaltılmıştır; gerçek yanıt, liste örneğinde gösterilen tüm alanları içerir.)

Hata yanıtları:

3. Belirli bir siparişin özelleştirmesini alma

Uç nokta:

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

Açıklama: Bir siparişin tek bir özelleştirmesini getirir.

Parametreler:

Başlıklar:

Örnek istek:

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

Yanıt: data içine sarılmadan, yalnızca özelleştirmenin kendisi:

{
  "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" }
  ]
}

Hata yanıtları:

🖊️ Özelleştirme değerleri

Her özelleştirme values alanını içerir: siparişle birlikte kaydedilen her kişiselleştirme alanı için bir girdi; bunlar, Shopify'daki siparişte ürün özellikleri olarak gördüğünüz ayrıntılarla aynıdır. Her girdi şunları içerir:

• key: alanın şablonunuzdaki tanımlayıcısı. Aynı şablonun aynı alanı için siparişten siparişe aynı kalır; bu nedenle entegrasyonunuzda alanları eşlemek için bunu kullanın.
• label: müşterilerinizin gördüğü seçenek adı, örneğin "Name". Eski siparişlerde boş olabilir.
• type: seçeneğin türü, örneğin text-field, color-picker, font-swatch, image-swatch, layout-swatch, date-picker veya file-upload.
• value: müşterinizin seçtiği veya girdiği değer, her zaman metin olarak.

value değerinin her seçenek türü için nasıl göründüğü:

• Metin: müşterinizin tam olarak yazdığı metin.
• Renk seçici: müşterinizin seçtiği renk kodu.
• Yazı tipi, görsel, renk ve kontur renk örnekleri: müşterinizin seçtiği renk örneğinin değeri.
• Düzen renk örnekleri: müşterinizin seçtiği düzenin, sipariş verildiği andaki adı.
• Tarih ve saat seçiciler: müşterinizin seçtiği tarih veya saat.
• Dosya ve vektör yüklemeleri: müşterinizin yüklediği dosyaya bağlantı.
• Paletler ve kelime bulutu yazı tipleri: müşterinizin seçtiği renkler veya yazı tipleri, virgülle ayrılmış olarak.
• Harita stilleri, konumlar veya Spotify parçaları gibi metin karşılığı olmayan seçenekler boş değerle döner; bunlar için baskı dosyalarını kullanın.

⚠️ Yaygın hata kodları

📌 Notlar

• Tüm yanıtlar JSON biçimindedir.
• Hız sınırı: 2 requests/second.
• Sorularınız için [email protected] adresiyle iletişime geçin.

Güncelleme tarihi: 14/09/2026