Quadratisches Geschäft (unabhängiger Herausgeber) (Vorschau)

Square hilft Millionen von Verkäufern, ihr Geschäft zu führen - von der sicheren Kreditkartenverarbeitung bis hin zu Point of Sale-Lösungen. Dieser Connector enthält Aktionen für die folgenden Endpunkte: Loyalty, Gift Cards, Bookings, Business, Team, Financials, Online und Auth.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung	Class	Regions
Copilot Studio	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Logik-Apps	Norm	Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)

Kontakt
Name	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Connectormetadaten
Herausgeber	Troy Taylor
Webseite	https://squareup.com/
Datenschutzrichtlinie	https://squareup.com/us/en/legal/general/privacy
Kategorien	Handel; Vertrieb und CRM

Drosselungsgrenzwerte

Name	Aufrufe	Verlängerungszeitraum
API-Aufrufe pro Verbindung	100	60 Sekunden

Aktionen

Abrufen der Bargeldschubladeschicht	Enthält die Zusammenfassungsdetails für eine einzelne Bargeldschubladeschicht.
Abrufen der Lohneinstellung	Ruft ein WageSetting -Objekt für ein Teammitglied ab, das von der TeamMember-ID angegeben wird.
Abrufen des Geschäftsbuchungsprofils (Beta)	Ruft das Buchungsprofil eines Verkäufers ab.
Abrufen des Treueprogramms	Ruft das Treueprogramm in einem Verkäuferkonto ab, das durch die Programm-ID oder das Schlüsselworthauptwort angegeben wird. Treueprogramme definieren, wie Käufer Punkte sammeln und Punkte für Prämien einlösen können.
Abrufen einer Geschenkkarte aus Nonce (Beta)	Ruft eine Geschenkkarte mit einer Nonce (einem sicheren Token) ab, die die Geschenkkarte darstellt.
Abrufen einer Geschenkkarte von GAN (Beta)	Ruft eine Geschenkkarte mit der Geschenkkartenkontonummer (GAN) ab.
Abrufen einer Treueprämie	Ruft eine Treueprämie ab.
Abrufen eines Treuekontos	Ruft ein Treuekonto ab.
Abrufen von Gerätecode	Ruft DeviceCode mit der zugeordneten ID ab.
Aktualisieren der Lohneinstellung	Erstellt oder aktualisiert ein WageSetting -Objekt.
Anpassen von Treuepunkten	Fügt Punkte zu oder subtrahiert Punkte vom Konto eines Käufers. Verwenden Sie diesen Endpunkt nur, wenn Sie Punkte manuell anpassen müssen.
Arbeitswochenkonfiguration aktualisieren	Aktualisiert eine WorkweekConfig.
Arbeitswochenkonfigurationen auflisten	Gibt eine Liste der WorkweekConfig-Instanzen für ein Unternehmen zurück.
Auflisten von Bankkontokonten	Gibt eine Liste von BankAccount -Objekten zurück, die mit einem Quadrat-Konto verknüpft sind.
Auflisten von Bargeldschublade-Schichtereignissen	Stellt eine paginierte Liste von Ereignissen für eine einzelne Bargeldschubladeschicht bereit.
Auflisten von Buchungsprofilen für Teammitglieder (Beta)	Listet Buchungsprofile für Teammitglieder auf.
Auflisten von Geschenkgutscheinaktivitäten (Beta)	Listet Geschenkkartenaktivitäten auf. Standardmäßig erhalten Sie Geschenkgutscheinaktivitäten für alle Geschenkgutscheine im Konto des Verkäufers. Sie können optional Abfrageparameter angeben, um die Liste zu filtern. Beispielsweise können Sie eine Liste der Geschenkkartenaktivitäten für eine Geschenkkarte, für alle Geschenkgutscheine in einer bestimmten Region oder für Aktivitäten innerhalb eines Zeitfensters abrufen.
Auflisten von Schubladeverschiebungen	Stellt die Details für alle Schubladeverschiebungen für einen Ort in einem Datumsbereich bereit.
Auflisten von Umbruchtypen	Gibt eine paginierte Liste von BreakType-Instanzen für ein Unternehmen zurück.
Auschecken erstellen	Verknüpft eine CheckoutId mit einer checkout_page_url, an die Kunden weitergeleitet werden, um ihre Zahlungsinformationen mithilfe eines Zahlungsverarbeitungsworkflows bereitzustellen.
Ausschnitt löschen	Entfernt Ihren Codeausschnitt von einer Square Online-Website.
Bankkonto abrufen	Gibt Details eines BankAccounts zurück, das mit einem Quadrat-Konto verknüpft ist.
Bankkonto nach V1-ID abrufen	Gibt Details eines BankAccounts zurück, das von der V1-Bankkonto-ID identifiziert wurde.
Berechnen von Treuepunkten	Berechnet die Punkte, die ein Kauf erzielt. Eine Anwendung ruft diesen Endpunkt möglicherweise auf, um die Punkte anzuzeigen, die ein Käufer mit dem spezifischen Kauf verdienen kann.
Buchung erstellen (Beta)	Erstellt eine Buchung.
Codeausschnitt abrufen	Ruft Ihren Codeausschnitt von einer Square Online-Website ab. Eine Website kann Codeausschnitte aus mehreren Codeausschnittanwendungen enthalten, Sie können jedoch nur den Codeausschnitt abrufen, der von Ihrer Anwendung hinzugefügt wurde.
Durchsuchen von Treuekonten	Sucht nach Treuekonten in einem Treueprogramm.
Erstellen einer Geschenkgutscheinaktivität (Beta)	Erstellt eine Geschenkgutscheinaktivität.
Erstellen eines Treuekontos	Erstellt ein Treuekonto.
Erstellen von Gerätecode	Erstellt einen DeviceCode, der zum Anmelden bei einem Quadrat-Terminalgerät verwendet werden kann, um in den verbundenen Terminalmodus zu gelangen.
Erstellen von mobilem Autorisierungscode	Generiert Code zum Autorisieren einer mobilen Anwendung zum Herstellen einer Verbindung mit einem Square-Kartenleser. Autorisierungscodes sind einmalverwendlich und laufen 60 Minuten nach der Ausstellung ab.
Gerätecodes auflisten	Listet alle DeviceCodes auf, die dem Händler zugeordnet sind.
Geschenkgutschein abrufen (Beta)	Ruft eine Geschenkkarte mithilfe ihrer ID ab.
Händler abrufen	Rufen Sie ein Merchant-Objekt für die angegebene merchant_id ab.
Händler auflisten	Gibt Händlerinformationen für ein bestimmtes Zugriffstoken zurück.
Kunden mit Geschenkgutschein verknüpfen (Beta)	Verknüpft einen Kunden mit einer Geschenkkarte
Kundenverknüpfung von Geschenkgutschein aufheben (Beta)	Hebt die Verknüpfung eines Kunden von einer Geschenkkarte auf.
Löschen des Umbruchtyps	Löscht einen vorhandenen BreakType. Ein BreakType kann gelöscht werden, auch wenn von einer Umschalttaste darauf verwiesen wird.
Massenaktualisierung von Teammitgliedern	Aktualisiert mehrere TeamMember-Objekte.
Massenerstellung von Teammitgliedern	Erstellt mehrere TeamMember-Objekte.
Sammeln von Treuepunkten	Fügt Punkte zu einem Treuekonto hinzu.
Schicht abrufen	Gibt eine einzelne Umschalttaste zurück, die durch id angegeben wird.
Schicht aktualisieren	Aktualisiert eine vorhandene Schicht.
Schicht erstellen	Erstellt eine neue Umschalttaste. Eine Schicht stellt einen vollständigen Arbeitstag für einen einzelnen Mitarbeiter dar.
Schicht löschen	Löscht eine Schicht
Speicherort abrufen	Ruft Details eines Speicherorts ab. Sie können "main" als Standort-ID angeben, um Details des Hauptspeicherorts abzurufen.
Speicherort erstellen (Beta)	Erstellt einen Speicherort.
Speicherorte auflisten	Stellt Informationen zu allen Standorten eines Unternehmens bereit.
Suchen von Treueereignissen	Sucht nach Treueereignissen. Ein Square-Treueprogramm unterhält ein Hauptbuch von Ereignissen, die während der Lebensdauer eines Treuekontos eines Käufers auftreten. Jede Änderung des Punktesaldos (z. B. Verdiente Punkte, eingelöste Punkte und abgelaufene Punkte) wird im Hauptbuch erfasst. Mithilfe dieses Endpunkts können Sie das Hauptbuch nach Ereignissen durchsuchen.
Suchverschiebungen	Gibt eine paginierte Liste von Umschaltdatensätzen für ein Unternehmen zurück.
Teammitglied abrufen	Ruft ein TeamMember -Objekt für die angegebene TeamMember-ID ab.
Teammitglied aktualisieren	Aktualisiert ein einzelnes TeamMember-Objekt.
Teammitglied erstellen	Erstellt ein einzelnes TeamMember -Objekt.
Teammitglieder durchsuchen	Gibt eine paginierte Liste von TeamMember-Objekten für ein Unternehmen zurück.
Teammitgliedslohn abrufen	Gibt einen einzelnen TeamMemberWage zurück, der durch id angegeben wird.
Teammitgliedslöhne auflisten	Gibt eine paginierte Liste von TeamMemberWage-Instanzen für ein Unternehmen zurück.
Treueprämie einlösen	Löst eine Treueprämie ein. Nachdem die Belohnung den Terminalzustand erreicht hat, kann sie nicht gelöscht werden. Mit anderen Worten: Punkte, die für die Belohnung verwendet werden, können nicht an das Konto zurückgegeben werden.
Treueprämie löschen	Löscht eine Treueprämie. Gibt die Treuepunkte zurück auf das Treuekonto zurück. Sie können keine Belohnung löschen, die den Terminalstatus erreicht hat (EINGELÖSt).
Treueprämie schaffen	Schafft eine Treueprämie. Nachdem eine Belohnung erstellt wurde, sind die Punkte gesperrt und für den Käufer nicht verfügbar, um eine andere Belohnung einzulösen.
Treueprämien suchen	Sucht nach Treueprämien in einem Treuekonto.
Umbruchtyp erstellen	Erstellt einen neuen BreakType. Ein BreakType ist eine Vorlage zum Erstellen von Break-Objekten.
Unterbrechungstyp abrufen	Gibt einen einzelnen BreakType zurück, der durch id angegeben wird.
Update-Unterbrechungstyp	Aktualisiert einen vorhandenen BreakType.
Updatespeicherort (Beta)	Aktualisiert einen Speicherort.
Upsert-Codeausschnitt	Fügt einer Square Online-Website einen Codeausschnitt hinzu oder aktualisiert den vorhandenen Codeausschnitt auf der Website. Der Codeausschnitt wird am Ende des Kopfelements auf jeder Seite der Website angefügt, mit Ausnahme der Auscheckseiten. Eine Codeausschnittanwendung kann einer bestimmten Website einen Codeausschnitt hinzufügen.
Verfügbarkeit der Suche (Beta)	Sucht nach Verfügbarkeiten für die Buchung.
Websites auflisten	Listet die Square Online-Websites auf, die zu einem Verkäufer gehören.

Abrufen der Bargeldschubladeschicht

Vorgangs-ID:: CashDrawerRetrieveShift

Enthält die Zusammenfassungsdetails für eine einzelne Bargeldschubladeschicht.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Umschalt-ID	shift_id	True	string	Der Bezeichner der Schicht.
Speicherort-ID	location_id	True	string	Sie können diesen optionalen Filter angeben, um nur die Datensätze abzurufen, die zu einem bestimmten Speicherort gehören.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	cash_drawer_shift.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Staat	cash_drawer_shift.state	string	Der aktuelle Zustand.
Geöffnet am	cash_drawer_shift.opened_at	string	Die Zeit, zu der die Schicht begann, im ISO 8601-Format.
Beendet am	cash_drawer_shift.ended_at	string	Die Zeit, zu der die Schicht endete, im ISO 8601-Format.
Geschlossen am	cash_drawer_shift.closed_at	string	Die Uhrzeit beim Schließen im ISO 8601-Format.
Öffnen der Mitarbeiter-ID	cash_drawer_shift.opening_employee_id	string	Die ID des Mitarbeiters, der die Schubladeschicht gestartet hat.
Beenden der Mitarbeiter-ID	cash_drawer_shift.ending_employee_id	string	Die ID des Mitarbeiters, der die Bargeldschubladeschicht beendet hat.
Schließen der Mitarbeiter-ID	cash_drawer_shift.closing_employee_id	string	Die ID des Mitarbeiters, der die Schubladeschicht geschlossen hat, indem der Bargeldschubladeinhalt überprüft wird.
Description	cash_drawer_shift.description	string	Die Beschreibung.
Betrag	cash_drawer_shift.opened_cash_money.amount	integer	Der Betrag.
Währung	cash_drawer_shift.opened_cash_money.currency	string	Die Währung.
Betrag	cash_drawer_shift.cash_payment_money.amount	integer	Der Betrag.
Währung	cash_drawer_shift.cash_payment_money.currency	string	Die Währung.
Betrag	cash_drawer_shift.cash_refunds_money.amount	integer	Der Betrag.
Währung	cash_drawer_shift.cash_refunds_money.currency	string	Die Währung.
Betrag	cash_drawer_shift.cash_paid_in_money.amount	integer	Der Betrag.
Währung	cash_drawer_shift.cash_paid_in_money.currency	string	Die Währung.
Betrag	cash_drawer_shift.cash_paid_out_money.amount	integer	Der Betrag.
Währung	cash_drawer_shift.cash_paid_out_money.currency	string	Die Währung.
Betrag	cash_drawer_shift.expected_cash_money.amount	integer	Der Betrag.
Währung	cash_drawer_shift.expected_cash_money.currency	string	Die Währung.
Betrag	cash_drawer_shift.closed_cash_money.amount	integer	Der Betrag.
Währung	cash_drawer_shift.closed_cash_money.currency	string	Die Währung.
Name	cash_drawer_shift.device.name	string	Der Name.

Abrufen der Lohneinstellung

Vorgangs-ID:: TeamRetrieveWage

Ruft ein WageSetting -Objekt für ein Teammitglied ab, das von der TeamMember-ID angegeben wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teammitglieds-ID	team_member_id	True	string	Der Bezeichner des Teammitglieds.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Teammitglieds-ID	wage_setting.team_member_id	string	Die ID des Teammitglieds.
Aufgaben	wage_setting.job_assignments	array of object
Position	wage_setting.job_assignments.job_title	string	Der Titel des Auftrags.
Zahlungstyp	wage_setting.job_assignments.pay_type	string	Der aktuelle Lohntyp für die Auftragszuweisung, die zum Berechnen des Lohnbetrags in einem Zahlungszeitraum verwendet wird.
Betrag	wage_setting.job_assignments.hourly_rate.amount	integer	Der Betrag.
Währung	wage_setting.job_assignments.hourly_rate.currency	string	Die Währung.
Betrag	wage_setting.job_assignments.annual_rate.amount	integer	Der Betrag.
Währung	wage_setting.job_assignments.annual_rate.currency	string	Die Währung.
Wöchentliche Stunden	wage_setting.job_assignments.weekly_hours	integer	Die geplanten Stunden pro Woche für den Auftrag. Legen Sie fest, ob der Job PayType GEHALT ist.
Ist Überstunden ausgenommen	wage_setting.is_overtime_exempt	boolean	Gibt an, ob das Teammitglied von den Überstundenregeln des Verkäuferlandes ausgenommen ist.
Version	wage_setting.version	integer	Die aktuelle Version dieses Objekts.
Erstellt unter	wage_setting.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	wage_setting.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Abrufen des Geschäftsbuchungsprofils (Beta)

Vorgangs-ID:: BookingRetrieveProfile

Ruft das Buchungsprofil eines Verkäufers ab.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Verkäufer-ID	business_booking_profile.seller_id	string	Die ID des Verkäufers, die mit der Merchants-API beschafft werden kann.
Erstellt unter	business_booking_profile.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Buchung aktiviert	business_booking_profile.booking_enabled	boolean	Gibt an, ob der Verkäufer für die Buchung geöffnet ist.
Auswahl der Kundenzeitzone	business_booking_profile.customer_timezone_choice	string	Die Wahl der Zeitzoneninformationen eines Kunden einer Buchung. Die Square Online-Buchungswebsite und alle Benachrichtigungen für Kunden verwenden entweder die Zeitzone des Verkäufers oder die Zeitzone, die der Kunde bei der Buchung auswäht.
Buchungsrichtlinie	business_booking_profile.booking_policy	string	Die Richtlinie für den Verkäufer, Buchungsanfragen (ACCEPT_ALL) automatisch anzunehmen oder nicht (REQUIRES_ACCEPTANCE).
Benutzer abbrechen zulassen	business_booking_profile.allow_user_cancel	boolean	Gibt an, ob Kunden ihre eigenen Buchungen stornieren oder neu planen können (wahr) oder nicht (falsch).
Standorttypen	business_booking_profile.business_appointment_settings.location_types	array of string
Ausrichtungszeit	business_booking_profile.business_appointment_settings.alignment_time	string	Die Zeiteinheit der Dienstdauer für Buchungen.
Min Buchung Tead Time Sekunden	business_booking_profile.business_appointment_settings.min_booking_lead_time_seconds	integer	Die minimale Vorlaufzeit in Sekunden, bevor ein Service gebucht werden kann. Buchungen müssen mindestens so weit vor der Startzeit der Buchung erstellt werden.
Max. Buchungsvorlaufzeit Sekunden	business_booking_profile.business_appointment_settings.max_booking_lead_time_seconds	integer	Die maximale Vorlaufzeit in Sekunden, bevor ein Service gebucht werden kann. Buchungen müssen höchstens so weit vor der Startzeit der Buchung erstellt werden.
Alle Teammitgliedsbuchungen aktiviert	business_booking_profile.business_appointment_settings.any_team_member_booking_enabled	boolean	Gibt an, ob ein Kunde aus allen verfügbaren Zeitfenstern wählen kann und einem Mitarbeiter automatisch (wahr) oder nicht (false) zugewiesen ist.
Mehrere Dienstbuchungen aktiviert	business_booking_profile.business_appointment_settings.multiple_service_booking_enabled	boolean	Gibt an, ob ein Kunde mehrere Dienste in einer einzigen Onlinebuchung buchen kann.
Betrag	business_booking_profile.business_appointment_settings.cancellation_fee_money.amount	string	Der Geldbetrag in der kleinsten Währung, die durch Währung angegeben ist
Währung	business_booking_profile.business_appointment_settings.cancellation_fee_money.currency	string	Der Währungstyp im ISO 4217-Format.
Stornierungsrichtlinie	business_booking_profile.business_appointment_settings.cancellation_policy	string	Die vom Verkäufer angenommene Stornierungsrichtlinie.
Personalauswahl überspringen	business_booking_profile.business_appointment_settings.skip_booking_flow_staff_selection	boolean	Gibt an, ob Kunden über einen zugewiesenen Mitarbeiter (true) oder den Mitarbeiter ihrer Wahl (false) auswählen können.
Errors	errors	array of

