Bütün uçlar

Siparişler

Sipariş açın, listeleyin, onaylayın, teslim edin, düzeltin ve iptal edin.

• POSTSipariş oluştur/v1/ordersKendi sitenizden, ERP’nizden veya başka bir yazılımdan yeni satış açın; stok ve tahsilat paneldeki elle siparişle aynı kuralla işlenir.
• GETSiparişleri listele/v1/ordersYetkili markaların siparişlerini zaman, durum, marka ve görünen numarayla süzerek alın; ERP sipariş aktarımında kullanın.
• GETSiparişi getir/v1/orders/{id}Siparişin güncel durumunu ve tutarlarını okuyun; olay geldikten sonra ERP kaydını güncellemek için kullanın.
• POSTSiparişi onayla/v1/orders/{id}/confirmYeni (bekleyen) siparişi onaylandı durumuna geçirin.
• POSTSiparişi hazırlamaya başla/v1/orders/{id}/processingOnaylı siparişi hazırlanıyor durumuna geçirin.
• POSTTeslim almaya hazır işaretle/v1/orders/{id}/readyMarkadan teslim alınacak sipariş hazır olduğunda ve müşteriye haber verdiğinizde kullanın.
• POSTSiparişi teslim et/v1/orders/{id}/deliverElden, markadan veya kargoyla teslim edilen siparişi teslim edildi durumuna geçirin.
• POSTAlınan ödemeyi kaydet/v1/orders/{id}/payment-receivedMüşteriden gerçekten aldığınız nakit, POS veya havale ödemesini siparişe yazın.
• POSTSiparişi iptal et/v1/orders/{id}/cancelSiparişi iptal edin; stok geri gelir, ödeme ve iade paneldeki iptal kuralıyla işlenir.
• PATCHSiparişi düzelt/v1/orders/{id}Siparişin adresini, notlarını, teslim gününü veya kalemlerini değiştirin.
• POSTSipariş durumunu düzelt/v1/orders/{id}/correct-statusYanlışlıkla seçilmiş sipariş durumunu gerekçe yazarak düzeltin.
• GETSipariş satırlarını listele/v1/orders/{id}/linesSipariş anındaki ürün, seçenek, miktar ve fiyatları alın; ERP sipariş kalemlerini oluştururken kullanın.
• GETÖdemeleri ve para özetini getir/v1/orders/{id}/paymentsSiparişin tahsilat ve geri ödemelerini ve bütün siparişin para özetini okuyun; mutabakatta kullanın.
• GETSipariş geçmişini getir/v1/orders/{id}/historySiparişin durum geçişlerini sırasıyla okuyun; işlem sırasını açıklamak için kullanın.

Müşteriler

Müşteri kartını bulun, ekleyin, güncelleyin, arşivleyin veya KVKK için anonimleştirin.

• POSTMüşteri oluştur/v1/customersYeni müşteri kartı açın; sipariş açmadan önce müşteriyi kaydetmek için kullanın.
• GETMüşterileri listele/v1/customersMüşteri kartlarını listeleyin veya e-posta/telefonla doğru kartı bulun.
• GETMüşteriyi getir/v1/customers/{id}Bir müşteri kartını okuyun; siparişteki customer kimliğini kendi kaydınızla eşleştirirken kullanın.
• PATCHMüşteriyi güncelle/v1/customers/{id}Müşteri kartının adını, iletişim bilgilerini veya notunu değiştirin.
• POSTMüşteriyi arşivle/v1/customers/{id}/archiveMüşteri kartını etkin listeden kaldırın; kart ve siparişleri silinmez.
• POSTMüşteriyi geri getir/v1/customers/{id}/restoreArşivdeki müşteri kartını etkin listeye geri getirin.
• POSTMüşteriyi anonimleştir (KVKK)/v1/customers/{id}/anonymizeMüşterinin KVKK silme isteğini yerine getirin: kişisel bilgiler temizlenir, sipariş ve muhasebe kayıtları kalır.

Ürünler

Ürün, seçenek, kategori, ürün markası ve markaya özel fiyat.

