Square Business (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: Sadakat, Hediye Kartları, Bookings, İş, Ekip, Finansallar, Çevrimiçi ve Kimlik Doğrulama.

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

Arama kullanılabilirliği (Beta)	Rezervasyon için uygunluk durumunu arar.
Arama vardiyaları	bir işletme için sayfalandırılmış Shift kayıtlarının listesini döndürür.
Banka hesabı alma	Square hesabına bağlı bir BankAccount'ın ayrıntılarını döndürür.
Banka hesaplarını listeleme	Kare hesaba bağlı BankAccount nesnelerinin listesini döndürür.
Bağlılık programı etkinliklerini arama	Sadakat etkinliklerini arar. Kare sadakat programı, bir alıcının sadakat hesabının ömrü boyunca gerçekleşen olayların bir kayıt defterini tutar. Puan bakiyesindeki her değişiklik (örneğin, kazanılan puanlar, kullanılan puanlar ve süresi dolan puanlar) kayıt defterine kaydedilir. Bu uç noktayı kullanarak, kayıt defterinde olaylar için arama yapabilirsiniz.
Bağlılık programı hesabı oluşturma	Bir sadakat hesabı oluşturur.
Bağlılık programı hesaplarında arama	Sadakat programındaki bağlılık programı hesaplarını arar.
Bağlılık programı puanlarını hesaplama	Satın alma işleminin kazandığı puanları hesaplar. Bir uygulama, bir alıcının belirli bir satın alma işlemiyle kazanabileceği puanları göstermek için bu uç noktayı çağırabilir.
Cihaz kodlarını listeleme	Satıcıyla ilişkili tüm DeviceCode'ları listeler.
Cihaz kodu oluşturma	Bağlı terminal moduna girmek için Bir Square Terminal cihazında oturum açmak için kullanılabilecek bir DeviceCode oluşturur.
Cihaz kodunu alma	İlişkili kimlikle DeviceCode alır.
Ekip üyelerini arama	bir işletme için TeamMember nesnelerinin sayfalandırılmış listesini döndürür.
Ekip üyelerini toplu güncelleştirme	Birden çok TeamMember nesnesini güncelleştirir.
Ekip üyelerini toplu oluşturma	Birden çok TeamMember nesnesi oluşturur.
Ekip üyesi oluşturma	Tek bir TeamMember nesnesi oluşturur.
Ekip üyesi rezervasyon profillerini listeleme (Beta)	Ekip üyeleri için rezervasyon profillerini listeler.
Ekip üyesi ücreti alma	Kimlikle belirtilen tek bir TeamMemberWage döndürür.
Ekip üyesi ücretlerini listeleme	bir işletme için TeamMemberWage örneklerinin sayfalandırılmış listesini döndürür.
Ekip üyesini alma	Verilen TeamMember kimliği için bir TeamMember nesnesi alır.
Ekip üyesini güncelleştirme	Tek bir TeamMember nesnesini güncelleştirir.
GAN'dan hediye kartı alma (Beta)	Hediye kartı hesap numarasını (GAN) kullanarak bir hediye kartı alır.
Güncelleştirme kesme türü	Mevcut bir BreakType'i güncelleştirir.
Hediye kartı etkinliklerini listeleme (Beta)	Hediye kartı etkinliklerini listeler. Varsayılan olarak, satıcının hesabındaki tüm hediye kartları için hediye kartı etkinlikleri alırsınız. İsteğe bağlı olarak, listeyi filtrelemek için sorgu parametreleri belirtebilirsiniz. Örneğin, bir hediye kartı için, belirli bir bölgedeki tüm hediye kartları için veya zaman penceresindeki etkinlikler için hediye kartı etkinliklerinin listesini alabilirsiniz.
Hediye kartı etkinliği oluşturma (Beta)	Hediye kartı etkinliği oluşturur.
Hediye kartını alma (Beta)	Kimliğini kullanarak bir hediye kartı alır.
İş haftası yapılandırmasını güncelleştirme	WorkweekConfig'i güncelleştirir.
İş rezervasyon profilini alma (Beta)	Bir satıcının rezervasyon profilini alır.
Kasa vardiyası alma	Tek bir nakit çekmece vardiyası için özet ayrıntıları sağlar.
Kesme türü oluşturma	Yeni bir BreakType oluşturur. BreakType, Break nesneleri oluşturmaya yönelik bir şablondur.
Kesme türünü alma	Kimlik tarafından belirtilen tek bir BreakType döndürür.
Kesme türünü silme	Var olan bir BreakType'i siler. BreakType, Shift'ten başvurulsa bile silinebilir.
Kod parçacığını alma	Kod parçacığınızı bir Square Online sitesinden alır. Bir site birden çok kod parçacığı uygulamasından kod parçacıkları içerebilir, ancak yalnızca uygulamanız tarafından eklenen kod parçacığını alabilirsiniz.
Kod parçacığını silme	Kod parçacığınızı Bir Square Online sitesinden kaldırır.
Konum alma	Konumun ayrıntılarını alır. Ana konumun ayrıntılarını almak için konum kimliği olarak "main" belirtebilirsiniz.
Konum oluşturma (Beta)	Bir konum oluşturur.
Konumları listeleme	Bir işletmenin tüm konumları hakkında bilgi sağlar.
Konumu güncelleştirme (Beta)	Bir konumu güncelleştirir.
Kullanıma alma oluşturma	Ödeme işleme iş akışı kullanarak ödeme bilgilerini sağlamak için bir checkoutId'yi müşterilerin yönlendirildikleri bir checkout_page_url bağlar.
Liste sonu türleri	bir işletmeye ait BreakType örneklerinin sayfalandırılmış listesini döndürür.
Mobil yetkilendirme kodu oluşturma	Bir mobil uygulamayı Kare kart okuyucuya bağlanacak şekilde yetkilendirmek için kod oluşturur. Yetkilendirme kodları tek seferlik kullanılır ve verildikten 60 dakika sonra süresi dolar.
Müşterinin hediye kartıyla bağlantısını kaldırma (Beta)	Müşterinin hediye kartıyla bağlantısını kaldırır.
Müşteriyi hediye kartına bağlama (Beta)	Müşteriyi hediye kartına bağlar
Nakit çekmece vardiyalarını listeleme	Tarih aralığındaki bir konumun tüm nakit çekmece vardiyalarının ayrıntılarını sağlar.
Nakit çekmece vardiyası etkinliklerini listeleme	Tek bir nakit çekmece vardiyası için olayların sayfalandırılmış listesini sağlar.
Nonce'dan hediye kartı alma (Beta)	Hediye kartını temsil eden bir nonce (güvenli belirteç) kullanarak bir hediye kartı alır.
Rezervasyon oluşturma (Beta)	Bir rezervasyon oluşturur.
Sadakat hesabı alma	Bir sadakat hesabı alır.
Sadakat programı alma	Satışçının hesabında program kimliği veya anahtar sözcük main ile belirtilen sadakat programını alır. Sadakat programları, alıcıların puan kazanma ve ödüller için puan kullanma şeklini tanımlar.
Sadakat puanlarını ayarlama	Bir alıcının hesabına puan ekler veya puan çıkarır. Bu uç noktayı yalnızca noktaları el ile ayarlamanız gerektiğinde kullanın.
Sadakat puanı biriktirin	Bağlılık programı hesabına puan ekler.
Sadakat ödüllerini arama	Sadakat hesabındaki sadakat ödüllerini arar.
Sadakat ödülü oluşturma	Sadakat ödülü oluşturur. Bir ödül oluşturulduktan sonra puanlar kilitlenir ve alıcı başka bir ödülü kullanamayabilir.
Sadakat ödülünü alma	Sadakat ödülü alır.
Sadakat ödülünü kullan	Sadakat ödülü alır. Ödül terminal durumuna ulaştıktan sonra silinemez. Başka bir deyişle ödül için kullanılan puanlar hesaba iade edilemez.
Sadakat ödülünü silme	Sadakat ödülünü siler. Sadakat puanlarını sadakat hesabına geri döndürür. Terminal durumuna ulaşmış bir ödülü silemezsiniz (KULLANILIR).
Satıcıları listeleme	Belirli bir erişim belirtecinin Satıcı bilgilerini döndürür.
Satıcıyı alma	Verilen merchant_id için bir Merchant nesnesi alın.
Siteleri listeleme	Bir satıcıya ait Square Online sitelerini listeler.
Upsert kod parçacığı	Square Online sitesine bir kod parçacığı ekler veya sitedeki mevcut kod parçacığını güncelleştirir. Kod parçacığı kodu, kullanıma alma sayfaları dışında sitenin her sayfasında baş öğesinin sonuna eklenir. Kod parçacığı uygulaması belirli bir siteye bir kod parçacığı ekleyebilir.
V1 kimliğine göre banka hesabı alma	V1 banka hesabı kimliği tarafından tanımlanan Bir BankAccount'ın ayrıntılarını döndürür.
Vardiya alma	Kimlik tarafından belirtilen tek bir Shift döndürür.
Vardiya oluşturma	Yeni bir Shift oluşturur. Vardiya, tek bir çalışan için tam bir iş gününü temsil eder
Vardiyayı güncelleştir	Mevcut bir Shift'i güncelleştirir.
Vardiyayı sil	Vardiyayı siler
Çalışma haftası yapılandırmalarını listeleme	bir işletme için WorkweekConfig örneklerinin listesini döndürür.
Ücret ayarını alma	TeamMember kimliği tarafından belirtilen bir ekip üyesi için WageSetting nesnesi alır.
Ücret ayarını güncelleştirme	WageSetting nesnesi oluşturur veya güncelleştirir.

Arama kullanılabilirliği (Beta)

İşlem Kimliği:

BookingAvailability

Rezervasyon için uygunluk durumunu arar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
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.
Konum Kimliği	location_id		string	Belirtilen satıcı konumu kimlikleriyle eşleşen kullanılabilirlikleri aramak için sorgu ifadesi.
Hizmet Çeşitleme Kimliği	service_variation_id		string	Bu segmentte rezervasyonu yapılan hizmeti temsil eden CatalogItemVariation kimliği.
Herhangi biri	any		array of string

Döndürülenler

Name	Yol	Tür	Description
Kullanılabilirlik	availabilities	array of object
Başlangıç:	availabilities.start_at	string	Kullanılabilir yuvanın başlangıç zamanını belirten RFC 3339 zaman damgası.
Konum Kimliği	availabilities.location_id	string	Konumun tanımlayıcısı.
Randevu Kesimleri	availabilities.appointment_segments	array of object
Süre Dakikaları	availabilities.appointment_segments.duration_minutes	integer	Bir randevu kesiminin dakika cinsinden zaman aralığı.
Ekip Üyesi Kimliği	availabilities.appointment_segments.team_member_id	string	Bu segmentte yer alan ekip üyesini temsil eden TeamMember nesnesinin kimliği.
Hizmet Çeşitleme Kimliği	availabilities.appointment_segments.service_variation_id	string	Bu segmentte rezervasyonu yapılan hizmeti temsil eden CatalogItemVariation nesnesinin kimliği.
Hizmet Varyasyonu Sürümü	availabilities.appointment_segments.service_variation_version	integer	Bu segmentte rezervasyonu yapılan hizmeti temsil eden madde varyasyonunun geçerli sürümü.
Errors	errors	array of

Arama vardiyaları

İşlem Kimliği:

LaborSearchShifts

bir işletme için sayfalandırılmış Shift kayıtlarının listesini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Başlangıç Tarihi	start_date		string	Takvim tarihleri için ISO 8601 genişletilmiş biçimine göre 2017-10-31 gibi YYYY-MM-DD biçiminde bir dize. Tarih aralığının başlangıcı (dahil).
Bitiş Tarihi	end_date		string	Takvim tarihleri için ISO 8601 genişletilmiş biçimine göre 2017-10-31 gibi YYYY-MM-DD biçiminde bir dize. Tarih aralığının sonu (dahil).
Vardiyaları Ölçütüne Göre Eşleştir	match_shifts_by		string	Tarihlerin uygulandığı strateji.
Varsayılan Saat Dilimi	default_timezone		string	Konuma özgü saat dilimleri, iş günlerini tarih saat filtrelerine dönüştürür. Sorguya dahil edilen her konumun bir saat dilimi olması veya bu alanın geri dönüş olarak sağlanması gerekir. Biçim: İlgili saat dilimi için IANA saat dilimi veritabanı tanımlayıcısı.
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
Vardiya	shifts	array of object
Kimlik	shifts.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Ekip Üyesi Kimliği	shifts.team_member_id	string	Nesneyle ilişkilendirilmiş ekip üyesinin TeamMember nesnesinin kimliği.
Konum Kimliği	shifts.location_id	string	Konumun tanımlayıcısı.
Timezone	shifts.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.
Başlangıç:	shifts.start_at	string	Kullanılabilir yuvanın başlangıç zamanını belirten RFC 3339 zaman damgası.
Bitiş:	shifts.end_at	string	RFC 3339; saat dilimi + uzaklık konumuna kaydırıldı. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Başlık	shifts.wage.title	string	Bu vardiya sırasında gerçekleştirilen işin adı. İşgücü raporlama URI'lerinin karesi, vardiyaları başlığa göre gruplandırabilir.
Miktar	shifts.wage.hourly_rate.amount	integer	Miktar.
Para birimi	shifts.wage.hourly_rate.currency	string	Para birimi.
Tatili	shifts.breaks	array of object
Kimlik	shifts.breaks.id	string	Bu nesneye başvurmak için bir tanımlayıcı.
Başlangıç:	shifts.breaks.start_at	string	RFC 3339 biçiminde, zaman aralığının ne zaman başladığını gösteren bir tarih saat değeri.
Bitiş:	shifts.breaks.end_at	string	RFC 3339 biçiminde, zaman aralığının ne zaman sona erdiğini gösteren bir tarih saat değeri.
Kesme Türü Kimliği	shifts.breaks.break_type_id	string	Bu Kesmenin şablonlandığı BreakType.
İsim	shifts.breaks.name	string	İnsan tarafından okunabilen bir isim.
Beklenen Süre	shifts.breaks.expected_duration	string	Kesmenin beklenen uzunluğu. Biçim: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
Ücretlidir	shifts.breaks.is_paid	boolean	Bu kesmenin telafi amacıyla çalıştığı zamana göre sayılıp sayılmayacağı.
Statü	shifts.status	string	Bu nesnenin geçerli doğrulama durumu.
Sürüm	shifts.version	integer	Nesnenin geçerli sürümü.
Oluşturma Tarihi	shifts.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	shifts.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası

Banka hesabı alma

İşlem Kimliği:

BankAccountGet

Square hesabına bağlı bir BankAccount'ın ayrıntılarını döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Banka Hesabı Kimliği	bank_account_id	True	string	İstenen BankAccount değerinin kare olarak verilen kimliği.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	bank_account.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Hesap Numarası Son Eki	bank_account.account_number_suffix	string	Hesap numarasının son birkaç rakamı.
Country	bank_account.country	string	ISO 3166 Alfa-2 ülke kodu.
Para birimi	bank_account.currency	string	3 karakterli ISO 4217 para birimi kodu.
Hesap Türü	bank_account.account_type	string	Hesabın türü.
Tutucu Adı	bank_account.holder_name	string	Hesap sahibinin adı.
Birincil Banka Kimlik Numarası	bank_account.primary_bank_identification_number	string	Bankanın birincil tanımlayıcısı.
Konum Kimliği	bank_account.location_id	string	Konumun tanımlayıcısı.
Statü	bank_account.status	string	Bu nesnenin geçerli doğrulama durumu.
Övülmeye değer	bank_account.creditable	boolean	Square'in bu hesaba para göndermesinin mümkün olup olmadığını gösterir.
Borçlandırılabilir	bank_account.debitable	boolean	Square'in bu hesaptan para almasının mümkün olup olmadığını gösterir.
Sürüm	bank_account.version	integer	Bu nesnenin geçerli sürümü.
Banka Adı	bank_account.bank_name	string	Gerçek finans kurumunun adı.

Banka hesaplarını listeleme

İşlem Kimliği:

BankAccountList

Kare hesaba bağlı BankAccount nesnelerinin 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.
Sınır	limit		integer	Yanıtta döndürülecek sayı üst sınırı.
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
Banka hesabı	bank_accounts	array of object
Kimlik	bank_accounts.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Hesap Numarası Son Eki	bank_accounts.account_number_suffix	string	Hesap numarasının son birkaç rakamı.
Country	bank_accounts.country	string	ISO 3166 Alfa-2 ülke kodu.
Para birimi	bank_accounts.currency	string	3 karakterli ISO 4217 para birimi kodu.
Hesap Türü	bank_accounts.account_type	string	İlişkili banka hesabının finansal amacı.
Tutucu Adı	bank_accounts.holder_name	string	Hesap sahibinin adı. Bu ad, hedeflenen banka hesabı kaydındaki adla eşleşmelidir.
Birincil Banka Kimlik Numarası	bank_accounts.primary_bank_identification_number	string	Bankanın birincil tanımlayıcısı.
Konum Kimliği	bank_accounts.location_id	string	Konumun tanımlayıcısı.
Statü	bank_accounts.status	string	Bu nesnenin geçerli doğrulama durumu.
Övülmeye değer	bank_accounts.creditable	boolean	Square'in bu banka hesabına para göndermesinin mümkün olup olmadığını gösterir.
Borçlandırılabilir	bank_accounts.debitable	boolean	Square'in bu banka hesabına para göndermesinin mümkün olup olmadığını gösterir.
Sürüm	bank_accounts.version	integer	Nesnenin geçerli sürümü.
Banka Adı	bank_accounts.bank_name	string	Gerçek finans kurumunun adı.

Bağlılık programı etkinliklerini arama

İşlem Kimliği:

LoyaltySearchEvents

Sadakat etkinliklerini arar. Kare sadakat programı, bir alıcının sadakat hesabının ömrü boyunca gerçekleşen olayların bir kayıt defterini tutar. Puan bakiyesindeki her değişiklik (örneğin, kazanılan puanlar, kullanılan puanlar ve süresi dolan puanlar) kayıt defterine kaydedilir. Bu uç noktayı kullanarak, kayıt defterinde olaylar için arama yapabilirsiniz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sipariş Kimliği	order_id		string	Sipariş tanımlayıcısı.
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
Events	events	array of object
Kimlik	events.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Türü	events.type	string	Bu nesnenin türü.
Oluşturma Tarihi	events.created_at	string	ISO 8601 biçimindeki olay zamanı.
Bağlılık Programı Kimliği	events.accumulate_points.loyalty_program_id	string	Bağlılık programı kimliği
Points	events.accumulate_points.points	integer	Olay tarafından birikmiş puan sayısı.
Sipariş Kimliği	events.accumulate_points.order_id	string	Etkinlikle ilişkili siparişin kimliği.
Bağlılık Programı Hesabı Kimliği	events.loyalty_account_id	string	Olayın gerçekleştiği bağlılık programı hesabının kimliği.
Konum Kimliği	events.location_id	string	Konumun tanımlayıcısı.
Kaynak	events.source	string	Olayın Satış Noktası Karesi tarafından oluşturulup oluşturulmadığını tanımlar.
Bağlılık Programı Kimliği	events.redeem_reward.loyalty_program_id	string	Bağlılık programı kimliği
Ödül Kimliği	events.redeem_reward.reward_id	string	Kullanılan sadakat ödülünün kimliği.
Sipariş Kimliği	events.redeem_reward.order_id	string	Etkinlikle ilişkili siparişin kimliği.
Bağlılık Programı Kimliği	events.create_reward.loyalty_program_id	string	Bağlılık programı kimliği
Ödül Kimliği	events.create_reward.reward_id	string	Kullanılan sadakat ödülünün kimliği.
Points	events.create_reward.points	integer	Olay tarafından birikmiş puan sayısı.

Bağlılık programı hesabı oluşturma

İşlem Kimliği:

LoyaltyCreateAccount

Bir sadakat hesabı oluşturur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Telefon Numarası	phone_number		string	Alıcının telefon numarası.
Program Kimliği	program_id		string	Programın Kare atanan kimliği.
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	loyalty_account.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Kimlik	loyalty_account.mapping.id	string	Kare olarak atanan kimlik.
Telefon Numarası	loyalty_account.mapping.phone_number	string	Alıcının telefon numarası.
Oluşturma Tarihi	loyalty_account.mapping.created_at	string	Rfc 3339 biçiminde oluşturulduğunda zaman damgası.
Program Kimliği	loyalty_account.program_id	string	Programın Kare atanan kimliği.
Denge	loyalty_account.balance	integer	Kullanılabilir bakiye.
Yaşam Puanı	loyalty_account.lifetime_points	integer	Hesabın ömrü boyunca tahakkuk eden toplam puan.
Oluşturma Tarihi	loyalty_account.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	loyalty_account.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Bağlılık programı hesaplarında arama

İşlem Kimliği:

LoyaltySearchAccounts

Sadakat programındaki bağlılık programı hesaplarını arar.

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.

Döndürülenler

Name	Yol	Tür	Description
Bağlılık Programı Hesapları	loyalty_accounts	array of object
Kimlik	loyalty_accounts.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Kimlik	loyalty_accounts.mapping.id	string	Nesnenin tanımlayıcısı
Telefon Numarası	loyalty_accounts.mapping.phone_number	string	Alıcının telefon numarası.
Oluşturma Tarihi	loyalty_accounts.mapping.created_at	string	Rfc 3339 biçiminde oluşturulduğunda zaman damgası.
Program Kimliği	loyalty_accounts.program_id	string	Hesabın ait olduğu sadakat programının Kare atanan kimliği.
Denge	loyalty_accounts.balance	integer	Bağlılık programı hesabındaki kullanılabilir puan bakiyesi.
Yaşam Puanı	loyalty_accounts.lifetime_points	integer	Hesabın ömrü boyunca tahakkuk eden toplam puan.
Müşteri Kimliği	loyalty_accounts.customer_id	string	Hesapla ilişkilendirilmiş müşterinin Kare olarak atanan kimliği.
Oluşturma Tarihi	loyalty_accounts.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	loyalty_accounts.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
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.

Bağlılık programı puanlarını hesaplama

İşlem Kimliği:

LoyaltyCalculatePoints

Satın alma işleminin kazandığı puanları hesaplar. Bir uygulama, bir alıcının belirli bir satın alma işlemiyle kazanabileceği puanları göstermek için bu uç noktayı çağırabilir.

Parametreler

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

Döndürülenler

Name	Yol	Tür	Description
Points	points	integer	Alıcının belirtilen bir satın alma işlemiyle kazanabileceği puanlar.

Cihaz kodlarını listeleme

İşlem Kimliği:

DeviceList

Satıcıyla ilişkili tüm DeviceCode'ları listeler.

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.
Konum Kimliği	location_id		string	Yalnızca belirli bir konuma ait kayıtları almak için bu isteğe bağlı filtreyi belirtebilirsiniz.
Ürün Türü	product_type		string	Belirtilirse, yalnızca belirtilen ürün türünü hedefleyen DeviceCodes döndürür. Boşsa tüm ürün türlerinin DeviceCode'larını döndürür.
Statü	status		string	Belirtilirse, yalnızca belirtilen durumlarla eşleşen nesneleri döndürür.

Döndürülenler

Name	Yol	Tür	Description
Cihaz Kodları	device_codes	array of object
Kimlik	device_codes.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İsim	device_codes.name	string	Nesnenin adı.
Kod	device_codes.code	string	Oturum açmak için kullanılabilecek benzersiz kod.
Ürün Türü	device_codes.product_type	string	Cihaz kodunun hedef ürün türü.
Konum Kimliği	device_codes.location_id	string	Konumun tanımlayıcısı.
Oluşturma Tarihi	device_codes.created_at	string	ISO 8601 biçimindeki olay zamanı.
Eşleştirme Ölçütü	device_codes.pair_by	string	Bu DeviceCode'un süresi dolduğunda ve artık oturum açmadığında. RFC 3339 biçiminde zaman damgası.
Statü	device_codes.status	string	Bu nesnenin geçerli doğrulama durumu.
Cihaz Kimliği	device_codes.device_id	string	Bu kodu kullanan cihazın benzersiz kimliği. Cihaz eşlendiğinde doldurulur.
Durum Değiştirildiği Yer	device_codes.status_changed_at	string	Bu DeviceCode'un durumu son değiştirildiğinde. RFC 3339 biçiminde zaman damgası.

Cihaz kodu oluşturma

İşlem Kimliği:

DeviceCreate

Bağlı terminal moduna girmek için Bir Square Terminal cihazında oturum açmak için kullanılabilecek bir DeviceCode 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.
İsim	name		string	Nesnenin adı.
Konum Kimliği	location_id		string	Konumun tanımlayıcısı.
Ürün Türü	product_type		string	Cihaz kodunun hedef ürün türü.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	device_code.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İsim	device_code.name	string	Nesnenin adı.
Kod	device_code.code	string	Oturum açmak için kullanılabilecek benzersiz kod.
Ürün Türü	device_code.product_type	string	Cihaz kodunun hedef ürün türü.
Konum Kimliği	device_code.location_id	string	Konumun tanımlayıcısı.
Oluşturma Tarihi	device_code.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Eşleştirme Ölçütü	device_code.pair_by	string	Bu DeviceCode'un süresi dolduğunda ve artık oturum açmadığında. RFC 3339 biçiminde zaman damgası.
Statü	device_code.status	string	Bu nesnenin geçerli doğrulama durumu.
Durum Değiştirildiği Yer	device_code.status_changed_at	string	Bu DeviceCode'un durumu son değiştirildiğinde. RFC 3339 biçiminde zaman damgası.

Cihaz kodunu alma

İşlem Kimliği:

DeviceGet

İlişkili kimlikle DeviceCode alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Tanımlayıcı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	device_code.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İsim	device_code.name	string	Nesnenin adı.
Kod	device_code.code	string	Oturum açmak için kullanılabilecek benzersiz kod.
Ürün Türü	device_code.product_type	string	Cihaz kodunun hedef ürün türü.
Konum Kimliği	device_code.location_id	string	Konumun tanımlayıcısı.
Oluşturma Tarihi	device_code.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Eşleştirme Ölçütü	device_code.pair_by	string	Bu DeviceCode'un süresi dolduğunda ve artık oturum açmadığında. RFC 3339 biçiminde zaman damgası.
Statü	device_code.status	string	Bu nesnenin geçerli doğrulama durumu.
Cihaz Kimliği	device_code.device_id	string	Cihazın kimliği.
Durum Değiştirildiği Yer	device_code.status_changed_at	string	Bu DeviceCode'un durumu son değiştirildiğinde. RFC 3339 biçiminde zaman damgası.

Ekip üyelerini arama

İşlem Kimliği:

TeamSearch

bir işletme için TeamMember nesnelerinin sayfalandırılmış listesini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Konum Kimlikleri	location_ids		array of string
Statü	status		string	Geçerli durum.
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
Ekip Üyeleri	team_members	array of object
Kimlik	team_members.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Başvuru Kimliği	team_members.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.
Sahip	team_members.is_owner	boolean	Ekip üyesinin Square hesabının sahibi olup olmadığı.
Statü	team_members.status	string	Bu nesnenin geçerli doğrulama durumu.
İsim	team_members.given_name	string	Müşteri profiliyle ilişkilendirilmiş verilen (yani ad) adı.
Aile Adı	team_members.family_name	string	Müşteri profiliyle ilişkili aile (soyadı) adı.
E-posta Adresi	team_members.email_address	string	Müşteri profiliyle ilişkili e-posta adresi.
Oluşturma Tarihi	team_members.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	team_members.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Atama Türü	team_members.assigned_locations.assignment_type	string	Ekip üyesinin geçerli atama türü.
Telefon Numarası	team_members.phone_number	string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
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.

Ekip üyelerini toplu güncelleştirme

İşlem Kimliği:

TeamUpdateBulkMembers

Birden çok TeamMember nesnesini güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Başvuru Kimliği	reference_id		string	Ekip üyesini başka bir sistemdeki bir varlıkla ilişkilendirmek için kullanılan ikinci kimlik.
Sahip	is_owner		boolean	Ekip üyesinin Square hesabının sahibi olup olmadığı.
Statü	status		string	Ekip üyesinin durumunu açıklar.
İsim	given_name		string	Ekip üyesiyle ilişkili verilen ad (yani ad).
Aile Adı	family_name		string	Ekip üyesiyle ilişkili aile adı (soyadı).
E-posta Adresi	email_address		string	Ekip üyesiyle ilişkili e-posta adresi.
Telefon Numarası	phone_number		string	Ekip üyesinin E.164 biçimindeki telefon numarası.
Konum Kimlikleri	location_ids		array of string
Atama Türü	assignment_type		string	Ekip üyesinin geçerli atama türü.
Başvuru Kimliği	reference_id		string	Ekip üyesini başka bir sistemdeki bir varlıkla ilişkilendirmek için kullanılan ikinci kimlik.
Sahip	is_owner		boolean	Ekip üyesinin Square hesabının sahibi olup olmadığı.
Statü	status		string	Ekip üyesinin durumunu açıklar.
İsim	given_name		string	Ekip üyesiyle ilişkili verilen ad (yani ad).
Aile Adı	family_name		string	Ekip üyesiyle ilişkili aile adı (soyadı).
E-posta Adresi	email_address		string	Ekip üyesiyle ilişkili e-posta adresi.
Telefon Numarası	phone_number		string	Ekip üyesinin E.164 biçimindeki telefon numarası.
Atama Türü	assignment_type		string	Ekip üyesinin geçerli atama türü.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	team_members.team_member_id.team_member.id	string	Bu nesneye başvurmak için bir tanımlayıcı.
Başvuru Kimliği	team_members.team_member_id.team_member.reference_id	string	Ekip üyesini başka bir sistemdeki bir varlıkla ilişkilendirmek için kullanılan ikinci kimlik.
Sahip	team_members.team_member_id.team_member.is_owner	boolean	Ekip üyesinin Square hesabının sahibi olup olmadığı.
Statü	team_members.team_member_id.team_member.status	string	Ekip üyesinin durumunu açıklar.
İsim	team_members.team_member_id.team_member.given_name	string	Ekip üyesiyle ilişkili verilen ad (yani ad).
Aile Adı	team_members.team_member_id.team_member.family_name	string	Ekip üyesiyle ilişkili aile adı (soyadı).
E-posta Adresi	team_members.team_member_id.team_member.email_address	string	Ekip üyesiyle ilişkili e-posta adresi.
Telefon Numarası	team_members.team_member_id.team_member.phone_number	string	Ekip üyesinin E.164 biçimindeki telefon numarası.
Oluşturma Tarihi	team_members.team_member_id.team_member.created_at	string	RFC 3339 biçiminde, ekip üyesinin ne zaman oluşturulduğunu açıklayan zaman damgası
Atama Türü	team_members.team_member_id.team_member.assigned_locations.assignment_type	string	Ekip üyesinin geçerli atama türü.
Konum Kimlikleri	team_members.team_member_id.team_member.assigned_locations.location_ids	array of string

Ekip üyelerini toplu oluşturma

İşlem Kimliği:

TeamCreateBulkMembers

Birden çok TeamMember nesnesi oluşturur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İsim	given_name		string	Ekip üyesiyle ilişkili verilen ad (yani ad).
Aile Adı	family_name		string	Ekip üyesiyle ilişkili aile adı (soyadı).
E-posta Adresi	email_address		string	Ekip üyesiyle ilişkili e-posta adresi.
Başvuru Kimliği	reference_id		string	Ekip üyesini başka bir sistemdeki bir varlıkla ilişkilendirmek için kullanılan ikinci kimlik.
Telefon Numarası	phone_number		string	Ekip üyesinin E.164 biçimindeki telefon numarası.
Konum Kimlikleri	location_ids		array of string
Atama Türü	assignment_type		string	Ekip üyesinin geçerli atama türü.
İsim	given_name		string	Ekip üyesiyle ilişkili verilen ad (yani ad).
Aile Adı	family_name		string	Ekip üyesiyle ilişkili aile adı (soyadı).
E-posta Adresi	email_address		string	Ekip üyesiyle ilişkili e-posta adresi.
Başvuru Kimliği	reference_id		string	Ekip üyesini başka bir sistemdeki bir varlıkla ilişkilendirmek için kullanılan ikinci kimlik.
Telefon Numarası	phone_number		string	Ekip üyesinin E.164 biçimindeki telefon numarası.
Atama Türü	assignment_type		string	Ekip üyesinin geçerli atama türü.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	team_members.idempotency-key-1.team_member.id	string	Bu nesneye başvurmak için bir tanımlayıcı.
Başvuru Kimliği	team_members.idempotency-key-1.team_member.reference_id	string	Ekip üyesini başka bir sistemdeki bir varlıkla ilişkilendirmek için kullanılan ikinci kimlik.
Sahip	team_members.idempotency-key-1.team_member.is_owner	boolean	Ekip üyesinin Square hesabının sahibi olup olmadığı.
Statü	team_members.idempotency-key-1.team_member.status	string	Ekip üyesinin durumunu açıklar.
İsim	team_members.idempotency-key-1.team_member.given_name	string	Ekip üyesiyle ilişkili verilen ad (yani ad).
Aile Adı	team_members.idempotency-key-1.team_member.family_name	string	Ekip üyesiyle ilişkili aile adı (soyadı).
E-posta Adresi	team_members.idempotency-key-1.team_member.email_address	string	Ekip üyesiyle ilişkili e-posta adresi.
Telefon Numarası	team_members.idempotency-key-1.team_member.phone_number	string	Ekip üyesinin E.164 biçimindeki telefon numarası.
Atama Türü	team_members.idempotency-key-1.team_member.assigned_locations.assignment_type	string	Ekip üyesinin geçerli atama türü.
Konum Kimlikleri	team_members.idempotency-key-1.team_member.assigned_locations.location_ids	array of string
Kimlik	team_members.idempotency-key-2.team_member.id	string	Bu nesneye başvurmak için bir tanımlayıcı.
Başvuru Kimliği	team_members.idempotency-key-2.team_member.reference_id	string	Ekip üyesini başka bir sistemdeki bir varlıkla ilişkilendirmek için kullanılan ikinci kimlik.
Sahip	team_members.idempotency-key-2.team_member.is_owner	boolean	Ekip üyesinin Square hesabının sahibi olup olmadığı.
Statü	team_members.idempotency-key-2.team_member.status	string	Ekip üyesinin durumunu açıklar.
İsim	team_members.idempotency-key-2.team_member.given_name	string	Ekip üyesiyle ilişkili verilen ad (yani ad).
Aile Adı	team_members.idempotency-key-2.team_member.family_name	string	Ekip üyesiyle ilişkili aile adı (soyadı).
E-posta Adresi	team_members.idempotency-key-2.team_member.email_address	string	Ekip üyesiyle ilişkili e-posta adresi.
Telefon Numarası	team_members.idempotency-key-2.team_member.phone_number	string	Ekip üyesinin E.164 biçimindeki telefon numarası.
Atama Türü	team_members.idempotency-key-2.team_member.assigned_locations.assignment_type	string	Ekip üyesinin geçerli atama türü.

Ekip üyesi oluşturma

İşlem Kimliği:

TeamCreateMember

Tek bir TeamMember nesnesi 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.
Statü	status		string	Bu nesnenin geçerli doğrulama durumu.
İsim	given_name		string	Müşteri profiliyle ilişkilendirilmiş verilen (yani ad) adı.
Aile Adı	family_name		string	Müşteri profiliyle ilişkili aile (soyadı) adı.
E-posta Adresi	email_address		string	Müşteri profiliyle ilişkili e-posta adresi.
Telefon Numarası	phone_number		string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
Konum Kimlikleri	location_ids		array of string
Atama Türü	assignment_type		string	Ekip üyesinin geçerli atama türü.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	team_member.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Başvuru Kimliği	team_member.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Sahip	team_member.is_owner	boolean	Ekip üyesinin Square hesabının sahibi olup olmadığı.
Statü	team_member.status	string	Bu nesnenin geçerli doğrulama durumu.
İsim	team_member.given_name	string	Müşteri profiliyle ilişkilendirilmiş verilen (yani ad) adı.
Aile Adı	team_member.family_name	string	Müşteri profiliyle ilişkili aile (soyadı) adı.
E-posta Adresi	team_member.email_address	string	Müşteri profiliyle ilişkili e-posta adresi.
Telefon Numarası	team_member.phone_number	string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
Atama Türü	team_member.assigned_locations.assignment_type	string	Ekip üyesinin geçerli atama türü.
Konum Kimlikleri	team_member.assigned_locations.location_ids	array of string

Ekip üyesi rezervasyon profillerini listeleme (Beta)

İşlem Kimliği:

BookingListTeamProfiles

Ekip üyeleri için rezervasyon profillerini listeler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Yalnızca Rezervasyon Yapılabilir	bookable_only		boolean	Döndürülen sonuca yalnızca rezerve edilebilir ekip üyelerinin eklenip eklenmeyeceğini (true) veya eklenip eklenmeyeceğini (false) gösterir.
Sınır	limit		integer	Yanıtta döndürülecek sayı üst sınırı.
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.

Döndürülenler

Name	Yol	Tür	Description
Ekip Üyesi Rezervasyon Profilleri	team_member_booking_profiles	array of object
Ekip Üyesi Kimliği	team_member_booking_profiles.team_member_id	string	Nesneyle ilişkilendirilmiş ekip üyesinin TeamMember nesnesinin kimliği.
Görüntü adı	team_member_booking_profiles.display_name	string	Ekip üyesinin görünen adı.
Rezerve Edilebilir	team_member_booking_profiles.is_bookable	boolean	Ekip üyesinin Bookings API'sini veya satıcının çevrimiçi rezervasyon kanalını ya da sitesini (doğru) ya da rezervasyonu (false' olarak) yapıp yapmadığını gösterir.
Errors	errors	array of