Abrufen des Treueprogramms

Vorgangs-ID:: LoyaltyRetrieveProgram

Ruft das Treueprogramm in einem Verkäuferkonto ab, das durch die Programm-ID oder das Schlüsselworthauptwort angegeben wird. Treueprogramme definieren, wie Käufer Punkte sammeln und Punkte für Prämien einlösen können.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Programm-ID	program_id	True	string	Der Bezeichner des Programms.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	program.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Der Status	program.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Belohnungsstufen	program.reward_tiers	array of object
ID	program.reward_tiers.id	string	Der Bezeichner des Objekts
Punkte	program.reward_tiers.points	integer	Die Anzahl der punkte, die vom Ereignis gesammelt wurden.
Name	program.reward_tiers.name	string	Der Name des Elements. Dies ist ein durchsuchbares Attribut für die Verwendung in anwendbaren Abfragefiltern, sein Wert darf nicht leer sein, und die Länge ist von Unicode-Codepunkten.
Umfang	program.reward_tiers.definition.scope	string	Gibt die Ebene an, auf der das Objekt angewendet wird.
Rabatttyp	program.reward_tiers.definition.discount_type	string	Die Art des Rabatts der Prämienstufenangebote.
Prozentualer Rabatt	program.reward_tiers.definition.percentage_discount	string	Der feste Prozentsatz des Rabatts.
Erstellt unter	program.reward_tiers.created_at	string	Der Zeitstempel, wenn er erstellt wurde, im RFC 3339-Format.
Objekt-ID	program.reward_tiers.pricing_rule_reference.object_id	string	Die ID des objekts, auf das verwiesen wird.
Katalogversion	program.reward_tiers.pricing_rule_reference.catalog_version	string	Die Version des Objekts.
One	program.terminology.one	string	Eine Singulareinheit für einen Punkt (z. B. 1 Punkt wird als 1 Stern bezeichnet).
Other	program.terminology.other	string	Eine Pluraleinheit für Punkt (z. B. 10 Punkt wird als 10 Sterne bezeichnet).
Standort-IDs	program.location_ids	array of string
Erstellt unter	program.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	program.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.
Fälligkeitsregeln	program.accrual_rules	array of object
Fälligkeitstyp	program.accrual_rules.accrual_type	string	Die Art der Fälligkeitsregel, die definiert, wie Käufer Punkte sammeln können.
Punkte	program.accrual_rules.points	integer	Die Anzahl der punkte, die vom Ereignis gesammelt wurden.
Betrag	program.accrual_rules.spend_amount_money.amount	integer	Der Betrag.
Ausgeschlossene Kategorie-IDs	program.accrual_rules.excluded_category_ids	array of string
Ausgeschlossene Elementvariations-IDs	program.accrual_rules.excluded_item_variation_ids	array of string

Abrufen einer Geschenkkarte aus Nonce (Beta)

Vorgangs-ID:: GiftCardRetrieveNonce

Ruft eine Geschenkkarte mit einer Nonce (einem sicheren Token) ab, die die Geschenkkarte darstellt.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Nonce	nonce		string	Die Nonce des abzurufenden Geschenkgutscheins.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	gift_card.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Typ	gift_card.type	string	Der Typ dieses Objekts.
GAN-Quelle	gift_card.gan_source	string	Gibt an, ob die Geschenkkartenkontonummer (GAN) von Square generiert oder aus einem nicht quadratischen System importiert wird.
Staat	gift_card.state	string	Der aktuelle Zustand.
Betrag	gift_card.balance_money.amount	integer	Der Betrag.
Währung	gift_card.balance_money.currency	string	Die Währung.
Gan	gift_card.gan	string	Die Kontonummer des Geschenkgutscheins.
Erstellt unter	gift_card.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.

Abrufen einer Geschenkkarte von GAN (Beta)

Vorgangs-ID:: GiftCardRetrieveGAN

Ruft eine Geschenkkarte mit der Geschenkkartenkontonummer (GAN) ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Gan	gan		string	Die Kontonummer des Geschenkgutscheins.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	gift_card.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Typ	gift_card.type	string	Der Typ dieses Objekts.
GAN-Quelle	gift_card.gan_source	string	Gibt an, ob die Geschenkkartenkontonummer (GAN) von Square generiert oder aus einem nicht quadratischen System importiert wird.
Staat	gift_card.state	string	Der aktuelle Zustand.
Betrag	gift_card.balance_money.amount	integer	Der Betrag.
Währung	gift_card.balance_money.currency	string	Die Währung.
Gan	gift_card.gan	string	Die Kontonummer des Geschenkgutscheins.
Erstellt unter	gift_card.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.

Abrufen einer Treueprämie

Vorgangs-ID:: LoyaltyRetrieveReward

Ruft eine Treueprämie ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Belohnungs-ID	reward_id	True	string	Der Bezeichner der Belohnung.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	reward.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Der Status	reward.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Treuekonto-ID	reward.loyalty_account_id	string	Die ID des Treuekontos, in dem das Ereignis aufgetreten ist.
Belohnungsstufen-ID	reward.reward_tier_id	string	Die quadratische ID der Belohnungsstufe, die zum Erstellen der Belohnung verwendet wird.
Punkte	reward.points	integer	Die Anzahl der hinzugefügten oder entfernten Punkte.
Erstellt unter	reward.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	reward.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.
Eingelöst bei	reward.redeemed_at	string	Der Zeitstempel, als die Belohnung eingelöst wurde, im RFC 3339-Format.

Abrufen eines Treuekontos

Vorgangs-ID:: LoyaltyRetrieveAccount

Ruft ein Treuekonto ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Konto-ID	account_id	True	string	Der Bezeichner des Kontos.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	loyalty_account.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
ID	loyalty_account.mapping.id	string	Die quadratische ID.
Rufnummer	loyalty_account.mapping.phone_number	string	Die Telefonnummer des Empfängers.
Erstellt unter	loyalty_account.mapping.created_at	string	Der Zeitstempel, wenn er erstellt wurde, im RFC 3339-Format.
Programm-ID	loyalty_account.program_id	string	Die quadratische ID des Programms.
Gesamtbetrag	loyalty_account.balance	integer	Der verfügbare Saldo.
Lebensdauerpunkte	loyalty_account.lifetime_points	integer	Die Gesamtpunkte, die während der Lebensdauer des Kontos anfallen.
Kunden-ID	loyalty_account.customer_id	string	Die ID dieses Objekts, das den Kunden darstellt.
Erstellt unter	loyalty_account.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	loyalty_account.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Abrufen von Gerätecode

Vorgangs-ID:: DeviceGet

Ruft DeviceCode mit der zugeordneten ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID	id	True	string	Der Bezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	device_code.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Name	device_code.name	string	Der Name des Objekts.
Code	device_code.code	string	Der eindeutige Code, der zum Anmelden verwendet werden kann.
Produkttyp	device_code.product_type	string	Der Zielprodukttyp des Gerätecodes.
Speicherort-ID	device_code.location_id	string	Der Bezeichner des Speicherorts.
Erstellt unter	device_code.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Paar nach	device_code.pair_by	string	Wenn dieser DeviceCode abläuft und sich nicht mehr anmeldet. Zeitstempel im RFC 3339-Format.
Der Status	device_code.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Geräte-ID	device_code.device_id	string	Die ID des Geräts.
Status geändert bei	device_code.status_changed_at	string	Wenn der Status dieses DeviceCode zuletzt geändert wurde. Zeitstempel im RFC 3339-Format.

Aktualisieren der Lohneinstellung

Vorgangs-ID:: TeamUpdateWage

Erstellt oder aktualisiert ein WageSetting -Objekt.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teammitglieds-ID	team_member_id	True	string	Der Bezeichner des Teammitglieds.
Ist Überstunden ausgenommen	is_overtime_exempt		boolean	Gibt an, ob das Teammitglied von den Überstundenregeln des Verkäuferlandes ausgenommen ist.
Position	job_title		string	Der Titel des Auftrags.
Zahlungstyp	pay_type		string	Der aktuelle Lohntyp für die Auftragszuweisung, die zum Berechnen des Lohnbetrags in einem Zahlungszeitraum verwendet wird.
Betrag	amount		integer	Der Betrag.
Währung	currency		string	Die Währung.
Wöchentliche Stunden	weekly_hours		integer	Die geplanten Stunden pro Woche für den Auftrag. Legen Sie fest, ob der Job PayType GEHALT ist.
Betrag	amount		integer	Der Betrag.
Währung	currency		string	Die Währung.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Teammitglieds-ID	wage_setting.team_member_id	string	Die ID des Teammitglieds.
Aufgaben	wage_setting.job_assignments	array of object
Position	wage_setting.job_assignments.job_title	string	Der Titel des Auftrags.
Zahlungstyp	wage_setting.job_assignments.pay_type	string	Der aktuelle Lohntyp für die Auftragszuweisung, die zum Berechnen des Lohnbetrags in einem Zahlungszeitraum verwendet wird.
Betrag	wage_setting.job_assignments.hourly_rate.amount	integer	Der Betrag.
Währung	wage_setting.job_assignments.hourly_rate.currency	string	Die Währung.
Betrag	wage_setting.job_assignments.annual_rate.amount	integer	Der Betrag.
Währung	wage_setting.job_assignments.annual_rate.currency	string	Die Währung.
Wöchentliche Stunden	wage_setting.job_assignments.weekly_hours	integer	Die geplanten Stunden pro Woche für den Auftrag. Legen Sie fest, ob der Job PayType GEHALT ist.
Ist Überstunden ausgenommen	wage_setting.is_overtime_exempt	boolean	Gibt an, ob das Teammitglied von den Überstundenregeln des Verkäuferlandes ausgenommen ist.
Version	wage_setting.version	integer	Die aktuelle Version dieses Objekts.
Erstellt unter	wage_setting.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	wage_setting.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Anpassen von Treuepunkten

Vorgangs-ID:: LoyaltyAdjustPoints

Fügt Punkte zu oder subtrahiert Punkte vom Konto eines Käufers. Verwenden Sie diesen Endpunkt nur, wenn Sie Punkte manuell anpassen müssen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Konto-ID	account_id	True	string	Der Bezeichner des Kontos.
Punkte	points		integer	Die Anzahl der hinzugefügten oder entfernten Punkte.
Ursache	reason		string	Der Grund für dieses Objekt.
Idempotency-Taste	idempotency_key		string	Ein Wert, den Sie angeben, die diese Anforderung eindeutig unter allen Ihren Anforderungen identifiziert. Eine gängige Methode zum Erstellen eines gültigen idempotency-Schlüssels besteht darin, einen universally unique identifier (UUID) zu verwenden.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	event.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Typ	event.type	string	Der Typ dieses Objekts.
Erstellt unter	event.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Treueprogramm-ID	event.adjust_points.loyalty_program_id	string	Die ID des Treueprogramms
Punkte	event.adjust_points.points	integer	Die Anzahl der punkte, die vom Ereignis gesammelt wurden.
Ursache	event.adjust_points.reason	string	Der Grund für die Anpassung von Punkten.
Treuekonto-ID	event.loyalty_account_id	string	Die ID des Treuekontos, in dem das Ereignis aufgetreten ist.
Quelle	event.source	string	Die Quelle.

Arbeitswochenkonfiguration aktualisieren

Vorgangs-ID:: LaborUpdateConfig

Aktualisiert eine WorkweekConfig.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID	id	True	string	Der Bezeichner.
Beginn der Woche	start_of_week		string	Der Wochentag, an dem eine Geschäftswoche zu Entschädigungszwecken endet.
Start Of Day Local Time	start_of_day_local_time		string	Die Ortszeit, zu der eine Geschäftswoche endet. Wird als Zeichenfolge im HH:MM-Format dargestellt (HH:MM:SS wird ebenfalls akzeptiert, Sekunden werden jedoch abgeschnitten).
Version	version		integer	Die aktuelle Version dieses Objekts.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	workweek_config.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Beginn der Woche	workweek_config.start_of_week	string	Der Wochentag, an dem eine Geschäftswoche zu Entschädigungszwecken endet.
Start Of Day Local Time	workweek_config.start_of_day_local_time	string	Die Ortszeit, zu der eine Geschäftswoche endet. Wird als Zeichenfolge im HH:MM-Format dargestellt (HH:MM:SS wird ebenfalls akzeptiert, Sekunden werden jedoch abgeschnitten).
Version	workweek_config.version	integer	Die aktuelle Version dieses Objekts.
Erstellt unter	workweek_config.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	workweek_config.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Arbeitswochenkonfigurationen auflisten

Vorgangs-ID:: LaborListConfigs

Gibt eine Liste der WorkweekConfig-Instanzen für ein Unternehmen zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Limit	limit		integer	Obergrenze für die Zahl, die in der Antwort zurückgegeben werden soll.
Mauszeiger	cursor		string	Der Paginierungscursor, der von einem vorherigen Aufruf an diesen Endpunkt zurückgegeben wird.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Workweek-Konfigurationen	workweek_configs	array of object
ID	workweek_configs.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Beginn der Woche	workweek_configs.start_of_week	string	Der Wochentag, an dem eine Geschäftswoche zu Entschädigungszwecken endet.
Start Of Day Local Time	workweek_configs.start_of_day_local_time	string	Die Ortszeit, zu der eine Geschäftswoche endet. Wird als Zeichenfolge im HH:MM-Format dargestellt (HH:MM:SS wird ebenfalls akzeptiert, Sekunden werden jedoch abgeschnitten).
Version	workweek_configs.version	integer	Die aktuelle Version des Objekts.
Erstellt unter	workweek_configs.created_at	string	Die Ereigniszeit im ISO 8601-Format.
Aktualisiert unter	workweek_configs.updated_at	string	Zeitstempel der letzten Änderung im RFC 3339-Format
Mauszeiger	cursor	string	Fügen Sie den Paginierungscursor in nachfolgende Aufrufe dieses Endpunkts ein, um die nächste Gruppe von Ergebnissen abzurufen, die der ursprünglichen Abfrage zugeordnet sind.

Auflisten von Bankkontokonten

Vorgangs-ID:: BankAccountList

Gibt eine Liste von BankAccount -Objekten zurück, die mit einem Quadrat-Konto verknüpft sind.

Parameter

Name	Schlüssel	Typ	Beschreibung
Mauszeiger	cursor	string	Der Paginierungscursor, der von einem vorherigen Aufruf an diesen Endpunkt zurückgegeben wird.
Limit	limit	integer	Obergrenze für die Zahl, die in der Antwort zurückgegeben werden soll.
Speicherort-ID	location_id	string	Sie können diesen optionalen Filter angeben, um nur die Datensätze abzurufen, die zu einem bestimmten Speicherort gehören.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Bankkonto	bank_accounts	array of object
ID	bank_accounts.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Kontonummernsuffix	bank_accounts.account_number_suffix	string	Die letzten Ziffern der Kontonummer.
Country	bank_accounts.country	string	Der ISO 3166 Alpha-2-Ländercode.
Währung	bank_accounts.currency	string	Der 3-stellige ISO 4217-Währungscode.
Kontoart	bank_accounts.account_type	string	Der finanzielle Zweck des zugehörigen Bankkontos.
Name des Inhabers	bank_accounts.holder_name	string	Name des Kontoinhabers. Dieser Name muss mit dem Namen für den Zielkontodatensatz übereinstimmen.
Primäre Bankidentifikationsnummer	bank_accounts.primary_bank_identification_number	string	Primärbezeichner für die Bank.
Speicherort-ID	bank_accounts.location_id	string	Der Bezeichner für den Speicherort.
Der Status	bank_accounts.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Anerkennenswert	bank_accounts.creditable	boolean	Gibt an, ob Square Geld an dieses Bankkonto senden kann.
Debitable	bank_accounts.debitable	boolean	Gibt an, ob Square Geld an dieses Bankkonto senden kann.
Version	bank_accounts.version	integer	Die aktuelle Version des Objekts.
Bankname	bank_accounts.bank_name	string	Name des tatsächlichen Finanzinstituts.

Auflisten von Bargeldschublade-Schichtereignissen

Vorgangs-ID:: CashDrawerListEvents

Stellt eine paginierte Liste von Ereignissen für eine einzelne Bargeldschubladeschicht bereit.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Umschalt-ID	shift_id	True	string	Der Bezeichner der Schicht.
Speicherort-ID	location_id	True	string	Sie können diesen optionalen Filter angeben, um nur die Datensätze abzurufen, die zu einem bestimmten Speicherort gehören.
Limit	limit		integer	Obergrenze für die Zahl, die in der Antwort zurückgegeben werden soll.
Mauszeiger	cursor		string	Der Paginierungscursor, der von einem vorherigen Aufruf an diesen Endpunkt zurückgegeben wird.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Ereignisse	events	array of object
ID	events.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Ereignistyp	events.event_type	string	Die Art des Bargeldschublade-Schichtereignisses.
Betrag	events.event_money.amount	integer	Der Betrag.
Währung	events.event_money.currency	string	Die Währung.
Erstellt unter	events.created_at	string	Die Ereigniszeit im ISO 8601-Format.
Description	events.title	string	Die Beschreibung.

Auflisten von Buchungsprofilen für Teammitglieder (Beta)

Vorgangs-ID:: BookingListTeamProfiles

Listet Buchungsprofile für Teammitglieder auf.

Parameter