• POSTÜrün oluştur/v1/productsÜrünü seçenekleri, kategorileri ve ürün markasıyla birlikte tek istekte açın.
• GETÜrünleri listele/v1/productsGörünür ürünleri ve istenirse seçeneklerini, kategorilerini ve marka fiyatlarını alın; katalog aktarımı ve ürün kimliği eşleştirmesi için kullanın.
• GETÜrünü getir/v1/products/{id}Bir ürünün güncel bilgilerini okuyun; ürün olayından sonra kendi kataloğunuzu güncellerken kullanın.
• PATCHÜrünü güncelle/v1/products/{id}Ürünün adını, fiyatını, açıklamasını, kategorilerini veya satış durumunu değiştirin.
• POSTÜrünü arşivle/v1/products/{id}/archiveÜrünü listeden ve vitrinden kaldırın; kayıtları silinmez.
• POSTÜrünü geri getir/v1/products/{id}/restoreArşivdeki ürünü ve arşivlenen seçeneklerini geri getirin.
• POSTÜrüne seçenek ekle/v1/products/{id}/variantsVar olan ürüne renk, beden gibi yeni bir seçenek ekleyin.
• GETSeçenekleri listele/v1/variantsÜrün seçeneklerini stok kodu (SKU) veya barkodla bulun; ERP stok kartını var_ kimliğiyle eşleştirin.
• GETSeçeneği getir/v1/variants/{id}Bir seçeneğin güncel fiyatını ve stok türünü okuyun.
• PATCHSeçeneği güncelle/v1/variants/{id}Seçeneğin stok kodunu, barkodunu, fiyatını, maliyetini, ağırlığını veya görsellerini değiştirin.
• POSTSeçeneği arşivle/v1/variants/{id}/archiveSatılmayan bir seçeneği üründen kaldırın; kaydı silinmez.
• PUTMarka fiyatını yaz/v1/store-prices/{store}/{product}Ürünün veya seçeneğin bir markadaki satış fiyatını ayarlayın ya da kaldırın.
• GETMarka fiyatlarını listele/v1/store-pricesMarkaya özel kaydedilmiş ürün ve seçenek fiyatlarını alın.
• GETMarka fiyatını getir/v1/store-prices/{store}/{product}Belirli marka ve ürünün kaydedilmiş fiyatını okuyun.
• POSTKategori oluştur/v1/categoriesİşletmenin bütün markalarında kullanılan yeni bir kategori açın.
• GETKategorileri listele/v1/categoriesGörünür ürünlerin kategorilerini alın; kendi kategori ağacınızı kurarken kullanın.
• GETKategoriyi getir/v1/categories/{id}Bir kategorinin adını, açıklamasını ve görünür üst kategorisini okuyun.
• PATCHKategoriyi güncelle/v1/categories/{id}Kategorinin adını, açıklamasını veya üst kategorisini değiştirin.
• POSTKategoriyi arşivle/v1/categories/{id}/archiveKategoriyi vitrinden kaldırın; ürün bağları silinmez.
• POSTKategoriyi geri getir/v1/categories/{id}/restoreArşivdeki kategoriyi geri getirin.
• POSTÜrün markası oluştur/v1/brandsÜrünlerin üretici veya ticari markasını (ör. bir giyim markası) ekleyin.
• GETÜrün markalarını listele/v1/brandsÜrünlerin üretici veya ticari markalarını alın.
• GETÜrün markasını getir/v1/brands/{id}Bir ürün markasının adını ve logosunu okuyun; ürünün brand alanını ayrıntılandırırken kullanın.
• PATCHÜrün markasını güncelle/v1/brands/{id}Ürün markasının adını veya logosunu değiştirin.
• POSTÜrün markasını arşivle/v1/brands/{id}/archiveÜrün markasını vitrinden kaldırın; ürün bağları silinmez.
• POSTÜrün markasını geri getir/v1/brands/{id}/restoreArşivdeki ürün markasını geri getirin.

Stok

Depodaki miktarlar, stok girişi, sayım, fire, depolar arası taşıma ve stok geçmişi.

• GETStok miktarlarını listele/v1/inventory/levelsSeçenek ve depo bazında eldeki fiziksel miktarı alın; ERP stok görünümünü güncellerken kullanın.
• POSTStok girişi yap/v1/inventory/receiptsDepoya gelen malı stoğa ekleyin.
• POSTStok sayımı yap/v1/inventory/countsDepoda saydığınız miktarı stoğa yazın.
• POSTFire ve kayıp yaz/v1/inventory/write_offsKırılan, kaybolan veya kullanılamayan ürünü stoktan düşün.
• POSTDepolar arası taşı/v1/inventory/transfersBir depodaki malı başka bir depoya taşıyın.
• GETStok hareketlerini listele/v1/inventory/movementsStok değişimlerinin değişmez geçmişini alın; mutabakat yaparken kullanın.
• GETStok belgesini getir/v1/inventory/documents/{id}Bir stok girişi, sayım, fire veya taşıma belgesini hareketleriyle okuyun.
• POSTStok belgesini geri al/v1/inventory/documents/{id}/reverseYanlış girilmiş mal girişini veya fireyi ters kayıtla düzeltin.
• GETDepoları listele/v1/locationsAnahtarın görebildiği depoları alın; stok miktarlarındaki location kimliğini kendi depo adınızla eşleştirin.