Ekip üyesi ücreti alma

İşlem Kimliği:

LaborGetWage

Kimlikle belirtilen tek bir TeamMemberWage döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Tanımlayıcı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	team_member_wage.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Ekip Üyesi Kimliği	team_member_wage.team_member_id	string	Ekip üyesinin kimliği.
Başlık	team_member_wage.title	string	Başlık.
Miktar	team_member_wage.hourly_rate.amount	integer	Miktar.
Para birimi	team_member_wage.hourly_rate.currency	string	Para birimi.

Ekip üyesi ücretlerini listeleme

İşlem Kimliği:

LaborListWages

bir işletme için TeamMemberWage örneklerinin sayfalandırılmış listesini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ekip Üyesi Kimliği	team_member_id		string	Döndürülen ücretleri yalnızca belirtilen ekip üyesiyle ilişkili olanlara göre filtreleyin.
Sınır	limit		integer	Yanıtta döndürülecek sayı üst sınırı.
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
Ekip Üyesi Ücretleri	team_member_wages	array of object
Kimlik	team_member_wages.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Ekip Üyesi Kimliği	team_member_wages.team_member_id	string	Nesneyle ilişkilendirilmiş ekip üyesinin TeamMember nesnesinin kimliği.
Başlık	team_member_wages.title	string	Faturanın başlığı.
Miktar	team_member_wages.hourly_rate.amount	integer	Miktar.
Para birimi	team_member_wages.hourly_rate.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.