Name	Schlüssel	Typ	Beschreibung
Nur buchbar	bookable_only	boolean	Gibt an, ob nur buchbare Teammitglieder in das zurückgegebene Ergebnis (true) oder nicht (false) eingeschlossen werden sollen.
Limit	limit	integer	Obergrenze für die Zahl, die in der Antwort zurückgegeben werden soll.
Mauszeiger	cursor	string	Der Paginierungscursor, der von einem vorherigen Aufruf an diesen Endpunkt zurückgegeben wird.
Speicherort-ID	location_id	string	Sie können diesen optionalen Filter angeben, um nur die Datensätze abzurufen, die zu einem bestimmten Speicherort gehören.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Buchungsprofile für Teammitglieder	team_member_booking_profiles	array of object
Teammitglieds-ID	team_member_booking_profiles.team_member_id	string	Die ID des TeamMember-Objekts für das Dem Objekt zugeordnete Teammitglied.
Anzeigename	team_member_booking_profiles.display_name	string	Der Anzeigename des Teammitglieds.
Ist buchbar	team_member_booking_profiles.is_bookable	boolean	Gibt an, ob das Teammitglied über die Bookings-API oder den Onlinebuchungskanal oder die Website des Verkäufers (wahr) oder nicht (falsch) gebucht werden kann.
Errors	errors	array of

Auflisten von Geschenkgutscheinaktivitäten (Beta)

Vorgangs-ID:: GiftCardList

Listet Geschenkkartenaktivitäten auf. Standardmäßig erhalten Sie Geschenkgutscheinaktivitäten für alle Geschenkgutscheine im Konto des Verkäufers. Sie können optional Abfrageparameter angeben, um die Liste zu filtern. Beispielsweise können Sie eine Liste der Geschenkkartenaktivitäten für eine Geschenkkarte, für alle Geschenkgutscheine in einer bestimmten Region oder für Aktivitäten innerhalb eines Zeitfensters abrufen.

Parameter

Name	Schlüssel	Typ	Beschreibung
Geschenkgutschein-ID	gift_card_id	string	Wenn Sie eine Geschenkgutschein-ID angeben, gibt der Endpunkt Aktivitäten zurück, die zur angegebenen Geschenkkarte gehören. Andernfalls gibt der Endpunkt alle Aktivitäten der Geschenkkarte für den Verkäufer zurück.
Typ	type	string	Wenn Sie einen Typ angeben, gibt der Endpunkt Geschenkkartenaktivitäten dieses Typs zurück. Andernfalls gibt der Endpunkt alle Arten von Geschenkkartenaktivitäten zurück.
Speicherort-ID	location_id	string	Sie können diesen optionalen Filter angeben, um nur die Datensätze abzurufen, die zu einem bestimmten Speicherort gehören.
Anfangszeit	begin_time	string	Die inklusive Startzeit der Abfrage für opened_at im ISO 8601-Format.
Endzeit	end_time	string	Das exklusive Enddatum der Abfrage am opened_at im ISO 8601-Format.
Limit	limit	integer	Obergrenze für die Zahl, die in der Antwort zurückgegeben werden soll.
Mauszeiger	cursor	string	Der Paginierungscursor, der von einem vorherigen Aufruf an diesen Endpunkt zurückgegeben wird.
Sortierreihenfolge	sort_order	string	Sortiert die zurückgegebene Liste nach dem Zeitpunkt der Erstellung der Karte mit der angegebenen Reihenfolge.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Geschenkgutscheinaktivitäten	gift_card_activities	array of object
ID	gift_card_activities.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Typ	gift_card_activities.type	string	Der Typ dieses Objekts.
Speicherort-ID	gift_card_activities.location_id	string	Der Bezeichner für den Speicherort.
Erstellt unter	gift_card_activities.created_at	string	Die Ereigniszeit im ISO 8601-Format.
Geschenkgutschein-ID	gift_card_activities.gift_card_id	string	Die Geschenkgutschein-ID. Die ID ist nicht erforderlich, wenn ein GAN vorhanden ist.
Geschenkgutschein GAN	gift_card_activities.gift_card_gan	string	Die Geschenkkarte GAN. Das GAN ist nicht erforderlich, wenn gift_card_id vorhanden ist.
Betrag	gift_card_activities.gift_card_balance_money.amount	integer	Der Betrag.
Währung	gift_card_activities.gift_card_balance_money.currency	string	Die Währung.
Betrag	gift_card_activities.redeem_activity_details.amount_money.amount	integer	Der Betrag.
Währung	gift_card_activities.redeem_activity_details.amount_money.currency	string	Die Währung.
Betrag	gift_card_activities.activate_activity_details.amount_money.amount	integer	Der Betrag.
Währung	gift_card_activities.activate_activity_details.amount_money.currency	string	Die Währung.
Auftrags-ID	gift_card_activities.activate_activity_details.order_id	string	Die ID der Bestellung, die der Aktivität zugeordnet ist.
Zeilenelement-UID	gift_card_activities.activate_activity_details.line_item_uid	string	Die line_item_uid des Artikelartikels der Geschenkkarte in einer Bestellung.

Auflisten von Schubladeverschiebungen

Vorgangs-ID:: CashDrawerListShifts

Stellt die Details für alle Schubladeverschiebungen für einen Ort in einem Datumsbereich bereit.

Parameter

Name	Schlüssel	Typ	Beschreibung
Speicherort-ID	location_id	string	Sie können diesen optionalen Filter angeben, um nur die Datensätze abzurufen, die zu einem bestimmten Speicherort gehören.
Sortierreihenfolge	sort_order	string	Sortiert die zurückgegebene Liste nach dem Zeitpunkt der Erstellung der Karte mit der angegebenen Reihenfolge.
Anfangszeit	begin_time	string	Die inklusive Startzeit der Abfrage für opened_at im ISO 8601-Format.
Endzeit	end_time	string	Das exklusive Enddatum der Abfrage am opened_at im ISO 8601-Format.
Limit	limit	integer	Obergrenze für die Zahl, die in der Antwort zurückgegeben werden soll.
Mauszeiger	cursor	string	Der Paginierungscursor, der von einem vorherigen Aufruf an diesen Endpunkt zurückgegeben wird.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Gegenstände	items	array of object
ID	items.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Staat	items.state	string	Der aktuelle Zustand.
Geöffnet am	items.opened_at	string	Die Schichtanfangszeit im ISO 8601-Format.
Beendet am	items.ended_at	string	Die Schichtendzeit im ISO 8601-Format.
Geschlossen am	items.closed_at	string	Die Schichtschlusszeit im ISO 8601-Format.
Description	items.title	string	Die Beschreibung.
Betrag	items.opened_cash_money.amount	integer	Der Betrag.
Währung	items.opened_cash_money.currency	string	Die Währung.
Betrag	items.expected_cash_money.amount	integer	Der Betrag.
Währung	items.expected_cash_money.currency	string	Die Währung.
Betrag	items.closed_cash_money.amount	integer	Der Betrag.
Währung	items.closed_cash_money.currency	string	Die Währung.

Auflisten von Umbruchtypen

Vorgangs-ID:: LaborListBreak

Gibt eine paginierte Liste von BreakType-Instanzen für ein Unternehmen zurück.

Parameter

Name	Schlüssel	Typ	Beschreibung
Speicherort-ID	location_id	string	Sie können diesen optionalen Filter angeben, um nur die Datensätze abzurufen, die zu einem bestimmten Speicherort gehören.
Limit	limit	integer	Obergrenze für die Zahl, die in der Antwort zurückgegeben werden soll.
Mauszeiger	cursor	string	Der Paginierungscursor, der von einem vorherigen Aufruf an diesen Endpunkt zurückgegeben wird.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Unterbrechungstypen	break_types	array of object
ID	break_types.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Speicherort-ID	break_types.location_id	string	Der Bezeichner für den Speicherort.
Umbruchname	break_types.break_name	string	Ein lesbarer Name für diese Art von Unterbrechung. Der Name wird mitarbeitern in Square-Produkten angezeigt.
Erwartete Dauer	break_types.expected_duration	string	Die erwartete Länge dieses Umbruchs. Format: RFC-3339 P[n]Y[n]M[n]M[n]DT[n]H[n]M[n]S. Genauigkeit kleiner als Minuten wird abgeschnitten.
Wird bezahlt	break_types.is_paid	boolean	Gibt an, ob diese Unterbrechung zu Entschädigungszwecken auf Zeit zugegangen ist.
Version	break_types.version	integer	Die aktuelle Version des Objekts.
Erstellt unter	break_types.created_at	string	Die Ereigniszeit im ISO 8601-Format.
Aktualisiert unter	break_types.updated_at	string	Zeitstempel der letzten Änderung im RFC 3339-Format
Mauszeiger	cursor	string	Fügen Sie den Paginierungscursor in nachfolgende Aufrufe dieses Endpunkts ein, um die nächste Gruppe von Ergebnissen abzurufen, die der ursprünglichen Abfrage zugeordnet sind.

Auschecken erstellen

Vorgangs-ID:: CheckoutCreate

Verknüpft eine CheckoutId mit einer checkout_page_url, an die Kunden weitergeleitet werden, um ihre Zahlungsinformationen mithilfe eines Zahlungsverarbeitungsworkflows bereitzustellen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Speicherort-ID	location_id	True	string	Der Bezeichner des Speicherorts.
Idempotency-Taste	idempotency_key		string	Ein Wert, den Sie angeben, die diese Anforderung eindeutig unter allen Ihren Anforderungen identifiziert. Eine gängige Methode zum Erstellen eines gültigen idempotency-Schlüssels besteht darin, einen universally unique identifier (UUID) zu verwenden.
Umleitungs-URL	redirect_url		string	Wenn die bereitgestellte Umleitungs-URL beispielsweise lautet `http://www.example.com/order-complete`, leitet eine erfolgreiche Transaktion den Kunden zu: `http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` Wenn Sie keine Umleitungs-URL angeben, zeigt Square Checkout eine Bestellbestätigungsseite in Ihrem Auftrag an. Es wird jedoch dringend empfohlen, eine Umleitungs-URL bereitzustellen, damit Sie die Transaktionsergebnisse überprüfen und die Bestellung über Ihren vorhandenen/normalen Bestätigungsworkflow abschließen können.
Idempotency-Taste	idempotency_key		string	Ein Wert, den Sie angeben, die diese Bestellung unter bestellungen eindeutig identifiziert, die Sie erstellt haben. Wenn Sie nicht sicher sind, ob eine bestimmte Bestellung erfolgreich erstellt wurde, können Sie sie mit demselben Idempotency-Schlüssel erneut versuchen, ohne sich Gedanken über das Erstellen doppelter Bestellungen machen zu müssen.
Speicherort-ID	location_id		string	Der Abfrageausdruck, der nach Verfügbarkeiten sucht, die den angegebenen Verkäuferspeicherort-IDs entsprechen.
Kunden-ID	customer_id		string	Die ID des Kunden, der der Bestellung zugeordnet ist.
Referenz-ID	reference_id		string	Eine clientspezifische ID, um eine Entität in einem anderen System dieser Reihenfolge zuzuordnen.
Name	name		string	Der Name des Elements.
Menge	quantity		string	Die gekaufte Menge, die als Dezimalzahl formatiert ist. Positionen mit einer Menge von 0 werden automatisch entfernt, wenn Sie die Bestellung bezahlen oder anderweitig abschließen.
Betrag	amount		integer	Der Betrag.
Währung	currency		string	Die Währung.
Rabatt-UID	discount_uid		string	Die UID des Rabatts, den der angewendete Rabatt darstellt. Sie muss auf einen Rabatt verweisen, der im Feld "order.discounts" vorhanden ist. Dieses Feld ist unveränderlich. Um zu ändern, welche Rabatte für einen Artikel gelten, müssen Sie den Rabatt löschen und es als neues OrderLineItemAppliedDiscount-Element erneut hinzufügen.
Steuer-UID	tax_uid		string	Die UID der Steuer, für die diese angewendete Steuer steht. Sie muss auf eine im Feld "order.tax" enthaltene Steuer verweisen. Dieses Feld ist unveränderlich. Wenn Sie ändern möchten, welche Steuern für eine Position gelten, löschen Und fügen Sie ein neues OrderLineItemAppliedTax hinzu.
UID	uid		string	Eine eindeutige ID.
Typ	type		string	Der Typ dieses Objekts.
Prozentsatz	percentage		string	Der Prozentsatz der Steuer als Zeichenfolgendarstellung einer Dezimalzahl.
Umfang	scope		string	Gibt die Ebene an, auf der das Objekt angewendet wird.
UID	uid		string	Eine eindeutige ID.
Typ	type		string	Der Typ dieses Objekts.
Umfang	scope		string	Gibt die Ebene an, auf der das Objekt angewendet wird.
Betrag	amount		integer	Der Betrag.
Währung	currency		string	Die Währung.
Speicherort-ID	location_id		string	Der Bezeichner für den Speicherort.
Description	title		string	Die Beschreibung.
Betrag	amount		integer	Der Betrag.
Währung	currency		string	Die Währung.
Versandadresse anfordern	ask_for_shipping_address		boolean	Wenn true, sammelt Square Checkout Versandinformationen in Ihrem Auftrag und speichert diese Informationen mit den Transaktionsinformationen im Square Seller Dashboard.
Händlersupport-E-Mail	merchant_support_email		string	Die E-Mail-Adresse, die auf der Bestätigungsseite des Square Checkout angezeigt werden soll, und bestätigungs-E-Mail, die der Käufer zum Kontaktieren des Verkäufers verwenden kann. Wenn dieser Wert nicht festgelegt ist, zeigt die Bestätigungsseite und E-Mail die primäre E-Mail-Adresse an, die dem Quadratkonto des Verkäufers zugeordnet ist.
Vorabfüllen der E-Mail-Adresse des Käufers	pre_populate_buyer_email		string	Wenn angegeben, wird die E-Mail des Käufers auf der Checkout-Seite als bearbeitbares Textfeld vorgefüllt.
Adresszeile 1	address_line_1		string	Die erste Zeile der Adresse.
Adresszeile 2	address_line_2		string	Die zweite Zeile der Adresse( falls vorhanden).
Örtlichkeit	locality		string	Die Stadt oder Die Stadt der Adresse.
VerwaltungsbezirkSebene 1	administrative_district_level_1		string	Eine zivile Person im Land der Adresse. In den USA ist dies der Staat.
Postleitzahl	postal_code		string	Die Postleitzahl der Adresse.
Country	country		string	Der ISO 3166 Alpha-2-Ländercode.
Vorname	first_name		string	Optionaler Vorname, wenn er den Empfänger darstellt.
Nachname	last_name		string	Optionaler Nachname, wenn er den Empfänger darstellt.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	checkout.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
URL der Auscheckseite	checkout.checkout_page_url	string	Die URL, an die der Browser des Käufers umgeleitet werden soll, nachdem das Auschecken abgeschlossen wurde.
Versandadresse anfordern	checkout.ask_for_shipping_address	boolean	Wenn "true", sammelt Square Checkout Versandinformationen in Ihrem Auftrag und speichert diese Informationen mit den Transaktionsinformationen in Ihrem Square Dashboard.
Händlersupport-E-Mail	checkout.merchant_support_email	string	Die E-Mail-Adresse, die auf der Bestätigungsseite des Square Checkout angezeigt werden soll, und bestätigungs-E-Mail, die der Käufer verwenden kann, um sich an den Händler zu wenden.
Vorabfüllen der E-Mail-Adresse des Käufers	checkout.pre_populate_buyer_email	string	Wenn angegeben, wird die E-Mail des Käufers auf der Checkout-Seite als bearbeitbares Textfeld vorgefüllt.
Adresszeile 1	checkout.pre_populate_shipping_address.address_line_1	string	Die erste Zeile der Adresse. Felder, die mit address_line beginnen, geben die spezifischesten Details der Adresse an, z. B. Straßennummer, Straßenname und Gebäudename.
Adresszeile 2	checkout.pre_populate_shipping_address.address_line_2	string	Die zweite Zeile der Adresse( falls vorhanden).
Örtlichkeit	checkout.pre_populate_shipping_address.locality	string	Die Stadt oder Die Stadt der Adresse.
VerwaltungsbezirkSebene 1	checkout.pre_populate_shipping_address.administrative_district_level_1	string	Eine zivile Person im Land der Adresse. In den USA ist dies der Staat.
Postleitzahl	checkout.pre_populate_shipping_address.postal_code	string	Die Postleitzahl der Adresse.
Country	checkout.pre_populate_shipping_address.country	string	Das Land der Adresse im ISO 3166-1-Alpha-2-Format.
Vorname	checkout.pre_populate_shipping_address.first_name	string	Optionaler Vorname, wenn er den Empfänger darstellt.
Nachname	checkout.pre_populate_shipping_address.last_name	string	Optionaler lsat-Name, wenn er den Empfänger darstellt.
Umleitungs-URL	checkout.redirect_url	string	Die URL, an die nach Abschluss des Auscheckvorgangs umgeleitet werden soll, mit checkoutId, square es orderId, transactionId und referenceId, die als URL-Parameter angefügt wurde. Wenn beispielsweise die bereitgestellte redirect_url ist `http://www.example.com/order-complete`, leitet eine erfolgreiche Transaktion den Kunden zu: `http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` Wenn Sie keine Umleitungs-URL angeben, zeigt Square Checkout eine Bestellbestätigungsseite in Ihrem Auftrag an. Square empfiehlt jedoch dringend, eine Umleitungs-URL anzugeben, damit Sie die Transaktionsergebnisse überprüfen und die Bestellung über Ihren vorhandenen/normalen Bestätigungsworkflow abschließen können.
Speicherort-ID	checkout.order.location_id	string	Der Abfrageausdruck, der nach Verfügbarkeiten sucht, die den angegebenen Verkäuferspeicherort-IDs entsprechen.
Kunden-ID	checkout.order.customer_id	string	Die ID des Kunden, der der Bestellung zugeordnet ist.
Referenz-ID	checkout.order.reference_id	string	Eine clientspezifische ID, um eine Entität in einem anderen System dieser Reihenfolge zuzuordnen.
Zeilenelemente	checkout.order.line_items	array of object
Name	checkout.order.line_items.name	string	Der Name des Zeilenelements.
Menge	checkout.order.line_items.quantity	string	Die gekaufte Menge, die als Dezimalzahl formatiert ist. Positionen mit einer Menge von 0 werden automatisch entfernt, wenn Sie die Bestellung bezahlen oder anderweitig abschließen.
Angewendete Steuern	checkout.order.line_items.applied_taxes	array of object
Steuer-UID	checkout.order.line_items.applied_taxes.tax_uid	string	Die UID der Steuer, für die diese angewendete Steuer steht. Sie muss auf eine im Feld "order.tax" enthaltene Steuer verweisen. Dieses Feld ist unveränderlich. Wenn Sie ändern möchten, welche Steuern für eine Position gelten, löschen Und fügen Sie ein neues OrderLineItemAppliedTax hinzu.
Betrag	checkout.order.line_items.applied_taxes.applied_money.amount	integer	Der Geldbetrag in der kleinsten Währungsbezeichnung, die durch Währung angegeben ist. Wenn die Währung z. B. USD ist, beträgt der Betrag in Cent. Geldbeträge können positiv oder negativ sein. In der spezifischen Feldbeschreibung können Sie die Bedeutung des Zeichens in einem bestimmten Fall ermitteln.
Währung	checkout.order.line_items.applied_taxes.applied_money.currency	string	Der Währungstyp im ISO 4217-Format. Der Währungscode für US-Dollar ist beispielsweise USD.
Angewendete Rabatte	checkout.order.line_items.applied_discounts	array of object
Rabatt-UID	checkout.order.line_items.applied_discounts.discount_uid	string	Die UID des Rabatts, den der angewendete Rabatt darstellt. Sie muss auf einen Rabatt verweisen, der im Feld "order.discounts" vorhanden ist. Dieses Feld ist unveränderlich. Um zu ändern, welche Rabatte für einen Artikel gelten, müssen Sie den Rabatt löschen und es als neues OrderLineItemAppliedDiscount-Element erneut hinzufügen.
Betrag	checkout.order.line_items.applied_discounts.applied_money.amount	integer	Der Geldbetrag in der kleinsten Währungsbezeichnung, die durch Währung angegeben ist. Wenn die Währung z. B. USD ist, beträgt der Betrag in Cent. Geldbeträge können positiv oder negativ sein. In der spezifischen Feldbeschreibung können Sie die Bedeutung des Zeichens in einem bestimmten Fall ermitteln.
Währung	checkout.order.line_items.applied_discounts.applied_money.currency	string	Der Währungstyp im ISO 4217-Format. Der Währungscode für US-Dollar ist beispielsweise USD.
Betrag	checkout.order.line_items.base_price_money.amount	integer	Der Betrag.
Währung	checkout.order.line_items.base_price_money.currency	string	Die Währung.
Betrag	checkout.order.line_items.total_tax_money.amount	integer	Der Betrag.
Währung	checkout.order.line_items.total_tax_money.currency	string	Die Währung.
Betrag	checkout.order.line_items.total_discount_money.amount	integer	Der Betrag.
Währung	checkout.order.line_items.total_discount_money.currency	string	Die Währung.
Betrag	checkout.order.line_items.total_money.amount	integer	Der Betrag.
Währung	checkout.order.line_items.total_money.currency	string	Die Währung.
MwSt.	checkout.order.taxes	array of object
UID	checkout.order.taxes.uid	string	Eine eindeutige ID.
Typ	checkout.order.taxes.type	string	Der Typ dieses Objekts.
Prozentsatz	checkout.order.taxes.percentage	string	Der Prozentsatz der Steuer als Zeichenfolgendarstellung einer Dezimalzahl.
Umfang	checkout.order.taxes.scope	string	Gibt die Ebene an, auf der das Objekt angewendet wird.
Rabatte	checkout.order.discounts	array of object
UID	checkout.order.discounts.uid	string	Eine eindeutige ID.
Typ	checkout.order.discounts.type	string	Der Typ dieses Objekts.
Umfang	checkout.order.discounts.scope	string	Gibt die Ebene an, auf der das Objekt angewendet wird.
Betrag	checkout.order.discounts.amount_money.amount	integer	Der Betrag.
Währung	checkout.order.discounts.amount_money.currency	string	Die Währung.
Betrag	checkout.order.discounts.applied_money.amount	integer	Der Betrag.
Währung	checkout.order.discounts.applied_money.currency	string	Die Währung.
Betrag	checkout.order.total_money.amount	integer	Der Betrag.
Währung	checkout.order.total_money.currency	string	Die Währung.
Betrag	checkout.order.total_tax_money.amount	integer	Der Betrag.
Währung	checkout.order.total_tax_money.currency	string	Die Währung.
Betrag	checkout.order.total_discount_money.amount	integer	Der Betrag.
Währung	checkout.order.total_discount_money.currency	string	Die Währung.
Erstellt unter	checkout.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Version	checkout.version	integer	Die aktuelle Version dieses Objekts.
Weitere Empfänger	checkout.additional_recipients	array of object
Speicherort-ID	checkout.additional_recipients.location_id	string	Die Standort-ID für einen Empfänger (außer dem Händler), der einen Teil dieses Angebots erhält.
Description	checkout.additional_recipients.title	string	Die Beschreibung des Elements. Dies ist ein durchsuchbares Attribut für die Verwendung in anwendbaren Abfragefiltern, und die Wertlänge ist von Unicode-Codepunkten.
Betrag	checkout.additional_recipients.amount_money.amount	integer	Der Betrag.
Währung	checkout.additional_recipients.amount_money.currency	string	Die Währung.

