id | metin (≤ 64) | zorunlu | Sipariş kimliği. Siparişin sitenizdeki tekil kimliği (metin). Faturalanan birimdir; aynı kimliğe ikinci fatura kesilmez. |
number | metin (≤ 64) | isteğe bağlı | Sipariş no. Müşteriye gösterilen sipariş numarası; faturada sipariş referansı olarak yazılır. |
status | "created" · "paid" · "shipped" · "delivered" · "cancelled" · "returned" | zorunlu | Durum. created ödeme bekleniyor · paid · shipped · delivered · cancelled · returned. Yalnızca paid, shipped ve delivered faturalanır. |
statusId | metin (≤ 100) | koşullu (satıcı mağaza ayarında faturalanacak durumları seçtiyse) | Durum kimliği. Sitenizdeki durum kimliği (/order-statuses). |
createdAt | tarih-saat (ISO 8601, saat dilimli) | zorunlu | Sipariş tarihi. Siparişin oluşturulduğu an, saat dilimiyle. |
paidAt | tarih-saat (ISO 8601, saat dilimli) | isteğe bağlı | Ödeme tarihi. Gönderilmezse sipariş tarihi kullanılır (e-Arşiv internet satışı bilgisi). |
currency | metin | isteğe bağlı | Para birimi. ISO 4217 (ör. TRY, USD). Gönderilmezse TRY. |
exchangeRate v1.1 | sayı (ondalık) | isteğe bağlı | Kur. 1 birim döviz = kaç TL. USD ve EUR'da fatura kuru hesabın kur ayarına göre TCMB'den alınır ve bu değer kullanılmaz; diğer para birimlerinde faturaya bu kur yazılır (yoksa sipariş otomatik faturalanmaz). |
pricesIncludeVat | true / false | isteğe bağlı | Fiyatlar KDV dahil mi. Varsayılan true. Mağaza ayarında "Siteden gelen fiyatlar" seçiliyse o geçerlidir. |
paymentMethod | "KREDIKARTI/BANKAKARTI" · "EFT/HAVALE" · "KAPIDAODEME" · "ODEMEARACISI" · "DIGER" | isteğe bağlı | Ödeme yöntemi. GİB internet satışı kodu. Gönderilmezse DIGER. |
paymentAgent v1.1 | metin (≤ 100) | koşullu (paymentMethod = ODEMEARACISI) | Ödeme aracısı. Ödemeyi tahsil eden kuruluşun adı (ör. iyzico). e-Arşiv internet satışı bilgisine yazılır. |
customer | nesne | zorunlu | Alıcı. Fatura alıcısı. |
customer.type | "individual" · "company" | zorunlu | Alıcı türü. individual bireysel, company kurumsal (şirket ya da şahıs firması). Belge türü kimlik numarasından belirlenir: vergi kimliği olan alıcı e-Fatura kullanıcısıysa e-Fatura, değilse e-Arşiv kesilir. |
customer.name | metin (≤ 200) | zorunlu | Alıcı adı. Bireyde ad soyad, kurumsalda unvan. |
customer.taxNumber | metin | koşullu (customer.type = company) | VKN / TCKN. Şirkette 10 haneli VKN; bireyde ve şahıs firmasında 11 haneli TCKN. Bireyde kimlik yoksa göndermeyin (nihai tüketici). |
customer.taxOffice | metin (≤ 100) | isteğe bağlı | Vergi dairesi. Kurumsal alıcının vergi dairesi. |
customer.email | metin (≤ 200) | isteğe bağlı | E-posta. Fatura e-postası (mağaza ayarı açıksa fatura bu adrese gönderilir). |
customer.phone | metin (≤ 40) | isteğe bağlı | Telefon |
customer.address | metin (≤ 500) | isteğe bağlı | Fatura adresi. Açık adres (FATURA adresi; teslimat adresi shippingAddress alanındadır). |
customer.district | metin (≤ 100) | isteğe bağlı | İlçe |
customer.city | metin (≤ 100) | isteğe bağlı | İl |
customer.postalCode | metin (≤ 10) | isteğe bağlı | Posta kodu |
customer.country | metin (≤ 60) | isteğe bağlı | Ülke. Gönderilmezse Türkiye. |
shippingAddress v1.1 | nesne | isteğe bağlı | Teslimat adresi. Kargo gönderisinin alıcısı. Faturaya YAZILMAZ; gönderilmezse kargo fatura adresine düşer ve satıcı uyarılır. |
shippingAddress.name | metin (≤ 200) | zorunlu | Teslimat alıcısı |
shippingAddress.company | metin (≤ 200) | isteğe bağlı | Firma adı |
shippingAddress.phone | metin (≤ 40) | isteğe bağlı | Telefon |
shippingAddress.email | metin (≤ 200) | isteğe bağlı | E-posta |
shippingAddress.address | metin (≤ 500) | zorunlu | Teslimat adresi |
shippingAddress.neighborhood | metin (≤ 100) | isteğe bağlı | Mahalle |
shippingAddress.district | metin (≤ 100) | isteğe bağlı | İlçe |
shippingAddress.city | metin (≤ 100) | zorunlu | İl |
shippingAddress.postalCode | metin (≤ 10) | isteğe bağlı | Posta kodu |
shippingAddress.country | metin (≤ 60) | isteğe bağlı | Ülke. Gönderilmezse Türkiye. |
shipping | nesne | isteğe bağlı | Kargo |
shipping.fee | sayı (ondalık) | isteğe bağlı | Kargo ücreti. Alıcıdan alınan kargo ücreti; "Kargo Bedeli" satırı olur. KDV oranı mağaza ayarından gelir (oranı siz göndermek için fees kullanın). |
shipping.carrier | metin (≤ 100) | isteğe bağlı | Kargo firması. e-Arşiv internet satışı bilgisine taşıyıcı olarak yazılır. |
shipping.trackingNumber | metin (≤ 80) | isteğe bağlı | Takip no. Bilgi amaçlı; faturaya yazılmaz. |
shipping.shippedAt | tarih-saat (ISO 8601, saat dilimli) | isteğe bağlı | Gönderim tarihi. e-Arşiv internet satışı bilgisine yazılır. |
items | dizi | zorunlu | Ürün satırları |
items[].lineId v1.1 | metin (≤ 64) | isteğe bağlı | Satır kimliği. Satırın sitenizdeki kimliği; kısmi iadede refund.lines[].lineId ile bu satıra başvurulur. |
items[].sku | metin (≤ 100) | isteğe bağlı | Stok kodu. Ürün kartıyla eşleştirmede kullanılır. |
items[].barcode v1.1 | metin (≤ 64) | isteğe bağlı | Barkod. Stok kodu eşleşmezse ürün kartı barkodla aranır. |
items[].name | metin (≤ 500) | zorunlu | Ürün adı |
items[].quantity | tam sayı | zorunlu | Miktar. Tam sayı. |
items[].unit v1.1 | "C62" · "KGM" · "GRM" · "LTR" · "MTR" · "MTK" · "BX" · "PA" · "SET" · "HUR" · "DAY" · "MON" | isteğe bağlı | Birim. UBL birim kodu: C62 (adet), KGM (kilogram), GRM (gram), LTR (litre), MTR (metre), MTK (metrekare), BX (kutu), PA (paket), SET (set), HUR (saat), DAY (gün), MON (ay). Gönderilmezse C62 (adet). |
items[].unitPrice | sayı (ondalık) | zorunlu | Birim fiyat. İndirim öncesi birim fiyat (pricesIncludeVat'e göre KDV dahil ya da hariç). |
items[].vatRate | 0 · 1 · 10 · 20 | zorunlu | KDV oranı. Satırın KDV oranı (%). Gönderilmezse sipariş faturalanmaz; tek istisna: satıcı mağaza ayarında "tüm ürünler tek KDV oranı" seçtiyse oran oradan gelir. |
items[].discount | sayı (ondalık) | isteğe bağlı | Satır indirimi. Satırın TOPLAM indirimi (birim başına değil), fiyatla aynı KDV bazında. |
orderDiscount v1.1 | sayı (ondalık) | isteğe bağlı | Sipariş indirimi. Sipariş geneli indirim (kupon), fiyatlarla aynı KDV bazında. Ürün satırlarına tutarlarıyla orantılı dağıtılır; kargo ve ek ücretlere uygulanmaz. |
fees v1.1 | dizi | isteğe bağlı | Ek ücretler. Kargo, kapıda ödeme, hizmet bedeli gibi ücretler; her biri kendi KDV oranıyla ayrı fatura satırı olur. shipping.fee ile birlikte kargo ücreti gönderilmez. |
fees[].type | "shipping" · "cod" · "service" · "other" | zorunlu | Ücret türü. shipping kargo, cod kapıda ödeme, service hizmet bedeli, other diğer. |
fees[].name | metin (≤ 100) | isteğe bağlı | Faturadaki ad. Gönderilmezse türün adı (ör. "Kapıda Ödeme Bedeli"). |
fees[].amount | sayı (ondalık) | zorunlu | Tutar. Ücret tutarı, fiyatlarla aynı KDV bazında. |
fees[].vatRate | 0 · 1 · 10 · 20 | zorunlu | KDV oranı. Ücretin KDV oranı (%). |
total v1.1 | sayı (ondalık) | isteğe bağlı | Sipariş toplamı. Alıcının ödediği toplam. Gönderilirse hesaplanan fatura toplamıyla karşılaştırılır; tutmazsa sipariş "Kontrol gerekli" olur. |
note v1.1 | metin (≤ 1000) | isteğe bağlı | Sipariş notu. Alıcının notu. Kaydedilir, faturaya yazılmaz. |
invoiceNote v1.1 | metin (≤ 500) | isteğe bağlı | Fatura açıklaması. Faturanın açıklama (not) bölümüne yazılır. |
invoiced | true / false | isteğe bağlı | Başka yerde faturalandı. true ise sipariş alınır ama faturalanmaz. |
marketplace | metin (≤ 60) | isteğe bağlı | Pazaryeri kaynağı. Sipariş bir pazaryerinden sitenize aktarıldıysa pazaryerinin adı (ör. "Trendyol"). Varsayılan olarak faturalanmaz; satıcı mağaza ayarında açarsa faturalanır. |
refund v1.1 | nesne | isteğe bağlı | İptal / iade bilgisi. Yalnızca status cancelled ya da returned iken gönderilir. Faturası kesilmiş siparişte hiçbir belge kendiliğinden kesilmez: panelde onay bekleyen işlem oluşur. |
refund.type | "cancel" · "return" | zorunlu | Tür. cancel iptal (status: cancelled ile), return iade (status: returned ile). |
refund.scope | "full" · "partial" | isteğe bağlı | Kapsam. full tamamı (varsayılan), partial kısmi. |
refund.amount | sayı (ondalık) | koşullu (refund.scope = partial) | Tutar. İptal / iade edilen toplam tutar (KDV dahil, sipariş para biriminde). Gönderilmezse fatura iptali kendiliğinden uygulanmaz; satıcının onayına düşer. |
refund.lines | dizi | isteğe bağlı | İade edilen satırlar. Kısmi iadede hangi satırdan kaç adet. |
refund.lines[].lineId | metin (≤ 64) | isteğe bağlı | Satır kimliği |
refund.lines[].sku | metin (≤ 100) | isteğe bağlı | Stok kodu |
refund.lines[].quantity | tam sayı | zorunlu | Miktar |
refund.reason | metin (≤ 300) | isteğe bağlı | Neden |
refund.at | tarih-saat (ISO 8601, saat dilimli) | isteğe bağlı | Tarih. İptal / iade tarihi. |