Ekip üyesini alma

İşlem Kimliği:

TeamRetrieveMember

Verilen TeamMember kimliği için bir TeamMember nesnesi alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ekip Üyesi Kimliği	team_member_id	True	string	Ekip üyesinin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	team_member.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Başvuru Kimliği	team_member.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Sahip	team_member.is_owner	boolean	Ekip üyesinin Square hesabının sahibi olup olmadığı.
Statü	team_member.status	string	Bu nesnenin geçerli doğrulama durumu.
İsim	team_member.given_name	string	Müşteri profiliyle ilişkilendirilmiş verilen (yani ad) adı.
Aile Adı	team_member.family_name	string	Müşteri profiliyle ilişkili aile (soyadı) adı.
E-posta Adresi	team_member.email_address	string	Müşteri profiliyle ilişkili e-posta adresi.
Telefon Numarası	team_member.phone_number	string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
Oluşturma Tarihi	team_member.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	team_member.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Atama Türü	team_member.assigned_locations.assignment_type	string	Ekip üyesinin geçerli atama türü.
Konum Kimlikleri	team_member.assigned_locations.location_ids	array of string

Ekip üyesini güncelleştirme

İşlem Kimliği:

TeamUpdate

Tek bir TeamMember nesnesini güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ekip Üyesi Kimliği	team_member_id	True	string	Ekip üyesinin tanımlayıcısı.
Başvuru Kimliği	reference_id		string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Statü	status		string	Bu nesnenin geçerli doğrulama durumu.
İsim	given_name		string	Müşteri profiliyle ilişkilendirilmiş verilen (yani ad) adı.
Aile Adı	family_name		string	Müşteri profiliyle ilişkili aile (soyadı) adı.
E-posta Adresi	email_address		string	Müşteri profiliyle ilişkili e-posta adresi.
Telefon Numarası	phone_number		string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
Konum Kimlikleri	location_ids		array of string
Atama Türü	assignment_type		string	Ekip üyesinin geçerli atama türü.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	team_member.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Başvuru Kimliği	team_member.reference_id	string	İsteğe bağlı kullanıcı tanımlı başvuru kimliği.
Sahip	team_member.is_owner	boolean	Ekip üyesinin Square hesabının sahibi olup olmadığı.
Statü	team_member.status	string	Bu nesnenin geçerli doğrulama durumu.
İsim	team_member.given_name	string	Müşteri profiliyle ilişkilendirilmiş verilen (yani ad) adı.
Aile Adı	team_member.family_name	string	Müşteri profiliyle ilişkili aile (soyadı) adı.
E-posta Adresi	team_member.email_address	string	Müşteri profiliyle ilişkili e-posta adresi.
Telefon Numarası	team_member.phone_number	string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
Oluşturma Tarihi	team_member.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Atama Türü	team_member.assigned_locations.assignment_type	string	Ekip üyesinin geçerli atama türü.
Konum Kimlikleri	team_member.assigned_locations.location_ids	array of string

GAN'dan hediye kartı alma (Beta)

İşlem Kimliği:

GiftCardRetrieveGAN

Hediye kartı hesap numarasını (GAN) kullanarak bir hediye kartı alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
GaN	gan		string	Hediye kartı hesap numarası.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	gift_card.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Türü	gift_card.type	string	Bu nesnenin türü.
GAN Kaynağı	gift_card.gan_source	string	Hediye kartı hesap numarasının (GAN) Kare tarafından mı oluşturulduğunu yoksa Kare olmayan bir sistemden mi içeri aktarılacağını gösterir.
Devlet	gift_card.state	string	Geçerli durum.
Miktar	gift_card.balance_money.amount	integer	Miktar.
Para birimi	gift_card.balance_money.currency	string	Para birimi.
GaN	gift_card.gan	string	Hediye kartı hesap numarası.
Oluşturma Tarihi	gift_card.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.

Güncelleştirme kesme türü

İşlem Kimliği:

LaborUpdateBreak

Mevcut bir BreakType'i güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Tanımlayıcı.
Konum Kimliği	location_id		string	Konumun tanımlayıcısı.
Kesme Adı	break_name		string	Bu tür bir kesme için okunabilir bir ad. Bu ad Square ürünlerinde çalışanlara görüntülenir.
Beklenen Süre	expected_duration		string	Bu kesmenin beklenen uzunluğu. Biçim: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Duyarlık dakikalar içinde kesilir.
Ücretlidir	is_paid		boolean	Bu kesmenin telafi amacıyla çalıştığı zamana göre sayılıp sayılmayacağı.
Sürüm	version		integer	Bu nesnenin geçerli sürümü.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	break_type.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	break_type.location_id	string	Konumun tanımlayıcısı.
Kesme Adı	break_type.break_name	string	Bu tür bir kesme için okunabilir bir ad. Bu ad Square ürünlerinde çalışanlara görüntülenir.
Beklenen Süre	break_type.expected_duration	string	Bu kesmenin beklenen uzunluğu. Biçim: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Duyarlık dakikalar içinde kesilir.
Ücretlidir	break_type.is_paid	boolean	Bu kesmenin telafi amacıyla çalıştığı zamana göre sayılıp sayılmayacağı.
Sürüm	break_type.version	integer	Bu nesnenin geçerli sürümü.
Oluşturma Tarihi	break_type.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	break_type.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Hediye kartı etkinliklerini listeleme (Beta)

İşlem Kimliği:

GiftCardList