Ausschnitt löschen

Vorgangs-ID:: SnippetDelete

Entfernt Ihren Codeausschnitt von einer Square Online-Website.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID der Website	site_id	True	string	Der Bezeichner der Website.

Gibt zurück

response: object

Bankkonto abrufen

Vorgangs-ID:: BankAccountGet

Gibt Details eines BankAccounts zurück, das mit einem Quadrat-Konto verknüpft ist.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Bankkonto-ID	bank_account_id	True	string	Square-ausgestellte ID des gewünschten BankAccounts.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	bank_account.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Kontonummernsuffix	bank_account.account_number_suffix	string	Die letzten Ziffern der Kontonummer.
Country	bank_account.country	string	Der ISO 3166 Alpha-2-Ländercode.
Währung	bank_account.currency	string	Der 3-stellige ISO 4217-Währungscode.
Kontoart	bank_account.account_type	string	Der Typ des Kontos.
Name des Inhabers	bank_account.holder_name	string	Name des Kontoinhabers.
Primäre Bankidentifikationsnummer	bank_account.primary_bank_identification_number	string	Primärbezeichner für die Bank.
Speicherort-ID	bank_account.location_id	string	Der Bezeichner des Speicherorts.
Der Status	bank_account.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Anerkennenswert	bank_account.creditable	boolean	Gibt an, ob Square Geld an dieses Konto senden kann.
Debitable	bank_account.debitable	boolean	Gibt an, ob Es möglich ist, dass Square Geld von diesem Konto in Anspruch nehmen kann.
Version	bank_account.version	integer	Die aktuelle Version dieses Objekts.
Bankname	bank_account.bank_name	string	Name des tatsächlichen Finanzinstituts.

Bankkonto nach V1-ID abrufen

Vorgangs-ID:: BankAccountGetV1

Gibt Details eines BankAccounts zurück, das von der V1-Bankkonto-ID identifiziert wurde.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
V1 Bankkonto-ID	v1_bank_account_id	True	string	Verbinden Sie die V1-ID des gewünschten BankAccounts.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	bank_account.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Kontonummernsuffix	bank_account.account_number_suffix	string	Die letzten Ziffern der Kontonummer.
Country	bank_account.country	string	Der ISO 3166 Alpha-2-Ländercode.
Währung	bank_account.currency	string	Der 3-stellige ISO 4217-Währungscode.
Kontoart	bank_account.account_type	string	Der Typ des Kontos.
Name des Inhabers	bank_account.holder_name	string	Name des Kontoinhabers.
Primäre Bankidentifikationsnummer	bank_account.primary_bank_identification_number	string	Primärbezeichner für die Bank.
Speicherort-ID	bank_account.location_id	string	Der Bezeichner des Speicherorts.
Der Status	bank_account.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Anerkennenswert	bank_account.creditable	boolean	Gibt an, ob Square Geld an dieses Konto senden kann.
Debitable	bank_account.debitable	boolean	Gibt an, ob Es möglich ist, dass Square Geld von diesem Konto in Anspruch nehmen kann.
Version	bank_account.version	integer	Die aktuelle Version dieses Objekts.
Bankname	bank_account.bank_name	string	Name des tatsächlichen Finanzinstituts.

Berechnen von Treuepunkten

Vorgangs-ID:: LoyaltyCalculatePoints

Berechnet die Punkte, die ein Kauf erzielt. Eine Anwendung ruft diesen Endpunkt möglicherweise auf, um die Punkte anzuzeigen, die ein Käufer mit dem spezifischen Kauf verdienen kann.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Programm-ID	program_id	True	string	Der Bezeichner des Programms.
Auftrags-ID	order_id		string	Der Auftragsbezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Punkte	points	integer	Die Punkte, die der Käufer aus einem bestimmten Kauf verdienen kann.

Buchung erstellen (Beta)

Vorgangs-ID:: BookingCreate

Erstellt eine Buchung.

Parameter

Name	Schlüssel	Typ	Beschreibung
Kunden-ID	customer_id	string	Die ID dieses Objekts, das den Kunden darstellt.
Beginnen Bei	start_at	string	Der Zeitstempel, der die Startzeit dieses Objekts im RFC 3339-Format angibt.
Speicherort-ID	location_id	string	Der Bezeichner des Speicherorts.
Dauer Minuten	duration_minutes	integer	Die Zeitspanne in Minuten eines Terminsegments.
Teammitglieds-ID	team_member_id	string	Die ID des TeamMember-Objekts, das das in diesem Segment gebuchte Teammitglied darstellt.
Dienstvariations-ID	service_variation_id	string	Die ID des CatalogItemVariation-Objekts, das den in diesem Segment gebuchten Dienst darstellt.
Dienstvariationsversion	service_variation_version	integer	Die aktuelle Version der Elementvariation, die den in diesem Segment gebuchten Dienst darstellt.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	booking.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Version	booking.version	integer	Die aktuelle Version dieses Objekts.
Der Status	booking.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Erstellt unter	booking.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	booking.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.
Speicherort-ID	booking.location_id	string	Der Bezeichner des Speicherorts.
Kunden-ID	booking.customer_id	string	Die ID dieses Objekts, das den Kunden darstellt.
Kundennotiz	booking.customer_note	string	Das Freitextfeld für den Kunden, um Hinweise zur Buchung zu liefern.
Verkäuferhinweis	booking.seller_note	string	Das Freitextfeld für den Verkäufer, um Hinweise zur Buchung zu liefern.
Beginnen Bei	booking.start_at	string	Der Zeitstempel, der die Startzeit dieses Objekts im RFC 3339-Format angibt.
Terminsegment	booking.appointment_segments	array of object
Dauer Minuten	booking.appointment_segments.duration_minutes	integer	Die Zeitspanne in Minuten eines Terminsegments.
Dienstvariations-ID	booking.appointment_segments.service_variation_id	string	Die ID des CatalogItemVariation-Objekts, das den in diesem Segment gebuchten Dienst darstellt.
Teammitglieds-ID	booking.appointment_segments.team_member_id	string	Die ID des TeamMember-Objekts, das das in diesem Segment gebuchte Teammitglied darstellt.
Dienstvariationsversion	booking.appointment_segments.service_variation_version	integer	Die aktuelle Version der Elementvariation, die den in diesem Segment gebuchten Dienst darstellt.
Errors	errors	array of

Codeausschnitt abrufen

Vorgangs-ID:: SnippetRetrieve

Ruft Ihren Codeausschnitt von einer Square Online-Website ab. Eine Website kann Codeausschnitte aus mehreren Codeausschnittanwendungen enthalten, Sie können jedoch nur den Codeausschnitt abrufen, der von Ihrer Anwendung hinzugefügt wurde.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID der Website	site_id	True	string	Der Bezeichner der Website.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	snippet.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
ID der Website	snippet.site_id	string	Die ID der Website, die den Codeausschnitt enthält.
Content	snippet.content	string	Der Codeausschnitt, der gültige HTML, JavaScript oder beides enthalten kann.
Erstellt unter	snippet.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	snippet.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Durchsuchen von Treuekonten

Vorgangs-ID:: LoyaltySearchAccounts

Sucht nach Treuekonten in einem Treueprogramm.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Limit	limit		integer	Ein Grenzwert für die Anzahl der Ergebnisse, die auf einer einzelnen Seite zurückgegeben werden sollen. Der Grenzwert ist eine Empfehlung – die Implementierung kann mehr oder weniger Ergebnisse zurückgeben. Wenn der angegebene Grenzwert negativ, null oder höher als der maximal zulässige Grenzwert von 1.000 ist, wird er ignoriert.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Treuekonten	loyalty_accounts	array of object
ID	loyalty_accounts.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
ID	loyalty_accounts.mapping.id	string	Der Bezeichner des Objekts
Rufnummer	loyalty_accounts.mapping.phone_number	string	Die Telefonnummer des Empfängers.
Erstellt unter	loyalty_accounts.mapping.created_at	string	Der Zeitstempel, wenn er erstellt wurde, im RFC 3339-Format.
Programm-ID	loyalty_accounts.program_id	string	Die square-assigned ID des Treueprogramms, zu dem das Konto gehört.
Gesamtbetrag	loyalty_accounts.balance	integer	Der verfügbare Punktesaldo im Treuekonto.
Lebensdauerpunkte	loyalty_accounts.lifetime_points	integer	Die Gesamtpunkte, die während der Lebensdauer des Kontos anfallen.
Kunden-ID	loyalty_accounts.customer_id	string	Die quadratische ID des Kunden, der dem Konto zugeordnet ist.
Erstellt unter	loyalty_accounts.created_at	string	Die Ereigniszeit im ISO 8601-Format.
Aktualisiert unter	loyalty_accounts.updated_at	string	Zeitstempel der letzten Änderung im RFC 3339-Format
Mauszeiger	cursor	string	Fügen Sie den Paginierungscursor in nachfolgende Aufrufe dieses Endpunkts ein, um die nächste Gruppe von Ergebnissen abzurufen, die der ursprünglichen Abfrage zugeordnet sind.

Erstellen einer Geschenkgutscheinaktivität (Beta)

Vorgangs-ID:: GiftCardCreate

Erstellt eine Geschenkgutscheinaktivität.

Parameter

Name	Schlüssel	Typ	Beschreibung
Idempotency-Taste	idempotency_key	string	Ein Wert, den Sie angeben, die diese Anforderung eindeutig unter allen Ihren Anforderungen identifiziert. Eine gängige Methode zum Erstellen eines gültigen idempotency-Schlüssels besteht darin, einen universally unique identifier (UUID) zu verwenden.
Geschenkgutschein-ID	gift_card_id	string	Die Geschenkgutschein-ID. Die ID ist nicht erforderlich, wenn ein GAN vorhanden ist.
Typ	type	string	Der Typ dieses Objekts.
Speicherort-ID	location_id	string	Der Bezeichner des Speicherorts.
Auftrags-ID	order_id	string	Die ID der Bestellung, die der Aktivität zugeordnet ist.
Zeilenelement-UID	line_item_uid	string	Die line_item_uid des Artikelartikels der Geschenkkarte in einer Bestellung.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	gift_card_activity.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Geschenkgutschein-ID	gift_card_activity.gift_card_id	string	Die Geschenkgutschein-ID. Die ID ist nicht erforderlich, wenn ein GAN vorhanden ist.
Geschenkgutschein GAN	gift_card_activity.gift_card_gan	string	Die Geschenkkarte GAN. Das GAN ist nicht erforderlich, wenn gift_card_id vorhanden ist.
Typ	gift_card_activity.type	string	Der Typ dieses Objekts.
Betrag	gift_card_activity.gift_card_balance_money.amount	integer	Der Betrag.
Währung	gift_card_activity.gift_card_balance_money.currency	string	Die Währung.
Speicherort-ID	gift_card_activity.location_id	string	Der Bezeichner des Speicherorts.
Erstellt unter	gift_card_activity.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Betrag	gift_card_activity.activate_activity_details.amount_money.amount	integer	Der Betrag.
Währung	gift_card_activity.activate_activity_details.amount_money.currency	string	Die Währung.
Auftrags-ID	gift_card_activity.activate_activity_details.order_id	string	Die ID der Bestellung, die der Aktivität zugeordnet ist.
Zeilenelement-UID	gift_card_activity.activate_activity_details.line_item_uid	string	Die line_item_uid des Artikelartikels der Geschenkkarte in einer Bestellung.

Erstellen eines Treuekontos

Vorgangs-ID:: LoyaltyCreateAccount

Erstellt ein Treuekonto.

Parameter

Name	Schlüssel	Typ	Beschreibung
Rufnummer	phone_number	string	Die Telefonnummer des Empfängers.
Programm-ID	program_id	string	Die quadratische ID des Programms.
Idempotency-Taste	idempotency_key	string	Ein Wert, den Sie angeben, die diese Anforderung eindeutig unter allen Ihren Anforderungen identifiziert. Eine gängige Methode zum Erstellen eines gültigen idempotency-Schlüssels besteht darin, einen universally unique identifier (UUID) zu verwenden.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	loyalty_account.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
ID	loyalty_account.mapping.id	string	Die quadratische ID.
Rufnummer	loyalty_account.mapping.phone_number	string	Die Telefonnummer des Empfängers.
Erstellt unter	loyalty_account.mapping.created_at	string	Der Zeitstempel, wenn er erstellt wurde, im RFC 3339-Format.
Programm-ID	loyalty_account.program_id	string	Die quadratische ID des Programms.
Gesamtbetrag	loyalty_account.balance	integer	Der verfügbare Saldo.
Lebensdauerpunkte	loyalty_account.lifetime_points	integer	Die Gesamtpunkte, die während der Lebensdauer des Kontos anfallen.
Erstellt unter	loyalty_account.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	loyalty_account.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Erstellen von Gerätecode

Vorgangs-ID:: DeviceCreate

Erstellt einen DeviceCode, der zum Anmelden bei einem Quadrat-Terminalgerät verwendet werden kann, um in den verbundenen Terminalmodus zu gelangen.

Parameter