Kargo

Kargo fiyatı sorun, BasitKargo gönderisi açın, etiket indirin ve iptal edin.

• POSTKargo fiyatı sor/v1/orders/{id}/shipments/quoteGönderi açmadan önce açık kargo firmalarının fiyatını ve gönderim engellerini görün.
• POSTGönderi oluştur/v1/orders/{id}/shipmentsSiparişi kargoya verin: seçtiğiniz firmayla BasitKargo gönderisi açılır, ücret bakiyenizden düşer.
• GETGönderiyi getir/v1/shipments/{id}Gönderinin durumunu, takip kodunu ve kapıda ödeme bilgisini okuyun.
• GETKargo etiketini indir/v1/shipments/{id}/labelKoliye yapıştırılacak kargo etiketini SVG olarak indirin.
• POSTGönderiyi iptal et/v1/shipments/{id}/cancelKurye almadan önce gönderiyi iptal edin; ücret paneldeki kuralla bakiyenize döner.
• GETSiparişin gönderilerini listele/v1/orders/{id}/shipmentsBir siparişin gönderilerini ve kapıda ödeme bilgilerini alın.

İade

İade talebini karara bağlayın, ürünü geri alın ve parayı iade edin.

• POSTİadeyi önizle/v1/orders/{id}/refunds/previewİade yapmadan önce iade edilecek tutarı, stok etkisini ve uyarıları görün.
• POSTİade başlat/v1/orders/{id}/refundsÜrünü geri alın ve parayı müşteriye iade edin.
• GETPara iadesini getir/v1/refunds/{id}Para iadesinin müşteriye ulaşıp ulaşmadığını izleyin.
• POSTElle verilen iadeyi kaydet/v1/refunds/{id}/money-returnedParayı nakit, POS veya havaleyle kendiniz geri verdikten sonra kaydedin.
• GETSiparişin iadelerini listele/v1/orders/{id}/returnsSiparişe bağlı iade ve değişim kayıtlarını alın; ERP iade durumlarını izlerken kullanın.
• GETİade talebini getir/v1/returns/{id}Müşterinin iade talebinin kalemlerini ve kararını okuyun.
• POSTİade talebini onayla/v1/returns/{id}/approveMüşterinin iade veya değişim talebini kabul edin; para iadesi ayrı adımdır.
• POSTİade talebini reddet/v1/returns/{id}/rejectMüşterinin iade talebini gerekçesiyle reddedin.

Fatura

Fatura kesin, belgesini indirin ve iptal edin.

• POSTFaturayı önizle/v1/orders/{id}/invoices/previewFatura kesmeden önce alıcıyı, kalemleri, tutarı ve fatura türünü görün.
• POSTFatura kes/v1/orders/{id}/invoicesBağlı fatura sağlayıcınızla siparişin e-Arşiv veya e-Fatura belgesini kesin.
• GETFaturayı getir/v1/invoices/{id}Faturanın kesilip kesilmediğini ve iptal durumunu okuyun.
• GETFatura belgesini indir/v1/invoices/{id}/documentFaturanın yazdırılabilir HTML görünümünü indirin.
• POSTFatura iptalini önizle/v1/invoices/{id}/cancel/previewFaturanın API ile mi, sağlayıcı portalından mı iptal edileceğini öğrenin.
• POSTFaturayı iptal et/v1/invoices/{id}/cancelKesilmiş faturayı iptal edin.
• GETSiparişin faturalarını listele/v1/orders/{id}/invoicesBir siparişin fatura kayıtlarını ve durumlarını alın; ERP fatura mutabakatında kullanın.

Başka kanaldaki satış

Ödemesi başka kanalda alınmış satışı stoğa ve sipariş listesine işleyin.

• POSTBaşka kanaldaki satışı bildir/v1/external_ordersÖdemesi başka bir kanalda (ör. Etsy, fuar, kendi kasanız) alınmış kesinleşmiş satışı stoktan düşmek ve listede görmek için kaydedin.

Toplu işler

Binlerce satırlık fiyat ve stok güncellemesini tek işte yapın.

• POSTToplu fiyat güncelle/v1/bulk/pricesBinlerce ürün ve seçeneğin fiyatını tek istekte güncelleyin.
• POSTToplu stok say/v1/bulk/inventoryBir depodaki binlerce seçeneğin sayım sonucunu tek istekte yazın.
• GETToplu işin durumunu getir/v1/jobs/{id}Toplu fiyat veya stok işinin ilerlemesini ve sonucunu izleyin.
• GETToplu işin hatalarını listele/v1/jobs/{id}/errorsToplu işte işlenemeyen satırları ve nedenlerini alın.