Hediye kartı etkinliklerini listeler. Varsayılan olarak, satıcının hesabındaki tüm hediye kartları için hediye kartı etkinlikleri alırsınız. İsteğe bağlı olarak, listeyi filtrelemek için sorgu parametreleri belirtebilirsiniz. Örneğin, bir hediye kartı için, belirli bir bölgedeki tüm hediye kartları için veya zaman penceresindeki etkinlikler için hediye kartı etkinliklerinin listesini alabilirsiniz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Hediye Kartı Kimliği	gift_card_id		string	Hediye kartı kimliği sağlarsanız uç nokta, belirtilen hediye kartına ait etkinlikleri döndürür. Aksi takdirde uç nokta, satıcı için tüm hediye kartı etkinliklerini döndürür.
Türü	type		string	Bir tür sağlarsanız, uç nokta bu türdeki hediye kartı etkinliklerini döndürür. Aksi takdirde uç nokta tüm hediye kartı etkinlik türlerini döndürür.
Konum Kimliği	location_id		string	Yalnızca belirli bir konuma ait kayıtları almak için bu isteğe bağlı filtreyi belirtebilirsiniz.
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ınır	limit		integer	Yanıtta döndürülecek sayı üst sınırı.
Cursor	cursor		string	Bu uç noktaya önceki bir çağrı tarafından döndürülen sayfalandırma imleci.
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
Hediye Kartı Etkinlikleri	gift_card_activities	array of object
Kimlik	gift_card_activities.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Türü	gift_card_activities.type	string	Bu nesnenin türü.
Konum Kimliği	gift_card_activities.location_id	string	Konumun tanımlayıcısı.
Oluşturma Tarihi	gift_card_activities.created_at	string	ISO 8601 biçimindeki olay zamanı.
Hediye Kartı Kimliği	gift_card_activities.gift_card_id	string	Hediye kartı kimliği. GAN varsa kimlik gerekli değildir.
Hediye Kartı GAN	gift_card_activities.gift_card_gan	string	Hediye kartı GAN. gift_card_id varsa GAN gerekli değildir.
Miktar	gift_card_activities.gift_card_balance_money.amount	integer	Miktar.
Para birimi	gift_card_activities.gift_card_balance_money.currency	string	Para birimi.
Miktar	gift_card_activities.redeem_activity_details.amount_money.amount	integer	Miktar.
Para birimi	gift_card_activities.redeem_activity_details.amount_money.currency	string	Para birimi.
Miktar	gift_card_activities.activate_activity_details.amount_money.amount	integer	Miktar.
Para birimi	gift_card_activities.activate_activity_details.amount_money.currency	string	Para birimi.
Sipariş Kimliği	gift_card_activities.activate_activity_details.order_id	string	Etkinlikle ilişkili siparişin kimliği.
Satır Öğesi UID	gift_card_activities.activate_activity_details.line_item_uid	string	Hediye kartı satırı öğesinin siparişteki line_item_uid.

Hediye kartı etkinliği oluşturma (Beta)

İşlem Kimliği:

GiftCardCreate

Hediye kartı etkinliğ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.
Hediye Kartı Kimliği	gift_card_id		string	Hediye kartı kimliği. GAN varsa kimlik gerekli değildir.
Türü	type		string	Bu nesnenin türü.
Konum Kimliği	location_id		string	Konumun tanımlayıcısı.
Sipariş Kimliği	order_id		string	Etkinlikle ilişkili siparişin kimliği.
Satır Öğesi UID	line_item_uid		string	Hediye kartı satırı öğesinin siparişteki line_item_uid.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	gift_card_activity.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Hediye Kartı Kimliği	gift_card_activity.gift_card_id	string	Hediye kartı kimliği. GAN varsa kimlik gerekli değildir.
Hediye Kartı GAN	gift_card_activity.gift_card_gan	string	Hediye kartı GAN. gift_card_id varsa GAN gerekli değildir.
Türü	gift_card_activity.type	string	Bu nesnenin türü.
Miktar	gift_card_activity.gift_card_balance_money.amount	integer	Miktar.
Para birimi	gift_card_activity.gift_card_balance_money.currency	string	Para birimi.
Konum Kimliği	gift_card_activity.location_id	string	Konumun tanımlayıcısı.
Oluşturma Tarihi	gift_card_activity.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Miktar	gift_card_activity.activate_activity_details.amount_money.amount	integer	Miktar.
Para birimi	gift_card_activity.activate_activity_details.amount_money.currency	string	Para birimi.
Sipariş Kimliği	gift_card_activity.activate_activity_details.order_id	string	Etkinlikle ilişkili siparişin kimliği.
Satır Öğesi UID	gift_card_activity.activate_activity_details.line_item_uid	string	Hediye kartı satırı öğesinin siparişteki line_item_uid.

Hediye kartını alma (Beta)

İşlem Kimliği:

GiftCardRetrieve

Kimliğini kullanarak bir hediye kartı alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Tanımlayıcı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	gift_card.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Türü	gift_card.type	string	Bu nesnenin türü.
GAN Kaynağı	gift_card.gan_source	string	Hediye kartı hesap numarasının (GAN) Kare tarafından mı oluşturulduğunu yoksa Kare olmayan bir sistemden mi içeri aktarılacağını gösterir.
Devlet	gift_card.state	string	Geçerli durum.
Miktar	gift_card.balance_money.amount	integer	Miktar.
Para birimi	gift_card.balance_money.currency	string	Para birimi.
GaN	gift_card.gan	string	Hediye kartı hesap numarası.
Oluşturma Tarihi	gift_card.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.

İş haftası yapılandırmasını güncelleştirme

İşlem Kimliği:

LaborUpdateConfig

WorkweekConfig'i güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Tanımlayıcı.
Haftanın Başlangıcı	start_of_week		string	Telafi amacıyla iş haftasının sona erdiği gün.
Yerel Saatle Günün Başlangıcı	start_of_day_local_time		string	İş haftasının sona erdiği yerel saat. SS:MM biçiminde bir dize olarak temsil edilir (SS:DD:SS de kabul edilir, ancak saniyeler kesilir).
Sürüm	version		integer	Bu nesnenin geçerli sürümü.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	workweek_config.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Haftanın Başlangıcı	workweek_config.start_of_week	string	Telafi amacıyla iş haftasının sona erdiği gün.
Yerel Saatle Günün Başlangıcı	workweek_config.start_of_day_local_time	string	İş haftasının sona erdiği yerel saat. SS:MM biçiminde bir dize olarak temsil edilir (SS:DD:SS de kabul edilir, ancak saniyeler kesilir).
Sürüm	workweek_config.version	integer	Bu nesnenin geçerli sürümü.
Oluşturma Tarihi	workweek_config.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	workweek_config.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

İş rezervasyon profilini alma (Beta)

İşlem Kimliği:

BookingRetrieveProfile

Bir satıcının rezervasyon profilini alır.

Döndürülenler

Name	Yol	Tür	Description
Satıcı Kimliği	business_booking_profile.seller_id	string	Satıcılar API'si kullanılarak elde edilebilen satıcının kimliği.
Oluşturma Tarihi	business_booking_profile.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Rezervasyon Etkinleştirildi	business_booking_profile.booking_enabled	boolean	Satıcının rezervasyon için açık olup olmadığını gösterir.
Müşteri Saat Dilimi Seçimi	business_booking_profile.customer_timezone_choice	string	Bir rezervasyonun müşterinin saat dilimi bilgilerini seçme. Square online rezervasyon sitesi ve müşterilere yapılan tüm bildirimler, satıcı konumunun saat dilimini veya müşterinin rezervasyon sırasında seçtiği saat dilimini kullanır.
Rezervasyon İlkesi	business_booking_profile.booking_policy	string	Satıcının rezervasyon isteklerini otomatik olarak kabul etme (ACCEPT_ALL) veya kabul etmemesi (REQUIRES_ACCEPTANCE) ilkesi.
Kullanıcının İptal etmesine izin ver	business_booking_profile.allow_user_cancel	boolean	Müşterilerin kendi rezervasyonlarını iptal edip edemeyeceğini veya yeniden zamanlayıp zamanlayamayacağını gösterir (true) veya değil (false).
Konum Türleri	business_booking_profile.business_appointment_settings.location_types	array of string
Hizalama Zamanı	business_booking_profile.business_appointment_settings.alignment_time	string	Rezervasyonlar için hizmet süresinin zaman birimi.
Min Booking Tead Time Seconds	business_booking_profile.business_appointment_settings.min_booking_lead_time_seconds	integer	Bir hizmetin rezerve edilebilmesi için saniye cinsinden minimum sağlama süresi. Rezervasyonlar, rezervasyonun başlangıç saatinden en az bu kadar önce oluşturulmalıdır.
Maksimum Rezervasyon Sağlama Süresi Saniye sayısı	business_booking_profile.business_appointment_settings.max_booking_lead_time_seconds	integer	Bir hizmetin rezerve edilebilmesi için saniye cinsinden maksimum sağlama süresi. Rezervasyonlar, rezervasyonun başlangıç saatinden bu kadar önce oluşturulmalıdır.
Tüm Ekip Üyesi Rezervasyonları Etkin	business_booking_profile.business_appointment_settings.any_team_member_booking_enabled	boolean	Bir müşterinin tüm kullanılabilir zaman aralıklarından birini seçip seçemeyeceğini ve personel üyesinin otomatik olarak atanıp atanmayacağını (doğru) veya değil (false) gösterir.
Birden Çok Hizmet Rezervasyonu Etkin	business_booking_profile.business_appointment_settings.multiple_service_booking_enabled	boolean	Bir müşterinin tek bir çevrimiçi rezervasyonda birden çok hizmet rezervasyonu yapıp yapmadığını gösterir.
Miktar	business_booking_profile.business_appointment_settings.cancellation_fee_money.amount	string	Para birimiyle belirtilen para biriminin en küçük paydası olan para miktarı
Para birimi	business_booking_profile.business_appointment_settings.cancellation_fee_money.currency	string	ISO 4217 biçimindeki para biriminin türü.
İptal İlkesi	business_booking_profile.business_appointment_settings.cancellation_policy	string	Satıcı tarafından benimsenen iptal ilkesi.
Rezervasyon Akışı Personel Seçimini Atla	business_booking_profile.business_appointment_settings.skip_booking_flow_staff_selection	boolean	Müşterilerin atanmış bir personel üyesi (true) olup olmadığını veya tercih ettikleri personel üyesini (yanlış) seçip seçemeyeceğini gösterir.
Errors	errors	array of

Kasa vardiyası alma

İşlem Kimliği:

CashDrawerRetrieveShift

Tek bir nakit çekmece vardiyası için özet ayrıntıları sağlar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Shift Kimliği	shift_id	True	string	Vardiyanın tanımlayıcısı.
Konum Kimliği	location_id	True	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
Kimlik	cash_drawer_shift.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Devlet	cash_drawer_shift.state	string	Geçerli durum.
Açılış:	cash_drawer_shift.opened_at	string	Vardiyanın başladığı saat, ISO 8601 biçimindedir.
Bitiş:	cash_drawer_shift.ended_at	string	Vardiyanın sona ertiği saat, ISO 8601 biçimindedir.
Kapalı:	cash_drawer_shift.closed_at	string	Iso 8601 biçiminde kapatılan zaman.
Çalışan Kimliği Açılıyor	cash_drawer_shift.opening_employee_id	string	Nakit çekmece vardiyasını başlatan çalışanın kimliği.
Son Çalışan Kimliği	cash_drawer_shift.ending_employee_id	string	Kasa vardiyasını sonlandıran çalışanın kimliği.
Çalışan Kimliği Kapatılıyor	cash_drawer_shift.closing_employee_id	string	Nakit çekmecesinin içeriğini denetleyerek kasa vardiyasını kapatan çalışanın kimliği.
Description	cash_drawer_shift.description	string	Açıklama.
Miktar	cash_drawer_shift.opened_cash_money.amount	integer	Miktar.
Para birimi	cash_drawer_shift.opened_cash_money.currency	string	Para birimi.
Miktar	cash_drawer_shift.cash_payment_money.amount	integer	Miktar.
Para birimi	cash_drawer_shift.cash_payment_money.currency	string	Para birimi.
Miktar	cash_drawer_shift.cash_refunds_money.amount	integer	Miktar.
Para birimi	cash_drawer_shift.cash_refunds_money.currency	string	Para birimi.
Miktar	cash_drawer_shift.cash_paid_in_money.amount	integer	Miktar.
Para birimi	cash_drawer_shift.cash_paid_in_money.currency	string	Para birimi.
Miktar	cash_drawer_shift.cash_paid_out_money.amount	integer	Miktar.
Para birimi	cash_drawer_shift.cash_paid_out_money.currency	string	Para birimi.
Miktar	cash_drawer_shift.expected_cash_money.amount	integer	Miktar.
Para birimi	cash_drawer_shift.expected_cash_money.currency	string	Para birimi.
Miktar	cash_drawer_shift.closed_cash_money.amount	integer	Miktar.
Para birimi	cash_drawer_shift.closed_cash_money.currency	string	Para birimi.
İsim	cash_drawer_shift.device.name	string	Adı.

Kesme türü oluşturma

İşlem Kimliği:

LaborCreateBreak

Yeni bir BreakType oluşturur. BreakType, Break nesneleri oluşturmaya yönelik bir şablondur.

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ı.
Kesme Adı	break_name		string	Bu tür bir kesme için okunabilir bir ad. Bu ad Square ürünlerinde çalışanlara görüntülenir.
Beklenen Süre	expected_duration		string	Bu kesmenin beklenen uzunluğu. Biçim: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Duyarlık dakikalar içinde kesilir.
Ücretlidir	is_paid		boolean	Bu kesmenin telafi amacıyla çalıştığı zamana göre sayılıp sayılmayacağı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	break_type.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	break_type.location_id	string	Konumun tanımlayıcısı.
Kesme Adı	break_type.break_name	string	Bu tür bir kesme için okunabilir bir ad. Bu ad Square ürünlerinde çalışanlara görüntülenir.
Beklenen Süre	break_type.expected_duration	string	Bu kesmenin beklenen uzunluğu. Biçim: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Duyarlık dakikalar içinde kesilir.
Ücretlidir	break_type.is_paid	boolean	Bu kesmenin telafi amacıyla çalıştığı zamana göre sayılıp sayılmayacağı.
Sürüm	break_type.version	integer	Bu nesnenin geçerli sürümü.
Oluşturma Tarihi	break_type.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	break_type.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Kesme türünü alma

İşlem Kimliği:

LaborGetBreak

Kimlik tarafından belirtilen tek bir BreakType döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Tanımlayıcı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	break_type.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	break_type.location_id	string	Konumun tanımlayıcısı.
Kesme Adı	break_type.break_name	string	Bu tür bir kesme için okunabilir bir ad. Bu ad Square ürünlerinde çalışanlara görüntülenir.
Beklenen Süre	break_type.expected_duration	string	Bu kesmenin beklenen uzunluğu. Biçim: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Duyarlık dakikalar içinde kesilir.
Ücretlidir	break_type.is_paid	boolean	Bu kesmenin telafi amacıyla çalıştığı zamana göre sayılıp sayılmayacağı.
Sürüm	break_type.version	integer	Bu nesnenin geçerli sürümü.
Oluşturma Tarihi	break_type.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	break_type.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Kesme türünü silme

İşlem Kimliği:

LaborDeleteBreak

Var olan bir BreakType'i siler. BreakType, Shift'ten başvurulsa bile silinebilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Tanımlayıcı.

Döndürülenler

response

object

Kod parçacığını alma

İşlem Kimliği:

SnippetRetrieve