Name	Schlüssel	Typ	Beschreibung
Idempotency-Taste	idempotency_key	string	Ein Wert, den Sie angeben, die diese Anforderung eindeutig unter allen Ihren Anforderungen identifiziert. Eine gängige Methode zum Erstellen eines gültigen idempotency-Schlüssels besteht darin, einen universally unique identifier (UUID) zu verwenden.
Name	name	string	Der Name des Objekts.
Speicherort-ID	location_id	string	Der Bezeichner des Speicherorts.
Produkttyp	product_type	string	Der Zielprodukttyp des Gerätecodes.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	device_code.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Name	device_code.name	string	Der Name des Objekts.
Code	device_code.code	string	Der eindeutige Code, der zum Anmelden verwendet werden kann.
Produkttyp	device_code.product_type	string	Der Zielprodukttyp des Gerätecodes.
Speicherort-ID	device_code.location_id	string	Der Bezeichner des Speicherorts.
Erstellt unter	device_code.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Paar nach	device_code.pair_by	string	Wenn dieser DeviceCode abläuft und sich nicht mehr anmeldet. Zeitstempel im RFC 3339-Format.
Der Status	device_code.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Status geändert bei	device_code.status_changed_at	string	Wenn der Status dieses DeviceCode zuletzt geändert wurde. Zeitstempel im RFC 3339-Format.

Erstellen von mobilem Autorisierungscode

Vorgangs-ID:: MobileAuthorizationCreate

Generiert Code zum Autorisieren einer mobilen Anwendung zum Herstellen einer Verbindung mit einem Square-Kartenleser. Autorisierungscodes sind einmalverwendlich und laufen 60 Minuten nach der Ausstellung ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Speicherort-ID	location_id		string	Der Speicherortbezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Autorisierungscode	authorization_code	string	Generierter Autorisierungscode, der eine mobile Anwendungsinstanz mit einem Quadrat-Konto verbindet.
Läuft ab	expires_at	string	Der Zeitstempel, wenn authorization_code im RFC 3339-Format abläuft.

Gerätecodes auflisten

Vorgangs-ID:: DeviceList

Listet alle DeviceCodes auf, die dem Händler zugeordnet sind.

Parameter

Name	Schlüssel	Typ	Beschreibung
Mauszeiger	cursor	string	Der Paginierungscursor, der von einem vorherigen Aufruf an diesen Endpunkt zurückgegeben wird.
Speicherort-ID	location_id	string	Sie können diesen optionalen Filter angeben, um nur die Datensätze abzurufen, die zu einem bestimmten Speicherort gehören.
Produkttyp	product_type	string	Wenn angegeben, gibt nur DeviceCodes für den angegebenen Produkttyp zurück. Gibt DeviceCodes aller Produkttypen zurück, wenn sie leer sind.
Der Status	status	string	Wenn angegeben, werden nur Objekte zurückgegeben, die den angegebenen Status entsprechen.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Gerätecodes	device_codes	array of object
ID	device_codes.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Name	device_codes.name	string	Der Name des Objekts.
Code	device_codes.code	string	Der eindeutige Code, der zum Anmelden verwendet werden kann.
Produkttyp	device_codes.product_type	string	Der Zielprodukttyp des Gerätecodes.
Speicherort-ID	device_codes.location_id	string	Der Bezeichner für den Speicherort.
Erstellt unter	device_codes.created_at	string	Die Ereigniszeit im ISO 8601-Format.
Paar nach	device_codes.pair_by	string	Wenn dieser DeviceCode abläuft und sich nicht mehr anmeldet. Zeitstempel im RFC 3339-Format.
Der Status	device_codes.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Geräte-ID	device_codes.device_id	string	Die eindeutige ID des Geräts, das diesen Code verwendet hat. Aufgefüllt, wenn das Gerät gekoppelt ist.
Status geändert bei	device_codes.status_changed_at	string	Wenn der Status dieses DeviceCode zuletzt geändert wurde. Zeitstempel im RFC 3339-Format.

Geschenkgutschein abrufen (Beta)

Vorgangs-ID:: GiftCardRetrieve

Ruft eine Geschenkkarte mithilfe ihrer ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID	id	True	string	Der Bezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	gift_card.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Typ	gift_card.type	string	Der Typ dieses Objekts.
GAN-Quelle	gift_card.gan_source	string	Gibt an, ob die Geschenkkartenkontonummer (GAN) von Square generiert oder aus einem nicht quadratischen System importiert wird.
Staat	gift_card.state	string	Der aktuelle Zustand.
Betrag	gift_card.balance_money.amount	integer	Der Betrag.
Währung	gift_card.balance_money.currency	string	Die Währung.
Gan	gift_card.gan	string	Die Kontonummer des Geschenkgutscheins.
Erstellt unter	gift_card.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.

Händler abrufen

Vorgangs-ID:: MerchantRetrieve

Rufen Sie ein Merchant-Objekt für die angegebene merchant_id ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Händler-ID	merchant_id	True	string	Der Bezeichner des Händlers.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	merchant.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Unternehmensname	merchant.business_name	string	Der Geschäftsname des Standorts Dies ist der Name, der für die Kunden des Standorts sichtbar ist. Dieser Name wird z. B. auf Kundenbestätigungen angezeigt.
Country	merchant.country	string	Der ISO 3166 Alpha-2-Ländercode.
Sprachcode	merchant.language_code	string	Der Sprachcode im BCP 47-Format.
Währung	merchant.currency	string	Der 3-stellige ISO 4217-Währungscode.
Der Status	merchant.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Hauptspeicherort-ID	merchant.main_location_id	string	Die ID des Hauptstandorts für diesen Händler.

Händler auflisten

Vorgangs-ID:: MerchantList

Gibt Händlerinformationen für ein bestimmtes Zugriffstoken zurück.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Mauszeiger	cursor		integer	Der Paginierungscursor, der von einem vorherigen Aufruf an diesen Endpunkt zurückgegeben wird.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Kaufmann	merchant	array of object
ID	merchant.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Unternehmensname	merchant.business_name	string	Der Geschäftsname des Standorts Dies ist der Name, der für die Kunden des Standorts sichtbar ist. Dieser Name wird z. B. auf Kundenbestätigungen angezeigt.
Country	merchant.country	string	Der ISO 3166 Alpha-2-Ländercode.
Sprachcode	merchant.language_code	string	Die dem Speicherort zugeordnete Sprache im BCP 47-Format.
Währung	merchant.currency	string	Der 3-stellige ISO 4217-Währungscode.
Der Status	merchant.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Hauptspeicherort-ID	merchant.main_location_id	string	Die ID des Hauptstandorts für diesen Händler.

Kunden mit Geschenkgutschein verknüpfen (Beta)

Vorgangs-ID:: GiftCardLink

Verknüpft einen Kunden mit einer Geschenkkarte

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Geschenkgutschein-ID	gift_card_id	True	string	Der Bezeichner der Geschenkkarte.
Kunden-ID	customer_id		string	Die ID des Kunden, der verknüpft werden soll.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	gift_card.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Typ	gift_card.type	string	Der Typ dieses Objekts.
GAN-Quelle	gift_card.gan_source	string	Gibt an, ob die Geschenkkartenkontonummer (GAN) von Square generiert oder aus einem nicht quadratischen System importiert wird.
Staat	gift_card.state	string	Der aktuelle Zustand.
Betrag	gift_card.balance_money.amount	integer	Der Betrag.
Währung	gift_card.balance_money.currency	string	Die Währung.
Gan	gift_card.gan	string	Die Kontonummer des Geschenkgutscheins.
Erstellt unter	gift_card.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Kunden-IDs	gift_card.customer_ids	array of string

Kundenverknüpfung von Geschenkgutschein aufheben (Beta)

Vorgangs-ID:: GiftCardUnlink

Hebt die Verknüpfung eines Kunden von einer Geschenkkarte auf.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Geschenkgutschein-ID	gift_card_id	True	string	Der Bezeichner der Geschenkkarte.
Kunden-ID	customer_id		string	Die ID des Kunden, der verknüpft werden soll.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	gift_card.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Typ	gift_card.type	string	Der Typ dieses Objekts.
GAN-Quelle	gift_card.gan_source	string	Gibt an, ob die Geschenkkartenkontonummer (GAN) von Square generiert oder aus einem nicht quadratischen System importiert wird.
Staat	gift_card.state	string	Der aktuelle Zustand.
Betrag	gift_card.balance_money.amount	integer	Der Betrag.
Währung	gift_card.balance_money.currency	string	Die Währung.
Gan	gift_card.gan	string	Die Kontonummer des Geschenkgutscheins.
Erstellt unter	gift_card.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.

Löschen des Umbruchtyps

Vorgangs-ID:: LaborDeleteBreak

Löscht einen vorhandenen BreakType. Ein BreakType kann gelöscht werden, auch wenn von einer Umschalttaste darauf verwiesen wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID	id	True	string	Der Bezeichner.

Gibt zurück

response: object

Massenaktualisierung von Teammitgliedern

Vorgangs-ID:: TeamUpdateBulkMembers

Aktualisiert mehrere TeamMember-Objekte.

Parameter

Name	Schlüssel	Typ	Beschreibung
Referenz-ID	reference_id	string	Eine zweite ID, die verwendet wird, um das Teammitglied einer Entität in einem anderen System zuzuordnen.
Ist Besitzer	is_owner	boolean	Gibt an, ob das Teammitglied der Besitzer des Square-Kontos ist.
Der Status	status	string	Beschreibt den Status des Teammitglieds.
Vorname	given_name	string	Der angegebene Name (d. h. der Vorname), der dem Teammitglied zugeordnet ist.
Familienname	family_name	string	Der Familienname (d. h. der Nachname), der dem Teammitglied zugeordnet ist.
E-Mail-Adresse	email_address	string	Die E-Mail-Adresse, die dem Teammitglied zugeordnet ist.
Rufnummer	phone_number	string	Die Telefonnummer des Teammitglieds im E.164-Format.
Standort-IDs	location_ids	array of string
Zuordnungstyp	assignment_type	string	Der aktuelle Zuordnungstyp des Teammitglieders.
Referenz-ID	reference_id	string	Eine zweite ID, die verwendet wird, um das Teammitglied einer Entität in einem anderen System zuzuordnen.
Ist Besitzer	is_owner	boolean	Gibt an, ob das Teammitglied der Besitzer des Square-Kontos ist.
Der Status	status	string	Beschreibt den Status des Teammitglieds.
Vorname	given_name	string	Der angegebene Name (d. h. der Vorname), der dem Teammitglied zugeordnet ist.
Familienname	family_name	string	Der Familienname (d. h. der Nachname), der dem Teammitglied zugeordnet ist.
E-Mail-Adresse	email_address	string	Die E-Mail-Adresse, die dem Teammitglied zugeordnet ist.
Rufnummer	phone_number	string	Die Telefonnummer des Teammitglieds im E.164-Format.
Zuordnungstyp	assignment_type	string	Der aktuelle Zuordnungstyp des Teammitglieders.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	team_members.team_member_id.team_member.id	string	Ein Bezeichner, der auf dieses Objekt verweist.
Referenz-ID	team_members.team_member_id.team_member.reference_id	string	Eine zweite ID, die verwendet wird, um das Teammitglied einer Entität in einem anderen System zuzuordnen.
Ist Besitzer	team_members.team_member_id.team_member.is_owner	boolean	Gibt an, ob das Teammitglied der Besitzer des Square-Kontos ist.
Der Status	team_members.team_member_id.team_member.status	string	Beschreibt den Status des Teammitglieds.
Vorname	team_members.team_member_id.team_member.given_name	string	Der angegebene Name (d. h. der Vorname), der dem Teammitglied zugeordnet ist.
Familienname	team_members.team_member_id.team_member.family_name	string	Der Familienname (d. h. der Nachname), der dem Teammitglied zugeordnet ist.
E-Mail-Adresse	team_members.team_member_id.team_member.email_address	string	Die E-Mail-Adresse, die dem Teammitglied zugeordnet ist.
Rufnummer	team_members.team_member_id.team_member.phone_number	string	Die Telefonnummer des Teammitglieds im E.164-Format.
Erstellt unter	team_members.team_member_id.team_member.created_at	string	Der Zeitstempel im RFC 3339-Format, der beschreibt, wann das Teammitglied erstellt wurde
Zuordnungstyp	team_members.team_member_id.team_member.assigned_locations.assignment_type	string	Der aktuelle Zuordnungstyp des Teammitglieders.
Standort-IDs	team_members.team_member_id.team_member.assigned_locations.location_ids	array of string

Massenerstellung von Teammitgliedern

Vorgangs-ID:: TeamCreateBulkMembers

Erstellt mehrere TeamMember-Objekte.

Parameter

Name	Schlüssel	Typ	Beschreibung
Vorname	given_name	string	Der angegebene Name (d. h. der Vorname), der dem Teammitglied zugeordnet ist.
Familienname	family_name	string	Der Familienname (d. h. der Nachname), der dem Teammitglied zugeordnet ist.
E-Mail-Adresse	email_address	string	Die E-Mail-Adresse, die dem Teammitglied zugeordnet ist.
Referenz-ID	reference_id	string	Eine zweite ID, die verwendet wird, um das Teammitglied einer Entität in einem anderen System zuzuordnen.
Rufnummer	phone_number	string	Die Telefonnummer des Teammitglieds im E.164-Format.
Standort-IDs	location_ids	array of string
Zuordnungstyp	assignment_type	string	Der aktuelle Zuordnungstyp des Teammitglieders.
Vorname	given_name	string	Der angegebene Name (d. h. der Vorname), der dem Teammitglied zugeordnet ist.
Familienname	family_name	string	Der Familienname (d. h. der Nachname), der dem Teammitglied zugeordnet ist.
E-Mail-Adresse	email_address	string	Die E-Mail-Adresse, die dem Teammitglied zugeordnet ist.
Referenz-ID	reference_id	string	Eine zweite ID, die verwendet wird, um das Teammitglied einer Entität in einem anderen System zuzuordnen.
Rufnummer	phone_number	string	Die Telefonnummer des Teammitglieds im E.164-Format.
Zuordnungstyp	assignment_type	string	Der aktuelle Zuordnungstyp des Teammitglieders.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	team_members.idempotency-key-1.team_member.id	string	Ein Bezeichner, der auf dieses Objekt verweist.
Referenz-ID	team_members.idempotency-key-1.team_member.reference_id	string	Eine zweite ID, die verwendet wird, um das Teammitglied einer Entität in einem anderen System zuzuordnen.
Ist Besitzer	team_members.idempotency-key-1.team_member.is_owner	boolean	Gibt an, ob das Teammitglied der Besitzer des Square-Kontos ist.
Der Status	team_members.idempotency-key-1.team_member.status	string	Beschreibt den Status des Teammitglieds.
Vorname	team_members.idempotency-key-1.team_member.given_name	string	Der angegebene Name (d. h. der Vorname), der dem Teammitglied zugeordnet ist.
Familienname	team_members.idempotency-key-1.team_member.family_name	string	Der Familienname (d. h. der Nachname), der dem Teammitglied zugeordnet ist.
E-Mail-Adresse	team_members.idempotency-key-1.team_member.email_address	string	Die E-Mail-Adresse, die dem Teammitglied zugeordnet ist.
Rufnummer	team_members.idempotency-key-1.team_member.phone_number	string	Die Telefonnummer des Teammitglieds im E.164-Format.
Zuordnungstyp	team_members.idempotency-key-1.team_member.assigned_locations.assignment_type	string	Der aktuelle Zuordnungstyp des Teammitglieders.
Standort-IDs	team_members.idempotency-key-1.team_member.assigned_locations.location_ids	array of string
ID	team_members.idempotency-key-2.team_member.id	string	Ein Bezeichner, der auf dieses Objekt verweist.
Referenz-ID	team_members.idempotency-key-2.team_member.reference_id	string	Eine zweite ID, die verwendet wird, um das Teammitglied einer Entität in einem anderen System zuzuordnen.
Ist Besitzer	team_members.idempotency-key-2.team_member.is_owner	boolean	Gibt an, ob das Teammitglied der Besitzer des Square-Kontos ist.
Der Status	team_members.idempotency-key-2.team_member.status	string	Beschreibt den Status des Teammitglieds.
Vorname	team_members.idempotency-key-2.team_member.given_name	string	Der angegebene Name (d. h. der Vorname), der dem Teammitglied zugeordnet ist.
Familienname	team_members.idempotency-key-2.team_member.family_name	string	Der Familienname (d. h. der Nachname), der dem Teammitglied zugeordnet ist.
E-Mail-Adresse	team_members.idempotency-key-2.team_member.email_address	string	Die E-Mail-Adresse, die dem Teammitglied zugeordnet ist.
Rufnummer	team_members.idempotency-key-2.team_member.phone_number	string	Die Telefonnummer des Teammitglieds im E.164-Format.
Zuordnungstyp	team_members.idempotency-key-2.team_member.assigned_locations.assignment_type	string	Der aktuelle Zuordnungstyp des Teammitglieders.

Sammeln von Treuepunkten

Vorgangs-ID:: LoyaltyAccumulatePoints

Fügt Punkte zu einem Treuekonto hinzu.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Konto-ID	account_id	True	string	Der Bezeichner des Kontos.
Auftrags-ID	order_id		string	Die ID der Bestellung.
Speicherort-ID	location_id		string	Der Speicherortbezeichner.
Idempotency-Taste	idempotency_key		string	Ein Wert, den Sie angeben, die diese Anforderung eindeutig unter allen Ihren Anforderungen identifiziert. Eine gängige Methode zum Erstellen eines gültigen idempotency-Schlüssels besteht darin, einen universally unique identifier (UUID) zu verwenden.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	event.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Typ	event.type	string	Der Typ dieses Objekts.
Erstellt unter	event.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Treueprogramm-ID	event.accumulate_points.loyalty_program_id	string	Die ID des Treueprogramms
Punkte	event.accumulate_points.points	integer	Die Anzahl der punkte, die vom Ereignis gesammelt wurden.
Auftrags-ID	event.accumulate_points.order_id	string	Die ID der Bestellung, die der Aktivität zugeordnet ist.
Treuekonto-ID	event.loyalty_account_id	string	Die ID des Treuekontos, in dem das Ereignis aufgetreten ist.
Speicherort-ID	event.location_id	string	Der Bezeichner des Speicherorts.
Quelle	event.source	string	Die Quelle.

Schicht abrufen

Vorgangs-ID:: LaborGetShift

