Square Payments (Bağımsız Yayımcı) (Önizleme)

Square, milyonlarca satıcının güvenli kredi kartı işlemeden satış noktası çözümlerine kadar işlerini yürütmesine yardımcı olur. Bu bağlayıcı şu uç noktalar için eylemler içerir: Ödemeler, Terminal, Siparişler, Abonelikler, Faturalar, Katalog, Envanter ve Müşteriler.

Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:

Hizmet	Class	Bölgeler
Copilot Studio	Premium	Aşağıdakiler dışında tüm Power Automate bölgeleri :      - ABD Kamu (GCC)      - US Government (GCC High)      - 21Vianet tarafından işletilen Çin Bulutu      - ABD Savunma Bakanlığı (DoD)
Logic Apps	Standart	Aşağıdakiler dışında tüm Logic Apps bölgeleri :      - Azure Kamu bölgeleri      - Azure Çin bölgeleri      - ABD Savunma Bakanlığı (DoD)
Power Apps	Premium	Aşağıdakiler dışında tüm Power Apps bölgeleri :      - ABD Kamu (GCC)      - US Government (GCC High)      - 21Vianet tarafından işletilen Çin Bulutu      - ABD Savunma Bakanlığı (DoD)
Power Automate	Premium	Aşağıdakiler dışında tüm Power Automate bölgeleri :      - ABD Kamu (GCC)      - US Government (GCC High)      - 21Vianet tarafından işletilen Çin Bulutu      - ABD Savunma Bakanlığı (DoD)

İletişim
İsim	Troy Taylor
URL	https://www.hitachisolutions.com
E-posta	ttaylor@hitachisolutions.com

Bağlayıcı Meta Verileri
Publisher	Troy Taylor
Web sitesi	https://squareup.com/
Gizlilik ilkesi	https://squareup.com/us/en/legal/general/privacy
Kategoriler	Ticaret; Satış ve CRM

Azaltma Sınırları

Name	Çağrılar	Yenileme Dönemi
Bağlantı başına API çağrıları	100	60 saniye

Eylemler