Kod parçacığınızı bir Square Online sitesinden alır. Bir site birden çok kod parçacığı uygulamasından kod parçacıkları içerebilir, ancak yalnızca uygulamanız tarafından eklenen kod parçacığını alabilirsiniz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Site Kimliği	site_id	True	string	Sitenin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	snippet.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Site Kimliği	snippet.site_id	string	Kod parçacığını içeren sitenin kimliği.
Content	snippet.content	string	Geçerli HTML, JavaScript veya her ikisini de içerebilen kod parçacığı kodu.
Oluşturma Tarihi	snippet.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	snippet.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Kod parçacığını silme

İşlem Kimliği:

SnippetDelete

Kod parçacığınızı Bir Square Online sitesinden kaldırır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Site Kimliği	site_id	True	string	Sitenin tanımlayıcısı.

Döndürülenler

response

object

Konum alma

İşlem Kimliği:

LocationRetrieve

Konumun ayrıntılarını alır. Ana konumun ayrıntılarını almak için konum kimliği olarak "main" belirtebilirsiniz.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Konum Kimliği	location_id	True	string	Konumun tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	location.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İsim	location.name	string	Nesnenin adı.
Adres Satırı 1	location.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.
Yer	location.address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	location.address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	location.address.postal_code	string	Adresin posta kodu.
Country	location.address.country	string	Adresin ülkesi, ISO 3166-1-alfa-2 biçimindedir.
Timezone	location.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.
Capabilities	location.capabilities	array of string
Statü	location.status	string	Bu nesnenin geçerli doğrulama durumu.
Oluşturma Tarihi	location.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Satıcı Kimliği	location.merchant_id	string	Satıcının kimliği.
Country	location.country	string	ISO 3166 Alfa-2 ülke kodu.
Dil Kodu	location.language_code	string	BCP 47 biçimindeki dil kodu.
Para birimi	location.currency	string	3 karakterli ISO 4217 para birimi kodu.
Telefon Numarası	location.phone_number	string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
İş Adı	location.business_name	string	Konumun iş adı Bu, konumun müşterilerine görünen adıdır. Örneğin, bu ad müşteri makbuzlarında görünür.

Konum oluşturma (Beta)

İşlem Kimliği:

LocationCreate

Bir konum oluşturur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İsim	name		string	Nesnenin adı.
Description	description		string	Açıklama.
Facebook URL'si	facebook_url		string	Konumun Facebook profili URL'si. URL 'facebook.com/' ile başlamalıdır.
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.
Yönetim Bölgesi Düzey 1	administrative_district_level_1		string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Yer	locality		string	Adresin şehri veya şehri.
Posta Kodu	postal_code		string	Adresin posta kodu.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	location.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İsim	location.name	string	Nesnenin adı.
Adres Satırı 1	location.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.
Yer	location.address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	location.address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	location.address.postal_code	string	Adresin posta kodu.
Capabilities	location.capabilities	array of string
Statü	location.status	string	Bu nesnenin geçerli doğrulama durumu.
Oluşturma Tarihi	location.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Satıcı Kimliği	location.merchant_id	string	Satıcının kimliği.
Country	location.country	string	ISO 3166 Alfa-2 ülke kodu.
Dil Kodu	location.language_code	string	BCP 47 biçimindeki dil kodu.
Para birimi	location.currency	string	3 karakterli ISO 4217 para birimi kodu.
Türü	location.type	string	Bu nesnenin türü.
Description	location.description	string	Açıklama.
Web sitesi URL'si	location.website_url	string	Konumun web sitesi URL'si.
Twitter Kullanıcı Adı	location.twitter_username	string	'@' simgesi olmayan konumun Twitter kullanıcı adı.
Instagram Kullanıcı Adı	location.instagram_username	string	'@' simgesi olmayan konumun Instagram kullanıcı adı.
Enlem	location.coordinates.latitude	float	Koordinatın derece cinsinden ifade edilen enlemi.
Boylam	location.coordinates.longitude	float	Koordinatın derece cinsinden ifade edilen boylamı.
MM	location.mcc	string	ISO 18245 tarafından standartlaştırılan konumun satıcı kategori kodu (MCC). MCC, konumda satılan mal veya hizmetlerin türünü açıklar.

Konumları listeleme

İşlem Kimliği:

LocationList

Bir işletmenin tüm konumları hakkında bilgi sağlar.

Döndürülenler

Name	Yol	Tür	Description
Yerleşimler	locations	array of object
Kimlik	locations.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İsim	locations.name	string	Nesnenin adı.
Adres Satırı 1	locations.address.address_line_1	string	Adresin ilk satırı.
Yer	locations.address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	locations.address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	locations.address.postal_code	string	Adresin posta kodu.
Country	locations.address.country	string	Adresin ülkesi, ISO 3166-1-alfa-2 biçimindedir.
Timezone	locations.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.
Capabilities	locations.capabilities	array of string
Statü	locations.status	string	Bu nesnenin geçerli doğrulama durumu.
Oluşturma Tarihi	locations.created_at	string	ISO 8601 biçimindeki olay zamanı.
Satıcı Kimliği	locations.merchant_id	string	Konumun sahibi olan satıcının kimliği.
Country	locations.country	string	ISO 3166 Alfa-2 ülke kodu.
Dil Kodu	locations.language_code	string	BcP 47 biçiminde konumla ilişkilendirilmiş dil.
Para birimi	locations.currency	string	3 karakterli ISO 4217 para birimi kodu.
Telefon Numarası	locations.phone_number	string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
İş Adı	locations.business_name	string	Konumun iş adı Bu, konumun müşterilerine görünen adıdır. Örneğin, bu ad müşteri makbuzlarında görünür.

Konumu güncelleştirme (Beta)

İşlem Kimliği:

LocationUpdate

Bir konumu güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Konum Kimliği	location_id	True	string	Konumun tanımlayıcısı.
İsim	name		string	Nesnenin adı.
Description	description		string	Açıklama.
Facebook URL'si	facebook_url		string	Konumun Facebook profili URL'si. URL 'facebook.com/' ile başlamalıdır.
Twitter Kullanıcı Adı	twitter_username		string	'@' simgesi olmayan konumun Twitter kullanıcı adı.
Instagram Kullanıcı Adı	instagram_username		string	'@' simgesi olmayan konumun Instagram kullanıcı adı.
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.
Yönetim Bölgesi Düzey 1	administrative_district_level_1		string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Yer	locality		string	Adresin şehri veya şehri.
Posta Kodu	postal_code		string	Adresin posta kodu.
Haftanın Günü	day_of_week		string	Bu zaman aralığı için haftanın günü.
Yerel Saati Başlat	start_local_time		string	Kısmi zamanlı RFC 3339 biçimi kullanılarak yerel saatle belirtilen bir iş saati döneminin başlangıç saati.
Yerel Saati Sonlandır	end_local_time		string	Kısmi zamanlı RFC 3339 biçimi kullanılarak yerel saatle belirtilen bir iş saati döneminin bitiş saati.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	location.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İsim	location.name	string	Nesnenin adı.
Adres Satırı 1	location.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.
Yer	location.address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	location.address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	location.address.postal_code	string	Adresin posta kodu.
Timezone	location.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.
Capabilities	location.capabilities	array of string
Statü	location.status	string	Bu nesnenin geçerli doğrulama durumu.
Oluşturma Tarihi	location.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Satıcı Kimliği	location.merchant_id	string	Satıcının kimliği.
Country	location.country	string	ISO 3166 Alfa-2 ülke kodu.
Dil Kodu	location.language_code	string	BCP 47 biçimindeki dil kodu.
Para birimi	location.currency	string	3 karakterli ISO 4217 para birimi kodu.
Telefon Numarası	location.phone_number	string	Müşteri profiliyle ilişkili 11 basamaklı telefon numarası.
İş Adı	location.business_name	string	Konumun iş adı Bu, konumun müşterilerine görünen adıdır. Örneğin, bu ad müşteri makbuzlarında görünür.
Türü	location.type	string	Bu nesnenin türü.
Web sitesi URL'si	location.website_url	string	Konumun web sitesi URL'si.
Dönem	location.business_hours.periods	array of object
Haftanın Günü	location.business_hours.periods.day_of_week	string	Bu zaman aralığı için haftanın günü.
Yerel Saati Başlat	location.business_hours.periods.start_local_time	string	Kısmi zamanlı RFC 3339 biçimi kullanılarak yerel saatle belirtilen bir iş saati döneminin başlangıç saati.
Yerel Saati Sonlandır	location.business_hours.periods.end_local_time	string	Kısmi zamanlı RFC 3339 biçimi kullanılarak yerel saatle belirtilen bir iş saati döneminin bitiş saati.
İş E-postası	location.business_email	string	Konumun e-posta adresi. Bu e-posta konumun müşterileri tarafından görülebilir. Örneğin, e-posta müşteri makbuzlarında görünür.
Description	location.description	string	Açıklama.
Twitter Kullanıcı Adı	location.twitter_username	string	'@' simgesi olmayan konumun Twitter kullanıcı adı.
Instagram Kullanıcı Adı	location.instagram_username	string	'@' simgesi olmayan konumun Instagram kullanıcı adı.
Enlem	location.coordinates.latitude	float	Koordinatın derece cinsinden ifade edilen enlemi.
Boylam	location.coordinates.longitude	float	Koordinatın derece cinsinden ifade edilen boylamı.
MM	location.mcc	string	ISO 18245 tarafından standartlaştırılan konumun satıcı kategori kodu (MCC). MCC, konumda satılan mal veya hizmetlerin türünü açıklar.

Kullanıma alma oluşturma

İşlem Kimliği:

CheckoutCreate