Gibt eine einzelne Umschalttaste zurück, die durch id angegeben wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID	id	True	string	Der Bezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	shift.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Teammitglieds-ID	shift.team_member_id	string	Die ID des Teammitglieds.
Mitarbeiter-ID	shift.employee_id	string	Die quadratisch generierte ID des Mitarbeiters.
Speicherort-ID	shift.location_id	string	Der Bezeichner des Speicherorts.
Timezone	shift.timezone	string	Die Zeitzone, die zum Interpretieren von Kalenderdaten verwendet wird. Wenn eine Rechnung erstellt wird, wird dieses Feld auf die für den Verkäuferstandort angegebene Zeitzone festgelegt. Der Wert kann nicht geändert werden.
Beginnen Bei	shift.start_at	string	Der Zeitstempel, der die Startzeit dieses Objekts im RFC 3339-Format angibt.
End At	shift.end_at	string	RFC 3339; wird in die Zeitzone + Offset verschoben. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
Title	shift.wage.title	string	Der Name des Auftrags, der während dieser Schicht ausgeführt wurde. Quadratische Arbeitsberichterstattungs-UIs können Verschiebungen nach Titel gruppieren.
Betrag	shift.wage.hourly_rate.amount	integer	Der Betrag.
Währung	shift.wage.hourly_rate.currency	string	Die Währung.
Unterbrechungen	shift.breaks	array of object
ID	shift.breaks.id	string	Der Bezeichner des Objekts
Beginnen Bei	shift.breaks.start_at	string	RFC 3339; folgt den gleichen Zeitzoneninformationen wie Umschalt. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
End At	shift.breaks.end_at	string	RFC 3339; folgt den gleichen Zeitzoneninformationen wie Umschalt. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
Umbruchtyp-ID	shift.breaks.break_type_id	string	Der Haltetyp, für den dieser Umbruch vorlagen wurde.
Name	shift.breaks.name	string	Der Name des Elements. Dies ist ein durchsuchbares Attribut für die Verwendung in anwendbaren Abfragefiltern, sein Wert darf nicht leer sein, und die Länge ist von Unicode-Codepunkten.
Erwartete Dauer	shift.breaks.expected_duration	string	Die erwartete Länge des Umbruchs. Format: RFC-3339 P[n]Y[n]M[n]M[n]DT[n]H[n]M[n]S.
Wird bezahlt	shift.breaks.is_paid	boolean	Gibt an, ob diese Unterbrechung zu Entschädigungszwecken auf Zeit zugegangen ist.
Der Status	shift.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Version	shift.version	integer	Die aktuelle Version dieses Objekts.
Erstellt unter	shift.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	shift.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Schicht aktualisieren

Vorgangs-ID:: LaborUpdateShift

Aktualisiert eine vorhandene Schicht.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID	id	True	string	Der Bezeichner.
Teammitglieds-ID	team_member_id		string	Die ID des Teammitglieds.
Speicherort-ID	location_id		string	Der Bezeichner des Speicherorts.
Beginnen Bei	start_at		string	Der Zeitstempel, der die Startzeit dieses Objekts im RFC 3339-Format angibt.
End At	end_at		string	RFC 3339; wird in die Zeitzone + Offset verschoben. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
Title	title		string	Der Name des Auftrags, der während dieser Schicht ausgeführt wurde. Quadratische Arbeitsberichterstattungs-UIs können Verschiebungen nach Titel gruppieren.
Betrag	amount		integer	Der Betrag.
Währung	currency		string	Die Währung.
ID	id		string	Der Bezeichner des Objekts
Beginnen Bei	start_at		string	RFC 3339; folgt den gleichen Zeitzoneninformationen wie Umschalt. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
End At	end_at		string	RFC 3339; folgt den gleichen Zeitzoneninformationen wie Umschalt. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
Umbruchtyp-ID	break_type_id		string	Der Haltetyp, für den dieser Umbruch vorlagen wurde.
Name	name		string	Der Name des Elements. Dies ist ein durchsuchbares Attribut für die Verwendung in anwendbaren Abfragefiltern, sein Wert darf nicht leer sein, und die Länge ist von Unicode-Codepunkten.
Erwartete Dauer	expected_duration		string	Die erwartete Länge des Umbruchs. Format: RFC-3339 P[n]Y[n]M[n]M[n]DT[n]H[n]M[n]S.
Wird bezahlt	is_paid		boolean	Gibt an, ob diese Unterbrechung zu Entschädigungszwecken auf Zeit zugegangen ist.
Version	version		integer	Die aktuelle Version dieses Objekts.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	shift.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Teammitglieds-ID	shift.team_member_id	string	Die ID des Teammitglieds.
Mitarbeiter-ID	shift.employee_id	string	Die quadratisch generierte ID des Mitarbeiters.
Speicherort-ID	shift.location_id	string	Der Bezeichner des Speicherorts.
Timezone	shift.timezone	string	Die Zeitzone, die zum Interpretieren von Kalenderdaten verwendet wird. Wenn eine Rechnung erstellt wird, wird dieses Feld auf die für den Verkäuferstandort angegebene Zeitzone festgelegt. Der Wert kann nicht geändert werden.
Beginnen Bei	shift.start_at	string	Der Zeitstempel, der die Startzeit dieses Objekts im RFC 3339-Format angibt.
End At	shift.end_at	string	RFC 3339; wird in die Zeitzone + Offset verschoben. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
Title	shift.wage.title	string	Der Name des Auftrags, der während dieser Schicht ausgeführt wurde. Quadratische Arbeitsberichterstattungs-UIs können Verschiebungen nach Titel gruppieren.
Betrag	shift.wage.hourly_rate.amount	integer	Der Betrag.
Währung	shift.wage.hourly_rate.currency	string	Die Währung.
Unterbrechungen	shift.breaks	array of object
ID	shift.breaks.id	string	Der Bezeichner des Objekts
Beginnen Bei	shift.breaks.start_at	string	RFC 3339; folgt den gleichen Zeitzoneninformationen wie Umschalt. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
End At	shift.breaks.end_at	string	RFC 3339; folgt den gleichen Zeitzoneninformationen wie Umschalt. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
Umbruchtyp-ID	shift.breaks.break_type_id	string	Der Haltetyp, für den dieser Umbruch vorlagen wurde.
Name	shift.breaks.name	string	Der Name des Elements. Dies ist ein durchsuchbares Attribut für die Verwendung in anwendbaren Abfragefiltern, sein Wert darf nicht leer sein, und die Länge ist von Unicode-Codepunkten.
Erwartete Dauer	shift.breaks.expected_duration	string	Die erwartete Länge des Umbruchs. Format: RFC-3339 P[n]Y[n]M[n]M[n]DT[n]H[n]M[n]S.
Wird bezahlt	shift.breaks.is_paid	boolean	Gibt an, ob diese Unterbrechung zu Entschädigungszwecken auf Zeit zugegangen ist.
Der Status	shift.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Version	shift.version	integer	Die aktuelle Version dieses Objekts.
Erstellt unter	shift.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	shift.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Schicht erstellen

Vorgangs-ID:: LaborCreateShift

Erstellt eine neue Umschalttaste. Eine Schicht stellt einen vollständigen Arbeitstag für einen einzelnen Mitarbeiter dar.

Parameter

Name	Schlüssel	Typ	Beschreibung
Idempotency-Taste	idempotency_key	string	Ein Wert, den Sie angeben, die diese Anforderung eindeutig unter allen Ihren Anforderungen identifiziert. Eine gängige Methode zum Erstellen eines gültigen idempotency-Schlüssels besteht darin, einen universally unique identifier (UUID) zu verwenden.
Teammitglieds-ID	team_member_id	string	Die ID des Teammitglieds.
Speicherort-ID	location_id	string	Der Bezeichner des Speicherorts.
Beginnen Bei	start_at	string	Der Zeitstempel, der die Startzeit dieses Objekts im RFC 3339-Format angibt.
End At	end_at	string	RFC 3339; wird in die Zeitzone + Offset verschoben. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
Title	title	string	Der Name des Auftrags, der während dieser Schicht ausgeführt wurde. Quadratische Arbeitsberichterstattungs-UIs können Verschiebungen nach Titel gruppieren.
Betrag	amount	integer	Der Betrag.
Währung	currency	string	Die Währung.
Beginnen Bei	start_at	string	RFC 3339; folgt den gleichen Zeitzoneninformationen wie Umschalt. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
End At	end_at	string	RFC 3339; folgt den gleichen Zeitzoneninformationen wie Umschalt. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
Umbruchtyp-ID	break_type_id	string	Der Haltetyp, für den dieser Umbruch vorlagen wurde.
Name	name	string	Der Name des Elements. Dies ist ein durchsuchbares Attribut für die Verwendung in anwendbaren Abfragefiltern, sein Wert darf nicht leer sein, und die Länge ist von Unicode-Codepunkten.
Erwartete Dauer	expected_duration	string	Die erwartete Länge des Umbruchs. Format: RFC-3339 P[n]Y[n]M[n]M[n]DT[n]H[n]M[n]S.
Wird bezahlt	is_paid	boolean	Gibt an, ob diese Unterbrechung zu Entschädigungszwecken auf Zeit zugegangen ist.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	shift.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Teammitglieds-ID	shift.team_member_id	string	Die ID des Teammitglieds.
Mitarbeiter-ID	shift.employee_id	string	Die quadratisch generierte ID des Mitarbeiters.
Speicherort-ID	shift.location_id	string	Der Bezeichner des Speicherorts.
Timezone	shift.timezone	string	Die Zeitzone, die zum Interpretieren von Kalenderdaten verwendet wird. Wenn eine Rechnung erstellt wird, wird dieses Feld auf die für den Verkäuferstandort angegebene Zeitzone festgelegt. Der Wert kann nicht geändert werden.
Beginnen Bei	shift.start_at	string	Der Zeitstempel, der die Startzeit dieses Objekts im RFC 3339-Format angibt.
End At	shift.end_at	string	RFC 3339; wird in die Zeitzone + Offset verschoben. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
Title	shift.wage.title	string	Der Name des Auftrags, der während dieser Schicht ausgeführt wurde. Quadratische Arbeitsberichterstattungs-UIs können Verschiebungen nach Titel gruppieren.
Betrag	shift.wage.hourly_rate.amount	integer	Der Betrag.
Währung	shift.wage.hourly_rate.currency	string	Die Währung.
Unterbrechungen	shift.breaks	array of object
ID	shift.breaks.id	string	Der Bezeichner des Objekts
Beginnen Bei	shift.breaks.start_at	string	RFC 3339; folgt den gleichen Zeitzoneninformationen wie Umschalt. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
End At	shift.breaks.end_at	string	RFC 3339; folgt den gleichen Zeitzoneninformationen wie Umschalt. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
Umbruchtyp-ID	shift.breaks.break_type_id	string	Der Haltetyp, für den dieser Umbruch vorlagen wurde.
Name	shift.breaks.name	string	Der Name des Elements. Dies ist ein durchsuchbares Attribut für die Verwendung in anwendbaren Abfragefiltern, sein Wert darf nicht leer sein, und die Länge ist von Unicode-Codepunkten.
Erwartete Dauer	shift.breaks.expected_duration	string	Die erwartete Länge des Umbruchs. Format: RFC-3339 P[n]Y[n]M[n]M[n]DT[n]H[n]M[n]S.
Wird bezahlt	shift.breaks.is_paid	boolean	Gibt an, ob diese Unterbrechung zu Entschädigungszwecken auf Zeit zugegangen ist.
Der Status	shift.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Version	shift.version	integer	Die aktuelle Version dieses Objekts.
Erstellt unter	shift.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	shift.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Schicht löschen

Vorgangs-ID:: LaborDeleteShift

Löscht eine Schicht

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID	id	True	string	Der Bezeichner.

Gibt zurück

response: object

Speicherort abrufen

Vorgangs-ID:: LocationRetrieve

Ruft Details eines Speicherorts ab. Sie können "main" als Standort-ID angeben, um Details des Hauptspeicherorts abzurufen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Speicherort-ID	location_id	True	string	Der Bezeichner des Speicherorts.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	location.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Name	location.name	string	Der Name des Objekts.
Adresszeile 1	location.address.address_line_1	string	Die erste Zeile der Adresse. Felder, die mit address_line beginnen, geben die spezifischesten Details der Adresse an, z. B. Straßennummer, Straßenname und Gebäudename.
Örtlichkeit	location.address.locality	string	Die Stadt oder Die Stadt der Adresse.
VerwaltungsbezirkSebene 1	location.address.administrative_district_level_1	string	Eine zivile Person im Land der Adresse. In den USA ist dies der Staat.
Postleitzahl	location.address.postal_code	string	Die Postleitzahl der Adresse.
Country	location.address.country	string	Das Land der Adresse im ISO 3166-1-Alpha-2-Format.
Timezone	location.timezone	string	Die Zeitzone, die zum Interpretieren von Kalenderdaten verwendet wird. Wenn eine Rechnung erstellt wird, wird dieses Feld auf die für den Verkäuferstandort angegebene Zeitzone festgelegt. Der Wert kann nicht geändert werden.
Fähigkeiten	location.capabilities	array of string
Der Status	location.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Erstellt unter	location.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Händler-ID	location.merchant_id	string	Die ID des Händlers.
Country	location.country	string	Der ISO 3166 Alpha-2-Ländercode.
Sprachcode	location.language_code	string	Der Sprachcode im BCP 47-Format.
Währung	location.currency	string	Der 3-stellige ISO 4217-Währungscode.
Rufnummer	location.phone_number	string	Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist.
Unternehmensname	location.business_name	string	Der Geschäftsname des Standorts Dies ist der Name, der für die Kunden des Standorts sichtbar ist. Dieser Name wird z. B. auf Kundenbestätigungen angezeigt.

Speicherort erstellen (Beta)

Vorgangs-ID:: LocationCreate

Erstellt einen Speicherort.

Parameter

Name	Schlüssel	Typ	Beschreibung
Name	name	string	Der Name des Objekts.
Description	description	string	Die Beschreibung.
Facebook-URL	facebook_url	string	Die Facebook-Profil-URL des Speicherorts. Die URL sollte mit "facebook.com/" beginnen.
Adresszeile 1	address_line_1	string	Die erste Zeile der Adresse. Felder, die mit address_line beginnen, geben die spezifischesten Details der Adresse an, z. B. Straßennummer, Straßenname und Gebäudename.
VerwaltungsbezirkSebene 1	administrative_district_level_1	string	Eine zivile Person im Land der Adresse. In den USA ist dies der Staat.
Örtlichkeit	locality	string	Die Stadt oder Die Stadt der Adresse.
Postleitzahl	postal_code	string	Die Postleitzahl der Adresse.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	location.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Name	location.name	string	Der Name des Objekts.
Adresszeile 1	location.address.address_line_1	string	Die erste Zeile der Adresse. Felder, die mit address_line beginnen, geben die spezifischesten Details der Adresse an, z. B. Straßennummer, Straßenname und Gebäudename.
Örtlichkeit	location.address.locality	string	Die Stadt oder Die Stadt der Adresse.
VerwaltungsbezirkSebene 1	location.address.administrative_district_level_1	string	Eine zivile Person im Land der Adresse. In den USA ist dies der Staat.
Postleitzahl	location.address.postal_code	string	Die Postleitzahl der Adresse.
Fähigkeiten	location.capabilities	array of string
Der Status	location.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Erstellt unter	location.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Händler-ID	location.merchant_id	string	Die ID des Händlers.
Country	location.country	string	Der ISO 3166 Alpha-2-Ländercode.
Sprachcode	location.language_code	string	Der Sprachcode im BCP 47-Format.
Währung	location.currency	string	Der 3-stellige ISO 4217-Währungscode.
Typ	location.type	string	Der Typ dieses Objekts.
Description	location.description	string	Die Beschreibung.
Website-URL	location.website_url	string	Die Website-URL des Speicherorts.
Twitter-Benutzername	location.twitter_username	string	Der Twitter-Benutzername des Speicherorts ohne das Symbol "@".
Instagram-Benutzername	location.instagram_username	string	Der Instagram-Benutzername des Standorts ohne das Symbol "@".
Breitengrad	location.coordinates.latitude	float	Der Breitengrad der Koordinate, ausgedrückt in Grad.
Längengrad	location.coordinates.longitude	float	Der Längengrad der Koordinate, ausgedrückt in Grad.
MCC	location.mcc	string	Der Händlerkategoriecode (MCC) des Standorts, gemäß ISO 18245 standardisiert. Die MCC beschreibt die Art von Waren oder Dienstleistungen, die an dem Standort verkauft werden.

Speicherorte auflisten

Vorgangs-ID:: LocationList

Stellt Informationen zu allen Standorten eines Unternehmens bereit.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Standorte	locations	array of object
ID	locations.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Name	locations.name	string	Der Name des Objekts.
Adresszeile 1	locations.address.address_line_1	string	Die erste Zeile der Adresse.
Örtlichkeit	locations.address.locality	string	Die Stadt oder Die Stadt der Adresse.
VerwaltungsbezirkSebene 1	locations.address.administrative_district_level_1	string	Eine zivile Person im Land der Adresse. In den USA ist dies der Staat.
Postleitzahl	locations.address.postal_code	string	Die Postleitzahl der Adresse.
Country	locations.address.country	string	Das Land der Adresse im ISO 3166-1-Alpha-2-Format.
Timezone	locations.timezone	string	Die Zeitzone, die verwendet wird, um Kalenderdaten auf der Rechnung zu interpretieren, z. B. due_date. Wenn eine Rechnung erstellt wird, wird dieses Feld auf die für den Verkäuferstandort angegebene Zeitzone festgelegt. Der Wert kann nicht geändert werden.
Fähigkeiten	locations.capabilities	array of string
Der Status	locations.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Erstellt unter	locations.created_at	string	Die Ereigniszeit im ISO 8601-Format.
Händler-ID	locations.merchant_id	string	Die ID des Händlers, der den Standort besitzt.
Country	locations.country	string	Der ISO 3166 Alpha-2-Ländercode.
Sprachcode	locations.language_code	string	Die dem Speicherort zugeordnete Sprache im BCP 47-Format.
Währung	locations.currency	string	Der 3-stellige ISO 4217-Währungscode.
Rufnummer	locations.phone_number	string	Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist.
Unternehmensname	locations.business_name	string	Der Geschäftsname des Standorts Dies ist der Name, der für die Kunden des Standorts sichtbar ist. Dieser Name wird z. B. auf Kundenbestätigungen angezeigt.

Suchen von Treueereignissen