Abonelik olaylarını listeleme	Belirli bir abonelik için tüm olayları listeler.
Abonelik oluşturma	Müşteri için abonelik planına abonelik oluşturur. İstekte dosya üzerinde bir kart sağlarsanız, Square aboneliğin kartını ücretlendirilir. Aksi takdirde Square, faturayı müşterinin e-posta adresine faturalar. İstek isteğe bağlı start_date içermediği sürece abonelik hemen başlar. Her bir abonelik belirli bir konumla ilişkilendirilir.
Abonelikleri ara	Abonelikleri arar. Sonuçlar, abonelik oluşturma tarihine göre kronolojik olarak sıralanır. İstek birden fazla konum kimliği belirtiyorsa, uç nokta sonucu konum kimliğine ve ardından her konumda oluşturma tarihine göre sıralar. Sorguda hiçbir konum belirtilmemişse, tüm konumlar aranıyor.
Aboneliği alma	Bir abonelik alır.
Aboneliği güncelleştirme	Aboneliği güncelleştirir. Abonelik alanı değerlerini ayarlayabilir, değiştirebilir ve temizleyebilirsiniz.
Aboneliği iptal et	canceled_date alanını etkin faturalama döneminin sonuna ayarlar. Bu tarihten sonra, durum ETKİn olan İptal EDİlDİ olarak değişir.
Aboneliği sürdür	Devre dışı bırakılmış aboneliği sürdürür.
Apple Pay için etki alanı kaydetme	Web ve Kare üzerinde Apple Pay ile kullanmak üzere bir etki alanını etkinleştirir. Apple Pay özellikli bir etki alanı olarak düzgün ayarlandığından emin olmak için bu etki alanında Apple tarafından bir doğrulama gerçekleştirilir.
Arama siparişleri	Bir veya daha fazla konum için tüm siparişlerde arama yapın. Siparişler, Kare ekosistemine nasıl veya ne zaman girdiklerinden bağımsız olarak tüm satışları, iadeleri ve değişimleri içerir (Satış Noktası, Faturalar ve Connect API'leri gibi).
Arama terminali kullanıma alma işlemleri	İstekte bulunan hesap tarafından oluşturulan Terminal kullanıma alma isteklerinin filtrelenmiş listesini alır.
Eşzamanlılık anahtarıyla ödemeyi iptal etme	İstekte belirtilen bir eşzamanlılık anahtarı tarafından tanımlanan bir ödemeyi iptal eder (geçersiz kılar). CreatePayment isteğinin durumu bilinmiyorsa (örneğin, Bir CreatePayment isteği gönderdikten sonra bir ağ hatası oluşur ve yanıt alamazsınız) bu yöntemi kullanın. Bu durumda Square'i bu uç noktayı kullanarak ödemeyi iptal etmeye yönlendirebilirsiniz. İstekte, Iptal etmek istediğiniz CreatePayment isteğinizde sağladığınız aynı eşzamanlılık anahtarını sağlarsınız. Ödemeyi iptal ettikten sonra CreatePayment isteğinizi yeniden gönderebilirsiniz. Belirtilen bir eşzamanlılık anahtarıyla ödeme yapılmazsa hiçbir işlem yapılmadığını ve uç noktanın başarıyla döndürüldüğünü unutmayın.
Fatura oluşturma	Siparişler API'sini kullanarak oluşturulan bir sipariş için taslak fatura oluşturur. Taslak fatura hesabınızda kalır ve hiçbir işlem yapılmaz. Square'in faturayı işleyebilmesi için önce faturayı yayımlamanız gerekir (müşterinin e-posta adresine gönderin veya dosyada müşterinin kartından ücret alın).
Faturalarda arama	Filtrede belirtilen bir konumdan fatura arar.
Faturaları listeleme	Belirli bir konum için faturaların listesini döndürür.
Faturayı alma	Fatura kimliğine göre bir fatura alır.
Faturayı güncelleştirme	Alanları değiştirerek, alanları temizleyerek veya her ikisini birden yaparak faturayı güncelleştirir.
Faturayı iptal et	Faturayı iptal eder. Satıcı, iptal edilen faturanın ödemelerini toplayamaz.
Faturayı silme	Belirtilen faturayı siler. Fatura silindiğinde, ilişkili sipariş durumu İPTAL EDİlDİ olarak değişir. Yalnızca taslak faturayı silebilirsiniz (işlenmek üzere zamanlanmış fatura da dahil olmak üzere yayımlanmış bir faturayı silemezsiniz).
Faturayı yayımlama	Belirtilen taslak faturayı yayımlar. Bir fatura yayımlandıktan sonra Square, fatura yapılandırmasına göre bunu izler. Örneğin, Square faturayı müşterinin e-posta adresine gönderir, müşterinin kartından dosyada ücret alır veya hiçbir şey yapmaz. Square, faturayı Kare şeklinde barındırılan bir fatura sayfasında da kullanılabilir hale getirir.
Grubu müşteriden kaldırma	Müşteriden grup üyeliğini kaldırır. Müşteri customer_id değeriyle, müşteri grubu ise group_id değeriyle tanımlanır.
Güncelleştirme sırası (Beta)	Alanları ekleyerek, değiştirerek veya silerek açık bir siparişi güncelleştirir. TAMAMLANMIŞ veya İptal EDİlMİş durumdaki siparişler güncelleştirilemez.
İhtilaf kanıtlarını alma	İstek URL yolundaki kanıt kimliği tarafından belirtilen kanıt meta verilerini döndürür. Daha sonra başvurmak istiyorsanız karşıya yüklediğiniz kanıtın bir kopyasını tutmanız gerekir. Karşıya yükledikten sonra kanıtı indiremezsiniz.
İhtilaf kanıtlarını silme	Belirtilen kanıtı bir anlaşmazlıktan kaldırır.
İhtilafı alma	Belirli bir anlaşmazlıkla ilgili ayrıntıları döndürür.
Kanıt gönderme	Kart sahibinin bankasına kanıt gönderir. Kanıt göndermeden önce Square tüm kullanılabilir kanıtları derler. Bu, CreateDisputeEvidenceFile ve CreateDisputeEvidenceText uç noktaları kullanılarak karşıya yüklenen kanıtları ve kullanılabilir olduğunda Square tarafından otomatik olarak sağlanan kanıtı içerir.
Kart oluşturma	Mevcut bir satıcıya dosyaya kart ekler.
Kartı alma	Belirli bir Kartın ayrıntılarını alır.
Kartı devre dışı bırakma	Kartı devre dışı bırakır ve daha fazla güncelleştirme veya ücret alınmasını önler. Zaten devre dışı bırakılmış bir kartın devre dışı bırakılmasına izin verilir, ancak hiçbir etkisi yoktur.
Katalog bilgileri	BatchUpsertCatalogObjects uç noktası tarafından kullanılabilecek toplu iş boyutu sınırları gibi Kare Katalog API'sine ilişkin bilgileri alır.
Katalog nesnelerini arama	Öğelerdeki veya öğe çeşitlemelerindeki özel öznitelik değerleri hariç, desteklenen arama özniteliği değerlerini belirtilen bir veya daha fazla sorgu filtresiyle eşleştirerek herhangi bir türde CatalogObject arar.
Katalog nesnelerini toplu silme	Sağlanan hedef kimlik listesine göre bir CatalogItems kümesini siler ve yanıtta başarıyla silinen bir kimlik kümesi döndürür.
Katalog nesnesini alma	Sağlanan kimliği temel alarak tek bir CatalogItem'i CatalogObject olarak döndürür. Döndürülen nesne, catalogItemVariation alt öğeleri, CatalogModifierList nesnelerine başvurular ve buna uygulanan tüm CatalogTax nesnelerinin kimlikleri dahil olmak üzere tüm ilgili CatalogItem bilgilerini içerir.
Katalog nesnesini silme	Sağlanan kimliğe göre tek bir CatalogObject'i siler ve yanıtta başarıyla silinen kimlik kümesini döndürür. Silme, hedeflenen nesnenin tüm alt öğelerinin de silinmesini sağlayan basamaklı bir olaydır. Örneğin, bir CatalogItem silindiğinde tüm CatalogItemVariation alt öğeleri de silinir.
Kopyalama sırası (Beta)	Mevcut bir siparişi çoğaltarak TASLAK durumunda yeni bir sipariş oluşturur. Yeni oluşturulan siparişte yalnızca özgün siparişten kopyalanan çekirdek alanlar (satır öğeleri, vergiler ve indirimler gibi) bulunur.
Liste kartları	İstekte bulunan hesaba ait kartların listesini alır.
Liste kataloğu	Katalogdaki istenen tür kümesindeki tüm nesneleri (örneğin, tüm CatalogItem ve CatalogTax nesneleri) içeren CatalogObjects listesini döndürür. ListCatalog silinen katalog öğelerini döndürmez.
Madde vergilerini güncelleştirme	Öğenin tamamında bir upsert gerçekleştirmek zorunda kalmadan hedeflenen CatalogItem'e uygulanan CatalogTax nesnelerini güncelleştirir.
Müşteri grubu oluşturma	bir işletme için yeni bir müşteri grubu oluşturur.
Müşteri grubunu alma	Belirli bir müşteri grubunu alır.
Müşteri grubunu güncelleştirme	Müşteri grubunu güncelleştirir.
Müşteri grubunu silme	group_id değeriyle tanımlanan bir müşteri grubunu siler.
Müşteri gruplarını listeleme	bir işletmenin müşteri gruplarının listesini alır.
Müşteri oluşturma	bir işletme için yeni bir müşteri oluşturur.
Müşteri segmentini alma	Belirli bir müşteri segmentini alır.
Müşteri segmentlerini listeleme	Bir işletmenin müşteri segmentlerinin listesini alır.
Müşterileri ara	Desteklenen bir sorgu filtresi kullanarak Kare hesapla ilişkili müşteri profillerinde arama gerçekleştirir. SearchCustomers'ı açık sorgu filtresi olmadan çağırmak, given_name ve family_name göre alfabetik olarak sıralanmış tüm müşteri profillerini döndürür.
Müşterileri listeleme	Kare hesabıyla ilişkilendirilmiş müşteri profillerini listeler. Normal çalışma koşulları altında, yeni oluşturulan veya güncelleştirilen müşteri profilleri, listeleme işlemi için 30 saniyeden kısa bir süre içinde kullanılabilir hale gelir. Bazen, yeni veya güncelleştirilmiş profillerin yayılması, özellikle ağ olayları ve kesintiler sırasında bir dakika veya daha uzun sürebilir.
Müşteriye grup ekleme	Müşteriye grup üyeliği ekler. Müşteri customer_id değeriyle, müşteri grubu ise group_id değeriyle tanımlanır.
Müşteriyi alma	Tek bir müşterinin ayrıntılarını döndürür.
Müşteriyi güncelleştirme	Müşteri profilini güncelleştirir. Özniteliği değiştirmek için yeni değeri belirtin. Özniteliği kaldırmak için değeri boş dize veya boş nesne olarak belirtin.
Müşteriyi silme	bir işletmeden müşteri profilini siler. Bu işlem, dosyadaki ilişkili kartların bağlantılarını da kaldırıyor.
Para iadesi ödemesi	Bir ödeme için para iadesi alır. Ödeme tutarının tamamını veya bir kısmını iade edebilirsiniz. Bu uç noktayı kart ödemesine para iadesi yapmak veya nakit ya da harici ödeme için para iadesi kaydetmek için kullanabilirsiniz.
Sipariş oluştur	Satın alma için ürünler ve satın alma için uygulanacak ayarlar hakkında bilgi içerebilen yeni bir sipariş oluşturur.
Siparişi alma	Kimliğine göre bir Sipariş alır.
Stok aktarımını alma (Beta)	Sağlanan transfer_id ile InventoryTransfer nesnesini döndürür.
Stok düzeltmesi alma	Sağlanan adjustment_id ile InventoryAdjustment nesnesini döndürür.
Stok fiziksel sayısını alma	Sağlanan physical_count_id ile InventoryPhysicalCount nesnesini döndürür.
Stok sayısını alma	Belirli bir Konum kümesindeki belirli bir CatalogObject için geçerli hesaplanan hisse senedi sayısını alır.
Sıralamayı hesaplama (Beta)	Uygulamaların sipariş oluşturmadan sipariş fiyatlandırmasını önizlemesini sağlar.
Terminal kullanıma alma oluşturma	Bir Terminal ödeme isteği oluşturur ve istenen tutar için ödeme almak üzere belirtilen cihaza gönderir.
Terminal kullanıma almayı iptal etme	İsteğin durumu izin verirse Bir Terminal kullanıma alma isteğini iptal eder.
Terminal para iadelerinde arama	İstekte bulunan satıcı tarafından oluşturulan Interac Terminal para iadesi isteklerinin filtrelenmiş listesini alır.
Terminal para iadesi alma	Kimliğine göre Interac Terminal para iadesi nesnesi alır.
Terminal para iadesi oluşturma	Kare Terminalde tamamlanan Interac ödemesi için para iadesi isteği oluşturur.
Terminal para iadesini iptal et	İsteğin durumu izin verirse, para iadesi isteği kimliğine göre Interac Terminal para iadesi isteğini iptal eder.
Terminal ödemesi alma	checkout_id tarafından bir Terminal kullanıma alma isteği alır.
Toplu alma siparişleri	Kimliklerine göre bir dizi siparişi alır. Belirli bir sipariş kimliği yoksa, bir hata oluşturmak yerine kimlik yoksayılır.
Toplu alma stok sayıları	İstenen Konumlarda sağlanan CatalogObjects için geçerli sayıları döndürür.
Toplu değişiklik envanteri	Sağlanan madde miktarlarına düzeltmeler ve sayımlar uygular. Başarılı olduğunda: İstekte başvuruda bulunılan tüm nesneler için geçerli hesaplanan sayıları döndürür.
Toplu işlem katalog nesnelerini alma	Sağlanan kimliği temel alan bir nesne kümesi döndürür. Kümede döndürülen her CatalogItem, aşağıdakiler dahil olmak üzere tüm alt bilgilerini içerir: tüm CatalogItemVariation nesneleri, CatalogModifierList nesnelerine yapılan başvurular ve buna uygulanan tüm CatalogTax nesnelerinin kimlikleri.
Toplu olarak stok değişikliklerini alma	Sağlanan filtre ölçütlerine göre geçmiş fiziksel sayıları ve ayarlamaları döndürür.
Toplu upsert katalog nesneleri	Sağlanan nesne listesine göre en fazla 10.000 hedef nesne oluşturur veya güncelleştirir. Hedef nesneler toplu olarak gruplandırılır ve her toplu iş tümü veya hiç şeklinde eklenir/güncelleştirilir. Toplu iş içindeki bir nesne bir şekilde yanlış biçimlendirilmişse veya veritabanı kısıtlamasını ihlal ederse, söz konusu öğeyi içeren tüm toplu iş göz ardı edilir. Ancak, aynı istekteki diğer toplu işlemler yine de başarılı olabilir. Her toplu işlem en fazla 1.000 nesne içerebilir ve istek için toplam nesne sayısı (öğeler, varyasyonlar, değiştirici listeler, indirimler ve vergiler) 10.000'den fazla olmadığı sürece toplu işlemler sırayla işlenir.
Upsert katalog nesnesi	Hedef CatalogObject'i oluşturur veya güncelleştirir.
Uyuşmazlık kanıtlarını listeleme	Bir anlaşmazlıkla ilişkili kanıtların listesini döndürür.
Uyuşmazlık kanıtı metni oluşturma	Uyuşmazlık sınaması için kanıt olarak kullanılacak metni karşıya yükler.
Uyuşmazlıkları listeleme	Belirli bir hesapla ilişkili anlaşmazlıkların listesini döndürür.
Uyuşmazlığı kabul et	Bir anlaşmazlıkta kaybı kabul eder. Square, tartışmalı tutarı kart sahibine iade ederek anlaşmazlık durumunu KABUL EDİLEN olarak güncelleştirir. İtiraz edilen tutarı satıcının Kare hesabından borç olarak alır. Square hesabında yeterli fon yoksa, Square ilişkili banka hesabını borç olarak alır.
Ödeme alma	Belirli bir ödemenin ayrıntılarını alır.
Ödeme oluşturma	Sağlanan kaynağı kullanarak bir ödeme oluşturur. Bu uç noktayı bir karttan (kredi/banka kartı veya Kare hediye kartı) ücretlendirmek veya satıcının Square dışından aldığı bir ödemeyi (bir alıcıdan yapılan nakit ödeme veya bir dış varlığın satıcı adına işlediği bir ödeme) kaydetmek için kullanabilirsiniz.
Ödeme para iadelerini listeleme	İsteği yapan hesap için para iadelerinin listesini alır. Sonuçlar nihai olarak tutarlıdır ve yeni para iadelerinin veya para iadelerindeki değişikliklerin görünmesi birkaç saniye sürebilir.
Ödeme para iadesi alma	refund_id kullanarak belirli bir para iadesi alır.
Ödeme siparişi (Beta)	Bir veya daha fazla onaylanmış ödeme kullanarak bir sipariş için ödeme yapın veya toplam 0 ile bir siparişi ödeyin. İstekte listelenen payment_ids toplamı, sipariş toplamına eşit olmalıdır. Toplam tutarı 0 olan siparişler, istekte boş bir payment_ids dizisi belirtilerek ödendi olarak işaretlenebilir.
Ödemeleri listeleme	İstekte bulunan hesabın aldığı ödemelerin listesini alır. Sonuçlar nihai olarak tutarlıdır ve yeni ödemelerin veya ödemelerdeki değişikliklerin görünmesi birkaç saniye sürebilir.
Ödemeyi güncelleştirme	Bir ödemeyi APPROVED durumuyla güncelleştirir. Bu uç noktayı kullanarak amount_money ve tip_money güncelleştirebilirsiniz.
Ödemeyi iptal et	Bir ödemeyi iptal eder (geçersiz kılar). Onaylanan durumuyla bir ödemeyi iptal etmek için bu uç noktayı kullanabilirsiniz.
Ödemeyi tamamlama	Bir ödemeyi tamamlar (yakalar). Varsayılan olarak, ödemeler oluşturulduktan hemen sonra tamamlayacak şekilde ayarlanır.
Öğe değiştirici listelerini güncelleştirme	Hedeflenen CatalogItem için geçerli olan CatalogModifierList nesnelerini, öğenin tamamında bir upsert gerçekleştirmek zorunda kalmadan güncelleştirir.

Abonelik olaylarını listeleme

İşlem Kimliği:

SubscriptionListEvents

Belirli bir abonelik için tüm olayları listeler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Abonelik Kimliği	subscription_id	True	string	Aboneliğin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Abonelik Olayları	subscription_events	array of object
Kimlik	subscription_events.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Abonelik Olay Türü	subscription_events.subscription_event_type	string	Abonelik olayının türü.
Yürürlük Tarihi	subscription_events.effective_date	string	YYYY-MM-DD biçiminde abonelik olayının yürürlüğe girdiği tarih.
Plan Kimliği	subscription_events.plan_id	string	İlişkili abonelik planının kimliği

Abonelik oluşturma

İşlem Kimliği:

SubscriptionCreate

Müşteri için abonelik planına abonelik oluşturur. İstekte dosya üzerinde bir kart sağlarsanız, Square aboneliğin kartını ücretlendirilir. Aksi takdirde Square, faturayı müşterinin e-posta adresine faturalar. İstek isteğe bağlı start_date içermediği sürece abonelik hemen başlar. Her bir abonelik belirli bir konumla ilişkilendirilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Konum Kimliği	location_id		string	Konum tanımlayıcısı.
Plan Kimliği	plan_id		string	Katalog API'si kullanılarak oluşturulan abonelik planının kimliği.
Müşteri Kimliği	customer_id		string	Bağlanacak müşterinin kimliği.
Kart Kimliği	card_id		string	Ücretlendirilecek müşteri kartının kimliği.
Başlangıç Tarihi	start_date		string	Aboneliğin başlangıç tarihi, YYYY-MM-DD biçimindedir.
Vergi Yüzdesi	tax_percentage		string	Aboneliği faturalarken eklenecek vergi.
Miktar	amount		integer	tip_money dahil olmak üzere bu ödeme için kabul edilen para miktarı.
Para birimi	currency		string	3 karakterli ISO 4217 para birimi kodu.
Timezone	timezone		string	Abonelik için tarih hesaplamalarında kullanılan saat dilimi.
İsim	name		string	Nesnenin adı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	subscription.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	subscription.location_id	string	Konumun tanımlayıcısı.
Plan Kimliği	subscription.plan_id	string	İlişkili abonelik planının kimliği.
Müşteri Kimliği	subscription.customer_id	string	Müşteriyi temsil eden bu nesnenin kimliği.
Başlangıç Tarihi	subscription.start_date	string	Aboneliğin başlangıç tarihi, YYYY-MM-DD biçimindedir.
Statü	subscription.status	string	Bu nesnenin geçerli doğrulama durumu.
Vergi Yüzdesi	subscription.tax_percentage	string	Aboneliği faturalarken uygulanan vergi tutarı.
Miktar	subscription.price_override_money.amount	integer	Miktar.
Para birimi	subscription.price_override_money.currency	string	Para birimi.
Sürüm	subscription.version	integer	Bu nesnenin geçerli sürümü.
Oluşturma Tarihi	subscription.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Kart Kimliği	subscription.card_id	string	Abonelik için ücretlendirilen müşteri kartının kimliği.
Timezone	subscription.timezone	string	Takvim tarihlerini yorumlamak için kullanılan saat dilimi. Fatura oluşturulduğunda, bu alan satıcı konumu için belirtilen saat dilimine ayarlanır. Değer değiştirilemez.
İsim	subscription.source.name	string	Adı.

Abonelikleri ara

İşlem Kimliği:

SubscriptionSearch

Abonelikleri arar. Sonuçlar, abonelik oluşturma tarihine göre kronolojik olarak sıralanır. İstek birden fazla konum kimliği belirtiyorsa, uç nokta sonucu konum kimliğine ve ardından her konumda oluşturma tarihine göre sıralar. Sorguda hiçbir konum belirtilmemişse, tüm konumlar aranıyor.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Konum Kimlikleri	location_ids		array of string
Müşteri Kimlikleri	customer_ids		array of string
Kaynak Adları	source_names		array of string

Döndürülenler

Name	Yol	Tür	Description
Abonelik	subscriptions	array of object
Kimlik	subscriptions.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	subscriptions.location_id	string	Konumun tanımlayıcısı.
Plan Kimliği	subscriptions.plan_id	string	İlişkili abonelik planının kimliği
Müşteri Kimliği	subscriptions.customer_id	string	Hesapla ilişkilendirilmiş müşterinin Kare olarak atanan kimliği.
Başlangıç Tarihi	subscriptions.start_date	string	Aboneliğin başlangıç tarihi, YYYY-MM-DD biçimindedir.
İptal Tarihi	subscriptions.canceled_date	string	YYYY-MM-DD biçiminde abonelik iptal tarihi.
Ödeme Tarihi	subscriptions.charged_through_date	string	Müşterinin abonelik için YYYY-MM-DD biçiminde faturalandığı tarih.
Statü	subscriptions.status	string	Bu nesnenin geçerli doğrulama durumu.
Oluşturma Tarihi	subscriptions.created_at	string	ISO 8601 biçimindeki olay zamanı.
Kart Kimliği	subscriptions.card_id	string	Abonelik için ücretlendirilen müşteri kartının kimliği.
Ödeme Tarihi	subscriptions.paid_until_date	string	Ödeme tarihi.
Timezone	subscriptions.timezone	string	Due_date gibi, faturadaki takvim tarihlerini yorumlamak için kullanılan saat dilimi. Fatura oluşturulduğunda, bu alan satıcı konumu için belirtilen saat dilimine ayarlanır. Değer değiştirilemez.
İsim	subscriptions.source.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Vergi Yüzdesi	subscriptions.tax_percentage	string	Aboneliği faturalarken uygulanan vergi tutarı.
Miktar	subscriptions.price_override_money.amount	integer	Miktar.
Para birimi	subscriptions.price_override_money.currency	string	Para birimi.
Sürüm	subscriptions.version	integer	Nesnenin geçerli sürümü.
Fatura Kimlikleri	subscriptions.invoice_ids	array of string

Aboneliği alma

İşlem Kimliği:

SubscriptionRetrieve

Bir abonelik alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Abonelik Kimliği	subscription_id	True	string	Aboneliğin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	subscription.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	subscription.location_id	string	Konumun tanımlayıcısı.
Plan Kimliği	subscription.plan_id	string	İlişkili abonelik planının kimliği.
Müşteri Kimliği	subscription.customer_id	string	Müşteriyi temsil eden bu nesnenin kimliği.
Başlangıç Tarihi	subscription.start_date	string	Aboneliğin başlangıç tarihi, YYYY-MM-DD biçimindedir.
Ödeme Tarihi	subscription.charged_through_date	string	Müşterinin abonelik için YYYY-MM-DD biçiminde faturalandığı tarih.
Statü	subscription.status	string	Bu nesnenin geçerli doğrulama durumu.
Fatura Kimlikleri	subscription.invoice_ids	array of string
Miktar	subscription.price_override_money.amount	integer	Miktar.
Para birimi	subscription.price_override_money.currency	string	Para birimi.
Oluşturma Tarihi	subscription.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Ödeme Tarihi	subscription.paid_until_date	string	Ödeme tarihi.
Timezone	subscription.timezone	string	Takvim tarihlerini yorumlamak için kullanılan saat dilimi. Fatura oluşturulduğunda, bu alan satıcı konumu için belirtilen saat dilimine ayarlanır. Değer değiştirilemez.
İsim	subscription.source.name	string	Adı.

Aboneliği güncelleştirme

İşlem Kimliği:

SubscriptionUpdate

Aboneliği güncelleştirir. Abonelik alanı değerlerini ayarlayabilir, değiştirebilir ve temizleyebilirsiniz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Abonelik Kimliği	subscription_id	True	string	Aboneliğin tanımlayıcısı.
Sürüm	version		integer	Bu nesnenin geçerli sürümü.
Vergi Yüzdesi	tax_percentage		string	Aboneliği faturalarken uygulanan vergi tutarı.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	subscription.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	subscription.location_id	string	Konumun tanımlayıcısı.
Plan Kimliği	subscription.plan_id	string	İlişkili abonelik planının kimliği.
Müşteri Kimliği	subscription.customer_id	string	Müşteriyi temsil eden bu nesnenin kimliği.
Statü	subscription.status	string	Bu nesnenin geçerli doğrulama durumu.
Miktar	subscription.price_override_money.amount	integer	Miktar.
Para birimi	subscription.price_override_money.currency	string	Para birimi.
Sürüm	subscription.version	integer	Bu nesnenin geçerli sürümü.
Oluşturma Tarihi	subscription.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Timezone	subscription.timezone	string	Takvim tarihlerini yorumlamak için kullanılan saat dilimi. Fatura oluşturulduğunda, bu alan satıcı konumu için belirtilen saat dilimine ayarlanır. Değer değiştirilemez.
İsim	subscription.source.name	string	Adı.

Aboneliği iptal et

İşlem Kimliği:

SubscriptionCancel

canceled_date alanını etkin faturalama döneminin sonuna ayarlar. Bu tarihten sonra, durum ETKİn olan İptal EDİlDİ olarak değişir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Abonelik Kimliği	subscription_id	True	string	Aboneliğin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	subscription.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	subscription.location_id	string	Konumun tanımlayıcısı.
Plan Kimliği	subscription.plan_id	string	İlişkili abonelik planının kimliği.
Müşteri Kimliği	subscription.customer_id	string	Müşteriyi temsil eden bu nesnenin kimliği.
Kart Kimliği	subscription.card_id	string	Abonelik için ücretlendirilen müşteri kartının kimliği.
Başlangıç Tarihi	subscription.start_date	string	Aboneliğin başlangıç tarihi, YYYY-MM-DD biçimindedir.
İptal Tarihi	subscription.canceled_date	string	YYYY-MM-DD biçiminde abonelik iptal tarihi.
Ödeme Tarihi	subscription.paid_until_date	string	Ödeme tarihi.
Statü	subscription.status	string	Bu nesnenin geçerli doğrulama durumu.
Oluşturma Tarihi	subscription.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Sürüm	subscription.version	integer	Bu nesnenin geçerli sürümü.
Timezone	subscription.timezone	string	Takvim tarihlerini yorumlamak için kullanılan saat dilimi. Fatura oluşturulduğunda, bu alan satıcı konumu için belirtilen saat dilimine ayarlanır. Değer değiştirilemez.
İsim	subscription.source.name	string	Adı.

Aboneliği sürdür

İşlem Kimliği:

SubscriptionResume

Devre dışı bırakılmış aboneliği sürdürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Abonelik Kimliği	subscription_id	True	string	Aboneliğin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	subscription.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	subscription.location_id	string	Konumun tanımlayıcısı.
Plan Kimliği	subscription.plan_id	string	İlişkili abonelik planının kimliği.
Müşteri Kimliği	subscription.customer_id	string	Müşteriyi temsil eden bu nesnenin kimliği.
Statü	subscription.status	string	Bu nesnenin geçerli doğrulama durumu.
Miktar	subscription.price_override_money.amount	integer	Miktar.
Para birimi	subscription.price_override_money.currency	string	Para birimi.
Sürüm	subscription.version	integer	Bu nesnenin geçerli sürümü.
Oluşturma Tarihi	subscription.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Timezone	subscription.timezone	string	Takvim tarihlerini yorumlamak için kullanılan saat dilimi. Fatura oluşturulduğunda, bu alan satıcı konumu için belirtilen saat dilimine ayarlanır. Değer değiştirilemez.
İsim	subscription.source.name	string	Adı.

Apple Pay için etki alanı kaydetme

İşlem Kimliği:

ApplePayRegister

Web ve Kare üzerinde Apple Pay ile kullanmak üzere bir etki alanını etkinleştirir. Apple Pay özellikli bir etki alanı olarak düzgün ayarlandığından emin olmak için bu etki alanında Apple tarafından bir doğrulama gerçekleştirilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Alan Adı	domain_name	True	string	RFC-1034'te açıklandığı gibi, Apple Pay'e kaydedilecek bir etki alanı adı.

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Etki alanı kaydının durumu.

Arama siparişleri

İşlem Kimliği:

OrderSearch

Bir veya daha fazla konum için tüm siparişlerde arama yapın. Siparişler, Kare ekosistemine nasıl veya ne zaman girdiklerinden bağımsız olarak tüm satışları, iadeleri ve değişimleri içerir (Satış Noktası, Faturalar ve Connect API'leri gibi).

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İade Girdileri	return_entries		boolean	Arama sonuçlarının biçimini denetleyen boole değeri. True ise SearchOrders, OrderEntry nesnelerini döndürür. False ise, SearchOrders tam sıra nesnelerini döndürür.
Sınır	limit		integer	Tek bir sayfada döndürülecek sonuç sayısıyla ilgili bir sınır. Sınır danışmanlıktır; uygulama daha fazla veya daha az sonuç döndürebilir. Sağlanan sınır negatif, sıfır veya en yüksek sınır olan 1.000'den yüksekse, yoksayılır.
Konum Kimlikleri	location_ids		array of string
Başlangıç:	start_at		string	RFC 3339 biçiminde, zaman aralığının ne zaman başladığını gösteren bir tarih saat değeri.
Bitiş:	end_at		string	RFC 3339 biçiminde, zaman aralığının ne zaman sona erdiğini gösteren bir tarih saat değeri.
States	states		array of string
Sıralama Alanı	sort_field		string	Sıralama ölçütü olarak alan.
Sıralama Düzeni	sort_order		string	Sonuçların döndürüldiği kronolojik sıra.

Döndürülenler

Name	Yol	Tür	Description
Sipariş Girişleri	order_entries	array of object
Sipariş Kimliği	order_entries.order_id	string	Siparişin kimliği.
Konum Kimliği	order_entries.location_id	string	Konumun tanımlayıcısı.
Sürüm	order_entries.version	integer	Nesnenin geçerli sürümü.
Cursor	cursor	string	Özgün sorguyla ilişkili sonraki sonuç kümesini almak için sayfalandırma imlecini bu uç noktaya yapılan sonraki çağrılara ekleyin.

Arama terminali kullanıma alma işlemleri

İşlem Kimliği:

TerminalSearchCheckouts

İstekte bulunan hesap tarafından oluşturulan Terminal kullanıma alma isteklerinin filtrelenmiş listesini alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sınır	limit		integer	Tek bir sayfada döndürülecek sonuç sayısıyla ilgili bir sınır. Sınır danışmanlıktır; uygulama daha fazla veya daha az sonuç döndürebilir. Sağlanan sınır negatif, sıfır veya en yüksek sınır olan 1.000'den yüksekse, yoksayılır.
Statü	status		string	Geçerli durum.

Döndürülenler

Name	Yol	Tür	Description
Ödemeler	checkouts	array of object
Kimlik	checkouts.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Miktar	checkouts.amount_money.amount	integer	Miktar.
Para birimi	checkouts.amount_money.currency	string	Para birimi.
Başvuru Kimliği	checkouts.reference_id	string	Müşteri profilini başka bir sistemdeki bir varlıkla ilişkilendirmek için kullanılan isteğe bağlı ikinci kimlik.
Uyarı	checkouts.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
Cihaz Kimliği	checkouts.device_options.device_id	string	Bu TerminalCheckout için tasarlanan cihazın benzersiz kimliği.
Ekran Alıntısına İzin Ver	checkouts.device_options.tip_settings.allow_tipping	boolean	Bu ödeme için bahşiş vermenin etkinleştirilip etkinleştirilmediğini gösterir. Varsayılan değer false'tur.
Makbuz Ekranını Atla	checkouts.device_options.skip_receipt_screen	boolean	Cihaza makbuz ekranını atlayıp atlamasını emreder. Varsayılan değer false'tur.
Statü	checkouts.status	string	Bu nesnenin geçerli doğrulama durumu.
Ödeme Kimlikleri	checkouts.payment_ids	array of string
Oluşturma Tarihi	checkouts.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	checkouts.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Uygulama Kimliği	checkouts.app_id	string	Kullanıma alma işlemini oluşturan uygulamanın kimliği.
Son Tarih Süresi	checkouts.deadline_duration	string	Bir RFC 3339 süresi, ardından kullanıma alma işlemi otomatik olarak iptal edilir. BEKLEMEDE olan bir TerminalCheckout otomatik olarak İPTAL EDİlDİ ve iptal nedeni TIMED_OUT. Varsayılan: Oluşturmadan 5 dakika sonra
Cursor	cursor	string	Özgün sorguyla ilişkili sonraki sonuç kümesini almak için sayfalandırma imlecini bu uç noktaya yapılan sonraki çağrılara ekleyin.

Eşzamanlılık anahtarıyla ödemeyi iptal etme

İşlem Kimliği:

PaymentCancelIdempotency

İstekte belirtilen bir eşzamanlılık anahtarı tarafından tanımlanan bir ödemeyi iptal eder (geçersiz kılar). CreatePayment isteğinin durumu bilinmiyorsa (örneğin, Bir CreatePayment isteği gönderdikten sonra bir ağ hatası oluşur ve yanıt alamazsınız) bu yöntemi kullanın. Bu durumda Square'i bu uç noktayı kullanarak ödemeyi iptal etmeye yönlendirebilirsiniz. İstekte, Iptal etmek istediğiniz CreatePayment isteğinizde sağladığınız aynı eşzamanlılık anahtarını sağlarsınız. Ödemeyi iptal ettikten sonra CreatePayment isteğinizi yeniden gönderebilirsiniz. Belirtilen bir eşzamanlılık anahtarıyla ödeme yapılmazsa hiçbir işlem yapılmadığını ve uç noktanın başarıyla döndürüldüğünü unutmayın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.

Döndürülenler

response

object

Fatura oluşturma

İşlem Kimliği:

InvoiceCreate

Siparişler API'sini kullanarak oluşturulan bir sipariş için taslak fatura oluşturur. Taslak fatura hesabınızda kalır ve hiçbir işlem yapılmaz. Square'in faturayı işleyebilmesi için önce faturayı yayımlamanız gerekir (müşterinin e-posta adresine gönderin veya dosyada müşterinin kartından ücret alın).

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Konum Kimliği	location_id		string	Konumun tanımlayıcısı.
Sipariş Kimliği	order_id		string	Siparişin kimliği.
Zamanlanan Tarih	scheduled_at		string	İşlemenin zamanlandığı zaman damgası RFC 3339 biçimindedir.
Müşteri Kimliği	customer_id		string	Siparişle ilişkili müşterinin kimliği.
Teslim Yöntemi	delivery_method		string	Square'in faturayı, anımsatıcıları ve makbuzları müşteriye göndermek için kullandığı teslimat yöntemi. Fatura yayımlandıktan sonra Square, faturayı hemen veya belirtildiyse scheduled_at tarihte teslim yöntemine ve ödeme isteği ayarlarına göre işler.
İstek Türü	request_type		string	Ödeme isteği türünü tanımlar. Bu tür, ödeme isteği tutarının nasıl belirlendiğini tanımlar.
Son Tarih	due_date		string	Ödeme isteğinin son tarihi, YYYY-MM-DD biçimindedir.
Ekran Alıntısı Etkin	tipping_enabled		boolean	True olarak ayarlanırsa, müşterinin bir ipucu ödemesi için bir yer sağlar.
Otomatik Ödeme Kaynağı	automatic_payment_source		string	Otomatik ödeme için ödeme yöntemi.
Message	message		string	İleti.
Göreli Zamanlanmış Günler	relative_scheduled_days		integer	Anımsatıcı gönderildiğinde ödeme isteğinin due_date önceki (negatif bir sayı) veya sonraki gün sayısı (pozitif bir sayı).
Fatura Numarası	invoice_number		string	Kullanıcı dostu bir fatura numarası. Değer bir konum içinde benzersizdir. Fatura oluşturulurken sağlanmazsa Square bir değer atar.
Başlık	title		string	Başlık.
Description	description		string	Açıklama.
Card	card		boolean	Kredi kartı veya banka kartı ödemelerinin kabul edilip edilmediğini gösterir.
Kare Hediye Kartı	square_gift_card		boolean	Kare hediye kartı ödemelerinin kabul edilip edilmediğini gösterir.
Banka hesabı	bank_account		boolean	Banka havalesi ödemelerinin kabul edilip edilmediğini gösterir.
Etiket	label		string	Özel alanın etiketi veya başlığı.
Değer	value		string	Özel alanın metni.
Yerleştirme	placement		string	Faturadaki özel alanın konumu.
Satış veya Servis Tarihi	sale_or_service_date		string	Satış tarihi veya hizmetin işlendiği tarih, YYYY-MM-DD biçimindedir. Bu alan, faturada görüntülenen geçmiş veya gelecekteki bir tarihi belirtmek için kullanılabilir.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	invoice.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Sürüm	invoice.version	integer	Bu nesnenin geçerli sürümü.
Konum Kimliği	invoice.location_id	string	Konumun tanımlayıcısı.
Sipariş Kimliği	invoice.order_id	string	Siparişin kimliği.
Ödeme İstekleri	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Kare tarafından oluşturulan kimlik.
İstek Türü	invoice.payment_requests.request_type	string	Ödeme isteği türünü tanımlar. Bu tür, ödeme isteği tutarının nasıl belirlendiğini tanımlar.
Son Tarih	invoice.payment_requests.due_date	string	Ödeme isteğinin son tarihi, YYYY-MM-DD biçimindedir.
Ekran Alıntısı Etkin	invoice.payment_requests.tipping_enabled	boolean	True olarak ayarlanırsa, müşterinin bir ipucu ödemesi için bir yer sağlar.
Hatırlatmalar	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Kare olarak atanan kimlik.
Göreli Zamanlanmış Günler	invoice.payment_requests.reminders.relative_scheduled_days	integer	Anımsatıcı gönderildiğinde ödeme isteğinin due_date önceki (negatif bir sayı) veya sonraki gün sayısı (pozitif bir sayı).
Message	invoice.payment_requests.reminders.message	string	İleti.
Statü	invoice.payment_requests.reminders.status	string	Geçerli durum.
Miktar	invoice.payment_requests.computed_amount_money.amount	integer	Miktar.
Para birimi	invoice.payment_requests.computed_amount_money.currency	string	Para birimi.
Miktar	invoice.payment_requests.total_completed_amount_money.amount	integer	Miktar.
Para birimi	invoice.payment_requests.total_completed_amount_money.currency	string	Para birimi.
Otomatik Ödeme Kaynağı	invoice.payment_requests.automatic_payment_source	string	Otomatik ödeme için ödeme yöntemi.
Fatura Numarası	invoice.invoice_number	string	Kullanıcı dostu bir fatura numarası. Değer bir konum içinde benzersizdir. Fatura oluşturulurken sağlanmazsa Square bir değer atar.
Başlık	invoice.title	string	Başlık.
Description	invoice.description	string	Açıklama.
Zamanlanan Tarih	invoice.scheduled_at	string	İşlemenin zamanlandığı zaman damgası RFC 3339 biçimindedir.
Statü	invoice.status	string	Bu nesnenin geçerli doğrulama durumu.
Timezone	invoice.timezone	string	Takvim tarihlerini yorumlamak için kullanılan saat dilimi. Fatura oluşturulduğunda, bu alan satıcı konumu için belirtilen saat dilimine ayarlanır. Değer değiştirilemez.
Oluşturma Tarihi	invoice.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	invoice.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Müşteri Kimliği	invoice.primary_recipient.customer_id	string	Siparişle ilişkili müşterinin kimliği.
İsim	invoice.primary_recipient.given_name	string	Alıcının adı (yani, adı) verilmiştir.
Aile Adı	invoice.primary_recipient.family_name	string	Alıcının ailesinin (soyadı) adı.
E-posta Adresi	invoice.primary_recipient.email_address	string	Alıcının e-posta adresi.
Telefon Numarası	invoice.primary_recipient.phone_number	string	Alıcının telefon numarası.
Card	invoice.accepted_payment_methods.card	boolean	Kredi kartı veya banka kartı ödemelerinin kabul edilip edilmediğini gösterir.
Kare Hediye Kartı	invoice.accepted_payment_methods.square_gift_card	boolean	Kare hediye kartı ödemelerinin kabul edilip edilmediğini gösterir.
Banka hesabı	invoice.accepted_payment_methods.bank_account	boolean	Banka havalesi ödemelerinin kabul edilip edilmediğini gösterir.
Özel Alanlar	invoice.custom_fields	array of object
Etiket	invoice.custom_fields.label	string	Özel alanın etiketi veya başlığı.
Değer	invoice.custom_fields.value	string	Özel alanın metni.
Yerleştirme	invoice.custom_fields.placement	string	Faturadaki özel alanın konumu.
Teslim Yöntemi	invoice.delivery_method	string	Square'in faturayı, anımsatıcıları ve makbuzları müşteriye göndermek için kullandığı teslimat yöntemi. Fatura yayımlandıktan sonra Square, faturayı hemen veya belirtildiyse scheduled_at tarihte teslim yöntemine ve ödeme isteği ayarlarına göre işler.
Satış veya Servis Tarihi	invoice.sale_or_service_date	string	Satış tarihi veya hizmetin işlendiği tarih, YYYY-MM-DD biçimindedir. Bu alan, faturada görüntülenen geçmiş veya gelecekteki bir tarihi belirtmek için kullanılabilir.

Faturalarda arama

İşlem Kimliği:

InvoiceSearch

Filtrede belirtilen bir konumdan fatura arar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Konum Kimlikleri	location_ids		array of string
Müşteri Kimlikleri	customer_ids		array of string
Veri Alanı	field		string	Arama yapılan müşteri profillerini sıralamak için sıralama anahtarı olarak bir veya daha fazla müşteri özniteliği kullanın.
Sipariş	order		string	Sıralama alanı değerine göre sonuçların sıralanma sırasını gösterir. Dizeler, sırayı belirlemek için standart alfabetik karşılaştırmayı kullanır.
Sınır	limit		integer	Döndürülecek fatura sayısı üst sınırı (200' dür). Sağlanmadıysa, sunucu varsayılan olarak 100 fatura sınırı kullanır.

Döndürülenler

Name	Yol	Tür	Description
Invoices	invoices	array of object
Kimlik	invoices.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Sürüm	invoices.version	integer	Nesnenin geçerli sürümü.
Konum Kimliği	invoices.location_id	string	Konumun tanımlayıcısı.
Sipariş Kimliği	invoices.order_id	string	Siparişin kimliği.
Ödeme İstekleri	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	Faturadaki ödeme isteğinin Kare olarak oluşturulan kimliği.
İstek Türü	invoices.payment_requests.request_type	string	Ödeme isteği türünü tanımlar. Bu tür, ödeme isteği tutarının nasıl belirlendiğini tanımlar.
Son Tarih	invoices.payment_requests.due_date	string	Ödeme isteğinin son tarihi (faturanın saat diliminde), YYYY-MM-DD biçimindedir.
Ekran Alıntısı Etkin	invoices.payment_requests.tipping_enabled	boolean	True olarak ayarlanırsa, Kare şeklinde barındırılan fatura sayfası (faturanın public_url alanı) müşterinin ipucu ödemesi için bir yer sağlar.
Hatırlatmalar	invoices.payment_requests.reminders	array of object	Hatırlatmalar
UID	invoices.payment_requests.reminders.uid	string	InvoicePaymentRequest içinde anımsatıcıyı benzersiz olarak tanımlayan, Kare atanan kimlik.
Göreli Zamanlanmış Günler	invoices.payment_requests.reminders.relative_scheduled_days	integer	Anımsatıcı gönderildiğinde ödeme isteğinin due_date önceki (negatif bir sayı) veya sonraki gün sayısı (pozitif bir sayı).
Message	invoices.payment_requests.reminders.message	string	Anımsatıcı iletisi.
Statü	invoices.payment_requests.reminders.status	string	Anımsatıcının durumu.
Miktar	invoices.payment_requests.computed_amount_money.amount	integer	Miktar.
Para birimi	invoices.payment_requests.computed_amount_money.currency	string	Para birimi.
Miktar	invoices.payment_requests.total_completed_amount_money.amount	integer	Miktar.
Para birimi	invoices.payment_requests.total_completed_amount_money.currency	string	Para birimi.
Otomatik Ödeme Kaynağı	invoices.payment_requests.automatic_payment_source	string	Otomatik ödeme için ödeme yöntemi.
İstenen Yüzde	invoices.payment_requests.percentage_requested	string	Ödeme isteğinin tutarını yüzde olarak belirtir.
Kart Kimliği	invoices.payment_requests.card_id	string	Ödeme isteği için ücretlendirilecek kredi kartının veya banka kartının kimliği.
Fatura Numarası	invoices.invoice_number	string	Kullanıcı dostu bir fatura numarası.
Başlık	invoices.title	string	Faturanın başlığı.
Description	invoices.description	string	Açıklama.
Zamanlanan Tarih	invoices.scheduled_at	string	Faturanın, RFC 3339 biçiminde işlenmek üzere zamanlandığı zaman damgası. Fatura yayımlandıktan sonra Square, faturayı belirtilen tarihte teslim yöntemine ve ödeme isteği ayarlarına göre işler.
Statü	invoices.status	string	Bu nesnenin geçerli doğrulama durumu.
Timezone	invoices.timezone	string	Due_date gibi, faturadaki takvim tarihlerini yorumlamak için kullanılan saat dilimi. Fatura oluşturulduğunda, bu alan satıcı konumu için belirtilen saat dilimine ayarlanır. Değer değiştirilemez.
Oluşturma Tarihi	invoices.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	invoices.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Müşteri Kimliği	invoices.primary_recipient.customer_id	string	Kartla ilişkilendirilecek müşterinin kimliği.
İsim	invoices.primary_recipient.given_name	string	Alıcının adı (yani, adı) verilmiştir.
Aile Adı	invoices.primary_recipient.family_name	string	Alıcının ailesinin (soyadı) adı.
E-posta Adresi	invoices.primary_recipient.email_address	string	Alıcının e-posta adresi.
Telefon Numarası	invoices.primary_recipient.phone_number	string	Alıcının telefon numarası.
Card	invoices.accepted_payment_methods.card	boolean	Kredi kartı veya banka kartı ödemelerinin kabul edilip edilmediğini gösterir.
Kare Hediye Kartı	invoices.accepted_payment_methods.square_gift_card	boolean	Kare hediye kartı ödemelerinin kabul edilip edilmediğini gösterir.
Banka hesabı	invoices.accepted_payment_methods.bank_account	boolean	Banka havalesi ödemelerinin kabul edilip edilmediğini gösterir.
Özel Alanlar	invoices.custom_fields	array of object
Etiket	invoices.custom_fields.label	string	Özel alanın etiketi veya başlığı.
Değer	invoices.custom_fields.value	string	Özel alanın metni.
Yerleştirme	invoices.custom_fields.placement	string	Faturadaki özel alanın konumu
Teslim Yöntemi	invoices.delivery_method	string	Square'in faturayı, anımsatıcıları ve makbuzları müşteriye göndermek için kullandığı teslimat yöntemi.
Satış veya Servis Tarihi	invoices.sale_or_service_date	string	Satış tarihi veya hizmetin işlendiği tarih, YYYY-MM-DD biçimindedir. Bu alan, faturada görüntülenen geçmiş veya gelecekteki bir tarihi belirtmek için kullanılabilir.
Genel URL	invoices.public_url	string	Barındırılan kare fatura sayfasının URL'si. PublishInvoice uç noktasını kullanarak faturayı yayımladıktan sonra, Square fatura sayfasını barındırıp yanıttaki sayfa URL'sini döndürür.
Miktar	invoices.next_payment_amount_money.amount	integer	Miktar.
Para birimi	invoices.next_payment_amount_money.currency	string	Para birimi.
Cursor	cursor	string	Özgün sorguyla ilişkili sonraki sonuç kümesini almak için sayfalandırma imlecini bu uç noktaya yapılan sonraki çağrılara ekleyin.

Faturaları listeleme

İşlem Kimliği:

InvoiceList

Belirli bir konum için faturaların listesini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Konum Kimliği	location_id		string	Yalnızca belirli bir konuma ait kayıtları almak için bu isteğe bağlı filtreyi belirtebilirsiniz.
Cursor	cursor		string	Bu uç noktaya önceki bir çağrı tarafından döndürülen sayfalandırma imleci.
Sınır	limit		integer	Yanıtta döndürülecek sayı üst sınırı.

Döndürülenler

Name	Yol	Tür	Description
Invoices	invoices	array of object
Kimlik	invoices.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Sürüm	invoices.version	integer	Nesnenin geçerli sürümü.
Konum Kimliği	invoices.location_id	string	Konumun tanımlayıcısı.
Sipariş Kimliği	invoices.order_id	string	Siparişin kimliği.
Ödeme İstekleri	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	Faturadaki ödeme isteğinin Kare olarak oluşturulan kimliği.
İstek Türü	invoices.payment_requests.request_type	string	Ödeme isteği türünü tanımlar. Bu tür, ödeme isteği tutarının nasıl belirlendiğini tanımlar.
Son Tarih	invoices.payment_requests.due_date	string	Ödeme isteğinin son tarihi (faturanın saat diliminde), YYYY-MM-DD biçimindedir.
Ekran Alıntısı Etkin	invoices.payment_requests.tipping_enabled	boolean	True olarak ayarlanırsa, Kare şeklinde barındırılan fatura sayfası (faturanın public_url alanı) müşterinin ipucu ödemesi için bir yer sağlar.
Hatırlatmalar	invoices.payment_requests.reminders	array of object	Hatırlatmalar
UID	invoices.payment_requests.reminders.uid	string	InvoicePaymentRequest içinde anımsatıcıyı benzersiz olarak tanımlayan, Kare atanan kimlik.
Göreli Zamanlanmış Günler	invoices.payment_requests.reminders.relative_scheduled_days	integer	Anımsatıcı gönderildiğinde ödeme isteğinin due_date önceki (negatif bir sayı) veya sonraki gün sayısı (pozitif bir sayı).
Message	invoices.payment_requests.reminders.message	string	Anımsatıcı iletisi.
Statü	invoices.payment_requests.reminders.status	string	Anımsatıcının durumu.
Miktar	invoices.payment_requests.computed_amount_money.amount	integer	Miktar.
Para birimi	invoices.payment_requests.computed_amount_money.currency	string	Para birimi.
Miktar	invoices.payment_requests.total_completed_amount_money.amount	integer	Miktar.
Para birimi	invoices.payment_requests.total_completed_amount_money.currency	string	Para birimi.
Otomatik Ödeme Kaynağı	invoices.payment_requests.automatic_payment_source	string	Otomatik ödeme için ödeme yöntemi.
İstenen Yüzde	invoices.payment_requests.percentage_requested	string	Ödeme isteğinin tutarını yüzde olarak belirtir.
Kart Kimliği	invoices.payment_requests.card_id	string	Ödeme isteği için ücretlendirilecek kredi kartının veya banka kartının kimliği.
Fatura Numarası	invoices.invoice_number	string	Kullanıcı dostu bir fatura numarası.
Başlık	invoices.title	string	Faturanın başlığı.
Description	invoices.description	string	Açıklama.
Zamanlanan Tarih	invoices.scheduled_at	string	Faturanın, RFC 3339 biçiminde işlenmek üzere zamanlandığı zaman damgası. Fatura yayımlandıktan sonra Square, faturayı belirtilen tarihte teslim yöntemine ve ödeme isteği ayarlarına göre işler.
Statü	invoices.status	string	Bu nesnenin geçerli doğrulama durumu.
Timezone	invoices.timezone	string	Due_date gibi, faturadaki takvim tarihlerini yorumlamak için kullanılan saat dilimi. Fatura oluşturulduğunda, bu alan satıcı konumu için belirtilen saat dilimine ayarlanır. Değer değiştirilemez.
Oluşturma Tarihi	invoices.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	invoices.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Müşteri Kimliği	invoices.primary_recipient.customer_id	string	Kartla ilişkilendirilecek müşterinin kimliği.
İsim	invoices.primary_recipient.given_name	string	Alıcının adı (yani, adı) verilmiştir.
Aile Adı	invoices.primary_recipient.family_name	string	Alıcının ailesinin (soyadı) adı.
E-posta Adresi	invoices.primary_recipient.email_address	string	Alıcının e-posta adresi.
Telefon Numarası	invoices.primary_recipient.phone_number	string	Alıcının telefon numarası.
Card	invoices.accepted_payment_methods.card	boolean	Kredi kartı veya banka kartı ödemelerinin kabul edilip edilmediğini gösterir.
Kare Hediye Kartı	invoices.accepted_payment_methods.square_gift_card	boolean	Kare hediye kartı ödemelerinin kabul edilip edilmediğini gösterir.
Banka hesabı	invoices.accepted_payment_methods.bank_account	boolean	Banka havalesi ödemelerinin kabul edilip edilmediğini gösterir.
Özel Alanlar	invoices.custom_fields	array of object
Etiket	invoices.custom_fields.label	string	Özel alanın etiketi veya başlığı.
Değer	invoices.custom_fields.value	string	Özel alanın metni.
Yerleştirme	invoices.custom_fields.placement	string	Faturadaki özel alanın konumu
Teslim Yöntemi	invoices.delivery_method	string	Square'in faturayı, anımsatıcıları ve makbuzları müşteriye göndermek için kullandığı teslimat yöntemi.
Satış veya Servis Tarihi	invoices.sale_or_service_date	string	Satış tarihi veya hizmetin işlendiği tarih, YYYY-MM-DD biçimindedir. Bu alan, faturada görüntülenen geçmiş veya gelecekteki bir tarihi belirtmek için kullanılabilir.
Genel URL	invoices.public_url	string	Barındırılan kare fatura sayfasının URL'si. PublishInvoice uç noktasını kullanarak faturayı yayımladıktan sonra, Square fatura sayfasını barındırıp yanıttaki sayfa URL'sini döndürür.
Miktar	invoices.next_payment_amount_money.amount	integer	Miktar.
Para birimi	invoices.next_payment_amount_money.currency	string	Para birimi.
Cursor	cursor	string	Özgün sorguyla ilişkili sonraki sonuç kümesini almak için sayfalandırma imlecini bu uç noktaya yapılan sonraki çağrılara ekleyin.

Faturayı alma

İşlem Kimliği:

InvoiceGet

Fatura kimliğine göre bir fatura alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Fatura kimliği	invoice_id	True	string	Faturanın tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	invoice.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Sürüm	invoice.version	integer	Bu nesnenin geçerli sürümü.
Konum Kimliği	invoice.location_id	string	Konumun tanımlayıcısı.
Sipariş Kimliği	invoice.order_id	string	Siparişin kimliği.
Ödeme İstekleri	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Kare tarafından oluşturulan kimlik.
İstek Türü	invoice.payment_requests.request_type	string	Ödeme isteği türünü tanımlar. Bu tür, ödeme isteği tutarının nasıl belirlendiğini tanımlar.
Son Tarih	invoice.payment_requests.due_date	string	Ödeme isteğinin son tarihi, YYYY-MM-DD biçimindedir.
Ekran Alıntısı Etkin	invoice.payment_requests.tipping_enabled	boolean	True olarak ayarlanırsa, müşterinin bir ipucu ödemesi için bir yer sağlar.
Hatırlatmalar	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Kare olarak atanan kimlik.
Göreli Zamanlanmış Günler	invoice.payment_requests.reminders.relative_scheduled_days	integer	Anımsatıcı gönderildiğinde ödeme isteğinin due_date önceki (negatif bir sayı) veya sonraki gün sayısı (pozitif bir sayı).
Message	invoice.payment_requests.reminders.message	string	İleti.
Statü	invoice.payment_requests.reminders.status	string	Geçerli durum.
Miktar	invoice.payment_requests.computed_amount_money.amount	integer	Miktar.
Para birimi	invoice.payment_requests.computed_amount_money.currency	string	Para birimi.
Miktar	invoice.payment_requests.total_completed_amount_money.amount	integer	Miktar.
Para birimi	invoice.payment_requests.total_completed_amount_money.currency	string	Para birimi.
Otomatik Ödeme Kaynağı	invoice.payment_requests.automatic_payment_source	string	Otomatik ödeme için ödeme yöntemi.
Fatura Numarası	invoice.invoice_number	string	Kullanıcı dostu bir fatura numarası. Değer bir konum içinde benzersizdir. Fatura oluşturulurken sağlanmazsa Square bir değer atar.
Başlık	invoice.title	string	Başlık.
Description	invoice.description	string	Açıklama.
Zamanlanan Tarih	invoice.scheduled_at	string	İşlemenin zamanlandığı zaman damgası RFC 3339 biçimindedir.
Statü	invoice.status	string	Bu nesnenin geçerli doğrulama durumu.
Timezone	invoice.timezone	string	Takvim tarihlerini yorumlamak için kullanılan saat dilimi. Fatura oluşturulduğunda, bu alan satıcı konumu için belirtilen saat dilimine ayarlanır. Değer değiştirilemez.
Oluşturma Tarihi	invoice.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	invoice.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Müşteri Kimliği	invoice.primary_recipient.customer_id	string	Siparişle ilişkili müşterinin kimliği.
İsim	invoice.primary_recipient.given_name	string	Alıcının adı (yani, adı) verilmiştir.
Aile Adı	invoice.primary_recipient.family_name	string	Alıcının ailesinin (soyadı) adı.
E-posta Adresi	invoice.primary_recipient.email_address	string	Alıcının e-posta adresi.
Telefon Numarası	invoice.primary_recipient.phone_number	string	Alıcının telefon numarası.
Card	invoice.accepted_payment_methods.card	boolean	Kredi kartı veya banka kartı ödemelerinin kabul edilip edilmediğini gösterir.
Kare Hediye Kartı	invoice.accepted_payment_methods.square_gift_card	boolean	Kare hediye kartı ödemelerinin kabul edilip edilmediğini gösterir.
Banka hesabı	invoice.accepted_payment_methods.bank_account	boolean	Banka havalesi ödemelerinin kabul edilip edilmediğini gösterir.
Özel Alanlar	invoice.custom_fields	array of object
Etiket	invoice.custom_fields.label	string	Özel alanın etiketi veya başlığı.
Değer	invoice.custom_fields.value	string	Özel alanın metni.
Yerleştirme	invoice.custom_fields.placement	string	Faturadaki özel alanın konumu.
Teslim Yöntemi	invoice.delivery_method	string	Square'in faturayı, anımsatıcıları ve makbuzları müşteriye göndermek için kullandığı teslimat yöntemi. Fatura yayımlandıktan sonra Square, faturayı hemen veya belirtildiyse scheduled_at tarihte teslim yöntemine ve ödeme isteği ayarlarına göre işler.
Satış veya Servis Tarihi	invoice.sale_or_service_date	string	Satış tarihi veya hizmetin işlendiği tarih, YYYY-MM-DD biçimindedir. Bu alan, faturada görüntülenen geçmiş veya gelecekteki bir tarihi belirtmek için kullanılabilir.

Faturayı güncelleştirme

İşlem Kimliği:

InvoiceUpdate

Alanları değiştirerek, alanları temizleyerek veya her ikisini birden yaparak faturayı güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Fatura kimliği	invoice_id	True	string	Faturanın tanımlayıcısı.
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
UID	uid		string	Kare tarafından oluşturulan kimlik.
Ekran Alıntısı Etkin	tipping_enabled		boolean	True olarak ayarlanırsa, müşterinin bir ipucu ödemesi için bir yer sağlar.
Temizlenecek Alanlar	fields_to_clear		array of string

Döndürülenler

Name	Yol	Tür	Description
Kimlik	invoice.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Sürüm	invoice.version	integer	Bu nesnenin geçerli sürümü.
Konum Kimliği	invoice.location_id	string	Konumun tanımlayıcısı.
Sipariş Kimliği	invoice.order_id	string	Siparişin kimliği.
Ödeme İstekleri	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Kare tarafından oluşturulan kimlik.
İstek Türü	invoice.payment_requests.request_type	string	Ödeme isteği türünü tanımlar. Bu tür, ödeme isteği tutarının nasıl belirlendiğini tanımlar.
Son Tarih	invoice.payment_requests.due_date	string	Ödeme isteğinin son tarihi, YYYY-MM-DD biçimindedir.
Ekran Alıntısı Etkin	invoice.payment_requests.tipping_enabled	boolean	True olarak ayarlanırsa, müşterinin bir ipucu ödemesi için bir yer sağlar.
Miktar	invoice.payment_requests.computed_amount_money.amount	integer	Miktar.
Para birimi	invoice.payment_requests.computed_amount_money.currency	string	Para birimi.
Miktar	invoice.payment_requests.total_completed_amount_money.amount	integer	Miktar.
Para birimi	invoice.payment_requests.total_completed_amount_money.currency	string	Para birimi.
Otomatik Ödeme Kaynağı	invoice.payment_requests.automatic_payment_source	string	Otomatik ödeme için ödeme yöntemi.
Fatura Numarası	invoice.invoice_number	string	Kullanıcı dostu bir fatura numarası. Değer bir konum içinde benzersizdir. Fatura oluşturulurken sağlanmazsa Square bir değer atar.
Başlık	invoice.title	string	Başlık.
Description	invoice.description	string	Açıklama.
Zamanlanan Tarih	invoice.scheduled_at	string	İşlemenin zamanlandığı zaman damgası RFC 3339 biçimindedir.
Statü	invoice.status	string	Bu nesnenin geçerli doğrulama durumu.
Timezone	invoice.timezone	string	Takvim tarihlerini yorumlamak için kullanılan saat dilimi. Fatura oluşturulduğunda, bu alan satıcı konumu için belirtilen saat dilimine ayarlanır. Değer değiştirilemez.
Oluşturma Tarihi	invoice.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	invoice.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Müşteri Kimliği	invoice.primary_recipient.customer_id	string	Siparişle ilişkili müşterinin kimliği.
İsim	invoice.primary_recipient.given_name	string	Alıcının adı (yani, adı) verilmiştir.
Aile Adı	invoice.primary_recipient.family_name	string	Alıcının ailesinin (soyadı) adı.
E-posta Adresi	invoice.primary_recipient.email_address	string	Alıcının e-posta adresi.
Telefon Numarası	invoice.primary_recipient.phone_number	string	Alıcının telefon numarası.
Miktar	invoice.next_payment_amount_money.amount	integer	Miktar.
Para birimi	invoice.next_payment_amount_money.currency	string	Para birimi.
Card	invoice.accepted_payment_methods.card	boolean	Kredi kartı veya banka kartı ödemelerinin kabul edilip edilmediğini gösterir.
Kare Hediye Kartı	invoice.accepted_payment_methods.square_gift_card	boolean	Kare hediye kartı ödemelerinin kabul edilip edilmediğini gösterir.
Banka hesabı	invoice.accepted_payment_methods.bank_account	boolean	Banka havalesi ödemelerinin kabul edilip edilmediğini gösterir.
Özel Alanlar	invoice.custom_fields	array of object
Etiket	invoice.custom_fields.label	string	Özel alanın etiketi veya başlığı.
Değer	invoice.custom_fields.value	string	Özel alanın metni.
Yerleştirme	invoice.custom_fields.placement	string	Faturadaki özel alanın konumu.
Teslim Yöntemi	invoice.delivery_method	string	Square'in faturayı, anımsatıcıları ve makbuzları müşteriye göndermek için kullandığı teslimat yöntemi. Fatura yayımlandıktan sonra Square, faturayı hemen veya belirtildiyse scheduled_at tarihte teslim yöntemine ve ödeme isteği ayarlarına göre işler.
Satış veya Servis Tarihi	invoice.sale_or_service_date	string	Satış tarihi veya hizmetin işlendiği tarih, YYYY-MM-DD biçimindedir. Bu alan, faturada görüntülenen geçmiş veya gelecekteki bir tarihi belirtmek için kullanılabilir.

Faturayı iptal et

İşlem Kimliği:

InvoiceCancel

Faturayı iptal eder. Satıcı, iptal edilen faturanın ödemelerini toplayamaz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Fatura kimliği	invoice_id	True	string	Faturanın tanımlayıcısı.
Sürüm	version		integer	Sürüm.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	invoice.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Sürüm	invoice.version	integer	Bu nesnenin geçerli sürümü.
Konum Kimliği	invoice.location_id	string	Konumun tanımlayıcısı.
Sipariş Kimliği	invoice.order_id	string	Siparişin kimliği.
Ödeme İstekleri	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Kare tarafından oluşturulan kimlik.
İstek Türü	invoice.payment_requests.request_type	string	Ödeme isteği türünü tanımlar. Bu tür, ödeme isteği tutarının nasıl belirlendiğini tanımlar.
Son Tarih	invoice.payment_requests.due_date	string	Ödeme isteğinin son tarihi, YYYY-MM-DD biçimindedir.
Ekran Alıntısı Etkin	invoice.payment_requests.tipping_enabled	boolean	True olarak ayarlanırsa, müşterinin bir ipucu ödemesi için bir yer sağlar.
Hatırlatmalar	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Kare olarak atanan kimlik.
Göreli Zamanlanmış Günler	invoice.payment_requests.reminders.relative_scheduled_days	integer	Anımsatıcı gönderildiğinde ödeme isteğinin due_date önceki (negatif bir sayı) veya sonraki gün sayısı (pozitif bir sayı).
Message	invoice.payment_requests.reminders.message	string	İleti.
Statü	invoice.payment_requests.reminders.status	string	Geçerli durum.
Miktar	invoice.payment_requests.computed_amount_money.amount	integer	Miktar.
Para birimi	invoice.payment_requests.computed_amount_money.currency	string	Para birimi.
Miktar	invoice.payment_requests.total_completed_amount_money.amount	integer	Miktar.
Para birimi	invoice.payment_requests.total_completed_amount_money.currency	string	Para birimi.
Otomatik Ödeme Kaynağı	invoice.payment_requests.automatic_payment_source	string	Otomatik ödeme için ödeme yöntemi.
Fatura Numarası	invoice.invoice_number	string	Kullanıcı dostu bir fatura numarası. Değer bir konum içinde benzersizdir. Fatura oluşturulurken sağlanmazsa Square bir değer atar.
Başlık	invoice.title	string	Başlık.
Description	invoice.description	string	Açıklama.
Zamanlanan Tarih	invoice.scheduled_at	string	İşlemenin zamanlandığı zaman damgası RFC 3339 biçimindedir.
Statü	invoice.status	string	Bu nesnenin geçerli doğrulama durumu.
Timezone	invoice.timezone	string	Takvim tarihlerini yorumlamak için kullanılan saat dilimi. Fatura oluşturulduğunda, bu alan satıcı konumu için belirtilen saat dilimine ayarlanır. Değer değiştirilemez.
Oluşturma Tarihi	invoice.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	invoice.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Müşteri Kimliği	invoice.primary_recipient.customer_id	string	Siparişle ilişkili müşterinin kimliği.
İsim	invoice.primary_recipient.given_name	string	Alıcının adı (yani, adı) verilmiştir.
Aile Adı	invoice.primary_recipient.family_name	string	Alıcının ailesinin (soyadı) adı.
E-posta Adresi	invoice.primary_recipient.email_address	string	Alıcının e-posta adresi.
Telefon Numarası	invoice.primary_recipient.phone_number	string	Alıcının telefon numarası.
Card	invoice.accepted_payment_methods.card	boolean	Kredi kartı veya banka kartı ödemelerinin kabul edilip edilmediğini gösterir.
Kare Hediye Kartı	invoice.accepted_payment_methods.square_gift_card	boolean	Kare hediye kartı ödemelerinin kabul edilip edilmediğini gösterir.
Banka hesabı	invoice.accepted_payment_methods.bank_account	boolean	Banka havalesi ödemelerinin kabul edilip edilmediğini gösterir.
Özel Alanlar	invoice.custom_fields	array of object
Etiket	invoice.custom_fields.label	string	Özel alanın etiketi veya başlığı.
Değer	invoice.custom_fields.value	string	Özel alanın metni.
Yerleştirme	invoice.custom_fields.placement	string	Faturadaki özel alanın konumu.
Teslim Yöntemi	invoice.delivery_method	string	Square'in faturayı, anımsatıcıları ve makbuzları müşteriye göndermek için kullandığı teslimat yöntemi. Fatura yayımlandıktan sonra Square, faturayı hemen veya belirtildiyse scheduled_at tarihte teslim yöntemine ve ödeme isteği ayarlarına göre işler.
Satış veya Servis Tarihi	invoice.sale_or_service_date	string	Satış tarihi veya hizmetin işlendiği tarih, YYYY-MM-DD biçimindedir. Bu alan, faturada görüntülenen geçmiş veya gelecekteki bir tarihi belirtmek için kullanılabilir.

Faturayı silme

İşlem Kimliği:

InvoiceDelete

Belirtilen faturayı siler. Fatura silindiğinde, ilişkili sipariş durumu İPTAL EDİlDİ olarak değişir. Yalnızca taslak faturayı silebilirsiniz (işlenmek üzere zamanlanmış fatura da dahil olmak üzere yayımlanmış bir faturayı silemezsiniz).

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Fatura kimliği	invoice_id	True	string	Faturanın tanımlayıcısı.
Sürüm	version		integer	Silinecek faturanın sürümü.

Döndürülenler

response

object

Faturayı yayımlama

İşlem Kimliği:

InvoicePublish

Belirtilen taslak faturayı yayımlar. Bir fatura yayımlandıktan sonra Square, fatura yapılandırmasına göre bunu izler. Örneğin, Square faturayı müşterinin e-posta adresine gönderir, müşterinin kartından dosyada ücret alır veya hiçbir şey yapmaz. Square, faturayı Kare şeklinde barındırılan bir fatura sayfasında da kullanılabilir hale getirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Fatura kimliği	invoice_id	True	string	Faturanın tanımlayıcısı.
Sürüm	version		integer	Sürüm.
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	invoice.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Sürüm	invoice.version	integer	Bu nesnenin geçerli sürümü.
Konum Kimliği	invoice.location_id	string	Konumun tanımlayıcısı.
Sipariş Kimliği	invoice.order_id	string	Siparişin kimliği.
Ödeme İstekleri	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Kare tarafından oluşturulan kimlik.
İstek Türü	invoice.payment_requests.request_type	string	Ödeme isteği türünü tanımlar. Bu tür, ödeme isteği tutarının nasıl belirlendiğini tanımlar.
Son Tarih	invoice.payment_requests.due_date	string	Ödeme isteğinin son tarihi, YYYY-MM-DD biçimindedir.
Ekran Alıntısı Etkin	invoice.payment_requests.tipping_enabled	boolean	True olarak ayarlanırsa, müşterinin bir ipucu ödemesi için bir yer sağlar.
Hatırlatmalar	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Kare olarak atanan kimlik.
Göreli Zamanlanmış Günler	invoice.payment_requests.reminders.relative_scheduled_days	integer	Anımsatıcı gönderildiğinde ödeme isteğinin due_date önceki (negatif bir sayı) veya sonraki gün sayısı (pozitif bir sayı).
Message	invoice.payment_requests.reminders.message	string	İleti.
Statü	invoice.payment_requests.reminders.status	string	Geçerli durum.
Miktar	invoice.payment_requests.computed_amount_money.amount	integer	Miktar.
Para birimi	invoice.payment_requests.computed_amount_money.currency	string	Para birimi.
Miktar	invoice.payment_requests.total_completed_amount_money.amount	integer	Miktar.
Para birimi	invoice.payment_requests.total_completed_amount_money.currency	string	Para birimi.
Otomatik Ödeme Kaynağı	invoice.payment_requests.automatic_payment_source	string	Otomatik ödeme için ödeme yöntemi.
Fatura Numarası	invoice.invoice_number	string	Kullanıcı dostu bir fatura numarası. Değer bir konum içinde benzersizdir. Fatura oluşturulurken sağlanmazsa Square bir değer atar.
Başlık	invoice.title	string	Başlık.
Description	invoice.description	string	Açıklama.
Zamanlanan Tarih	invoice.scheduled_at	string	İşlemenin zamanlandığı zaman damgası RFC 3339 biçimindedir.
Statü	invoice.status	string	Bu nesnenin geçerli doğrulama durumu.
Timezone	invoice.timezone	string	Takvim tarihlerini yorumlamak için kullanılan saat dilimi. Fatura oluşturulduğunda, bu alan satıcı konumu için belirtilen saat dilimine ayarlanır. Değer değiştirilemez.
Oluşturma Tarihi	invoice.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	invoice.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Müşteri Kimliği	invoice.primary_recipient.customer_id	string	Siparişle ilişkili müşterinin kimliği.
İsim	invoice.primary_recipient.given_name	string	Alıcının adı (yani, adı) verilmiştir.
Aile Adı	invoice.primary_recipient.family_name	string	Alıcının ailesinin (soyadı) adı.
E-posta Adresi	invoice.primary_recipient.email_address	string	Alıcının e-posta adresi.
Telefon Numarası	invoice.primary_recipient.phone_number	string	Alıcının telefon numarası.
Genel URL	invoice.public_url	string	Barındırılan kare fatura sayfasının URL'si. PublishInvoice uç noktasını kullanarak faturayı yayımladıktan sonra, Square fatura sayfasını barındırıp yanıttaki sayfa URL'sini döndürür.
Card	invoice.accepted_payment_methods.card	boolean	Kredi kartı veya banka kartı ödemelerinin kabul edilip edilmediğini gösterir.
Kare Hediye Kartı	invoice.accepted_payment_methods.square_gift_card	boolean	Kare hediye kartı ödemelerinin kabul edilip edilmediğini gösterir.
Banka hesabı	invoice.accepted_payment_methods.bank_account	boolean	Banka havalesi ödemelerinin kabul edilip edilmediğini gösterir.
Özel Alanlar	invoice.custom_fields	array of object
Etiket	invoice.custom_fields.label	string	Özel alanın etiketi veya başlığı.
Değer	invoice.custom_fields.value	string	Özel alanın metni.
Yerleştirme	invoice.custom_fields.placement	string	Faturadaki özel alanın konumu.
Teslim Yöntemi	invoice.delivery_method	string	Square'in faturayı, anımsatıcıları ve makbuzları müşteriye göndermek için kullandığı teslimat yöntemi. Fatura yayımlandıktan sonra Square, faturayı hemen veya belirtildiyse scheduled_at tarihte teslim yöntemine ve ödeme isteği ayarlarına göre işler.
Satış veya Servis Tarihi	invoice.sale_or_service_date	string	Satış tarihi veya hizmetin işlendiği tarih, YYYY-MM-DD biçimindedir. Bu alan, faturada görüntülenen geçmiş veya gelecekteki bir tarihi belirtmek için kullanılabilir.

Grubu müşteriden kaldırma

İşlem Kimliği:

CustomerRemoveGroup

Müşteriden grup üyeliğini kaldırır. Müşteri customer_id değeriyle, müşteri grubu ise group_id değeriyle tanımlanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Müşteri Kimliği	customer_id	True	string	Müşterinin tanımlayıcısı.
Grup Kimliği	group_id	True	string	Grubun tanımlayıcısı.

Döndürülenler

response

object

Güncelleştirme sırası (Beta)

İşlem Kimliği:

OrderUpdate

Alanları ekleyerek, değiştirerek veya silerek açık bir siparişi güncelleştirir. TAMAMLANMIŞ veya İptal EDİlMİş durumdaki siparişler güncelleştirilemez.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sipariş Kimliği	order_id	True	string	Siparişin tanımlayıcısı.
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Sürüm	version		integer	Bu nesnenin geçerli sürümü.
UID	uid		string	Kare tarafından oluşturulan kimlik.
Miktar	quantity		string	Fiziksel sayının ondalık dize olarak etkilediği öğe sayısı. Sayı, ondalık ayırıcıdan sonra en çok 5 basamağı destekleyebilir.
İsim	name		string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.
Temizlenecek Alanlar	fields_to_clear		array of string

Döndürülenler

Name	Yol	Tür	Description
Sürüm	order.version	integer	Bu nesnenin geçerli sürümü.
Para birimi	order.total_money.currency	string	Para birimi.
Miktar	order.total_money.amount	integer	Miktar.
İsim	order.source.name	string	Adı.
Satır Öğeleri	order.line_items	array of object
Para birimi	order.line_items.total_tax_money.currency	string	Para birimi.
Miktar	order.line_items.total_tax_money.amount	integer	Miktar.
Miktar	order.line_items.total_money.amount	integer	Miktar.
Para birimi	order.line_items.total_money.currency	string	Para birimi.
Miktar	order.line_items.gross_sales_money.amount	integer	Miktar.
Para birimi	order.line_items.gross_sales_money.currency	string	Para birimi.
Miktar	order.line_items.base_price_money.amount	integer	Miktar.
Para birimi	order.line_items.base_price_money.currency	string	Para birimi.
Miktar	order.line_items.quantity	string	Fiziksel sayının ondalık dize olarak etkilediği öğe sayısı. Sayı, ondalık ayırıcıdan sonra en çok 5 basamağı destekleyebilir.
Para birimi	order.line_items.total_discount_money.currency	string	Para birimi.
Miktar	order.line_items.total_discount_money.amount	integer	Miktar.
İsim	order.line_items.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
UID	order.line_items.uid	string	Kare tarafından oluşturulan kimlik.
Miktar	order.line_items.variation_total_price_money.amount	integer	Miktar.
Para birimi	order.line_items.variation_total_price_money.currency	string	Para birimi.
Devlet	order.state	string	Geçerli durum.
Miktar	order.total_service_charge_money.amount	integer	Miktar.
Para birimi	order.total_service_charge_money.currency	string	Para birimi.
Kimlik	order.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	order.location_id	string	Konumun tanımlayıcısı.
Miktar	order.total_tax_money.amount	integer	Miktar.
Para birimi	order.total_tax_money.currency	string	Para birimi.
Oluşturma Tarihi	order.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Miktar	order.total_discount_money.amount	integer	Miktar.
Para birimi	order.total_discount_money.currency	string	Para birimi.
Para birimi	order.net_amounts.service_charge_money.currency	string	Para birimi.
Miktar	order.net_amounts.service_charge_money.amount	integer	Miktar.
Miktar	order.net_amounts.total_money.amount	integer	Miktar.
Para birimi	order.net_amounts.total_money.currency	string	Para birimi.
Para birimi	order.net_amounts.discount_money.currency	string	Para birimi.
Miktar	order.net_amounts.discount_money.amount	integer	Miktar.
Para birimi	order.net_amounts.tax_money.currency	string	Para birimi.
Miktar	order.net_amounts.tax_money.amount	integer	Miktar.
Güncelleştirme Tarihi:	order.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

İhtilaf kanıtlarını alma

İşlem Kimliği:

DisputeRetrieveEvidence

İstek URL yolundaki kanıt kimliği tarafından belirtilen kanıt meta verilerini döndürür. Daha sonra başvurmak istiyorsanız karşıya yüklediğiniz kanıtın bir kopyasını tutmanız gerekir. Karşıya yükledikten sonra kanıtı indiremezsiniz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Uyuşmazlık Kimliği	dispute_id	True	string	İtirazın tanımlayıcısı.
Kanıt Kimliği	evidence_id	True	string	Kanıtın tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	evidence.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Uyuşmazlık Kimliği	evidence.dispute_id	string	Kanıtın ilişkili olduğu uyuşmazlığın kimliği.
Filename	evidence.evidence_file.filename	string	Anlaşmazlık kanıt dosyaları uygulama/pdf, görüntü/heic, image/heif, image/jpeg, image/png veya image/tiff biçimleri olmalıdır.
Dosya Türü	evidence.evidence_file.filetype	string	Dosya uzantısını içeren dosya adı.
Kanıt Türü	evidence.evidence_type	string	Tür pf kanıtı.
Karşıya Yükleme:	evidence.uploaded_at	string	Rfc 3339 biçiminde bir sonraki eylemin son tarihi.

İhtilaf kanıtlarını silme

İşlem Kimliği:

DisputeDeleteEvidence

Belirtilen kanıtı bir anlaşmazlıktan kaldırır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Uyuşmazlık Kimliği	dispute_id	True	string	İtirazın tanımlayıcısı.
Kanıt Kimliği	evidence_id	True	string	Kanıtın tanımlayıcısı.

Döndürülenler

response

object

İhtilafı alma

İşlem Kimliği:

DisputeRetrieve

Belirli bir anlaşmazlıkla ilgili ayrıntıları döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Uyuşmazlık Kimliği	dispute_id	True	string	İtirazın tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	dispute.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Miktar	dispute.amount_money.amount	integer	Miktar.
Para birimi	dispute.amount_money.currency	string	Para birimi.
Reason	dispute.reason	string	Bu nesnenin nedeni.
Devlet	dispute.state	string	Geçerli durum.
Son Tarih	dispute.due_at	string	Rfc 3339 biçiminde bir sonraki eylemin son tarihi.
Tartışmalı Ödemeler	dispute.disputed_payments	array of object
Ödeme Kimliği	dispute.disputed_payments.payment_id	string	Ödemenin kare olarak oluşturulan benzersiz kimliği.
Kart Markası	dispute.card_brand	string	Kartın markası.
Oluşturma Tarihi	dispute.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	dispute.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Marka Uyuşmazlığı Kimliği	dispute.brand_dispute_id	string	Kart markası tarafından oluşturulan kart markası sistemindeki uyuşmazlığın kimliği.

Kanıt gönderme

İşlem Kimliği:

EvidenceSubmit

Kart sahibinin bankasına kanıt gönderir. Kanıt göndermeden önce Square tüm kullanılabilir kanıtları derler. Bu, CreateDisputeEvidenceFile ve CreateDisputeEvidenceText uç noktaları kullanılarak karşıya yüklenen kanıtları ve kullanılabilir olduğunda Square tarafından otomatik olarak sağlanan kanıtı içerir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Uyuşmazlık Kimliği	dispute_id	True	string	İtirazın tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	dispute.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Miktar	dispute.amount_money.amount	integer	Miktar.
Para birimi	dispute.amount_money.currency	string	Para birimi.
Reason	dispute.reason	string	Bu nesnenin nedeni.
Devlet	dispute.state	string	Geçerli durum.
Son Tarih	dispute.due_at	string	Rfc 3339 biçiminde bir sonraki eylemin son tarihi.
Tartışmalı Ödemeler	dispute.disputed_payments	array of object
Ödeme Kimliği	dispute.disputed_payments.payment_id	string	Ödemenin kare olarak oluşturulan benzersiz kimliği.
Kart Markası	dispute.card_brand	string	Kartın markası.
Oluşturma Tarihi	dispute.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	dispute.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Marka Uyuşmazlığı Kimliği	dispute.brand_dispute_id	string	Kart markası tarafından oluşturulan kart markası sistemindeki uyuşmazlığın kimliği.

Kart oluşturma

İşlem Kimliği:

CardCreate

Mevcut bir satıcıya dosyaya kart ekler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Idempotency Anahtarı	idempotency_key		string	Idempotency anahtarı.
Kaynak Kimliği	source_id		string	Kaynağın tanımlayıcısı.
Adres Satırı 1	address_line_1		string	Adresin ilk satırı. address_line ile başlayan alanlar, adresin sokak numarası, sokak adı ve bina adı gibi en özel ayrıntılarını sağlar.
Adres Satırı 2	address_line_2		string	Varsa, adresin ikinci satırı.
Yer	locality		string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	administrative_district_level_1		string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	postal_code		string	Adresin posta kodu.
Country	country		string	Adresin ülkesi, ISO 3166-1-alfa-2 biçimindedir.
Kart Sahibi Adı	cardholder_name		string	Kart sahibinin adı.
Müşteri Kimliği	customer_id		string	Müşteriyi temsil eden bu nesnenin kimliği.
Başvuru Kimliği	reference_id		string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	card.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Adres Satırı 1	card.billing_address.address_line_1	string	Adresin ilk satırı. address_line ile başlayan alanlar, adresin sokak numarası, sokak adı ve bina adı gibi en özel ayrıntılarını sağlar.
Adres Satırı 2	card.billing_address.address_line_2	string	Varsa, adresin ikinci satırı.
Yer	card.billing_address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	card.billing_address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	card.billing_address.postal_code	string	Adresin posta kodu.
Country	card.billing_address.country	string	Adresin ülkesi, ISO 3166-1-alfa-2 biçimindedir.
Parmak izi	card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
BIN	card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı.
Kart Markası	card.card_brand	string	Kartın markası.
Kart Türü	card.card_type	string	Kartın türü.
Kart Sahibi Adı	card.cardholder_name	string	Kart sahibinin adı.
Müşteri Kimliği	card.customer_id	string	Müşteriyi temsil eden bu nesnenin kimliği.
Etkinleştirildi	card.enabled	boolean	Etkin olup olmadığı.
Exp Ay	card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Exp Yılı	card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Son 4	card.last_4	string	Kart numarasının son 4 basamağı.
Ön Ödemeli Tür	card.prepaid_type	string	Kartın ön ödemeli olup olmadığını gösterir.
Başvuru Kimliği	card.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Sürüm	card.version	integer	Bu nesnenin geçerli sürümü.

Kartı alma

İşlem Kimliği:

CardRetrieve

Belirli bir Kartın ayrıntılarını alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kart Kimliği	card_id	True	string	Kartın tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	card.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Adres Satırı 1	card.billing_address.address_line_1	string	Adresin ilk satırı. address_line ile başlayan alanlar, adresin sokak numarası, sokak adı ve bina adı gibi en özel ayrıntılarını sağlar.
Adres Satırı 2	card.billing_address.address_line_2	string	Varsa, adresin ikinci satırı.
Yer	card.billing_address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	card.billing_address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	card.billing_address.postal_code	string	Adresin posta kodu.
Country	card.billing_address.country	string	Adresin ülkesi, ISO 3166-1-alfa-2 biçimindedir.
Parmak izi	card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
BIN	card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı.
Kart Markası	card.card_brand	string	Kartın markası.
Kart Türü	card.card_type	string	Kartın türü.
Kart Sahibi Adı	card.cardholder_name	string	Kart sahibinin adı.
Müşteri Kimliği	card.customer_id	string	Müşteriyi temsil eden bu nesnenin kimliği.
Etkinleştirildi	card.enabled	boolean	Etkin olup olmadığı.
Exp Ay	card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Exp Yılı	card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Son 4	card.last_4	string	Kart numarasının son 4 basamağı.
Ön Ödemeli Tür	card.prepaid_type	string	Kartın ön ödemeli olup olmadığını gösterir.
Başvuru Kimliği	card.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Sürüm	card.version	integer	Bu nesnenin geçerli sürümü.

Kartı devre dışı bırakma

İşlem Kimliği:

CardDisable

Kartı devre dışı bırakır ve daha fazla güncelleştirme veya ücret alınmasını önler. Zaten devre dışı bırakılmış bir kartın devre dışı bırakılmasına izin verilir, ancak hiçbir etkisi yoktur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kart Kimliği	card_id	True	string	Kartın tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	card.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Adres Satırı 1	card.billing_address.address_line_1	string	Adresin ilk satırı. address_line ile başlayan alanlar, adresin sokak numarası, sokak adı ve bina adı gibi en özel ayrıntılarını sağlar.
Adres Satırı 2	card.billing_address.address_line_2	string	Varsa, adresin ikinci satırı.
Yer	card.billing_address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	card.billing_address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	card.billing_address.postal_code	string	Adresin posta kodu.
Country	card.billing_address.country	string	Adresin ülkesi, ISO 3166-1-alfa-2 biçimindedir.
Parmak izi	card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
BIN	card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı.
Kart Markası	card.card_brand	string	Kartın markası.
Kart Türü	card.card_type	string	Kartın türü.
Kart Sahibi Adı	card.cardholder_name	string	Kart sahibinin adı.
Müşteri Kimliği	card.customer_id	string	Müşteriyi temsil eden bu nesnenin kimliği.
Etkinleştirildi	card.enabled	boolean	Etkin olup olmadığı.
Exp Ay	card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Exp Yılı	card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Son 4	card.last_4	string	Kart numarasının son 4 basamağı.
Ön Ödemeli Tür	card.prepaid_type	string	Kartın ön ödemeli olup olmadığını gösterir.
Başvuru Kimliği	card.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Sürüm	card.version	integer	Bu nesnenin geçerli sürümü.

Katalog bilgileri

İşlem Kimliği:

CatalogInfo

BatchUpsertCatalogObjects uç noktası tarafından kullanılabilecek toplu iş boyutu sınırları gibi Kare Katalog API'sine ilişkin bilgileri alır.

Döndürülenler

Name	Yol	Tür	Description
Toplu İş Başına En Fazla Nesne Ekleme	limits.batch_upsert_max_objects_per_batch	integer	/v2/catalog/batch-upsert isteğinde tek bir toplu işlem içinde görünebilecek en fazla nesne sayısı.
Batch Upsert Maksimum Toplam Nesne Sayısı	limits.batch_upsert_max_total_objects	integer	/v2/catalog/batch-upsert isteğinde tüm toplu işlemlerde görünebilecek en fazla nesne sayısı.
Batch En Fazla Nesne Kimliklerini Alma	limits.batch_retrieve_max_object_ids	integer	/v2/catalog/batch-retrieve isteğinde görünebilecek en fazla nesne kimliği sayısı.
En Fazla Sayfa Sınırını Ara	limits.search_max_page_limit	integer	/v2/catalog/search yanıtının bir sayfasında döndürülebilecek en fazla sonuç sayısı.
En Fazla Nesne Kimliklerini Toplu Silme	limits.batch_delete_max_object_ids	integer	Tek bir /v2/catalog/batch-delete isteğine dahil edilebilecek en fazla nesne kimliği sayısı.
Madde Vergileri En Fazla Öğe Kimliklerini Güncelleştir	limits.update_item_taxes_max_item_ids	integer	Tek bir /v2/catalog/update-item-taxes isteğine dahil edilebilecek en fazla öğe kimliği sayısı.
Etkinleştirecek Öğe Vergileri Maksimum Vergilerini Güncelleştir	limits.update_item_taxes_max_taxes_to_enable	integer	Etkinleştirilecek ve tek bir /v2/catalog/update-item-tax isteğine dahil edilebilecek maksimum vergi kimlikleri sayısı.
Devre Dışı Bırakmak için Öğe Vergileri Maksimum Vergilerini Güncelleştir	limits.update_item_taxes_max_taxes_to_disable	integer	Tek bir /v2/catalog/update-item-tax isteğine dahil edilebilecek, devre dışı bırakılacak en fazla vergi kimliği sayısı.
Öğe Değiştirici Listelerini En Fazla Öğe Kimliklerini Güncelleştir	limits.update_item_modifier_lists_max_item_ids	integer	Tek bir /v2/catalog/update-item-tax isteğine dahil edilebilecek, devre dışı bırakılacak en fazla vergi kimliği sayısı.
Etkinleştirecek Öğe Değiştirici Listelerini En Fazla Değiştirici Liste Güncelleştir	limits.update_item_modifier_lists_max_modifier_lists_to_enable	integer	Etkinleştirilecek ve tek bir /v2/catalog/update-item-modifier-lists isteğine dahil edilebilecek en fazla değiştirici liste kimliği sayısı.
Devre Dışı Bırakmak için Öğe Değiştirici Listelerini En Fazla Değiştirici Liste Güncelleştir	limits.update_item_modifier_lists_max_modifier_lists_to_disable	integer	Tek bir /v2/catalog/update-item-modifier-lists isteğine dahil edilebilecek devre dışı bırakılacak en fazla değiştirici liste kimliği sayısı.

Katalog nesnelerini arama

İşlem Kimliği:

CatalogSearch

Öğelerdeki veya öğe çeşitlemelerindeki özel öznitelik değerleri hariç, desteklenen arama özniteliği değerlerini belirtilen bir veya daha fazla sorgu filtresiyle eşleştirerek herhangi bir türde CatalogObject arar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Nesne Türleri	object_types		array of string
Öznitelik Adı	attribute_name		string	Aranacak özniteliğin adı.
Öznitelik Ön Eki	attribute_prefix		string	Arama özniteliği değerinin istenen ön eki.
Sınır	limit		integer	Tek bir sayfada döndürülecek sonuç sayısıyla ilgili bir sınır. Sınır danışmanlıktır; uygulama daha fazla veya daha az sonuç döndürebilir. Sağlanan sınır negatif, sıfır veya en yüksek sınır olan 1.000'den yüksekse, yoksayılır.

Döndürülenler

Name	Yol	Tür	Description
Objects	objects	array of object
Türü	objects.type	string	Bu nesnenin türü.
Kimlik	objects.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Güncelleştirme Tarihi:	objects.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Sürüm	objects.version	integer	Nesnenin geçerli sürümü.
Silindi	objects.is_deleted	boolean	True ise, nesne veritabanından silinmiştir. Eklenen yeni nesneler için false olmalıdır. Silindiğinde, updated_at alanı silme süresine eşit olur.
Tüm Konumlarda Mevcut	objects.present_at_all_locations	boolean	True ise, bu nesne absent_at_location_ids alanında belirtilen yerler dışında tüm konumlarda (gelecekteki konumlar dahil) bulunur. False ise, bu nesne present_at_location_ids alanında belirtilen yerler dışında hiçbir konumda (gelecekteki konumlar dahil) mevcut değildir. Belirtilmezse, varsayılan değer true olur.
İsim	objects.item_data.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Description	objects.item_data.title	string	Öğenin açıklaması. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir ve değer uzunluğu Unicode kod noktalarıdır.
Kategori Kimliği	objects.item_data.category_id	string	Varsa, öğenin kategorisinin kimliği.
Ürün Türü	objects.item_data.product_type	string	Belirtilen ürün türlerine sahip öğeleri veya öğe çeşitlemelerini döndürmek için ürün türleri sorgu ifadesi.
Vergi kimlikleri	objects.item_data.tax_ids	array of string
Varyasyon -ları	objects.item_data.variations	array of object
Türü	objects.item_data.variations.type	string	Bu nesnenin türü. Her nesne türü, aşağıdaki ilgili *_data alanı içinde yapılandırılmış biçimde ifade edilen beklenen özelliklere sahiptir.
Kimlik	objects.item_data.variations.id	string	Bu nesneye başvurmak için bir tanımlayıcı.
Güncelleştirme Tarihi:	objects.item_data.variations.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Sürüm	objects.item_data.variations.version	integer	Nesnenin sürümü. Bir nesneyi güncelleştirirken, sağlanan sürüm veritabanındaki sürümle eşleşmelidir, aksi takdirde yazma işlemi çakışan olarak reddedilir.
Silindi	objects.item_data.variations.is_deleted	boolean	True ise, nesne veritabanından silinmiştir. Eklenen yeni nesneler için false olmalıdır. Silindiğinde, updated_at alanı silme süresine eşit olur.
Tüm Konumlarda Mevcut	objects.item_data.variations.present_at_all_locations	boolean	present_at_all_locations false olsa bile nesnenin bulunduğu konumların listesi. Bu, devre dışı bırakılan konumları içerebilir.
Öğe Kimliği	objects.item_data.variations.item_variation_data.item_id	string	Bu öğe varyasyonu olan nesnenin kimliği.
İsim	objects.item_data.variations.item_variation_data.name	string	Bu öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir ve değer uzunluğu Unicode kod noktalarıdır.
Sıralı	objects.item_data.variations.item_variation_data.ordinal	integer	Bu öğe varyasyonunun görüntülenme sırası. Bu değer salt okunurdur.
Miktar	objects.item_data.variations.item_variation_data.price_money.amount	integer	Para birimiyle belirtilen para biriminin en küçük paydasında yer alan para miktarı. Örneğin, para birimi ABD doları olduğunda tutar cent cinsindendir. Parasal tutarlar pozitif veya negatif olabilir. Belirli bir durumdaki işaretin anlamını belirlemek için belirli alan açıklamasına bakın.
Para birimi	objects.item_data.variations.item_variation_data.price_money.currency	string	ISO 4217 biçimindeki para biriminin türü. Örneğin, ABD doları için para birimi kodu ABD dolarıdır.
Fiyatlandırma Türü	objects.item_data.variations.item_variation_data.pricing_type	string	Madde varyasyonunun fiyatının sabit olup olmadığını veya satış sırasında belirlenip belirlenmediğini gösterir.
Görünürlük	objects.item_data.visibility	string	Görünürlük.

Katalog nesnelerini toplu silme

İşlem Kimliği:

CatalogBatchDelete

Sağlanan hedef kimlik listesine göre bir CatalogItems kümesini siler ve yanıtta başarıyla silinen bir kimlik kümesi döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Nesne Kimlikleri	object_ids		array of string

Döndürülenler

Name	Yol	Tür	Description
Silinen Nesne Kimlikleri	deleted_object_ids	array of string
Silindiği Yer	deleted_at	string	Bu silme işleminin RFC 3339 biçimindeki veritabanı zaman damgası

Katalog nesnesini alma

İşlem Kimliği:

CatalogRetrieve

Sağlanan kimliği temel alarak tek bir CatalogItem'i CatalogObject olarak döndürür. Döndürülen nesne, catalogItemVariation alt öğeleri, CatalogModifierList nesnelerine başvurular ve buna uygulanan tüm CatalogTax nesnelerinin kimlikleri dahil olmak üzere tüm ilgili CatalogItem bilgilerini içerir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Nesne kimliği	object_id	True	string	Nesnenin tanımlayıcısı.
İlgili Nesneleri Ekle	include_related_objects		boolean	True ise, yanıt aşağıdaki gibi istenen nesneyle ilgili ek nesneler içerir: Yanıtın nesne alanı bir CatalogItem içeriyorsa, yanıtın related_objects alanında ilişkili CatalogCategory, CatalogTax, CatalogImage ve CatalogModifierList nesneleri döndürülür. Yanıtın nesne alanı bir CatalogItemVariation içeriyorsa, üst CatalogItem yanıtın related_objects alanında döndürülür.

Döndürülenler

Name	Yol	Tür	Description
Türü	object.type	string	Bu nesnenin türü.
Kimlik	object.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Güncelleştirme Tarihi:	object.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Sürüm	object.version	integer	Bu nesnenin geçerli sürümü.
Silindi	object.is_deleted	boolean	True ise, nesne veritabanından silinmiştir. Eklenen yeni nesneler için false olmalıdır. Silindiğinde, updated_at alanı silme süresine eşit olur.
present_at_all_locations	object.present_at_all_locations	boolean	True ise, bu nesne absent_at_location_ids alanında belirtilen yerler dışında tüm konumlarda (gelecekteki konumlar dahil) bulunur. False ise, bu nesne present_at_location_ids alanında belirtilen yerler dışında hiçbir konumda (gelecekteki konumlar dahil) mevcut değildir. Belirtilmezse, varsayılan değer true olur.
İsim	object.item_data.name	string	Adı.
Description	object.item_data.title	string	Öğenin açıklaması. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir ve değer uzunluğu Unicode kod noktalarıdır.
Kategori Kimliği	object.item_data.category_id	string	Varsa, öğenin kategorisinin kimliği.
Vergi kimlikleri	object.item_data.tax_ids	array of string
Varyasyon -ları	object.item_data.variations	array of object
Türü	object.item_data.variations.type	string	Bu nesnenin türü.
Kimlik	object.item_data.variations.id	string	Katalogda bu nesneye başvurmak için bir tanımlayıcı.
Güncelleştirme Tarihi:	object.item_data.variations.updated_at	string	RFC 3339 biçimindeki son değişiklik zaman damgası.
Sürüm	object.item_data.variations.version	integer	Nesnenin sürümü. Bir nesneyi güncelleştirirken, sağlanan sürüm veritabanındaki sürümle eşleşmelidir, aksi takdirde yazma işlemi çakışan olarak reddedilir.
Silindi	object.item_data.variations.is_deleted	boolean	True ise, nesne veritabanından silinmiştir. Eklenen yeni nesneler için false olmalıdır. Silindiğinde, updated_at alanı silme süresine eşit olur.
Tüm Konumlarda Mevcut	object.item_data.variations.present_at_all_locations	boolean	True ise, bu nesne absent_at_location_ids alanında belirtilen yerler dışında tüm konumlarda (gelecekteki konumlar dahil) bulunur. False ise, bu nesne present_at_location_ids alanında belirtilen yerler dışında hiçbir konumda (gelecekteki konumlar dahil) mevcut değildir. Belirtilmezse, varsayılan değer true olur.
Öğe Kimliği	object.item_data.variations.item_variation_data.item_id	string	Bu öğe varyasyonuyla ilişkili CatalogItem kimliği.
İsim	object.item_data.variations.item_variation_data.name	string	Öğe varyasyonunun adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir ve değer uzunluğu Unicode kod noktalarıdır.
Sıralı	object.item_data.variations.item_variation_data.ordinal	integer	Bu öğe varyasyonunun görüntülenme sırası. Bu değer salt okunurdur. Yazma işlemlerinde, bir üst CatalogItem içindeki her öğe varyasyonu için sıra, öğe varyasyonlarının konumuna göre ayarlanır. Okumalarda, değerin sıralı veya benzersiz olması garanti edilmemektedir.
Fiyatlandırma Türü	object.item_data.variations.item_variation_data.pricing_type	string	Madde varyasyonunun fiyatının sabit olup olmadığını veya satış sırasında belirlenip belirlenmediğini gösterir.
Miktar	object.item_data.variations.item_variation_data.price_money.amount	integer	Miktar.
Para birimi	object.item_data.variations.item_variation_data.price_money.currency	string	Para birimi.

Katalog nesnesini silme

İşlem Kimliği:

CatalogDelete

Sağlanan kimliğe göre tek bir CatalogObject'i siler ve yanıtta başarıyla silinen kimlik kümesini döndürür. Silme, hedeflenen nesnenin tüm alt öğelerinin de silinmesini sağlayan basamaklı bir olaydır. Örneğin, bir CatalogItem silindiğinde tüm CatalogItemVariation alt öğeleri de silinir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Nesne kimliği	object_id	True	string	Nesnenin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Silinen Nesne Kimlikleri	deleted_object_ids	array of string
Silindiği Yer	deleted_at	string	Bu silme işleminin RFC 3339 biçimindeki veritabanı zaman damgası

Kopyalama sırası (Beta)

İşlem Kimliği:

OrderClone

Mevcut bir siparişi çoğaltarak TASLAK durumunda yeni bir sipariş oluşturur. Yeni oluşturulan siparişte yalnızca özgün siparişten kopyalanan çekirdek alanlar (satır öğeleri, vergiler ve indirimler gibi) bulunur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sipariş Kimliği	order_id		string	Sipariş tanımlayıcısı.
Sürüm	version		integer	Sürüm.
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	order.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	order.location_id	string	Konumun tanımlayıcısı.
Satır Öğeleri	order.line_items	array of object
UID	order.line_items.uid	string	Kare tarafından oluşturulan kimlik.
İsim	order.line_items.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Miktar	order.line_items.quantity	string	Fiziksel sayının ondalık dize olarak etkilediği öğe sayısı. Sayı, ondalık ayırıcıdan sonra en çok 5 basamağı destekleyebilir.
Uygulanan Vergiler	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	Kare olarak atanan kimlik.
Vergi UID	order.line_items.applied_taxes.tax_uid	string	Bu uygulanan verginin temsil ettiği verginin UID'sini.
Miktar	order.line_items.applied_taxes.applied_money.amount	integer	Miktar.
Para birimi	order.line_items.applied_taxes.applied_money.currency	string	Para birimi.
Uygulanan İndirimler	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Kare olarak atanan kimlik.
İndirim UID	order.line_items.applied_discounts.discount_uid	string	Uygulanan indirimin temsil ettiği indirimin kullanıcı arabirimi.
Miktar	order.line_items.applied_discounts.applied_money.amount	integer	Miktar.
Para birimi	order.line_items.applied_discounts.applied_money.currency	string	Para birimi.
Miktar	order.line_items.base_price_money.amount	integer	Miktar.
Para birimi	order.line_items.base_price_money.currency	string	Para birimi.
Miktar	order.line_items.gross_sales_money.amount	integer	Miktar.
Para birimi	order.line_items.gross_sales_money.currency	string	Para birimi.
Miktar	order.line_items.total_tax_money.amount	integer	Miktar.
Para birimi	order.line_items.total_tax_money.currency	string	Para birimi.
Miktar	order.line_items.total_discount_money.amount	integer	Miktar.
Para birimi	order.line_items.total_discount_money.currency	string	Para birimi.
Miktar	order.line_items.total_money.amount	integer	Miktar.
Para birimi	order.line_items.total_money.currency	string	Para birimi.
Miktar	order.line_items.variation_total_price_money.amount	integer	Miktar.
Para birimi	order.line_items.variation_total_price_money.currency	string	Para birimi.
Katalog Nesne Kimliği	order.line_items.catalog_object_id	string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
Çeşitleme Adı	order.line_items.variation_name	string	Bu satır öğesine uygulanan varyasyonun adı.
Değiştirici	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	Kare olarak atanan kimlik.
Katalog Nesne Kimliği	order.line_items.modifiers.catalog_object_id	string	Katalog nesne kimliği.
İsim	order.line_items.modifiers.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Miktar	order.line_items.modifiers.base_price_money.amount	integer	Miktar.
Para birimi	order.line_items.modifiers.base_price_money.currency	string	Para birimi.
Miktar	order.line_items.modifiers.total_price_money.amount	integer	Miktar.
Para birimi	order.line_items.modifiers.total_price_money.currency	string	Para birimi.
Vergiler	order.taxes	array of object
UID	order.taxes.uid	string	Kare tarafından oluşturulan kimlik.
İsim	order.taxes.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Türü	order.taxes.type	string	Türünü gösterir.
Yüzde	order.taxes.percentage	string	Ondalık ayırıcı olarak '.' kullanan ve '%' işareti olmayan ondalık biçimindeki yüzde. 7,5 değeri,%7,5'e karşılık gelir.
Miktar	order.taxes.applied_money.amount	integer	Miktar.
Para birimi	order.taxes.applied_money.currency	string	Para birimi.
Scope	order.taxes.scope	string	Geçerli düzeyi gösterir.
İskontolar	order.discounts	array of object
UID	order.discounts.uid	string	Kare tarafından oluşturulan kimlik.
Katalog Nesne Kimliği	order.discounts.catalog_object_id	string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
İsim	order.discounts.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Türü	order.discounts.type	string	Türünü gösterir.
Yüzde	order.discounts.percentage	string	Ondalık ayırıcı olarak '.' kullanan ve '%' işareti olmayan ondalık biçimindeki yüzde. 7,5 değeri,%7,5'e karşılık gelir.
Miktar	order.discounts.applied_money.amount	integer	Miktar.
Para birimi	order.discounts.applied_money.currency	string	Para birimi.
Scope	order.discounts.scope	string	Geçerli düzeyi gösterir.
Miktar	order.discounts.amount_money.amount	integer	Miktar.
Para birimi	order.discounts.amount_money.currency	string	Para birimi.
Oluşturma Tarihi	order.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	order.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Devlet	order.state	string	Geçerli durum.
Sürüm	order.version	integer	Bu nesnenin geçerli sürümü.
Başvuru Kimliği	order.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Miktar	order.total_money.amount	integer	Miktar.
Para birimi	order.total_money.currency	string	Para birimi.
Miktar	order.total_tax_money.amount	integer	Miktar.
Para birimi	order.total_tax_money.currency	string	Para birimi.
Miktar	order.total_discount_money.amount	integer	Miktar.
Para birimi	order.total_discount_money.currency	string	Para birimi.
Miktar	order.total_tip_money.amount	integer	Miktar.
Para birimi	order.total_tip_money.currency	string	Para birimi.
Miktar	order.total_service_charge_money.amount	integer	Miktar.
Para birimi	order.total_service_charge_money.currency	string	Para birimi.
Miktar	order.net_amounts.total_money.amount	integer	Miktar.
Para birimi	order.net_amounts.total_money.currency	string	Para birimi.
Miktar	order.net_amounts.tax_money.amount	integer	Miktar.
Para birimi	order.net_amounts.tax_money.currency	string	Para birimi.
Miktar	order.net_amounts.discount_money.amount	integer	Miktar.
Para birimi	order.net_amounts.discount_money.currency	string	Para birimi.
Miktar	order.net_amounts.tip_money.amount	integer	Miktar.
Para birimi	order.net_amounts.tip_money.currency	string	Para birimi.
Miktar	order.net_amounts.service_charge_money.amount	integer	Miktar.
Para birimi	order.net_amounts.service_charge_money.currency	string	Para birimi.
İsim	order.source.name	string	Adı.

Liste kartları

İşlem Kimliği:

CardList

İstekte bulunan hesaba ait kartların listesini alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Cursor	cursor		string	Bu uç noktaya önceki bir çağrı tarafından döndürülen sayfalandırma imleci.
Müşteri Kimliği	customer_id		string	Sonuçları, sağlanan müşteriyle ilişkili kartlarla sınırlayın. Varsayılan olarak, satıcıya ait tüm kartlar iade edilir.
Devre Dışı Ekle	include_disabled		boolean	Devre dışı bırakılan kartları içerir. Varsayılan olarak, satıcının sahip olduğu tüm etkin kartlar döndürülür.
Başvuru Kimliği	reference_id		string	Sonuçları sağlanan reference_id ilişkili kartlarla sınırlayın.
Sıralama Düzeni	sort_order		string	Döndürülen listeyi, kartın belirtilen düzende oluşturulduğu zamanlara göre sıralar.

Döndürülenler

Name	Yol	Tür	Description
Cards	cards	array of object
Kimlik	cards.card.id	string	Nesnenin tanımlayıcısı
Adres Satırı 1	cards.card.billing_address.address_line_1	string	address_line ile başlayan alanlar, adresin sokak numarası, sokak adı ve bina adı gibi en özel ayrıntılarını sağlar.
Adres Satırı 2	cards.card.billing_address.address_line_2	string	Varsa, adresin ikinci satırı.
Yer	cards.card.billing_address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	cards.card.billing_address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	cards.card.billing_address.postal_code	string	Adresin posta kodu.
Country	cards.card.billing_address.country	string	Adresin ülkesi, ISO 3166-1-alfa-2 biçimindedir.
Parmak izi	cards.card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
BIN	cards.card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı.
Kart Markası	cards.card.card_brand	string	Kartın markası.
Kart Türü	cards.card.card_type	string	Kartın türü.
Kart Sahibi Adı	cards.card.cardholder_name	string	Kart sahibinin adı.
Müşteri Kimliği	cards.card.customer_id	string	Kartla ilişkilendirilecek müşterinin kimliği.
Etkinleştirildi	cards.card.enabled	boolean	Bir nesnenin kullanılıp kullanılamayacağını gösterir.
Sona Erme Ayı	cards.card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Sona Erme Yılı	cards.card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Son 4	cards.card.last_4	string	Kart numarasının son 4 basamağı.
Ön Ödemeli Tür	cards.card.prepaid_type	string	Kartın ön ödemeli olup olmadığını gösterir.
Başvuru Kimliği	cards.card.reference_id	string	Bu kartı bir dış sistemdeki başka bir varlıkla ilişkilendiren isteğe bağlı kullanıcı tanımlı başvuru kimliği.
Sürüm	cards.card.version	integer	Kartın geçerli sürüm numarası. Her kart güncelleştirmesi ile artımlar. İstekteki sürüm Kartın geçerli sürümüyle eşleşmediği sürece mevcut Bir Card nesnesini güncelleştirme istekleri reddedilir.

Liste kataloğu

İşlem Kimliği:

CatalogList

Katalogdaki istenen tür kümesindeki tüm nesneleri (örneğin, tüm CatalogItem ve CatalogTax nesneleri) içeren CatalogObjects listesini döndürür. ListCatalog silinen katalog öğelerini döndürmez.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Cursor	cursor		integer	Bu uç noktaya önceki bir çağrı tarafından döndürülen sayfalandırma imleci.
Türler	types		string	Alınacak nesne türlerinin isteğe bağlı büyük/küçük harfe duyarlı olmayan, virgülle ayrılmış listesi. Geçerli değerler ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST veya IMAGE gibi CatalogObjectType sabit listesinde tanımlanır. Bu belirtilmezse, işlem isteği yapmak için kullanılan Square API sürümündeki tüm türlerin nesnelerini döndürür.

Döndürülenler

Name	Yol	Tür	Description
Objects	objects	array of object
Türü	objects.type	string	Bu nesnenin türü.
Kimlik	objects.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Güncelleştirme Tarihi:	objects.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Sürüm	objects.version	integer	Nesnenin geçerli sürümü.
Silindi	objects.is_deleted	boolean	True ise, nesne veritabanından silinmiştir. Eklenen yeni nesneler için false olmalıdır. Silindiğinde, updated_at alanı silme süresine eşit olur.
Tüm Konumlarda Mevcut	objects.present_at_all_locations	boolean	True ise, bu nesne absent_at_location_ids alanında belirtilen yerler dışında tüm konumlarda (gelecekteki konumlar dahil) bulunur. False ise, bu nesne present_at_location_ids alanında belirtilen yerler dışında hiçbir konumda (gelecekteki konumlar dahil) mevcut değildir. Belirtilmezse, varsayılan değer true olur.
İsim	objects.category_data.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
İsim	objects.tax_data.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Hesaplama Aşaması	objects.tax_data.calculation_phase	string	Verginin bir ödemenin alt toplamına veya toplamına göre hesaplanıp hesaplanmadığı.
Ekleme Türü	objects.tax_data.inclusion_type	string	Verginin EKLENEBILIR mi yoksa KAPSAYıCı mı olduğu.
Yüzde	objects.tax_data.percentage	string	Ondalık ayırıcı olarak '.' kullanan ve '%' işareti olmayan ondalık biçimindeki yüzde. 7,5 değeri,%7,5'e karşılık gelir.
Etkinleştirildi	objects.tax_data.enabled	boolean	Bir nesnenin kullanılıp kullanılamayacağını gösterir.

Madde vergilerini güncelleştirme

İşlem Kimliği:

CatalogUpdateTaxes

Öğenin tamamında bir upsert gerçekleştirmek zorunda kalmadan hedeflenen CatalogItem'e uygulanan CatalogTax nesnelerini güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Öğe Kimlikleri	item_ids		array of string
Etkinleştirecek Vergiler	taxes_to_enable		array of string
Devre Dışı Bırakacak Vergiler	taxes_to_disable		array of string

Döndürülenler

Name	Yol	Tür	Description
Güncelleştirme Tarihi:	updated_at	string	Bu güncelleştirmenin RFC 3339 biçimindeki veritabanı zaman damgası.

Müşteri grubu oluşturma

İşlem Kimliği:

CustomGroupCreate

bir işletme için yeni bir müşteri grubu oluşturur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İsim	name		string	Nesnenin adı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	group.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İsim	group.name	string	Nesnenin adı.
Oluşturma Tarihi	group.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	group.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Müşteri grubunu alma

İşlem Kimliği:

CustomerGroupRetrieve

Belirli bir müşteri grubunu alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Grup Kimliği	group_id	True	string	Grubun tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	group.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İsim	group.name	string	Nesnenin adı.
Oluşturma Tarihi	group.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	group.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Müşteri grubunu güncelleştirme

İşlem Kimliği:

CustomerGroupUpdate

Müşteri grubunu güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Grup Kimliği	group_id	True	string	Grubun tanımlayıcısı.
İsim	name		string	Nesnenin adı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	group.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İsim	group.name	string	Nesnenin adı.
Oluşturma Tarihi	group.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	group.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Müşteri grubunu silme

İşlem Kimliği:

CustomerGroupDelete

group_id değeriyle tanımlanan bir müşteri grubunu siler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Grup Kimliği	group_id	True	string	Grubun tanımlayıcısı.

Döndürülenler

response

object

Müşteri gruplarını listeleme

İşlem Kimliği:

CustomerGroupList

bir işletmenin müşteri gruplarının listesini alır.

Döndürülenler

Name	Yol	Tür	Description
Groups	groups	array of object
Kimlik	groups.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İsim	groups.name	string	Nesnenin adı.
Oluşturma Tarihi	groups.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	groups.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası

Müşteri oluşturma

İşlem Kimliği:

CustomerCreate

bir işletme için yeni bir müşteri oluşturur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İsim	given_name		string	Müşteri profiliyle ilişkili verilen ad (yani ad).
Aile Adı	family_name		string	Müşteri profiliyle ilişkili aile adı (soyadı).
E-posta Adresi	email_address		string	Müşteri profiliyle ilişkili e-posta adresi.
Şirket Adı	company_name		string	Müşteri profiliyle ilişkilendirilmiş bir iş adı.
Lakap	nickname		string	Müşteri profili için bir takma ad.
Adres Satırı 1	address_line_1		string	Adresin ilk satırı.
Adres Satırı 2	address_line_2		string	Varsa, adresin ikinci satırı.
Yer	locality		string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	administrative_district_level_1		string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	postal_code		string	Adresin posta kodu.
Country	country		string	ISO 3166 Alfa-2 ülke kodu.
Telefon Numarası	phone_number		string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
Başvuru Kimliği	reference_id		string	Müşteri profilini başka bir sistemdeki bir varlıkla ilişkilendirmek için kullanılan isteğe bağlı ikinci kimlik.
Uyarı	note		string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
Doğum günü	birthday		string	Rfc 3339 biçiminde, müşteri profiliyle ilişkili doğum günü. Yıl isteğe bağlıdır. Saat dilimine ve saate izin verilmez. Örneğin, 0000-09-21T00:00:00-00:00:00, 21 Eylül 1998 ve 1998-09-21T00:00:00-00:00 yaş günlerini temsil eder. Bu değeri YYYY-MM-DD biçiminde de belirtebilirsiniz.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	customer.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Oluşturma Tarihi	customer.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	customer.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
İsim	customer.given_name	string	Müşteri profiliyle ilişkilendirilmiş verilen (yani ad) adı.
Aile Adı	customer.family_name	string	Müşteri profiliyle ilişkili aile (soyadı) adı.
E-posta Adresi	customer.email_address	string	Müşteri profiliyle ilişkili e-posta adresi.
Şirket Adı	customer.company_name	string	Müşteri profiliyle ilişkilendirilmiş bir iş adı.
Lakap	customer.nickname	string	Müşteri profili için bir takma ad.
Adres Satırı 1	customer.address.address_line_1	string	Adresin ilk satırı. address_line ile başlayan alanlar, adresin sokak numarası, sokak adı ve bina adı gibi en özel ayrıntılarını sağlar.
Adres Satırı 2	customer.address.address_line_2	string	Varsa, adresin ikinci satırı.
Yer	customer.address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	customer.address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	customer.address.postal_code	string	Adresin posta kodu.
Country	customer.address.country	string	Adresin ülkesi, ISO 3166-1-alfa-2 biçimindedir.
Telefon Numarası	customer.phone_number	string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
Başvuru Kimliği	customer.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Uyarı	customer.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
Doğum günü	customer.birthday	string	Rfc 3339 biçiminde, müşteri profiliyle ilişkili doğum günü. Yıl isteğe bağlıdır. Saat dilimine ve saate izin verilmez. Örneğin, 0000-09-21T00:00:00-00:00:00, 21 Eylül 1998 ve 1998-09-21T00:00:00-00:00 yaş günlerini temsil eder.
E-posta Aboneliği Kaldırıldı	customer.preferences.email_unsubscribed	boolean	Müşterinin pazarlama kampanyası e-posta aboneliğini kaldırıp kaldırmadığını gösterir. True değeri, müşterinin e-posta pazarlamasını geçerli Kare satıcısından veya tüm Square satıcılarından almayı seçtiği anlamına gelir.
Kaynak Oluşturma	customer.creation_source	string	Oluşturma kaynağı, müşteri profilini oluşturmak için kullanılan yöntemi temsil eder.
Sürüm	customer.version	integer	Bu nesnenin geçerli sürümü.

Müşteri segmentini alma

İşlem Kimliği:

CustomerSegmentRetrieve

Belirli bir müşteri segmentini alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Segment kimliği	segment_id	True	string	Segmentin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	segment.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İsim	segment.name	string	Nesnenin adı.
Oluşturma Tarihi	segment.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	segment.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Müşteri segmentlerini listeleme

İşlem Kimliği:

CustomerSegmentList

Bir işletmenin müşteri segmentlerinin listesini alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Cursor	cursor		string	Bu uç noktaya önceki bir çağrı tarafından döndürülen sayfalandırma imleci.
Sınır	limit		integer	Yanıtta döndürülecek sayı üst sınırı.

Döndürülenler

Name	Yol	Tür	Description
Segmentler	segments	array of object
Kimlik	segments.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İsim	segments.name	string	Nesnenin adı.
Oluşturma Tarihi	segments.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	segments.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası

Müşterileri ara

İşlem Kimliği:

CustomerSearch

Desteklenen bir sorgu filtresi kullanarak Kare hesapla ilişkili müşteri profillerinde arama gerçekleştirir. SearchCustomers'ı açık sorgu filtresi olmadan çağırmak, given_name ve family_name göre alfabetik olarak sıralanmış tüm müşteri profillerini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bulanık	fuzzy		string	Öznitelikleri belirtilen sorguyla benzer şekilde eşleşen müşterileri seçmek için benzer filtreyi kullanın. Benzer seçenek kullanıldığında, arama sorguları belirteç haline getirilir ve her sorgu belirteci, aranan özniteliğin bir yerinde eşleştirilmelidir. Tek belirteçli sorgular için bu, kısmi eşleştirme işlemiyle etkili bir şekilde aynı davranıştır.
Değerler	values		array of string
Rule	rule		string	Filtre ölçütlerine uyan bir müşteri profilinin sonuda dahil edilmesi mi yoksa sonuçtan dışlanması mı gerektiğini gösterir.
Başlangıç:	start_at		string	RFC 3339 biçiminde, zaman aralığının ne zaman başladığını gösteren bir tarih saat değeri.
Bitiş:	end_at		string	RFC 3339 biçiminde, zaman aralığının ne zaman sona erdiğini gösteren bir tarih saat değeri.
Tümü	all		array of string
Veri Alanı	field		string	Arama yapılan müşteri profillerini sıralamak için sıralama anahtarı olarak bir veya daha fazla müşteri özniteliği kullanın.
Sipariş	order		string	Sıralama alanı değerine göre sonuçların sıralanma sırasını gösterir. Dizeler, sırayı belirlemek için standart alfabetik karşılaştırmayı kullanır.
Sınır	limit		integer	Tek bir sayfada döndürülecek sonuç sayısıyla ilgili bir sınır. Sınır danışmanlıktır; uygulama daha fazla veya daha az sonuç döndürebilir. Sağlanan sınır negatif, sıfır veya en yüksek sınır olan 1.000'den yüksekse, yoksayılır.

Döndürülenler

Name	Yol	Tür	Description
Customers	customers	array of object
Kimlik	customers.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Oluşturma Tarihi	customers.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	customers.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
İsim	customers.given_name	string	Müşteri profiliyle ilişkilendirilmiş verilen (yani ad) adı.
Aile Adı	customers.family_name	string	Müşteri profiliyle ilişkili aile (soyadı) adı.
E-posta Adresi	customers.email_address	string	Müşteri profiliyle ilişkili e-posta adresi.
Adres Satırı 1	customers.address.address_line_1	string	Adresin ilk satırı.
Adres Satırı 2	customers.address.address_line_2	string	Varsa, adresin ikinci satırı.
Yer	customers.address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	customers.address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	customers.address.postal_code	string	Adresin posta kodu.
Country	customers.address.country	string	Adresin ülkesi, ISO 3166-1-alfa-2 biçimindedir.
Telefon Numarası	customers.phone_number	string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
Başvuru Kimliği	customers.reference_id	string	Müşteri profilini başka bir sistemdeki bir varlıkla ilişkilendirmek için kullanılan isteğe bağlı ikinci kimlik.
E-posta Aboneliği Kaldırıldı	customers.preferences.email_unsubscribed	boolean	Müşterinin pazarlama kampanyası e-posta aboneliğini kaldırıp kaldırmadığını gösterir. True değeri, müşterinin e-posta pazarlamasını geçerli Kare satıcısından veya tüm Square satıcılarından almayı seçtiği anlamına gelir. Bu değer, Müşteriler API'sinden salt okunurdur.
Kaynak Oluşturma	customers.creation_source	string	Oluşturma kaynağı, müşteri profilini oluşturmak için kullanılan yöntemi temsil eder.
Grup Kimlikleri	customers.group_ids	array of string
Segment Kimlikleri	customers.segment_ids	array of string
Sürüm	customers.version	integer	Nesnenin geçerli sürümü.
Uyarı	customers.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
Cursor	cursor	string	Özgün sorguyla ilişkili sonraki sonuç kümesini almak için sayfalandırma imlecini bu uç noktaya yapılan sonraki çağrılara ekleyin.

Müşterileri listeleme

İşlem Kimliği:

CustomerList

Kare hesabıyla ilişkilendirilmiş müşteri profillerini listeler. Normal çalışma koşulları altında, yeni oluşturulan veya güncelleştirilen müşteri profilleri, listeleme işlemi için 30 saniyeden kısa bir süre içinde kullanılabilir hale gelir. Bazen, yeni veya güncelleştirilmiş profillerin yayılması, özellikle ağ olayları ve kesintiler sırasında bir dakika veya daha uzun sürebilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Cursor	cursor		string	Bu uç noktaya önceki bir çağrı tarafından döndürülen sayfalandırma imleci.
Sınır	limit		integer	Yanıtta döndürülecek sayı üst sınırı.
Sıralama Alanı	sort_field		string	Müşterilerin nasıl sıralanması gerektiğini gösterir. Varsayılan değer DEFAULT değeridir.
Sıralama Düzeni	sort_order		string	Döndürülen listeyi, kartın belirtilen düzende oluşturulduğu zamanlara göre sıralar.

Döndürülenler

Name	Yol	Tür	Description
Customers	customers	array of object
Kimlik	customers.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Oluşturma Tarihi	customers.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	customers.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
İsim	customers.given_name	string	Müşteri profiliyle ilişkilendirilmiş verilen (yani ad) adı.
Aile Adı	customers.family_name	string	Müşteri profiliyle ilişkili aile (soyadı) adı.
E-posta Adresi	customers.email_address	string	Müşteri profiliyle ilişkili e-posta adresi.
Adres Satırı 1	customers.address.address_line_1	string	Adresin ilk satırı.
Adres Satırı 2	customers.address.address_line_2	string	Varsa, adresin ikinci satırı.
Yer	customers.address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	customers.address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	customers.address.postal_code	string	Adresin posta kodu.
Country	customers.address.country	string	Adresin ülkesi, ISO 3166-1-alfa-2 biçimindedir.
Telefon Numarası	customers.phone_number	string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
Başvuru Kimliği	customers.reference_id	string	Müşteri profilini başka bir sistemdeki bir varlıkla ilişkilendirmek için kullanılan isteğe bağlı ikinci kimlik.
Uyarı	customers.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
E-posta Aboneliği Kaldırıldı	customers.preferences.email_unsubscribed	boolean	Müşterinin pazarlama kampanyası e-posta aboneliğini kaldırıp kaldırmadığını gösterir. True değeri, müşterinin e-posta pazarlamasını geçerli Kare satıcısından veya tüm Square satıcılarından almayı seçtiği anlamına gelir. Bu değer, Müşteriler API'sinden salt okunurdur.
Kaynak Oluşturma	customers.creation_source	string	Oluşturma kaynağı, müşteri profilini oluşturmak için kullanılan yöntemi temsil eder.
Grup Kimlikleri	customers.group_ids	array of string
Segment Kimlikleri	customers.segment_ids	array of string
Sürüm	customers.version	integer	Nesnenin geçerli sürümü.

Müşteriye grup ekleme

İşlem Kimliği:

CustomerAddGroup

Müşteriye grup üyeliği ekler. Müşteri customer_id değeriyle, müşteri grubu ise group_id değeriyle tanımlanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Müşteri Kimliği	customer_id	True	string	Müşterinin tanımlayıcısı.
Grup Kimliği	group_id	True	string	Grubun tanımlayıcısı.

Döndürülenler

response

object

Müşteriyi alma

İşlem Kimliği:

CustomerRetrieve

Tek bir müşterinin ayrıntılarını döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Müşteri Kimliği	customer_id	True	string	Müşterinin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	customer.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Oluşturma Tarihi	customer.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	customer.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
İsim	customer.given_name	string	Müşteri profiliyle ilişkilendirilmiş verilen (yani ad) adı.
Aile Adı	customer.family_name	string	Müşteri profiliyle ilişkili aile (soyadı) adı.
E-posta Adresi	customer.email_address	string	Müşteri profiliyle ilişkili e-posta adresi.
Adres Satırı 1	customer.address.address_line_1	string	Adresin ilk satırı. address_line ile başlayan alanlar, adresin sokak numarası, sokak adı ve bina adı gibi en özel ayrıntılarını sağlar.
Adres Satırı 2	customer.address.address_line_2	string	Varsa, adresin ikinci satırı.
Yer	customer.address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	customer.address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	customer.address.postal_code	string	Adresin posta kodu.
Country	customer.address.country	string	Adresin ülkesi, ISO 3166-1-alfa-2 biçimindedir.
Telefon Numarası	customer.phone_number	string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
Başvuru Kimliği	customer.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Uyarı	customer.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
E-posta Aboneliği Kaldırıldı	customer.preferences.email_unsubscribed	boolean	Müşterinin pazarlama kampanyası e-posta aboneliğini kaldırıp kaldırmadığını gösterir. True değeri, müşterinin e-posta pazarlamasını geçerli Kare satıcısından veya tüm Square satıcılarından almayı seçtiği anlamına gelir.
Kaynak Oluşturma	customer.creation_source	string	Oluşturma kaynağı, müşteri profilini oluşturmak için kullanılan yöntemi temsil eder.
Grup Kimlikleri	customer.group_ids	array of string
Segment Kimlikleri	customer.segment_ids	array of string
Sürüm	customer.version	integer	Bu nesnenin geçerli sürümü.

Müşteriyi güncelleştirme

İşlem Kimliği:

CustomerUpdate

Müşteri profilini güncelleştirir. Özniteliği değiştirmek için yeni değeri belirtin. Özniteliği kaldırmak için değeri boş dize veya boş nesne olarak belirtin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Müşteri Kimliği	customer_id	True	string	Müşterinin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	customer.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Oluşturma Tarihi	customer.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	customer.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
İsim	customer.given_name	string	Müşteri profiliyle ilişkilendirilmiş verilen (yani ad) adı.
Aile Adı	customer.family_name	string	Müşteri profiliyle ilişkili aile (soyadı) adı.
E-posta Adresi	customer.email_address	string	Müşteri profiliyle ilişkili e-posta adresi.
Adres Satırı 1	customer.address.address_line_1	string	Adresin ilk satırı. address_line ile başlayan alanlar, adresin sokak numarası, sokak adı ve bina adı gibi en özel ayrıntılarını sağlar.
Adres Satırı 2	customer.address.address_line_2	string	Varsa, adresin ikinci satırı.
Yer	customer.address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	customer.address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	customer.address.postal_code	string	Adresin posta kodu.
Country	customer.address.country	string	Adresin ülkesi, ISO 3166-1-alfa-2 biçimindedir.
Başvuru Kimliği	customer.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Uyarı	customer.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
E-posta Aboneliği Kaldırıldı	customer.preferences.email_unsubscribed	boolean	Müşterinin pazarlama kampanyası e-posta aboneliğini kaldırıp kaldırmadığını gösterir. True değeri, müşterinin e-posta pazarlamasını geçerli Kare satıcısından veya tüm Square satıcılarından almayı seçtiği anlamına gelir.
Kaynak Oluşturma	customer.creation_source	string	Oluşturma kaynağı, müşteri profilini oluşturmak için kullanılan yöntemi temsil eder.
Sürüm	customer.version	integer	Bu nesnenin geçerli sürümü.

Müşteriyi silme

İşlem Kimliği:

CustomerDelete

bir işletmeden müşteri profilini siler. Bu işlem, dosyadaki ilişkili kartların bağlantılarını da kaldırıyor.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Müşteri Kimliği	customer_id	True	string	Müşterinin tanımlayıcısı.

Döndürülenler

response

object

Para iadesi ödemesi

İşlem Kimliği:

RefundPayment

Bir ödeme için para iadesi alır. Ödeme tutarının tamamını veya bir kısmını iade edebilirsiniz. Bu uç noktayı kart ödemesine para iadesi yapmak veya nakit ya da harici ödeme için para iadesi kaydetmek için kullanabilirsiniz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Ödeme Kimliği	payment_id		string	Para iadesi yapılan ödemenin benzersiz kimliği.
Miktar	amount		integer	tip_money dahil olmak üzere bu ödeme için kabul edilen para miktarı.
Para birimi	currency		string	3 karakterli ISO 4217 para birimi kodu.
Miktar	amount		integer	tip_money dahil olmak üzere bu ödeme için kabul edilen para miktarı.
Para birimi	currency		string	3 karakterli ISO 4217 para birimi kodu.
Reason	reason		string	Para iadesinin nedeninin açıklaması.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	refund.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Statü	refund.status	string	Bu nesnenin geçerli doğrulama durumu.
Miktar	refund.amount_money.amount	integer	Miktar.
Para birimi	refund.amount_money.currency	string	Para birimi.
Ödeme Kimliği	refund.payment_id	string	Ödemenin benzersiz kimliği.
Sipariş Kimliği	refund.order_id	string	Siparişin kimliği.
Oluşturma Tarihi	refund.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	refund.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Miktar	refund.app_fee_money.amount	integer	Miktar.
Para birimi	refund.app_fee_money.currency	string	Para birimi.
Konum Kimliği	refund.location_id	string	Konumun tanımlayıcısı.
Reason	refund.reason	string	Bu nesnenin nedeni.

Sipariş oluştur

İşlem Kimliği:

OrderCreate

Satın alma için ürünler ve satın alma için uygulanacak ayarlar hakkında bilgi içerebilen yeni bir sipariş oluşturur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Başvuru Kimliği	reference_id		string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Konum Kimliği	location_id		string	Konumun tanımlayıcısı.
İsim	name		string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Miktar	quantity		string	Fiziksel sayının ondalık dize olarak etkilediği öğe sayısı. Sayı, ondalık ayırıcıdan sonra en çok 5 basamağı destekleyebilir.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.
Katalog Nesne Kimliği	catalog_object_id		string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
Katalog Nesne Kimliği	catalog_object_id		string	Katalog nesne kimliği.
İndirim UID	discount_uid		string	Uygulanan indirimin temsil ettiği indirimin kullanıcı arabirimi.
UID	uid		string	Kare tarafından oluşturulan kimlik.
İsim	name		string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Yüzde	percentage		string	Ondalık ayırıcı olarak '.' kullanan ve '%' işareti olmayan ondalık biçimindeki yüzde. 7,5 değeri,%7,5'e karşılık gelir.
Scope	scope		string	Geçerli düzeyi gösterir.
UID	uid		string	Kare tarafından oluşturulan kimlik.
İsim	name		string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Yüzde	percentage		string	Ondalık ayırıcı olarak '.' kullanan ve '%' işareti olmayan ondalık biçimindeki yüzde. 7,5 değeri,%7,5'e karşılık gelir.
Scope	scope		string	Geçerli düzeyi gösterir.
Katalog Nesne Kimliği	catalog_object_id		string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	order.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	order.location_id	string	Konumun tanımlayıcısı.
Satır Öğeleri	order.line_items	array of object
UID	order.line_items.uid	string	Kare tarafından oluşturulan kimlik.
İsim	order.line_items.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Miktar	order.line_items.quantity	string	Fiziksel sayının ondalık dize olarak etkilediği öğe sayısı. Sayı, ondalık ayırıcıdan sonra en çok 5 basamağı destekleyebilir.
Uygulanan Vergiler	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	Kare olarak atanan kimlik.
Vergi UID	order.line_items.applied_taxes.tax_uid	string	Bu uygulanan verginin temsil ettiği verginin UID'sini.
Miktar	order.line_items.applied_taxes.applied_money.amount	integer	Miktar.
Para birimi	order.line_items.applied_taxes.applied_money.currency	string	Para birimi.
Uygulanan İndirimler	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Kare olarak atanan kimlik.
İndirim UID	order.line_items.applied_discounts.discount_uid	string	Uygulanan indirimin temsil ettiği indirimin kullanıcı arabirimi.
Miktar	order.line_items.applied_discounts.applied_money.amount	integer	Miktar.
Para birimi	order.line_items.applied_discounts.applied_money.currency	string	Para birimi.
Miktar	order.line_items.base_price_money.amount	integer	Miktar.
Para birimi	order.line_items.base_price_money.currency	string	Para birimi.
Miktar	order.line_items.gross_sales_money.amount	integer	Miktar.
Para birimi	order.line_items.gross_sales_money.currency	string	Para birimi.
Miktar	order.line_items.total_tax_money.amount	integer	Miktar.
Para birimi	order.line_items.total_tax_money.currency	string	Para birimi.
Miktar	order.line_items.total_discount_money.amount	integer	Miktar.
Para birimi	order.line_items.total_discount_money.currency	string	Para birimi.
Miktar	order.line_items.total_money.amount	integer	Miktar.
Para birimi	order.line_items.total_money.currency	string	Para birimi.
Miktar	order.line_items.variation_total_price_money.amount	integer	Miktar.
Para birimi	order.line_items.variation_total_price_money.currency	string	Para birimi.
Katalog Nesne Kimliği	order.line_items.catalog_object_id	string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
Çeşitleme Adı	order.line_items.variation_name	string	Bu satır öğesine uygulanan varyasyonun adı.
Değiştirici	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	Kare olarak atanan kimlik.
Katalog Nesne Kimliği	order.line_items.modifiers.catalog_object_id	string	Katalog nesne kimliği.
İsim	order.line_items.modifiers.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Miktar	order.line_items.modifiers.base_price_money.amount	integer	Miktar.
Para birimi	order.line_items.modifiers.base_price_money.currency	string	Para birimi.
Miktar	order.line_items.modifiers.total_price_money.amount	integer	Miktar.
Para birimi	order.line_items.modifiers.total_price_money.currency	string	Para birimi.
Vergiler	order.taxes	array of object
UID	order.taxes.uid	string	Kare tarafından oluşturulan kimlik.
İsim	order.taxes.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Türü	order.taxes.type	string	Türünü gösterir.
Yüzde	order.taxes.percentage	string	Ondalık ayırıcı olarak '.' kullanan ve '%' işareti olmayan ondalık biçimindeki yüzde. 7,5 değeri,%7,5'e karşılık gelir.
Miktar	order.taxes.applied_money.amount	integer	Miktar.
Para birimi	order.taxes.applied_money.currency	string	Para birimi.
Scope	order.taxes.scope	string	Geçerli düzeyi gösterir.
İskontolar	order.discounts	array of object
UID	order.discounts.uid	string	Kare tarafından oluşturulan kimlik.
Katalog Nesne Kimliği	order.discounts.catalog_object_id	string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
İsim	order.discounts.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Türü	order.discounts.type	string	Türünü gösterir.
Yüzde	order.discounts.percentage	string	Ondalık ayırıcı olarak '.' kullanan ve '%' işareti olmayan ondalık biçimindeki yüzde. 7,5 değeri,%7,5'e karşılık gelir.
Miktar	order.discounts.applied_money.amount	integer	Miktar.
Para birimi	order.discounts.applied_money.currency	string	Para birimi.
Scope	order.discounts.scope	string	Geçerli düzeyi gösterir.
Miktar	order.discounts.amount_money.amount	integer	Miktar.
Para birimi	order.discounts.amount_money.currency	string	Para birimi.
Oluşturma Tarihi	order.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	order.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Devlet	order.state	string	Geçerli durum.
Sürüm	order.version	integer	Bu nesnenin geçerli sürümü.
Başvuru Kimliği	order.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Miktar	order.total_money.amount	integer	Miktar.
Para birimi	order.total_money.currency	string	Para birimi.
Miktar	order.total_tax_money.amount	integer	Miktar.
Para birimi	order.total_tax_money.currency	string	Para birimi.
Miktar	order.total_discount_money.amount	integer	Miktar.
Para birimi	order.total_discount_money.currency	string	Para birimi.
Miktar	order.total_tip_money.amount	integer	Miktar.
Para birimi	order.total_tip_money.currency	string	Para birimi.
Miktar	order.total_service_charge_money.amount	integer	Miktar.
Para birimi	order.total_service_charge_money.currency	string	Para birimi.
Miktar	order.net_amounts.total_money.amount	integer	Miktar.
Para birimi	order.net_amounts.total_money.currency	string	Para birimi.
Miktar	order.net_amounts.tax_money.amount	integer	Miktar.
Para birimi	order.net_amounts.tax_money.currency	string	Para birimi.
Miktar	order.net_amounts.discount_money.amount	integer	Miktar.
Para birimi	order.net_amounts.discount_money.currency	string	Para birimi.
Miktar	order.net_amounts.tip_money.amount	integer	Miktar.
Para birimi	order.net_amounts.tip_money.currency	string	Para birimi.
Miktar	order.net_amounts.service_charge_money.amount	integer	Miktar.
Para birimi	order.net_amounts.service_charge_money.currency	string	Para birimi.
İsim	order.source.name	string	Adı.

Siparişi alma

İşlem Kimliği:

OrderRetrieve

Kimliğine göre bir Sipariş alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sipariş Kimliği	order_id	True	string	Siparişin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	order.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	order.location_id	string	Konumun tanımlayıcısı.
Satır Öğeleri	order.line_items	array of object
UID	order.line_items.uid	string	Kare tarafından oluşturulan kimlik.
Miktar	order.line_items.quantity	string	Fiziksel sayının ondalık dize olarak etkilediği öğe sayısı. Sayı, ondalık ayırıcıdan sonra en çok 5 basamağı destekleyebilir.
İsim	order.line_items.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Miktar	order.line_items.base_price_money.amount	integer	Miktar.
Para birimi	order.line_items.base_price_money.currency	string	Para birimi.
Miktar	order.line_items.gross_sales_money.amount	integer	Miktar.
Para birimi	order.line_items.gross_sales_money.currency	string	Para birimi.
Miktar	order.line_items.total_tax_money.amount	integer	Miktar.
Para birimi	order.line_items.total_tax_money.currency	string	Para birimi.
Miktar	order.line_items.total_discount_money.amount	integer	Miktar.
Para birimi	order.line_items.total_discount_money.currency	string	Para birimi.
Miktar	order.line_items.total_money.amount	integer	Miktar.
Para birimi	order.line_items.total_money.currency	string	Para birimi.
Miktar	order.line_items.variation_total_price_money.amount	integer	Miktar.
Para birimi	order.line_items.variation_total_price_money.currency	string	Para birimi.
Uygulanan İndirimler	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Kare olarak atanan kimlik.
İndirim UID	order.line_items.applied_discounts.discount_uid	string	Uygulanan indirimin temsil ettiği indirimin kullanıcı arabirimi.
Miktar	order.line_items.applied_discounts.applied_money.amount	integer	Miktar.
Para birimi	order.line_items.applied_discounts.applied_money.currency	string	Para birimi.
İskontolar	order.discounts	array of object
UID	order.discounts.uid	string	Kare tarafından oluşturulan kimlik.
İsim	order.discounts.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Yüzde	order.discounts.percentage	string	Ondalık ayırıcı olarak '.' kullanan ve '%' işareti olmayan ondalık biçimindeki yüzde. 7,5 değeri,%7,5'e karşılık gelir.
Miktar	order.discounts.applied_money.amount	integer	Miktar.
Para birimi	order.discounts.applied_money.currency	string	Para birimi.
Türü	order.discounts.type	string	Türünü gösterir.
Scope	order.discounts.scope	string	Geçerli düzeyi gösterir.
Oluşturma Tarihi	order.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	order.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Devlet	order.state	string	Geçerli durum.
Sürüm	order.version	integer	Bu nesnenin geçerli sürümü.
Miktar	order.total_tax_money.amount	integer	Miktar.
Para birimi	order.total_tax_money.currency	string	Para birimi.
Miktar	order.total_discount_money.amount	integer	Miktar.
Para birimi	order.total_discount_money.currency	string	Para birimi.
Miktar	order.total_tip_money.amount	integer	Miktar.
Para birimi	order.total_tip_money.currency	string	Para birimi.
Miktar	order.total_money.amount	integer	Miktar.
Para birimi	order.total_money.currency	string	Para birimi.
Miktar	order.total_service_charge_money.amount	integer	Miktar.
Para birimi	order.total_service_charge_money.currency	string	Para birimi.
Miktar	order.net_amounts.total_money.amount	integer	Miktar.
Para birimi	order.net_amounts.total_money.currency	string	Para birimi.
Miktar	order.net_amounts.tax_money.amount	integer	Miktar.
Para birimi	order.net_amounts.tax_money.currency	string	Para birimi.
Miktar	order.net_amounts.discount_money.amount	integer	Miktar.
Para birimi	order.net_amounts.discount_money.currency	string	Para birimi.
Miktar	order.net_amounts.tip_money.amount	integer	Miktar.
Para birimi	order.net_amounts.tip_money.currency	string	Para birimi.
Miktar	order.net_amounts.service_charge_money.amount	integer	Miktar.
Para birimi	order.net_amounts.service_charge_money.currency	string	Para birimi.

Stok aktarımını alma (Beta)

İşlem Kimliği:

InventoryRetrieveTransfer

Sağlanan transfer_id ile InventoryTransfer nesnesini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Aktarım Kimliği	transfer_id	True	string	Aktarımın tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	transfer.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Katalog Nesne Kimliği	transfer.catalog_object_id	string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
Katalog Nesne Türü	transfer.catalog_object_type	string	İzlenen CatalogObject türü.
Oluşturma Tarihi	transfer.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Çalışan Kimliği	transfer.employee_id	string	Çalışanın Kare olarak oluşturulan kimliği.
Kaynak Konum Kimliği	transfer.from_location_id	string	Transferden önce ilgili madde miktarının izlendiği Konumun Kare olarak oluşturulan kimliği.
Konum Kimliğine	transfer.to_location_id	string	Transferden sonra ilgili madde miktarının izlendiği Konumun Kare olarak oluşturulan kimliği.
Oluştuğu Yer	transfer.occurred_at	string	Stok ayarlamasının ne zaman gerçekleştiğini gösteren istemci tarafından oluşturulan RFC 3339 biçimli zaman damgası. Stok ayarlama güncelleştirmeleri için, occurred_at zaman damgası isteğin zamanına göre 24 saatten eski veya gelecekte olamaz.
Miktar	transfer.quantity	string	Ayarlamadan etkilenen öğelerin ondalık dize olarak sayısı. Ondalık ayırıcıdan sonra en fazla 5 basamak destekleyebilir.
Başvuru Kimliği	transfer.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Ürün	transfer.source.product	string	Uygulamanın ürün türü.
Uygulama Kimliği	transfer.source.application_id	string	Uygulamaya atanan salt okunur Kare Kimliği.
İsim	transfer.source.name	string	Adı.
Devlet	transfer.state	string	Geçerli durum.

Stok düzeltmesi alma

İşlem Kimliği:

InventoryRetrieveAdjustment

Sağlanan adjustment_id ile InventoryAdjustment nesnesini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ayarlama Kimliği	adjustment_id	True	string	Ayarlamanın tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	adjustment.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Başvuru Kimliği	adjustment.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Kimden Durumu	adjustment.from_state	string	Ayarlamadan önceki ilgili madde miktarının stok durumu.
Son Durum	adjustment.to_state	string	Ayarlamadan sonra ilgili madde miktarının stok durumu.
Konum Kimliği	adjustment.location_id	string	Konumun tanımlayıcısı.
Katalog Nesne Kimliği	adjustment.catalog_object_id	string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
Katalog Nesne Türü	adjustment.catalog_object_type	string	İzlenen CatalogObject türü.
Miktar	adjustment.quantity	string	Ayarlamadan etkilenen öğelerin ondalık dize olarak sayısı. Ondalık ayırıcıdan sonra en fazla 5 basamak destekleyebilir.
Miktar	adjustment.total_price_money.amount	integer	Miktar.
Para birimi	adjustment.total_price_money.currency	string	Para birimi.
Oluştuğu Yer	adjustment.occurred_at	string	Stok ayarlamasının ne zaman gerçekleştiğini gösteren istemci tarafından oluşturulan RFC 3339 biçimli zaman damgası. Stok ayarlama güncelleştirmeleri için, occurred_at zaman damgası isteğin zamanına göre 24 saatten eski veya gelecekte olamaz.
Oluşturma Tarihi	adjustment.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Ürün	adjustment.source.product	string	Uygulamanın ürün türü.
Uygulama Kimliği	adjustment.source.application_id	string	Uygulamaya atanan salt okunur Kare Kimliği.
İsim	adjustment.source.name	string	Adı.
Çalışan Kimliği	adjustment.employee_id	string	Çalışanın Kare olarak oluşturulan kimliği.

Stok fiziksel sayısını alma

İşlem Kimliği:

InventoryRetrievePhysicalCount

Sağlanan physical_count_id ile InventoryPhysicalCount nesnesini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Fiziksel Sayı Kimliği	physical_count_id	True	string	Fiziksel sayının tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	count.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Başvuru Kimliği	count.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Katalog Nesne Kimliği	count.catalog_object_id	string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
Katalog Nesne Türü	count.catalog_object_type	string	İzlenen CatalogObject türü.
Devlet	count.state	string	Geçerli durum.
Konum Kimliği	count.location_id	string	Konumun tanımlayıcısı.
Miktar	count.quantity	string	Ayarlamadan etkilenen öğelerin ondalık dize olarak sayısı. Ondalık ayırıcıdan sonra en fazla 5 basamak destekleyebilir.
Ürün	count.source.product	string	Uygulamanın ürün türü.
Uygulama Kimliği	count.source.application_id	string	Uygulamaya atanan salt okunur Kare Kimliği.
İsim	count.source.name	string	Adı.
Çalışan Kimliği	count.employee_id	string	Çalışanın Kare olarak oluşturulan kimliği.
Oluştuğu Yer	count.occurred_at	string	Stok ayarlamasının ne zaman gerçekleştiğini gösteren istemci tarafından oluşturulan RFC 3339 biçimli zaman damgası. Stok ayarlama güncelleştirmeleri için, occurred_at zaman damgası isteğin zamanına göre 24 saatten eski veya gelecekte olamaz.
Oluşturma Tarihi	count.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.

Stok sayısını alma

İşlem Kimliği:

InventoryRetrieveCount

Belirli bir Konum kümesindeki belirli bir CatalogObject için geçerli hesaplanan hisse senedi sayısını alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Katalog Nesne Kimliği	catalog_object_id	True	string	Katalog nesnesinin tanımlayıcısı.
Konum Kimlikleri	location_ids		string	Virgülle ayrılmış liste olarak aramak için Konum Kimlikleri. Boş bir liste tüm konumları sorgular.
Cursor	cursor		string	Bu uç noktaya önceki bir çağrı tarafından döndürülen sayfalandırma imleci.

Döndürülenler

Name	Yol	Tür	Description
Sayar	counts	array of object
Katalog Nesne Kimliği	counts.catalog_object_id	string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
Katalog Nesne Türü	counts.catalog_object_type	string	İzlenen CatalogObject türü.
Devlet	counts.state	string	Geçerli durum.
Konum Kimliği	counts.location_id	string	Konumun tanımlayıcısı.
Miktar	counts.quantity	string	Ondalık dize olarak tahmini sayıdan etkilenen öğe sayısı. Ondalık ayırıcıdan sonra en fazla 5 basamak destekleyebilir.
Hesaplanacak Yer	counts.calculated_at	string	Tahmini sayıyı etkileyen en son fiziksel sayının veya ayarlamanın ne zaman alındığını gösteren RFC 3339 biçimli zaman damgası.

Sıralamayı hesaplama (Beta)

İşlem Kimliği:

OrderCalculate

Uygulamaların sipariş oluşturmadan sipariş fiyatlandırmasını önizlemesini sağlar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Konum Kimliği	location_id		string	Konumun tanımlayıcısı.
İsim	name		string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Yüzde	percentage		string	Ondalık ayırıcı olarak '.' kullanan ve '%' işareti olmayan ondalık biçimindeki yüzde. 7,5 değeri,%7,5'e karşılık gelir.
Scope	scope		string	Geçerli düzeyi gösterir.
İsim	name		string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Miktar	quantity		string	Fiziksel sayının ondalık dize olarak etkilediği öğe sayısı. Sayı, ondalık ayırıcıdan sonra en çok 5 basamağı destekleyebilir.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.

Döndürülenler

Name	Yol	Tür	Description
Konum Kimliği	order.location_id	string	Konumun tanımlayıcısı.
Satır Öğeleri	order.line_items	array of object
UID	order.line_items.uid	string	Kare tarafından oluşturulan kimlik.
Miktar	order.line_items.quantity	string	Fiziksel sayının ondalık dize olarak etkilediği öğe sayısı. Sayı, ondalık ayırıcıdan sonra en çok 5 basamağı destekleyebilir.
İsim	order.line_items.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Miktar	order.line_items.base_price_money.amount	integer	Miktar.
Para birimi	order.line_items.base_price_money.currency	string	Para birimi.
Miktar	order.line_items.gross_sales_money.amount	integer	Miktar.
Para birimi	order.line_items.gross_sales_money.currency	string	Para birimi.
Miktar	order.line_items.total_tax_money.amount	integer	Miktar.
Para birimi	order.line_items.total_tax_money.currency	string	Para birimi.
Miktar	order.line_items.total_discount_money.amount	integer	Miktar.
Para birimi	order.line_items.total_discount_money.currency	string	Para birimi.
Miktar	order.line_items.total_money.amount	integer	Miktar.
Para birimi	order.line_items.total_money.currency	string	Para birimi.
Miktar	order.line_items.variation_total_price_money.amount	integer	Miktar.
Para birimi	order.line_items.variation_total_price_money.currency	string	Para birimi.
Uygulanan İndirimler	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Kare olarak atanan kimlik.
İndirim UID	order.line_items.applied_discounts.discount_uid	string	Uygulanan indirimin temsil ettiği indirimin kullanıcı arabirimi.
Miktar	order.line_items.applied_discounts.applied_money.amount	integer	Miktar.
Para birimi	order.line_items.applied_discounts.applied_money.currency	string	Para birimi.
İskontolar	order.discounts	array of object
UID	order.discounts.uid	string	Kare tarafından oluşturulan kimlik.
İsim	order.discounts.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Yüzde	order.discounts.percentage	string	Ondalık ayırıcı olarak '.' kullanan ve '%' işareti olmayan ondalık biçimindeki yüzde. 7,5 değeri,%7,5'e karşılık gelir.
Miktar	order.discounts.applied_money.amount	integer	Miktar.
Para birimi	order.discounts.applied_money.currency	string	Para birimi.
Türü	order.discounts.type	string	Türünü gösterir.
Scope	order.discounts.scope	string	Geçerli düzeyi gösterir.
Oluşturma Tarihi	order.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	order.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Devlet	order.state	string	Geçerli durum.
Sürüm	order.version	integer	Bu nesnenin geçerli sürümü.
Miktar	order.total_tax_money.amount	integer	Miktar.
Para birimi	order.total_tax_money.currency	string	Para birimi.
Miktar	order.total_discount_money.amount	integer	Miktar.
Para birimi	order.total_discount_money.currency	string	Para birimi.
Miktar	order.total_tip_money.amount	integer	Miktar.
Para birimi	order.total_tip_money.currency	string	Para birimi.
Miktar	order.total_money.amount	integer	Miktar.
Para birimi	order.total_money.currency	string	Para birimi.
Miktar	order.total_service_charge_money.amount	integer	Miktar.
Para birimi	order.total_service_charge_money.currency	string	Para birimi.
Miktar	order.net_amounts.total_money.amount	integer	Miktar.
Para birimi	order.net_amounts.total_money.currency	string	Para birimi.
Miktar	order.net_amounts.tax_money.amount	integer	Miktar.
Para birimi	order.net_amounts.tax_money.currency	string	Para birimi.
Miktar	order.net_amounts.discount_money.amount	integer	Miktar.
Para birimi	order.net_amounts.discount_money.currency	string	Para birimi.
Miktar	order.net_amounts.tip_money.amount	integer	Miktar.
Para birimi	order.net_amounts.tip_money.currency	string	Para birimi.
Miktar	order.net_amounts.service_charge_money.amount	integer	Miktar.
Para birimi	order.net_amounts.service_charge_money.currency	string	Para birimi.

Terminal kullanıma alma oluşturma

İşlem Kimliği:

TerminalCreateCheckout

Bir Terminal ödeme isteği oluşturur ve istenen tutar için ödeme almak üzere belirtilen cihaza gönderir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.
Başvuru Kimliği	reference_id		string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Cihaz Kimliği	device_id		string	Bu TerminalCheckout için tasarlanan cihazın benzersiz kimliği.
Uyarı	note		string	Müşteri profiliyle ilişkilendirilmiş özel bir not.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	checkout.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Miktar	checkout.amount_money.amount	integer	Miktar.
Para birimi	checkout.amount_money.currency	string	Para birimi.
Başvuru Kimliği	checkout.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Uyarı	checkout.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
Cihaz Kimliği	checkout.device_options.device_id	string	Bu TerminalCheckout için tasarlanan cihazın benzersiz kimliği.
Ekran Alıntısına İzin Ver	checkout.device_options.tip_settings.allow_tipping	boolean	Bu ödeme için bahşiş vermenin etkinleştirilip etkinleştirilmediğini gösterir. Varsayılan değer false'tur.
Makbuz Ekranını Atla	checkout.device_options.skip_receipt_screen	boolean	Cihaza makbuz ekranını atlayıp atlamasını emreder. Varsayılan değer false'tur.
Statü	checkout.status	string	Bu nesnenin geçerli doğrulama durumu.
Oluşturma Tarihi	checkout.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	checkout.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Uygulama Kimliği	checkout.app_id	string	Kullanıma alma işlemini oluşturan uygulamanın kimliği.
Son Tarih Süresi	checkout.deadline_duration	string	Bir RFC 3339 süresi, ardından kullanıma alma işlemi otomatik olarak iptal edilir. BEKLEMEDE olan bir TerminalCheckout otomatik olarak İPTAL EDİlDİ ve iptal nedeni TIMED_OUT. Varsayılan: Oluşturmadan 5 dakika sonra
Ödeme Türü	checkout.payment_type	string	Terminalin yakalamayı denemesi gereken ödeme türü. Varsayılan olarak CARD_PRESENT.

Terminal kullanıma almayı iptal etme

İşlem Kimliği:

TerminalCancelCheckout

İsteğin durumu izin verirse Bir Terminal kullanıma alma isteğini iptal eder.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kullanıma Alma Kimliği	checkout_id	True	string	Kullanıma alma işleminin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	checkout.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Miktar	checkout.amount_money.amount	integer	Miktar.
Para birimi	checkout.amount_money.currency	string	Para birimi.
Başvuru Kimliği	checkout.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Cihaz Kimliği	checkout.device_options.device_id	string	Bu TerminalCheckout için tasarlanan cihazın benzersiz kimliği.
Ekran Alıntısına İzin Ver	checkout.device_options.tip_settings.allow_tipping	boolean	Bu ödeme için bahşiş vermenin etkinleştirilip etkinleştirilmediğini gösterir. Varsayılan değer false'tur.
Makbuz Ekranını Atla	checkout.device_options.skip_receipt_screen	boolean	Cihaza makbuz ekranını atlayıp atlamasını emreder. Varsayılan değer false'tur.
Statü	checkout.status	string	Bu nesnenin geçerli doğrulama durumu.
İptal Nedeni	checkout.cancel_reason	string	İptal edilen işlemin nedeni.
Oluşturma Tarihi	checkout.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	checkout.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Uygulama Kimliği	checkout.app_id	string	Kullanıma alma işlemini oluşturan uygulamanın kimliği.
Son Tarih Süresi	checkout.deadline_duration	string	Bir RFC 3339 süresi, ardından kullanıma alma işlemi otomatik olarak iptal edilir. BEKLEMEDE olan bir TerminalCheckout otomatik olarak İPTAL EDİlDİ ve iptal nedeni TIMED_OUT. Varsayılan: Oluşturmadan 5 dakika sonra

Terminal para iadelerinde arama

İşlem Kimliği:

TerminalSearchRefunds

İstekte bulunan satıcı tarafından oluşturulan Interac Terminal para iadesi isteklerinin filtrelenmiş listesini alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sınır	limit		integer	Tek bir sayfada döndürülecek sonuç sayısıyla ilgili bir sınır. Sınır danışmanlıktır; uygulama daha fazla veya daha az sonuç döndürebilir. Sağlanan sınır negatif, sıfır veya en yüksek sınır olan 1.000'den yüksekse, yoksayılır.
Statü	status		string	Geçerli durum.

Döndürülenler

Name	Yol	Tür	Description
Iadesi	refunds	array of object
Kimlik	refunds.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Para İadesi Kimliği	refunds.refund_id	string	Bu para iadesi için Kare tarafından oluşturulan benzersiz kimlik.
Ödeme Kimliği	refunds.payment_id	string	Ödemenin kimliği.
Miktar	refunds.amount_money.amount	integer	Miktar.
Para birimi	refunds.amount_money.currency	string	Para birimi.
Reason	refunds.reason	string	Kart sahibinin anlaşmazlığı bankasıyla başlatmasının anlaşmazlık nedeni.
Cihaz Kimliği	refunds.device_id	string	Bu kodu kullanan cihazın benzersiz kimliği. Cihaz eşlendiğinde doldurulur.
Son Tarih Süresi	refunds.deadline_duration	string	Bir RFC 3339 süresi, ardından kullanıma alma işlemi otomatik olarak iptal edilir. BEKLEMEDE olan bir TerminalCheckout otomatik olarak İPTAL EDİlDİ ve iptal nedeni TIMED_OUT. Varsayılan: Oluşturmadan 5 dakika sonra
Statü	refunds.status	string	Bu nesnenin geçerli doğrulama durumu.
Oluşturma Tarihi	refunds.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	refunds.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Uygulama Kimliği	refunds.app_id	string	Kullanıma alma işlemini oluşturan uygulamanın kimliği.
Kart Markası	refunds.card.card_brand	string	Kartın markası.
Son 4	refunds.card.last_4	string	Kart numarasının son 4 basamağı.
Sona Erme Ayı	refunds.card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Sona Erme Yılı	refunds.card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Parmak izi	refunds.card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
Kart Türü	refunds.card.card_type	string	Kartın türü.
BIN	refunds.card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı.
Sipariş Kimliği	refunds.order_id	string	Siparişin kimliği.
Konum Kimliği	refunds.location_id	string	Konumun tanımlayıcısı.

Terminal para iadesi alma

İşlem Kimliği:

TerminalGetRefund

Kimliğine göre Interac Terminal para iadesi nesnesi alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Terminal Para İadesi Kimliği	terminal_refund_id	True	string	Terminal para iadesinin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	refund.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Para İadesi Kimliği	refund.refund_id	string	Bu para iadesi için Kare tarafından oluşturulan benzersiz kimlik.
Ödeme Kimliği	refund.payment_id	string	Ödemenin benzersiz kimliği.
Miktar	refund.amount_money.amount	integer	Miktar.
Para birimi	refund.amount_money.currency	string	Para birimi.
Reason	refund.reason	string	Bu nesnenin nedeni.
Cihaz Kimliği	refund.device_id	string	Bu TerminalRefund için tasarlanan cihazın benzersiz kimliği.
Son Tarih Süresi	refund.deadline_duration	string	Bir RFC 3339 süresi, ardından kullanıma alma işlemi otomatik olarak iptal edilir. BEKLEMEDE olan bir TerminalCheckout otomatik olarak İPTAL EDİlDİ ve iptal nedeni TIMED_OUT. Varsayılan: Oluşturmadan 5 dakika sonra
Statü	refund.status	string	Bu nesnenin geçerli doğrulama durumu.
Oluşturma Tarihi	refund.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	refund.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Uygulama Kimliği	refund.app_id	string	Kullanıma alma işlemini oluşturan uygulamanın kimliği.
Kart Markası	refund.card.card_brand	string	Kartın markası.
last_4	refund.card.last_4	string	Kart numarasının son 4 basamağı.
Exp Ay	refund.card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Exp Yılı	refund.card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Parmak izi	refund.card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
Kart Türü	refund.card.card_type	string	Kartın türü.
BIN	refund.card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı.
Sipariş Kimliği	refund.order_id	string	Siparişin kimliği.
Konum Kimliği	refund.location_id	string	Konumun tanımlayıcısı.

Terminal para iadesi oluşturma

İşlem Kimliği:

TerminalCreateRefund

Kare Terminalde tamamlanan Interac ödemesi için para iadesi isteği oluşturur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.
Cihaz Kimliği	device_id		string	Bu TerminalRefund için tasarlanan cihazın benzersiz kimliği.
Reason	reason		string	Bu nesnenin nedeni.
Ödeme Kimliği	payment_id		string	Ödemenin benzersiz kimliği.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	refund.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Ödeme Kimliği	refund.payment_id	string	Ödemenin benzersiz kimliği.
Miktar	refund.amount_money.amount	integer	Miktar.
Para birimi	refund.amount_money.currency	string	Para birimi.
Reason	refund.reason	string	Bu nesnenin nedeni.
Cihaz Kimliği	refund.device_id	string	Bu TerminalRefund için tasarlanan cihazın benzersiz kimliği.
Son Tarih Süresi	refund.deadline_duration	string	Bir RFC 3339 süresi, ardından kullanıma alma işlemi otomatik olarak iptal edilir. BEKLEMEDE olan bir TerminalCheckout otomatik olarak İPTAL EDİlDİ ve iptal nedeni TIMED_OUT. Varsayılan: Oluşturmadan 5 dakika sonra
Statü	refund.status	string	Bu nesnenin geçerli doğrulama durumu.
Oluşturma Tarihi	refund.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	refund.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Uygulama Kimliği	refund.app_id	string	Kullanıma alma işlemini oluşturan uygulamanın kimliği.
Kart Markası	refund.card.card_brand	string	Kartın markası.
last_4	refund.card.last_4	string	Kart numarasının son 4 basamağı.
Exp Ay	refund.card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Exp Yılı	refund.card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Parmak izi	refund.card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
Kart Türü	refund.card.card_type	string	Kartın türü.
BIN	refund.card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı.
Sipariş Kimliği	refund.order_id	string	Siparişin kimliği.
Konum Kimliği	refund.location_id	string	Konumun tanımlayıcısı.

Terminal para iadesini iptal et

İşlem Kimliği:

TerminalCancelRefund

İsteğin durumu izin verirse, para iadesi isteği kimliğine göre Interac Terminal para iadesi isteğini iptal eder.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Terminal Para İadesi Kimliği	terminal_refund_id	True	string	Terminal para iadesinin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	refund.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Ödeme Kimliği	refund.payment_id	string	Ödemenin benzersiz kimliği.
Miktar	refund.amount_money.amount	integer	Miktar.
Para birimi	refund.amount_money.currency	string	Para birimi.
Reason	refund.reason	string	Bu nesnenin nedeni.
Cihaz Kimliği	refund.device_id	string	Bu TerminalRefund için tasarlanan cihazın benzersiz kimliği.
Son Tarih Süresi	refund.deadline_duration	string	Bir RFC 3339 süresi, ardından kullanıma alma işlemi otomatik olarak iptal edilir. BEKLEMEDE olan bir TerminalCheckout otomatik olarak İPTAL EDİlDİ ve iptal nedeni TIMED_OUT. Varsayılan: Oluşturmadan 5 dakika sonra
Statü	refund.status	string	Bu nesnenin geçerli doğrulama durumu.
İptal Nedeni	refund.cancel_reason	string	İptal edilen işlemin nedeni.
Oluşturma Tarihi	refund.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	refund.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Uygulama Kimliği	refund.app_id	string	Kullanıma alma işlemini oluşturan uygulamanın kimliği.
Kart Markası	refund.card.card_brand	string	Kartın markası.
last_4	refund.card.last_4	string	Kart numarasının son 4 basamağı.
Exp Ay	refund.card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Exp Yılı	refund.card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Parmak izi	refund.card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
Kart Türü	refund.card.card_type	string	Kartın türü.
BIN	refund.card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı.
Sipariş Kimliği	refund.order_id	string	Siparişin kimliği.
Konum Kimliği	refund.location_id	string	Konumun tanımlayıcısı.

Terminal ödemesi alma

İşlem Kimliği:

TerminalGetCheckout

checkout_id tarafından bir Terminal kullanıma alma isteği alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kullanıma Alma Kimliği	checkout_id	True	string	Kullanıma alma işleminin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	checkout.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Miktar	checkout.amount_money.amount	integer	Miktar.
Para birimi	checkout.amount_money.currency	string	Para birimi.
Başvuru Kimliği	checkout.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Uyarı	checkout.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
Cihaz Kimliği	checkout.device_options.device_id	string	Bu TerminalCheckout için tasarlanan cihazın benzersiz kimliği.
Ekran Alıntısına İzin Ver	checkout.device_options.tip_settings.allow_tipping	boolean	Bu ödeme için bahşiş vermenin etkinleştirilip etkinleştirilmediğini gösterir. Varsayılan değer false'tur.
Makbuz Ekranını Atla	checkout.device_options.skip_receipt_screen	boolean	Cihaza makbuz ekranını atlayıp atlamasını emreder. Varsayılan değer false'tur.
Statü	checkout.status	string	Bu nesnenin geçerli doğrulama durumu.
Oluşturma Tarihi	checkout.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	checkout.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Uygulama Kimliği	checkout.app_id	string	Kullanıma alma işlemini oluşturan uygulamanın kimliği.
Son Tarih Süresi	checkout.deadline_duration	string	Bir RFC 3339 süresi, ardından kullanıma alma işlemi otomatik olarak iptal edilir. BEKLEMEDE olan bir TerminalCheckout otomatik olarak İPTAL EDİlDİ ve iptal nedeni TIMED_OUT. Varsayılan: Oluşturmadan 5 dakika sonra

Toplu alma siparişleri

İşlem Kimliği:

OrderBatchRetrieve

Kimliklerine göre bir dizi siparişi alır. Belirli bir sipariş kimliği yoksa, bir hata oluşturmak yerine kimlik yoksayılır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Konum Kimliği	location_id		string	Konum tanımlayıcısı.
Kimlikleri sırala	order_ids		array of string

Döndürülenler

Name	Yol	Tür	Description
Sipariş	orders	array of object
Kimlik	orders.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	orders.location_id	string	Konumun tanımlayıcısı.
Başvuru Kimliği	orders.reference_id	string	Müşteri profilini başka bir sistemdeki bir varlıkla ilişkilendirmek için kullanılan isteğe bağlı ikinci kimlik.
Satır Öğeleri	orders.line_items	array of object
UID	orders.line_items.uid	string	Faturadaki ödeme isteğinin Kare olarak oluşturulan kimliği.
İsim	orders.line_items.name	string	İnsan tarafından okunabilen bir isim.
Miktar	orders.line_items.quantity	string	Satın alınan ve ondalık sayı olarak biçimlendirilmiş miktar.
Miktar	orders.line_items.base_price_money.amount	integer	Miktar.
Para birimi	orders.line_items.base_price_money.currency	string	Para birimi.
Miktar	orders.line_items.total_money.amount	integer	Miktar.
Para birimi	orders.line_items.total_money.currency	string	Para birimi.
Miktar	orders.total_money.amount	integer	Miktar.
Para birimi	orders.total_money.currency	string	Para birimi.

Toplu alma stok sayıları

İşlem Kimliği:

InventoryBatchRetrieveCounts

İstenen Konumlarda sağlanan CatalogObjects için geçerli sayıları döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Katalog Nesne Kimlikleri	catalog_object_ids		array of string
Konum Kimlikleri	location_ids		array of string
Sonra Güncelleştirildi	updated_after		string	Rfc 3339 zaman damgasında belirtilen süreden sonra sonuçları calculated_at değeriyle döndürme filtresi.

Döndürülenler

Name	Yol	Tür	Description
Sayar	counts	array of object
Katalog Nesne Kimliği	counts.catalog_object_id	string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
Katalog Nesne Türü	counts.catalog_object_type	string	İzlenen CatalogObject türü.
Devlet	counts.state	string	Geçerli durum.
Konum Kimliği	counts.location_id	string	Konumun tanımlayıcısı.
Miktar	counts.quantity	string	Ondalık dize olarak tahmini sayıdan etkilenen öğe sayısı. Ondalık ayırıcıdan sonra en fazla 5 basamak destekleyebilir.
Hesaplanacak Yer	counts.calculated_at	string	Tahmini sayıyı etkileyen en son fiziksel sayının veya ayarlamanın ne zaman alındığını gösteren RFC 3339 biçimli zaman damgası.

Toplu değişiklik envanteri

İşlem Kimliği:

InventoryBatchChange

Sağlanan madde miktarlarına düzeltmeler ve sayımlar uygular. Başarılı olduğunda: İstekte başvuruda bulunılan tüm nesneler için geçerli hesaplanan sayıları döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Türü	type		string	Bu nesnenin türü.
Başvuru Kimliği	reference_id		string	Bu kartı bir dış sistemdeki başka bir varlıkla ilişkilendiren isteğe bağlı kullanıcı tanımlı başvuru kimliği.
Katalog Nesne Kimliği	catalog_object_id		string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
Devlet	state		string	İlgili madde miktarı için geçerli stok durumu.
Konum Kimliği	location_id		string	Bu ihalenin bir kısmını alan alıcının (satıcı dışında) konum kimliği.
Miktar	quantity		string	Fiziksel sayının ondalık dize olarak etkilediği öğe sayısı. Sayı, ondalık ayırıcıdan sonra en çok 5 basamağı destekleyebilir.
Çalışan Kimliği	employee_id		string	Fiziksel sayıdan sorumlu Çalışanın Kare olarak oluşturulan kimliği.
Oluştuğu Yer	occurred_at		string	Fiziksel sayının ne zaman incelendiğini gösteren istemci tarafından oluşturulan RFC 3339 biçimli zaman damgası. Fiziksel sayım güncelleştirmeleri için, occurred_at zaman damgası isteğin zamanına göre 24 saatten eski veya gelecekte olamaz.
Değişmemiş Sayıları Yoksay	ignore_unchanged_counts		boolean	Son fiziksel sayıdan bu yana miktarın değişmemesi durumunda geçerli fiziksel sayın yoksayılıp yoksayılmayacağını gösterir.

Döndürülenler

Name	Yol	Tür	Description
Sayar	counts	array of object
Katalog Nesne Kimliği	counts.catalog_object_id	string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
Katalog Nesne Türü	counts.catalog_object_type	string	İzlenen CatalogObject türü.
Devlet	counts.state	string	Geçerli durum.
Konum Kimliği	counts.location_id	string	Konumun tanımlayıcısı.
Miktar	counts.quantity	string	Ondalık dize olarak tahmini sayıdan etkilenen öğe sayısı. Ondalık ayırıcıdan sonra en fazla 5 basamak destekleyebilir.
Hesaplanacak Yer	counts.calculated_at	string	Tahmini sayıyı etkileyen en son fiziksel sayının veya ayarlamanın ne zaman alındığını gösteren RFC 3339 biçimli zaman damgası.

Toplu işlem katalog nesnelerini alma

İşlem Kimliği:

CatalogBatchRetrieve

Sağlanan kimliği temel alan bir nesne kümesi döndürür. Kümede döndürülen her CatalogItem, aşağıdakiler dahil olmak üzere tüm alt bilgilerini içerir: tüm CatalogItemVariation nesneleri, CatalogModifierList nesnelerine yapılan başvurular ve buna uygulanan tüm CatalogTax nesnelerinin kimlikleri.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Nesne Kimlikleri	object_ids		array of string
Katalog Sürümü	catalog_version		integer	Yanıta eklenecek katalog nesnelerinin belirli sürümü. Bu, nesnelerin geçmiş sürümlerini almanıza olanak tanır. Belirtilen sürüm değeri, CatalogObjects'in sürüm özniteliğiyle eşleştirilir.
İlgili Nesneleri Ekle	include_related_objects		boolean	True ise, yanıt aşağıdaki gibi istenen nesnelerle ilgili ek nesneler içerir: Yanıtın nesne alanı bir CatalogItem içeriyorsa, yanıtın related_objects alanında ilişkili CatalogCategory nesneleri, CatalogTax nesneleri, CatalogImage nesneleri ve CatalogModifierLists döndürülür. Yanıtın nesne alanı bir CatalogItemVariation içeriyorsa, üst CatalogItem yanıtın related_objects alanında döndürülür.

Döndürülenler

Name	Yol	Tür	Description
Objects	objects	array of object
Türü	objects.type	string	Bu nesnenin türü.
Kimlik	objects.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Güncelleştirme Tarihi:	objects.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Sürüm	objects.version	integer	Nesnenin geçerli sürümü.
Silindi	objects.is_deleted	boolean	True ise, nesne veritabanından silinmiştir. Eklenen yeni nesneler için false olmalıdır. Silindiğinde, updated_at alanı silme süresine eşit olur.
Tüm Konumlarda Mevcut	objects.present_at_all_locations	boolean	True ise, bu nesne absent_at_location_ids alanında belirtilen yerler dışında tüm konumlarda (gelecekteki konumlar dahil) bulunur. False ise, bu nesne present_at_location_ids alanında belirtilen yerler dışında hiçbir konumda (gelecekteki konumlar dahil) mevcut değildir. Belirtilmezse, varsayılan değer true olur.
İsim	objects.item_data.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Description	objects.item_data.title	string	Öğenin açıklaması. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir ve değer uzunluğu Unicode kod noktalarıdır.
Kategori Kimliği	objects.item_data.category_id	string	Varsa, öğenin kategorisinin kimliği.
Vergi kimlikleri	objects.item_data.tax_ids	array of string
Varyasyon -ları	objects.item_data.variations	array of object
Türü	objects.item_data.variations.type	string	Bu nesnenin türü. Her nesne türü, aşağıdaki ilgili *_data alanı içinde yapılandırılmış biçimde ifade edilen beklenen özelliklere sahiptir.
Kimlik	objects.item_data.variations.id	string	Bu nesneye başvurmak için bir tanımlayıcı.
Güncelleştirme Tarihi:	objects.item_data.variations.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Sürüm	objects.item_data.variations.version	integer	Nesnenin sürümü. Bir nesneyi güncelleştirirken, sağlanan sürüm veritabanındaki sürümle eşleşmelidir, aksi takdirde yazma işlemi çakışan olarak reddedilir.
Silindi	objects.item_data.variations.is_deleted	boolean	True ise, nesne veritabanından silinmiştir. Eklenen yeni nesneler için false olmalıdır. Silindiğinde, updated_at alanı silme süresine eşit olur.
Tüm Konumlarda Mevcut	objects.item_data.variations.present_at_all_locations	boolean	present_at_all_locations false olsa bile nesnenin bulunduğu konumların listesi. Bu, devre dışı bırakılan konumları içerebilir.
Öğe Kimliği	objects.item_data.variations.item_variation_data.item_id	string	Bu öğe varyasyonu olan nesnenin kimliği.
İsim	objects.item_data.variations.item_variation_data.name	string	Bu öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir ve değer uzunluğu Unicode kod noktalarıdır.
Sıralı	objects.item_data.variations.item_variation_data.ordinal	integer	Bu öğe varyasyonunun görüntülenme sırası. Bu değer salt okunurdur.
Fiyatlandırma Türü	objects.item_data.variations.item_variation_data.pricing_type	string	Madde varyasyonunun fiyatının sabit olup olmadığını veya satış sırasında belirlenip belirlenmediğini gösterir.
Miktar	objects.item_data.variations.item_variation_data.price_money.amount	integer	Para birimiyle belirtilen para biriminin en küçük paydasında yer alan para miktarı. Örneğin, para birimi ABD doları olduğunda tutar cent cinsindendir. Parasal tutarlar pozitif veya negatif olabilir. Belirli bir durumdaki işaretin anlamını belirlemek için belirli alan açıklamasına bakın.
Para birimi	objects.item_data.variations.item_variation_data.price_money.currency	string	ISO 4217 biçimindeki para biriminin türü. Örneğin, ABD doları için para birimi kodu ABD dolarıdır.
İlgili Nesneler	related_objects	array of object
Türü	related_objects.type	string	Bu nesnenin türü.
Kimlik	related_objects.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Güncelleştirme Tarihi:	related_objects.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Sürüm	related_objects.version	integer	Nesnenin geçerli sürümü.
Silindi	related_objects.is_deleted	boolean	True ise, nesne veritabanından silinmiştir. Eklenen yeni nesneler için false olmalıdır. Silindiğinde, updated_at alanı silme süresine eşit olur.
Tüm Konumlarda Mevcut	related_objects.present_at_all_locations	boolean	True ise, bu nesne absent_at_location_ids alanında belirtilen yerler dışında tüm konumlarda (gelecekteki konumlar dahil) bulunur. False ise, bu nesne present_at_location_ids alanında belirtilen yerler dışında hiçbir konumda (gelecekteki konumlar dahil) mevcut değildir. Belirtilmezse, varsayılan değer true olur.
İsim	related_objects.category_data.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
İsim	related_objects.tax_data.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Hesaplama Aşaması	related_objects.tax_data.calculation_phase	string	Verginin bir ödemenin alt toplamına veya toplamına göre hesaplanıp hesaplanmadığı.
Ekleme Türü	related_objects.tax_data.inclusion_type	string	Verginin EKLENEBILIR mi yoksa KAPSAYıCı mı olduğu.
Yüzde	related_objects.tax_data.percentage	string	Ondalık ayırıcı olarak '.' kullanan ve '%' işareti olmayan ondalık biçimindeki yüzde. 7,5 değeri,%7,5'e karşılık gelir.
Etkinleştirildi	related_objects.tax_data.enabled	boolean	Bir nesnenin kullanılıp kullanılamayacağını gösterir.

Toplu olarak stok değişikliklerini alma

İşlem Kimliği:

InventoryBatchRetrieveChanges

Sağlanan filtre ölçütlerine göre geçmiş fiziksel sayıları ve ayarlamaları döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Katalog Nesne Kimlikleri	catalog_object_ids		array of string
Konum Kimlikleri	location_ids		array of string
Türler	types		array of string
States	states		array of string
Sonra Güncelleştirildi	updated_after		string	Rfc 3339 zaman damgasında belirtilen süreden sonra sonuçları calculated_at değeriyle döndürme filtresi.
Önce Güncelleştirildi	updated_before		string	Rfc 3339 zaman damgasında belirtilen süreden önce sonuçları created_at veya calculated_at değeriyle döndüren filtre.

Döndürülenler

Name	Yol	Tür	Description
Changes	changes	array of object
Türü	changes.type	string	Bu nesnenin türü.
Kimlik	changes.physical_count.id	string	Nesnenin tanımlayıcısı
Başvuru Kimliği	changes.physical_count.reference_id	string	Bu kartı bir dış sistemdeki başka bir varlıkla ilişkilendiren isteğe bağlı kullanıcı tanımlı başvuru kimliği.
Katalog Nesne Kimliği	changes.physical_count.catalog_object_id	string	İzlenen CatalogObject'in Kare olarak oluşturulan kimliği.
Katalog Nesne Türü	changes.physical_count.catalog_object_type	string	İzlenen CatalogObject türü.
Devlet	changes.physical_count.state	string	İlgili madde miktarı için geçerli stok durumu.
Konum Kimliği	changes.physical_count.location_id	string	Bu ihalenin bir kısmını alan alıcının (satıcı dışında) konum kimliği.
Miktar	changes.physical_count.quantity	string	Fiziksel sayının ondalık dize olarak etkilediği öğe sayısı. Sayı, ondalık ayırıcıdan sonra en çok 5 basamağı destekleyebilir.
Ürün	changes.physical_count.source.product	string	Uygulamanın ürün türü.
Uygulama Kimliği	changes.physical_count.source.application_id	string	Uygulamaya atanan Kare Kimlik.
İsim	changes.physical_count.source.name	string	Öğenin adı.
Çalışan Kimliği	changes.physical_count.employee_id	string	Fiziksel sayıdan sorumlu Çalışanın Kare olarak oluşturulan kimliği.
Oluştuğu Yer	changes.physical_count.occurred_at	string	Fiziksel sayının ne zaman incelendiğini gösteren istemci tarafından oluşturulan RFC 3339 biçimli zaman damgası. Fiziksel sayım güncelleştirmeleri için, occurred_at zaman damgası isteğin zamanına göre 24 saatten eski veya gelecekte olamaz.
Oluşturma Tarihi	changes.physical_count.created_at	string	Fiziksel sayının ne zaman oluşturulduğunu gösteren istemci tarafından oluşturulan RFC 3339 biçimli zaman damgası.

Toplu upsert katalog nesneleri

İşlem Kimliği:

CatalogBatchUpsert

Sağlanan nesne listesine göre en fazla 10.000 hedef nesne oluşturur veya güncelleştirir. Hedef nesneler toplu olarak gruplandırılır ve her toplu iş tümü veya hiç şeklinde eklenir/güncelleştirilir. Toplu iş içindeki bir nesne bir şekilde yanlış biçimlendirilmişse veya veritabanı kısıtlamasını ihlal ederse, söz konusu öğeyi içeren tüm toplu iş göz ardı edilir. Ancak, aynı istekteki diğer toplu işlemler yine de başarılı olabilir. Her toplu işlem en fazla 1.000 nesne içerebilir ve istek için toplam nesne sayısı (öğeler, varyasyonlar, değiştirici listeler, indirimler ve vergiler) 10.000'den fazla olmadığı sürece toplu işlemler sırayla işlenir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Türü	type		string	Bu nesnenin türü.
Kimlik	id		string	Bu nesneye başvurmak için bir tanımlayıcı.
Tüm Konumlarda Mevcut	present_at_all_locations		boolean	True ise, bu nesne absent_at_location_ids alanında belirtilen yerler dışında tüm konumlarda (gelecekteki konumlar dahil) bulunur. False ise, bu nesne present_at_location_ids alanında belirtilen yerler dışında hiçbir konumda (gelecekteki konumlar dahil) mevcut değildir. Belirtilmezse, varsayılan değer true olur.
İsim	name		string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Description	title		string	Öğenin açıklaması. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir ve değer uzunluğu Unicode kod noktalarıdır.
Kategori Kimliği	category_id		string	Varsa, öğenin kategorisinin kimliği.
Vergi kimlikleri	tax_ids		array of string
Türü	type		string	Bu nesnenin türü. Her nesne türü, aşağıdaki ilgili *_data alanı içinde yapılandırılmış biçimde ifade edilen beklenen özelliklere sahiptir.
Kimlik	id		string	Bu nesneye başvurmak için bir tanımlayıcı.
Tüm Konumlarda Mevcut	present_at_all_locations		boolean	Tüm konumlarda bulunup bulunmadığı.
Öğe Kimliği	item_id		string	Öğenin tanımlayıcısı.
İsim	name		string	Öğenin adı.
Fiyatlandırma Türü	pricing_type		string	Fiyatlandırma türü.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.
İsim	name		string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
İsim	name		string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Hesaplama Aşaması	calculation_phase		string	Verginin bir ödemenin alt toplamına veya toplamına göre hesaplanıp hesaplanmadığı.
Ekleme Türü	inclusion_type		string	Verginin EKLENEBILIR mi yoksa KAPSAYıCı mı olduğu.
Yüzde	percentage		string	Ondalık ayırıcı olarak '.' kullanan ve '%' işareti olmayan ondalık biçimindeki vergi yüzdesi. 7,5 değeri,%7,5'e karşılık gelir.
Özel Tutarlar için geçerlidir	applies_to_custom_amounts		boolean	Doğruysa, ücret Belirli bir CatalogItem ile ilişkilendirilmemiş Olan Satış Noktası Kare uygulamasına girilen özel tutarlar için geçerlidir.
Etkinleştirildi	enabled		boolean	Satış Noktası Karesi uygulamasında verginin etkin (true) olarak görüntülenip görüntülenmeyeceğini (false) belirten boole bayrağı.

Döndürülenler

Name	Yol	Tür	Description
Objects	objects	array of object
Türü	objects.type	string	Bu nesnenin türü.
Kimlik	objects.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Güncelleştirme Tarihi:	objects.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Sürüm	objects.version	integer	Nesnenin geçerli sürümü.
Silindi	objects.is_deleted	boolean	True ise, nesne veritabanından silinmiştir. Eklenen yeni nesneler için false olmalıdır. Silindiğinde, updated_at alanı silme süresine eşit olur.
Tüm Konumlarda Mevcut	objects.present_at_all_locations	boolean	True ise, bu nesne absent_at_location_ids alanında belirtilen yerler dışında tüm konumlarda (gelecekteki konumlar dahil) bulunur. False ise, bu nesne present_at_location_ids alanında belirtilen yerler dışında hiçbir konumda (gelecekteki konumlar dahil) mevcut değildir. Belirtilmezse, varsayılan değer true olur.
İsim	objects.item_data.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Description	objects.item_data.title	string	Öğenin açıklaması. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir ve değer uzunluğu Unicode kod noktalarıdır.
Kategori Kimliği	objects.item_data.category_id	string	Varsa, öğenin kategorisinin kimliği.
Vergi kimlikleri	objects.item_data.tax_ids	array of string
Varyasyon -ları	objects.item_data.variations	array of object
Türü	objects.item_data.variations.type	string	Bu nesnenin türü. Her nesne türü, aşağıdaki ilgili *_data alanı içinde yapılandırılmış biçimde ifade edilen beklenen özelliklere sahiptir.
Kimlik	objects.item_data.variations.id	string	Bu nesneye başvurmak için bir tanımlayıcı.
Güncelleştirme Tarihi:	objects.item_data.variations.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Sürüm	objects.item_data.variations.version	integer	Nesnenin sürümü. Bir nesneyi güncelleştirirken, sağlanan sürüm veritabanındaki sürümle eşleşmelidir, aksi takdirde yazma işlemi çakışan olarak reddedilir.
Silindi	objects.item_data.variations.is_deleted	boolean	True ise, nesne veritabanından silinmiştir. Eklenen yeni nesneler için false olmalıdır. Silindiğinde, updated_at alanı silme süresine eşit olur.
Tüm Konumlarda Mevcut	objects.item_data.variations.present_at_all_locations	boolean	present_at_all_locations false olsa bile nesnenin bulunduğu konumların listesi. Bu, devre dışı bırakılan konumları içerebilir.
Öğe Kimliği	objects.item_data.variations.item_variation_data.item_id	string	Bu öğe varyasyonu olan nesnenin kimliği.
İsim	objects.item_data.variations.item_variation_data.name	string	Bu öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir ve değer uzunluğu Unicode kod noktalarıdır.
Sıralı	objects.item_data.variations.item_variation_data.ordinal	integer	Bu öğe varyasyonunun görüntülenme sırası. Bu değer salt okunurdur.
Fiyatlandırma Türü	objects.item_data.variations.item_variation_data.pricing_type	string	Madde varyasyonunun fiyatının sabit olup olmadığını veya satış sırasında belirlenip belirlenmediğini gösterir.
Miktar	objects.item_data.variations.item_variation_data.price_money.amount	integer	Para birimiyle belirtilen para biriminin en küçük paydasında yer alan para miktarı. Örneğin, para birimi ABD doları olduğunda tutar cent cinsindendir. Parasal tutarlar pozitif veya negatif olabilir. Belirli bir durumdaki işaretin anlamını belirlemek için belirli alan açıklamasına bakın.
Para birimi	objects.item_data.variations.item_variation_data.price_money.currency	string	ISO 4217 biçimindeki para biriminin türü. Örneğin, ABD doları için para birimi kodu ABD dolarıdır.
İsim	objects.category_data.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
İsim	objects.tax_data.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Hesaplama Aşaması	objects.tax_data.calculation_phase	string	Verginin bir ödemenin alt toplamına veya toplamına göre hesaplanıp hesaplanmadığı.
Ekleme Türü	objects.tax_data.inclusion_type	string	Verginin EKLENEBILIR mi yoksa KAPSAYıCı mı olduğu.
Yüzde	objects.tax_data.percentage	string	Ondalık ayırıcı olarak '.' kullanan ve '%' işareti olmayan ondalık biçimindeki yüzde. 7,5 değeri,%7,5'e karşılık gelir.
Özel Tutarlara Uygulanır	objects.tax_data.applies_to_custom_amounts	boolean	Doğruysa, ücret Belirli bir CatalogItem ile ilişkilendirilmemiş Olan Satış Noktası Kare uygulamasına girilen özel tutarlar için geçerlidir.
Etkinleştirildi	objects.tax_data.enabled	boolean	Bir nesnenin kullanılıp kullanılamayacağını gösterir.
Kimlik Eşlemeleri	id_mappings	array of object
İstemci Nesne Kimliği	id_mappings.client_object_id	string	yeni bir CatalogObject için istemci tarafından sağlanan geçici #ön ekli kimlik.
Nesne kimliği	id_mappings.object_id	string	Sunucu tarafından oluşturulan kalıcı kimlik.

Upsert katalog nesnesi

İşlem Kimliği:

CatalogUpsert

Hedef CatalogObject'i oluşturur veya güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Kimlik	id		string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Türü	type		string	Bu nesnenin türü.
Abbreviation	abbreviation		string	Ürünün Satış Noktası Kare uygulamasındaki görüntü etiketinin metni. Dizenin yalnızca ilk beş karakteri kullanılır. Bu öznitelik aranabilir ve değer uzunluğu Unicode kod noktalarıdır.
Description	title		string	Öğenin açıklaması. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir ve değer uzunluğu Unicode kod noktalarıdır.
İsim	name		string	Adı.
Kimlik	id		string	Katalogda bu nesneye başvurmak için bir tanımlayıcı.
Türü	type		string	Bu nesnenin türü.
Öğe Kimliği	item_id		string	Bu öğe varyasyonuyla ilişkili CatalogItem kimliği.
İsim	name		string	Öğe varyasyonunun adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir ve değer uzunluğu Unicode kod noktalarıdır.
Fiyatlandırma Türü	pricing_type		string	Madde varyasyonunun fiyatının sabit olup olmadığını veya satış sırasında belirlenip belirlenmediğini gösterir.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.

Döndürülenler

Name	Yol	Tür	Description
Türü	catalog_object.type	string	Bu nesnenin türü.
Kimlik	catalog_object.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Güncelleştirme Tarihi:	catalog_object.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Sürüm	catalog_object.version	integer	Bu nesnenin geçerli sürümü.
Silindi	catalog_object.is_deleted	boolean	True ise, nesne veritabanından silinmiştir. Eklenen yeni nesneler için false olmalıdır. Silindiğinde, updated_at alanı silme süresine eşit olur.
present_at_all_locations	catalog_object.present_at_all_locations	boolean	True ise, bu nesne absent_at_location_ids alanında belirtilen yerler dışında tüm konumlarda (gelecekteki konumlar dahil) bulunur. False ise, bu nesne present_at_location_ids alanında belirtilen yerler dışında hiçbir konumda (gelecekteki konumlar dahil) mevcut değildir. Belirtilmezse, varsayılan değer true olur.
İsim	catalog_object.item_data.name	string	Adı.
Description	catalog_object.item_data.title	string	Öğenin açıklaması. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir ve değer uzunluğu Unicode kod noktalarıdır.
Abbreviation	catalog_object.item_data.abbreviation	string	Ürünün Satış Noktası Kare uygulamasındaki görüntü etiketinin metni. Dizenin yalnızca ilk beş karakteri kullanılır. Bu öznitelik aranabilir ve değer uzunluğu Unicode kod noktalarıdır.
Varyasyon -ları	catalog_object.item_data.variations	array of object
Türü	catalog_object.item_data.variations.type	string	Bu nesnenin türü.
Kimlik	catalog_object.item_data.variations.id	string	Katalogda bu nesneye başvurmak için bir tanımlayıcı.
Güncelleştirme Tarihi:	catalog_object.item_data.variations.updated_at	string	RFC 3339 biçimindeki son değişiklik zaman damgası.
Sürüm	catalog_object.item_data.variations.version	integer	Nesnenin sürümü. Bir nesneyi güncelleştirirken, sağlanan sürüm veritabanındaki sürümle eşleşmelidir, aksi takdirde yazma işlemi çakışan olarak reddedilir.
Silindi	catalog_object.item_data.variations.is_deleted	boolean	True ise, nesne veritabanından silinmiştir. Eklenen yeni nesneler için false olmalıdır. Silindiğinde, updated_at alanı silme süresine eşit olur.
Tüm Konumlarda Mevcut	catalog_object.item_data.variations.present_at_all_locations	boolean	True ise, bu nesne absent_at_location_ids alanında belirtilen yerler dışında tüm konumlarda (gelecekteki konumlar dahil) bulunur. False ise, bu nesne present_at_location_ids alanında belirtilen yerler dışında hiçbir konumda (gelecekteki konumlar dahil) mevcut değildir. Belirtilmezse, varsayılan değer true olur.
Öğe Kimliği	catalog_object.item_data.variations.item_variation_data.item_id	string	Bu öğe varyasyonuyla ilişkili CatalogItem kimliği.
İsim	catalog_object.item_data.variations.item_variation_data.name	string	Öğe varyasyonunun adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir ve değer uzunluğu Unicode kod noktalarıdır.
Sıralı	catalog_object.item_data.variations.item_variation_data.ordinal	integer	Bu öğe varyasyonunun görüntülenme sırası. Bu değer salt okunurdur. Yazma işlemlerinde, bir üst CatalogItem içindeki her öğe varyasyonu için sıra, öğe varyasyonlarının konumuna göre ayarlanır. Okumalarda, değerin sıralı veya benzersiz olması garanti edilmemektedir.
Fiyatlandırma Türü	catalog_object.item_data.variations.item_variation_data.pricing_type	string	Madde varyasyonunun fiyatının sabit olup olmadığını veya satış sırasında belirlenip belirlenmediğini gösterir.
Stoklanabilir	catalog_object.item_data.variations.item_variation_data.stockable	boolean	Hisse senedinin doğrudan bu varyasyona mı (DOĞRU) yoksa yalnızca bileşenlerine mi (YANLIŞ) sayılıp sayılmadığı. Geriye dönük uyumluluk için eksik değerler TRUE olarak yorumlanır.
Miktar	catalog_object.item_data.variations.item_variation_data.price_money.amount	integer	Miktar.
Para birimi	catalog_object.item_data.variations.item_variation_data.price_money.currency	string	Para birimi.
Ürün Türü	catalog_object.item_data.product_type	string	Öğenin ürün türü. Bir öğe oluşturulduktan sonra değiştirilemez.
Kimlik Eşlemeleri	id_mappings	array of object
İstemci Nesne Kimliği	id_mappings.client_object_id	string	yeni bir CatalogObject için istemci tarafından sağlanan geçici #ön ekli kimlik.
Nesne kimliği	id_mappings.object_id	string	Sunucu tarafından oluşturulan kalıcı kimlik.

Uyuşmazlık kanıtlarını listeleme

İşlem Kimliği:

DisputeListEvidence

Bir anlaşmazlıkla ilişkili kanıtların listesini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Uyuşmazlık Kimliği	dispute_id	True	string	İtirazın tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Evidence	evidence	array of object
Kimlik	evidence.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Uyuşmazlık Kimliği	evidence.dispute_id	string	Kanıtın ilişkili olduğu uyuşmazlığın kimliği.
Kanıt Metni	evidence.evidence_text	string	Ham metin.
Kanıt Türü	evidence.evidence_type	string	Kanıtın türü.
Karşıya Yükleme:	evidence.uploaded_at	string	Rfc 3339 biçiminde bir sonraki eylemin son tarihi.
Kanıt Kimliği	evidence.evidence_id	string	Kanıtın Kare olarak oluşturulan kimliği.
Filename	evidence.evidence_file.filename	string	Dosya uzantısını içeren dosya adı
Dosya Türü	evidence.evidence_file.filetype	string	Anlaşmazlık kanıt dosyaları uygulama/pdf, görüntü/heic, image/heif, image/jpeg, image/png veya image/tiff biçimleri olmalıdır.
Cursor	cursor	string	Özgün sorguyla ilişkili sonraki sonuç kümesini almak için sayfalandırma imlecini bu uç noktaya yapılan sonraki çağrılara ekleyin.

Uyuşmazlık kanıtı metni oluşturma

İşlem Kimliği:

DisputeCreateEvidenceText

Uyuşmazlık sınaması için kanıt olarak kullanılacak metni karşıya yükler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Uyuşmazlık Kimliği	dispute_id	True	string	İtirazın tanımlayıcısı.
Kanıt Türü	evidence_type		string	Karşıya yüklediğiniz kanıt türü.
Kanıt Metni	evidence_text		string	Kanıt dizesi.
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	evidence.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Uyuşmazlık Kimliği	evidence.dispute_id	string	Kanıtın ilişkili olduğu uyuşmazlığın kimliği.
Kanıt Metni	evidence.evidence_text	string	Ham metin.
Kanıt Türü	evidence.evidence_type	string	Tür pf kanıtı.
Karşıya Yükleme:	evidence.uploaded_at	string	Rfc 3339 biçiminde bir sonraki eylemin son tarihi.

Uyuşmazlıkları listeleme

İşlem Kimliği:

DisputeList

Belirli bir hesapla ilişkili anlaşmazlıkların listesini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Cursor	cursor		string	Bu uç noktaya önceki bir çağrı tarafından döndürülen sayfalandırma imleci.
States	states		string	Anlaşmazlık sonucu filtrelemeyi belirtir. Belirtilmezse uç nokta tüm açık anlaşmazlıkları döndürür (anlaşmazlık durumu INQUIRY_CLOSED, KAZANILMAZ veya KAYIP değildir).
Konum Kimliği	location_id		string	Yalnızca belirli bir konuma ait kayıtları almak için bu isteğe bağlı filtreyi belirtebilirsiniz.

Döndürülenler

Name	Yol	Tür	Description
Sorunlar	disputes	array of object
Kimlik	disputes.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Miktar	disputes.amount_money.amount	integer	Miktar.
Para birimi	disputes.amount_money.currency	string	Para birimi.
Reason	disputes.reason	string	Kart sahibinin anlaşmazlığı bankasıyla başlatmasının anlaşmazlık nedeni.
Devlet	disputes.state	string	Geçerli durum.
Son Tarih	disputes.due_at	string	Rfc 3339 biçiminde bir sonraki eylemin son tarihi.
Tartışmalı Ödemeler	disputes.disputed_payments	array of object
Ödeme Kimliği	disputes.disputed_payments.payment_id	string	İtiraz edilen ödemenin kare olarak oluşturulan benzersiz kimliği.
Kart Markası	disputes.card_brand	string	Tartışmalı ödemede kullanılan kart markası.
Oluşturma Tarihi	disputes.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	disputes.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Marka Uyuşmazlığı Kimliği	disputes.brand_dispute_id	string	Kart markası tarafından oluşturulan kart markası sistemindeki uyuşmazlığın kimliği.
Cursor	cursor	string	Özgün sorguyla ilişkili sonraki sonuç kümesini almak için sayfalandırma imlecini bu uç noktaya yapılan sonraki çağrılara ekleyin.

Uyuşmazlığı kabul et

İşlem Kimliği:

DisputeAccept

Bir anlaşmazlıkta kaybı kabul eder. Square, tartışmalı tutarı kart sahibine iade ederek anlaşmazlık durumunu KABUL EDİLEN olarak güncelleştirir. İtiraz edilen tutarı satıcının Kare hesabından borç olarak alır. Square hesabında yeterli fon yoksa, Square ilişkili banka hesabını borç olarak alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Uyuşmazlık Kimliği	dispute_id	True	string	İtirazın tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	dispute.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Miktar	dispute.amount_money.amount	integer	Miktar.
Para birimi	dispute.amount_money.currency	string	Para birimi.
Reason	dispute.reason	string	Bu nesnenin nedeni.
Devlet	dispute.state	string	Geçerli durum.
Son Tarih	dispute.due_at	string	Rfc 3339 biçiminde bir sonraki eylemin son tarihi.
Tartışmalı Ödemeler	dispute.disputed_payments	array of object
Ödeme Kimliği	dispute.disputed_payments.payment_id	string	Ödemenin kare olarak oluşturulan benzersiz kimliği.
Kart Markası	dispute.card_brand	string	Kartın markası.
Oluşturma Tarihi	dispute.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	dispute.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Marka Uyuşmazlığı Kimliği	dispute.brand_dispute_id	string	Kart markası tarafından oluşturulan kart markası sistemindeki uyuşmazlığın kimliği.

Ödeme alma

İşlem Kimliği:

PaymentGet

Belirli bir ödemenin ayrıntılarını alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ödeme Kimliği	payment_id	True	string	Ödemenin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	payment.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Oluşturma Tarihi	payment.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	payment.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Miktar	payment.amount_money.amount	integer	Miktar.
Para birimi	payment.amount_money.currency	string	Para birimi.
Statü	payment.status	string	Bu nesnenin geçerli doğrulama durumu.
Gecikme Süresi	payment.delay_duration	string	Square'in ödemeye otomatik olarak delay_action uyguladığı ödemenin oluşturulmasından sonraki süre. Bu otomatik delay_action yalnızca delay_duration zaman aralığından önce terminal durumuna (TAMAMLANDı, İptal EDİlDİ veya BAŞARISIZ) ulaşmayan ödemeler için geçerlidir. Bu alan, RFC 3339 biçiminde bir süre olarak belirtilir.
Kaynak Türü	payment.source_type	string	Bu ödemenin kaynak türü. Geçerli değerler CARD, BANK_ACCOUNT, CÜZDAN, CASH veya EXTERNAL değerleridir.
Statü	payment.card_details.status	string	Geçerli durum.
Kart Markası	payment.card_details.card.card_brand	string	Kartın markası.
Son 4	payment.card_details.card.last_4	string	Kart numarasının son 4 basamağı.
Exp Ay	payment.card_details.card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Exp Yılı	payment.card_details.card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Parmak izi	payment.card_details.card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
Kart Türü	payment.card_details.card.card_type	string	Kartın türü.
Ön Ödemeli Tür	payment.card_details.card.prepaid_type	string	Kartın ön ödemeli olup olmadığını gösterir.
BIN	payment.card_details.card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı.
Giriş Yöntemi	payment.card_details.entry_method	string	Ödeme için kartın ayrıntılarını girmek için kullanılan yöntem. Yöntem KEYED, SWIPED, EMV, ON_FILE veya CONTACTLESS olabilir.
CVV Durumu	payment.card_details.cvv_status	string	Kart Doğrulama Değeri (CVV) denetiminden döndürülen durum kodu. Kod CVV_ACCEPTED, CVV_REJECTED veya CVV_NOT_CHECKED olabilir.
AVS Durumu	payment.card_details.avs_status	string	Adres Doğrulama Sistemi (AVS) denetiminden döndürülen durum kodu. Kod AVS_ACCEPTED, AVS_REJECTED veya AVS_NOT_CHECKED olabilir.
Kimlik Doğrulama Sonuç Kodu	payment.card_details.auth_result_code	string	Kartı veren tarafından döndürülen ve ödemenin yetkilendirme durumunu açıklayan durum kodu.
Deyim Açıklaması	payment.card_details.statement_description	string	Kart ağlarına gönderilen deyim açıklaması.
Yetkili:	payment.card_details.card_payment_timeline.authorized_at	string	Ödemenin yetkilendirilildiği zaman damgası RFC 3339 biçimindedir.
Yakalanan Yer	payment.card_details.card_payment_timeline.captured_at	string	Ödemenin yakalandığı zaman damgası RFC 3339 biçimindedir.
Konum Kimliği	payment.location_id	string	Konumun tanımlayıcısı.
Sipariş Kimliği	payment.order_id	string	Siparişin kimliği.
İşlem Ücreti	payment.processing_fee	array of object
Geçerlilik Tarihi:	payment.processing_fee.effective_at	string	Rfc 3339 biçiminde ücretin geçerli olduğu zaman damgası.
Türü	payment.processing_fee.type	string	Türünü gösterir.
Miktar	payment.processing_fee.amount_money.amount	integer	Miktar.
Para birimi	payment.processing_fee.amount_money.currency	string	Para birimi.
Uyarı	payment.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
Miktar	payment.total_money.amount	integer	Miktar.
Para birimi	payment.total_money.currency	string	Para birimi.
Miktar	payment.approved_money.amount	integer	Miktar.
Para birimi	payment.approved_money.currency	string	Para birimi.
Çalışan Kimliği	payment.employee_id	string	Çalışanın Kare olarak oluşturulan kimliği.
Makbuz Numarası	payment.receipt_number	string	Ödemenin makbuz numarası. Ödeme iptal edilirse alan eksik olur.
Makbuz URL'si	payment.receipt_url	string	Ödeme makbuzunun URL'si. Alan yalnızca TAMAMLANAN ödemeler için doldurulur.
Gecikme Eylemi	payment.delay_action	string	delay_duration sona erdiğinde ödemeye uygulanacak eylem.
Gecikmeli	payment.delayed_until	string	rfc 3339 biçiminde delay_action otomatik olarak uygulandığında salt okunur zaman damgası.
Ekip Üyesi Kimliği	payment.team_member_id	string	Ekip üyesinin kimliği.
Kare Ürün	payment.application_details.square_product	string	Kare Satış Noktası (POS), Kare Faturalar veya Kare Sanal Terminal gibi Kare ürün.
Uygulama Kimliği	payment.application_details.application_id	string	Uygulamaya atanan salt okunur Kare Kimliği.
Sürüm Belirteci	payment.version_token	string	Bu opak belirteç nesnenin belirli bir sürümünü tanımlar.

Ödeme oluşturma

İşlem Kimliği:

PaymentCreate

Sağlanan kaynağı kullanarak bir ödeme oluşturur. Bu uç noktayı bir karttan (kredi/banka kartı veya Kare hediye kartı) ücretlendirmek veya satıcının Square dışından aldığı bir ödemeyi (bir alıcıdan yapılan nakit ödeme veya bir dış varlığın satıcı adına işlediği bir ödeme) kaydetmek için kullanabilirsiniz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Miktar	amount		integer	tip_money dahil olmak üzere bu ödeme için kabul edilen para miktarı.
Para birimi	currency		string	3 karakterli ISO 4217 para birimi kodu.
Kaynak Kimliği	source_id		string	Bu ödeme için fon kaynağının kimliği. Bu, Kare ödeme formu tarafından oluşturulan bir ödeme belirteci (kart nonce) veya Müşteriler API'siyle yapılan dosyadaki bir kart olabilir. Satıcının Square dışından aldığı bir ödemeyi kaydediyorsa, CASH veya EXTERNAL belirtin.
Otomatik Tamamlama	autocomplete		boolean	True olarak ayarlanırsa, bu ödeme mümkün olduğunda tamamlanır. False olarak ayarlanırsa, bu ödeme açıkça tamamlanana (yakalanan) veya iptal edilene (geçersiz kılınana) kadar onaylanan bir durumda tutulur.
Müşteri Kimliği	customer_id		string	Bağlanacak müşterinin kimliği.
Konum Kimliği	location_id		string	Konum tanımlayıcısı.
Başvuru Kimliği	reference_id		string	Müşteri profilini başka bir sistemdeki bir varlıkla ilişkilendirmek için kullanılan isteğe bağlı ikinci kimlik.
Uyarı	note		string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
Miktar	amount		integer	tip_money dahil olmak üzere bu ödeme için kabul edilen para miktarı.
Para birimi	currency		string	3 karakterli ISO 4217 para birimi kodu.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	payment.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Oluşturma Tarihi	payment.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	payment.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Miktar	payment.amount_money.amount	integer	Miktar.
Para birimi	payment.amount_money.currency	string	Para birimi.
Miktar	payment.app_fee_money.amount	integer	Miktar.
Para birimi	payment.app_fee_money.currency	string	Para birimi.
Statü	payment.status	string	Bu nesnenin geçerli doğrulama durumu.
Gecikme Süresi	payment.delay_duration	string	Square'in ödemeye otomatik olarak delay_action uyguladığı ödemenin oluşturulmasından sonraki süre. Bu otomatik delay_action yalnızca delay_duration zaman aralığından önce terminal durumuna (TAMAMLANDı, İptal EDİlDİ veya BAŞARISIZ) ulaşmayan ödemeler için geçerlidir. Bu alan, RFC 3339 biçiminde bir süre olarak belirtilir.
Kaynak Türü	payment.source_type	string	Bu ödemenin kaynak türü. Geçerli değerler CARD, BANK_ACCOUNT, CÜZDAN, CASH veya EXTERNAL değerleridir.
Statü	payment.card_details.status	string	Geçerli durum.
Kart Markası	payment.card_details.card.card_brand	string	Kartın markası.
Son 4	payment.card_details.card.last_4	string	Kart numarasının son 4 basamağı.
Exp Ay	payment.card_details.card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Exp Yılı	payment.card_details.card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Parmak izi	payment.card_details.card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
Kart Türü	payment.card_details.card.card_type	string	Kartın türü.
Ön Ödemeli Tür	payment.card_details.card.prepaid_type	string	Kartın ön ödemeli olup olmadığını gösterir.
BIN	payment.card_details.card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı.
Giriş Yöntemi	payment.card_details.entry_method	string	Ödeme için kartın ayrıntılarını girmek için kullanılan yöntem. Yöntem KEYED, SWIPED, EMV, ON_FILE veya CONTACTLESS olabilir.
CVV Durumu	payment.card_details.cvv_status	string	Kart Doğrulama Değeri (CVV) denetiminden döndürülen durum kodu. Kod CVV_ACCEPTED, CVV_REJECTED veya CVV_NOT_CHECKED olabilir.
AVS Durumu	payment.card_details.avs_status	string	Adres Doğrulama Sistemi (AVS) denetiminden döndürülen durum kodu. Kod AVS_ACCEPTED, AVS_REJECTED veya AVS_NOT_CHECKED olabilir.
Kimlik Doğrulama Sonuç Kodu	payment.card_details.auth_result_code	string	Kartı veren tarafından döndürülen ve ödemenin yetkilendirme durumunu açıklayan durum kodu.
Deyim Açıklaması	payment.card_details.statement_description	string	Kart ağlarına gönderilen deyim açıklaması.
Yetkili:	payment.card_details.card_payment_timeline.authorized_at	string	Ödemenin yetkilendirilildiği zaman damgası RFC 3339 biçimindedir.
Yakalanan Yer	payment.card_details.card_payment_timeline.captured_at	string	Ödemenin yakalandığı zaman damgası RFC 3339 biçimindedir.
Konum Kimliği	payment.location_id	string	Konumun tanımlayıcısı.
Sipariş Kimliği	payment.order_id	string	Siparişin kimliği.
Başvuru Kimliği	payment.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Oluşturma Tarihi	payment.risk_evaluation.created_at	string	Rfc 3339 biçiminde oluşturulduğunda zaman damgası.
Risk Düzeyi	payment.risk_evaluation.risk_level	string	Ödemeyle ilişkili risk düzeyi.
Uyarı	payment.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
Müşteri Kimliği	payment.customer_id	string	Müşteriyi temsil eden bu nesnenin kimliği.
Miktar	payment.total_money.amount	integer	Miktar.
Para birimi	payment.total_money.currency	string	Para birimi.
Miktar	payment.approved_money.amount	integer	Miktar.
Para birimi	payment.approved_money.currency	string	Para birimi.
Makbuz Numarası	payment.receipt_number	string	Ödemenin makbuz numarası. Ödeme iptal edilirse alan eksik olur.
Makbuz URL'si	payment.receipt_url	string	Ödeme makbuzunun URL'si. Alan yalnızca TAMAMLANAN ödemeler için doldurulur.
Gecikme Eylemi	payment.delay_action	string	delay_duration sona erdiğinde ödemeye uygulanacak eylem.
Gecikmeli	payment.delayed_until	string	rfc 3339 biçiminde delay_action otomatik olarak uygulandığında salt okunur zaman damgası.
Kare Ürün	payment.application_details.square_product	string	Kare Satış Noktası (POS), Kare Faturalar veya Kare Sanal Terminal gibi Kare ürün.
Uygulama Kimliği	payment.application_details.application_id	string	Uygulamaya atanan salt okunur Kare Kimliği.
Sürüm Belirteci	payment.version_token	string	Bu opak belirteç nesnenin belirli bir sürümünü tanımlar.

Ödeme para iadelerini listeleme

İşlem Kimliği:

RefundList

İsteği yapan hesap için para iadelerinin listesini alır. Sonuçlar nihai olarak tutarlıdır ve yeni para iadelerinin veya para iadelerindeki değişikliklerin görünmesi birkaç saniye sürebilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Başlangıç Saati	begin_time		string	opened_at'daki sorgunun ISO 8601 biçimindeki kapsayıcı başlangıç saati.
Bitiş Saati	end_time		string	opened_at'daki sorgunun ISO 8601 biçimindeki özel bitiş tarihi.
Sıralama Düzeni	sort_order		string	Döndürülen listeyi, kartın belirtilen düzende oluşturulduğu zamanlara göre sıralar.
Cursor	cursor		string	Bu uç noktaya önceki bir çağrı tarafından döndürülen sayfalandırma imleci.
Konum Kimliği	location_id		string	Yalnızca belirli bir konuma ait kayıtları almak için bu isteğe bağlı filtreyi belirtebilirsiniz.
Statü	status		string	Belirtilirse, yalnızca belirtilen durumlarla eşleşen nesneleri döndürür.
Kaynak Türü	source_type		string	Sağlanırsa, yalnızca belirtilen kaynak türüne sahip para iadeleri döndürülür.
Sınır	limit		integer	Yanıtta döndürülecek sayı üst sınırı.

Döndürülenler

Name	Yol	Tür	Description
Iadesi	refunds	array of object
Kimlik	refunds.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Statü	refunds.status	string	Bu nesnenin geçerli doğrulama durumu.
Miktar	refunds.amount_money.amount	integer	Miktar.
Para birimi	refunds.amount_money.currency	string	Para birimi.
Ödeme Kimliği	refunds.payment_id	string	Ödemenin kimliği.
Sipariş Kimliği	refunds.order_id	string	Siparişin kimliği.
Oluşturma Tarihi	refunds.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	refunds.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
İşlem Ücreti	refunds.processing_fee	array of object
Geçerlilik Tarihi:	refunds.processing_fee.effective_at	string	Rfc 3339 biçiminde ücretin geçerli olduğu zaman damgası.
Türü	refunds.processing_fee.type	string	Bu nesnenin türü.
Miktar	refunds.processing_fee.amount_money.amount	integer	Miktar.
Para birimi	refunds.processing_fee.amount_money.currency	string	Para birimi.
Konum Kimliği	refunds.location_id	string	Konumun tanımlayıcısı.
Reason	refunds.reason	string	Kart sahibinin anlaşmazlığı bankasıyla başlatmasının anlaşmazlık nedeni.
Cursor	cursor	string	Özgün sorguyla ilişkili sonraki sonuç kümesini almak için sayfalandırma imlecini bu uç noktaya yapılan sonraki çağrılara ekleyin.

Ödeme para iadesi alma

İşlem Kimliği:

RefundGet

refund_id kullanarak belirli bir para iadesi alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Para İadesi Kimliği	refund_id	True	string	Para iadesinin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	refund.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Statü	refund.status	string	Bu nesnenin geçerli doğrulama durumu.
Miktar	refund.amount_money.amount	integer	Miktar.
Para birimi	refund.amount_money.currency	string	Para birimi.
Ödeme Kimliği	refund.payment_id	string	Ödemenin benzersiz kimliği.
Sipariş Kimliği	refund.order_id	string	Siparişin kimliği.
Oluşturma Tarihi	refund.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	refund.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
İşlem Ücreti	refund.processing_fee	array of object
Geçerlilik Tarihi:	refund.processing_fee.effective_at	string	Rfc 3339 biçiminde ücretin geçerli olduğu zaman damgası.
Türü	refund.processing_fee.type	string	Türünü gösterir.
Miktar	refund.processing_fee.amount_money.amount	integer	Miktar.
Para birimi	refund.processing_fee.amount_money.currency	string	Para birimi.
Konum Kimliği	refund.location_id	string	Konumun tanımlayıcısı.
Reason	refund.reason	string	Bu nesnenin nedeni.

Ödeme siparişi (Beta)

İşlem Kimliği:

OrderPay

Bir veya daha fazla onaylanmış ödeme kullanarak bir sipariş için ödeme yapın veya toplam 0 ile bir siparişi ödeyin. İstekte listelenen payment_ids toplamı, sipariş toplamına eşit olmalıdır. Toplam tutarı 0 olan siparişler, istekte boş bir payment_ids dizisi belirtilerek ödendi olarak işaretlenebilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sipariş Kimliği	order_id	True	string	Siparişin tanımlayıcısı.
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Ödeme Kimlikleri	payment_ids		array of string

Döndürülenler

Name	Yol	Tür	Description
Kimlik	order.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	order.location_id	string	Konumun tanımlayıcısı.
Satır Öğeleri	order.line_items	array of object
UID	order.line_items.uid	string	Kare tarafından oluşturulan kimlik.
Miktar	order.line_items.quantity	string	Fiziksel sayının ondalık dize olarak etkilediği öğe sayısı. Sayı, ondalık ayırıcıdan sonra en çok 5 basamağı destekleyebilir.
İsim	order.line_items.name	string	Öğenin adı. Bu, geçerli sorgu filtrelerinde kullanılmak üzere aranabilir bir özniteliktir, değeri boş olmamalıdır ve uzunluğu Unicode kod noktalarıdır.
Miktar	order.line_items.base_price_money.amount	integer	Miktar.
Para birimi	order.line_items.base_price_money.currency	string	Para birimi.
Miktar	order.line_items.gross_sales_money.amount	integer	Miktar.
Para birimi	order.line_items.gross_sales_money.currency	string	Para birimi.
Miktar	order.line_items.total_tax_money.amount	integer	Miktar.
Para birimi	order.line_items.total_tax_money.currency	string	Para birimi.
Miktar	order.line_items.total_discount_money.amount	integer	Miktar.
Para birimi	order.line_items.total_discount_money.currency	string	Para birimi.
Miktar	order.line_items.total_money.amount	integer	Miktar.
Para birimi	order.line_items.total_money.currency	string	Para birimi.
Oluşturma Tarihi	order.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	order.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Sürüm	order.version	integer	Bu nesnenin geçerli sürümü.
Miktar	order.total_tax_money.amount	integer	Miktar.
Para birimi	order.total_tax_money.currency	string	Para birimi.
Miktar	order.total_discount_money.amount	integer	Miktar.
Para birimi	order.total_discount_money.currency	string	Para birimi.
Miktar	order.total_money.amount	integer	Miktar.
Para birimi	order.total_money.currency	string	Para birimi.
Kapalı:	order.closed_at	string	Iso 8601 biçiminde kapatılan zaman.
Ihale	order.tenders	array of object
Kimlik	order.tenders.id	string	Nesnenin tanımlayıcısı
Konum Kimliği	order.tenders.location_id	string	Bu ihalenin bir kısmını alan alıcının (satıcı dışında) konum kimliği.
İşlem Kimliği	order.tenders.transaction_id	string	İhalenin ilişkili işleminin kimliği.
Oluşturma Tarihi	order.tenders.created_at	string	Rfc 3339 biçiminde oluşturulduğunda zaman damgası.
Miktar	order.tenders.amount_money.amount	integer	Miktar.
Para birimi	order.tenders.amount_money.currency	string	Para birimi.
Türü	order.tenders.type	string	Türünü gösterir.
Statü	order.tenders.card_details.status	string	Kredi kartı ödemesinin geçerli durumu (YETKİlİ veya YAKALANMIŞ gibi)
Kart Markası	order.tenders.card_details.card.card_brand	string	Kartın markası.
last_4	order.tenders.card_details.card.last_4	string	Kart numarasının son 4 basamağı.
Exp Ay	order.tenders.card_details.card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Exp Yılı	order.tenders.card_details.card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Parmak izi	order.tenders.card_details.card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
Giriş Yöntemi	order.tenders.card_details.entry_method	string	Kartın işlem ayrıntılarını girmek için kullanılan yöntem.
Ödeme Kimliği	order.tenders.payment_id	string	Ödemenin kare olarak oluşturulan benzersiz kimliği.
Miktar	order.total_service_charge_money.amount	integer	Miktar.
Para birimi	order.total_service_charge_money.currency	string	Para birimi.
Miktar	order.net_amounts.total_money.amount	integer	Miktar.
Para birimi	order.net_amounts.total_money.currency	string	Para birimi.
Miktar	order.net_amounts.tax_money.amount	integer	Miktar.
Para birimi	order.net_amounts.tax_money.currency	string	Para birimi.
Miktar	order.net_amounts.discount_money.amount	integer	Miktar.
Para birimi	order.net_amounts.discount_money.currency	string	Para birimi.
Miktar	order.net_amounts.tip_money.amount	integer	Miktar.
Para birimi	order.net_amounts.tip_money.currency	string	Para birimi.
Miktar	order.net_amounts.service_charge_money.amount	integer	Miktar.
Para birimi	order.net_amounts.service_charge_money.currency	string	Para birimi.
İsim	order.source.name	string	Adı.
Devlet	order.state	string	Geçerli durum.

Ödemeleri listeleme

İşlem Kimliği:

PaymentList

İstekte bulunan hesabın aldığı ödemelerin listesini alır. Sonuçlar nihai olarak tutarlıdır ve yeni ödemelerin veya ödemelerdeki değişikliklerin görünmesi birkaç saniye sürebilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Başlangıç Saati	begin_time		string	opened_at'daki sorgunun ISO 8601 biçimindeki kapsayıcı başlangıç saati.
Bitiş Saati	end_time		string	opened_at'daki sorgunun ISO 8601 biçimindeki özel bitiş tarihi.
Sıralama Düzeni	sort_order		string	Döndürülen listeyi, kartın belirtilen düzende oluşturulduğu zamanlara göre sıralar.
Cursor	cursor		string	Bu uç noktaya önceki bir çağrı tarafından döndürülen sayfalandırma imleci.
Konum Kimliği	location_id		string	Yalnızca belirli bir konuma ait kayıtları almak için bu isteğe bağlı filtreyi belirtebilirsiniz.
Total	total		integer	Ödeme için total_money tam tutar.
Son 4	last_4		string	Ödeme kartının son dört rakamı.
Kart Markası	card_brand		string	Ödeme kartının markası (örneğin, VISA).
Sınır	limit		integer	Yanıtta döndürülecek sayı üst sınırı.

Döndürülenler

Name	Yol	Tür	Description
Ödemeler	payments	array of object
Kimlik	payments.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Oluşturma Tarihi	payments.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	payments.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Miktar	payments.amount_money.amount	integer	Miktar.
Para birimi	payments.amount_money.currency	string	Para birimi.
Statü	payments.status	string	Bu nesnenin geçerli doğrulama durumu.
Gecikme Süresi	payments.delay_duration	string	Square'in ödemeye otomatik olarak delay_action uyguladığı ödemenin oluşturulmasından sonraki süre.
Kaynak Türü	payments.source_type	string	Bu ödemenin kaynak türü.
Statü	payments.card_details.status	string	Kart ödemesinin geçerli durumu. Durum YETKİlİ, YAKALANIR, HÜKÜMSİz VEYA BAŞARISIZ olabilir.
Kart Markası	payments.card_details.card.card_brand	string	Kartın markası.
last_4	payments.card_details.card.last_4	string	Kart numarasının son 4 basamağı.
Exp Ay	payments.card_details.card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Exp Yılı	payments.card_details.card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Parmak izi	payments.card_details.card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
Kart Türü	payments.card_details.card.card_type	string	Kartın türü.
Ön Ödemeli Tür	payments.card_details.card.prepaid_type	string	Kartın ön ödemeli olup olmadığını gösterir.
BIN	payments.card_details.card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı
Giriş Yöntemi	payments.card_details.entry_method	string	Ödeme için kartın ayrıntılarını girmek için kullanılan yöntem. Yöntem KEYED, SWIPED, EMV, ON_FILE veya CONTACTLESS olabilir.
Cvv Durumu	payments.card_details.cvv_status	string	Kart Doğrulama Değeri (CVV) denetiminden döndürülen durum kodu. Kod CVV_ACCEPTED, CVV_REJECTED veya CVV_NOT_CHECKED olabilir.
Avs Durumu	payments.card_details.avs_status	string	Adres Doğrulama Sistemi (AVS) denetiminden döndürülen durum kodu. Kod AVS_ACCEPTED, AVS_REJECTED veya AVS_NOT_CHECKED olabilir.
Kimlik Doğrulama Sonuç Kodu	payments.card_details.auth_result_code	string	Kartı veren tarafından döndürülen ve ödemenin yetkilendirme durumunu açıklayan durum kodu.
Deyim Açıklaması	payments.card_details.statement_description	string	Kart ağlarına gönderilen deyim açıklaması.
Yetkili:	payments.card_details.card_payment_timeline.authorized_at	string	Ödemenin yetkilendirilildiği zaman damgası RFC 3339 biçimindedir.
Yakalanan Yer	payments.card_details.card_payment_timeline.captured_at	string	Ödemenin yakalandığı zaman damgası RFC 3339 biçimindedir.
Konum Kimliği	payments.location_id	string	Konumun tanımlayıcısı.
Sipariş Kimliği	payments.order_id	string	Siparişin kimliği.
İşlem Ücreti	payments.processing_fee	array of object
Geçerlilik Tarihi:	payments.processing_fee.effective_at	string	Rfc 3339 biçiminde ücretin geçerli olduğu zaman damgası.
Türü	payments.processing_fee.type	string	Bu nesnenin türü.
Miktar	payments.processing_fee.amount_money.amount	integer	Miktar.
Para birimi	payments.processing_fee.amount_money.currency	string	Para birimi.
Uyarı	payments.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
Miktar	payments.total_money.amount	integer	Miktar.
Para birimi	payments.total_money.currency	string	Para birimi.
Miktar	payments.approved_money.amount	integer	Miktar.
Para birimi	payments.approved_money.currency	string	Para birimi.
Makbuz Numarası	payments.receipt_number	string	Ödemenin makbuz numarası. Ödeme iptal edilirse alan eksik olur.
Makbuz URL'si	payments.receipt_url	string	Ödeme makbuzunun URL'si. Alan yalnızca TAMAMLANAN ödemeler için doldurulur.
Gecikme Eylemi	payments.delay_action	string	delay_duration sona erdiğinde ödemeye uygulanacak eylem.
Gecikmeli	payments.delayed_until	string	rfc 3339 biçiminde delay_action otomatik olarak uygulandığında salt okunur zaman damgası.
Ekip Üyesi Kimliği	payments.team_member_id	string	Nesneyle ilişkilendirilmiş ekip üyesinin TeamMember nesnesinin kimliği.
Kare Ürün	payments.application_details.square_product	string	Kare Satış Noktası (POS), Kare Faturalar veya Kare Sanal Terminal gibi Kare ürün.
Uygulama Kimliği	payments.application_details.application_id	string	Ödemeyi almak için kullanılan uygulamaya atanan Kare Kimliği. Uygulama geliştiricileri, uygulamalarının işlediği ödemeleri belirlemek için bu bilgileri kullanabilir. Örneğin, bir geliştirici ödemeleri işlemek için özel bir uygulama kullanıyorsa, bu alan Geliştirici Panosu'ndan uygulama kimliğini içerir. Bir satıcı ödemeleri işlemek için Bir Square App Market uygulaması kullanıyorsa, bu alan ilgili uygulama kimliğini içerir.
Sürüm Belirteci	payments.version_token	string	İyimser eşzamanlılık için kullanılır. Bu opak belirteç, Payment nesnesinin belirli bir sürümünü tanımlar.

Ödemeyi güncelleştirme

İşlem Kimliği:

PaymentUpdate

Bir ödemeyi APPROVED durumuyla güncelleştirir. Bu uç noktayı kullanarak amount_money ve tip_money güncelleştirebilirsiniz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ödeme Kimliği	payment_id	True	string	Ödemenin tanımlayıcısı.
Idempotency Anahtarı	idempotency_key		string	Tüm istekleriniz arasında bu isteği benzersiz olarak tanımlayan, belirttiğiniz bir değer. Geçerli bir eşzamanlılık anahtarı oluşturmanın yaygın bir yolu, Evrensel olarak benzersiz bir tanımlayıcı (UUID) kullanmaktır.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.
Sürüm Belirteci	version_token		string	Bu opak belirteç nesnenin belirli bir sürümünü tanımlar.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	payment.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Oluşturma Tarihi	payment.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	payment.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Miktar	payment.amount_money.amount	integer	Miktar.
Para birimi	payment.amount_money.currency	string	Para birimi.
Miktar	payment.tip_money.amount	integer	Miktar.
Para birimi	payment.tip_money.currency	string	Para birimi.
Statü	payment.status	string	Bu nesnenin geçerli doğrulama durumu.
Gecikme Süresi	payment.delay_duration	string	Square'in ödemeye otomatik olarak delay_action uyguladığı ödemenin oluşturulmasından sonraki süre. Bu otomatik delay_action yalnızca delay_duration zaman aralığından önce terminal durumuna (TAMAMLANDı, İptal EDİlDİ veya BAŞARISIZ) ulaşmayan ödemeler için geçerlidir. Bu alan, RFC 3339 biçiminde bir süre olarak belirtilir.
Kaynak Türü	payment.source_type	string	Bu ödemenin kaynak türü. Geçerli değerler CARD, BANK_ACCOUNT, CÜZDAN, CASH veya EXTERNAL değerleridir.
Statü	payment.card_details.status	string	Geçerli durum.
Kart Markası	payment.card_details.card.card_brand	string	Kartın markası.
Son 4	payment.card_details.card.last_4	string	Kart numarasının son 4 basamağı.
Exp Ay	payment.card_details.card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Exp Yılı	payment.card_details.card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Parmak izi	payment.card_details.card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
Kart Türü	payment.card_details.card.card_type	string	Kartın türü.
Ön Ödemeli Tür	payment.card_details.card.prepaid_type	string	Kartın ön ödemeli olup olmadığını gösterir.
BIN	payment.card_details.card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı.
Giriş Yöntemi	payment.card_details.entry_method	string	Ödeme için kartın ayrıntılarını girmek için kullanılan yöntem. Yöntem KEYED, SWIPED, EMV, ON_FILE veya CONTACTLESS olabilir.
CVV Durumu	payment.card_details.cvv_status	string	Kart Doğrulama Değeri (CVV) denetiminden döndürülen durum kodu. Kod CVV_ACCEPTED, CVV_REJECTED veya CVV_NOT_CHECKED olabilir.
AVS Durumu	payment.card_details.avs_status	string	Adres Doğrulama Sistemi (AVS) denetiminden döndürülen durum kodu. Kod AVS_ACCEPTED, AVS_REJECTED veya AVS_NOT_CHECKED olabilir.
Kimlik Doğrulama Sonuç Kodu	payment.card_details.auth_result_code	string	Kartı veren tarafından döndürülen ve ödemenin yetkilendirme durumunu açıklayan durum kodu.
Deyim Açıklaması	payment.card_details.statement_description	string	Kart ağlarına gönderilen deyim açıklaması.
Yetkili:	payment.card_details.card_payment_timeline.authorized_at	string	Ödemenin yetkilendirilildiği zaman damgası RFC 3339 biçimindedir.
Konum Kimliği	payment.location_id	string	Konumun tanımlayıcısı.
Sipariş Kimliği	payment.order_id	string	Siparişin kimliği.
Oluşturma Tarihi	payment.risk_evaluation.created_at	string	Rfc 3339 biçiminde oluşturulduğunda zaman damgası.
Risk Düzeyi	payment.risk_evaluation.risk_level	string	Ödemeyle ilişkili risk düzeyi.
Uyarı	payment.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
Müşteri Kimliği	payment.customer_id	string	Müşteriyi temsil eden bu nesnenin kimliği.
Miktar	payment.total_money.amount	integer	Miktar.
Para birimi	payment.total_money.currency	string	Para birimi.
Miktar	payment.approved_money.amount	integer	Miktar.
Para birimi	payment.approved_money.currency	string	Para birimi.
Capabilities	payment.capabilities	array of string
Makbuz Numarası	payment.receipt_number	string	Ödemenin makbuz numarası. Ödeme iptal edilirse alan eksik olur.
Gecikme Eylemi	payment.delay_action	string	delay_duration sona erdiğinde ödemeye uygulanacak eylem.
Gecikmeli	payment.delayed_until	string	rfc 3339 biçiminde delay_action otomatik olarak uygulandığında salt okunur zaman damgası.
Kare Ürün	payment.application_details.square_product	string	Kare Satış Noktası (POS), Kare Faturalar veya Kare Sanal Terminal gibi Kare ürün.
Uygulama Kimliği	payment.application_details.application_id	string	Uygulamaya atanan salt okunur Kare Kimliği.
Sürüm Belirteci	payment.version_token	string	Bu opak belirteç nesnenin belirli bir sürümünü tanımlar.

Ödemeyi iptal et

İşlem Kimliği:

PaymentCancel

Bir ödemeyi iptal eder (geçersiz kılar). Onaylanan durumuyla bir ödemeyi iptal etmek için bu uç noktayı kullanabilirsiniz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ödeme Kimliği	payment_id	True	string	Ödemenin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	payment.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Oluşturma Tarihi	payment.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	payment.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Miktar	payment.amount_money.amount	integer	Miktar.
Para birimi	payment.amount_money.currency	string	Para birimi.
Miktar	payment.tip_money.amount	integer	Miktar.
Para birimi	payment.tip_money.currency	string	Para birimi.
Statü	payment.status	string	Bu nesnenin geçerli doğrulama durumu.
Gecikme Süresi	payment.delay_duration	string	Square'in ödemeye otomatik olarak delay_action uyguladığı ödemenin oluşturulmasından sonraki süre. Bu otomatik delay_action yalnızca delay_duration zaman aralığından önce terminal durumuna (TAMAMLANDı, İptal EDİlDİ veya BAŞARISIZ) ulaşmayan ödemeler için geçerlidir. Bu alan, RFC 3339 biçiminde bir süre olarak belirtilir.
Kaynak Türü	payment.source_type	string	Bu ödemenin kaynak türü. Geçerli değerler CARD, BANK_ACCOUNT, CÜZDAN, CASH veya EXTERNAL değerleridir.
Statü	payment.card_details.status	string	Geçerli durum.
Kart Markası	payment.card_details.card.card_brand	string	Kartın markası.
Son 4	payment.card_details.card.last_4	string	Kart numarasının son 4 basamağı.
Exp Ay	payment.card_details.card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Exp Yılı	payment.card_details.card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Parmak izi	payment.card_details.card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
Kart Türü	payment.card_details.card.card_type	string	Kartın türü.
Ön Ödemeli Tür	payment.card_details.card.prepaid_type	string	Kartın ön ödemeli olup olmadığını gösterir.
BIN	payment.card_details.card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı.
Giriş Yöntemi	payment.card_details.entry_method	string	Ödeme için kartın ayrıntılarını girmek için kullanılan yöntem. Yöntem KEYED, SWIPED, EMV, ON_FILE veya CONTACTLESS olabilir.
CVV Durumu	payment.card_details.cvv_status	string	Kart Doğrulama Değeri (CVV) denetiminden döndürülen durum kodu. Kod CVV_ACCEPTED, CVV_REJECTED veya CVV_NOT_CHECKED olabilir.
AVS Durumu	payment.card_details.avs_status	string	Adres Doğrulama Sistemi (AVS) denetiminden döndürülen durum kodu. Kod AVS_ACCEPTED, AVS_REJECTED veya AVS_NOT_CHECKED olabilir.
Kimlik Doğrulama Sonuç Kodu	payment.card_details.auth_result_code	string	Kartı veren tarafından döndürülen ve ödemenin yetkilendirme durumunu açıklayan durum kodu.
Deyim Açıklaması	payment.card_details.statement_description	string	Kart ağlarına gönderilen deyim açıklaması.
Yetkili:	payment.card_details.card_payment_timeline.authorized_at	string	Ödemenin yetkilendirilildiği zaman damgası RFC 3339 biçimindedir.
Geçersiz Kılınan Yer	payment.card_details.card_payment_timeline.voided_at	string	Ödemenin iptal edildiği zaman damgası RFC 3339 biçimindedir.
Konum Kimliği	payment.location_id	string	Konumun tanımlayıcısı.
Sipariş Kimliği	payment.order_id	string	Siparişin kimliği.
Oluşturma Tarihi	payment.risk_evaluation.created_at	string	Rfc 3339 biçiminde oluşturulduğunda zaman damgası.
Risk Düzeyi	payment.risk_evaluation.risk_level	string	Ödemeyle ilişkili risk düzeyi.
Uyarı	payment.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
Müşteri Kimliği	payment.customer_id	string	Müşteriyi temsil eden bu nesnenin kimliği.
Miktar	payment.total_money.amount	integer	Miktar.
Para birimi	payment.total_money.currency	string	Para birimi.
Miktar	payment.approved_money.amount	integer	Miktar.
Para birimi	payment.approved_money.currency	string	Para birimi.
Gecikme Eylemi	payment.delay_action	string	delay_duration sona erdiğinde ödemeye uygulanacak eylem.
Gecikmeli	payment.delayed_until	string	rfc 3339 biçiminde delay_action otomatik olarak uygulandığında salt okunur zaman damgası.
Kare Ürün	payment.application_details.square_product	string	Kare Satış Noktası (POS), Kare Faturalar veya Kare Sanal Terminal gibi Kare ürün.
Uygulama Kimliği	payment.application_details.application_id	string	Uygulamaya atanan salt okunur Kare Kimliği.
Sürüm Belirteci	payment.version_token	string	Bu opak belirteç nesnenin belirli bir sürümünü tanımlar.

Ödemeyi tamamlama

İşlem Kimliği:

PaymentComplete

Bir ödemeyi tamamlar (yakalar). Varsayılan olarak, ödemeler oluşturulduktan hemen sonra tamamlayacak şekilde ayarlanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ödeme Kimliği	payment_id	True	string	Ödemenin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	payment.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Oluşturma Tarihi	payment.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	payment.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Miktar	payment.amount_money.amount	integer	Miktar.
Para birimi	payment.amount_money.currency	string	Para birimi.
Statü	payment.status	string	Bu nesnenin geçerli doğrulama durumu.
Gecikme Süresi	payment.delay_duration	string	Square'in ödemeye otomatik olarak delay_action uyguladığı ödemenin oluşturulmasından sonraki süre. Bu otomatik delay_action yalnızca delay_duration zaman aralığından önce terminal durumuna (TAMAMLANDı, İptal EDİlDİ veya BAŞARISIZ) ulaşmayan ödemeler için geçerlidir. Bu alan, RFC 3339 biçiminde bir süre olarak belirtilir.
Kaynak Türü	payment.source_type	string	Bu ödemenin kaynak türü. Geçerli değerler CARD, BANK_ACCOUNT, CÜZDAN, CASH veya EXTERNAL değerleridir.
Statü	payment.card_details.status	string	Geçerli durum.
Kart Markası	payment.card_details.card.card_brand	string	Kartın markası.
Son 4	payment.card_details.card.last_4	string	Kart numarasının son 4 basamağı.
Exp Ay	payment.card_details.card.exp_month	integer	İlişkili kartın 1 ile 12 arasında bir tamsayı olarak sona erme ayı.
Exp Yılı	payment.card_details.card.exp_year	integer	Kartın son kullanma tarihinin dört basamaklı yılı.
Parmak izi	payment.card_details.card.fingerprint	string	Kartı tek bir uygulama içindeki birden çok konumda tanımlamak için kart numarasına göre Kare olarak atanan bir tanımlayıcı olarak tasarlanmıştır.
Kart Türü	payment.card_details.card.card_type	string	Kartın türü.
Ön Ödemeli Tür	payment.card_details.card.prepaid_type	string	Kartın ön ödemeli olup olmadığını gösterir.
BIN	payment.card_details.card.bin	string	Banka Kimlik Numarası (BIN) olarak bilinen kart numarasının ilk altı basamağı.
Giriş Yöntemi	payment.card_details.entry_method	string	Ödeme için kartın ayrıntılarını girmek için kullanılan yöntem. Yöntem KEYED, SWIPED, EMV, ON_FILE veya CONTACTLESS olabilir.
CVV Durumu	payment.card_details.cvv_status	string	Kart Doğrulama Değeri (CVV) denetiminden döndürülen durum kodu. Kod CVV_ACCEPTED, CVV_REJECTED veya CVV_NOT_CHECKED olabilir.
AVS Durumu	payment.card_details.avs_status	string	Adres Doğrulama Sistemi (AVS) denetiminden döndürülen durum kodu. Kod AVS_ACCEPTED, AVS_REJECTED veya AVS_NOT_CHECKED olabilir.
Kimlik Doğrulama Sonuç Kodu	payment.card_details.auth_result_code	string	Kartı veren tarafından döndürülen ve ödemenin yetkilendirme durumunu açıklayan durum kodu.
Deyim Açıklaması	payment.card_details.statement_description	string	Kart ağlarına gönderilen deyim açıklaması.
Yetkili:	payment.card_details.card_payment_timeline.authorized_at	string	Ödemenin yetkilendirilildiği zaman damgası RFC 3339 biçimindedir.
Yakalanan Yer	payment.card_details.card_payment_timeline.captured_at	string	Ödemenin yakalandığı zaman damgası RFC 3339 biçimindedir.
Konum Kimliği	payment.location_id	string	Konumun tanımlayıcısı.
Sipariş Kimliği	payment.order_id	string	Siparişin kimliği.
İşlem Ücreti	payment.processing_fee	array of object
Geçerlilik Tarihi:	payment.processing_fee.effective_at	string	Rfc 3339 biçiminde ücretin geçerli olduğu zaman damgası.
Türü	payment.processing_fee.type	string	Türünü gösterir.
Miktar	payment.processing_fee.amount_money.amount	integer	Miktar.
Para birimi	payment.processing_fee.amount_money.currency	string	Para birimi.
Uyarı	payment.note	string	Müşteri profiliyle ilişkilendirilmiş özel bir not.
Miktar	payment.total_money.amount	integer	Miktar.
Para birimi	payment.total_money.currency	string	Para birimi.
Miktar	payment.approved_money.amount	integer	Miktar.
Para birimi	payment.approved_money.currency	string	Para birimi.
Çalışan Kimliği	payment.employee_id	string	Çalışanın Kare olarak oluşturulan kimliği.
Makbuz Numarası	payment.receipt_number	string	Ödemenin makbuz numarası. Ödeme iptal edilirse alan eksik olur.
Makbuz URL'si	payment.receipt_url	string	Ödeme makbuzunun URL'si. Alan yalnızca TAMAMLANAN ödemeler için doldurulur.
Gecikme Eylemi	payment.delay_action	string	delay_duration sona erdiğinde ödemeye uygulanacak eylem.
Gecikmeli	payment.delayed_until	string	rfc 3339 biçiminde delay_action otomatik olarak uygulandığında salt okunur zaman damgası.
Ekip Üyesi Kimliği	payment.team_member_id	string	Ekip üyesinin kimliği.
Kare Ürün	payment.application_details.square_product	string	Kare Satış Noktası (POS), Kare Faturalar veya Kare Sanal Terminal gibi Kare ürün.
Uygulama Kimliği	payment.application_details.application_id	string	Uygulamaya atanan salt okunur Kare Kimliği.
Sürüm Belirteci	payment.version_token	string	Bu opak belirteç nesnenin belirli bir sürümünü tanımlar.

Öğe değiştirici listelerini güncelleştirme

İşlem Kimliği:

CatalogUpdateModifier

Hedeflenen CatalogItem için geçerli olan CatalogModifierList nesnelerini, öğenin tamamında bir upsert gerçekleştirmek zorunda kalmadan güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Öğe Kimlikleri	item_ids		array of string
Etkinleştirecek Değiştirici Listeleri	modifier_lists_to_enable		array of string
Devre Dışı Bırakacak Değiştirici Listeleri	modifier_lists_to_disable		array of string

Döndürülenler

Name	Yol	Tür	Description
Güncelleştirme Tarihi:	updated_at	string	Bu güncelleştirmenin RFC 3339 biçimindeki veritabanı zaman damgası.

Tanımlar

object

Bu , 'object' türüdür.