Ödeme işleme iş akışı kullanarak ödeme bilgilerini sağlamak için bir checkoutId'yi müşterilerin yönlendirildikleri bir checkout_page_url bağlar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Konum Kimliği	location_id	True	string	Konumun 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.
Yeniden yönlendirme URL'si	redirect_url		string	Örneğin, sağlanan yeniden yönlendirme URL'si ise http://www.example.com/order-completebaşarılı bir işlem müşteriyi şu konuma yönlendirir: http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx Yeniden yönlendirme URL'si sağlamazsanız Square Checkout sizin yerinize bir sipariş onay sayfası görüntüler; ancak, işlem sonuçlarını doğrulayabilmeniz ve siparişi mevcut/normal onay iş akışınız aracılığıyla tamamlayabilmeniz için bir yeniden yönlendirme URL'si sağlamanız kesinlikle önerilir.
Idempotency Anahtarı	idempotency_key		string	Oluşturduğunuz siparişler arasında bu siparişi benzersiz olarak tanımlayan, belirttiğiniz bir değer. Belirli bir siparişin başarıyla oluşturulup oluşturulmadığını bilmiyorsanız, yinelenen siparişler oluşturma konusunda endişelenmeden aynı eşzamanlılık anahtarıyla yeniden deneyebilirsiniz.
Konum Kimliği	location_id		string	Belirtilen satıcı konumu kimlikleriyle eşleşen kullanılabilirlikleri aramak için sorgu ifadesi.
Müşteri Kimliği	customer_id		string	Siparişle ilişkili müşterinin kimliği.
Başvuru Kimliği	reference_id		string	Başka bir sistemdeki bir varlığı bu siparişle ilişkilendirmek için istemci tarafından belirtilen kimlik.
İsim	name		string	Öğenin adı.
Miktar	quantity		string	Satın alınan ve ondalık sayı olarak biçimlendirilmiş miktar. Siparişin ödemesi veya başka bir şekilde tamamlanması sırasında miktarı 0 olan satır öğeleri otomatik olarak kaldırılır.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.
İndirim UID	discount_uid		string	Uygulanan indirimin temsil ettiği indirimin UID'si. Order.discount alanında mevcut bir indirime başvurması gerekir. Bu alan sabittir. Bir satır öğesine hangi indirimlerin uygulanacağını değiştirmek için, indirimi silmeniz ve yeni orderlineitemAppliedDiscount olarak yeniden eklemeniz gerekir.
Vergi UID	tax_uid		string	Bu uygulanan verginin temsil ettiği verginin UID'sini. Order.tax alanında bulunan bir vergiye başvurması gerekir. Bu alan sabittir. Bir satır öğesine uygulanacak vergileri değiştirmek için yeni bir OrderLineItemAppliedTax silin ve ekleyin.
UID	uid		string	Benzersiz bir kimlik.
Türü	type		string	Bu nesnenin türü.
Yüzde	percentage		string	Ondalık bir sayının dize gösterimi olarak vergi yüzdesi.
Scope	scope		string	Nesnenin uygulandığı düzeyi gösterir.
UID	uid		string	Benzersiz bir kimlik.
Türü	type		string	Bu nesnenin türü.
Scope	scope		string	Nesnenin uygulandığı düzeyi gösterir.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.
Konum Kimliği	location_id		string	Konumun tanımlayıcısı.
Description	title		string	Açıklama.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.
Sevkiyat Adresi İste	ask_for_shipping_address		boolean	Doğruysa, Square Checkout sizin yerinize sevkiyat bilgilerini toplar ve bu bilgileri işlem bilgileriyle birlikte Square Seller Panosu'nda depolar.
Satıcı Destek E-postası	merchant_support_email		string	Square Checkout onay sayfasında görüntülenecek e-posta adresi ve alıcının satıcıyla iletişim kurmak için kullanabileceği onay e-postası. Bu değer ayarlanmazsa, onay sayfası ve e-postada satıcının Kare hesabıyla ilişkili birincil e-posta adresi görüntülenir.
Alıcı E-postası'nın ön doldurması	pre_populate_buyer_email		string	Sağlanırsa, alıcının e-postası kullanıma alma sayfasında düzenlenebilir bir metin alanı olarak önceden doldurulur.
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.
İlk İsim	first_name		string	Alıcıyı temsil ederken isteğe bağlı ad.
Soyadı	last_name		string	Alıcıyı temsil ederken isteğe bağlı soyadı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	checkout.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Kullanıma Alma Sayfası URL'si	checkout.checkout_page_url	string	Satın alma işlemi tamamlandıktan sonra alıcının tarayıcısının yönlendirileceği URL.
Sevkiyat Adresi İste	checkout.ask_for_shipping_address	boolean	Doğruysa, Square Checkout sizin yerinize sevkiyat bilgilerini toplar ve bu bilgileri işlem bilgileriyle birlikte Kare Panonuzda depolar.
Satıcı Destek E-postası	checkout.merchant_support_email	string	Square Checkout onay sayfasında görüntülenecek e-posta adresi ve alıcının satıcıyla iletişim kurmak için kullanabileceği onay e-postası.
Alıcı E-postası'nın ön doldurması	checkout.pre_populate_buyer_email	string	Sağlanırsa, alıcının e-postası kullanıma alma sayfasında düzenlenebilir bir metin alanı olarak önceden doldurulur.
Adres Satırı 1	checkout.pre_populate_shipping_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	checkout.pre_populate_shipping_address.address_line_2	string	Varsa, adresin ikinci satırı.
Yer	checkout.pre_populate_shipping_address.locality	string	Adresin şehri veya şehri.
Yönetim Bölgesi Düzey 1	checkout.pre_populate_shipping_address.administrative_district_level_1	string	Adresin ülkesi içinde bir sivil varlık. ABD'de bu devlettir.
Posta Kodu	checkout.pre_populate_shipping_address.postal_code	string	Adresin posta kodu.
Country	checkout.pre_populate_shipping_address.country	string	Adresin ülkesi, ISO 3166-1-alfa-2 biçimindedir.
İlk İsim	checkout.pre_populate_shipping_address.first_name	string	Alıcıyı temsil ederken isteğe bağlı ad.
Soyadı	checkout.pre_populate_shipping_address.last_name	string	Alıcıyı temsil ederken isteğe bağlı lsat adı.
Yeniden yönlendirme URL'si	checkout.redirect_url	string	Kullanıma alma tamamlandıktan sonra yeniden yönlendirilecek URL, checkoutId, Square'in orderId, transactionId ve referenceId değerleri URL parametresi olarak eklenir. Örneğin, sağlanan redirect_url ise http://www.example.com/order-completebaşarılı bir işlem müşteriyi şu konuma yönlendirir: http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx Yeniden yönlendirme URL'si sağlamazsanız Square Checkout sizin için bir sipariş onay sayfası görüntüler; Ancak Square, işlem sonuçlarını doğrulayabilmeniz ve siparişi mevcut/normal onay iş akışınız aracılığıyla tamamlayabilmeniz için bir yeniden yönlendirme URL'si sağlamanızı kesinlikle önerir.
Konum Kimliği	checkout.order.location_id	string	Belirtilen satıcı konumu kimlikleriyle eşleşen kullanılabilirlikleri aramak için sorgu ifadesi.
Müşteri Kimliği	checkout.order.customer_id	string	Siparişle ilişkili müşterinin kimliği.
Başvuru Kimliği	checkout.order.reference_id	string	Başka bir sistemdeki bir varlığı bu siparişle ilişkilendirmek için istemci tarafından belirtilen kimlik.
Satır Öğeleri	checkout.order.line_items	array of object
İsim	checkout.order.line_items.name	string	Satır öğesinin adı.
Miktar	checkout.order.line_items.quantity	string	Satın alınan ve ondalık sayı olarak biçimlendirilmiş miktar. Siparişin ödemesi veya başka bir şekilde tamamlanması sırasında miktarı 0 olan satır öğeleri otomatik olarak kaldırılır.
Uygulanan Vergiler	checkout.order.line_items.applied_taxes	array of object
Vergi UID	checkout.order.line_items.applied_taxes.tax_uid	string	Bu uygulanan verginin temsil ettiği verginin UID'sini. Order.tax alanında bulunan bir vergiye başvurması gerekir. Bu alan sabittir. Bir satır öğesine uygulanacak vergileri değiştirmek için yeni bir OrderLineItemAppliedTax silin ve ekleyin.
Miktar	checkout.order.line_items.applied_taxes.applied_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	checkout.order.line_items.applied_taxes.applied_money.currency	string	ISO 4217 biçimindeki para biriminin türü. Örneğin, ABD doları için para birimi kodu ABD dolarıdır.
Uygulanan İndirimler	checkout.order.line_items.applied_discounts	array of object
İndirim UID	checkout.order.line_items.applied_discounts.discount_uid	string	Uygulanan indirimin temsil ettiği indirimin UID'si. Order.discount alanında mevcut bir indirime başvurması gerekir. Bu alan sabittir. Bir satır öğesine hangi indirimlerin uygulanacağını değiştirmek için, indirimi silmeniz ve yeni orderlineitemAppliedDiscount olarak yeniden eklemeniz gerekir.
Miktar	checkout.order.line_items.applied_discounts.applied_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	checkout.order.line_items.applied_discounts.applied_money.currency	string	ISO 4217 biçimindeki para biriminin türü. Örneğin, ABD doları için para birimi kodu ABD dolarıdır.
Miktar	checkout.order.line_items.base_price_money.amount	integer	Miktar.
Para birimi	checkout.order.line_items.base_price_money.currency	string	Para birimi.
Miktar	checkout.order.line_items.total_tax_money.amount	integer	Miktar.
Para birimi	checkout.order.line_items.total_tax_money.currency	string	Para birimi.
Miktar	checkout.order.line_items.total_discount_money.amount	integer	Miktar.
Para birimi	checkout.order.line_items.total_discount_money.currency	string	Para birimi.
Miktar	checkout.order.line_items.total_money.amount	integer	Miktar.
Para birimi	checkout.order.line_items.total_money.currency	string	Para birimi.
Vergiler	checkout.order.taxes	array of object
UID	checkout.order.taxes.uid	string	Benzersiz bir kimlik.
Türü	checkout.order.taxes.type	string	Bu nesnenin türü.
Yüzde	checkout.order.taxes.percentage	string	Ondalık bir sayının dize gösterimi olarak vergi yüzdesi.
Scope	checkout.order.taxes.scope	string	Nesnenin uygulandığı düzeyi gösterir.
İskontolar	checkout.order.discounts	array of object
UID	checkout.order.discounts.uid	string	Benzersiz bir kimlik.
Türü	checkout.order.discounts.type	string	Bu nesnenin türü.
Scope	checkout.order.discounts.scope	string	Nesnenin uygulandığı düzeyi gösterir.
Miktar	checkout.order.discounts.amount_money.amount	integer	Miktar.
Para birimi	checkout.order.discounts.amount_money.currency	string	Para birimi.
Miktar	checkout.order.discounts.applied_money.amount	integer	Miktar.
Para birimi	checkout.order.discounts.applied_money.currency	string	Para birimi.
Miktar	checkout.order.total_money.amount	integer	Miktar.
Para birimi	checkout.order.total_money.currency	string	Para birimi.
Miktar	checkout.order.total_tax_money.amount	integer	Miktar.
Para birimi	checkout.order.total_tax_money.currency	string	Para birimi.
Miktar	checkout.order.total_discount_money.amount	integer	Miktar.
Para birimi	checkout.order.total_discount_money.currency	string	Para birimi.
Oluşturma Tarihi	checkout.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Sürüm	checkout.version	integer	Bu nesnenin geçerli sürümü.
Ek Alıcılar	checkout.additional_recipients	array of object
Konum Kimliği	checkout.additional_recipients.location_id	string	Bu ihalenin bir kısmını alan alıcının (satıcı dışında) konum kimliği.
Description	checkout.additional_recipients.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.
Miktar	checkout.additional_recipients.amount_money.amount	integer	Miktar.
Para birimi	checkout.additional_recipients.amount_money.currency	string	Para birimi.

Liste sonu türleri

İşlem Kimliği:

LaborListBreak

bir işletmeye ait BreakType örneklerinin sayfalandırılmış 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.
Sınır	limit		integer	Yanıtta döndürülecek sayı üst sınırı.
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
Kesme Türleri	break_types	array of object
Kimlik	break_types.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Konum Kimliği	break_types.location_id	string	Konumun tanımlayıcısı.
Kesme Adı	break_types.break_name	string	Bu tür bir kesme için okunabilir bir ad. Bu ad Square ürünlerinde çalışanlara görüntülenir.
Beklenen Süre	break_types.expected_duration	string	Bu kesmenin beklenen uzunluğu. Biçim: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Duyarlık dakikalar içinde kesilir.
Ücretlidir	break_types.is_paid	boolean	Bu kesmenin telafi amacıyla çalıştığı zamana göre sayılıp sayılmayacağı.
Sürüm	break_types.version	integer	Nesnenin geçerli sürümü.
Oluşturma Tarihi	break_types.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	break_types.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
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.

Mobil yetkilendirme kodu oluşturma

İşlem Kimliği:

MobileAuthorizationCreate

Bir mobil uygulamayı Kare kart okuyucuya bağlanacak şekilde yetkilendirmek için kod oluşturur. Yetkilendirme kodları tek seferlik kullanılır ve verildikten 60 dakika sonra süresi dolar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Konum Kimliği	location_id		string	Konum tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Yetkilendirme Kodu	authorization_code	string	Bir mobil uygulama örneğini Square hesabına bağlayan yetkilendirme kodu oluşturuldu.
Süresi Dolduğunda	expires_at	string	authorization_code süresi RFC 3339 biçiminde dolduğunda zaman damgası.

Müşterinin hediye kartıyla bağlantısını kaldırma (Beta)

İşlem Kimliği:

GiftCardUnlink

Müşterinin hediye kartıyla bağlantısını kaldırır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Hediye Kartı Kimliği	gift_card_id	True	string	Hediye kartının tanımlayıcısı.
Müşteri Kimliği	customer_id		string	Bağlanacak müşterinin kimliği.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	gift_card.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Türü	gift_card.type	string	Bu nesnenin türü.
GAN Kaynağı	gift_card.gan_source	string	Hediye kartı hesap numarasının (GAN) Kare tarafından mı oluşturulduğunu yoksa Kare olmayan bir sistemden mi içeri aktarılacağını gösterir.
Devlet	gift_card.state	string	Geçerli durum.
Miktar	gift_card.balance_money.amount	integer	Miktar.
Para birimi	gift_card.balance_money.currency	string	Para birimi.
GaN	gift_card.gan	string	Hediye kartı hesap numarası.
Oluşturma Tarihi	gift_card.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.

Müşteriyi hediye kartına bağlama (Beta)

İşlem Kimliği:

GiftCardLink

Müşteriyi hediye kartına bağlar

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Hediye Kartı Kimliği	gift_card_id	True	string	Hediye kartının tanımlayıcısı.
Müşteri Kimliği	customer_id		string	Bağlanacak müşterinin kimliği.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	gift_card.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Türü	gift_card.type	string	Bu nesnenin türü.
GAN Kaynağı	gift_card.gan_source	string	Hediye kartı hesap numarasının (GAN) Kare tarafından mı oluşturulduğunu yoksa Kare olmayan bir sistemden mi içeri aktarılacağını gösterir.
Devlet	gift_card.state	string	Geçerli durum.
Miktar	gift_card.balance_money.amount	integer	Miktar.
Para birimi	gift_card.balance_money.currency	string	Para birimi.
GaN	gift_card.gan	string	Hediye kartı hesap numarası.
Oluşturma Tarihi	gift_card.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Müşteri Kimlikleri	gift_card.customer_ids	array of string

Nakit çekmece vardiyalarını listeleme

İşlem Kimliği:

CashDrawerListShifts

Tarih aralığındaki bir konumun tüm nakit çekmece vardiyalarının ayrıntılarını sağlar.

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.
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.
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ınır	limit		integer	Yanıtta döndürülecek sayı üst sınırı.
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
Eşya	items	array of object
Kimlik	items.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Devlet	items.state	string	Geçerli durum.
Açılış:	items.opened_at	string	ISO 8601 biçiminde vardiya başlangıç zamanı.
Bitiş:	items.ended_at	string	ISO 8601 biçiminde vardiya bitiş saati.
Kapalı:	items.closed_at	string	ISO 8601 biçiminde kaydırma yakın süresi.
Description	items.title	string	Açıklama.
Miktar	items.opened_cash_money.amount	integer	Miktar.
Para birimi	items.opened_cash_money.currency	string	Para birimi.
Miktar	items.expected_cash_money.amount	integer	Miktar.
Para birimi	items.expected_cash_money.currency	string	Para birimi.
Miktar	items.closed_cash_money.amount	integer	Miktar.
Para birimi	items.closed_cash_money.currency	string	Para birimi.

Nakit çekmece vardiyası etkinliklerini listeleme

İşlem Kimliği:

CashDrawerListEvents

Tek bir nakit çekmece vardiyası için olayların sayfalandırılmış listesini sağlar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Shift Kimliği	shift_id	True	string	Vardiyanın tanımlayıcısı.
Konum Kimliği	location_id	True	string	Yalnızca belirli bir konuma ait kayıtları almak için bu isteğe bağlı filtreyi belirtebilirsiniz.
Sınır	limit		integer	Yanıtta döndürülecek sayı üst sınırı.
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
Events	events	array of object
Kimlik	events.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Olay Türü	events.event_type	string	Nakit çekmece vardiyası olayının türü.
Miktar	events.event_money.amount	integer	Miktar.
Para birimi	events.event_money.currency	string	Para birimi.
Oluşturma Tarihi	events.created_at	string	ISO 8601 biçimindeki olay zamanı.
Description	events.title	string	Açıklama.

Nonce'dan hediye kartı alma (Beta)

İşlem Kimliği:

GiftCardRetrieveNonce

Hediye kartını temsil eden bir nonce (güvenli belirteç) kullanarak bir hediye kartı alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Nonce	nonce		string	Alınacak hediye kartının nonce değeri.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	gift_card.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Türü	gift_card.type	string	Bu nesnenin türü.
GAN Kaynağı	gift_card.gan_source	string	Hediye kartı hesap numarasının (GAN) Kare tarafından mı oluşturulduğunu yoksa Kare olmayan bir sistemden mi içeri aktarılacağını gösterir.
Devlet	gift_card.state	string	Geçerli durum.
Miktar	gift_card.balance_money.amount	integer	Miktar.
Para birimi	gift_card.balance_money.currency	string	Para birimi.
GaN	gift_card.gan	string	Hediye kartı hesap numarası.
Oluşturma Tarihi	gift_card.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.

Rezervasyon oluşturma (Beta)

İşlem Kimliği:

BookingCreate

Bir rezervasyon oluşturur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Müşteri Kimliği	customer_id		string	Müşteriyi temsil eden bu nesnenin kimliği.
Başlangıç:	start_at		string	Bu nesnenin başlangıç saatini RFC 3339 biçiminde belirten zaman damgası.
Konum Kimliği	location_id		string	Konumun tanımlayıcısı.
Süre Dakikaları	duration_minutes		integer	Bir randevu kesiminin dakika cinsinden zaman aralığı.
Ekip Üyesi Kimliği	team_member_id		string	Bu segmentte yer alan ekip üyesini temsil eden TeamMember nesnesinin kimliği.
Hizmet Çeşitleme Kimliği	service_variation_id		string	Bu segmentte rezervasyonu yapılan hizmeti temsil eden CatalogItemVariation nesnesinin kimliği.
Hizmet Varyasyonu Sürümü	service_variation_version		integer	Bu segmentte rezervasyonu yapılan hizmeti temsil eden madde varyasyonunun geçerli sürümü.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	booking.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Sürüm	booking.version	integer	Bu nesnenin geçerli sürümü.
Statü	booking.status	string	Bu nesnenin geçerli doğrulama durumu.
Oluşturma Tarihi	booking.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	booking.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Konum Kimliği	booking.location_id	string	Konumun tanımlayıcısı.
Müşteri Kimliği	booking.customer_id	string	Müşteriyi temsil eden bu nesnenin kimliği.
Müşteri Notu	booking.customer_note	string	Müşterinin rezervasyonla ilgili notlar sağlaması için serbest metin alanı.
Satıcı Notu	booking.seller_note	string	Satıcının rezervasyonla ilgili notlar sağlaması için serbest metin alanı.
Başlangıç:	booking.start_at	string	Bu nesnenin başlangıç saatini RFC 3339 biçiminde belirten zaman damgası.
Randevu Kesimi	booking.appointment_segments	array of object
Süre Dakikaları	booking.appointment_segments.duration_minutes	integer	Bir randevu kesiminin dakika cinsinden zaman aralığı.
Hizmet Çeşitleme Kimliği	booking.appointment_segments.service_variation_id	string	Bu segmentte rezervasyonu yapılan hizmeti temsil eden CatalogItemVariation nesnesinin kimliği.
Ekip Üyesi Kimliği	booking.appointment_segments.team_member_id	string	Bu segmentte yer alan ekip üyesini temsil eden TeamMember nesnesinin kimliği.
Hizmet Varyasyonu Sürümü	booking.appointment_segments.service_variation_version	integer	Bu segmentte rezervasyonu yapılan hizmeti temsil eden madde varyasyonunun geçerli sürümü.
Errors	errors	array of