Vorgangs-ID:: LoyaltySearchEvents

Sucht nach Treueereignissen. Ein Square-Treueprogramm unterhält ein Hauptbuch von Ereignissen, die während der Lebensdauer eines Treuekontos eines Käufers auftreten. Jede Änderung des Punktesaldos (z. B. Verdiente Punkte, eingelöste Punkte und abgelaufene Punkte) wird im Hauptbuch erfasst. Mithilfe dieses Endpunkts können Sie das Hauptbuch nach Ereignissen durchsuchen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Auftrags-ID	order_id		string	Der Auftragsbezeichner.
Limit	limit		integer	Ein Grenzwert für die Anzahl der Ergebnisse, die auf einer einzelnen Seite zurückgegeben werden sollen. Der Grenzwert ist eine Empfehlung – die Implementierung kann mehr oder weniger Ergebnisse zurückgeben. Wenn der angegebene Grenzwert negativ, null oder höher als der maximal zulässige Grenzwert von 1.000 ist, wird er ignoriert.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Ereignisse	events	array of object
ID	events.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Typ	events.type	string	Der Typ dieses Objekts.
Erstellt unter	events.created_at	string	Die Ereigniszeit im ISO 8601-Format.
Treueprogramm-ID	events.accumulate_points.loyalty_program_id	string	Die ID des Treueprogramms
Punkte	events.accumulate_points.points	integer	Die Anzahl der punkte, die vom Ereignis gesammelt wurden.
Auftrags-ID	events.accumulate_points.order_id	string	Die ID der Bestellung, die der Aktivität zugeordnet ist.
Treuekonto-ID	events.loyalty_account_id	string	Die ID des Treuekontos, in dem das Ereignis aufgetreten ist.
Speicherort-ID	events.location_id	string	Der Bezeichner für den Speicherort.
Quelle	events.source	string	Definiert, ob das Ereignis vom Square Point of Sale generiert wurde.
Treueprogramm-ID	events.redeem_reward.loyalty_program_id	string	Die ID des Treueprogramms
Belohnungs-ID	events.redeem_reward.reward_id	string	Die ID der eingelösten Treueprämie.
Auftrags-ID	events.redeem_reward.order_id	string	Die ID der Bestellung, die der Aktivität zugeordnet ist.
Treueprogramm-ID	events.create_reward.loyalty_program_id	string	Die ID des Treueprogramms
Belohnungs-ID	events.create_reward.reward_id	string	Die ID der eingelösten Treueprämie.
Punkte	events.create_reward.points	integer	Die Anzahl der punkte, die vom Ereignis gesammelt wurden.

Suchverschiebungen

Vorgangs-ID:: LaborSearchShifts

Gibt eine paginierte Liste von Umschaltdatensätzen für ein Unternehmen zurück.

Parameter

Name	Schlüssel	Typ	Beschreibung
Startdatum	start_date	string	Eine Zeichenfolge im Format YYYY-MM-DD, z. B. 2017-10-31, gemäß dem erweiterten ISO 8601-Format für Kalenderdaten. Der Anfang eines Datumsbereichs (einschließlich).
Enddatum	end_date	string	Eine Zeichenfolge im Format YYYY-MM-DD, z. B. 2017-10-31, gemäß dem erweiterten ISO 8601-Format für Kalenderdaten. Das Ende eines Datumsbereichs (einschließlich).
Abgleichen von Schichten nach	match_shifts_by	string	Die Strategie, auf die die Termine angewendet werden.
Standardzeitzone	default_timezone	string	Standortspezifische Zeitzonen konvertieren Arbeitstage in Datums-/Uhrzeitfilter. Jede in der Abfrage enthaltene Position muss eine Zeitzone aufweisen, oder dieses Feld muss als Fallback bereitgestellt werden. Format: Der IANA-Zeitzonen-Datenbankbezeichner für die relevante Zeitzone.
Limit	limit	integer	Ein Grenzwert für die Anzahl der Ergebnisse, die auf einer einzelnen Seite zurückgegeben werden sollen. Der Grenzwert ist eine Empfehlung – die Implementierung kann mehr oder weniger Ergebnisse zurückgeben. Wenn der angegebene Grenzwert negativ, null oder höher als der maximal zulässige Grenzwert von 1.000 ist, wird er ignoriert.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Shifts	shifts	array of object
ID	shifts.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Teammitglieds-ID	shifts.team_member_id	string	Die ID des TeamMember-Objekts für das Dem Objekt zugeordnete Teammitglied.
Speicherort-ID	shifts.location_id	string	Der Bezeichner für den Speicherort.
Timezone	shifts.timezone	string	Die Zeitzone, die verwendet wird, um Kalenderdaten auf der Rechnung zu interpretieren, z. B. due_date. Wenn eine Rechnung erstellt wird, wird dieses Feld auf die für den Verkäuferstandort angegebene Zeitzone festgelegt. Der Wert kann nicht geändert werden.
Beginnen Bei	shifts.start_at	string	Der RFC 3339-Zeitstempel, der die Anfangszeit des verfügbaren Steckplatzes angibt.
End At	shifts.end_at	string	RFC 3339; wird in die Zeitzone + Offset verschoben. Präzision bis zur Minute wird beachtet; Sekunden werden abgeschnitten.
Title	shifts.wage.title	string	Der Name des Auftrags, der während dieser Schicht ausgeführt wurde. Quadratische Arbeitsberichterstattungs-UIs können Verschiebungen nach Titel gruppieren.
Betrag	shifts.wage.hourly_rate.amount	integer	Der Betrag.
Währung	shifts.wage.hourly_rate.currency	string	Die Währung.
Unterbrechungen	shifts.breaks	array of object
ID	shifts.breaks.id	string	Ein Bezeichner, der auf dieses Objekt verweist.
Beginnen Bei	shifts.breaks.start_at	string	Ein Datetime-Wert im RFC 3339-Format, der angibt, wann der Zeitbereich beginnt.
End At	shifts.breaks.end_at	string	Ein Datetime-Wert im RFC 3339-Format, der angibt, wann der Zeitraum endet.
Umbruchtyp-ID	shifts.breaks.break_type_id	string	Der Haltetyp, für den dieser Umbruch vorlagen wurde.
Name	shifts.breaks.name	string	Ein lesbarer Name.
Erwartete Dauer	shifts.breaks.expected_duration	string	Die erwartete Länge des Umbruchs. Format: RFC-3339 P[n]Y[n]M[n]M[n]DT[n]H[n]M[n]S.
Wird bezahlt	shifts.breaks.is_paid	boolean	Gibt an, ob diese Unterbrechung zu Entschädigungszwecken auf Zeit zugegangen ist.
Der Status	shifts.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Version	shifts.version	integer	Die aktuelle Version des Objekts.
Erstellt unter	shifts.created_at	string	Die Ereigniszeit im ISO 8601-Format.
Aktualisiert unter	shifts.updated_at	string	Zeitstempel der letzten Änderung im RFC 3339-Format

Teammitglied abrufen

Vorgangs-ID:: TeamRetrieveMember

Ruft ein TeamMember -Objekt für die angegebene TeamMember-ID ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teammitglieds-ID	team_member_id	True	string	Der Bezeichner des Teammitglieds.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	team_member.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Referenz-ID	team_member.reference_id	string	Eine optionale benutzerdefinierte Referenz-ID.
Ist Besitzer	team_member.is_owner	boolean	Gibt an, ob das Teammitglied der Besitzer des Square-Kontos ist.
Der Status	team_member.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Vorname	team_member.given_name	string	Der angegebene (d. h. Vorname), der dem Kundenprofil zugeordnet ist.
Familienname	team_member.family_name	string	Der Familienname (d. h. Nachname), der dem Kundenprofil zugeordnet ist.
E-Mail-Adresse	team_member.email_address	string	Die E-Mail-Adresse, die dem Kundenprofil zugeordnet ist.
Rufnummer	team_member.phone_number	string	Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist.
Erstellt unter	team_member.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	team_member.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.
Zuordnungstyp	team_member.assigned_locations.assignment_type	string	Der aktuelle Zuordnungstyp des Teammitglieders.
Standort-IDs	team_member.assigned_locations.location_ids	array of string

Teammitglied aktualisieren

Vorgangs-ID:: TeamUpdate

Aktualisiert ein einzelnes TeamMember-Objekt.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Teammitglieds-ID	team_member_id	True	string	Der Bezeichner des Teammitglieds.
Referenz-ID	reference_id		string	Eine optionale benutzerdefinierte Referenz-ID.
Der Status	status		string	Der aktuelle Überprüfungsstatus dieses Objekts.
Vorname	given_name		string	Der angegebene (d. h. Vorname), der dem Kundenprofil zugeordnet ist.
Familienname	family_name		string	Der Familienname (d. h. Nachname), der dem Kundenprofil zugeordnet ist.
E-Mail-Adresse	email_address		string	Die E-Mail-Adresse, die dem Kundenprofil zugeordnet ist.
Rufnummer	phone_number		string	Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist.
Standort-IDs	location_ids		array of string
Zuordnungstyp	assignment_type		string	Der aktuelle Zuordnungstyp des Teammitglieders.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	team_member.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Referenz-ID	team_member.reference_id	string	Eine optionale benutzerdefinierte Referenz-ID.
Ist Besitzer	team_member.is_owner	boolean	Gibt an, ob das Teammitglied der Besitzer des Square-Kontos ist.
Der Status	team_member.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Vorname	team_member.given_name	string	Der angegebene (d. h. Vorname), der dem Kundenprofil zugeordnet ist.
Familienname	team_member.family_name	string	Der Familienname (d. h. Nachname), der dem Kundenprofil zugeordnet ist.
E-Mail-Adresse	team_member.email_address	string	Die E-Mail-Adresse, die dem Kundenprofil zugeordnet ist.
Rufnummer	team_member.phone_number	string	Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist.
Erstellt unter	team_member.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Zuordnungstyp	team_member.assigned_locations.assignment_type	string	Der aktuelle Zuordnungstyp des Teammitglieders.
Standort-IDs	team_member.assigned_locations.location_ids	array of string

Teammitglied erstellen

Vorgangs-ID:: TeamCreateMember

Erstellt ein einzelnes TeamMember -Objekt.

Parameter

Name	Schlüssel	Typ	Beschreibung
Idempotency-Taste	idempotency_key	string	Ein Wert, den Sie angeben, die diese Anforderung eindeutig unter allen Ihren Anforderungen identifiziert. Eine gängige Methode zum Erstellen eines gültigen idempotency-Schlüssels besteht darin, einen universally unique identifier (UUID) zu verwenden.
Referenz-ID	reference_id	string	Eine optionale benutzerdefinierte Referenz-ID.
Der Status	status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Vorname	given_name	string	Der angegebene (d. h. Vorname), der dem Kundenprofil zugeordnet ist.
Familienname	family_name	string	Der Familienname (d. h. Nachname), der dem Kundenprofil zugeordnet ist.
E-Mail-Adresse	email_address	string	Die E-Mail-Adresse, die dem Kundenprofil zugeordnet ist.
Rufnummer	phone_number	string	Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist.
Standort-IDs	location_ids	array of string
Zuordnungstyp	assignment_type	string	Der aktuelle Zuordnungstyp des Teammitglieders.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	team_member.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Referenz-ID	team_member.reference_id	string	Eine optionale benutzerdefinierte Referenz-ID.
Ist Besitzer	team_member.is_owner	boolean	Gibt an, ob das Teammitglied der Besitzer des Square-Kontos ist.
Der Status	team_member.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Vorname	team_member.given_name	string	Der angegebene (d. h. Vorname), der dem Kundenprofil zugeordnet ist.
Familienname	team_member.family_name	string	Der Familienname (d. h. Nachname), der dem Kundenprofil zugeordnet ist.
E-Mail-Adresse	team_member.email_address	string	Die E-Mail-Adresse, die dem Kundenprofil zugeordnet ist.
Rufnummer	team_member.phone_number	string	Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist.
Zuordnungstyp	team_member.assigned_locations.assignment_type	string	Der aktuelle Zuordnungstyp des Teammitglieders.
Standort-IDs	team_member.assigned_locations.location_ids	array of string

Teammitglieder durchsuchen

Vorgangs-ID:: TeamSearch

Gibt eine paginierte Liste von TeamMember-Objekten für ein Unternehmen zurück.

Parameter

Name	Schlüssel	Typ	Beschreibung
Standort-IDs	location_ids	array of string
Der Status	status	string	Der aktuelle Status.
Limit	limit	integer	Ein Grenzwert für die Anzahl der Ergebnisse, die auf einer einzelnen Seite zurückgegeben werden sollen. Der Grenzwert ist eine Empfehlung – die Implementierung kann mehr oder weniger Ergebnisse zurückgeben. Wenn der angegebene Grenzwert negativ, null oder höher als der maximal zulässige Grenzwert von 1.000 ist, wird er ignoriert.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Teammitglieder	team_members	array of object
ID	team_members.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Referenz-ID	team_members.reference_id	string	Eine optionale zweite ID, die verwendet wird, um das Kundenprofil einer Entität in einem anderen System zuzuordnen.
Ist Besitzer	team_members.is_owner	boolean	Gibt an, ob das Teammitglied der Besitzer des Square-Kontos ist.
Der Status	team_members.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Vorname	team_members.given_name	string	Der angegebene (d. h. Vorname), der dem Kundenprofil zugeordnet ist.
Familienname	team_members.family_name	string	Der Familienname (d. h. Nachname), der dem Kundenprofil zugeordnet ist.
E-Mail-Adresse	team_members.email_address	string	Die E-Mail-Adresse, die dem Kundenprofil zugeordnet ist.
Erstellt unter	team_members.created_at	string	Die Ereigniszeit im ISO 8601-Format.
Aktualisiert unter	team_members.updated_at	string	Zeitstempel der letzten Änderung im RFC 3339-Format
Zuordnungstyp	team_members.assigned_locations.assignment_type	string	Der aktuelle Zuordnungstyp des Teammitglieders.
Rufnummer	team_members.phone_number	string	Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist.
Mauszeiger	cursor	string	Fügen Sie den Paginierungscursor in nachfolgende Aufrufe dieses Endpunkts ein, um die nächste Gruppe von Ergebnissen abzurufen, die der ursprünglichen Abfrage zugeordnet sind.

Teammitgliedslohn abrufen

Vorgangs-ID:: LaborGetWage

Gibt einen einzelnen TeamMemberWage zurück, der durch id angegeben wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID	id	True	string	Der Bezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	team_member_wage.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Teammitglieds-ID	team_member_wage.team_member_id	string	Die ID des Teammitglieds.
Title	team_member_wage.title	string	Der Titel.
Betrag	team_member_wage.hourly_rate.amount	integer	Der Betrag.
Währung	team_member_wage.hourly_rate.currency	string	Die Währung.

Teammitgliedslöhne auflisten

Vorgangs-ID:: LaborListWages

Gibt eine paginierte Liste von TeamMemberWage-Instanzen für ein Unternehmen zurück.

Parameter

Name	Schlüssel	Typ	Beschreibung
Teammitglieds-ID	team_member_id	string	Filtern Sie die zurückgegebenen Löhne nur auf diejenigen, die dem angegebenen Teammitglied zugeordnet sind.
Limit	limit	integer	Obergrenze für die Zahl, die in der Antwort zurückgegeben werden soll.
Mauszeiger	cursor	string	Der Paginierungscursor, der von einem vorherigen Aufruf an diesen Endpunkt zurückgegeben wird.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Teammitgliedslöhne	team_member_wages	array of object
ID	team_member_wages.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Teammitglieds-ID	team_member_wages.team_member_id	string	Die ID des TeamMember-Objekts für das Dem Objekt zugeordnete Teammitglied.
Title	team_member_wages.title	string	Der Titel der Rechnung.
Betrag	team_member_wages.hourly_rate.amount	integer	Der Betrag.
Währung	team_member_wages.hourly_rate.currency	string	Die Währung.
Mauszeiger	cursor	string	Fügen Sie den Paginierungscursor in nachfolgende Aufrufe dieses Endpunkts ein, um die nächste Gruppe von Ergebnissen abzurufen, die der ursprünglichen Abfrage zugeordnet sind.

Treueprämie einlösen

Vorgangs-ID:: LoyaltyRedeemReward

Löst eine Treueprämie ein. Nachdem die Belohnung den Terminalzustand erreicht hat, kann sie nicht gelöscht werden. Mit anderen Worten: Punkte, die für die Belohnung verwendet werden, können nicht an das Konto zurückgegeben werden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Belohnungs-ID	reward_id	True	string	Der Bezeichner der Belohnung.
Idempotency-Taste	idempotency_key		string	Ein Wert, den Sie angeben, die diese Anforderung eindeutig unter allen Ihren Anforderungen identifiziert. Eine gängige Methode zum Erstellen eines gültigen idempotency-Schlüssels besteht darin, einen universally unique identifier (UUID) zu verwenden.
Speicherort-ID	location_id		string	Der Speicherortbezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	event.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Typ	event.type	string	Der Typ dieses Objekts.
Erstellt unter	event.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Treueprogramm-ID	event.redeem_reward.loyalty_program_id	string	Die ID des Treueprogramms
Belohnungs-ID	event.redeem_reward.reward_id	string	Die Quadrat-zugewiesene ID der Treueprämie.
Treuekonto-ID	event.loyalty_account_id	string	Die ID des Treuekontos, in dem das Ereignis aufgetreten ist.
Speicherort-ID	event.location_id	string	Der Bezeichner des Speicherorts.
Quelle	event.source	string	Die Quelle.

Treueprämie löschen

Vorgangs-ID:: LoyaltyDeleteReward

Löscht eine Treueprämie. Gibt die Treuepunkte zurück auf das Treuekonto zurück. Sie können keine Belohnung löschen, die den Terminalstatus erreicht hat (EINGELÖSt).

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Belohnungs-ID	reward_id	True	string	Der Bezeichner der Belohnung.

Gibt zurück

response: object

Treueprämie schaffen

Vorgangs-ID:: LoyaltyCreateReward

Schafft eine Treueprämie. Nachdem eine Belohnung erstellt wurde, sind die Punkte gesperrt und für den Käufer nicht verfügbar, um eine andere Belohnung einzulösen.

Parameter