Kuponlar

İndirim kuponlarını ekleyin, güncelleyin ve arşivleyin.

• POSTKupon oluştur/v1/couponsMarkada kullanılacak yeni bir indirim kuponu açın.
• GETKuponları listele/v1/couponsMarkanın veya işletmenin kuponlarını ve kullanım sayılarını alın.
• GETKuponu getir/v1/coupons/{id}Bir kuponun kurallarını ve kullanım sayısını okuyun.
• PATCHKuponu güncelle/v1/coupons/{id}Kuponun indirimini, tarihlerini veya kurallarını değiştirin.
• POSTKuponu arşivle/v1/coupons/{id}/archiveKuponu kullanımdan kaldırın; geçmişi silinmez.
• POSTKuponu geri getir/v1/coupons/{id}/restoreArşivdeki kuponu yeniden kullanıma açın.

Olaylar ve Webhook

Değişiklikleri olay akışından okuyun ya da adresinize imzalı bildirim alın.

• GETOlayları listele/v1/eventsSipariş, stok, ürün ve müşterideki kalıcı değişiklikleri yayın sırasıyla okuyun; webhook yerine düzenli sorgulamak için kullanın.
• GETOlayı getir/v1/events/{id}Tek bir olayın değişiklik özetini okuyun; tekil teslimi incelemek için kullanın.
• POSTWebhook adresi oluştur/v1/webhook_endpointsDeğişikliklerin sizin HTTPS adresinize imzalı olarak gönderilmesi için adres ekleyin.
• GETWebhook adreslerini listele/v1/webhook_endpointsBu bağlantının webhook adreslerini ve sağlık durumlarını alın.
• GETWebhook adresini getir/v1/webhook_endpoints/{id}Bir webhook adresinin durumunu ve son teslim sonucunu okuyun; teslim sorunlarını teşhis ederken kullanın.
• PATCHWebhook adresini güncelle/v1/webhook_endpoints/{id}Webhook adresini, olay türlerini veya markasını değiştirin.
• POSTWebhook denemesi gönder/v1/webhook_endpoints/{id}/testKurulumda veya adresi yeniden açarken adresinize imzalı bir deneme bildirimi gönderin.
• POSTWebhook sırrını yenile/v1/webhook_endpoints/{id}/rotate_secretİmza sırrını değiştirin; eski sır bir süre daha geçerli kalır.
• POSTOlayı yeniden gönder/v1/webhook_endpoints/{id}/resendAlıcınızdaki sorun düzeldikten sonra kaçırılan bir olayı yeniden gönderin.
• GETWebhook teslimlerini listele/v1/webhook_endpoints/{id}/deliveriesBir adrese yapılan teslimlerin başarısını, hatasını ve sonraki deneme zamanını izleyin.
• GETTeslim denemelerini listele/v1/webhook_endpoints/{id}/deliveries/{delivery}/attemptsBir teslimin her denemesindeki HTTP durumunu ve süreyi görün.
• POSTWebhook adresini kapat/v1/webhook_endpoints/{id}/closeEntegrasyonu durdururken adresi kapatın; teslim geçmişi kalır.

Dışa aktarma

İlk eşitleme için tutarlı JSONL/CSV dosyası hazırlayın ve indirin.

• POSTDışa aktarma başlat/v1/exportsİlk eşitleme için siparişlerin, müşterilerin, ürünlerin veya stoğun tek andaki tutarlı dosyasını hazırlatın.
• GETDışa aktarmanın durumunu getir/v1/exports/{id}Dosyanın hazırlanmasını izleyin; hazır olunca dosya ve devam imleci gelir.
• GETDışa aktarma dosyasını indir/v1/files/{id}Hazırlanan JSONL/CSV dosyasını indirin.

Hesap

Bağlantıyı doğrulayın; işletmeyi ve markaları okuyun.

• GETBağlantıyı doğrula/v1/meAnahtarın çalıştığını, kapsamlarını, erişebildiği markaları ve bu ortamın API adresini görün; ilk istekte ve yetki sorunlarını çözerken kullanın.
• GETİşletmeyi getir/v1/businessAnahtarın bağlı olduğu işletmenin adını, türünü ve vergi durumunu okuyun; ERP şirket kaydını eşleştirirken kullanın.
• GETMarkaları listele/v1/storesAnahtarın erişebildiği satış markalarını alın; çok markalı işletmede store kimliğini seçerken kullanın.

Referans

• GETOpenAPI sözleşmesini indir/v1/openapi.jsonBütün uçları, alanları ve örnekleri içeren OpenAPI 3.1 belgesini indirin; istemci üretimi, alan doğrulama ve AI entegrasyonu için kullanın.