Sadakat hesabı alma

İşlem Kimliği:

LoyaltyRetrieveAccount

Bir sadakat hesabı alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Hesap Kimliği	account_id	True	string	Hesabın tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	loyalty_account.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Kimlik	loyalty_account.mapping.id	string	Kare olarak atanan kimlik.
Telefon Numarası	loyalty_account.mapping.phone_number	string	Alıcının telefon numarası.
Oluşturma Tarihi	loyalty_account.mapping.created_at	string	Rfc 3339 biçiminde oluşturulduğunda zaman damgası.
Program Kimliği	loyalty_account.program_id	string	Programın Kare atanan kimliği.
Denge	loyalty_account.balance	integer	Kullanılabilir bakiye.
Yaşam Puanı	loyalty_account.lifetime_points	integer	Hesabın ömrü boyunca tahakkuk eden toplam puan.
Müşteri Kimliği	loyalty_account.customer_id	string	Müşteriyi temsil eden bu nesnenin kimliği.
Oluşturma Tarihi	loyalty_account.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	loyalty_account.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Sadakat programı alma

İşlem Kimliği:

LoyaltyRetrieveProgram

Satışçının hesabında program kimliği veya anahtar sözcük main ile belirtilen sadakat programını alır. Sadakat programları, alıcıların puan kazanma ve ödüller için puan kullanma şeklini tanımlar.

Parametreler

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

Döndürülenler

Name	Yol	Tür	Description
Kimlik	program.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Statü	program.status	string	Bu nesnenin geçerli doğrulama durumu.
Reward Katmanları	program.reward_tiers	array of object
Kimlik	program.reward_tiers.id	string	Nesnenin tanımlayıcısı
Points	program.reward_tiers.points	integer	Olay tarafından birikmiş puan sayısı.
İsim	program.reward_tiers.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.
Scope	program.reward_tiers.definition.scope	string	Nesnenin uygulandığı düzeyi gösterir.
İndirim Türü	program.reward_tiers.definition.discount_type	string	Ödül katmanının sunduğu indirim türü.
yüzde indirimi	program.reward_tiers.definition.percentage_discount	string	İndirimin sabit yüzdesi.
Oluşturma Tarihi	program.reward_tiers.created_at	string	Rfc 3339 biçiminde oluşturulduğunda zaman damgası.
Nesne kimliği	program.reward_tiers.pricing_rule_reference.object_id	string	Başvuruda bulunılan nesnenin kimliği.
Katalog Sürümü	program.reward_tiers.pricing_rule_reference.catalog_version	string	Nesnenin sürümü.
One	program.terminology.one	string	Bir nokta için tekil birim (örneğin, 1 nokta 1 yıldız olarak adlandırılır).
Other	program.terminology.other	string	Nokta için çoğul birim (örneğin, 10 nokta 10 yıldız olarak adlandırılır).
Konum Kimlikleri	program.location_ids	array of string
Oluşturma Tarihi	program.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	program.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Tahakkuk Kuralları	program.accrual_rules	array of object
Tahakkuk Türü	program.accrual_rules.accrual_type	string	Alıcıların nasıl puan kazanabileceğini tanımlayan tahakkuk kuralının türü.
Points	program.accrual_rules.points	integer	Olay tarafından birikmiş puan sayısı.
Miktar	program.accrual_rules.spend_amount_money.amount	integer	Miktar.
Dışlanan Kategori Kimlikleri	program.accrual_rules.excluded_category_ids	array of string
Dışlanan Öğe Çeşitleme Kimlikleri	program.accrual_rules.excluded_item_variation_ids	array of string

Sadakat puanlarını ayarlama

İşlem Kimliği:

LoyaltyAdjustPoints

Bir alıcının hesabına puan ekler veya puan çıkarır. Bu uç noktayı yalnızca noktaları el ile ayarlamanız gerektiğinde kullanın.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Hesap Kimliği	account_id	True	string	Hesabın tanımlayıcısı.
Points	points		integer	Eklenen veya kaldırılan nokta sayısı.
Reason	reason		string	Bu nesnenin nedeni.
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	event.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Türü	event.type	string	Bu nesnenin türü.
Oluşturma Tarihi	event.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Bağlılık Programı Kimliği	event.adjust_points.loyalty_program_id	string	Bağlılık programı kimliği
Points	event.adjust_points.points	integer	Olay tarafından birikmiş puan sayısı.
Reason	event.adjust_points.reason	string	Noktaların ayarlanmasının nedeni.
Bağlılık Programı Hesabı Kimliği	event.loyalty_account_id	string	Olayın gerçekleştiği bağlılık programı hesabının kimliği.
Kaynak	event.source	string	Kaynak.

Sadakat puanı biriktirin

İşlem Kimliği:

LoyaltyAccumulatePoints

Bağlılık programı hesabına puan ekler.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Hesap Kimliği	account_id	True	string	Hesabın tanımlayıcısı.
Sipariş Kimliği	order_id		string	Siparişin kimliği.
Konum Kimliği	location_id		string	Konum 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.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	event.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Türü	event.type	string	Bu nesnenin türü.
Oluşturma Tarihi	event.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Bağlılık Programı Kimliği	event.accumulate_points.loyalty_program_id	string	Bağlılık programı kimliği
Points	event.accumulate_points.points	integer	Olay tarafından birikmiş puan sayısı.
Sipariş Kimliği	event.accumulate_points.order_id	string	Etkinlikle ilişkili siparişin kimliği.
Bağlılık Programı Hesabı Kimliği	event.loyalty_account_id	string	Olayın gerçekleştiği bağlılık programı hesabının kimliği.
Konum Kimliği	event.location_id	string	Konumun tanımlayıcısı.
Kaynak	event.source	string	Kaynak.

Sadakat ödüllerini arama

İşlem Kimliği:

LoyaltySearchRewards

Sadakat hesabındaki sadakat ödüllerini arar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bağlılık Programı Hesabı Kimliği	loyalty_account_id		string	Olayın gerçekleştiği bağlılık programı hesabının kimliği.
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
Ödüller	rewards	array of object
Kimlik	rewards.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Statü	rewards.status	string	Bu nesnenin geçerli doğrulama durumu.
Bağlılık Programı Hesabı Kimliği	rewards.loyalty_account_id	string	Olayın gerçekleştiği bağlılık programı hesabının kimliği.
Ödül Katmanı Kimliği	rewards.reward_tier_id	string	Ödülü oluşturmak için kullanılan ödül katmanının Kare atanan kimliği.
Points	rewards.points	integer	Ödül için kullanılan sadakat puanı sayısı.
Sipariş Kimliği	rewards.order_id	string	Siparişin kimliği.
Oluşturma Tarihi	rewards.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	rewards.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
Şu Konumda Kullanıldı:	rewards.redeemed_at	string	Ödülün kullanıldığı zaman damgası RFC 3339 biçimindedir.

Sadakat ödülü oluşturma

İşlem Kimliği:

LoyaltyCreateReward

Sadakat ödülü oluşturur. Bir ödül oluşturulduktan sonra puanlar kilitlenir ve alıcı başka bir ödülü kullanamayabilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Bağlılık Programı Hesabı Kimliği	loyalty_account_id		string	Olayın gerçekleştiği bağlılık programı hesabının kimliği.
Ödül Katmanı Kimliği	reward_tier_id		string	Ödülü oluşturmak için kullanılan ödül katmanının Kare atanan kimliği.
Sipariş Kimliği	order_id		string	Siparişin kimliği.
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	reward.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Statü	reward.status	string	Bu nesnenin geçerli doğrulama durumu.
Bağlılık Programı Hesabı Kimliği	reward.loyalty_account_id	string	Olayın gerçekleştiği bağlılık programı hesabının kimliği.
Ödül Katmanı Kimliği	reward.reward_tier_id	string	Ödülü oluşturmak için kullanılan ödül katmanının Kare atanan kimliği.
Points	reward.points	integer	Eklenen veya kaldırılan nokta sayısı.
Sipariş Kimliği	reward.order_id	string	Siparişin kimliği.
Oluşturma Tarihi	reward.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	reward.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Sadakat ödülünü alma

İşlem Kimliği:

LoyaltyRetrieveReward

Sadakat ödülü alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ödül Kimliği	reward_id	True	string	Ödülün tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	reward.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Statü	reward.status	string	Bu nesnenin geçerli doğrulama durumu.
Bağlılık Programı Hesabı Kimliği	reward.loyalty_account_id	string	Olayın gerçekleştiği bağlılık programı hesabının kimliği.
Ödül Katmanı Kimliği	reward.reward_tier_id	string	Ödülü oluşturmak için kullanılan ödül katmanının Kare atanan kimliği.
Points	reward.points	integer	Eklenen veya kaldırılan nokta sayısı.
Oluşturma Tarihi	reward.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	reward.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.
Şu Konumda Kullanıldı:	reward.redeemed_at	string	Ödülün kullanıldığı zaman damgası RFC 3339 biçimindedir.

Sadakat ödülünü kullan

İşlem Kimliği:

LoyaltyRedeemReward

Sadakat ödülü alır. Ödül terminal durumuna ulaştıktan sonra silinemez. Başka bir deyişle ödül için kullanılan puanlar hesaba iade edilemez.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ödül Kimliği	reward_id	True	string	Ödülü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.
Konum Kimliği	location_id		string	Konum tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	event.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Türü	event.type	string	Bu nesnenin türü.
Oluşturma Tarihi	event.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Bağlılık Programı Kimliği	event.redeem_reward.loyalty_program_id	string	Bağlılık programı kimliği
Ödül Kimliği	event.redeem_reward.reward_id	string	Sadakat ödülünün Kare atanan kimliği.
Bağlılık Programı Hesabı Kimliği	event.loyalty_account_id	string	Olayın gerçekleştiği bağlılık programı hesabının kimliği.
Konum Kimliği	event.location_id	string	Konumun tanımlayıcısı.
Kaynak	event.source	string	Kaynak.

Sadakat ödülünü silme

İşlem Kimliği:

LoyaltyDeleteReward

Sadakat ödülünü siler. Sadakat puanlarını sadakat hesabına geri döndürür. Terminal durumuna ulaşmış bir ödülü silemezsiniz (KULLANILIR).

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ödül Kimliği	reward_id	True	string	Ödülün tanımlayıcısı.

Döndürülenler

response

object

Satıcıları listeleme

İşlem Kimliği:

MerchantList

Belirli bir erişim belirtecinin Satıcı bilgilerini döndürür.

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.

Döndürülenler

Name	Yol	Tür	Description
Tüccar	merchant	array of object
Kimlik	merchant.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İş Adı	merchant.business_name	string	Konumun iş adı Bu, konumun müşterilerine görünen adıdır. Örneğin, bu ad müşteri makbuzlarında görünür.
Country	merchant.country	string	ISO 3166 Alfa-2 ülke kodu.
Dil Kodu	merchant.language_code	string	BcP 47 biçiminde konumla ilişkilendirilmiş dil.
Para birimi	merchant.currency	string	3 karakterli ISO 4217 para birimi kodu.
Statü	merchant.status	string	Bu nesnenin geçerli doğrulama durumu.
Ana Konum Kimliği	merchant.main_location_id	string	Bu satıcının ana Konumunun kimliği.

Satıcıyı alma

İşlem Kimliği:

MerchantRetrieve

Verilen merchant_id için bir Merchant nesnesi alın.

Parametreler

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

Döndürülenler

Name	Yol	Tür	Description
Kimlik	merchant.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
İş Adı	merchant.business_name	string	Konumun iş adı Bu, konumun müşterilerine görünen adıdır. Örneğin, bu ad müşteri makbuzlarında görünür.
Country	merchant.country	string	ISO 3166 Alfa-2 ülke kodu.
Dil Kodu	merchant.language_code	string	BCP 47 biçimindeki dil kodu.
Para birimi	merchant.currency	string	3 karakterli ISO 4217 para birimi kodu.
Statü	merchant.status	string	Bu nesnenin geçerli doğrulama durumu.
Ana Konum Kimliği	merchant.main_location_id	string	Bu satıcının ana Konumunun kimliği.

Siteleri listeleme

İşlem Kimliği:

SiteList

Bir satıcıya ait Square Online sitelerini listeler.

Döndürülenler

Name	Yol	Tür	Description
Sites	sites	array of object
Kimlik	sites.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Site Başlığı	sites.site_title	string	Sitenin başlığı.
Alan adı	sites.domain	string	Sitenin etki alanı (protokol olmadan).
Yayımlandı	sites.is_published	boolean	Sitenin yayımlanıp yayımlanmadığını gösterir.
Oluşturma Tarihi	sites.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	sites.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası

Upsert kod parçacığı

İşlem Kimliği:

SnippetUpsert

Square Online sitesine bir kod parçacığı ekler veya sitedeki mevcut kod parçacığını güncelleştirir. Kod parçacığı kodu, kullanıma alma sayfaları dışında sitenin her sayfasında baş öğesinin sonuna eklenir. Kod parçacığı uygulaması belirli bir siteye bir kod parçacığı ekleyebilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Site Kimliği	site_id	True	string	Sitenin tanımlayıcısı.
Content	content		string	Geçerli HTML, JavaScript veya her ikisini de içerebilen kod parçacığı kodu.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	snippet.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Site Kimliği	snippet.site_id	string	Kod parçacığını içeren sitenin kimliği.
Content	snippet.content	string	Geçerli HTML, JavaScript veya her ikisini de içerebilen kod parçacığı kodu.
Oluşturma Tarihi	snippet.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	snippet.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

V1 kimliğine göre banka hesabı alma

İşlem Kimliği:

BankAccountGetV1

V1 banka hesabı kimliği tarafından tanımlanan Bir BankAccount'ın ayrıntılarını döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
V1 Banka Hesap Kimliği	v1_bank_account_id	True	string	İstenen BankAccount'ın V1 kimliğini bağlayın.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	bank_account.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Hesap Numarası Son Eki	bank_account.account_number_suffix	string	Hesap numarasının son birkaç rakamı.
Country	bank_account.country	string	ISO 3166 Alfa-2 ülke kodu.
Para birimi	bank_account.currency	string	3 karakterli ISO 4217 para birimi kodu.
Hesap Türü	bank_account.account_type	string	Hesabın türü.
Tutucu Adı	bank_account.holder_name	string	Hesap sahibinin adı.
Birincil Banka Kimlik Numarası	bank_account.primary_bank_identification_number	string	Bankanın birincil tanımlayıcısı.
Konum Kimliği	bank_account.location_id	string	Konumun tanımlayıcısı.
Statü	bank_account.status	string	Bu nesnenin geçerli doğrulama durumu.
Övülmeye değer	bank_account.creditable	boolean	Square'in bu hesaba para göndermesinin mümkün olup olmadığını gösterir.
Borçlandırılabilir	bank_account.debitable	boolean	Square'in bu hesaptan para almasının mümkün olup olmadığını gösterir.
Sürüm	bank_account.version	integer	Bu nesnenin geçerli sürümü.
Banka Adı	bank_account.bank_name	string	Gerçek finans kurumunun adı.