Name	Schlüssel	Typ	Beschreibung
Treuekonto-ID	loyalty_account_id	string	Die ID des Treuekontos, in dem das Ereignis aufgetreten ist.
Belohnungsstufen-ID	reward_tier_id	string	Die quadratische ID der Belohnungsstufe, die zum Erstellen der Belohnung verwendet wird.
Auftrags-ID	order_id	string	Die ID der Bestellung.
Idempotency-Taste	idempotency_key	string	Ein Wert, den Sie angeben, die diese Anforderung eindeutig unter allen Ihren Anforderungen identifiziert. Eine gängige Methode zum Erstellen eines gültigen idempotency-Schlüssels besteht darin, einen universally unique identifier (UUID) zu verwenden.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	reward.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Der Status	reward.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Treuekonto-ID	reward.loyalty_account_id	string	Die ID des Treuekontos, in dem das Ereignis aufgetreten ist.
Belohnungsstufen-ID	reward.reward_tier_id	string	Die quadratische ID der Belohnungsstufe, die zum Erstellen der Belohnung verwendet wird.
Punkte	reward.points	integer	Die Anzahl der hinzugefügten oder entfernten Punkte.
Auftrags-ID	reward.order_id	string	Die ID der Bestellung.
Erstellt unter	reward.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	reward.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Treueprämien suchen

Vorgangs-ID:: LoyaltySearchRewards

Sucht nach Treueprämien in einem Treuekonto.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Treuekonto-ID	loyalty_account_id		string	Die ID des Treuekontos, in dem das Ereignis aufgetreten ist.
Limit	limit		integer	Ein Grenzwert für die Anzahl der Ergebnisse, die auf einer einzelnen Seite zurückgegeben werden sollen. Der Grenzwert ist eine Empfehlung – die Implementierung kann mehr oder weniger Ergebnisse zurückgeben. Wenn der angegebene Grenzwert negativ, null oder höher als der maximal zulässige Grenzwert von 1.000 ist, wird er ignoriert.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Belohnungen	rewards	array of object
ID	rewards.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Der Status	rewards.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Treuekonto-ID	rewards.loyalty_account_id	string	Die ID des Treuekontos, in dem das Ereignis aufgetreten ist.
Belohnungsstufen-ID	rewards.reward_tier_id	string	Die quadratische ID der Belohnungsstufe, die zum Erstellen der Belohnung verwendet wird.
Punkte	rewards.points	integer	Die Anzahl der Treuepunkte, die für die Belohnung verwendet werden.
Auftrags-ID	rewards.order_id	string	Die ID der Bestellung.
Erstellt unter	rewards.created_at	string	Die Ereigniszeit im ISO 8601-Format.
Aktualisiert unter	rewards.updated_at	string	Zeitstempel der letzten Änderung im RFC 3339-Format
Eingelöst bei	rewards.redeemed_at	string	Der Zeitstempel, als die Belohnung eingelöst wurde, im RFC 3339-Format.

Umbruchtyp erstellen

Vorgangs-ID:: LaborCreateBreak

Erstellt einen neuen BreakType. Ein BreakType ist eine Vorlage zum Erstellen von Break-Objekten.

Parameter

Name	Schlüssel	Typ	Beschreibung
Idempotency-Taste	idempotency_key	string	Ein Wert, den Sie angeben, die diese Anforderung eindeutig unter allen Ihren Anforderungen identifiziert. Eine gängige Methode zum Erstellen eines gültigen idempotency-Schlüssels besteht darin, einen universally unique identifier (UUID) zu verwenden.
Speicherort-ID	location_id	string	Der Bezeichner des Speicherorts.
Umbruchname	break_name	string	Ein lesbarer Name für diese Art von Unterbrechung. Der Name wird mitarbeitern in Square-Produkten angezeigt.
Erwartete Dauer	expected_duration	string	Die erwartete Länge dieses Umbruchs. Format: RFC-3339 P[n]Y[n]M[n]M[n]DT[n]H[n]M[n]S. Genauigkeit kleiner als Minuten wird abgeschnitten.
Wird bezahlt	is_paid	boolean	Gibt an, ob diese Unterbrechung zu Entschädigungszwecken auf Zeit zugegangen ist.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	break_type.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Speicherort-ID	break_type.location_id	string	Der Bezeichner des Speicherorts.
Umbruchname	break_type.break_name	string	Ein lesbarer Name für diese Art von Unterbrechung. Der Name wird mitarbeitern in Square-Produkten angezeigt.
Erwartete Dauer	break_type.expected_duration	string	Die erwartete Länge dieses Umbruchs. Format: RFC-3339 P[n]Y[n]M[n]M[n]DT[n]H[n]M[n]S. Genauigkeit kleiner als Minuten wird abgeschnitten.
Wird bezahlt	break_type.is_paid	boolean	Gibt an, ob diese Unterbrechung zu Entschädigungszwecken auf Zeit zugegangen ist.
Version	break_type.version	integer	Die aktuelle Version dieses Objekts.
Erstellt unter	break_type.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	break_type.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Unterbrechungstyp abrufen

Vorgangs-ID:: LaborGetBreak

Gibt einen einzelnen BreakType zurück, der durch id angegeben wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID	id	True	string	Der Bezeichner.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	break_type.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Speicherort-ID	break_type.location_id	string	Der Bezeichner des Speicherorts.
Umbruchname	break_type.break_name	string	Ein lesbarer Name für diese Art von Unterbrechung. Der Name wird mitarbeitern in Square-Produkten angezeigt.
Erwartete Dauer	break_type.expected_duration	string	Die erwartete Länge dieses Umbruchs. Format: RFC-3339 P[n]Y[n]M[n]M[n]DT[n]H[n]M[n]S. Genauigkeit kleiner als Minuten wird abgeschnitten.
Wird bezahlt	break_type.is_paid	boolean	Gibt an, ob diese Unterbrechung zu Entschädigungszwecken auf Zeit zugegangen ist.
Version	break_type.version	integer	Die aktuelle Version dieses Objekts.
Erstellt unter	break_type.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	break_type.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Update-Unterbrechungstyp

Vorgangs-ID:: LaborUpdateBreak

Aktualisiert einen vorhandenen BreakType.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID	id	True	string	Der Bezeichner.
Speicherort-ID	location_id		string	Der Bezeichner des Speicherorts.
Umbruchname	break_name		string	Ein lesbarer Name für diese Art von Unterbrechung. Der Name wird mitarbeitern in Square-Produkten angezeigt.
Erwartete Dauer	expected_duration		string	Die erwartete Länge dieses Umbruchs. Format: RFC-3339 P[n]Y[n]M[n]M[n]DT[n]H[n]M[n]S. Genauigkeit kleiner als Minuten wird abgeschnitten.
Wird bezahlt	is_paid		boolean	Gibt an, ob diese Unterbrechung zu Entschädigungszwecken auf Zeit zugegangen ist.
Version	version		integer	Die aktuelle Version dieses Objekts.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	break_type.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Speicherort-ID	break_type.location_id	string	Der Bezeichner des Speicherorts.
Umbruchname	break_type.break_name	string	Ein lesbarer Name für diese Art von Unterbrechung. Der Name wird mitarbeitern in Square-Produkten angezeigt.
Erwartete Dauer	break_type.expected_duration	string	Die erwartete Länge dieses Umbruchs. Format: RFC-3339 P[n]Y[n]M[n]M[n]DT[n]H[n]M[n]S. Genauigkeit kleiner als Minuten wird abgeschnitten.
Wird bezahlt	break_type.is_paid	boolean	Gibt an, ob diese Unterbrechung zu Entschädigungszwecken auf Zeit zugegangen ist.
Version	break_type.version	integer	Die aktuelle Version dieses Objekts.
Erstellt unter	break_type.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	break_type.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Updatespeicherort (Beta)

Vorgangs-ID:: LocationUpdate

Aktualisiert einen Speicherort.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Speicherort-ID	location_id	True	string	Der Bezeichner des Speicherorts.
Name	name		string	Der Name des Objekts.
Description	description		string	Die Beschreibung.
Facebook-URL	facebook_url		string	Die Facebook-Profil-URL des Speicherorts. Die URL sollte mit "facebook.com/" beginnen.
Twitter-Benutzername	twitter_username		string	Der Twitter-Benutzername des Speicherorts ohne das Symbol "@".
Instagram-Benutzername	instagram_username		string	Der Instagram-Benutzername des Standorts ohne das Symbol "@".
Adresszeile 1	address_line_1		string	Die erste Zeile der Adresse. Felder, die mit address_line beginnen, geben die spezifischesten Details der Adresse an, z. B. Straßennummer, Straßenname und Gebäudename.
VerwaltungsbezirkSebene 1	administrative_district_level_1		string	Eine zivile Person im Land der Adresse. In den USA ist dies der Staat.
Örtlichkeit	locality		string	Die Stadt oder Die Stadt der Adresse.
Postleitzahl	postal_code		string	Die Postleitzahl der Adresse.
Wochentag	day_of_week		string	Der Wochentag für diesen Zeitraum.
Ortszeit starten	start_local_time		string	Die Startzeit eines Geschäftsstundenzeitraums, der in der lokalen Zeit mithilfe des RFC 3339-Formats teilweise angegeben ist.
Ortszeit beenden	end_local_time		string	Die Endzeit eines Geschäftsstundenzeitraums, der in lokaler Zeit mithilfe des RFC 3339-Formats teilweise angegeben ist.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	location.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Name	location.name	string	Der Name des Objekts.
Adresszeile 1	location.address.address_line_1	string	Die erste Zeile der Adresse. Felder, die mit address_line beginnen, geben die spezifischesten Details der Adresse an, z. B. Straßennummer, Straßenname und Gebäudename.
Örtlichkeit	location.address.locality	string	Die Stadt oder Die Stadt der Adresse.
VerwaltungsbezirkSebene 1	location.address.administrative_district_level_1	string	Eine zivile Person im Land der Adresse. In den USA ist dies der Staat.
Postleitzahl	location.address.postal_code	string	Die Postleitzahl der Adresse.
Timezone	location.timezone	string	Die Zeitzone, die zum Interpretieren von Kalenderdaten verwendet wird. Wenn eine Rechnung erstellt wird, wird dieses Feld auf die für den Verkäuferstandort angegebene Zeitzone festgelegt. Der Wert kann nicht geändert werden.
Fähigkeiten	location.capabilities	array of string
Der Status	location.status	string	Der aktuelle Überprüfungsstatus dieses Objekts.
Erstellt unter	location.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Händler-ID	location.merchant_id	string	Die ID des Händlers.
Country	location.country	string	Der ISO 3166 Alpha-2-Ländercode.
Sprachcode	location.language_code	string	Der Sprachcode im BCP 47-Format.
Währung	location.currency	string	Der 3-stellige ISO 4217-Währungscode.
Rufnummer	location.phone_number	string	Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist.
Unternehmensname	location.business_name	string	Der Geschäftsname des Standorts Dies ist der Name, der für die Kunden des Standorts sichtbar ist. Dieser Name wird z. B. auf Kundenbestätigungen angezeigt.
Typ	location.type	string	Der Typ dieses Objekts.
Website-URL	location.website_url	string	Die Website-URL des Speicherorts.
Perioden	location.business_hours.periods	array of object
Wochentag	location.business_hours.periods.day_of_week	string	Der Wochentag für diesen Zeitraum.
Ortszeit starten	location.business_hours.periods.start_local_time	string	Die Startzeit eines Geschäftsstundenzeitraums, der in der lokalen Zeit mithilfe des RFC 3339-Formats teilweise angegeben ist.
Ortszeit beenden	location.business_hours.periods.end_local_time	string	Die Endzeit eines Geschäftsstundenzeitraums, der in lokaler Zeit mithilfe des RFC 3339-Formats teilweise angegeben ist.
Geschäftliche E-Mail	location.business_email	string	Die E-Mail des Speicherorts. Diese E-Mail ist für die Kunden des Standorts sichtbar. Beispielsweise wird die E-Mail auf Kundenbestätigungen angezeigt.
Description	location.description	string	Die Beschreibung.
Twitter-Benutzername	location.twitter_username	string	Der Twitter-Benutzername des Speicherorts ohne das Symbol "@".
Instagram-Benutzername	location.instagram_username	string	Der Instagram-Benutzername des Standorts ohne das Symbol "@".
Breitengrad	location.coordinates.latitude	float	Der Breitengrad der Koordinate, ausgedrückt in Grad.
Längengrad	location.coordinates.longitude	float	Der Längengrad der Koordinate, ausgedrückt in Grad.
MCC	location.mcc	string	Der Händlerkategoriecode (MCC) des Standorts, gemäß ISO 18245 standardisiert. Die MCC beschreibt die Art von Waren oder Dienstleistungen, die an dem Standort verkauft werden.

Upsert-Codeausschnitt

Vorgangs-ID:: SnippetUpsert

Fügt einer Square Online-Website einen Codeausschnitt hinzu oder aktualisiert den vorhandenen Codeausschnitt auf der Website. Der Codeausschnitt wird am Ende des Kopfelements auf jeder Seite der Website angefügt, mit Ausnahme der Auscheckseiten. Eine Codeausschnittanwendung kann einer bestimmten Website einen Codeausschnitt hinzufügen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
ID der Website	site_id	True	string	Der Bezeichner der Website.
Content	content		string	Der Codeausschnitt, der gültige HTML, JavaScript oder beides enthalten kann.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	snippet.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
ID der Website	snippet.site_id	string	Die ID der Website, die den Codeausschnitt enthält.
Content	snippet.content	string	Der Codeausschnitt, der gültige HTML, JavaScript oder beides enthalten kann.
Erstellt unter	snippet.created_at	string	Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt.
Aktualisiert unter	snippet.updated_at	string	Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt.

Verfügbarkeit der Suche (Beta)

Vorgangs-ID:: BookingAvailability

Sucht nach Verfügbarkeiten für die Buchung.

Parameter

Name	Schlüssel	Typ	Beschreibung
Beginnen Bei	start_at	string	Ein Datetime-Wert im RFC 3339-Format, der angibt, wann der Zeitbereich beginnt.
End At	end_at	string	Ein Datetime-Wert im RFC 3339-Format, der angibt, wann der Zeitraum endet.
Speicherort-ID	location_id	string	Der Abfrageausdruck, der nach Verfügbarkeiten sucht, die den angegebenen Verkäuferspeicherort-IDs entsprechen.
Dienstvariations-ID	service_variation_id	string	Die ID der CatalogItemVariation, die den in diesem Segment gebuchten Dienst darstellt.
Beliebig	any	array of string

Gibt zurück

Name	Pfad	Typ	Beschreibung
Vorräte	availabilities	array of object
Beginnen Bei	availabilities.start_at	string	Der RFC 3339-Zeitstempel, der die Anfangszeit des verfügbaren Steckplatzes angibt.
Speicherort-ID	availabilities.location_id	string	Der Bezeichner für den Speicherort.
Terminsegmente	availabilities.appointment_segments	array of object
Dauer Minuten	availabilities.appointment_segments.duration_minutes	integer	Die Zeitspanne in Minuten eines Terminsegments.
Teammitglieds-ID	availabilities.appointment_segments.team_member_id	string	Die ID des TeamMember-Objekts, das das in diesem Segment gebuchte Teammitglied darstellt.
Dienstvariations-ID	availabilities.appointment_segments.service_variation_id	string	Die ID des CatalogItemVariation-Objekts, das den in diesem Segment gebuchten Dienst darstellt.
Dienstvariationsversion	availabilities.appointment_segments.service_variation_version	integer	Die aktuelle Version der Elementvariation, die den in diesem Segment gebuchten Dienst darstellt.
Errors	errors	array of

Websites auflisten

Vorgangs-ID:: SiteList

Listet die Square Online-Websites auf, die zu einem Verkäufer gehören.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Sites	sites	array of object
ID	sites.id	string	Der eindeutige, quadratisch ausgestellte Bezeichner.
Websitetitel	sites.site_title	string	Der Titel der Website.
Domäne	sites.domain	string	Die Domäne der Website (ohne Protokoll).
Wird veröffentlicht	sites.is_published	boolean	Gibt an, ob die Website veröffentlicht wird.
Erstellt unter	sites.created_at	string	Die Ereigniszeit im ISO 8601-Format.
Aktualisiert unter	sites.updated_at	string	Zeitstempel der letzten Änderung im RFC 3339-Format

Definitionen

Objekt

Dies ist der Typ 'object'.

Freigeben über

Quadratisches Geschäft (unabhängiger Herausgeber) (Vorschau)

Drosselungsgrenzwerte

Aktionen

Abrufen der Bargeldschubladeschicht

Parameter

Gibt zurück

Abrufen der Lohneinstellung

Parameter

Gibt zurück

Abrufen des Geschäftsbuchungsprofils (Beta)

Gibt zurück

Abrufen des Treueprogramms

Parameter

Gibt zurück

Abrufen einer Geschenkkarte aus Nonce (Beta)

Parameter

Gibt zurück

Abrufen einer Geschenkkarte von GAN (Beta)

Parameter

Gibt zurück

Abrufen einer Treueprämie

Parameter

Gibt zurück

Abrufen eines Treuekontos

Parameter

Gibt zurück

Abrufen von Gerätecode

Parameter

Gibt zurück

Aktualisieren der Lohneinstellung

Parameter

Gibt zurück

Anpassen von Treuepunkten

Parameter

Gibt zurück

Arbeitswochenkonfiguration aktualisieren

Parameter

Gibt zurück

Arbeitswochenkonfigurationen auflisten

Parameter

Gibt zurück

Auflisten von Bankkontokonten

Parameter

Gibt zurück

Auflisten von Bargeldschublade-Schichtereignissen

Parameter

Gibt zurück

Auflisten von Buchungsprofilen für Teammitglieder (Beta)

Parameter

Gibt zurück

Auflisten von Geschenkgutscheinaktivitäten (Beta)

Parameter

Gibt zurück

Auflisten von Schubladeverschiebungen

Parameter

Gibt zurück

Auflisten von Umbruchtypen

Parameter

Gibt zurück

Auschecken erstellen

Parameter

Gibt zurück

Ausschnitt löschen

Parameter

Gibt zurück

Bankkonto abrufen

Parameter

Gibt zurück

Bankkonto nach V1-ID abrufen

Parameter

Gibt zurück

Berechnen von Treuepunkten

Parameter

Gibt zurück

Buchung erstellen (Beta)

Parameter

Gibt zurück

Codeausschnitt abrufen

Parameter