Vardiya alma

İşlem Kimliği:

LaborGetShift

Kimlik tarafından belirtilen tek bir Shift döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Tanımlayıcı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	shift.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Ekip Üyesi Kimliği	shift.team_member_id	string	Ekip üyesinin kimliği.
Çalışan Kimliği	shift.employee_id	string	Çalışanın Kare olarak oluşturulan kimliği.
Konum Kimliği	shift.location_id	string	Konumun tanımlayıcısı.
Timezone	shift.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.
Başlangıç:	shift.start_at	string	Bu nesnenin başlangıç saatini RFC 3339 biçiminde belirten zaman damgası.
Bitiş:	shift.end_at	string	RFC 3339; saat dilimi + uzaklık konumuna kaydırıldı. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Başlık	shift.wage.title	string	Bu vardiya sırasında gerçekleştirilen işin adı. İşgücü raporlama URI'lerinin karesi, vardiyaları başlığa göre gruplandırabilir.
Miktar	shift.wage.hourly_rate.amount	integer	Miktar.
Para birimi	shift.wage.hourly_rate.currency	string	Para birimi.
Tatili	shift.breaks	array of object
Kimlik	shift.breaks.id	string	Nesnenin tanımlayıcısı
Başlangıç:	shift.breaks.start_at	string	RFC 3339; Shift ile aynı saat dilimi bilgilerini izler. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Bitiş:	shift.breaks.end_at	string	RFC 3339; Shift ile aynı saat dilimi bilgilerini izler. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Kesme Türü Kimliği	shift.breaks.break_type_id	string	Bu Kesmenin şablonlandığı BreakType.
İsim	shift.breaks.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.
Beklenen Süre	shift.breaks.expected_duration	string	Kesmenin beklenen uzunluğu. Biçim: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
Ücretlidir	shift.breaks.is_paid	boolean	Bu kesmenin telafi amacıyla çalıştığı zamana göre sayılıp sayılmayacağı.
Statü	shift.status	string	Bu nesnenin geçerli doğrulama durumu.
Sürüm	shift.version	integer	Bu nesnenin geçerli sürümü.
Oluşturma Tarihi	shift.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	shift.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Vardiya oluşturma

İşlem Kimliği:

LaborCreateShift

Yeni bir Shift oluşturur. Vardiya, tek bir çalışan için tam bir iş gününü temsil eder

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.
Ekip Üyesi Kimliği	team_member_id		string	Ekip üyesinin kimliği.
Konum Kimliği	location_id		string	Konumun tanımlayıcısı.
Başlangıç:	start_at		string	Bu nesnenin başlangıç saatini RFC 3339 biçiminde belirten zaman damgası.
Bitiş:	end_at		string	RFC 3339; saat dilimi + uzaklık konumuna kaydırıldı. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Başlık	title		string	Bu vardiya sırasında gerçekleştirilen işin adı. İşgücü raporlama URI'lerinin karesi, vardiyaları başlığa göre gruplandırabilir.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.
Başlangıç:	start_at		string	RFC 3339; Shift ile aynı saat dilimi bilgilerini izler. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Bitiş:	end_at		string	RFC 3339; Shift ile aynı saat dilimi bilgilerini izler. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Kesme Türü Kimliği	break_type_id		string	Bu Kesmenin şablonlandığı BreakType.
İ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.
Beklenen Süre	expected_duration		string	Kesmenin beklenen uzunluğu. Biçim: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
Ücretlidir	is_paid		boolean	Bu kesmenin telafi amacıyla çalıştığı zamana göre sayılıp sayılmayacağı.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	shift.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Ekip Üyesi Kimliği	shift.team_member_id	string	Ekip üyesinin kimliği.
Çalışan Kimliği	shift.employee_id	string	Çalışanın Kare olarak oluşturulan kimliği.
Konum Kimliği	shift.location_id	string	Konumun tanımlayıcısı.
Timezone	shift.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.
Başlangıç:	shift.start_at	string	Bu nesnenin başlangıç saatini RFC 3339 biçiminde belirten zaman damgası.
Bitiş:	shift.end_at	string	RFC 3339; saat dilimi + uzaklık konumuna kaydırıldı. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Başlık	shift.wage.title	string	Bu vardiya sırasında gerçekleştirilen işin adı. İşgücü raporlama URI'lerinin karesi, vardiyaları başlığa göre gruplandırabilir.
Miktar	shift.wage.hourly_rate.amount	integer	Miktar.
Para birimi	shift.wage.hourly_rate.currency	string	Para birimi.
Tatili	shift.breaks	array of object
Kimlik	shift.breaks.id	string	Nesnenin tanımlayıcısı
Başlangıç:	shift.breaks.start_at	string	RFC 3339; Shift ile aynı saat dilimi bilgilerini izler. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Bitiş:	shift.breaks.end_at	string	RFC 3339; Shift ile aynı saat dilimi bilgilerini izler. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Kesme Türü Kimliği	shift.breaks.break_type_id	string	Bu Kesmenin şablonlandığı BreakType.
İsim	shift.breaks.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.
Beklenen Süre	shift.breaks.expected_duration	string	Kesmenin beklenen uzunluğu. Biçim: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
Ücretlidir	shift.breaks.is_paid	boolean	Bu kesmenin telafi amacıyla çalıştığı zamana göre sayılıp sayılmayacağı.
Statü	shift.status	string	Bu nesnenin geçerli doğrulama durumu.
Sürüm	shift.version	integer	Bu nesnenin geçerli sürümü.
Oluşturma Tarihi	shift.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	shift.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Vardiyayı güncelleştir

İşlem Kimliği:

LaborUpdateShift

Mevcut bir Shift'i güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Tanımlayıcı.
Ekip Üyesi Kimliği	team_member_id		string	Ekip üyesinin kimliği.
Konum Kimliği	location_id		string	Konumun tanımlayıcısı.
Başlangıç:	start_at		string	Bu nesnenin başlangıç saatini RFC 3339 biçiminde belirten zaman damgası.
Bitiş:	end_at		string	RFC 3339; saat dilimi + uzaklık konumuna kaydırıldı. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Başlık	title		string	Bu vardiya sırasında gerçekleştirilen işin adı. İşgücü raporlama URI'lerinin karesi, vardiyaları başlığa göre gruplandırabilir.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.
Kimlik	id		string	Nesnenin tanımlayıcısı
Başlangıç:	start_at		string	RFC 3339; Shift ile aynı saat dilimi bilgilerini izler. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Bitiş:	end_at		string	RFC 3339; Shift ile aynı saat dilimi bilgilerini izler. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Kesme Türü Kimliği	break_type_id		string	Bu Kesmenin şablonlandığı BreakType.
İ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.
Beklenen Süre	expected_duration		string	Kesmenin beklenen uzunluğu. Biçim: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
Ücretlidir	is_paid		boolean	Bu kesmenin telafi amacıyla çalıştığı zamana göre sayılıp sayılmayacağı.
Sürüm	version		integer	Bu nesnenin geçerli sürümü.

Döndürülenler

Name	Yol	Tür	Description
Kimlik	shift.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Ekip Üyesi Kimliği	shift.team_member_id	string	Ekip üyesinin kimliği.
Çalışan Kimliği	shift.employee_id	string	Çalışanın Kare olarak oluşturulan kimliği.
Konum Kimliği	shift.location_id	string	Konumun tanımlayıcısı.
Timezone	shift.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.
Başlangıç:	shift.start_at	string	Bu nesnenin başlangıç saatini RFC 3339 biçiminde belirten zaman damgası.
Bitiş:	shift.end_at	string	RFC 3339; saat dilimi + uzaklık konumuna kaydırıldı. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Başlık	shift.wage.title	string	Bu vardiya sırasında gerçekleştirilen işin adı. İşgücü raporlama URI'lerinin karesi, vardiyaları başlığa göre gruplandırabilir.
Miktar	shift.wage.hourly_rate.amount	integer	Miktar.
Para birimi	shift.wage.hourly_rate.currency	string	Para birimi.
Tatili	shift.breaks	array of object
Kimlik	shift.breaks.id	string	Nesnenin tanımlayıcısı
Başlangıç:	shift.breaks.start_at	string	RFC 3339; Shift ile aynı saat dilimi bilgilerini izler. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Bitiş:	shift.breaks.end_at	string	RFC 3339; Shift ile aynı saat dilimi bilgilerini izler. Dakikaya kadar olan duyarlık dikkate alındı; saniyeler kesilir.
Kesme Türü Kimliği	shift.breaks.break_type_id	string	Bu Kesmenin şablonlandığı BreakType.
İsim	shift.breaks.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.
Beklenen Süre	shift.breaks.expected_duration	string	Kesmenin beklenen uzunluğu. Biçim: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
Ücretlidir	shift.breaks.is_paid	boolean	Bu kesmenin telafi amacıyla çalıştığı zamana göre sayılıp sayılmayacağı.
Statü	shift.status	string	Bu nesnenin geçerli doğrulama durumu.
Sürüm	shift.version	integer	Bu nesnenin geçerli sürümü.
Oluşturma Tarihi	shift.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	shift.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Vardiyayı sil

İşlem Kimliği:

LaborDeleteShift

Vardiyayı siler

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Kimlik	id	True	string	Tanımlayıcı.

Döndürülenler

response

object

Çalışma haftası yapılandırmalarını listeleme

İşlem Kimliği:

LaborListConfigs

bir işletme için WorkweekConfig örneklerinin listesini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Sınır	limit		integer	Yanıtta döndürülecek sayı üst sınırı.
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
Çalışma Haftası Yapılandırmaları	workweek_configs	array of object
Kimlik	workweek_configs.id	string	Benzersiz, Kare şeklinde verilen tanımlayıcı.
Haftanın Başlangıcı	workweek_configs.start_of_week	string	Telafi amacıyla iş haftasının sona erdiği gün.
Yerel Saatle Günün Başlangıcı	workweek_configs.start_of_day_local_time	string	İş haftasının sona erdiği yerel saat. SS:MM biçiminde bir dize olarak temsil edilir (SS:DD:SS de kabul edilir, ancak saniyeler kesilir).
Sürüm	workweek_configs.version	integer	Nesnenin geçerli sürümü.
Oluşturma Tarihi	workweek_configs.created_at	string	ISO 8601 biçimindeki olay zamanı.
Güncelleştirme Tarihi:	workweek_configs.updated_at	string	RFC 3339 biçiminde son değişiklik zaman damgası
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.

Ücret ayarını alma

İşlem Kimliği:

TeamRetrieveWage

TeamMember kimliği tarafından belirtilen bir ekip üyesi için WageSetting nesnesi alır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ekip Üyesi Kimliği	team_member_id	True	string	Ekip üyesinin tanımlayıcısı.

Döndürülenler

Name	Yol	Tür	Description
Ekip Üyesi Kimliği	wage_setting.team_member_id	string	Ekip üyesinin kimliği.
İş Atamaları	wage_setting.job_assignments	array of object
İş unvanı	wage_setting.job_assignments.job_title	string	İşin başlığı.
Ödeme Türü	wage_setting.job_assignments.pay_type	string	Bir ödeme dönemindeki ödeme tutarını hesaplamak için kullanılan iş ataması için geçerli ödeme türü.
Miktar	wage_setting.job_assignments.hourly_rate.amount	integer	Miktar.
Para birimi	wage_setting.job_assignments.hourly_rate.currency	string	Para birimi.
Miktar	wage_setting.job_assignments.annual_rate.amount	integer	Miktar.
Para birimi	wage_setting.job_assignments.annual_rate.currency	string	Para birimi.
Haftalık Saatler	wage_setting.job_assignments.weekly_hours	integer	İş için haftalık planlanan saatler. PayType işinin MAAŞ olup olmadığını ayarlayın.
Fazla Mesai Muaf	wage_setting.is_overtime_exempt	boolean	Ekip üyesinin satıcının ülkesinin fazla mesai kurallarından muaf olup olmadığı.
Sürüm	wage_setting.version	integer	Bu nesnenin geçerli sürümü.
Oluşturma Tarihi	wage_setting.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	wage_setting.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Ücret ayarını güncelleştirme

İşlem Kimliği:

TeamUpdateWage

WageSetting nesnesi oluşturur veya güncelleştirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Ekip Üyesi Kimliği	team_member_id	True	string	Ekip üyesinin tanımlayıcısı.
Fazla Mesai Muaf	is_overtime_exempt		boolean	Ekip üyesinin satıcının ülkesinin fazla mesai kurallarından muaf olup olmadığı.
İş unvanı	job_title		string	İşin başlığı.
Ödeme Türü	pay_type		string	Bir ödeme dönemindeki ödeme tutarını hesaplamak için kullanılan iş ataması için geçerli ödeme türü.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.
Haftalık Saatler	weekly_hours		integer	İş için haftalık planlanan saatler. PayType işinin MAAŞ olup olmadığını ayarlayın.
Miktar	amount		integer	Miktar.
Para birimi	currency		string	Para birimi.

Döndürülenler

Name	Yol	Tür	Description
Ekip Üyesi Kimliği	wage_setting.team_member_id	string	Ekip üyesinin kimliği.
İş Atamaları	wage_setting.job_assignments	array of object
İş unvanı	wage_setting.job_assignments.job_title	string	İşin başlığı.
Ödeme Türü	wage_setting.job_assignments.pay_type	string	Bir ödeme dönemindeki ödeme tutarını hesaplamak için kullanılan iş ataması için geçerli ödeme türü.
Miktar	wage_setting.job_assignments.hourly_rate.amount	integer	Miktar.
Para birimi	wage_setting.job_assignments.hourly_rate.currency	string	Para birimi.
Miktar	wage_setting.job_assignments.annual_rate.amount	integer	Miktar.
Para birimi	wage_setting.job_assignments.annual_rate.currency	string	Para birimi.
Haftalık Saatler	wage_setting.job_assignments.weekly_hours	integer	İş için haftalık planlanan saatler. PayType işinin MAAŞ olup olmadığını ayarlayın.
Fazla Mesai Muaf	wage_setting.is_overtime_exempt	boolean	Ekip üyesinin satıcının ülkesinin fazla mesai kurallarından muaf olup olmadığı.
Sürüm	wage_setting.version	integer	Bu nesnenin geçerli sürümü.
Oluşturma Tarihi	wage_setting.created_at	string	Bu nesnenin oluşturma zamanını RFC 3339 biçiminde belirten zaman damgası.
Güncelleştirme Tarihi:	wage_setting.updated_at	string	Bu nesnenin en son güncelleştirme zamanını RFC 3339 biçiminde belirten zaman damgası.

Tanımlar

object

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