Square Payments (Independent Publisher) (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: Zahlungen, Terminal, Bestellungen, Abonnements, Rechnungen, Katalog, Bestand und Kunden.
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 |
| 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
| Abbrechen des Terminal-Auscheckens |
Bricht eine Terminal-Checkout-Anforderung ab, wenn der Status der Anforderung dies zulässt. |
| Abonnement abrufen |
Ruft ein Abonnement ab. |
| Abonnement aktualisieren |
Aktualisiert ein Abonnement. Sie können die Feldwerte des Abonnementfelds festlegen, ändern und löschen. |
| Abonnement erstellen |
Erstellt ein Abonnement für einen Kunden zu einem Abonnementplan. Wenn Sie eine Karte in der Datei in der Anforderung angeben, berechnet Square die Karte für das Abonnement. Andernfalls berechnet Square eine Rechnung an die E-Mail-Adresse des Kunden. Das Abonnement wird sofort gestartet, es sei denn, die Anforderung enthält die optionale start_date. Jedes einzelne Abonnement ist einem bestimmten Standort zugeordnet. |
| Abonnement fortsetzen |
Setzt ein deaktiviertes Abonnement fort. |
| Abrufen der Bestandsanpassung |
Gibt das InventoryAdjustment -Objekt mit der bereitgestellten adjustment_id zurück. |
| Abrufen der Bestandsanzahl |
Ruft die aktuelle berechnete Lageranzahl für ein bestimmtes CatalogObject bei einer bestimmten Gruppe von Standorten ab. |
| Abrufen der Bestandsübertragung (Beta) |
Gibt das InventoryTransfer -Objekt mit der bereitgestellten transfer_id zurück. |
| Abrufen der physischen Bestandsanzahl |
Gibt das InventoryPhysicalCount -Objekt mit der bereitgestellten physical_count_id zurück. |
| Abrufen der Terminalerstattung |
Ruft ein Interac Terminal Refund-Objekt nach ID ab. |
| Abrufen des Katalogobjekts |
Gibt ein einzelnes CatalogItem-Objekt als CatalogObject basierend auf der bereitgestellten ID zurück. Das zurückgegebene Objekt enthält alle relevanten CatalogItem-Informationen, einschließlich: CatalogItemVariation untergeordnete Elemente, Verweise auf seine CatalogModifierList-Objekte und die IDs aller CatalogTax-Objekte, die darauf angewendet werden. |
| Abrufen des Kundensegments |
Ruft ein bestimmtes Kundensegment ab. |
| Abrufen von Beweismitteln für Streitigkeiten |
Gibt die von der Nachweis-ID im Anforderungs-URL-Pfad angegebenen Nachweismetadaten zurück. Sie müssen eine Kopie der hochgeladenen Nachweise beibehalten, wenn Sie später darauf verweisen möchten. Sie können den Nachweis nach dem Hochladen nicht herunterladen. |
| Abrufen von Streitigkeiten |
Gibt Details zu einer bestimmten Streitigkeit zurück. |
| Aktualisieren von Elementmodifiziererlisten |
Aktualisiert die CatalogModifierList -Objekte, die auf das gezielte CatalogItem-Objekt angewendet werden, ohne einen Upsert für das gesamte Element ausführen zu müssen. |
| Aktualisieren von Elementsteuern |
Aktualisiert die CatalogTax-Objekte, die für das gezielte CatalogItem gelten, ohne einen Upsert für das gesamte Element ausführen zu müssen. |
| Annehmen von Streitigkeiten |
Akzeptiert den Verlust eines Streits. Square gibt den umstrittenen Betrag an den Karteninhaber zurück und aktualisiert den Streitstatus auf AKZEPTIERT. Square belastet den umstrittenen Betrag vom Quadratkonto des Verkäufers. Wenn das Square-Konto nicht über ausreichende Mittel verfügt, belastet Square das zugeordnete Bankkonto. |
| Auflisten von Abonnementereignissen |
Listet alle Ereignisse für ein bestimmtes Abonnement auf. |
| Auflisten von Zahlungserstattungen |
Ruft eine Liste der Rückerstattungen für das Konto ab, das die Anforderung stellt. Die Ergebnisse sind letztendlich konsistent, und es kann mehrere Sekunden dauern, bis neue Rückerstattungen oder Änderungen an Rückerstattungen angezeigt werden. |
| Batch abrufen von Bestandsänderungen |
Gibt historische physische Anzahlen und Anpassungen basierend auf den bereitgestellten Filterkriterien zurück. |
| Batch abrufen von Bestellungen |
Ruft eine Reihe von Bestellungen anhand ihrer IDs ab. Wenn keine bestimmte Bestell-ID vorhanden ist, wird die ID ignoriert, anstatt einen Fehler zu generieren. |
| Batch abrufen von Katalogobjekten |
Gibt eine Gruppe von Objekten basierend auf der bereitgestellten ID zurück. Jedes in der Gruppe zurückgegebene CatalogItem enthält alle untergeordneten Informationen, darunter: alle seine CatalogItemVariation-Objekte, Verweise auf seine CatalogModifierList-Objekte und die IDs aller CatalogTax-Objekte, die für sie gelten. |
| Batch-Abrufinventaranzahl |
Gibt aktuelle Anzahlen für die bereitgestellten CatalogObjects an den angeforderten Speicherorten zurück. |
| Batch-Upsert-Katalogobjekte |
Erstellt oder aktualisiert bis zu 10.000 Zielobjekte basierend auf der bereitgestellten Liste der Objekte. Die Zielobjekte werden in Batches gruppiert, und jeder Batch wird ganz oder gar nicht eingefügt/aktualisiert. Wenn ein Objekt in einem Batch in irgendeiner Weise falsch formatiert ist oder eine Datenbankeinschränkung verletzt, wird der gesamte Batch, der dieses Element enthält, ignoriert. Andere Batches in derselben Anforderung können jedoch weiterhin erfolgreich sein. Jeder Batch kann bis zu 1.000 Objekte enthalten, und Batches werden so lange verarbeitet, wie die Gesamtanzahl der Objekte für die Anforderung (Elemente, Variationen, Modifiziererlisten, Rabatte und Steuern) nicht mehr als 10.000 beträgt. |
| Batchlöschkatalogobjekte |
Löscht eine Reihe von CatalogItems basierend auf der bereitgestellten Liste der Ziel-IDs und gibt eine Reihe von erfolgreich gelöschten IDs in der Antwort zurück. |
| Batchänderungsbestand |
Wendet Anpassungen und Zählungen auf die bereitgestellten Artikelmengen an. Bei Erfolg: Gibt die aktuelle berechnete Anzahl aller Objekte zurück, auf die in der Anforderung verwiesen wird. |
| Berechnen der Reihenfolge (Beta) |
Ermöglicht Anwendungen die Vorschau der Bestellpreise, ohne einen Auftrag zu erstellen. |
| Bestellung abrufen |
Ruft eine Bestellung nach ID ab. |
| Bestellung erstellen |
Erstellt eine neue Bestellung, die Informationen zu Produkten zum Kauf und zu den Einstellungen enthalten kann, die für den Kauf gelten sollen. |
| Beweis für Streitigkeiten auflisten |
Gibt eine Liste von Beweismitteln zurück, die einer Streitigkeit zugeordnet sind. |
| Durchsuchen von Terminal-Auscheckvorgängen |
Ruft eine gefilterte Liste der Terminal-Auscheckanforderungen ab, die vom Konto erstellt wurden, das die Anforderung stellt. |
| Erstattungszahlung |
Erstattet eine Zahlung. Sie können den gesamten Zahlungsbetrag oder einen Teil davon zurückerstatten. Sie können diesen Endpunkt verwenden, um eine Kartenzahlung zu erstatten oder eine Rückerstattung eines Bargelds oder einer externen Zahlung aufzuzeichnen. |
| Erstellen der Terminalerstattung |
Erstellt eine Anforderung zur Rückerstattung einer interac-Zahlung, die auf einem Square Terminal abgeschlossen wurde. |
| Erstellen des Terminal-Auscheckens |
Erstellt eine Terminal-Checkout-Anforderung und sendet sie an das angegebene Gerät, um eine Zahlung für den angeforderten Betrag zu übernehmen. |
| Erstellen von Beweistexten für Streitigkeiten |
Lädt Text hoch, der als Beweis für eine Streitbeilegung verwendet werden soll. |
| Gruppe vom Kunden entfernen |
Entfernt eine Gruppenmitgliedschaft von einem Kunden. Der Kunde wird durch den customer_id Wert identifiziert, und die Kundengruppe wird durch den group_id Wert identifiziert. |
| Hinzufügen einer Gruppe zum Kunden |
Fügt einem Kunden eine Gruppenmitgliedschaft hinzu. Der Kunde wird durch den customer_id Wert identifiziert, und die Kundengruppe wird durch den group_id Wert identifiziert. |
| Karte abrufen |
Ruft Details für eine bestimmte Karte ab. |
| Karte deaktivieren |
Deaktiviert die Karte, um weitere Updates oder Gebühren zu verhindern. Das Deaktivieren einer bereits deaktivierten Karte ist zulässig, hat aber keine Auswirkung. |
| Karte erstellen |
Fügt einem vorhandenen Händler eine Karte in der Datei hinzu. |
| Karten auflisten |
Ruft eine Liste der Karten ab, die im Besitz des Kontos sind, das die Anforderung stellt. |
| Kataloginformationen |
Ruft Informationen zur Quadratkatalog-API ab, z. B. Batchgrößenbeschränkungen, die vom BatchUpsertCatalogObjects-Endpunkt verwendet werden können. |
| Katalogobjekt löschen |
Löscht ein einzelnes CatalogObject basierend auf der bereitgestellten ID und gibt den Satz von erfolgreich gelöschten IDs in der Antwort zurück. Das Löschen ist ein kaskadierendes Ereignis, sodass auch alle untergeordneten Elemente des Zielobjekts gelöscht werden. Das Löschen eines CatalogItem-Objekts löscht beispielsweise auch alle untergeordneten Elemente des CatalogItemVariation-Objekts. |
| Klonreihenfolge (Beta) |
Erstellt eine neue Reihenfolge im Entwurfszustand, indem eine vorhandene Reihenfolge dupliziert wird. Die neu erstellte Bestellung enthält nur die Kernfelder (z. B. Positionen, Steuern und Rabatte), die aus der ursprünglichen Bestellung kopiert wurden. |
| Kunde aktualisieren |
Aktualisiert ein Kundenprofil. Um ein Attribut zu ändern, geben Sie den neuen Wert an. Um ein Attribut zu entfernen, geben Sie den Wert als leere Zeichenfolge oder leeres Objekt an. |
| Kunde erstellen |
Erstellt einen neuen Kunden für ein Unternehmen. |
| Kunde löschen |
Löscht ein Kundenprofil aus einem Unternehmen. Dieser Vorgang hebt auch die Verknüpfung aller zugeordneten Karten in der Datei auf. |
| Kunden abrufen |
Gibt Details für einen einzelnen Kunden zurück. |
| Kunden auflisten |
Listet Kundenprofile auf, die einem Quadratkonto zugeordnet sind. Unter normalen Betriebsbedingungen werden neu erstellte oder aktualisierte Kundenprofile für den Eintragsvorgang in gut unter 30 Sekunden verfügbar. Gelegentlich kann die Verteilung der neuen oder aktualisierten Profile näher an eine Minute oder länger dauern, insbesondere bei Netzwerkvorfällen und Ausfällen. |
| Kunden suchen |
Durchsucht die Kundenprofile, die einem Quadrat-Konto zugeordnet sind, mithilfe eines unterstützten Abfragefilters. Das Aufrufen von SearchCustomers ohne expliziten Abfragefilter gibt alle Kundenprofile alphabetisch basierend auf given_name und family_name zurück. |
| Kundengruppe abrufen |
Ruft eine bestimmte Kundengruppe ab. |
| Kundengruppe aktualisieren |
Aktualisiert eine Kundengruppe. |
| Kundengruppe erstellen |
Erstellt eine neue Kundengruppe für ein Unternehmen. |
| Kundengruppe löschen |
Löscht eine Kundengruppe gemäß der Identifizierung durch den wert group_id. |
| Kundengruppen auflisten |
Ruft die Liste der Kundengruppen eines Unternehmens ab. |
| Kundensegmente auflisten |
Ruft die Liste der Kundensegmente eines Unternehmens ab. |
| Kündigen eines Abonnements |
Legt das feld canceled_date auf das Ende des aktiven Abrechnungszeitraums fest. Nach diesem Datum ändert sich der Status von ACTIVE in CANCELED. |
| Listenkatalog |
Gibt eine Liste von CatalogObjects zurück, die alle Objekte einer Gruppe von gewünschten Typen (z. B. alle CatalogItem- und CatalogTax-Objekte) im Katalog enthält. ListCatalog gibt keine gelöschten Katalogelemente zurück. |
| Löschen von Beweismitteln für Streitigkeiten |
Entfernt angegebene Beweise aus einer Streitigkeit. |
| Nachweise einreichen |
Übermittelt Nachweise an die Bank des Karteninhabers. Vor der Einreichung von Beweisen kompiliert Square alle verfügbaren Beweise. Dies umfasst Nachweise, die mithilfe der CreateDisputeEvidenceFile- und CreateDisputeEvidenceText-Endpunkte hochgeladen wurden, und Nachweise, die automatisch von Square bereitgestellt werden, sofern verfügbar. |
| Rechnung abrufen |
Ruft eine Rechnung anhand der Rechnungs-ID ab. |
| Rechnung aktualisieren |
Aktualisiert eine Rechnung durch Ändern von Feldern, Löschen von Feldern oder beides. |
| Rechnung erstellen |
Erstellt einen Rechnungsentwurf für einen Auftrag, der mithilfe der Orders-API erstellt wurde. Ein Rechnungsentwurf verbleibt in Ihrem Konto, und es wird keine Aktion ausgeführt. Sie müssen die Rechnung veröffentlichen, bevor Square sie verarbeiten kann (senden Sie sie an die E-Mail-Adresse des Kunden oder berechnen Sie die Karte des Kunden in der Datei). |
| Rechnung löschen |
Löscht die angegebene Rechnung. Wenn eine Rechnung gelöscht wird, ändert sich der zugeordnete Bestellstatus in CANCELED. Sie können nur einen Rechnungsentwurf löschen (Sie können keine veröffentlichte Rechnung löschen, einschließlich einer, die für die Verarbeitung geplant ist). |
| Rechnung stornieren |
Storniert eine Rechnung. Der Verkäufer kann keine Zahlungen für die stornierte Rechnung erheben. |
| Rechnung veröffentlichen |
Veröffentlicht den angegebenen Rechnungsentwurf. Nach der Veröffentlichung einer Rechnung folgt Square basierend auf der Rechnungskonfiguration. Beispielsweise sendet Square die Rechnung an die E-Mail-Adresse des Kunden, berechnet die Karte des Kunden in der Datei oder führt nichts aus. Square stellt die Rechnung auch auf einer square-gehosteten Rechnungsseite zur Verfügung. |
| Rechnungen auflisten |
Gibt eine Liste der Rechnungen für einen bestimmten Ort zurück. |
| Registrieren der Domäne für Apple Pay |
Aktiviert eine Domäne für die Verwendung mit Apple Pay im Web und Square. Eine Überprüfung wird von Apple auf dieser Domäne durchgeführt, um sicherzustellen, dass sie ordnungsgemäß als apple Pay-aktivierte Domäne eingerichtet ist. |
| Stornieren der Terminalerstattung |
Bricht eine Rückerstattungsanforderung für interac Terminal per Erstattungsanforderungs-ID ab, wenn der Status der Anforderung dies zulässt. |
| Stornieren der Zahlung durch idempotency Key |
Bricht eine Zahlung, die durch den in der Anforderung angegebenen idempotency-Schlüssel identifiziert wird, ab (ungültig). Verwenden Sie diese Methode, wenn der Status einer CreatePayment-Anforderung unbekannt ist (z. B. nachdem Sie eine CreatePayment-Anforderung gesendet haben, tritt ein Netzwerkfehler auf und Sie erhalten keine Antwort). In diesem Fall können Sie square per Direct Square zur Kündigung der Zahlung über diesen Endpunkt leiten. In der Anforderung geben Sie den gleichen idempotency-Schlüssel an, den Sie in Ihrer CreatePayment-Anforderung angegeben haben, die Sie abbrechen möchten. Nachdem Sie die Zahlung storniert haben, können Sie Ihre CreatePayment-Anforderung erneut übermitteln. Beachten Sie, dass, wenn keine Zahlung mit dem angegebenen idempotency-Schlüssel gefunden wird, keine Aktion ausgeführt wird und der Endpunkt erfolgreich zurückgegeben wird. |
| Streitigkeiten auflisten |
Gibt eine Liste von Streitigkeiten zurück, die einem bestimmten Konto zugeordnet sind. |
| Suchaufträge |
Durchsuchen Sie alle Bestellungen nach einem oder mehreren Speicherorten. Bestellungen umfassen alle Verkäufe, Rückgaben und Börsen, unabhängig davon, wie oder wann sie in das Square-Ökosystem eingegeben wurden (z. B. Point of Sale, Rechnungen und Connect-APIs). |
| Suchen von Abonnements |
Sucht nach Abonnements. Die Ergebnisse werden chronologisch nach Erstellungsdatum des Abonnements sortiert. Wenn die Anforderung mehrere Standort-ID angibt, sortiert der Endpunkt das Ergebnis nach Standort-ID und dann nach Erstellungsdatum innerhalb der einzelnen Standorte. Wenn in der Abfrage keine Speicherorte angegeben werden, werden alle Speicherorte durchsucht. |
| Suchen von Rechnungen |
Sucht nach Rechnungen von einem Speicherort, der im Filter angegeben ist. |
| Suchen von Terminalerstattungen |
Ruft eine gefilterte Liste der Von dem Verkäufer erstellten Erstattungsanforderungen von Interac Terminal ab. |
| Suchkatalogobjekte |
Sucht nach CatalogObject eines beliebigen Typs, indem unterstützte Suchattributewerte abgegleicht werden, mit Ausnahme von benutzerdefinierten Attributwerten für Elemente oder Elementvariationen, für einen oder mehrere der angegebenen Abfragefilter. |
| Terminal-Auschecken abrufen |
Ruft eine Terminal-Checkout-Anforderung von checkout_id ab. |
| Updatereihenfolge (Beta) |
Aktualisiert eine offene Reihenfolge, indem Felder hinzugefügt, ersetzt oder gelöscht werden. Bestellungen mit dem Status "ABGESCHLOSSEN" oder "ABGEBROCHEN" können nicht aktualisiert werden. |
| Upsert-Katalogobjekt |
Erstellt oder aktualisiert das Ziel CatalogObject. |
| Zahlung abschließen |
Schließt eine Zahlung ab (erfasst). Zahlungen werden standardmäßig sofort nach der Erstellung abgeschlossen. |
| Zahlung aktualisieren |
Aktualisiert eine Zahlung mit dem STATUS GENEHMIGT. Sie können die amount_money und tip_money mithilfe dieses Endpunkts aktualisieren. |
| Zahlung erhalten |
Ruft Details für eine bestimmte Zahlung ab. |
| Zahlung erstellen |
Erstellt eine Zahlung mithilfe der bereitgestellten Quelle. Sie können diesen Endpunkt verwenden, um eine Karte (Kreditkarte/Debitkarte oder Square-Geschenkkarte) zu belasten oder eine Zahlung aufzuzeichnen, die der Verkäufer außerhalb von Square erhalten hat (Barzahlung von einem Käufer oder einer Zahlung, die eine externe Entität im Namen des Verkäufers verarbeitet hat). |
| Zahlung stornieren |
Bricht eine Zahlung ab (nichtig). Sie können diesen Endpunkt verwenden, um eine Zahlung mit dem STATUS GENEHMIGT abzubrechen. |
| Zahlungen auflisten |
Ruft eine Liste der Zahlungen ab, die vom Konto übernommen wurden, das die Anforderung vornimmt. Die Ergebnisse sind letztendlich konsistent, und es kann mehrere Sekunden dauern, bis neue Zahlungen oder Änderungen an Zahlungen angezeigt werden. |
| Zahlungsauftrag (Beta) |
Zahlen Sie für eine Bestellung mit einer oder mehreren genehmigten Zahlungen oder begleichen Sie eine Bestellung mit insgesamt 0. Die Summe der in der Anforderung aufgeführten payment_ids muss der Bestellsumme entsprechen. Bestellungen mit einem Gesamtbetrag von 0 können als bezahlt gekennzeichnet werden, indem sie ein leeres Array von payment_ids in der Anforderung angeben. |
| Zahlungserstattung erhalten |
Ruft eine bestimmte Rückerstattung mithilfe des refund_id ab. |
Abbrechen des Terminal-Auscheckens
Bricht eine Terminal-Checkout-Anforderung ab, wenn der Status der Anforderung dies zulässt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Auscheck-ID
|
checkout_id | True | string |
Der Bezeichner des Auscheckvorgangs. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
checkout.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Betrag
|
checkout.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
checkout.amount_money.currency | string |
Die Währung. |
|
Referenz-ID
|
checkout.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Geräte-ID
|
checkout.device_options.device_id | string |
Die eindeutige ID des Geräts, das für dieses TerminalCheckout vorgesehen ist. |
|
Tippen zulassen
|
checkout.device_options.tip_settings.allow_tipping | boolean |
Gibt an, ob tipping für dieses Auschecken aktiviert ist. Der Standardwert ist „false“. |
|
Bestätigungsbildschirm überspringen
|
checkout.device_options.skip_receipt_screen | boolean |
Weist das Gerät an, den Belegbildschirm zu überspringen. Der Standardwert ist „false“. |
|
Der Status
|
checkout.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Grund für 'Abbrechen'
|
checkout.cancel_reason | string |
Der Grund für die abgebrochene Transaktion. |
|
Erstellt unter
|
checkout.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
checkout.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
App-ID
|
checkout.app_id | string |
Die ID der Anwendung, die das Auschecken erstellt hat. |
|
Stichtagsdauer
|
checkout.deadline_duration | string |
Eine RFC 3339-Dauer, nach der das Auschecken automatisch abgebrochen wird. Ein TerminalCheckout, das ausstehend ist, wird automatisch ABGEBROCHEN und hat einen Abbruchgrund für TIMED_OUT. Standard: 5 Minuten ab erstellung |
Abonnement abrufen
Ruft ein Abonnement ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Abonnement-ID
|
subscription_id | True | string |
Der Bezeichner des Abonnements. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
subscription.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Speicherort-ID
|
subscription.location_id | string |
Der Bezeichner des Speicherorts. |
|
Plan-ID
|
subscription.plan_id | string |
Die ID des zugehörigen Abonnementplans. |
|
Kunden-ID
|
subscription.customer_id | string |
Die ID dieses Objekts, das den Kunden darstellt. |
|
Startdatum
|
subscription.start_date | string |
Das Startdatum des Abonnements im Format JJJJ-MM-DD. |
|
Berechnet bis Datum
|
subscription.charged_through_date | string |
Das Datum, an dem der Kunde für das Abonnement in Rechnung gestellt wird, im Format JJJJ-MM-DD. |
|
Der Status
|
subscription.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Rechnungs-IDs
|
subscription.invoice_ids | array of string | |
|
Betrag
|
subscription.price_override_money.amount | integer |
Der Betrag. |
|
Währung
|
subscription.price_override_money.currency | string |
Die Währung. |
|
Erstellt unter
|
subscription.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Auszahlung bis Datum
|
subscription.paid_until_date | string |
Das Datum, das bis zu zahlen ist. |
|
Timezone
|
subscription.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. |
|
Name
|
subscription.source.name | string |
Der Name. |
Abonnement aktualisieren
Aktualisiert ein Abonnement. Sie können die Feldwerte des Abonnementfelds festlegen, ändern und löschen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Abonnement-ID
|
subscription_id | True | string |
Der Bezeichner des Abonnements. |
|
Version
|
version | integer |
Die aktuelle Version dieses Objekts. |
|
|
Steuerprozentsatz
|
tax_percentage | string |
Der Steuerbetrag, der bei der Abrechnung des Abonnements angewendet wird. |
|
|
Betrag
|
amount | integer |
Der Betrag. |
|
|
Währung
|
currency | string |
Die Währung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
subscription.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Speicherort-ID
|
subscription.location_id | string |
Der Bezeichner des Speicherorts. |
|
Plan-ID
|
subscription.plan_id | string |
Die ID des zugehörigen Abonnementplans. |
|
Kunden-ID
|
subscription.customer_id | string |
Die ID dieses Objekts, das den Kunden darstellt. |
|
Der Status
|
subscription.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Betrag
|
subscription.price_override_money.amount | integer |
Der Betrag. |
|
Währung
|
subscription.price_override_money.currency | string |
Die Währung. |
|
Version
|
subscription.version | integer |
Die aktuelle Version dieses Objekts. |
|
Erstellt unter
|
subscription.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Timezone
|
subscription.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. |
|
Name
|
subscription.source.name | string |
Der Name. |
Abonnement erstellen
Erstellt ein Abonnement für einen Kunden zu einem Abonnementplan. Wenn Sie eine Karte in der Datei in der Anforderung angeben, berechnet Square die Karte für das Abonnement. Andernfalls berechnet Square eine Rechnung an die E-Mail-Adresse des Kunden. Das Abonnement wird sofort gestartet, es sei denn, die Anforderung enthält die optionale start_date. Jedes einzelne Abonnement ist einem bestimmten Standort zugeordnet.
Parameter
| Name | Schlüssel | Erforderlich | 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 Speicherortbezeichner. |
|
|
Plan-ID
|
plan_id | string |
Die ID des Abonnementplans, der mit der Katalog-API erstellt wurde. |
|
|
Kunden-ID
|
customer_id | string |
Die ID des Kunden, der verknüpft werden soll. |
|
|
Kartenkennung
|
card_id | string |
Die ID der Kundenkarte, die belastet werden soll. |
|
|
Startdatum
|
start_date | string |
Das Startdatum des Abonnements im Format JJJJ-MM-DD. |
|
|
Steuerprozentsatz
|
tax_percentage | string |
Die Beim Abrechnung des Abonnements hinzuzufügende Steuer. |
|
|
Betrag
|
amount | integer |
Der Betrag, der für diese Zahlung akzeptiert werden soll, nicht einschließlich tip_money. |
|
|
Währung
|
currency | string |
Der 3-stellige ISO 4217-Währungscode. |
|
|
Timezone
|
timezone | string |
Die Zeitzone, die in Datumsberechnungen für das Abonnement verwendet wird. |
|
|
Name
|
name | string |
Der Name des Objekts. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
subscription.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Speicherort-ID
|
subscription.location_id | string |
Der Bezeichner des Speicherorts. |
|
Plan-ID
|
subscription.plan_id | string |
Die ID des zugehörigen Abonnementplans. |
|
Kunden-ID
|
subscription.customer_id | string |
Die ID dieses Objekts, das den Kunden darstellt. |
|
Startdatum
|
subscription.start_date | string |
Das Startdatum des Abonnements im Format JJJJ-MM-DD. |
|
Der Status
|
subscription.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Steuerprozentsatz
|
subscription.tax_percentage | string |
Der Steuerbetrag, der bei der Abrechnung des Abonnements angewendet wird. |
|
Betrag
|
subscription.price_override_money.amount | integer |
Der Betrag. |
|
Währung
|
subscription.price_override_money.currency | string |
Die Währung. |
|
Version
|
subscription.version | integer |
Die aktuelle Version dieses Objekts. |
|
Erstellt unter
|
subscription.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Kartenkennung
|
subscription.card_id | string |
Die ID der Kundenkarte, die für das Abonnement belastet wird. |
|
Timezone
|
subscription.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. |
|
Name
|
subscription.source.name | string |
Der Name. |
Abonnement fortsetzen
Setzt ein deaktiviertes Abonnement fort.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Abonnement-ID
|
subscription_id | True | string |
Der Bezeichner des Abonnements. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
subscription.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Speicherort-ID
|
subscription.location_id | string |
Der Bezeichner des Speicherorts. |
|
Plan-ID
|
subscription.plan_id | string |
Die ID des zugehörigen Abonnementplans. |
|
Kunden-ID
|
subscription.customer_id | string |
Die ID dieses Objekts, das den Kunden darstellt. |
|
Der Status
|
subscription.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Betrag
|
subscription.price_override_money.amount | integer |
Der Betrag. |
|
Währung
|
subscription.price_override_money.currency | string |
Die Währung. |
|
Version
|
subscription.version | integer |
Die aktuelle Version dieses Objekts. |
|
Erstellt unter
|
subscription.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Timezone
|
subscription.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. |
|
Name
|
subscription.source.name | string |
Der Name. |
Abrufen der Bestandsanpassung
Gibt das InventoryAdjustment -Objekt mit der bereitgestellten adjustment_id zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anpassungs-ID
|
adjustment_id | True | string |
Der Bezeichner der Anpassung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
adjustment.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Referenz-ID
|
adjustment.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Von Bundesland
|
adjustment.from_state | string |
Der Bestandsstatus der zugehörigen Menge der Artikel vor der Anpassung. |
|
An Bundesland
|
adjustment.to_state | string |
Der Bestandsstatus der zugehörigen Menge der Artikel nach der Anpassung. |
|
Speicherort-ID
|
adjustment.location_id | string |
Der Bezeichner des Speicherorts. |
|
Katalogobjekt-ID
|
adjustment.catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
Catalog-Objekttyp
|
adjustment.catalog_object_type | string |
Der Typ des CatalogObject, das nachverfolgt wird. |
|
Menge
|
adjustment.quantity | string |
Die Anzahl der elemente, die von der Anpassung als Dezimalzeichenfolge betroffen sind. Kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
Betrag
|
adjustment.total_price_money.amount | integer |
Der Betrag. |
|
Währung
|
adjustment.total_price_money.currency | string |
Die Währung. |
|
Aufgetreten bei
|
adjustment.occurred_at | string |
Ein vom Client generierter RFC 3339-formatierter Zeitstempel, der angibt, wann die Bestandsanpassung erfolgte. Bei Aktualisierungen der Bestandsanpassung kann der occurred_at Zeitstempel nicht älter als 24 Stunden oder in Zukunft relativ zum Zeitpunkt der Anforderung sein. |
|
Erstellt unter
|
adjustment.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Produkt
|
adjustment.source.product | string |
Produkttyp für die Anwendung. |
|
Anwendungs-ID
|
adjustment.source.application_id | string |
Read-only Quadrat-ID, die der Anwendung zugewiesen ist. |
|
Name
|
adjustment.source.name | string |
Der Name. |
|
Mitarbeiter-ID
|
adjustment.employee_id | string |
Die quadratisch generierte ID des Mitarbeiters. |
Abrufen der Bestandsanzahl
Ruft die aktuelle berechnete Lageranzahl für ein bestimmtes CatalogObject bei einer bestimmten Gruppe von Standorten ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Katalogobjekt-ID
|
catalog_object_id | True | string |
Der Bezeichner des Katalogobjekts. |
|
Standort-IDs
|
location_ids | string |
Die Speicherort-IDs, die als durch Trennzeichen getrennte Liste nachschlagen sollen. Eine leere Liste fragt alle Speicherorte ab. |
|
|
Mauszeiger
|
cursor | string |
Der Paginierungscursor, der von einem vorherigen Aufruf an diesen Endpunkt zurückgegeben wird. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zählt
|
counts | array of object | |
|
Katalogobjekt-ID
|
counts.catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
Catalog-Objekttyp
|
counts.catalog_object_type | string |
Der Typ des CatalogObject, das nachverfolgt wird. |
|
Staat
|
counts.state | string |
Der aktuelle Zustand. |
|
Speicherort-ID
|
counts.location_id | string |
Der Bezeichner für den Speicherort. |
|
Menge
|
counts.quantity | string |
Die Anzahl der Elemente, die von der geschätzten Anzahl als Dezimalzeichenfolge betroffen sind. Kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
Berechnet bei
|
counts.calculated_at | string |
Ein RFC 3339-formatierter Zeitstempel, der angibt, wann die letzte physische Anzahl oder Anpassung, die die geschätzte Anzahl beeinflusst, empfangen wird. |
Abrufen der Bestandsübertragung (Beta)
Gibt das InventoryTransfer -Objekt mit der bereitgestellten transfer_id zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Übertragungs-ID
|
transfer_id | True | string |
Der Bezeichner der Übertragung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
transfer.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Katalogobjekt-ID
|
transfer.catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
Catalog-Objekttyp
|
transfer.catalog_object_type | string |
Der Typ des CatalogObject, das nachverfolgt wird. |
|
Erstellt unter
|
transfer.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Mitarbeiter-ID
|
transfer.employee_id | string |
Die quadratisch generierte ID des Mitarbeiters. |
|
Von Standort-ID
|
transfer.from_location_id | string |
Die square-generierte ID des Orts, an dem die zugehörige Menge der Elemente vor der Übertragung nachverfolgt wurde. |
|
An Orts-ID
|
transfer.to_location_id | string |
Die square-generierte ID des Orts, an dem die zugehörige Menge der Elemente nach der Übertragung nachverfolgt wurde. |
|
Aufgetreten bei
|
transfer.occurred_at | string |
Ein vom Client generierter RFC 3339-formatierter Zeitstempel, der angibt, wann die Bestandsanpassung erfolgte. Bei Aktualisierungen der Bestandsanpassung kann der occurred_at Zeitstempel nicht älter als 24 Stunden oder in Zukunft relativ zum Zeitpunkt der Anforderung sein. |
|
Menge
|
transfer.quantity | string |
Die Anzahl der elemente, die von der Anpassung als Dezimalzeichenfolge betroffen sind. Kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
Referenz-ID
|
transfer.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Produkt
|
transfer.source.product | string |
Produkttyp für die Anwendung. |
|
Anwendungs-ID
|
transfer.source.application_id | string |
Read-only Quadrat-ID, die der Anwendung zugewiesen ist. |
|
Name
|
transfer.source.name | string |
Der Name. |
|
Staat
|
transfer.state | string |
Der aktuelle Zustand. |
Abrufen der physischen Bestandsanzahl
Gibt das InventoryPhysicalCount -Objekt mit der bereitgestellten physical_count_id zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Physische Anzahl-ID
|
physical_count_id | True | string |
Der Bezeichner der physischen Anzahl. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
count.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Referenz-ID
|
count.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Katalogobjekt-ID
|
count.catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
Catalog-Objekttyp
|
count.catalog_object_type | string |
Der Typ des CatalogObject, das nachverfolgt wird. |
|
Staat
|
count.state | string |
Der aktuelle Zustand. |
|
Speicherort-ID
|
count.location_id | string |
Der Bezeichner des Speicherorts. |
|
Menge
|
count.quantity | string |
Die Anzahl der elemente, die von der Anpassung als Dezimalzeichenfolge betroffen sind. Kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
Produkt
|
count.source.product | string |
Produkttyp für die Anwendung. |
|
Anwendungs-ID
|
count.source.application_id | string |
Read-only Quadrat-ID, die der Anwendung zugewiesen ist. |
|
Name
|
count.source.name | string |
Der Name. |
|
Mitarbeiter-ID
|
count.employee_id | string |
Die quadratisch generierte ID des Mitarbeiters. |
|
Aufgetreten bei
|
count.occurred_at | string |
Ein vom Client generierter RFC 3339-formatierter Zeitstempel, der angibt, wann die Bestandsanpassung erfolgte. Bei Aktualisierungen der Bestandsanpassung kann der occurred_at Zeitstempel nicht älter als 24 Stunden oder in Zukunft relativ zum Zeitpunkt der Anforderung sein. |
|
Erstellt unter
|
count.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
Abrufen der Terminalerstattung
Ruft ein Interac Terminal Refund-Objekt nach ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
TerminalErstattungs-ID
|
terminal_refund_id | True | string |
Der Bezeichner der Terminalerstattung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
refund.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Erstattungs-ID
|
refund.refund_id | string |
Die eindeutige ID für diese Rückerstattung, die von Square generiert wurde. |
|
Zahlungs-ID
|
refund.payment_id | string |
Die eindeutige ID der Zahlung. |
|
Betrag
|
refund.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
refund.amount_money.currency | string |
Die Währung. |
|
Ursache
|
refund.reason | string |
Der Grund für dieses Objekt. |
|
Geräte-ID
|
refund.device_id | string |
Die eindeutige ID des Geräts, das für dieses TerminalRefund vorgesehen ist. |
|
Stichtagsdauer
|
refund.deadline_duration | string |
Eine RFC 3339-Dauer, nach der das Auschecken automatisch abgebrochen wird. Ein TerminalCheckout, das ausstehend ist, wird automatisch ABGEBROCHEN und hat einen Abbruchgrund für TIMED_OUT. Standard: 5 Minuten ab erstellung |
|
Der Status
|
refund.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Erstellt unter
|
refund.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
refund.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
App-ID
|
refund.app_id | string |
Die ID der Anwendung, die das Auschecken erstellt hat. |
|
Kartenmarke
|
refund.card.card_brand | string |
Die Marke der Karte. |
|
last_4
|
refund.card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Ausdrucksmonat
|
refund.card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Exp Year
|
refund.card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Fingerabdruck
|
refund.card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
Kartentyp
|
refund.card.card_type | string |
Der Typ der Karte. |
|
KASTEN
|
refund.card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als Bank Identification Number (BIN) bezeichnet werden. |
|
Auftrags-ID
|
refund.order_id | string |
Die ID der Bestellung. |
|
Speicherort-ID
|
refund.location_id | string |
Der Bezeichner des Speicherorts. |
Abrufen des Katalogobjekts
Gibt ein einzelnes CatalogItem-Objekt als CatalogObject basierend auf der bereitgestellten ID zurück. Das zurückgegebene Objekt enthält alle relevanten CatalogItem-Informationen, einschließlich: CatalogItemVariation untergeordnete Elemente, Verweise auf seine CatalogModifierList-Objekte und die IDs aller CatalogTax-Objekte, die darauf angewendet werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Objekt-ID
|
object_id | True | string |
Der Bezeichner des Objekts. |
|
Verwandte Objekte einschließen
|
include_related_objects | boolean |
Wenn true, enthält die Antwort zusätzliche Objekte, die mit dem angeforderten Objekt zusammenhängen, wie folgt: Wenn das Objektfeld der Antwort ein CatalogItem enthält, werden die zugeordneten CatalogCategory-, CatalogTax-, CatalogImage- und CatalogModifierList-Objekte im feld related_objects der Antwort zurückgegeben. Wenn das Objektfeld der Antwort eine CatalogItemVariation enthält, wird das übergeordnete CatalogItem-Objekt im feld related_objects der Antwort zurückgegeben. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Typ
|
object.type | string |
Der Typ dieses Objekts. |
|
ID
|
object.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Aktualisiert unter
|
object.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Version
|
object.version | integer |
Die aktuelle Version dieses Objekts. |
|
Ist gelöscht
|
object.is_deleted | boolean |
Wenn true, wurde das Objekt aus der Datenbank gelöscht. Muss falsch sein, damit neue Objekte eingefügt werden. Beim Löschen entspricht das Feld updated_at der Löschzeit. |
|
present_at_all_locations
|
object.present_at_all_locations | boolean |
Ist "true", ist dieses Objekt an allen Speicherorten (einschließlich zukünftiger Speicherorte) vorhanden, außer wenn es im Feld absent_at_location_ids angegeben ist. Ist "false" angegeben, ist dieses Objekt an keiner Stelle (einschließlich zukünftiger Speicherorte) vorhanden, es sei denn, es wird im Feld present_at_location_ids angegeben. Wenn nicht angegeben, wird der Standardwert auf "true" festgelegt. |
|
Name
|
object.item_data.name | string |
Der Name. |
|
Description
|
object.item_data.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. |
|
Kategorie-ID
|
object.item_data.category_id | string |
Die ID der Kategorie des Elements, falls vorhanden. |
|
Steueridentifikationsnummern
|
object.item_data.tax_ids | array of string | |
|
Variationen
|
object.item_data.variations | array of object | |
|
Typ
|
object.item_data.variations.type | string |
Der Typ dieses Objekts. |
|
ID
|
object.item_data.variations.id | string |
Ein Bezeichner, der auf dieses Objekt im Katalog verweist. |
|
Aktualisiert unter
|
object.item_data.variations.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format. |
|
Version
|
object.item_data.variations.version | integer |
Die Version des Objekts. Beim Aktualisieren eines Objekts muss die angegebene Version mit der Version in der Datenbank übereinstimmen, andernfalls wird der Schreibvorgang als widersprüchlich abgelehnt. |
|
Ist gelöscht
|
object.item_data.variations.is_deleted | boolean |
Wenn true, wurde das Objekt aus der Datenbank gelöscht. Muss falsch sein, damit neue Objekte eingefügt werden. Beim Löschen entspricht das Feld updated_at der Löschzeit. |
|
An allen Standorten vorhanden
|
object.item_data.variations.present_at_all_locations | boolean |
Ist "true", ist dieses Objekt an allen Speicherorten (einschließlich zukünftiger Speicherorte) vorhanden, außer wenn es im Feld absent_at_location_ids angegeben ist. Ist "false" angegeben, ist dieses Objekt an keiner Stelle (einschließlich zukünftiger Speicherorte) vorhanden, es sei denn, es wird im Feld present_at_location_ids angegeben. Wenn nicht angegeben, wird der Standardwert auf "true" festgelegt. |
|
Artikel-ID
|
object.item_data.variations.item_variation_data.item_id | string |
Die ID des CatalogItem, das dieser Elementvariation zugeordnet ist. |
|
Name
|
object.item_data.variations.item_variation_data.name | string |
Der Name der Elementvariation. Dies ist ein durchsuchbares Attribut für die Verwendung in anwendbaren Abfragefiltern, und die Wertlänge ist von Unicode-Codepunkten. |
|
Ordinal
|
object.item_data.variations.item_variation_data.ordinal | integer |
Die Reihenfolge, in der diese Elementvariation angezeigt werden soll. Dieser Wert ist schreibgeschützt. Bei Schreibvorgängen wird die Ordnungszahl für jede Elementvariation innerhalb eines übergeordneten CatalogItem-Objekts entsprechend der Position der Elementvariationen festgelegt. Bei Lesevorgängen ist der Wert nicht garantiert sequenziell oder eindeutig. |
|
Preisart
|
object.item_data.variations.item_variation_data.pricing_type | string |
Gibt an, ob der Preis der Artikelvariation zum Zeitpunkt des Verkaufs festgelegt oder bestimmt wird. |
|
Betrag
|
object.item_data.variations.item_variation_data.price_money.amount | integer |
Der Betrag. |
|
Währung
|
object.item_data.variations.item_variation_data.price_money.currency | string |
Die Währung. |
Abrufen des Kundensegments
Ruft ein bestimmtes Kundensegment ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Segment-ID
|
segment_id | True | string |
Der Bezeichner des Segments. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
segment.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Name
|
segment.name | string |
Der Name des Objekts. |
|
Erstellt unter
|
segment.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
segment.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
Abrufen von Beweismitteln für Streitigkeiten
Gibt die von der Nachweis-ID im Anforderungs-URL-Pfad angegebenen Nachweismetadaten zurück. Sie müssen eine Kopie der hochgeladenen Nachweise beibehalten, wenn Sie später darauf verweisen möchten. Sie können den Nachweis nach dem Hochladen nicht herunterladen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Streitbeilegungs-ID
|
dispute_id | True | string |
Der Bezeichner des Streits. |
|
Nachweis-ID
|
evidence_id | True | string |
Der Bezeichner des Nachweises. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
evidence.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Streitbeilegungs-ID
|
evidence.dispute_id | string |
Die ID des Streits, dem die Beweismittel zugeordnet sind. |
|
Dateiname
|
evidence.evidence_file.filename | string |
Streitnachweisdateien müssen anwendungs-/pdf-, image/heic-, image/heif-, image/jpeg-, image/png- oder image/tiff-Formate sein. |
|
Dateityp
|
evidence.evidence_file.filetype | string |
Der Dateiname einschließlich der Dateierweiterung. |
|
Nachweistyp
|
evidence.evidence_type | string |
Der Pf-Nachweistyp. |
|
Hochgeladen unter
|
evidence.uploaded_at | string |
Der Zeitpunkt, zu dem die nächste Aktion fällig ist, im RFC 3339-Format. |
Abrufen von Streitigkeiten
Gibt Details zu einer bestimmten Streitigkeit zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Streitbeilegungs-ID
|
dispute_id | True | string |
Der Bezeichner des Streits. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
dispute.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Betrag
|
dispute.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
dispute.amount_money.currency | string |
Die Währung. |
|
Ursache
|
dispute.reason | string |
Der Grund für dieses Objekt. |
|
Staat
|
dispute.state | string |
Der aktuelle Zustand. |
|
Fällig bei
|
dispute.due_at | string |
Der Zeitpunkt, zu dem die nächste Aktion fällig ist, im RFC 3339-Format. |
|
Umstrittene Zahlungen
|
dispute.disputed_payments | array of object | |
|
Zahlungs-ID
|
dispute.disputed_payments.payment_id | string |
Square-generierte eindeutige ID der Zahlung. |
|
Kartenmarke
|
dispute.card_brand | string |
Die Marke der Karte. |
|
Erstellt unter
|
dispute.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
dispute.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Markenstreit-ID
|
dispute.brand_dispute_id | string |
Die ID des Streits im Kartenmarkensystem, generiert von der Kartenmarke. |
Aktualisieren von Elementmodifiziererlisten
Aktualisiert die CatalogModifierList -Objekte, die auf das gezielte CatalogItem-Objekt angewendet werden, ohne einen Upsert für das gesamte Element ausführen zu müssen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Element-IDs
|
item_ids | array of string | ||
|
Modifiziererlisten zum Aktivieren
|
modifier_lists_to_enable | array of string | ||
|
Modifiziererlisten zum Deaktivieren
|
modifier_lists_to_disable | array of string |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Aktualisiert unter
|
updated_at | string |
Der Zeitstempel der Datenbank dieses Updates im RFC 3339-Format. |
Aktualisieren von Elementsteuern
Aktualisiert die CatalogTax-Objekte, die für das gezielte CatalogItem gelten, ohne einen Upsert für das gesamte Element ausführen zu müssen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Element-IDs
|
item_ids | array of string | ||
|
Zu aktivierende Steuern
|
taxes_to_enable | array of string | ||
|
Zu deaktivierende Steuern
|
taxes_to_disable | array of string |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Aktualisiert unter
|
updated_at | string |
Der Zeitstempel der Datenbank dieses Updates im RFC 3339-Format. |
Annehmen von Streitigkeiten
Akzeptiert den Verlust eines Streits. Square gibt den umstrittenen Betrag an den Karteninhaber zurück und aktualisiert den Streitstatus auf AKZEPTIERT. Square belastet den umstrittenen Betrag vom Quadratkonto des Verkäufers. Wenn das Square-Konto nicht über ausreichende Mittel verfügt, belastet Square das zugeordnete Bankkonto.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Streitbeilegungs-ID
|
dispute_id | True | string |
Der Bezeichner des Streits. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
dispute.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Betrag
|
dispute.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
dispute.amount_money.currency | string |
Die Währung. |
|
Ursache
|
dispute.reason | string |
Der Grund für dieses Objekt. |
|
Staat
|
dispute.state | string |
Der aktuelle Zustand. |
|
Fällig bei
|
dispute.due_at | string |
Der Zeitpunkt, zu dem die nächste Aktion fällig ist, im RFC 3339-Format. |
|
Umstrittene Zahlungen
|
dispute.disputed_payments | array of object | |
|
Zahlungs-ID
|
dispute.disputed_payments.payment_id | string |
Square-generierte eindeutige ID der Zahlung. |
|
Kartenmarke
|
dispute.card_brand | string |
Die Marke der Karte. |
|
Erstellt unter
|
dispute.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
dispute.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Markenstreit-ID
|
dispute.brand_dispute_id | string |
Die ID des Streits im Kartenmarkensystem, generiert von der Kartenmarke. |
Auflisten von Abonnementereignissen
Listet alle Ereignisse für ein bestimmtes Abonnement auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Abonnement-ID
|
subscription_id | True | string |
Der Bezeichner des Abonnements. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Abonnementereignisse
|
subscription_events | array of object | |
|
ID
|
subscription_events.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Abonnementereignistyp
|
subscription_events.subscription_event_type | string |
Typ des Abonnementereignisses. |
|
Gültigkeitsdatum
|
subscription_events.effective_date | string |
Das Datum im Format JJJJ-MM-DD, wann das Abonnementereignis wirksam wurde. |
|
Plan-ID
|
subscription_events.plan_id | string |
Die ID des zugehörigen Abonnementplans |
Auflisten von Zahlungserstattungen
Ruft eine Liste der Rückerstattungen für das Konto ab, das die Anforderung stellt. Die Ergebnisse sind letztendlich konsistent, und es kann mehrere Sekunden dauern, bis neue Rückerstattungen oder Änderungen an Rückerstattungen angezeigt werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
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. |
|
|
Sortierreihenfolge
|
sort_order | string |
Sortiert die zurückgegebene Liste nach dem Zeitpunkt der Erstellung der Karte mit der angegebenen Reihenfolge. |
|
|
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. |
|
|
Der Status
|
status | string |
Wenn angegeben, werden nur Objekte zurückgegeben, die den angegebenen Status entsprechen. |
|
|
Quellentyp
|
source_type | string |
Falls angegeben, werden nur Erstattungen mit dem angegebenen Quelltyp zurückgegeben. |
|
|
Limit
|
limit | integer |
Obergrenze für die Zahl, die in der Antwort zurückgegeben werden soll. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zurückzahlungen
|
refunds | array of object | |
|
ID
|
refunds.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Der Status
|
refunds.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Betrag
|
refunds.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
refunds.amount_money.currency | string |
Die Währung. |
|
Zahlungs-ID
|
refunds.payment_id | string |
Die ID der Zahlung. |
|
Auftrags-ID
|
refunds.order_id | string |
Die ID der Bestellung. |
|
Erstellt unter
|
refunds.created_at | string |
Die Ereigniszeit im ISO 8601-Format. |
|
Aktualisiert unter
|
refunds.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Bearbeitungsgebühr
|
refunds.processing_fee | array of object | |
|
Effektiv bei
|
refunds.processing_fee.effective_at | string |
Der Zeitstempel, zu dem die Gebühr wirksam wird, im RFC 3339-Format. |
|
Typ
|
refunds.processing_fee.type | string |
Der Typ dieses Objekts. |
|
Betrag
|
refunds.processing_fee.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
refunds.processing_fee.amount_money.currency | string |
Die Währung. |
|
Speicherort-ID
|
refunds.location_id | string |
Der Bezeichner für den Speicherort. |
|
Ursache
|
refunds.reason | string |
Der Streitgrund, warum der Karteninhaber den Streit mit seiner Bank eingeleitet hat. |
|
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. |
Batch abrufen von Bestandsänderungen
Gibt historische physische Anzahlen und Anpassungen basierend auf den bereitgestellten Filterkriterien zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Catalog-Objekt-IDs
|
catalog_object_ids | array of string | ||
|
Standort-IDs
|
location_ids | array of string | ||
|
Typen
|
types | array of string | ||
|
Zustände
|
states | array of string | ||
|
Aktualisiert nach
|
updated_after | string |
Der Filter, um Ergebnisse mit ihrem calculated_at Wert nach dem angegebenen Zeitpunkt zurückzugeben, wie in einem RFC 3339-Zeitstempel angegeben. |
|
|
Aktualisiert vor
|
updated_before | string |
Der Filter, um Ergebnisse mit ihrem created_at- oder calculated_at Wert genau vor dem angegebenen Zeitpunkt zurückzugeben, wie in einem RFC 3339-Zeitstempel angegeben. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Changes
|
changes | array of object | |
|
Typ
|
changes.type | string |
Der Typ dieses Objekts. |
|
ID
|
changes.physical_count.id | string |
Der Bezeichner des Objekts |
|
Referenz-ID
|
changes.physical_count.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID, die diese Karte einer anderen Entität in einem externen System zuordnet. |
|
Katalogobjekt-ID
|
changes.physical_count.catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
Catalog-Objekttyp
|
changes.physical_count.catalog_object_type | string |
Der Typ des CatalogObject, das nachverfolgt wird. |
|
Staat
|
changes.physical_count.state | string |
Der aktuelle Bestandsstatus für die zugehörige Menge der Artikel. |
|
Speicherort-ID
|
changes.physical_count.location_id | string |
Die Standort-ID für einen Empfänger (außer dem Händler), der einen Teil dieses Angebots erhält. |
|
Menge
|
changes.physical_count.quantity | string |
Die Anzahl der Elemente, die von der physischen Anzahl als Dezimalzeichenfolge betroffen sind. Die Zahl kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
Produkt
|
changes.physical_count.source.product | string |
Produkttyp für die Anwendung. |
|
Anwendungs-ID
|
changes.physical_count.source.application_id | string |
Quadrat-ID, die der Anwendung zugewiesen ist. |
|
Name
|
changes.physical_count.source.name | string |
Der Name des Elements. |
|
Mitarbeiter-ID
|
changes.physical_count.employee_id | string |
Die square-generierte ID des Mitarbeiters, der für die physische Anzahl verantwortlich ist. |
|
Aufgetreten bei
|
changes.physical_count.occurred_at | string |
Ein vom Client generierter RFC 3339-formatierter Zeitstempel, der angibt, wann die physische Anzahl untersucht wurde. Bei Aktualisierungen der physischen Anzahl kann der occurred_at Zeitstempel nicht älter als 24 Stunden oder in Zukunft relativ zum Zeitpunkt der Anforderung sein. |
|
Erstellt unter
|
changes.physical_count.created_at | string |
Ein vom Client generierter RFC 3339-formatierter Zeitstempel, der angibt, wann die physische Anzahl erstellt wurde. |
Batch abrufen von Bestellungen
Ruft eine Reihe von Bestellungen anhand ihrer IDs ab. Wenn keine bestimmte Bestell-ID vorhanden ist, wird die ID ignoriert, anstatt einen Fehler zu generieren.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Speicherort-ID
|
location_id | string |
Der Speicherortbezeichner. |
|
|
Bestell-IDs
|
order_ids | array of string |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Orders
|
orders | array of object | |
|
ID
|
orders.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Speicherort-ID
|
orders.location_id | string |
Der Bezeichner für den Speicherort. |
|
Referenz-ID
|
orders.reference_id | string |
Eine optionale zweite ID, die verwendet wird, um das Kundenprofil einer Entität in einem anderen System zuzuordnen. |
|
Zeilenelemente
|
orders.line_items | array of object | |
|
UID
|
orders.line_items.uid | string |
Die square-generierte ID der Zahlungsanforderung in einer Rechnung. |
|
Name
|
orders.line_items.name | string |
Ein lesbarer Name. |
|
Menge
|
orders.line_items.quantity | string |
Die gekaufte Menge, die als Dezimalzahl formatiert ist. |
|
Betrag
|
orders.line_items.base_price_money.amount | integer |
Der Betrag. |
|
Währung
|
orders.line_items.base_price_money.currency | string |
Die Währung. |
|
Betrag
|
orders.line_items.total_money.amount | integer |
Der Betrag. |
|
Währung
|
orders.line_items.total_money.currency | string |
Die Währung. |
|
Betrag
|
orders.total_money.amount | integer |
Der Betrag. |
|
Währung
|
orders.total_money.currency | string |
Die Währung. |
Batch abrufen von Katalogobjekten
Gibt eine Gruppe von Objekten basierend auf der bereitgestellten ID zurück. Jedes in der Gruppe zurückgegebene CatalogItem enthält alle untergeordneten Informationen, darunter: alle seine CatalogItemVariation-Objekte, Verweise auf seine CatalogModifierList-Objekte und die IDs aller CatalogTax-Objekte, die für sie gelten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Objekt-IDs
|
object_ids | array of string | ||
|
Katalogversion
|
catalog_version | integer |
Die spezifische Version der Katalogobjekte, die in die Antwort eingeschlossen werden sollen. Auf diese Weise können Sie historische Versionen von Objekten abrufen. Der angegebene Versionswert wird mit dem Versionsattribut "CatalogObjects" abgeglichen. |
|
|
Verwandte Objekte einschließen
|
include_related_objects | boolean |
Wenn true, enthält die Antwort zusätzliche Objekte, die mit den angeforderten Objekten zusammenhängen, wie folgt: Wenn das Objektfeld der Antwort ein CatalogItem enthält, werden die zugeordneten CatalogCategory-Objekte, CatalogTax-Objekte, CatalogImage-Objekte und CatalogModifierLists im feld related_objects der Antwort zurückgegeben. Wenn das Objektfeld der Antwort eine CatalogItemVariation enthält, wird das übergeordnete CatalogItem-Objekt im feld related_objects der Antwort zurückgegeben. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Objekte
|
objects | array of object | |
|
Typ
|
objects.type | string |
Der Typ dieses Objekts. |
|
ID
|
objects.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Aktualisiert unter
|
objects.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Version
|
objects.version | integer |
Die aktuelle Version des Objekts. |
|
Ist gelöscht
|
objects.is_deleted | boolean |
Wenn true, wurde das Objekt aus der Datenbank gelöscht. Muss falsch sein, damit neue Objekte eingefügt werden. Beim Löschen entspricht das Feld updated_at der Löschzeit. |
|
An allen Standorten vorhanden
|
objects.present_at_all_locations | boolean |
Ist "true", ist dieses Objekt an allen Speicherorten (einschließlich zukünftiger Speicherorte) vorhanden, außer wenn es im Feld absent_at_location_ids angegeben ist. Ist "false" angegeben, ist dieses Objekt an keiner Stelle (einschließlich zukünftiger Speicherorte) vorhanden, es sei denn, es wird im Feld present_at_location_ids angegeben. Wenn nicht angegeben, wird der Standardwert auf "true" festgelegt. |
|
Name
|
objects.item_data.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. |
|
Description
|
objects.item_data.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. |
|
Kategorie-ID
|
objects.item_data.category_id | string |
Die ID der Kategorie des Elements, falls vorhanden. |
|
Steueridentifikationsnummern
|
objects.item_data.tax_ids | array of string | |
|
Variationen
|
objects.item_data.variations | array of object | |
|
Typ
|
objects.item_data.variations.type | string |
Der Typ dieses Objekts. Jeder Objekttyp hat eigenschaften erwartet, die in einem strukturierten Format innerhalb des entsprechenden Felds *_data unten ausgedrückt werden. |
|
ID
|
objects.item_data.variations.id | string |
Ein Bezeichner, der auf dieses Objekt verweist. |
|
Aktualisiert unter
|
objects.item_data.variations.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Version
|
objects.item_data.variations.version | integer |
Die Version des Objekts. Beim Aktualisieren eines Objekts muss die angegebene Version mit der Version in der Datenbank übereinstimmen, andernfalls wird der Schreibvorgang als widersprüchlich abgelehnt. |
|
Ist gelöscht
|
objects.item_data.variations.is_deleted | boolean |
Wenn true, wurde das Objekt aus der Datenbank gelöscht. Muss falsch sein, damit neue Objekte eingefügt werden. Beim Löschen entspricht das Feld updated_at der Löschzeit. |
|
An allen Standorten präsentieren
|
objects.item_data.variations.present_at_all_locations | boolean |
Eine Liste der Speicherorte, an denen das Objekt vorhanden ist, auch wenn present_at_all_locations falsch ist. Dies kann Speicherorte umfassen, die deaktiviert werden. |
|
Artikel-ID
|
objects.item_data.variations.item_variation_data.item_id | string |
Die ID des Objekts mit dieser Elementvariation. |
|
Name
|
objects.item_data.variations.item_variation_data.name | string |
Der Name dieses Elements. Dies ist ein durchsuchbares Attribut für die Verwendung in anwendbaren Abfragefiltern, und die Wertlänge ist von Unicode-Codepunkten. |
|
Ordinal
|
objects.item_data.variations.item_variation_data.ordinal | integer |
Die Reihenfolge, in der diese Elementvariation angezeigt werden soll. Dieser Wert ist schreibgeschützt. |
|
Preisart
|
objects.item_data.variations.item_variation_data.pricing_type | string |
Gibt an, ob der Preis der Artikelvariation zum Zeitpunkt des Verkaufs festgelegt oder bestimmt wird. |
|
Betrag
|
objects.item_data.variations.item_variation_data.price_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
|
objects.item_data.variations.item_variation_data.price_money.currency | string |
Der Währungstyp im ISO 4217-Format. Der Währungscode für US-Dollar ist beispielsweise USD. |
|
Verwandte Objekte
|
related_objects | array of object | |
|
Typ
|
related_objects.type | string |
Der Typ dieses Objekts. |
|
ID
|
related_objects.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Aktualisiert unter
|
related_objects.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Version
|
related_objects.version | integer |
Die aktuelle Version des Objekts. |
|
Ist gelöscht
|
related_objects.is_deleted | boolean |
Wenn true, wurde das Objekt aus der Datenbank gelöscht. Muss falsch sein, damit neue Objekte eingefügt werden. Beim Löschen entspricht das Feld updated_at der Löschzeit. |
|
An allen Standorten vorhanden
|
related_objects.present_at_all_locations | boolean |
Ist "true", ist dieses Objekt an allen Speicherorten (einschließlich zukünftiger Speicherorte) vorhanden, außer wenn es im Feld absent_at_location_ids angegeben ist. Ist "false" angegeben, ist dieses Objekt an keiner Stelle (einschließlich zukünftiger Speicherorte) vorhanden, es sei denn, es wird im Feld present_at_location_ids angegeben. Wenn nicht angegeben, wird der Standardwert auf "true" festgelegt. |
|
Name
|
related_objects.category_data.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. |
|
Name
|
related_objects.tax_data.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. |
|
Berechnungsphase
|
related_objects.tax_data.calculation_phase | string |
Gibt an, ob die Steuer basierend auf dem Teilergebnis oder der Summe einer Zahlung berechnet wird. |
|
Inklusionstyp
|
related_objects.tax_data.inclusion_type | string |
Ob die Steuer ADDITIVE oder INCLUSIVE ist. |
|
Prozentsatz
|
related_objects.tax_data.percentage | string |
Der Prozentsatz in dezimaler Form, wobei ein "." als Dezimaltrennzeichen und ohne "%" Zeichen verwendet wird. Der Wert 7,5 entspricht 7,5%. |
|
Enabled
|
related_objects.tax_data.enabled | boolean |
Gibt an, ob ein Objekt verwendet werden kann. |
Batch-Abrufinventaranzahl
Gibt aktuelle Anzahlen für die bereitgestellten CatalogObjects an den angeforderten Speicherorten zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Catalog-Objekt-IDs
|
catalog_object_ids | array of string | ||
|
Standort-IDs
|
location_ids | array of string | ||
|
Aktualisiert nach
|
updated_after | string |
Der Filter, um Ergebnisse mit ihrem calculated_at Wert nach dem angegebenen Zeitpunkt zurückzugeben, wie in einem RFC 3339-Zeitstempel angegeben. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zählt
|
counts | array of object | |
|
Katalogobjekt-ID
|
counts.catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
Catalog-Objekttyp
|
counts.catalog_object_type | string |
Der Typ des CatalogObject, das nachverfolgt wird. |
|
Staat
|
counts.state | string |
Der aktuelle Zustand. |
|
Speicherort-ID
|
counts.location_id | string |
Der Bezeichner für den Speicherort. |
|
Menge
|
counts.quantity | string |
Die Anzahl der Elemente, die von der geschätzten Anzahl als Dezimalzeichenfolge betroffen sind. Kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
Berechnet bei
|
counts.calculated_at | string |
Ein RFC 3339-formatierter Zeitstempel, der angibt, wann die letzte physische Anzahl oder Anpassung, die die geschätzte Anzahl beeinflusst, empfangen wird. |
Batch-Upsert-Katalogobjekte
Erstellt oder aktualisiert bis zu 10.000 Zielobjekte basierend auf der bereitgestellten Liste der Objekte. Die Zielobjekte werden in Batches gruppiert, und jeder Batch wird ganz oder gar nicht eingefügt/aktualisiert. Wenn ein Objekt in einem Batch in irgendeiner Weise falsch formatiert ist oder eine Datenbankeinschränkung verletzt, wird der gesamte Batch, der dieses Element enthält, ignoriert. Andere Batches in derselben Anforderung können jedoch weiterhin erfolgreich sein. Jeder Batch kann bis zu 1.000 Objekte enthalten, und Batches werden so lange verarbeitet, wie die Gesamtanzahl der Objekte für die Anforderung (Elemente, Variationen, Modifiziererlisten, Rabatte und Steuern) nicht mehr als 10.000 beträgt.
Parameter
| Name | Schlüssel | Erforderlich | 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. |
|
|
Typ
|
type | string |
Der Typ dieses Objekts. |
|
|
ID
|
id | string |
Ein Bezeichner, der auf dieses Objekt verweist. |
|
|
An allen Standorten vorhanden
|
present_at_all_locations | boolean |
Ist "true", ist dieses Objekt an allen Speicherorten (einschließlich zukünftiger Speicherorte) vorhanden, außer wenn es im Feld absent_at_location_ids angegeben ist. Ist "false" angegeben, ist dieses Objekt an keiner Stelle (einschließlich zukünftiger Speicherorte) vorhanden, es sei denn, es wird im Feld present_at_location_ids angegeben. Wenn nicht angegeben, wird der Standardwert auf "true" festgelegt. |
|
|
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. |
|
|
Description
|
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. |
|
|
Kategorie-ID
|
category_id | string |
Die ID der Kategorie des Elements, falls vorhanden. |
|
|
Steueridentifikationsnummern
|
tax_ids | array of string | ||
|
Typ
|
type | string |
Der Typ dieses Objekts. Jeder Objekttyp hat eigenschaften erwartet, die in einem strukturierten Format innerhalb des entsprechenden Felds *_data unten ausgedrückt werden. |
|
|
ID
|
id | string |
Ein Bezeichner, der auf dieses Objekt verweist. |
|
|
An allen Standorten präsentieren
|
present_at_all_locations | boolean |
Gibt an allen Standorten an. |
|
|
Artikel-ID
|
item_id | string |
Der Bezeichner des Elements. |
|
|
Name
|
name | string |
Der Name des Elements. |
|
|
Preisart
|
pricing_type | string |
Die Art der Preise. |
|
|
Betrag
|
amount | integer |
Der Betrag. |
|
|
Währung
|
currency | string |
Die Währung. |
|
|
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. |
|
|
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. |
|
|
Berechnungsphase
|
calculation_phase | string |
Gibt an, ob die Steuer basierend auf dem Teilergebnis oder der Summe einer Zahlung berechnet wird. |
|
|
Inklusionstyp
|
inclusion_type | string |
Ob die Steuer ADDITIVE oder INCLUSIVE ist. |
|
|
Prozentsatz
|
percentage | string |
Der Prozentsatz der Steuer in Dezimalform, wobei ein "." als Dezimaltrennzeichen und ohne "%" Zeichen verwendet wird. Der Wert 7,5 entspricht 7,5%. |
|
|
Gilt für benutzerdefinierte Beträge
|
applies_to_custom_amounts | boolean |
Wenn true, gilt die Gebühr für benutzerdefinierte Beträge, die in die Square Point of Sale-App eingegeben werden, die keinem bestimmten CatalogItem zugeordnet sind. |
|
|
Enabled
|
enabled | boolean |
Ein boolesches Kennzeichen, um anzugeben, ob die Steuer in der Square Point of Sale-App als aktiviert (true) angezeigt wird oder nicht (false). |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Objekte
|
objects | array of object | |
|
Typ
|
objects.type | string |
Der Typ dieses Objekts. |
|
ID
|
objects.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Aktualisiert unter
|
objects.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Version
|
objects.version | integer |
Die aktuelle Version des Objekts. |
|
Ist gelöscht
|
objects.is_deleted | boolean |
Wenn true, wurde das Objekt aus der Datenbank gelöscht. Muss falsch sein, damit neue Objekte eingefügt werden. Beim Löschen entspricht das Feld updated_at der Löschzeit. |
|
An allen Standorten vorhanden
|
objects.present_at_all_locations | boolean |
Ist "true", ist dieses Objekt an allen Speicherorten (einschließlich zukünftiger Speicherorte) vorhanden, außer wenn es im Feld absent_at_location_ids angegeben ist. Ist "false" angegeben, ist dieses Objekt an keiner Stelle (einschließlich zukünftiger Speicherorte) vorhanden, es sei denn, es wird im Feld present_at_location_ids angegeben. Wenn nicht angegeben, wird der Standardwert auf "true" festgelegt. |
|
Name
|
objects.item_data.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. |
|
Description
|
objects.item_data.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. |
|
Kategorie-ID
|
objects.item_data.category_id | string |
Die ID der Kategorie des Elements, falls vorhanden. |
|
Steueridentifikationsnummern
|
objects.item_data.tax_ids | array of string | |
|
Variationen
|
objects.item_data.variations | array of object | |
|
Typ
|
objects.item_data.variations.type | string |
Der Typ dieses Objekts. Jeder Objekttyp hat eigenschaften erwartet, die in einem strukturierten Format innerhalb des entsprechenden Felds *_data unten ausgedrückt werden. |
|
ID
|
objects.item_data.variations.id | string |
Ein Bezeichner, der auf dieses Objekt verweist. |
|
Aktualisiert unter
|
objects.item_data.variations.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Version
|
objects.item_data.variations.version | integer |
Die Version des Objekts. Beim Aktualisieren eines Objekts muss die angegebene Version mit der Version in der Datenbank übereinstimmen, andernfalls wird der Schreibvorgang als widersprüchlich abgelehnt. |
|
Ist gelöscht
|
objects.item_data.variations.is_deleted | boolean |
Wenn true, wurde das Objekt aus der Datenbank gelöscht. Muss falsch sein, damit neue Objekte eingefügt werden. Beim Löschen entspricht das Feld updated_at der Löschzeit. |
|
An allen Standorten präsentieren
|
objects.item_data.variations.present_at_all_locations | boolean |
Eine Liste der Speicherorte, an denen das Objekt vorhanden ist, auch wenn present_at_all_locations falsch ist. Dies kann Speicherorte umfassen, die deaktiviert werden. |
|
Artikel-ID
|
objects.item_data.variations.item_variation_data.item_id | string |
Die ID des Objekts mit dieser Elementvariation. |
|
Name
|
objects.item_data.variations.item_variation_data.name | string |
Der Name dieses Elements. Dies ist ein durchsuchbares Attribut für die Verwendung in anwendbaren Abfragefiltern, und die Wertlänge ist von Unicode-Codepunkten. |
|
Ordinal
|
objects.item_data.variations.item_variation_data.ordinal | integer |
Die Reihenfolge, in der diese Elementvariation angezeigt werden soll. Dieser Wert ist schreibgeschützt. |
|
Preisart
|
objects.item_data.variations.item_variation_data.pricing_type | string |
Gibt an, ob der Preis der Artikelvariation zum Zeitpunkt des Verkaufs festgelegt oder bestimmt wird. |
|
Betrag
|
objects.item_data.variations.item_variation_data.price_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
|
objects.item_data.variations.item_variation_data.price_money.currency | string |
Der Währungstyp im ISO 4217-Format. Der Währungscode für US-Dollar ist beispielsweise USD. |
|
Name
|
objects.category_data.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. |
|
Name
|
objects.tax_data.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. |
|
Berechnungsphase
|
objects.tax_data.calculation_phase | string |
Gibt an, ob die Steuer basierend auf dem Teilergebnis oder der Summe einer Zahlung berechnet wird. |
|
Inklusionstyp
|
objects.tax_data.inclusion_type | string |
Ob die Steuer ADDITIVE oder INCLUSIVE ist. |
|
Prozentsatz
|
objects.tax_data.percentage | string |
Der Prozentsatz in dezimaler Form, wobei ein "." als Dezimaltrennzeichen und ohne "%" Zeichen verwendet wird. Der Wert 7,5 entspricht 7,5%. |
|
Gilt für benutzerdefinierte Beträge
|
objects.tax_data.applies_to_custom_amounts | boolean |
Wenn true, gilt die Gebühr für benutzerdefinierte Beträge, die in die Square Point of Sale-App eingegeben werden, die keinem bestimmten CatalogItem zugeordnet sind. |
|
Enabled
|
objects.tax_data.enabled | boolean |
Gibt an, ob ein Objekt verwendet werden kann. |
|
ID-Zuordnungen
|
id_mappings | array of object | |
|
Clientobjekt-ID
|
id_mappings.client_object_id | string |
Die vom Client bereitgestellte temporäre #-Präfix-ID für ein neues CatalogObject. |
|
Objekt-ID
|
id_mappings.object_id | string |
Die permanente ID, die vom Server erstellt wurde. |
Batchlöschkatalogobjekte
Löscht eine Reihe von CatalogItems basierend auf der bereitgestellten Liste der Ziel-IDs und gibt eine Reihe von erfolgreich gelöschten IDs in der Antwort zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Objekt-IDs
|
object_ids | array of string |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gelöschte Objekt-IDs
|
deleted_object_ids | array of string | |
|
Gelöscht am
|
deleted_at | string |
Der Zeitstempel dieser Datenbank im RFC 3339-Format |
Batchänderungsbestand
Wendet Anpassungen und Zählungen auf die bereitgestellten Artikelmengen an. Bei Erfolg: Gibt die aktuelle berechnete Anzahl aller Objekte zurück, auf die in der Anforderung verwiesen wird.
Parameter
| Name | Schlüssel | Erforderlich | 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. |
|
|
Typ
|
type | string |
Der Typ dieses Objekts. |
|
|
Referenz-ID
|
reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID, die diese Karte einer anderen Entität in einem externen System zuordnet. |
|
|
Katalogobjekt-ID
|
catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
|
Staat
|
state | string |
Der aktuelle Bestandsstatus für die zugehörige Menge der Artikel. |
|
|
Speicherort-ID
|
location_id | string |
Die Standort-ID für einen Empfänger (außer dem Händler), der einen Teil dieses Angebots erhält. |
|
|
Menge
|
quantity | string |
Die Anzahl der Elemente, die von der physischen Anzahl als Dezimalzeichenfolge betroffen sind. Die Zahl kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
|
Mitarbeiter-ID
|
employee_id | string |
Die square-generierte ID des Mitarbeiters, der für die physische Anzahl verantwortlich ist. |
|
|
Aufgetreten bei
|
occurred_at | string |
Ein vom Client generierter RFC 3339-formatierter Zeitstempel, der angibt, wann die physische Anzahl untersucht wurde. Bei Aktualisierungen der physischen Anzahl kann der occurred_at Zeitstempel nicht älter als 24 Stunden oder in Zukunft relativ zum Zeitpunkt der Anforderung sein. |
|
|
Unveränderte Anzahl ignorieren
|
ignore_unchanged_counts | boolean |
Gibt an, ob die aktuelle physische Anzahl ignoriert werden soll, wenn die Menge seit der letzten physischen Anzahl unverändert ist. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zählt
|
counts | array of object | |
|
Katalogobjekt-ID
|
counts.catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
Catalog-Objekttyp
|
counts.catalog_object_type | string |
Der Typ des CatalogObject, das nachverfolgt wird. |
|
Staat
|
counts.state | string |
Der aktuelle Zustand. |
|
Speicherort-ID
|
counts.location_id | string |
Der Bezeichner für den Speicherort. |
|
Menge
|
counts.quantity | string |
Die Anzahl der Elemente, die von der geschätzten Anzahl als Dezimalzeichenfolge betroffen sind. Kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
Berechnet bei
|
counts.calculated_at | string |
Ein RFC 3339-formatierter Zeitstempel, der angibt, wann die letzte physische Anzahl oder Anpassung, die die geschätzte Anzahl beeinflusst, empfangen wird. |
Berechnen der Reihenfolge (Beta)
Ermöglicht Anwendungen die Vorschau der Bestellpreise, ohne einen Auftrag zu erstellen.
Parameter
| Name | Schlüssel | Erforderlich | 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. |
|
|
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. |
|
|
Prozentsatz
|
percentage | string |
Der Prozentsatz in dezimaler Form, wobei ein "." als Dezimaltrennzeichen und ohne "%" Zeichen verwendet wird. Der Wert 7,5 entspricht 7,5%. |
|
|
Umfang
|
scope | string |
Gibt die aktuelle Ebene an. |
|
|
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. |
|
|
Menge
|
quantity | string |
Die Anzahl der Elemente, die von der physischen Anzahl als Dezimalzeichenfolge betroffen sind. Die Zahl kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
|
Betrag
|
amount | integer |
Der Betrag. |
|
|
Währung
|
currency | string |
Die Währung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Speicherort-ID
|
order.location_id | string |
Der Bezeichner des Speicherorts. |
|
Zeilenelemente
|
order.line_items | array of object | |
|
UID
|
order.line_items.uid | string |
Die quadratisch generierte ID. |
|
Menge
|
order.line_items.quantity | string |
Die Anzahl der Elemente, die von der physischen Anzahl als Dezimalzeichenfolge betroffen sind. Die Zahl kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
Name
|
order.line_items.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. |
|
Betrag
|
order.line_items.base_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.base_price_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.gross_sales_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.gross_sales_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.variation_total_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.variation_total_price_money.currency | string |
Die Währung. |
|
Angewendete Rabatte
|
order.line_items.applied_discounts | array of object | |
|
UID
|
order.line_items.applied_discounts.uid | string |
Eine quadratische ID. |
|
Rabatt-UID
|
order.line_items.applied_discounts.discount_uid | string |
Die UID des Rabatts, den der angewendete Rabatt darstellt. |
|
Betrag
|
order.line_items.applied_discounts.applied_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.applied_discounts.applied_money.currency | string |
Die Währung. |
|
Rabatte
|
order.discounts | array of object | |
|
UID
|
order.discounts.uid | string |
Die quadratisch generierte ID. |
|
Name
|
order.discounts.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. |
|
Prozentsatz
|
order.discounts.percentage | string |
Der Prozentsatz in dezimaler Form, wobei ein "." als Dezimaltrennzeichen und ohne "%" Zeichen verwendet wird. Der Wert 7,5 entspricht 7,5%. |
|
Betrag
|
order.discounts.applied_money.amount | integer |
Der Betrag. |
|
Währung
|
order.discounts.applied_money.currency | string |
Die Währung. |
|
Typ
|
order.discounts.type | string |
Gibt den Typ an. |
|
Umfang
|
order.discounts.scope | string |
Gibt die aktuelle Ebene an. |
|
Erstellt unter
|
order.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
order.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Staat
|
order.state | string |
Der aktuelle Zustand. |
|
Version
|
order.version | integer |
Die aktuelle Version dieses Objekts. |
|
Betrag
|
order.total_tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_tip_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_tip_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_service_charge_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_service_charge_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.tip_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.tip_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.service_charge_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.service_charge_money.currency | string |
Die Währung. |
Bestellung abrufen
Ruft eine Bestellung nach ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Auftrags-ID
|
order_id | True | string |
Der Bezeichner der Bestellung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
order.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Speicherort-ID
|
order.location_id | string |
Der Bezeichner des Speicherorts. |
|
Zeilenelemente
|
order.line_items | array of object | |
|
UID
|
order.line_items.uid | string |
Die quadratisch generierte ID. |
|
Menge
|
order.line_items.quantity | string |
Die Anzahl der Elemente, die von der physischen Anzahl als Dezimalzeichenfolge betroffen sind. Die Zahl kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
Name
|
order.line_items.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. |
|
Betrag
|
order.line_items.base_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.base_price_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.gross_sales_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.gross_sales_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.variation_total_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.variation_total_price_money.currency | string |
Die Währung. |
|
Angewendete Rabatte
|
order.line_items.applied_discounts | array of object | |
|
UID
|
order.line_items.applied_discounts.uid | string |
Eine quadratische ID. |
|
Rabatt-UID
|
order.line_items.applied_discounts.discount_uid | string |
Die UID des Rabatts, den der angewendete Rabatt darstellt. |
|
Betrag
|
order.line_items.applied_discounts.applied_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.applied_discounts.applied_money.currency | string |
Die Währung. |
|
Rabatte
|
order.discounts | array of object | |
|
UID
|
order.discounts.uid | string |
Die quadratisch generierte ID. |
|
Name
|
order.discounts.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. |
|
Prozentsatz
|
order.discounts.percentage | string |
Der Prozentsatz in dezimaler Form, wobei ein "." als Dezimaltrennzeichen und ohne "%" Zeichen verwendet wird. Der Wert 7,5 entspricht 7,5%. |
|
Betrag
|
order.discounts.applied_money.amount | integer |
Der Betrag. |
|
Währung
|
order.discounts.applied_money.currency | string |
Die Währung. |
|
Typ
|
order.discounts.type | string |
Gibt den Typ an. |
|
Umfang
|
order.discounts.scope | string |
Gibt die aktuelle Ebene an. |
|
Erstellt unter
|
order.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
order.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Staat
|
order.state | string |
Der aktuelle Zustand. |
|
Version
|
order.version | integer |
Die aktuelle Version dieses Objekts. |
|
Betrag
|
order.total_tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_tip_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_tip_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_service_charge_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_service_charge_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.tip_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.tip_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.service_charge_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.service_charge_money.currency | string |
Die Währung. |
Bestellung erstellen
Erstellt eine neue Bestellung, die Informationen zu Produkten zum Kauf und zu den Einstellungen enthalten kann, die für den Kauf gelten sollen.
Parameter
| Name | Schlüssel | Erforderlich | 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. |
|
|
Speicherort-ID
|
location_id | string |
Der Bezeichner des Speicherorts. |
|
|
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. |
|
|
Menge
|
quantity | string |
Die Anzahl der Elemente, die von der physischen Anzahl als Dezimalzeichenfolge betroffen sind. Die Zahl kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
|
Betrag
|
amount | integer |
Der Betrag. |
|
|
Währung
|
currency | string |
Die Währung. |
|
|
Katalogobjekt-ID
|
catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
|
Katalogobjekt-ID
|
catalog_object_id | string |
Die Katalogobjekt-ID. |
|
|
Rabatt-UID
|
discount_uid | string |
Die UID des Rabatts, den der angewendete Rabatt darstellt. |
|
|
UID
|
uid | string |
Die quadratisch generierte ID. |
|
|
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. |
|
|
Prozentsatz
|
percentage | string |
Der Prozentsatz in dezimaler Form, wobei ein "." als Dezimaltrennzeichen und ohne "%" Zeichen verwendet wird. Der Wert 7,5 entspricht 7,5%. |
|
|
Umfang
|
scope | string |
Gibt die aktuelle Ebene an. |
|
|
UID
|
uid | string |
Die quadratisch generierte ID. |
|
|
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. |
|
|
Prozentsatz
|
percentage | string |
Der Prozentsatz in dezimaler Form, wobei ein "." als Dezimaltrennzeichen und ohne "%" Zeichen verwendet wird. Der Wert 7,5 entspricht 7,5%. |
|
|
Umfang
|
scope | string |
Gibt die aktuelle Ebene an. |
|
|
Katalogobjekt-ID
|
catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
|
Betrag
|
amount | integer |
Der Betrag. |
|
|
Währung
|
currency | string |
Die Währung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
order.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Speicherort-ID
|
order.location_id | string |
Der Bezeichner des Speicherorts. |
|
Zeilenelemente
|
order.line_items | array of object | |
|
UID
|
order.line_items.uid | string |
Die quadratisch generierte ID. |
|
Name
|
order.line_items.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. |
|
Menge
|
order.line_items.quantity | string |
Die Anzahl der Elemente, die von der physischen Anzahl als Dezimalzeichenfolge betroffen sind. Die Zahl kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
Angewendete Steuern
|
order.line_items.applied_taxes | array of object | |
|
UID
|
order.line_items.applied_taxes.uid | string |
Eine quadratische ID. |
|
Steuer-UID
|
order.line_items.applied_taxes.tax_uid | string |
Die UID der Steuer, für die diese angewendete Steuer steht. |
|
Betrag
|
order.line_items.applied_taxes.applied_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.applied_taxes.applied_money.currency | string |
Die Währung. |
|
Angewendete Rabatte
|
order.line_items.applied_discounts | array of object | |
|
UID
|
order.line_items.applied_discounts.uid | string |
Eine quadratische ID. |
|
Rabatt-UID
|
order.line_items.applied_discounts.discount_uid | string |
Die UID des Rabatts, den der angewendete Rabatt darstellt. |
|
Betrag
|
order.line_items.applied_discounts.applied_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.applied_discounts.applied_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.base_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.base_price_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.gross_sales_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.gross_sales_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.variation_total_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.variation_total_price_money.currency | string |
Die Währung. |
|
Katalogobjekt-ID
|
order.line_items.catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
Variationsname
|
order.line_items.variation_name | string |
Der Name der Variation, die auf dieses Zeilenelement angewendet wurde. |
|
Modifizierer
|
order.line_items.modifiers | array of object | |
|
UID
|
order.line_items.modifiers.uid | string |
Eine quadratische ID. |
|
Katalogobjekt-ID
|
order.line_items.modifiers.catalog_object_id | string |
Die Katalogobjekt-ID. |
|
Name
|
order.line_items.modifiers.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. |
|
Betrag
|
order.line_items.modifiers.base_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.modifiers.base_price_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.modifiers.total_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.modifiers.total_price_money.currency | string |
Die Währung. |
|
MwSt.
|
order.taxes | array of object | |
|
UID
|
order.taxes.uid | string |
Die quadratisch generierte ID. |
|
Name
|
order.taxes.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. |
|
Typ
|
order.taxes.type | string |
Gibt den Typ an. |
|
Prozentsatz
|
order.taxes.percentage | string |
Der Prozentsatz in dezimaler Form, wobei ein "." als Dezimaltrennzeichen und ohne "%" Zeichen verwendet wird. Der Wert 7,5 entspricht 7,5%. |
|
Betrag
|
order.taxes.applied_money.amount | integer |
Der Betrag. |
|
Währung
|
order.taxes.applied_money.currency | string |
Die Währung. |
|
Umfang
|
order.taxes.scope | string |
Gibt die aktuelle Ebene an. |
|
Rabatte
|
order.discounts | array of object | |
|
UID
|
order.discounts.uid | string |
Die quadratisch generierte ID. |
|
Katalogobjekt-ID
|
order.discounts.catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
Name
|
order.discounts.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. |
|
Typ
|
order.discounts.type | string |
Gibt den Typ an. |
|
Prozentsatz
|
order.discounts.percentage | string |
Der Prozentsatz in dezimaler Form, wobei ein "." als Dezimaltrennzeichen und ohne "%" Zeichen verwendet wird. Der Wert 7,5 entspricht 7,5%. |
|
Betrag
|
order.discounts.applied_money.amount | integer |
Der Betrag. |
|
Währung
|
order.discounts.applied_money.currency | string |
Die Währung. |
|
Umfang
|
order.discounts.scope | string |
Gibt die aktuelle Ebene an. |
|
Betrag
|
order.discounts.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.discounts.amount_money.currency | string |
Die Währung. |
|
Erstellt unter
|
order.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
order.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Staat
|
order.state | string |
Der aktuelle Zustand. |
|
Version
|
order.version | integer |
Die aktuelle Version dieses Objekts. |
|
Referenz-ID
|
order.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Betrag
|
order.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_tip_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_tip_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_service_charge_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_service_charge_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.tip_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.tip_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.service_charge_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.service_charge_money.currency | string |
Die Währung. |
|
Name
|
order.source.name | string |
Der Name. |
Beweis für Streitigkeiten auflisten
Gibt eine Liste von Beweismitteln zurück, die einer Streitigkeit zugeordnet sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Streitbeilegungs-ID
|
dispute_id | True | string |
Der Bezeichner des Streits. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Evidence
|
evidence | array of object | |
|
ID
|
evidence.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Streitbeilegungs-ID
|
evidence.dispute_id | string |
Die ID des Streits, dem die Beweismittel zugeordnet sind. |
|
Nachweistext
|
evidence.evidence_text | string |
Der unformatierte Text. |
|
Nachweistyp
|
evidence.evidence_type | string |
Die Art des Nachweises. |
|
Hochgeladen unter
|
evidence.uploaded_at | string |
Der Zeitpunkt, zu dem die nächste Aktion fällig ist, im RFC 3339-Format. |
|
Nachweis-ID
|
evidence.evidence_id | string |
Die square-generierte ID des Nachweises. |
|
Dateiname
|
evidence.evidence_file.filename | string |
Der Dateiname einschließlich der Dateierweiterung |
|
Dateityp
|
evidence.evidence_file.filetype | string |
Streitnachweisdateien müssen anwendungs-/pdf-, image/heic-, image/heif-, image/jpeg-, image/png- oder image/tiff-Formate sein. |
|
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. |
Durchsuchen von Terminal-Auscheckvorgängen
Ruft eine gefilterte Liste der Terminal-Auscheckanforderungen ab, die vom Konto erstellt wurden, das die Anforderung stellt.
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. |
|
|
Der Status
|
status | string |
Der aktuelle Status. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Auschecken
|
checkouts | array of object | |
|
ID
|
checkouts.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Betrag
|
checkouts.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
checkouts.amount_money.currency | string |
Die Währung. |
|
Referenz-ID
|
checkouts.reference_id | string |
Eine optionale zweite ID, die verwendet wird, um das Kundenprofil einer Entität in einem anderen System zuzuordnen. |
|
Hinweis
|
checkouts.note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
Geräte-ID
|
checkouts.device_options.device_id | string |
Die eindeutige ID des Geräts, das für dieses TerminalCheckout vorgesehen ist. |
|
Tippen zulassen
|
checkouts.device_options.tip_settings.allow_tipping | boolean |
Gibt an, ob tipping für dieses Auschecken aktiviert ist. Der Standardwert ist „false“. |
|
Bestätigungsbildschirm überspringen
|
checkouts.device_options.skip_receipt_screen | boolean |
Weist das Gerät an, den Belegbildschirm zu überspringen. Der Standardwert ist „false“. |
|
Der Status
|
checkouts.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Zahlungs-IDs
|
checkouts.payment_ids | array of string | |
|
Erstellt unter
|
checkouts.created_at | string |
Die Ereigniszeit im ISO 8601-Format. |
|
Aktualisiert unter
|
checkouts.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
App-ID
|
checkouts.app_id | string |
Die ID der Anwendung, die das Auschecken erstellt hat. |
|
Stichtagsdauer
|
checkouts.deadline_duration | string |
Eine RFC 3339-Dauer, nach der das Auschecken automatisch abgebrochen wird. Ein TerminalCheckout, das ausstehend ist, wird automatisch ABGEBROCHEN und hat einen Abbruchgrund für TIMED_OUT. Standard: 5 Minuten ab erstellung |
|
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. |
Erstattungszahlung
Erstattet eine Zahlung. Sie können den gesamten Zahlungsbetrag oder einen Teil davon zurückerstatten. Sie können diesen Endpunkt verwenden, um eine Kartenzahlung zu erstatten oder eine Rückerstattung eines Bargelds oder einer externen Zahlung aufzuzeichnen.
Parameter
| Name | Schlüssel | Erforderlich | 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. |
|
|
Zahlungs-ID
|
payment_id | string |
Die eindeutige ID der Zahlung, die erstattet wird. |
|
|
Betrag
|
amount | integer |
Der Betrag, der für diese Zahlung akzeptiert werden soll, nicht einschließlich tip_money. |
|
|
Währung
|
currency | string |
Der 3-stellige ISO 4217-Währungscode. |
|
|
Betrag
|
amount | integer |
Der Betrag, der für diese Zahlung akzeptiert werden soll, nicht einschließlich tip_money. |
|
|
Währung
|
currency | string |
Der 3-stellige ISO 4217-Währungscode. |
|
|
Ursache
|
reason | string |
Eine Beschreibung des Grundes für die Rückerstattung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
refund.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Der Status
|
refund.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Betrag
|
refund.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
refund.amount_money.currency | string |
Die Währung. |
|
Zahlungs-ID
|
refund.payment_id | string |
Die eindeutige ID der Zahlung. |
|
Auftrags-ID
|
refund.order_id | string |
Die ID der Bestellung. |
|
Erstellt unter
|
refund.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
refund.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Betrag
|
refund.app_fee_money.amount | integer |
Der Betrag. |
|
Währung
|
refund.app_fee_money.currency | string |
Die Währung. |
|
Speicherort-ID
|
refund.location_id | string |
Der Bezeichner des Speicherorts. |
|
Ursache
|
refund.reason | string |
Der Grund für dieses Objekt. |
Erstellen der Terminalerstattung
Erstellt eine Anforderung zur Rückerstattung einer interac-Zahlung, die auf einem Square Terminal abgeschlossen wurde.
Parameter
| Name | Schlüssel | Erforderlich | 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. |
|
|
Betrag
|
amount | integer |
Der Betrag. |
|
|
Währung
|
currency | string |
Die Währung. |
|
|
Geräte-ID
|
device_id | string |
Die eindeutige ID des Geräts, das für dieses TerminalRefund vorgesehen ist. |
|
|
Ursache
|
reason | string |
Der Grund für dieses Objekt. |
|
|
Zahlungs-ID
|
payment_id | string |
Die eindeutige ID der Zahlung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
refund.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Zahlungs-ID
|
refund.payment_id | string |
Die eindeutige ID der Zahlung. |
|
Betrag
|
refund.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
refund.amount_money.currency | string |
Die Währung. |
|
Ursache
|
refund.reason | string |
Der Grund für dieses Objekt. |
|
Geräte-ID
|
refund.device_id | string |
Die eindeutige ID des Geräts, das für dieses TerminalRefund vorgesehen ist. |
|
Stichtagsdauer
|
refund.deadline_duration | string |
Eine RFC 3339-Dauer, nach der das Auschecken automatisch abgebrochen wird. Ein TerminalCheckout, das ausstehend ist, wird automatisch ABGEBROCHEN und hat einen Abbruchgrund für TIMED_OUT. Standard: 5 Minuten ab erstellung |
|
Der Status
|
refund.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Erstellt unter
|
refund.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
refund.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
App-ID
|
refund.app_id | string |
Die ID der Anwendung, die das Auschecken erstellt hat. |
|
Kartenmarke
|
refund.card.card_brand | string |
Die Marke der Karte. |
|
last_4
|
refund.card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Ausdrucksmonat
|
refund.card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Exp Year
|
refund.card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Fingerabdruck
|
refund.card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
Kartentyp
|
refund.card.card_type | string |
Der Typ der Karte. |
|
KASTEN
|
refund.card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als Bank Identification Number (BIN) bezeichnet werden. |
|
Auftrags-ID
|
refund.order_id | string |
Die ID der Bestellung. |
|
Speicherort-ID
|
refund.location_id | string |
Der Bezeichner des Speicherorts. |
Erstellen des Terminal-Auscheckens
Erstellt eine Terminal-Checkout-Anforderung und sendet sie an das angegebene Gerät, um eine Zahlung für den angeforderten Betrag zu übernehmen.
Parameter
| Name | Schlüssel | Erforderlich | 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. |
|
|
Betrag
|
amount | integer |
Der Betrag. |
|
|
Währung
|
currency | string |
Die Währung. |
|
|
Referenz-ID
|
reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
|
Geräte-ID
|
device_id | string |
Die eindeutige ID des Geräts, das für dieses TerminalCheckout vorgesehen ist. |
|
|
Hinweis
|
note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
checkout.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Betrag
|
checkout.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
checkout.amount_money.currency | string |
Die Währung. |
|
Referenz-ID
|
checkout.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Hinweis
|
checkout.note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
Geräte-ID
|
checkout.device_options.device_id | string |
Die eindeutige ID des Geräts, das für dieses TerminalCheckout vorgesehen ist. |
|
Tippen zulassen
|
checkout.device_options.tip_settings.allow_tipping | boolean |
Gibt an, ob tipping für dieses Auschecken aktiviert ist. Der Standardwert ist „false“. |
|
Bestätigungsbildschirm überspringen
|
checkout.device_options.skip_receipt_screen | boolean |
Weist das Gerät an, den Belegbildschirm zu überspringen. Der Standardwert ist „false“. |
|
Der Status
|
checkout.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Erstellt unter
|
checkout.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
checkout.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
App-ID
|
checkout.app_id | string |
Die ID der Anwendung, die das Auschecken erstellt hat. |
|
Stichtagsdauer
|
checkout.deadline_duration | string |
Eine RFC 3339-Dauer, nach der das Auschecken automatisch abgebrochen wird. Ein TerminalCheckout, das ausstehend ist, wird automatisch ABGEBROCHEN und hat einen Abbruchgrund für TIMED_OUT. Standard: 5 Minuten ab erstellung |
|
Zahlungsmethode
|
checkout.payment_type | string |
Der Zahlungstyp, von dem das Terminal erfasst werden soll. Standardmäßig wird CARD_PRESENT. |
Erstellen von Beweistexten für Streitigkeiten
Lädt Text hoch, der als Beweis für eine Streitbeilegung verwendet werden soll.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Streitbeilegungs-ID
|
dispute_id | True | string |
Der Bezeichner des Streits. |
|
Nachweistyp
|
evidence_type | string |
Die Art der Nachweise, die Sie hochladen. |
|
|
Nachweistext
|
evidence_text | string |
Die Nachweiszeichenfolge. |
|
|
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
|
evidence.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Streitbeilegungs-ID
|
evidence.dispute_id | string |
Die ID des Streits, dem die Beweismittel zugeordnet sind. |
|
Nachweistext
|
evidence.evidence_text | string |
Der unformatierte Text. |
|
Nachweistyp
|
evidence.evidence_type | string |
Der Pf-Nachweistyp. |
|
Hochgeladen unter
|
evidence.uploaded_at | string |
Der Zeitpunkt, zu dem die nächste Aktion fällig ist, im RFC 3339-Format. |
Gruppe vom Kunden entfernen
Entfernt eine Gruppenmitgliedschaft von einem Kunden. Der Kunde wird durch den customer_id Wert identifiziert, und die Kundengruppe wird durch den group_id Wert identifiziert.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kunden-ID
|
customer_id | True | string |
Der Bezeichner des Kunden. |
|
Gruppen-ID
|
group_id | True | string |
Der Bezeichner der Gruppe. |
Gibt zurück
- response
- object
Hinzufügen einer Gruppe zum Kunden
Fügt einem Kunden eine Gruppenmitgliedschaft hinzu. Der Kunde wird durch den customer_id Wert identifiziert, und die Kundengruppe wird durch den group_id Wert identifiziert.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kunden-ID
|
customer_id | True | string |
Der Bezeichner des Kunden. |
|
Gruppen-ID
|
group_id | True | string |
Der Bezeichner der Gruppe. |
Gibt zurück
- response
- object
Karte abrufen
Ruft Details für eine bestimmte Karte ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kartenkennung
|
card_id | True | string |
Der Bezeichner der Karte. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
card.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Adresszeile 1
|
card.billing_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
|
card.billing_address.address_line_2 | string |
Die zweite Zeile der Adresse( falls vorhanden). |
|
Örtlichkeit
|
card.billing_address.locality | string |
Die Stadt oder Die Stadt der Adresse. |
|
VerwaltungsbezirkSebene 1
|
card.billing_address.administrative_district_level_1 | string |
Eine zivile Person im Land der Adresse. In den USA ist dies der Staat. |
|
Postleitzahl
|
card.billing_address.postal_code | string |
Die Postleitzahl der Adresse. |
|
Country
|
card.billing_address.country | string |
Das Land der Adresse im ISO 3166-1-Alpha-2-Format. |
|
Fingerabdruck
|
card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
KASTEN
|
card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als Bank Identification Number (BIN) bezeichnet werden. |
|
Kartenmarke
|
card.card_brand | string |
Die Marke der Karte. |
|
Kartentyp
|
card.card_type | string |
Der Typ der Karte. |
|
Kartenhaltername
|
card.cardholder_name | string |
Der Name des Karteninhabers. |
|
Kunden-ID
|
card.customer_id | string |
Die ID dieses Objekts, das den Kunden darstellt. |
|
Enabled
|
card.enabled | boolean |
Gibt an, ob diese Option aktiviert ist. |
|
Ausdrucksmonat
|
card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Exp Year
|
card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Letzte 4
|
card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Prepaid-Typ
|
card.prepaid_type | string |
Gibt an, ob die Karte im Voraus bezahlt ist. |
|
Referenz-ID
|
card.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Version
|
card.version | integer |
Die aktuelle Version dieses Objekts. |
Karte deaktivieren
Deaktiviert die Karte, um weitere Updates oder Gebühren zu verhindern. Das Deaktivieren einer bereits deaktivierten Karte ist zulässig, hat aber keine Auswirkung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kartenkennung
|
card_id | True | string |
Der Bezeichner der Karte. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
card.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Adresszeile 1
|
card.billing_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
|
card.billing_address.address_line_2 | string |
Die zweite Zeile der Adresse( falls vorhanden). |
|
Örtlichkeit
|
card.billing_address.locality | string |
Die Stadt oder Die Stadt der Adresse. |
|
VerwaltungsbezirkSebene 1
|
card.billing_address.administrative_district_level_1 | string |
Eine zivile Person im Land der Adresse. In den USA ist dies der Staat. |
|
Postleitzahl
|
card.billing_address.postal_code | string |
Die Postleitzahl der Adresse. |
|
Country
|
card.billing_address.country | string |
Das Land der Adresse im ISO 3166-1-Alpha-2-Format. |
|
Fingerabdruck
|
card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
KASTEN
|
card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als Bank Identification Number (BIN) bezeichnet werden. |
|
Kartenmarke
|
card.card_brand | string |
Die Marke der Karte. |
|
Kartentyp
|
card.card_type | string |
Der Typ der Karte. |
|
Kartenhaltername
|
card.cardholder_name | string |
Der Name des Karteninhabers. |
|
Kunden-ID
|
card.customer_id | string |
Die ID dieses Objekts, das den Kunden darstellt. |
|
Enabled
|
card.enabled | boolean |
Gibt an, ob diese Option aktiviert ist. |
|
Ausdrucksmonat
|
card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Exp Year
|
card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Letzte 4
|
card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Prepaid-Typ
|
card.prepaid_type | string |
Gibt an, ob die Karte im Voraus bezahlt ist. |
|
Referenz-ID
|
card.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Version
|
card.version | integer |
Die aktuelle Version dieses Objekts. |
Karte erstellen
Fügt einem vorhandenen Händler eine Karte in der Datei hinzu.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Idempotency-Taste
|
idempotency_key | string |
Der Idempotenzschlüssel. |
|
|
Quell-ID
|
source_id | string |
Der Bezeichner der Quelle. |
|
|
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. |
|
|
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 |
Das Land der Adresse im ISO 3166-1-Alpha-2-Format. |
|
|
Kartenhaltername
|
cardholder_name | string |
Der Name des Karteninhabers. |
|
|
Kunden-ID
|
customer_id | string |
Die ID dieses Objekts, das den Kunden darstellt. |
|
|
Referenz-ID
|
reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
card.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Adresszeile 1
|
card.billing_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
|
card.billing_address.address_line_2 | string |
Die zweite Zeile der Adresse( falls vorhanden). |
|
Örtlichkeit
|
card.billing_address.locality | string |
Die Stadt oder Die Stadt der Adresse. |
|
VerwaltungsbezirkSebene 1
|
card.billing_address.administrative_district_level_1 | string |
Eine zivile Person im Land der Adresse. In den USA ist dies der Staat. |
|
Postleitzahl
|
card.billing_address.postal_code | string |
Die Postleitzahl der Adresse. |
|
Country
|
card.billing_address.country | string |
Das Land der Adresse im ISO 3166-1-Alpha-2-Format. |
|
Fingerabdruck
|
card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
KASTEN
|
card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als Bank Identification Number (BIN) bezeichnet werden. |
|
Kartenmarke
|
card.card_brand | string |
Die Marke der Karte. |
|
Kartentyp
|
card.card_type | string |
Der Typ der Karte. |
|
Kartenhaltername
|
card.cardholder_name | string |
Der Name des Karteninhabers. |
|
Kunden-ID
|
card.customer_id | string |
Die ID dieses Objekts, das den Kunden darstellt. |
|
Enabled
|
card.enabled | boolean |
Gibt an, ob diese Option aktiviert ist. |
|
Ausdrucksmonat
|
card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Exp Year
|
card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Letzte 4
|
card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Prepaid-Typ
|
card.prepaid_type | string |
Gibt an, ob die Karte im Voraus bezahlt ist. |
|
Referenz-ID
|
card.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Version
|
card.version | integer |
Die aktuelle Version dieses Objekts. |
Karten auflisten
Ruft eine Liste der Karten ab, die im Besitz des Kontos sind, das die Anforderung stellt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Mauszeiger
|
cursor | string |
Der Paginierungscursor, der von einem vorherigen Aufruf an diesen Endpunkt zurückgegeben wird. |
|
|
Kunden-ID
|
customer_id | string |
Beschränken Sie die Ergebnisse auf Karten, die dem angegebenen Kunden zugeordnet sind. Standardmäßig werden alle Karten im Besitz des Händlers zurückgegeben. |
|
|
Deaktiviert einschließen
|
include_disabled | boolean |
Enthält deaktivierte Karten. Standardmäßig werden alle aktivierten Karten im Besitz des Händlers zurückgegeben. |
|
|
Referenz-ID
|
reference_id | string |
Beschränken Sie die Ergebnisse auf Karten, die dem bereitgestellten reference_id zugeordnet sind. |
|
|
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 |
|---|---|---|---|
|
Karten
|
cards | array of object | |
|
ID
|
cards.card.id | string |
Der Bezeichner des Objekts |
|
Adresszeile 1
|
cards.card.billing_address.address_line_1 | string |
Felder, die mit address_line beginnen, geben die spezifischesten Details der Adresse an, z. B. Straßennummer, Straßenname und Gebäudename. |
|
Adresszeile 2
|
cards.card.billing_address.address_line_2 | string |
Die zweite Zeile der Adresse( falls vorhanden). |
|
Örtlichkeit
|
cards.card.billing_address.locality | string |
Die Stadt oder Die Stadt der Adresse. |
|
VerwaltungsbezirkSebene 1
|
cards.card.billing_address.administrative_district_level_1 | string |
Eine zivile Person im Land der Adresse. In den USA ist dies der Staat. |
|
Postleitzahl
|
cards.card.billing_address.postal_code | string |
Die Postleitzahl der Adresse. |
|
Country
|
cards.card.billing_address.country | string |
Das Land der Adresse im ISO 3166-1-Alpha-2-Format. |
|
Fingerabdruck
|
cards.card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
KASTEN
|
cards.card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als Bank Identification Number (BIN) bezeichnet werden. |
|
Kartenmarke
|
cards.card.card_brand | string |
Die Marke der Karte. |
|
Kartentyp
|
cards.card.card_type | string |
Der Typ der Karte. |
|
Kartenhaltername
|
cards.card.cardholder_name | string |
Der Name des Karteninhabers. |
|
Kunden-ID
|
cards.card.customer_id | string |
Die ID eines Kunden, der der Karte zugeordnet werden soll. |
|
Enabled
|
cards.card.enabled | boolean |
Gibt an, ob ein Objekt verwendet werden kann. |
|
Ablaufmonat
|
cards.card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Ablaufjahr
|
cards.card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Letzte 4
|
cards.card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Prepaid-Typ
|
cards.card.prepaid_type | string |
Gibt an, ob die Karte im Voraus bezahlt ist. |
|
Referenz-ID
|
cards.card.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID, die diese Karte einer anderen Entität in einem externen System zuordnet. |
|
Version
|
cards.card.version | integer |
Aktuelle Versionsnummer der Karte. Erhöht sich bei jeder Kartenaktualisierung. Anforderungen zum Aktualisieren eines vorhandenen Card-Objekts werden abgelehnt, es sei denn, die Version in der Anforderung entspricht der aktuellen Version für die Karte. |
Kataloginformationen
Ruft Informationen zur Quadratkatalog-API ab, z. B. Batchgrößenbeschränkungen, die vom BatchUpsertCatalogObjects-Endpunkt verwendet werden können.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Batch-Upsert Max-Objekte pro Batch
|
limits.batch_upsert_max_objects_per_batch | integer |
Die maximale Anzahl von Objekten, die innerhalb eines einzelnen Batches in einer /v2/catalog/batch-upsert-Anforderung angezeigt werden können. |
|
Batch Upsert Max Gesamtobjekte
|
limits.batch_upsert_max_total_objects | integer |
Die maximale Anzahl von Objekten, die in allen Batches in einer /v2/catalog/batch-upsert-Anforderung angezeigt werden können. |
|
Batch abrufen max. Objekt-IDs
|
limits.batch_retrieve_max_object_ids | integer |
Die maximale Anzahl von Objekt-IDs, die in einer /v2/catalog/batch-retrieve-Anforderung angezeigt werden können. |
|
Maximale Anzahl von Suchseiten
|
limits.search_max_page_limit | integer |
Die maximale Anzahl von Ergebnissen, die auf einer Seite einer /v2/catalog/search-Antwort zurückgegeben werden können. |
|
Batchlöschen max. Objekt-IDs
|
limits.batch_delete_max_object_ids | integer |
Die maximale Anzahl von Objekt-IDs, die in einer einzelnen /v2/catalog/batch-delete-Anforderung enthalten sein können. |
|
Aktualisieren von Elementsteuern max. Element-IDs
|
limits.update_item_taxes_max_item_ids | integer |
Die maximale Anzahl von Element-IDs, die in einer einzigen Anforderung vom Typ "/v2/catalog/update-item-tax" enthalten sein können. |
|
Aktualisieren von Steuern für Artikel max. Steuern zum Aktivieren
|
limits.update_item_taxes_max_taxes_to_enable | integer |
Die maximale Anzahl von Steuer-IDs, die in einer einzigen /v2/catalog/update-item-tax-Anforderung enthalten sein können. |
|
Aktualisiere Steuern max. Steuern zum Deaktivieren des Elements
|
limits.update_item_taxes_max_taxes_to_disable | integer |
Die maximale Anzahl von Steuer-IDs, die in einer einzigen /v2/catalog/update-item-tax-Anforderung enthalten sein können. |
|
Elementmodifiziererlisten max. Element-IDs aktualisieren
|
limits.update_item_modifier_lists_max_item_ids | integer |
Die maximale Anzahl von Steuer-IDs, die in einer einzigen /v2/catalog/update-item-tax-Anforderung enthalten sein können. |
|
Aktualisieren von Modifiziererlisten für max. Modifiziererlisten auf Aktivierung
|
limits.update_item_modifier_lists_max_modifier_lists_to_enable | integer |
Die maximale Anzahl von Modifiziererlisten-IDs, die in einer einzelnen Anforderung "/v2/catalog/update-item-modifier-lists" enthalten sein können. |
|
Aktualisieren von Modifiziererlisten für max. Modifiziererlisten zum Deaktivieren
|
limits.update_item_modifier_lists_max_modifier_lists_to_disable | integer |
Die maximale Anzahl von Modifiziererlisten-IDs, die in einer einzelnen Anforderung "/v2/catalog/update-item-modifier-lists" enthalten sein können. |
Katalogobjekt löschen
Löscht ein einzelnes CatalogObject basierend auf der bereitgestellten ID und gibt den Satz von erfolgreich gelöschten IDs in der Antwort zurück. Das Löschen ist ein kaskadierendes Ereignis, sodass auch alle untergeordneten Elemente des Zielobjekts gelöscht werden. Das Löschen eines CatalogItem-Objekts löscht beispielsweise auch alle untergeordneten Elemente des CatalogItemVariation-Objekts.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Objekt-ID
|
object_id | True | string |
Der Bezeichner des Objekts. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gelöschte Objekt-IDs
|
deleted_object_ids | array of string | |
|
Gelöscht am
|
deleted_at | string |
Der Zeitstempel dieser Datenbank im RFC 3339-Format |
Klonreihenfolge (Beta)
Erstellt eine neue Reihenfolge im Entwurfszustand, indem eine vorhandene Reihenfolge dupliziert wird. Die neu erstellte Bestellung enthält nur die Kernfelder (z. B. Positionen, Steuern und Rabatte), die aus der ursprünglichen Bestellung kopiert wurden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Auftrags-ID
|
order_id | string |
Der Auftragsbezeichner. |
|
|
Version
|
version | integer |
Die Version. |
|
|
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
|
order.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Speicherort-ID
|
order.location_id | string |
Der Bezeichner des Speicherorts. |
|
Zeilenelemente
|
order.line_items | array of object | |
|
UID
|
order.line_items.uid | string |
Die quadratisch generierte ID. |
|
Name
|
order.line_items.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. |
|
Menge
|
order.line_items.quantity | string |
Die Anzahl der Elemente, die von der physischen Anzahl als Dezimalzeichenfolge betroffen sind. Die Zahl kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
Angewendete Steuern
|
order.line_items.applied_taxes | array of object | |
|
UID
|
order.line_items.applied_taxes.uid | string |
Eine quadratische ID. |
|
Steuer-UID
|
order.line_items.applied_taxes.tax_uid | string |
Die UID der Steuer, für die diese angewendete Steuer steht. |
|
Betrag
|
order.line_items.applied_taxes.applied_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.applied_taxes.applied_money.currency | string |
Die Währung. |
|
Angewendete Rabatte
|
order.line_items.applied_discounts | array of object | |
|
UID
|
order.line_items.applied_discounts.uid | string |
Eine quadratische ID. |
|
Rabatt-UID
|
order.line_items.applied_discounts.discount_uid | string |
Die UID des Rabatts, den der angewendete Rabatt darstellt. |
|
Betrag
|
order.line_items.applied_discounts.applied_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.applied_discounts.applied_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.base_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.base_price_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.gross_sales_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.gross_sales_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.variation_total_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.variation_total_price_money.currency | string |
Die Währung. |
|
Katalogobjekt-ID
|
order.line_items.catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
Variationsname
|
order.line_items.variation_name | string |
Der Name der Variation, die auf dieses Zeilenelement angewendet wurde. |
|
Modifizierer
|
order.line_items.modifiers | array of object | |
|
UID
|
order.line_items.modifiers.uid | string |
Eine quadratische ID. |
|
Katalogobjekt-ID
|
order.line_items.modifiers.catalog_object_id | string |
Die Katalogobjekt-ID. |
|
Name
|
order.line_items.modifiers.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. |
|
Betrag
|
order.line_items.modifiers.base_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.modifiers.base_price_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.modifiers.total_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.modifiers.total_price_money.currency | string |
Die Währung. |
|
MwSt.
|
order.taxes | array of object | |
|
UID
|
order.taxes.uid | string |
Die quadratisch generierte ID. |
|
Name
|
order.taxes.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. |
|
Typ
|
order.taxes.type | string |
Gibt den Typ an. |
|
Prozentsatz
|
order.taxes.percentage | string |
Der Prozentsatz in dezimaler Form, wobei ein "." als Dezimaltrennzeichen und ohne "%" Zeichen verwendet wird. Der Wert 7,5 entspricht 7,5%. |
|
Betrag
|
order.taxes.applied_money.amount | integer |
Der Betrag. |
|
Währung
|
order.taxes.applied_money.currency | string |
Die Währung. |
|
Umfang
|
order.taxes.scope | string |
Gibt die aktuelle Ebene an. |
|
Rabatte
|
order.discounts | array of object | |
|
UID
|
order.discounts.uid | string |
Die quadratisch generierte ID. |
|
Katalogobjekt-ID
|
order.discounts.catalog_object_id | string |
Die quadratisch generierte ID des CatalogObjects, das nachverfolgt wird. |
|
Name
|
order.discounts.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. |
|
Typ
|
order.discounts.type | string |
Gibt den Typ an. |
|
Prozentsatz
|
order.discounts.percentage | string |
Der Prozentsatz in dezimaler Form, wobei ein "." als Dezimaltrennzeichen und ohne "%" Zeichen verwendet wird. Der Wert 7,5 entspricht 7,5%. |
|
Betrag
|
order.discounts.applied_money.amount | integer |
Der Betrag. |
|
Währung
|
order.discounts.applied_money.currency | string |
Die Währung. |
|
Umfang
|
order.discounts.scope | string |
Gibt die aktuelle Ebene an. |
|
Betrag
|
order.discounts.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.discounts.amount_money.currency | string |
Die Währung. |
|
Erstellt unter
|
order.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
order.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Staat
|
order.state | string |
Der aktuelle Zustand. |
|
Version
|
order.version | integer |
Die aktuelle Version dieses Objekts. |
|
Referenz-ID
|
order.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Betrag
|
order.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_tip_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_tip_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_service_charge_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_service_charge_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.tip_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.tip_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.service_charge_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.service_charge_money.currency | string |
Die Währung. |
|
Name
|
order.source.name | string |
Der Name. |
Kunde aktualisieren
Aktualisiert ein Kundenprofil. Um ein Attribut zu ändern, geben Sie den neuen Wert an. Um ein Attribut zu entfernen, geben Sie den Wert als leere Zeichenfolge oder leeres Objekt an.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kunden-ID
|
customer_id | True | string |
Der Bezeichner des Kunden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
customer.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Erstellt unter
|
customer.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
customer.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Vorname
|
customer.given_name | string |
Der angegebene (d. h. Vorname), der dem Kundenprofil zugeordnet ist. |
|
Familienname
|
customer.family_name | string |
Der Familienname (d. h. Nachname), der dem Kundenprofil zugeordnet ist. |
|
E-Mail-Adresse
|
customer.email_address | string |
Die E-Mail-Adresse, die dem Kundenprofil zugeordnet ist. |
|
Adresszeile 1
|
customer.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
|
customer.address.address_line_2 | string |
Die zweite Zeile der Adresse( falls vorhanden). |
|
Örtlichkeit
|
customer.address.locality | string |
Die Stadt oder Die Stadt der Adresse. |
|
VerwaltungsbezirkSebene 1
|
customer.address.administrative_district_level_1 | string |
Eine zivile Person im Land der Adresse. In den USA ist dies der Staat. |
|
Postleitzahl
|
customer.address.postal_code | string |
Die Postleitzahl der Adresse. |
|
Country
|
customer.address.country | string |
Das Land der Adresse im ISO 3166-1-Alpha-2-Format. |
|
Referenz-ID
|
customer.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Hinweis
|
customer.note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
E-Mail-Abonnement gekündigt
|
customer.preferences.email_unsubscribed | boolean |
Gibt an, ob der Kunde das Abonnement von Marketingkampagnen-E-Mails abbestellt hat. Der Wert "true" bedeutet, dass der Kunde sich entschieden hat, E-Mail-Marketing vom aktuellen Square-Verkäufer oder von allen Square-Verkäufern zu deaktivieren. |
|
Erstellungsquelle
|
customer.creation_source | string |
Eine Erstellungsquelle stellt die Methode dar, die zum Erstellen des Kundenprofils verwendet wird. |
|
Version
|
customer.version | integer |
Die aktuelle Version dieses Objekts. |
Kunde erstellen
Erstellt einen neuen Kunden für ein Unternehmen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorname
|
given_name | string |
Der angegebene Name (d. h. der Vorname), der dem Kundenprofil zugeordnet ist. |
|
|
Familienname
|
family_name | string |
Der Familienname (d. h. der Nachname), der dem Kundenprofil zugeordnet ist. |
|
|
E-Mail-Adresse
|
email_address | string |
Die E-Mail-Adresse, die dem Kundenprofil zugeordnet ist. |
|
|
Name des Unternehmens
|
company_name | string |
Ein Geschäftsname, der dem Kundenprofil zugeordnet ist. |
|
|
Spitzname
|
nickname | string |
Ein Spitzname für das Kundenprofil. |
|
|
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. |
|
|
Rufnummer
|
phone_number | string |
Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist. |
|
|
Referenz-ID
|
reference_id | string |
Eine optionale zweite ID, die verwendet wird, um das Kundenprofil einer Entität in einem anderen System zuzuordnen. |
|
|
Hinweis
|
note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
|
Geburtstag
|
birthday | string |
Der Geburtstag, der dem Kundenprofil zugeordnet ist, im RFC 3339-Format. Das Jahr ist optional. Die Zeitzone und die Uhrzeit sind nicht zulässig. Beispielsweise steht 0000-09-21T00:00:00-00:00 für einen Geburtstag am 21. September und 1998-09-21T00:00:00-00:00 für einen Geburtstag am 21. September 1998. Sie können diesen Wert auch im Format JJJJ-MM-DD angeben. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
customer.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Erstellt unter
|
customer.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
customer.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Vorname
|
customer.given_name | string |
Der angegebene (d. h. Vorname), der dem Kundenprofil zugeordnet ist. |
|
Familienname
|
customer.family_name | string |
Der Familienname (d. h. Nachname), der dem Kundenprofil zugeordnet ist. |
|
E-Mail-Adresse
|
customer.email_address | string |
Die E-Mail-Adresse, die dem Kundenprofil zugeordnet ist. |
|
Name des Unternehmens
|
customer.company_name | string |
Ein Geschäftsname, der dem Kundenprofil zugeordnet ist. |
|
Spitzname
|
customer.nickname | string |
Ein Spitzname für das Kundenprofil. |
|
Adresszeile 1
|
customer.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
|
customer.address.address_line_2 | string |
Die zweite Zeile der Adresse( falls vorhanden). |
|
Örtlichkeit
|
customer.address.locality | string |
Die Stadt oder Die Stadt der Adresse. |
|
VerwaltungsbezirkSebene 1
|
customer.address.administrative_district_level_1 | string |
Eine zivile Person im Land der Adresse. In den USA ist dies der Staat. |
|
Postleitzahl
|
customer.address.postal_code | string |
Die Postleitzahl der Adresse. |
|
Country
|
customer.address.country | string |
Das Land der Adresse im ISO 3166-1-Alpha-2-Format. |
|
Rufnummer
|
customer.phone_number | string |
Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist. |
|
Referenz-ID
|
customer.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Hinweis
|
customer.note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
Geburtstag
|
customer.birthday | string |
Der Geburtstag, der dem Kundenprofil zugeordnet ist, im RFC 3339-Format. Das Jahr ist optional. Die Zeitzone und die Uhrzeit sind nicht zulässig. Beispielsweise steht 0000-09-21T00:00:00-00:00 für einen Geburtstag am 21. September und 1998-09-21T00:00:00-00:00 für einen Geburtstag am 21. September 1998. |
|
E-Mail-Abonnement gekündigt
|
customer.preferences.email_unsubscribed | boolean |
Gibt an, ob der Kunde das Abonnement von Marketingkampagnen-E-Mails abbestellt hat. Der Wert "true" bedeutet, dass der Kunde sich entschieden hat, E-Mail-Marketing vom aktuellen Square-Verkäufer oder von allen Square-Verkäufern zu deaktivieren. |
|
Erstellungsquelle
|
customer.creation_source | string |
Eine Erstellungsquelle stellt die Methode dar, die zum Erstellen des Kundenprofils verwendet wird. |
|
Version
|
customer.version | integer |
Die aktuelle Version dieses Objekts. |
Kunde löschen
Löscht ein Kundenprofil aus einem Unternehmen. Dieser Vorgang hebt auch die Verknüpfung aller zugeordneten Karten in der Datei auf.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kunden-ID
|
customer_id | True | string |
Der Bezeichner des Kunden. |
Gibt zurück
- response
- object
Kunden abrufen
Gibt Details für einen einzelnen Kunden zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Kunden-ID
|
customer_id | True | string |
Der Bezeichner des Kunden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
customer.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Erstellt unter
|
customer.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
customer.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Vorname
|
customer.given_name | string |
Der angegebene (d. h. Vorname), der dem Kundenprofil zugeordnet ist. |
|
Familienname
|
customer.family_name | string |
Der Familienname (d. h. Nachname), der dem Kundenprofil zugeordnet ist. |
|
E-Mail-Adresse
|
customer.email_address | string |
Die E-Mail-Adresse, die dem Kundenprofil zugeordnet ist. |
|
Adresszeile 1
|
customer.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
|
customer.address.address_line_2 | string |
Die zweite Zeile der Adresse( falls vorhanden). |
|
Örtlichkeit
|
customer.address.locality | string |
Die Stadt oder Die Stadt der Adresse. |
|
VerwaltungsbezirkSebene 1
|
customer.address.administrative_district_level_1 | string |
Eine zivile Person im Land der Adresse. In den USA ist dies der Staat. |
|
Postleitzahl
|
customer.address.postal_code | string |
Die Postleitzahl der Adresse. |
|
Country
|
customer.address.country | string |
Das Land der Adresse im ISO 3166-1-Alpha-2-Format. |
|
Rufnummer
|
customer.phone_number | string |
Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist. |
|
Referenz-ID
|
customer.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Hinweis
|
customer.note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
E-Mail-Abonnement gekündigt
|
customer.preferences.email_unsubscribed | boolean |
Gibt an, ob der Kunde das Abonnement von Marketingkampagnen-E-Mails abbestellt hat. Der Wert "true" bedeutet, dass der Kunde sich entschieden hat, E-Mail-Marketing vom aktuellen Square-Verkäufer oder von allen Square-Verkäufern zu deaktivieren. |
|
Erstellungsquelle
|
customer.creation_source | string |
Eine Erstellungsquelle stellt die Methode dar, die zum Erstellen des Kundenprofils verwendet wird. |
|
Gruppen-IDs
|
customer.group_ids | array of string | |
|
Segment-IDs
|
customer.segment_ids | array of string | |
|
Version
|
customer.version | integer |
Die aktuelle Version dieses Objekts. |
Kunden auflisten
Listet Kundenprofile auf, die einem Quadratkonto zugeordnet sind. Unter normalen Betriebsbedingungen werden neu erstellte oder aktualisierte Kundenprofile für den Eintragsvorgang in gut unter 30 Sekunden verfügbar. Gelegentlich kann die Verteilung der neuen oder aktualisierten Profile näher an eine Minute oder länger dauern, insbesondere bei Netzwerkvorfällen und Ausfällen.
Parameter
| Name | Schlüssel | Erforderlich | 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. |
|
|
Sortierfeld
|
sort_field | string |
Gibt an, wie Kunden sortiert werden sollen. Der Standardwert ist DEFAULT. |
|
|
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 |
|---|---|---|---|
|
Kundschaft
|
customers | array of object | |
|
ID
|
customers.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Erstellt unter
|
customers.created_at | string |
Die Ereigniszeit im ISO 8601-Format. |
|
Aktualisiert unter
|
customers.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Vorname
|
customers.given_name | string |
Der angegebene (d. h. Vorname), der dem Kundenprofil zugeordnet ist. |
|
Familienname
|
customers.family_name | string |
Der Familienname (d. h. Nachname), der dem Kundenprofil zugeordnet ist. |
|
E-Mail-Adresse
|
customers.email_address | string |
Die E-Mail-Adresse, die dem Kundenprofil zugeordnet ist. |
|
Adresszeile 1
|
customers.address.address_line_1 | string |
Die erste Zeile der Adresse. |
|
Adresszeile 2
|
customers.address.address_line_2 | string |
Die zweite Zeile der Adresse( falls vorhanden). |
|
Örtlichkeit
|
customers.address.locality | string |
Die Stadt oder Die Stadt der Adresse. |
|
VerwaltungsbezirkSebene 1
|
customers.address.administrative_district_level_1 | string |
Eine zivile Person im Land der Adresse. In den USA ist dies der Staat. |
|
Postleitzahl
|
customers.address.postal_code | string |
Die Postleitzahl der Adresse. |
|
Country
|
customers.address.country | string |
Das Land der Adresse im ISO 3166-1-Alpha-2-Format. |
|
Rufnummer
|
customers.phone_number | string |
Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist. |
|
Referenz-ID
|
customers.reference_id | string |
Eine optionale zweite ID, die verwendet wird, um das Kundenprofil einer Entität in einem anderen System zuzuordnen. |
|
Hinweis
|
customers.note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
E-Mail-Abonnement gekündigt
|
customers.preferences.email_unsubscribed | boolean |
Gibt an, ob der Kunde das Abonnement von Marketingkampagnen-E-Mails abbestellt hat. Der Wert "true" bedeutet, dass der Kunde sich entschieden hat, E-Mail-Marketing vom aktuellen Square-Verkäufer oder von allen Square-Verkäufern zu deaktivieren. Dieser Wert ist schreibgeschützt aus der Kunden-API. |
|
Erstellungsquelle
|
customers.creation_source | string |
Eine Erstellungsquelle stellt die Methode dar, die zum Erstellen des Kundenprofils verwendet wird. |
|
Gruppen-IDs
|
customers.group_ids | array of string | |
|
Segment-IDs
|
customers.segment_ids | array of string | |
|
Version
|
customers.version | integer |
Die aktuelle Version des Objekts. |
Kunden suchen
Durchsucht die Kundenprofile, die einem Quadrat-Konto zugeordnet sind, mithilfe eines unterstützten Abfragefilters. Das Aufrufen von SearchCustomers ohne expliziten Abfragefilter gibt alle Kundenprofile alphabetisch basierend auf given_name und family_name zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Unscharf
|
fuzzy | string |
Verwenden Sie den Fuzzyfilter, um Kunden auszuwählen, deren Attribute der angegebenen Abfrage auf fuzzy-Weise entsprechen. Wenn die Fuzzy-Option verwendet wird, werden Suchabfragen tokenisiert, und dann muss jedes Abfragetoken an einer beliebigen Stelle im durchsuchten Attribut abgeglichen werden. Bei Abfragen mit einem einzelnen Token ist dies effektiv dasselbe Verhalten wie bei einem teilweisen Abgleichsvorgang. |
|
|
Werte
|
values | array of string | ||
|
Regel
|
rule | string |
Gibt an, ob ein Kundenprofil, das den Filterkriterien entspricht, in das Ergebnis aufgenommen oder vom Ergebnis ausgeschlossen werden soll. |
|
|
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. |
|
|
All
|
all | array of string | ||
|
Feld
|
field | string |
Verwenden Sie ein oder mehrere Kundenattribute als Sortierschlüssel, um durchsuchte Kundenprofile zu sortieren. |
|
|
Bestellung
|
order | string |
Gibt die Reihenfolge an, in der Ergebnisse basierend auf dem Sortierfeldwert sortiert werden sollen. Zeichenfolgen verwenden einen standardmäßigen alphabetischen Vergleich, um die Reihenfolge zu bestimmen. |
|
|
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 |
|---|---|---|---|
|
Kundschaft
|
customers | array of object | |
|
ID
|
customers.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Erstellt unter
|
customers.created_at | string |
Die Ereigniszeit im ISO 8601-Format. |
|
Aktualisiert unter
|
customers.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Vorname
|
customers.given_name | string |
Der angegebene (d. h. Vorname), der dem Kundenprofil zugeordnet ist. |
|
Familienname
|
customers.family_name | string |
Der Familienname (d. h. Nachname), der dem Kundenprofil zugeordnet ist. |
|
E-Mail-Adresse
|
customers.email_address | string |
Die E-Mail-Adresse, die dem Kundenprofil zugeordnet ist. |
|
Adresszeile 1
|
customers.address.address_line_1 | string |
Die erste Zeile der Adresse. |
|
Adresszeile 2
|
customers.address.address_line_2 | string |
Die zweite Zeile der Adresse( falls vorhanden). |
|
Örtlichkeit
|
customers.address.locality | string |
Die Stadt oder Die Stadt der Adresse. |
|
VerwaltungsbezirkSebene 1
|
customers.address.administrative_district_level_1 | string |
Eine zivile Person im Land der Adresse. In den USA ist dies der Staat. |
|
Postleitzahl
|
customers.address.postal_code | string |
Die Postleitzahl der Adresse. |
|
Country
|
customers.address.country | string |
Das Land der Adresse im ISO 3166-1-Alpha-2-Format. |
|
Rufnummer
|
customers.phone_number | string |
Die 11-stellige Telefonnummer, die dem Kundenprofil zugeordnet ist. |
|
Referenz-ID
|
customers.reference_id | string |
Eine optionale zweite ID, die verwendet wird, um das Kundenprofil einer Entität in einem anderen System zuzuordnen. |
|
E-Mail-Abonnement gekündigt
|
customers.preferences.email_unsubscribed | boolean |
Gibt an, ob der Kunde das Abonnement von Marketingkampagnen-E-Mails abbestellt hat. Der Wert "true" bedeutet, dass der Kunde sich entschieden hat, E-Mail-Marketing vom aktuellen Square-Verkäufer oder von allen Square-Verkäufern zu deaktivieren. Dieser Wert ist schreibgeschützt aus der Kunden-API. |
|
Erstellungsquelle
|
customers.creation_source | string |
Eine Erstellungsquelle stellt die Methode dar, die zum Erstellen des Kundenprofils verwendet wird. |
|
Gruppen-IDs
|
customers.group_ids | array of string | |
|
Segment-IDs
|
customers.segment_ids | array of string | |
|
Version
|
customers.version | integer |
Die aktuelle Version des Objekts. |
|
Hinweis
|
customers.note | string |
Eine benutzerdefinierte Notiz, 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. |
Kundengruppe abrufen
Ruft eine bestimmte Kundengruppe ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Gruppen-ID
|
group_id | True | string |
Der Bezeichner der Gruppe. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
group.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Name
|
group.name | string |
Der Name des Objekts. |
|
Erstellt unter
|
group.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
group.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
Kundengruppe aktualisieren
Aktualisiert eine Kundengruppe.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Gruppen-ID
|
group_id | True | string |
Der Bezeichner der Gruppe. |
|
Name
|
name | string |
Der Name des Objekts. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
group.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Name
|
group.name | string |
Der Name des Objekts. |
|
Erstellt unter
|
group.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
group.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
Kundengruppe erstellen
Erstellt eine neue Kundengruppe für ein Unternehmen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | string |
Der Name des Objekts. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
group.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Name
|
group.name | string |
Der Name des Objekts. |
|
Erstellt unter
|
group.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
group.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
Kundengruppe löschen
Löscht eine Kundengruppe gemäß der Identifizierung durch den wert group_id.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Gruppen-ID
|
group_id | True | string |
Der Bezeichner der Gruppe. |
Gibt zurück
- response
- object
Kundengruppen auflisten
Ruft die Liste der Kundengruppen eines Unternehmens ab.
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gruppen
|
groups | array of object | |
|
ID
|
groups.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Name
|
groups.name | string |
Der Name des Objekts. |
|
Erstellt unter
|
groups.created_at | string |
Die Ereigniszeit im ISO 8601-Format. |
|
Aktualisiert unter
|
groups.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
Kundensegmente auflisten
Ruft die Liste der Kundensegmente eines Unternehmens ab.
Parameter
| Name | Schlüssel | Erforderlich | 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. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Segmente
|
segments | array of object | |
|
ID
|
segments.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Name
|
segments.name | string |
Der Name des Objekts. |
|
Erstellt unter
|
segments.created_at | string |
Die Ereigniszeit im ISO 8601-Format. |
|
Aktualisiert unter
|
segments.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
Kündigen eines Abonnements
Legt das feld canceled_date auf das Ende des aktiven Abrechnungszeitraums fest. Nach diesem Datum ändert sich der Status von ACTIVE in CANCELED.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Abonnement-ID
|
subscription_id | True | string |
Der Bezeichner des Abonnements. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
subscription.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Speicherort-ID
|
subscription.location_id | string |
Der Bezeichner des Speicherorts. |
|
Plan-ID
|
subscription.plan_id | string |
Die ID des zugehörigen Abonnementplans. |
|
Kunden-ID
|
subscription.customer_id | string |
Die ID dieses Objekts, das den Kunden darstellt. |
|
Kartenkennung
|
subscription.card_id | string |
Die ID der Kundenkarte, die für das Abonnement belastet wird. |
|
Startdatum
|
subscription.start_date | string |
Das Startdatum des Abonnements im Format JJJJ-MM-DD. |
|
Abgebrochenes Datum
|
subscription.canceled_date | string |
Das Abonnementabbruchdatum im Format JJJJ-MM-DD. |
|
Auszahlung bis Datum
|
subscription.paid_until_date | string |
Das Datum, das bis zu zahlen ist. |
|
Der Status
|
subscription.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Erstellt unter
|
subscription.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Version
|
subscription.version | integer |
Die aktuelle Version dieses Objekts. |
|
Timezone
|
subscription.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. |
|
Name
|
subscription.source.name | string |
Der Name. |
Listenkatalog
Gibt eine Liste von CatalogObjects zurück, die alle Objekte einer Gruppe von gewünschten Typen (z. B. alle CatalogItem- und CatalogTax-Objekte) im Katalog enthält. ListCatalog gibt keine gelöschten Katalogelemente 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. |
|
|
Typen
|
types | string |
Eine optionale, durch Trennzeichen getrennte Liste der abzurufenden Objekttypen. Die gültigen Werte werden in der CatalogObjectType-Enumeration definiert, einschließlich ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST oder IMAGE. Wenn dies nicht angegeben ist, gibt der Vorgang Objekte aller Typen in der Version der Square-API zurück, die für die Anforderung verwendet wird. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Objekte
|
objects | array of object | |
|
Typ
|
objects.type | string |
Der Typ dieses Objekts. |
|
ID
|
objects.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Aktualisiert unter
|
objects.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Version
|
objects.version | integer |
Die aktuelle Version des Objekts. |
|
Ist gelöscht
|
objects.is_deleted | boolean |
Wenn true, wurde das Objekt aus der Datenbank gelöscht. Muss falsch sein, damit neue Objekte eingefügt werden. Beim Löschen entspricht das Feld updated_at der Löschzeit. |
|
An allen Standorten vorhanden
|
objects.present_at_all_locations | boolean |
Ist "true", ist dieses Objekt an allen Speicherorten (einschließlich zukünftiger Speicherorte) vorhanden, außer wenn es im Feld absent_at_location_ids angegeben ist. Ist "false" angegeben, ist dieses Objekt an keiner Stelle (einschließlich zukünftiger Speicherorte) vorhanden, es sei denn, es wird im Feld present_at_location_ids angegeben. Wenn nicht angegeben, wird der Standardwert auf "true" festgelegt. |
|
Name
|
objects.category_data.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. |
|
Name
|
objects.tax_data.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. |
|
Berechnungsphase
|
objects.tax_data.calculation_phase | string |
Gibt an, ob die Steuer basierend auf dem Teilergebnis oder der Summe einer Zahlung berechnet wird. |
|
Inklusionstyp
|
objects.tax_data.inclusion_type | string |
Ob die Steuer ADDITIVE oder INCLUSIVE ist. |
|
Prozentsatz
|
objects.tax_data.percentage | string |
Der Prozentsatz in dezimaler Form, wobei ein "." als Dezimaltrennzeichen und ohne "%" Zeichen verwendet wird. Der Wert 7,5 entspricht 7,5%. |
|
Enabled
|
objects.tax_data.enabled | boolean |
Gibt an, ob ein Objekt verwendet werden kann. |
Löschen von Beweismitteln für Streitigkeiten
Entfernt angegebene Beweise aus einer Streitigkeit.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Streitbeilegungs-ID
|
dispute_id | True | string |
Der Bezeichner des Streits. |
|
Nachweis-ID
|
evidence_id | True | string |
Der Bezeichner des Nachweises. |
Gibt zurück
- response
- object
Nachweise einreichen
Übermittelt Nachweise an die Bank des Karteninhabers. Vor der Einreichung von Beweisen kompiliert Square alle verfügbaren Beweise. Dies umfasst Nachweise, die mithilfe der CreateDisputeEvidenceFile- und CreateDisputeEvidenceText-Endpunkte hochgeladen wurden, und Nachweise, die automatisch von Square bereitgestellt werden, sofern verfügbar.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Streitbeilegungs-ID
|
dispute_id | True | string |
Der Bezeichner des Streits. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
dispute.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Betrag
|
dispute.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
dispute.amount_money.currency | string |
Die Währung. |
|
Ursache
|
dispute.reason | string |
Der Grund für dieses Objekt. |
|
Staat
|
dispute.state | string |
Der aktuelle Zustand. |
|
Fällig bei
|
dispute.due_at | string |
Der Zeitpunkt, zu dem die nächste Aktion fällig ist, im RFC 3339-Format. |
|
Umstrittene Zahlungen
|
dispute.disputed_payments | array of object | |
|
Zahlungs-ID
|
dispute.disputed_payments.payment_id | string |
Square-generierte eindeutige ID der Zahlung. |
|
Kartenmarke
|
dispute.card_brand | string |
Die Marke der Karte. |
|
Erstellt unter
|
dispute.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
dispute.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Markenstreit-ID
|
dispute.brand_dispute_id | string |
Die ID des Streits im Kartenmarkensystem, generiert von der Kartenmarke. |
Rechnung abrufen
Ruft eine Rechnung anhand der Rechnungs-ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Rechnungskennung
|
invoice_id | True | string |
Der Bezeichner der Rechnung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
invoice.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Version
|
invoice.version | integer |
Die aktuelle Version dieses Objekts. |
|
Speicherort-ID
|
invoice.location_id | string |
Der Bezeichner des Speicherorts. |
|
Auftrags-ID
|
invoice.order_id | string |
Die ID der Bestellung. |
|
Zahlungsanforderungen
|
invoice.payment_requests | array of object | |
|
UID
|
invoice.payment_requests.uid | string |
Die quadratisch generierte ID. |
|
Anforderungstyp
|
invoice.payment_requests.request_type | string |
Gibt den Zahlungsanforderungstyp an. Dieser Typ definiert, wie der Zahlungsanforderungsbetrag bestimmt wird. |
|
Fälligkeitsdatum
|
invoice.payment_requests.due_date | string |
Das Fälligkeitsdatum für die Zahlungsanforderung im Format JJJJ-MM-DD. |
|
Tippsteuerung aktiviert
|
invoice.payment_requests.tipping_enabled | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird ein Ort bereitgestellt, an dem der Kunde einen Tipp bezahlen kann. |
|
Erinnerungen
|
invoice.payment_requests.reminders | array of object | |
|
UID
|
invoice.payment_requests.reminders.uid | string |
Eine quadratische ID. |
|
Relative geplante Tage
|
invoice.payment_requests.reminders.relative_scheduled_days | integer |
Die Anzahl der Tage vor (negativer Zahl) oder nach (einer positiven Zahl) due_date, wenn die Erinnerung gesendet wird. |
|
Nachricht
|
invoice.payment_requests.reminders.message | string |
Die Nachricht. |
|
Der Status
|
invoice.payment_requests.reminders.status | string |
Der aktuelle Status. |
|
Betrag
|
invoice.payment_requests.computed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoice.payment_requests.computed_amount_money.currency | string |
Die Währung. |
|
Betrag
|
invoice.payment_requests.total_completed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoice.payment_requests.total_completed_amount_money.currency | string |
Die Währung. |
|
Automatische Zahlungsquelle
|
invoice.payment_requests.automatic_payment_source | string |
Die Zahlungsmethode für eine automatische Zahlung. |
|
Rechnungsnummer
|
invoice.invoice_number | string |
Eine benutzerfreundliche Rechnungsnummer. Der Wert ist innerhalb eines Speicherorts eindeutig. Wenn beim Erstellen einer Rechnung nicht angegeben wird, weist Square einen Wert zu. |
|
Title
|
invoice.title | string |
Der Titel. |
|
Description
|
invoice.description | string |
Die Beschreibung. |
|
Geplant am
|
invoice.scheduled_at | string |
Der Zeitstempel beim Planen der Verarbeitung im RFC 3339-Format. |
|
Der Status
|
invoice.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Timezone
|
invoice.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. |
|
Erstellt unter
|
invoice.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
invoice.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Kunden-ID
|
invoice.primary_recipient.customer_id | string |
Die ID des Kunden, der der Bestellung zugeordnet ist. |
|
Vorname
|
invoice.primary_recipient.given_name | string |
Der angegebene Name des Empfängers (d. h. Vorname). |
|
Familienname
|
invoice.primary_recipient.family_name | string |
Die Familie des Empfängers (d. h. Nachname). |
|
E-Mail-Adresse
|
invoice.primary_recipient.email_address | string |
Die E-Mail-Adresse des Empfängers. |
|
Rufnummer
|
invoice.primary_recipient.phone_number | string |
Die Telefonnummer des Empfängers. |
|
Card
|
invoice.accepted_payment_methods.card | boolean |
Gibt an, ob Kreditkarten- oder Debitkartenzahlungen akzeptiert werden. |
|
Quadratische Geschenkkarte
|
invoice.accepted_payment_methods.square_gift_card | boolean |
Gibt an, ob Square-Geschenkkartenzahlungen akzeptiert werden. |
|
Bankkonto
|
invoice.accepted_payment_methods.bank_account | boolean |
Gibt an, ob Überweisungszahlungen akzeptiert werden. |
|
Benutzerdefinierte Felder
|
invoice.custom_fields | array of object | |
|
Etikett
|
invoice.custom_fields.label | string |
Die Beschriftung oder der Titel des benutzerdefinierten Felds. |
|
Wert
|
invoice.custom_fields.value | string |
Der Text des benutzerdefinierten Felds. |
|
Platzierung
|
invoice.custom_fields.placement | string |
Die Position des benutzerdefinierten Felds auf der Rechnung. |
|
Übermittlungsmethode
|
invoice.delivery_method | string |
Die Liefermethode, die Square verwendet, um die Rechnung, Erinnerungen und Belege an den Kunden zu senden. Nach der Veröffentlichung der Rechnung verarbeitet Square die Rechnung basierend auf der Liefermethode und den Zahlungsanforderungseinstellungen, entweder sofort oder am scheduled_at Datum, sofern angegeben. |
|
Verkaufs- oder Servicedatum
|
invoice.sale_or_service_date | string |
Das Datum des Verkaufs oder das Datum, an dem der Dienst gerendert wird, im Format JJJJ-MM-DD. Dieses Feld kann verwendet werden, um ein vergangenes oder zukünftiges Datum anzugeben, das auf der Rechnung angezeigt wird. |
Rechnung aktualisieren
Aktualisiert eine Rechnung durch Ändern von Feldern, Löschen von Feldern oder beides.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Rechnungskennung
|
invoice_id | True | string |
Der Bezeichner der Rechnung. |
|
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. |
|
|
UID
|
uid | string |
Die quadratisch generierte ID. |
|
|
Tippsteuerung aktiviert
|
tipping_enabled | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird ein Ort bereitgestellt, an dem der Kunde einen Tipp bezahlen kann. |
|
|
Zu löschende Felder
|
fields_to_clear | array of string |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
invoice.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Version
|
invoice.version | integer |
Die aktuelle Version dieses Objekts. |
|
Speicherort-ID
|
invoice.location_id | string |
Der Bezeichner des Speicherorts. |
|
Auftrags-ID
|
invoice.order_id | string |
Die ID der Bestellung. |
|
Zahlungsanforderungen
|
invoice.payment_requests | array of object | |
|
UID
|
invoice.payment_requests.uid | string |
Die quadratisch generierte ID. |
|
Anforderungstyp
|
invoice.payment_requests.request_type | string |
Gibt den Zahlungsanforderungstyp an. Dieser Typ definiert, wie der Zahlungsanforderungsbetrag bestimmt wird. |
|
Fälligkeitsdatum
|
invoice.payment_requests.due_date | string |
Das Fälligkeitsdatum für die Zahlungsanforderung im Format JJJJ-MM-DD. |
|
Tippsteuerung aktiviert
|
invoice.payment_requests.tipping_enabled | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird ein Ort bereitgestellt, an dem der Kunde einen Tipp bezahlen kann. |
|
Betrag
|
invoice.payment_requests.computed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoice.payment_requests.computed_amount_money.currency | string |
Die Währung. |
|
Betrag
|
invoice.payment_requests.total_completed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoice.payment_requests.total_completed_amount_money.currency | string |
Die Währung. |
|
Automatische Zahlungsquelle
|
invoice.payment_requests.automatic_payment_source | string |
Die Zahlungsmethode für eine automatische Zahlung. |
|
Rechnungsnummer
|
invoice.invoice_number | string |
Eine benutzerfreundliche Rechnungsnummer. Der Wert ist innerhalb eines Speicherorts eindeutig. Wenn beim Erstellen einer Rechnung nicht angegeben wird, weist Square einen Wert zu. |
|
Title
|
invoice.title | string |
Der Titel. |
|
Description
|
invoice.description | string |
Die Beschreibung. |
|
Geplant am
|
invoice.scheduled_at | string |
Der Zeitstempel beim Planen der Verarbeitung im RFC 3339-Format. |
|
Der Status
|
invoice.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Timezone
|
invoice.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. |
|
Erstellt unter
|
invoice.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
invoice.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Kunden-ID
|
invoice.primary_recipient.customer_id | string |
Die ID des Kunden, der der Bestellung zugeordnet ist. |
|
Vorname
|
invoice.primary_recipient.given_name | string |
Der angegebene Name des Empfängers (d. h. Vorname). |
|
Familienname
|
invoice.primary_recipient.family_name | string |
Die Familie des Empfängers (d. h. Nachname). |
|
E-Mail-Adresse
|
invoice.primary_recipient.email_address | string |
Die E-Mail-Adresse des Empfängers. |
|
Rufnummer
|
invoice.primary_recipient.phone_number | string |
Die Telefonnummer des Empfängers. |
|
Betrag
|
invoice.next_payment_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoice.next_payment_amount_money.currency | string |
Die Währung. |
|
Card
|
invoice.accepted_payment_methods.card | boolean |
Gibt an, ob Kreditkarten- oder Debitkartenzahlungen akzeptiert werden. |
|
Quadratische Geschenkkarte
|
invoice.accepted_payment_methods.square_gift_card | boolean |
Gibt an, ob Square-Geschenkkartenzahlungen akzeptiert werden. |
|
Bankkonto
|
invoice.accepted_payment_methods.bank_account | boolean |
Gibt an, ob Überweisungszahlungen akzeptiert werden. |
|
Benutzerdefinierte Felder
|
invoice.custom_fields | array of object | |
|
Etikett
|
invoice.custom_fields.label | string |
Die Beschriftung oder der Titel des benutzerdefinierten Felds. |
|
Wert
|
invoice.custom_fields.value | string |
Der Text des benutzerdefinierten Felds. |
|
Platzierung
|
invoice.custom_fields.placement | string |
Die Position des benutzerdefinierten Felds auf der Rechnung. |
|
Übermittlungsmethode
|
invoice.delivery_method | string |
Die Liefermethode, die Square verwendet, um die Rechnung, Erinnerungen und Belege an den Kunden zu senden. Nach der Veröffentlichung der Rechnung verarbeitet Square die Rechnung basierend auf der Liefermethode und den Zahlungsanforderungseinstellungen, entweder sofort oder am scheduled_at Datum, sofern angegeben. |
|
Verkaufs- oder Servicedatum
|
invoice.sale_or_service_date | string |
Das Datum des Verkaufs oder das Datum, an dem der Dienst gerendert wird, im Format JJJJ-MM-DD. Dieses Feld kann verwendet werden, um ein vergangenes oder zukünftiges Datum anzugeben, das auf der Rechnung angezeigt wird. |
Rechnung erstellen
Erstellt einen Rechnungsentwurf für einen Auftrag, der mithilfe der Orders-API erstellt wurde. Ein Rechnungsentwurf verbleibt in Ihrem Konto, und es wird keine Aktion ausgeführt. Sie müssen die Rechnung veröffentlichen, bevor Square sie verarbeiten kann (senden Sie sie an die E-Mail-Adresse des Kunden oder berechnen Sie die Karte des Kunden in der Datei).
Parameter
| Name | Schlüssel | Erforderlich | 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. |
|
|
Auftrags-ID
|
order_id | string |
Die ID der Bestellung. |
|
|
Geplant am
|
scheduled_at | string |
Der Zeitstempel beim Planen der Verarbeitung im RFC 3339-Format. |
|
|
Kunden-ID
|
customer_id | string |
Die ID des Kunden, der der Bestellung zugeordnet ist. |
|
|
Übermittlungsmethode
|
delivery_method | string |
Die Liefermethode, die Square verwendet, um die Rechnung, Erinnerungen und Belege an den Kunden zu senden. Nach der Veröffentlichung der Rechnung verarbeitet Square die Rechnung basierend auf der Liefermethode und den Zahlungsanforderungseinstellungen, entweder sofort oder am scheduled_at Datum, sofern angegeben. |
|
|
Anforderungstyp
|
request_type | string |
Gibt den Zahlungsanforderungstyp an. Dieser Typ definiert, wie der Zahlungsanforderungsbetrag bestimmt wird. |
|
|
Fälligkeitsdatum
|
due_date | string |
Das Fälligkeitsdatum für die Zahlungsanforderung im Format JJJJ-MM-DD. |
|
|
Tippsteuerung aktiviert
|
tipping_enabled | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird ein Ort bereitgestellt, an dem der Kunde einen Tipp bezahlen kann. |
|
|
Automatische Zahlungsquelle
|
automatic_payment_source | string |
Die Zahlungsmethode für eine automatische Zahlung. |
|
|
Nachricht
|
message | string |
Die Nachricht. |
|
|
Relative geplante Tage
|
relative_scheduled_days | integer |
Die Anzahl der Tage vor (negativer Zahl) oder nach (einer positiven Zahl) due_date, wenn die Erinnerung gesendet wird. |
|
|
Rechnungsnummer
|
invoice_number | string |
Eine benutzerfreundliche Rechnungsnummer. Der Wert ist innerhalb eines Speicherorts eindeutig. Wenn beim Erstellen einer Rechnung nicht angegeben wird, weist Square einen Wert zu. |
|
|
Title
|
title | string |
Der Titel. |
|
|
Description
|
description | string |
Die Beschreibung. |
|
|
Card
|
card | boolean |
Gibt an, ob Kreditkarten- oder Debitkartenzahlungen akzeptiert werden. |
|
|
Quadratische Geschenkkarte
|
square_gift_card | boolean |
Gibt an, ob Square-Geschenkkartenzahlungen akzeptiert werden. |
|
|
Bankkonto
|
bank_account | boolean |
Gibt an, ob Überweisungszahlungen akzeptiert werden. |
|
|
Etikett
|
label | string |
Die Beschriftung oder der Titel des benutzerdefinierten Felds. |
|
|
Wert
|
value | string |
Der Text des benutzerdefinierten Felds. |
|
|
Platzierung
|
placement | string |
Die Position des benutzerdefinierten Felds auf der Rechnung. |
|
|
Verkaufs- oder Servicedatum
|
sale_or_service_date | string |
Das Datum des Verkaufs oder das Datum, an dem der Dienst gerendert wird, im Format JJJJ-MM-DD. Dieses Feld kann verwendet werden, um ein vergangenes oder zukünftiges Datum anzugeben, das auf der Rechnung angezeigt wird. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
invoice.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Version
|
invoice.version | integer |
Die aktuelle Version dieses Objekts. |
|
Speicherort-ID
|
invoice.location_id | string |
Der Bezeichner des Speicherorts. |
|
Auftrags-ID
|
invoice.order_id | string |
Die ID der Bestellung. |
|
Zahlungsanforderungen
|
invoice.payment_requests | array of object | |
|
UID
|
invoice.payment_requests.uid | string |
Die quadratisch generierte ID. |
|
Anforderungstyp
|
invoice.payment_requests.request_type | string |
Gibt den Zahlungsanforderungstyp an. Dieser Typ definiert, wie der Zahlungsanforderungsbetrag bestimmt wird. |
|
Fälligkeitsdatum
|
invoice.payment_requests.due_date | string |
Das Fälligkeitsdatum für die Zahlungsanforderung im Format JJJJ-MM-DD. |
|
Tippsteuerung aktiviert
|
invoice.payment_requests.tipping_enabled | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird ein Ort bereitgestellt, an dem der Kunde einen Tipp bezahlen kann. |
|
Erinnerungen
|
invoice.payment_requests.reminders | array of object | |
|
UID
|
invoice.payment_requests.reminders.uid | string |
Eine quadratische ID. |
|
Relative geplante Tage
|
invoice.payment_requests.reminders.relative_scheduled_days | integer |
Die Anzahl der Tage vor (negativer Zahl) oder nach (einer positiven Zahl) due_date, wenn die Erinnerung gesendet wird. |
|
Nachricht
|
invoice.payment_requests.reminders.message | string |
Die Nachricht. |
|
Der Status
|
invoice.payment_requests.reminders.status | string |
Der aktuelle Status. |
|
Betrag
|
invoice.payment_requests.computed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoice.payment_requests.computed_amount_money.currency | string |
Die Währung. |
|
Betrag
|
invoice.payment_requests.total_completed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoice.payment_requests.total_completed_amount_money.currency | string |
Die Währung. |
|
Automatische Zahlungsquelle
|
invoice.payment_requests.automatic_payment_source | string |
Die Zahlungsmethode für eine automatische Zahlung. |
|
Rechnungsnummer
|
invoice.invoice_number | string |
Eine benutzerfreundliche Rechnungsnummer. Der Wert ist innerhalb eines Speicherorts eindeutig. Wenn beim Erstellen einer Rechnung nicht angegeben wird, weist Square einen Wert zu. |
|
Title
|
invoice.title | string |
Der Titel. |
|
Description
|
invoice.description | string |
Die Beschreibung. |
|
Geplant am
|
invoice.scheduled_at | string |
Der Zeitstempel beim Planen der Verarbeitung im RFC 3339-Format. |
|
Der Status
|
invoice.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Timezone
|
invoice.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. |
|
Erstellt unter
|
invoice.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
invoice.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Kunden-ID
|
invoice.primary_recipient.customer_id | string |
Die ID des Kunden, der der Bestellung zugeordnet ist. |
|
Vorname
|
invoice.primary_recipient.given_name | string |
Der angegebene Name des Empfängers (d. h. Vorname). |
|
Familienname
|
invoice.primary_recipient.family_name | string |
Die Familie des Empfängers (d. h. Nachname). |
|
E-Mail-Adresse
|
invoice.primary_recipient.email_address | string |
Die E-Mail-Adresse des Empfängers. |
|
Rufnummer
|
invoice.primary_recipient.phone_number | string |
Die Telefonnummer des Empfängers. |
|
Card
|
invoice.accepted_payment_methods.card | boolean |
Gibt an, ob Kreditkarten- oder Debitkartenzahlungen akzeptiert werden. |
|
Quadratische Geschenkkarte
|
invoice.accepted_payment_methods.square_gift_card | boolean |
Gibt an, ob Square-Geschenkkartenzahlungen akzeptiert werden. |
|
Bankkonto
|
invoice.accepted_payment_methods.bank_account | boolean |
Gibt an, ob Überweisungszahlungen akzeptiert werden. |
|
Benutzerdefinierte Felder
|
invoice.custom_fields | array of object | |
|
Etikett
|
invoice.custom_fields.label | string |
Die Beschriftung oder der Titel des benutzerdefinierten Felds. |
|
Wert
|
invoice.custom_fields.value | string |
Der Text des benutzerdefinierten Felds. |
|
Platzierung
|
invoice.custom_fields.placement | string |
Die Position des benutzerdefinierten Felds auf der Rechnung. |
|
Übermittlungsmethode
|
invoice.delivery_method | string |
Die Liefermethode, die Square verwendet, um die Rechnung, Erinnerungen und Belege an den Kunden zu senden. Nach der Veröffentlichung der Rechnung verarbeitet Square die Rechnung basierend auf der Liefermethode und den Zahlungsanforderungseinstellungen, entweder sofort oder am scheduled_at Datum, sofern angegeben. |
|
Verkaufs- oder Servicedatum
|
invoice.sale_or_service_date | string |
Das Datum des Verkaufs oder das Datum, an dem der Dienst gerendert wird, im Format JJJJ-MM-DD. Dieses Feld kann verwendet werden, um ein vergangenes oder zukünftiges Datum anzugeben, das auf der Rechnung angezeigt wird. |
Rechnung löschen
Löscht die angegebene Rechnung. Wenn eine Rechnung gelöscht wird, ändert sich der zugeordnete Bestellstatus in CANCELED. Sie können nur einen Rechnungsentwurf löschen (Sie können keine veröffentlichte Rechnung löschen, einschließlich einer, die für die Verarbeitung geplant ist).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Rechnungskennung
|
invoice_id | True | string |
Der Bezeichner der Rechnung. |
|
Version
|
version | integer |
Die Zu löschende Version der Rechnung. |
Gibt zurück
- response
- object
Rechnung stornieren
Storniert eine Rechnung. Der Verkäufer kann keine Zahlungen für die stornierte Rechnung erheben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Rechnungskennung
|
invoice_id | True | string |
Der Bezeichner der Rechnung. |
|
Version
|
version | integer |
Die Version. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
invoice.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Version
|
invoice.version | integer |
Die aktuelle Version dieses Objekts. |
|
Speicherort-ID
|
invoice.location_id | string |
Der Bezeichner des Speicherorts. |
|
Auftrags-ID
|
invoice.order_id | string |
Die ID der Bestellung. |
|
Zahlungsanforderungen
|
invoice.payment_requests | array of object | |
|
UID
|
invoice.payment_requests.uid | string |
Die quadratisch generierte ID. |
|
Anforderungstyp
|
invoice.payment_requests.request_type | string |
Gibt den Zahlungsanforderungstyp an. Dieser Typ definiert, wie der Zahlungsanforderungsbetrag bestimmt wird. |
|
Fälligkeitsdatum
|
invoice.payment_requests.due_date | string |
Das Fälligkeitsdatum für die Zahlungsanforderung im Format JJJJ-MM-DD. |
|
Tippsteuerung aktiviert
|
invoice.payment_requests.tipping_enabled | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird ein Ort bereitgestellt, an dem der Kunde einen Tipp bezahlen kann. |
|
Erinnerungen
|
invoice.payment_requests.reminders | array of object | |
|
UID
|
invoice.payment_requests.reminders.uid | string |
Eine quadratische ID. |
|
Relative geplante Tage
|
invoice.payment_requests.reminders.relative_scheduled_days | integer |
Die Anzahl der Tage vor (negativer Zahl) oder nach (einer positiven Zahl) due_date, wenn die Erinnerung gesendet wird. |
|
Nachricht
|
invoice.payment_requests.reminders.message | string |
Die Nachricht. |
|
Der Status
|
invoice.payment_requests.reminders.status | string |
Der aktuelle Status. |
|
Betrag
|
invoice.payment_requests.computed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoice.payment_requests.computed_amount_money.currency | string |
Die Währung. |
|
Betrag
|
invoice.payment_requests.total_completed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoice.payment_requests.total_completed_amount_money.currency | string |
Die Währung. |
|
Automatische Zahlungsquelle
|
invoice.payment_requests.automatic_payment_source | string |
Die Zahlungsmethode für eine automatische Zahlung. |
|
Rechnungsnummer
|
invoice.invoice_number | string |
Eine benutzerfreundliche Rechnungsnummer. Der Wert ist innerhalb eines Speicherorts eindeutig. Wenn beim Erstellen einer Rechnung nicht angegeben wird, weist Square einen Wert zu. |
|
Title
|
invoice.title | string |
Der Titel. |
|
Description
|
invoice.description | string |
Die Beschreibung. |
|
Geplant am
|
invoice.scheduled_at | string |
Der Zeitstempel beim Planen der Verarbeitung im RFC 3339-Format. |
|
Der Status
|
invoice.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Timezone
|
invoice.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. |
|
Erstellt unter
|
invoice.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
invoice.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Kunden-ID
|
invoice.primary_recipient.customer_id | string |
Die ID des Kunden, der der Bestellung zugeordnet ist. |
|
Vorname
|
invoice.primary_recipient.given_name | string |
Der angegebene Name des Empfängers (d. h. Vorname). |
|
Familienname
|
invoice.primary_recipient.family_name | string |
Die Familie des Empfängers (d. h. Nachname). |
|
E-Mail-Adresse
|
invoice.primary_recipient.email_address | string |
Die E-Mail-Adresse des Empfängers. |
|
Rufnummer
|
invoice.primary_recipient.phone_number | string |
Die Telefonnummer des Empfängers. |
|
Card
|
invoice.accepted_payment_methods.card | boolean |
Gibt an, ob Kreditkarten- oder Debitkartenzahlungen akzeptiert werden. |
|
Quadratische Geschenkkarte
|
invoice.accepted_payment_methods.square_gift_card | boolean |
Gibt an, ob Square-Geschenkkartenzahlungen akzeptiert werden. |
|
Bankkonto
|
invoice.accepted_payment_methods.bank_account | boolean |
Gibt an, ob Überweisungszahlungen akzeptiert werden. |
|
Benutzerdefinierte Felder
|
invoice.custom_fields | array of object | |
|
Etikett
|
invoice.custom_fields.label | string |
Die Beschriftung oder der Titel des benutzerdefinierten Felds. |
|
Wert
|
invoice.custom_fields.value | string |
Der Text des benutzerdefinierten Felds. |
|
Platzierung
|
invoice.custom_fields.placement | string |
Die Position des benutzerdefinierten Felds auf der Rechnung. |
|
Übermittlungsmethode
|
invoice.delivery_method | string |
Die Liefermethode, die Square verwendet, um die Rechnung, Erinnerungen und Belege an den Kunden zu senden. Nach der Veröffentlichung der Rechnung verarbeitet Square die Rechnung basierend auf der Liefermethode und den Zahlungsanforderungseinstellungen, entweder sofort oder am scheduled_at Datum, sofern angegeben. |
|
Verkaufs- oder Servicedatum
|
invoice.sale_or_service_date | string |
Das Datum des Verkaufs oder das Datum, an dem der Dienst gerendert wird, im Format JJJJ-MM-DD. Dieses Feld kann verwendet werden, um ein vergangenes oder zukünftiges Datum anzugeben, das auf der Rechnung angezeigt wird. |
Rechnung veröffentlichen
Veröffentlicht den angegebenen Rechnungsentwurf. Nach der Veröffentlichung einer Rechnung folgt Square basierend auf der Rechnungskonfiguration. Beispielsweise sendet Square die Rechnung an die E-Mail-Adresse des Kunden, berechnet die Karte des Kunden in der Datei oder führt nichts aus. Square stellt die Rechnung auch auf einer square-gehosteten Rechnungsseite zur Verfügung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Rechnungskennung
|
invoice_id | True | string |
Der Bezeichner der Rechnung. |
|
Version
|
version | integer |
Die Version. |
|
|
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
|
invoice.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Version
|
invoice.version | integer |
Die aktuelle Version dieses Objekts. |
|
Speicherort-ID
|
invoice.location_id | string |
Der Bezeichner des Speicherorts. |
|
Auftrags-ID
|
invoice.order_id | string |
Die ID der Bestellung. |
|
Zahlungsanforderungen
|
invoice.payment_requests | array of object | |
|
UID
|
invoice.payment_requests.uid | string |
Die quadratisch generierte ID. |
|
Anforderungstyp
|
invoice.payment_requests.request_type | string |
Gibt den Zahlungsanforderungstyp an. Dieser Typ definiert, wie der Zahlungsanforderungsbetrag bestimmt wird. |
|
Fälligkeitsdatum
|
invoice.payment_requests.due_date | string |
Das Fälligkeitsdatum für die Zahlungsanforderung im Format JJJJ-MM-DD. |
|
Tippsteuerung aktiviert
|
invoice.payment_requests.tipping_enabled | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird ein Ort bereitgestellt, an dem der Kunde einen Tipp bezahlen kann. |
|
Erinnerungen
|
invoice.payment_requests.reminders | array of object | |
|
UID
|
invoice.payment_requests.reminders.uid | string |
Eine quadratische ID. |
|
Relative geplante Tage
|
invoice.payment_requests.reminders.relative_scheduled_days | integer |
Die Anzahl der Tage vor (negativer Zahl) oder nach (einer positiven Zahl) due_date, wenn die Erinnerung gesendet wird. |
|
Nachricht
|
invoice.payment_requests.reminders.message | string |
Die Nachricht. |
|
Der Status
|
invoice.payment_requests.reminders.status | string |
Der aktuelle Status. |
|
Betrag
|
invoice.payment_requests.computed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoice.payment_requests.computed_amount_money.currency | string |
Die Währung. |
|
Betrag
|
invoice.payment_requests.total_completed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoice.payment_requests.total_completed_amount_money.currency | string |
Die Währung. |
|
Automatische Zahlungsquelle
|
invoice.payment_requests.automatic_payment_source | string |
Die Zahlungsmethode für eine automatische Zahlung. |
|
Rechnungsnummer
|
invoice.invoice_number | string |
Eine benutzerfreundliche Rechnungsnummer. Der Wert ist innerhalb eines Speicherorts eindeutig. Wenn beim Erstellen einer Rechnung nicht angegeben wird, weist Square einen Wert zu. |
|
Title
|
invoice.title | string |
Der Titel. |
|
Description
|
invoice.description | string |
Die Beschreibung. |
|
Geplant am
|
invoice.scheduled_at | string |
Der Zeitstempel beim Planen der Verarbeitung im RFC 3339-Format. |
|
Der Status
|
invoice.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Timezone
|
invoice.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. |
|
Erstellt unter
|
invoice.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
invoice.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Kunden-ID
|
invoice.primary_recipient.customer_id | string |
Die ID des Kunden, der der Bestellung zugeordnet ist. |
|
Vorname
|
invoice.primary_recipient.given_name | string |
Der angegebene Name des Empfängers (d. h. Vorname). |
|
Familienname
|
invoice.primary_recipient.family_name | string |
Die Familie des Empfängers (d. h. Nachname). |
|
E-Mail-Adresse
|
invoice.primary_recipient.email_address | string |
Die E-Mail-Adresse des Empfängers. |
|
Rufnummer
|
invoice.primary_recipient.phone_number | string |
Die Telefonnummer des Empfängers. |
|
Öffentliche URL
|
invoice.public_url | string |
Die URL der seite "Quadratgehostete Rechnung". Nachdem Sie die Rechnung mithilfe des PublishInvoice-Endpunkts veröffentlicht haben, hostt Square die Rechnungsseite und gibt die Seiten-URL in der Antwort zurück. |
|
Card
|
invoice.accepted_payment_methods.card | boolean |
Gibt an, ob Kreditkarten- oder Debitkartenzahlungen akzeptiert werden. |
|
Quadratische Geschenkkarte
|
invoice.accepted_payment_methods.square_gift_card | boolean |
Gibt an, ob Square-Geschenkkartenzahlungen akzeptiert werden. |
|
Bankkonto
|
invoice.accepted_payment_methods.bank_account | boolean |
Gibt an, ob Überweisungszahlungen akzeptiert werden. |
|
Benutzerdefinierte Felder
|
invoice.custom_fields | array of object | |
|
Etikett
|
invoice.custom_fields.label | string |
Die Beschriftung oder der Titel des benutzerdefinierten Felds. |
|
Wert
|
invoice.custom_fields.value | string |
Der Text des benutzerdefinierten Felds. |
|
Platzierung
|
invoice.custom_fields.placement | string |
Die Position des benutzerdefinierten Felds auf der Rechnung. |
|
Übermittlungsmethode
|
invoice.delivery_method | string |
Die Liefermethode, die Square verwendet, um die Rechnung, Erinnerungen und Belege an den Kunden zu senden. Nach der Veröffentlichung der Rechnung verarbeitet Square die Rechnung basierend auf der Liefermethode und den Zahlungsanforderungseinstellungen, entweder sofort oder am scheduled_at Datum, sofern angegeben. |
|
Verkaufs- oder Servicedatum
|
invoice.sale_or_service_date | string |
Das Datum des Verkaufs oder das Datum, an dem der Dienst gerendert wird, im Format JJJJ-MM-DD. Dieses Feld kann verwendet werden, um ein vergangenes oder zukünftiges Datum anzugeben, das auf der Rechnung angezeigt wird. |
Rechnungen auflisten
Gibt eine Liste der Rechnungen für einen bestimmten Ort zurück.
Parameter
| Name | Schlüssel | Erforderlich | 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. |
|
|
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. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Invoices
|
invoices | array of object | |
|
ID
|
invoices.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Version
|
invoices.version | integer |
Die aktuelle Version des Objekts. |
|
Speicherort-ID
|
invoices.location_id | string |
Der Bezeichner für den Speicherort. |
|
Auftrags-ID
|
invoices.order_id | string |
Die ID der Bestellung. |
|
Zahlungsanforderungen
|
invoices.payment_requests | array of object | |
|
UID
|
invoices.payment_requests.uid | string |
Die square-generierte ID der Zahlungsanforderung in einer Rechnung. |
|
Anforderungstyp
|
invoices.payment_requests.request_type | string |
Gibt den Zahlungsanforderungstyp an. Dieser Typ definiert, wie der Zahlungsanforderungsbetrag bestimmt wird. |
|
Fälligkeitsdatum
|
invoices.payment_requests.due_date | string |
Das Fälligkeitsdatum (in der Zeitzone der Rechnung) für die Zahlungsanforderung im Format JJJJ-MM-DD. |
|
Tippsteuerung aktiviert
|
invoices.payment_requests.tipping_enabled | boolean |
Wenn dieser Wert auf "true" festgelegt ist, stellt die seite "Quadrat-gehostete Rechnung" (das Feld public_url der Rechnung) einen Ort bereit, an dem der Kunde einen Tipp bezahlen kann. |
|
Erinnerungen
|
invoices.payment_requests.reminders | array of object |
Erinnerungen |
|
UID
|
invoices.payment_requests.reminders.uid | string |
Eine quadratische ID, die die Erinnerung innerhalb der InvoicePaymentRequest eindeutig identifiziert. |
|
Relative geplante Tage
|
invoices.payment_requests.reminders.relative_scheduled_days | integer |
Die Anzahl der Tage vor (negativer Zahl) oder nach (einer positiven Zahl) due_date, wenn die Erinnerung gesendet wird. |
|
Nachricht
|
invoices.payment_requests.reminders.message | string |
Die Erinnerungsnachricht. |
|
Der Status
|
invoices.payment_requests.reminders.status | string |
Der Status der Erinnerung. |
|
Betrag
|
invoices.payment_requests.computed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoices.payment_requests.computed_amount_money.currency | string |
Die Währung. |
|
Betrag
|
invoices.payment_requests.total_completed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoices.payment_requests.total_completed_amount_money.currency | string |
Die Währung. |
|
Automatische Zahlungsquelle
|
invoices.payment_requests.automatic_payment_source | string |
Die Zahlungsmethode für eine automatische Zahlung. |
|
Prozentsatz angefordert
|
invoices.payment_requests.percentage_requested | string |
Gibt den Betrag für die Zahlungsanforderung in Prozent an. |
|
Kartenkennung
|
invoices.payment_requests.card_id | string |
Die ID der Kredit- oder Debitkarte auf der Datei, die für die Zahlungsanforderung belastet werden soll. |
|
Rechnungsnummer
|
invoices.invoice_number | string |
Eine benutzerfreundliche Rechnungsnummer. |
|
Title
|
invoices.title | string |
Der Titel der Rechnung. |
|
Description
|
invoices.description | string |
Die Beschreibung. |
|
Geplant am
|
invoices.scheduled_at | string |
Der Zeitstempel, wenn die Rechnung für die Verarbeitung geplant ist, im RFC 3339-Format. Nach der Veröffentlichung der Rechnung verarbeitet Square die Rechnung am angegebenen Datum gemäß der Liefermethode und den Zahlungsanforderungseinstellungen. |
|
Der Status
|
invoices.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Timezone
|
invoices.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. |
|
Erstellt unter
|
invoices.created_at | string |
Die Ereigniszeit im ISO 8601-Format. |
|
Aktualisiert unter
|
invoices.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Kunden-ID
|
invoices.primary_recipient.customer_id | string |
Die ID eines Kunden, der der Karte zugeordnet werden soll. |
|
Vorname
|
invoices.primary_recipient.given_name | string |
Der angegebene Name des Empfängers (d. h. Vorname). |
|
Familienname
|
invoices.primary_recipient.family_name | string |
Die Familie des Empfängers (d. h. Nachname). |
|
E-Mail-Adresse
|
invoices.primary_recipient.email_address | string |
Die E-Mail-Adresse des Empfängers. |
|
Rufnummer
|
invoices.primary_recipient.phone_number | string |
Die Telefonnummer des Empfängers. |
|
Card
|
invoices.accepted_payment_methods.card | boolean |
Gibt an, ob Kreditkarten- oder Debitkartenzahlungen akzeptiert werden. |
|
Quadratische Geschenkkarte
|
invoices.accepted_payment_methods.square_gift_card | boolean |
Gibt an, ob Square-Geschenkkartenzahlungen akzeptiert werden. |
|
Bankkonto
|
invoices.accepted_payment_methods.bank_account | boolean |
Gibt an, ob Überweisungszahlungen akzeptiert werden. |
|
Benutzerdefinierte Felder
|
invoices.custom_fields | array of object | |
|
Etikett
|
invoices.custom_fields.label | string |
Die Beschriftung oder der Titel des benutzerdefinierten Felds. |
|
Wert
|
invoices.custom_fields.value | string |
Der Text des benutzerdefinierten Felds. |
|
Platzierung
|
invoices.custom_fields.placement | string |
Die Position des benutzerdefinierten Felds auf der Rechnung |
|
Übermittlungsmethode
|
invoices.delivery_method | string |
Die Liefermethode, die Square verwendet, um die Rechnung, Erinnerungen und Belege an den Kunden zu senden. |
|
Verkaufs- oder Servicedatum
|
invoices.sale_or_service_date | string |
Das Datum des Verkaufs oder das Datum, an dem der Dienst gerendert wird, im Format JJJJ-MM-DD. Dieses Feld kann verwendet werden, um ein vergangenes oder zukünftiges Datum anzugeben, das auf der Rechnung angezeigt wird. |
|
Öffentliche URL
|
invoices.public_url | string |
Die URL der seite "Quadratgehostete Rechnung". Nachdem Sie die Rechnung mithilfe des PublishInvoice-Endpunkts veröffentlicht haben, hostt Square die Rechnungsseite und gibt die Seiten-URL in der Antwort zurück. |
|
Betrag
|
invoices.next_payment_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoices.next_payment_amount_money.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. |
Registrieren der Domäne für Apple Pay
Aktiviert eine Domäne für die Verwendung mit Apple Pay im Web und Square. Eine Überprüfung wird von Apple auf dieser Domäne durchgeführt, um sicherzustellen, dass sie ordnungsgemäß als apple Pay-aktivierte Domäne eingerichtet ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Domänenname
|
domain_name | True | string |
Ein Domänenname, wie in RFC-1034 beschrieben, der bei Apple Pay registriert wird. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Der Status
|
status | string |
Der Status der Domänenregistrierung. |
Stornieren der Terminalerstattung
Bricht eine Rückerstattungsanforderung für interac Terminal per Erstattungsanforderungs-ID ab, wenn der Status der Anforderung dies zulässt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
TerminalErstattungs-ID
|
terminal_refund_id | True | string |
Der Bezeichner der Terminalerstattung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
refund.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Zahlungs-ID
|
refund.payment_id | string |
Die eindeutige ID der Zahlung. |
|
Betrag
|
refund.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
refund.amount_money.currency | string |
Die Währung. |
|
Ursache
|
refund.reason | string |
Der Grund für dieses Objekt. |
|
Geräte-ID
|
refund.device_id | string |
Die eindeutige ID des Geräts, das für dieses TerminalRefund vorgesehen ist. |
|
Stichtagsdauer
|
refund.deadline_duration | string |
Eine RFC 3339-Dauer, nach der das Auschecken automatisch abgebrochen wird. Ein TerminalCheckout, das ausstehend ist, wird automatisch ABGEBROCHEN und hat einen Abbruchgrund für TIMED_OUT. Standard: 5 Minuten ab erstellung |
|
Der Status
|
refund.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Grund für 'Abbrechen'
|
refund.cancel_reason | string |
Der Grund für die abgebrochene Transaktion. |
|
Erstellt unter
|
refund.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
refund.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
App-ID
|
refund.app_id | string |
Die ID der Anwendung, die das Auschecken erstellt hat. |
|
Kartenmarke
|
refund.card.card_brand | string |
Die Marke der Karte. |
|
last_4
|
refund.card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Ausdrucksmonat
|
refund.card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Exp Year
|
refund.card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Fingerabdruck
|
refund.card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
Kartentyp
|
refund.card.card_type | string |
Der Typ der Karte. |
|
KASTEN
|
refund.card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als Bank Identification Number (BIN) bezeichnet werden. |
|
Auftrags-ID
|
refund.order_id | string |
Die ID der Bestellung. |
|
Speicherort-ID
|
refund.location_id | string |
Der Bezeichner des Speicherorts. |
Stornieren der Zahlung durch idempotency Key
Bricht eine Zahlung, die durch den in der Anforderung angegebenen idempotency-Schlüssel identifiziert wird, ab (ungültig). Verwenden Sie diese Methode, wenn der Status einer CreatePayment-Anforderung unbekannt ist (z. B. nachdem Sie eine CreatePayment-Anforderung gesendet haben, tritt ein Netzwerkfehler auf und Sie erhalten keine Antwort). In diesem Fall können Sie square per Direct Square zur Kündigung der Zahlung über diesen Endpunkt leiten. In der Anforderung geben Sie den gleichen idempotency-Schlüssel an, den Sie in Ihrer CreatePayment-Anforderung angegeben haben, die Sie abbrechen möchten. Nachdem Sie die Zahlung storniert haben, können Sie Ihre CreatePayment-Anforderung erneut übermitteln. Beachten Sie, dass, wenn keine Zahlung mit dem angegebenen idempotency-Schlüssel gefunden wird, keine Aktion ausgeführt wird und der Endpunkt erfolgreich zurückgegeben wird.
Parameter
| Name | Schlüssel | Erforderlich | 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. |
Gibt zurück
- response
- object
Streitigkeiten auflisten
Gibt eine Liste von Streitigkeiten zurück, die einem bestimmten Konto zugeordnet sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Mauszeiger
|
cursor | string |
Der Paginierungscursor, der von einem vorherigen Aufruf an diesen Endpunkt zurückgegeben wird. |
|
|
Zustände
|
states | string |
Die Streitigkeit gibt an, das Ergebnis zu filtern. Wenn nicht angegeben, gibt der Endpunkt alle offenen Streitigkeiten zurück (der Streitstatus ist nicht INQUIRY_CLOSED, WON oder LOST). |
|
|
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 |
|---|---|---|---|
|
Streitigkeiten
|
disputes | array of object | |
|
ID
|
disputes.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Betrag
|
disputes.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
disputes.amount_money.currency | string |
Die Währung. |
|
Ursache
|
disputes.reason | string |
Der Streitgrund, warum der Karteninhaber den Streit mit seiner Bank eingeleitet hat. |
|
Staat
|
disputes.state | string |
Der aktuelle Zustand. |
|
Fällig bei
|
disputes.due_at | string |
Der Zeitpunkt, zu dem die nächste Aktion fällig ist, im RFC 3339-Format. |
|
Umstrittene Zahlungen
|
disputes.disputed_payments | array of object | |
|
Zahlungs-ID
|
disputes.disputed_payments.payment_id | string |
Quadratisch generierte eindeutige ID der Zahlung, die umstritten ist. |
|
Kartenmarke
|
disputes.card_brand | string |
Die Kartenmarke, die in der umstrittenen Zahlung verwendet wird. |
|
Erstellt unter
|
disputes.created_at | string |
Die Ereigniszeit im ISO 8601-Format. |
|
Aktualisiert unter
|
disputes.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Markenstreit-ID
|
disputes.brand_dispute_id | string |
Die ID des Streits im Kartenmarkensystem, generiert von der Kartenmarke. |
|
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. |
Suchaufträge
Durchsuchen Sie alle Bestellungen nach einem oder mehreren Speicherorten. Bestellungen umfassen alle Verkäufe, Rückgaben und Börsen, unabhängig davon, wie oder wann sie in das Square-Ökosystem eingegeben wurden (z. B. Point of Sale, Rechnungen und Connect-APIs).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Rückgabeeinträge
|
return_entries | boolean |
Ein Boolescher Wert, der das Format der Suchergebnisse steuert. Ist "true", gibt SearchOrders OrderEntry-Objekte zurück. Ist "false", gibt SearchOrders vollständige Order-Objekte zurück. |
|
|
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. |
|
|
Standort-IDs
|
location_ids | array of string | ||
|
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. |
|
|
Zustände
|
states | array of string | ||
|
Sortierfeld
|
sort_field | string |
Das Feld, nach dem sortiert werden soll. |
|
|
Sortierreihenfolge
|
sort_order | string |
Die chronologische Reihenfolge, in der Ergebnisse zurückgegeben werden. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Bestelleinträge
|
order_entries | array of object | |
|
Auftrags-ID
|
order_entries.order_id | string |
Die ID der Bestellung. |
|
Speicherort-ID
|
order_entries.location_id | string |
Der Bezeichner für den Speicherort. |
|
Version
|
order_entries.version | integer |
Die aktuelle Version des Objekts. |
|
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. |
Suchen von Abonnements
Sucht nach Abonnements. Die Ergebnisse werden chronologisch nach Erstellungsdatum des Abonnements sortiert. Wenn die Anforderung mehrere Standort-ID angibt, sortiert der Endpunkt das Ergebnis nach Standort-ID und dann nach Erstellungsdatum innerhalb der einzelnen Standorte. Wenn in der Abfrage keine Speicherorte angegeben werden, werden alle Speicherorte durchsucht.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Standort-IDs
|
location_ids | array of string | ||
|
Kunden-IDs
|
customer_ids | array of string | ||
|
Quellnamen
|
source_names | array of string |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Abonnements
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Speicherort-ID
|
subscriptions.location_id | string |
Der Bezeichner für den Speicherort. |
|
Plan-ID
|
subscriptions.plan_id | string |
Die ID des zugehörigen Abonnementplans |
|
Kunden-ID
|
subscriptions.customer_id | string |
Die quadratische ID des Kunden, der dem Konto zugeordnet ist. |
|
Startdatum
|
subscriptions.start_date | string |
Das Startdatum des Abonnements im Format JJJJ-MM-DD. |
|
Abgebrochenes Datum
|
subscriptions.canceled_date | string |
Das Abonnementabbruchdatum im Format JJJJ-MM-DD. |
|
Berechnet bis Datum
|
subscriptions.charged_through_date | string |
Das Datum, an dem der Kunde für das Abonnement in Rechnung gestellt wird, im Format JJJJ-MM-DD. |
|
Der Status
|
subscriptions.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Erstellt unter
|
subscriptions.created_at | string |
Die Ereigniszeit im ISO 8601-Format. |
|
Kartenkennung
|
subscriptions.card_id | string |
Die ID der Kundenkarte, die für das Abonnement belastet wird. |
|
Auszahlung bis Datum
|
subscriptions.paid_until_date | string |
Das Datum, das bis zu zahlen ist. |
|
Timezone
|
subscriptions.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. |
|
Name
|
subscriptions.source.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. |
|
Steuerprozentsatz
|
subscriptions.tax_percentage | string |
Der Steuerbetrag, der bei der Abrechnung des Abonnements angewendet wird. |
|
Betrag
|
subscriptions.price_override_money.amount | integer |
Der Betrag. |
|
Währung
|
subscriptions.price_override_money.currency | string |
Die Währung. |
|
Version
|
subscriptions.version | integer |
Die aktuelle Version des Objekts. |
|
Rechnungs-IDs
|
subscriptions.invoice_ids | array of string |
Suchen von Rechnungen
Sucht nach Rechnungen von einem Speicherort, der im Filter angegeben ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Standort-IDs
|
location_ids | array of string | ||
|
Kunden-IDs
|
customer_ids | array of string | ||
|
Feld
|
field | string |
Verwenden Sie ein oder mehrere Kundenattribute als Sortierschlüssel, um durchsuchte Kundenprofile zu sortieren. |
|
|
Bestellung
|
order | string |
Gibt die Reihenfolge an, in der Ergebnisse basierend auf dem Sortierfeldwert sortiert werden sollen. Zeichenfolgen verwenden einen standardmäßigen alphabetischen Vergleich, um die Reihenfolge zu bestimmen. |
|
|
Limit
|
limit | integer |
Die maximale Anzahl von Rechnungen, die zurückgegeben werden sollen (200 ist die maximale Grenze). Wenn nicht angegeben, verwendet der Server ein Standardlimit von 100 Rechnungen. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Invoices
|
invoices | array of object | |
|
ID
|
invoices.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Version
|
invoices.version | integer |
Die aktuelle Version des Objekts. |
|
Speicherort-ID
|
invoices.location_id | string |
Der Bezeichner für den Speicherort. |
|
Auftrags-ID
|
invoices.order_id | string |
Die ID der Bestellung. |
|
Zahlungsanforderungen
|
invoices.payment_requests | array of object | |
|
UID
|
invoices.payment_requests.uid | string |
Die square-generierte ID der Zahlungsanforderung in einer Rechnung. |
|
Anforderungstyp
|
invoices.payment_requests.request_type | string |
Gibt den Zahlungsanforderungstyp an. Dieser Typ definiert, wie der Zahlungsanforderungsbetrag bestimmt wird. |
|
Fälligkeitsdatum
|
invoices.payment_requests.due_date | string |
Das Fälligkeitsdatum (in der Zeitzone der Rechnung) für die Zahlungsanforderung im Format JJJJ-MM-DD. |
|
Tippsteuerung aktiviert
|
invoices.payment_requests.tipping_enabled | boolean |
Wenn dieser Wert auf "true" festgelegt ist, stellt die seite "Quadrat-gehostete Rechnung" (das Feld public_url der Rechnung) einen Ort bereit, an dem der Kunde einen Tipp bezahlen kann. |
|
Erinnerungen
|
invoices.payment_requests.reminders | array of object |
Erinnerungen |
|
UID
|
invoices.payment_requests.reminders.uid | string |
Eine quadratische ID, die die Erinnerung innerhalb der InvoicePaymentRequest eindeutig identifiziert. |
|
Relative geplante Tage
|
invoices.payment_requests.reminders.relative_scheduled_days | integer |
Die Anzahl der Tage vor (negativer Zahl) oder nach (einer positiven Zahl) due_date, wenn die Erinnerung gesendet wird. |
|
Nachricht
|
invoices.payment_requests.reminders.message | string |
Die Erinnerungsnachricht. |
|
Der Status
|
invoices.payment_requests.reminders.status | string |
Der Status der Erinnerung. |
|
Betrag
|
invoices.payment_requests.computed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoices.payment_requests.computed_amount_money.currency | string |
Die Währung. |
|
Betrag
|
invoices.payment_requests.total_completed_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoices.payment_requests.total_completed_amount_money.currency | string |
Die Währung. |
|
Automatische Zahlungsquelle
|
invoices.payment_requests.automatic_payment_source | string |
Die Zahlungsmethode für eine automatische Zahlung. |
|
Prozentsatz angefordert
|
invoices.payment_requests.percentage_requested | string |
Gibt den Betrag für die Zahlungsanforderung in Prozent an. |
|
Kartenkennung
|
invoices.payment_requests.card_id | string |
Die ID der Kredit- oder Debitkarte auf der Datei, die für die Zahlungsanforderung belastet werden soll. |
|
Rechnungsnummer
|
invoices.invoice_number | string |
Eine benutzerfreundliche Rechnungsnummer. |
|
Title
|
invoices.title | string |
Der Titel der Rechnung. |
|
Description
|
invoices.description | string |
Die Beschreibung. |
|
Geplant am
|
invoices.scheduled_at | string |
Der Zeitstempel, wenn die Rechnung für die Verarbeitung geplant ist, im RFC 3339-Format. Nach der Veröffentlichung der Rechnung verarbeitet Square die Rechnung am angegebenen Datum gemäß der Liefermethode und den Zahlungsanforderungseinstellungen. |
|
Der Status
|
invoices.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Timezone
|
invoices.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. |
|
Erstellt unter
|
invoices.created_at | string |
Die Ereigniszeit im ISO 8601-Format. |
|
Aktualisiert unter
|
invoices.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Kunden-ID
|
invoices.primary_recipient.customer_id | string |
Die ID eines Kunden, der der Karte zugeordnet werden soll. |
|
Vorname
|
invoices.primary_recipient.given_name | string |
Der angegebene Name des Empfängers (d. h. Vorname). |
|
Familienname
|
invoices.primary_recipient.family_name | string |
Die Familie des Empfängers (d. h. Nachname). |
|
E-Mail-Adresse
|
invoices.primary_recipient.email_address | string |
Die E-Mail-Adresse des Empfängers. |
|
Rufnummer
|
invoices.primary_recipient.phone_number | string |
Die Telefonnummer des Empfängers. |
|
Card
|
invoices.accepted_payment_methods.card | boolean |
Gibt an, ob Kreditkarten- oder Debitkartenzahlungen akzeptiert werden. |
|
Quadratische Geschenkkarte
|
invoices.accepted_payment_methods.square_gift_card | boolean |
Gibt an, ob Square-Geschenkkartenzahlungen akzeptiert werden. |
|
Bankkonto
|
invoices.accepted_payment_methods.bank_account | boolean |
Gibt an, ob Überweisungszahlungen akzeptiert werden. |
|
Benutzerdefinierte Felder
|
invoices.custom_fields | array of object | |
|
Etikett
|
invoices.custom_fields.label | string |
Die Beschriftung oder der Titel des benutzerdefinierten Felds. |
|
Wert
|
invoices.custom_fields.value | string |
Der Text des benutzerdefinierten Felds. |
|
Platzierung
|
invoices.custom_fields.placement | string |
Die Position des benutzerdefinierten Felds auf der Rechnung |
|
Übermittlungsmethode
|
invoices.delivery_method | string |
Die Liefermethode, die Square verwendet, um die Rechnung, Erinnerungen und Belege an den Kunden zu senden. |
|
Verkaufs- oder Servicedatum
|
invoices.sale_or_service_date | string |
Das Datum des Verkaufs oder das Datum, an dem der Dienst gerendert wird, im Format JJJJ-MM-DD. Dieses Feld kann verwendet werden, um ein vergangenes oder zukünftiges Datum anzugeben, das auf der Rechnung angezeigt wird. |
|
Öffentliche URL
|
invoices.public_url | string |
Die URL der seite "Quadratgehostete Rechnung". Nachdem Sie die Rechnung mithilfe des PublishInvoice-Endpunkts veröffentlicht haben, hostt Square die Rechnungsseite und gibt die Seiten-URL in der Antwort zurück. |
|
Betrag
|
invoices.next_payment_amount_money.amount | integer |
Der Betrag. |
|
Währung
|
invoices.next_payment_amount_money.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. |
Suchen von Terminalerstattungen
Ruft eine gefilterte Liste der Von dem Verkäufer erstellten Erstattungsanforderungen von Interac Terminal ab.
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. |
|
|
Der Status
|
status | string |
Der aktuelle Status. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zurückzahlungen
|
refunds | array of object | |
|
ID
|
refunds.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Erstattungs-ID
|
refunds.refund_id | string |
Die eindeutige ID für diese Rückerstattung, die von Square generiert wurde. |
|
Zahlungs-ID
|
refunds.payment_id | string |
Die ID der Zahlung. |
|
Betrag
|
refunds.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
refunds.amount_money.currency | string |
Die Währung. |
|
Ursache
|
refunds.reason | string |
Der Streitgrund, warum der Karteninhaber den Streit mit seiner Bank eingeleitet hat. |
|
Geräte-ID
|
refunds.device_id | string |
Die eindeutige ID des Geräts, das diesen Code verwendet hat. Aufgefüllt, wenn das Gerät gekoppelt ist. |
|
Stichtagsdauer
|
refunds.deadline_duration | string |
Eine RFC 3339-Dauer, nach der das Auschecken automatisch abgebrochen wird. Ein TerminalCheckout, das ausstehend ist, wird automatisch ABGEBROCHEN und hat einen Abbruchgrund für TIMED_OUT. Standard: 5 Minuten ab erstellung |
|
Der Status
|
refunds.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Erstellt unter
|
refunds.created_at | string |
Die Ereigniszeit im ISO 8601-Format. |
|
Aktualisiert unter
|
refunds.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
App-ID
|
refunds.app_id | string |
Die ID der Anwendung, die das Auschecken erstellt hat. |
|
Kartenmarke
|
refunds.card.card_brand | string |
Die Marke der Karte. |
|
Letzte 4
|
refunds.card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Ablaufmonat
|
refunds.card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Ablaufjahr
|
refunds.card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Fingerabdruck
|
refunds.card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
Kartentyp
|
refunds.card.card_type | string |
Der Typ der Karte. |
|
KASTEN
|
refunds.card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als Bank Identification Number (BIN) bezeichnet werden. |
|
Auftrags-ID
|
refunds.order_id | string |
Die ID der Bestellung. |
|
Speicherort-ID
|
refunds.location_id | string |
Der Bezeichner für den Speicherort. |
Suchkatalogobjekte
Sucht nach CatalogObject eines beliebigen Typs, indem unterstützte Suchattributewerte abgegleicht werden, mit Ausnahme von benutzerdefinierten Attributwerten für Elemente oder Elementvariationen, für einen oder mehrere der angegebenen Abfragefilter.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Objekttypen
|
object_types | array of string | ||
|
Attributname
|
attribute_name | string |
Der Name des zu durchsuchenden Attributs. |
|
|
Attributpräfix
|
attribute_prefix | string |
Das gewünschte Präfix des Suchattributewerts. |
|
|
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 |
|---|---|---|---|
|
Objekte
|
objects | array of object | |
|
Typ
|
objects.type | string |
Der Typ dieses Objekts. |
|
ID
|
objects.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Aktualisiert unter
|
objects.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Version
|
objects.version | integer |
Die aktuelle Version des Objekts. |
|
Ist gelöscht
|
objects.is_deleted | boolean |
Wenn true, wurde das Objekt aus der Datenbank gelöscht. Muss falsch sein, damit neue Objekte eingefügt werden. Beim Löschen entspricht das Feld updated_at der Löschzeit. |
|
An allen Standorten vorhanden
|
objects.present_at_all_locations | boolean |
Ist "true", ist dieses Objekt an allen Speicherorten (einschließlich zukünftiger Speicherorte) vorhanden, außer wenn es im Feld absent_at_location_ids angegeben ist. Ist "false" angegeben, ist dieses Objekt an keiner Stelle (einschließlich zukünftiger Speicherorte) vorhanden, es sei denn, es wird im Feld present_at_location_ids angegeben. Wenn nicht angegeben, wird der Standardwert auf "true" festgelegt. |
|
Name
|
objects.item_data.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. |
|
Description
|
objects.item_data.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. |
|
Kategorie-ID
|
objects.item_data.category_id | string |
Die ID der Kategorie des Elements, falls vorhanden. |
|
Produkttyp
|
objects.item_data.product_type | string |
Der Abfrageausdruck der Produkttypen, um Elemente oder Elementvariationen mit den angegebenen Produkttypen zurückzugeben. |
|
Steueridentifikationsnummern
|
objects.item_data.tax_ids | array of string | |
|
Variationen
|
objects.item_data.variations | array of object | |
|
Typ
|
objects.item_data.variations.type | string |
Der Typ dieses Objekts. Jeder Objekttyp hat eigenschaften erwartet, die in einem strukturierten Format innerhalb des entsprechenden Felds *_data unten ausgedrückt werden. |
|
ID
|
objects.item_data.variations.id | string |
Ein Bezeichner, der auf dieses Objekt verweist. |
|
Aktualisiert unter
|
objects.item_data.variations.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Version
|
objects.item_data.variations.version | integer |
Die Version des Objekts. Beim Aktualisieren eines Objekts muss die angegebene Version mit der Version in der Datenbank übereinstimmen, andernfalls wird der Schreibvorgang als widersprüchlich abgelehnt. |
|
Ist gelöscht
|
objects.item_data.variations.is_deleted | boolean |
Wenn true, wurde das Objekt aus der Datenbank gelöscht. Muss falsch sein, damit neue Objekte eingefügt werden. Beim Löschen entspricht das Feld updated_at der Löschzeit. |
|
An allen Standorten präsentieren
|
objects.item_data.variations.present_at_all_locations | boolean |
Eine Liste der Speicherorte, an denen das Objekt vorhanden ist, auch wenn present_at_all_locations falsch ist. Dies kann Speicherorte umfassen, die deaktiviert werden. |
|
Artikel-ID
|
objects.item_data.variations.item_variation_data.item_id | string |
Die ID des Objekts mit dieser Elementvariation. |
|
Name
|
objects.item_data.variations.item_variation_data.name | string |
Der Name dieses Elements. Dies ist ein durchsuchbares Attribut für die Verwendung in anwendbaren Abfragefiltern, und die Wertlänge ist von Unicode-Codepunkten. |
|
Ordinal
|
objects.item_data.variations.item_variation_data.ordinal | integer |
Die Reihenfolge, in der diese Elementvariation angezeigt werden soll. Dieser Wert ist schreibgeschützt. |
|
Betrag
|
objects.item_data.variations.item_variation_data.price_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
|
objects.item_data.variations.item_variation_data.price_money.currency | string |
Der Währungstyp im ISO 4217-Format. Der Währungscode für US-Dollar ist beispielsweise USD. |
|
Preisart
|
objects.item_data.variations.item_variation_data.pricing_type | string |
Gibt an, ob der Preis der Artikelvariation zum Zeitpunkt des Verkaufs festgelegt oder bestimmt wird. |
|
Sichtbarkeit
|
objects.item_data.visibility | string |
Die Sichtbarkeit. |
Terminal-Auschecken abrufen
Ruft eine Terminal-Checkout-Anforderung von checkout_id ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Auscheck-ID
|
checkout_id | True | string |
Der Bezeichner des Auscheckvorgangs. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
checkout.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Betrag
|
checkout.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
checkout.amount_money.currency | string |
Die Währung. |
|
Referenz-ID
|
checkout.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Hinweis
|
checkout.note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
Geräte-ID
|
checkout.device_options.device_id | string |
Die eindeutige ID des Geräts, das für dieses TerminalCheckout vorgesehen ist. |
|
Tippen zulassen
|
checkout.device_options.tip_settings.allow_tipping | boolean |
Gibt an, ob tipping für dieses Auschecken aktiviert ist. Der Standardwert ist „false“. |
|
Bestätigungsbildschirm überspringen
|
checkout.device_options.skip_receipt_screen | boolean |
Weist das Gerät an, den Belegbildschirm zu überspringen. Der Standardwert ist „false“. |
|
Der Status
|
checkout.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Erstellt unter
|
checkout.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
checkout.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
App-ID
|
checkout.app_id | string |
Die ID der Anwendung, die das Auschecken erstellt hat. |
|
Stichtagsdauer
|
checkout.deadline_duration | string |
Eine RFC 3339-Dauer, nach der das Auschecken automatisch abgebrochen wird. Ein TerminalCheckout, das ausstehend ist, wird automatisch ABGEBROCHEN und hat einen Abbruchgrund für TIMED_OUT. Standard: 5 Minuten ab erstellung |
Updatereihenfolge (Beta)
Aktualisiert eine offene Reihenfolge, indem Felder hinzugefügt, ersetzt oder gelöscht werden. Bestellungen mit dem Status "ABGESCHLOSSEN" oder "ABGEBROCHEN" können nicht aktualisiert werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Auftrags-ID
|
order_id | True | string |
Der Bezeichner 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. |
|
|
Version
|
version | integer |
Die aktuelle Version dieses Objekts. |
|
|
UID
|
uid | string |
Die quadratisch generierte ID. |
|
|
Menge
|
quantity | string |
Die Anzahl der Elemente, die von der physischen Anzahl als Dezimalzeichenfolge betroffen sind. Die Zahl kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
|
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. |
|
|
Betrag
|
amount | integer |
Der Betrag. |
|
|
Währung
|
currency | string |
Die Währung. |
|
|
Zu löschende Felder
|
fields_to_clear | array of string |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Version
|
order.version | integer |
Die aktuelle Version dieses Objekts. |
|
Währung
|
order.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_money.amount | integer |
Der Betrag. |
|
Name
|
order.source.name | string |
Der Name. |
|
Zeilenelemente
|
order.line_items | array of object | |
|
Währung
|
order.line_items.total_tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_tax_money.amount | integer |
Der Betrag. |
|
Betrag
|
order.line_items.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.gross_sales_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.gross_sales_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.base_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.base_price_money.currency | string |
Die Währung. |
|
Menge
|
order.line_items.quantity | string |
Die Anzahl der Elemente, die von der physischen Anzahl als Dezimalzeichenfolge betroffen sind. Die Zahl kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
Währung
|
order.line_items.total_discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_discount_money.amount | integer |
Der Betrag. |
|
Name
|
order.line_items.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. |
|
UID
|
order.line_items.uid | string |
Die quadratisch generierte ID. |
|
Betrag
|
order.line_items.variation_total_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.variation_total_price_money.currency | string |
Die Währung. |
|
Staat
|
order.state | string |
Der aktuelle Zustand. |
|
Betrag
|
order.total_service_charge_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_service_charge_money.currency | string |
Die Währung. |
|
ID
|
order.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Speicherort-ID
|
order.location_id | string |
Der Bezeichner des Speicherorts. |
|
Betrag
|
order.total_tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_tax_money.currency | string |
Die Währung. |
|
Erstellt unter
|
order.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Betrag
|
order.total_discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_discount_money.currency | string |
Die Währung. |
|
Währung
|
order.net_amounts.service_charge_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.service_charge_money.amount | integer |
Der Betrag. |
|
Betrag
|
order.net_amounts.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.total_money.currency | string |
Die Währung. |
|
Währung
|
order.net_amounts.discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.tax_money.amount | integer |
Der Betrag. |
|
Aktualisiert unter
|
order.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
Upsert-Katalogobjekt
Erstellt oder aktualisiert das Ziel CatalogObject.
Parameter
| Name | Schlüssel | Erforderlich | 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. |
|
|
ID
|
id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
|
Typ
|
type | string |
Der Typ dieses Objekts. |
|
|
Abkürzung
|
abbreviation | string |
Der Text der Anzeigebezeichnung des Elements in der Square Point of Sale-App. Es werden nur bis zu den ersten fünf Zeichen der Zeichenfolge verwendet. Dieses Attribut ist durchsuchbar, und die Wertlänge ist von Unicode-Codepunkten. |
|
|
Description
|
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. |
|
|
Name
|
name | string |
Der Name. |
|
|
ID
|
id | string |
Ein Bezeichner, der auf dieses Objekt im Katalog verweist. |
|
|
Typ
|
type | string |
Der Typ dieses Objekts. |
|
|
Artikel-ID
|
item_id | string |
Die ID des CatalogItem, das dieser Elementvariation zugeordnet ist. |
|
|
Name
|
name | string |
Der Name der Elementvariation. Dies ist ein durchsuchbares Attribut für die Verwendung in anwendbaren Abfragefiltern, und die Wertlänge ist von Unicode-Codepunkten. |
|
|
Preisart
|
pricing_type | string |
Gibt an, ob der Preis der Artikelvariation zum Zeitpunkt des Verkaufs festgelegt oder bestimmt wird. |
|
|
Betrag
|
amount | integer |
Der Betrag. |
|
|
Währung
|
currency | string |
Die Währung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Typ
|
catalog_object.type | string |
Der Typ dieses Objekts. |
|
ID
|
catalog_object.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Aktualisiert unter
|
catalog_object.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Version
|
catalog_object.version | integer |
Die aktuelle Version dieses Objekts. |
|
Ist gelöscht
|
catalog_object.is_deleted | boolean |
Wenn true, wurde das Objekt aus der Datenbank gelöscht. Muss falsch sein, damit neue Objekte eingefügt werden. Beim Löschen entspricht das Feld updated_at der Löschzeit. |
|
present_at_all_locations
|
catalog_object.present_at_all_locations | boolean |
Ist "true", ist dieses Objekt an allen Speicherorten (einschließlich zukünftiger Speicherorte) vorhanden, außer wenn es im Feld absent_at_location_ids angegeben ist. Ist "false" angegeben, ist dieses Objekt an keiner Stelle (einschließlich zukünftiger Speicherorte) vorhanden, es sei denn, es wird im Feld present_at_location_ids angegeben. Wenn nicht angegeben, wird der Standardwert auf "true" festgelegt. |
|
Name
|
catalog_object.item_data.name | string |
Der Name. |
|
Description
|
catalog_object.item_data.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. |
|
Abkürzung
|
catalog_object.item_data.abbreviation | string |
Der Text der Anzeigebezeichnung des Elements in der Square Point of Sale-App. Es werden nur bis zu den ersten fünf Zeichen der Zeichenfolge verwendet. Dieses Attribut ist durchsuchbar, und die Wertlänge ist von Unicode-Codepunkten. |
|
Variationen
|
catalog_object.item_data.variations | array of object | |
|
Typ
|
catalog_object.item_data.variations.type | string |
Der Typ dieses Objekts. |
|
ID
|
catalog_object.item_data.variations.id | string |
Ein Bezeichner, der auf dieses Objekt im Katalog verweist. |
|
Aktualisiert unter
|
catalog_object.item_data.variations.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format. |
|
Version
|
catalog_object.item_data.variations.version | integer |
Die Version des Objekts. Beim Aktualisieren eines Objekts muss die angegebene Version mit der Version in der Datenbank übereinstimmen, andernfalls wird der Schreibvorgang als widersprüchlich abgelehnt. |
|
Ist gelöscht
|
catalog_object.item_data.variations.is_deleted | boolean |
Wenn true, wurde das Objekt aus der Datenbank gelöscht. Muss falsch sein, damit neue Objekte eingefügt werden. Beim Löschen entspricht das Feld updated_at der Löschzeit. |
|
An allen Standorten vorhanden
|
catalog_object.item_data.variations.present_at_all_locations | boolean |
Ist "true", ist dieses Objekt an allen Speicherorten (einschließlich zukünftiger Speicherorte) vorhanden, außer wenn es im Feld absent_at_location_ids angegeben ist. Ist "false" angegeben, ist dieses Objekt an keiner Stelle (einschließlich zukünftiger Speicherorte) vorhanden, es sei denn, es wird im Feld present_at_location_ids angegeben. Wenn nicht angegeben, wird der Standardwert auf "true" festgelegt. |
|
Artikel-ID
|
catalog_object.item_data.variations.item_variation_data.item_id | string |
Die ID des CatalogItem, das dieser Elementvariation zugeordnet ist. |
|
Name
|
catalog_object.item_data.variations.item_variation_data.name | string |
Der Name der Elementvariation. Dies ist ein durchsuchbares Attribut für die Verwendung in anwendbaren Abfragefiltern, und die Wertlänge ist von Unicode-Codepunkten. |
|
Ordinal
|
catalog_object.item_data.variations.item_variation_data.ordinal | integer |
Die Reihenfolge, in der diese Elementvariation angezeigt werden soll. Dieser Wert ist schreibgeschützt. Bei Schreibvorgängen wird die Ordnungszahl für jede Elementvariation innerhalb eines übergeordneten CatalogItem-Objekts entsprechend der Position der Elementvariationen festgelegt. Bei Lesevorgängen ist der Wert nicht garantiert sequenziell oder eindeutig. |
|
Preisart
|
catalog_object.item_data.variations.item_variation_data.pricing_type | string |
Gibt an, ob der Preis der Artikelvariation zum Zeitpunkt des Verkaufs festgelegt oder bestimmt wird. |
|
Vorrätig
|
catalog_object.item_data.variations.item_variation_data.stockable | boolean |
Gibt an, ob die Aktie direkt auf diese Variation (TRUE) oder nur auf deren Komponenten (FALSE) gezählt wird. Aus Gründen der Abwärtskompatibilität werden fehlende Werte als WAHR interpretiert. |
|
Betrag
|
catalog_object.item_data.variations.item_variation_data.price_money.amount | integer |
Der Betrag. |
|
Währung
|
catalog_object.item_data.variations.item_variation_data.price_money.currency | string |
Die Währung. |
|
Produkttyp
|
catalog_object.item_data.product_type | string |
Der Produkttyp des Artikels. Kann nicht geändert werden, nachdem ein Element erstellt wurde. |
|
ID-Zuordnungen
|
id_mappings | array of object | |
|
Clientobjekt-ID
|
id_mappings.client_object_id | string |
Die vom Client bereitgestellte temporäre #-Präfix-ID für ein neues CatalogObject. |
|
Objekt-ID
|
id_mappings.object_id | string |
Die permanente ID, die vom Server erstellt wurde. |
Zahlung abschließen
Schließt eine Zahlung ab (erfasst). Zahlungen werden standardmäßig sofort nach der Erstellung abgeschlossen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Zahlungs-ID
|
payment_id | True | string |
Der Bezeichner der Zahlung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
payment.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Erstellt unter
|
payment.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
payment.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Betrag
|
payment.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.amount_money.currency | string |
Die Währung. |
|
Der Status
|
payment.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Verzögerungsdauer
|
payment.delay_duration | string |
Die Dauer nach der Erstellung der Zahlung, wenn Square automatisch die delay_action auf die Zahlung anwendet. Diese automatische delay_action gilt nur für Zahlungen, die keinen Terminalstatus (ABGESCHLOSSEN, ABGEBROCHEN oder FEHLGESCHLAGEN) vor dem delay_duration Zeitraum erreichen. Dieses Feld wird als Zeitdauer im RFC 3339-Format angegeben. |
|
Quellentyp
|
payment.source_type | string |
Der Quelltyp für diese Zahlung. Aktuelle Werte sind CARD, BANK_ACCOUNT, WALLET, CASH oder EXTERNAL. |
|
Der Status
|
payment.card_details.status | string |
Der aktuelle Status. |
|
Kartenmarke
|
payment.card_details.card.card_brand | string |
Die Marke der Karte. |
|
Letzte 4
|
payment.card_details.card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Ausdrucksmonat
|
payment.card_details.card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Exp Year
|
payment.card_details.card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Fingerabdruck
|
payment.card_details.card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
Kartentyp
|
payment.card_details.card.card_type | string |
Der Typ der Karte. |
|
Prepaid-Typ
|
payment.card_details.card.prepaid_type | string |
Gibt an, ob die Karte im Voraus bezahlt ist. |
|
KASTEN
|
payment.card_details.card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als Bank Identification Number (BIN) bezeichnet werden. |
|
Entry-Methode
|
payment.card_details.entry_method | string |
Die Methode, die zum Eingeben der Kartendetails für die Zahlung verwendet wird. Die Methode kann KEYED, SWIPED, EMV, ON_FILE oder CONTACTLESS sein. |
|
CVV-Status
|
payment.card_details.cvv_status | string |
Der statuscode, der von der Überprüfung des Kartenüberprüfungswerts (Card Verification Value, CVV) zurückgegeben wurde. Der Code kann CVV_ACCEPTED, CVV_REJECTED oder CVV_NOT_CHECKED werden. |
|
AVS-Status
|
payment.card_details.avs_status | string |
Der von der Überprüfung des Adressüberprüfungssystems (AVS) zurückgegebene Statuscode. Der Code kann AVS_ACCEPTED, AVS_REJECTED oder AVS_NOT_CHECKED sein. |
|
Authentifizierungsergebniscode
|
payment.card_details.auth_result_code | string |
Der vom Kartenaussteller zurückgegebene Statuscode, der den Autorisierungsstatus der Zahlung beschreibt. |
|
Beschreibung der Anweisung
|
payment.card_details.statement_description | string |
Die Beschreibung der Anweisung, die an die Kartennetzwerke gesendet wird. |
|
Autorisiert bei
|
payment.card_details.card_payment_timeline.authorized_at | string |
Der Zeitstempel, zu dem die Zahlung autorisiert wurde, im RFC 3339-Format. |
|
Erfasst bei
|
payment.card_details.card_payment_timeline.captured_at | string |
Der Zeitstempel, als die Zahlung erfasst wurde, im RFC 3339-Format. |
|
Speicherort-ID
|
payment.location_id | string |
Der Bezeichner des Speicherorts. |
|
Auftrags-ID
|
payment.order_id | string |
Die ID der Bestellung. |
|
Bearbeitungsgebühr
|
payment.processing_fee | array of object | |
|
Effektiv bei
|
payment.processing_fee.effective_at | string |
Der Zeitstempel, zu dem die Gebühr wirksam wird, im RFC 3339-Format. |
|
Typ
|
payment.processing_fee.type | string |
Gibt den Typ an. |
|
Betrag
|
payment.processing_fee.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.processing_fee.amount_money.currency | string |
Die Währung. |
|
Hinweis
|
payment.note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
Betrag
|
payment.total_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.total_money.currency | string |
Die Währung. |
|
Betrag
|
payment.approved_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.approved_money.currency | string |
Die Währung. |
|
Mitarbeiter-ID
|
payment.employee_id | string |
Die quadratisch generierte ID des Mitarbeiters. |
|
Belegnummer
|
payment.receipt_number | string |
Die Belegnummer der Zahlung. Das Feld fehlt, wenn eine Zahlung abgebrochen wird. |
|
Bestätigungs-URL
|
payment.receipt_url | string |
Die URL für den Zahlungsbeleg. Das Feld wird nur für ABGESCHLOSSENe Zahlungen ausgefüllt. |
|
Aktion verzögern
|
payment.delay_action | string |
Die Aktion, die auf die Zahlung angewendet werden soll, wenn der delay_duration verstrichen ist. |
|
Verzögert bis
|
payment.delayed_until | string |
Der schreibgeschützte Zeitstempel der automatischen Anwendung des delay_action im RFC 3339-Format. |
|
Teammitglieds-ID
|
payment.team_member_id | string |
Die ID des Teammitglieds. |
|
Quadratisches Produkt
|
payment.application_details.square_product | string |
Das Quadratprodukt, z. B. Square Point of Sale (POS), Square Invoices oder Square Virtual Terminal. |
|
Anwendungs-ID
|
payment.application_details.application_id | string |
Read-only Quadrat-ID, die der Anwendung zugewiesen ist. |
|
Versionstoken
|
payment.version_token | string |
Dieses undurchsichtige Token identifiziert eine bestimmte Version des Objekts. |
Zahlung aktualisieren
Aktualisiert eine Zahlung mit dem STATUS GENEHMIGT. Sie können die amount_money und tip_money mithilfe dieses Endpunkts aktualisieren.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Zahlungs-ID
|
payment_id | True | string |
Der Bezeichner der Zahlung. |
|
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. |
|
|
Betrag
|
amount | integer |
Der Betrag. |
|
|
Währung
|
currency | string |
Die Währung. |
|
|
Betrag
|
amount | integer |
Der Betrag. |
|
|
Währung
|
currency | string |
Die Währung. |
|
|
Versionstoken
|
version_token | string |
Dieses undurchsichtige Token identifiziert eine bestimmte Version des Objekts. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
payment.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Erstellt unter
|
payment.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
payment.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Betrag
|
payment.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.amount_money.currency | string |
Die Währung. |
|
Betrag
|
payment.tip_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.tip_money.currency | string |
Die Währung. |
|
Der Status
|
payment.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Verzögerungsdauer
|
payment.delay_duration | string |
Die Dauer nach der Erstellung der Zahlung, wenn Square automatisch die delay_action auf die Zahlung anwendet. Diese automatische delay_action gilt nur für Zahlungen, die keinen Terminalstatus (ABGESCHLOSSEN, ABGEBROCHEN oder FEHLGESCHLAGEN) vor dem delay_duration Zeitraum erreichen. Dieses Feld wird als Zeitdauer im RFC 3339-Format angegeben. |
|
Quellentyp
|
payment.source_type | string |
Der Quelltyp für diese Zahlung. Aktuelle Werte sind CARD, BANK_ACCOUNT, WALLET, CASH oder EXTERNAL. |
|
Der Status
|
payment.card_details.status | string |
Der aktuelle Status. |
|
Kartenmarke
|
payment.card_details.card.card_brand | string |
Die Marke der Karte. |
|
Letzte 4
|
payment.card_details.card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Ausdrucksmonat
|
payment.card_details.card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Exp Year
|
payment.card_details.card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Fingerabdruck
|
payment.card_details.card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
Kartentyp
|
payment.card_details.card.card_type | string |
Der Typ der Karte. |
|
Prepaid-Typ
|
payment.card_details.card.prepaid_type | string |
Gibt an, ob die Karte im Voraus bezahlt ist. |
|
KASTEN
|
payment.card_details.card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als Bank Identification Number (BIN) bezeichnet werden. |
|
Entry-Methode
|
payment.card_details.entry_method | string |
Die Methode, die zum Eingeben der Kartendetails für die Zahlung verwendet wird. Die Methode kann KEYED, SWIPED, EMV, ON_FILE oder CONTACTLESS sein. |
|
CVV-Status
|
payment.card_details.cvv_status | string |
Der statuscode, der von der Überprüfung des Kartenüberprüfungswerts (Card Verification Value, CVV) zurückgegeben wurde. Der Code kann CVV_ACCEPTED, CVV_REJECTED oder CVV_NOT_CHECKED werden. |
|
AVS-Status
|
payment.card_details.avs_status | string |
Der von der Überprüfung des Adressüberprüfungssystems (AVS) zurückgegebene Statuscode. Der Code kann AVS_ACCEPTED, AVS_REJECTED oder AVS_NOT_CHECKED sein. |
|
Authentifizierungsergebniscode
|
payment.card_details.auth_result_code | string |
Der vom Kartenaussteller zurückgegebene Statuscode, der den Autorisierungsstatus der Zahlung beschreibt. |
|
Beschreibung der Anweisung
|
payment.card_details.statement_description | string |
Die Beschreibung der Anweisung, die an die Kartennetzwerke gesendet wird. |
|
Autorisiert bei
|
payment.card_details.card_payment_timeline.authorized_at | string |
Der Zeitstempel, zu dem die Zahlung autorisiert wurde, im RFC 3339-Format. |
|
Speicherort-ID
|
payment.location_id | string |
Der Bezeichner des Speicherorts. |
|
Auftrags-ID
|
payment.order_id | string |
Die ID der Bestellung. |
|
Erstellt unter
|
payment.risk_evaluation.created_at | string |
Der Zeitstempel, wenn er erstellt wurde, im RFC 3339-Format. |
|
Risikostufe
|
payment.risk_evaluation.risk_level | string |
Das Risikoniveau, das der Zahlung zugeordnet ist. |
|
Hinweis
|
payment.note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
Kunden-ID
|
payment.customer_id | string |
Die ID dieses Objekts, das den Kunden darstellt. |
|
Betrag
|
payment.total_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.total_money.currency | string |
Die Währung. |
|
Betrag
|
payment.approved_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.approved_money.currency | string |
Die Währung. |
|
Fähigkeiten
|
payment.capabilities | array of string | |
|
Belegnummer
|
payment.receipt_number | string |
Die Belegnummer der Zahlung. Das Feld fehlt, wenn eine Zahlung abgebrochen wird. |
|
Aktion verzögern
|
payment.delay_action | string |
Die Aktion, die auf die Zahlung angewendet werden soll, wenn der delay_duration verstrichen ist. |
|
Verzögert bis
|
payment.delayed_until | string |
Der schreibgeschützte Zeitstempel der automatischen Anwendung des delay_action im RFC 3339-Format. |
|
Quadratisches Produkt
|
payment.application_details.square_product | string |
Das Quadratprodukt, z. B. Square Point of Sale (POS), Square Invoices oder Square Virtual Terminal. |
|
Anwendungs-ID
|
payment.application_details.application_id | string |
Read-only Quadrat-ID, die der Anwendung zugewiesen ist. |
|
Versionstoken
|
payment.version_token | string |
Dieses undurchsichtige Token identifiziert eine bestimmte Version des Objekts. |
Zahlung erhalten
Ruft Details für eine bestimmte Zahlung ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Zahlungs-ID
|
payment_id | True | string |
Der Bezeichner der Zahlung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
payment.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Erstellt unter
|
payment.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
payment.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Betrag
|
payment.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.amount_money.currency | string |
Die Währung. |
|
Der Status
|
payment.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Verzögerungsdauer
|
payment.delay_duration | string |
Die Dauer nach der Erstellung der Zahlung, wenn Square automatisch die delay_action auf die Zahlung anwendet. Diese automatische delay_action gilt nur für Zahlungen, die keinen Terminalstatus (ABGESCHLOSSEN, ABGEBROCHEN oder FEHLGESCHLAGEN) vor dem delay_duration Zeitraum erreichen. Dieses Feld wird als Zeitdauer im RFC 3339-Format angegeben. |
|
Quellentyp
|
payment.source_type | string |
Der Quelltyp für diese Zahlung. Aktuelle Werte sind CARD, BANK_ACCOUNT, WALLET, CASH oder EXTERNAL. |
|
Der Status
|
payment.card_details.status | string |
Der aktuelle Status. |
|
Kartenmarke
|
payment.card_details.card.card_brand | string |
Die Marke der Karte. |
|
Letzte 4
|
payment.card_details.card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Ausdrucksmonat
|
payment.card_details.card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Exp Year
|
payment.card_details.card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Fingerabdruck
|
payment.card_details.card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
Kartentyp
|
payment.card_details.card.card_type | string |
Der Typ der Karte. |
|
Prepaid-Typ
|
payment.card_details.card.prepaid_type | string |
Gibt an, ob die Karte im Voraus bezahlt ist. |
|
KASTEN
|
payment.card_details.card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als Bank Identification Number (BIN) bezeichnet werden. |
|
Entry-Methode
|
payment.card_details.entry_method | string |
Die Methode, die zum Eingeben der Kartendetails für die Zahlung verwendet wird. Die Methode kann KEYED, SWIPED, EMV, ON_FILE oder CONTACTLESS sein. |
|
CVV-Status
|
payment.card_details.cvv_status | string |
Der statuscode, der von der Überprüfung des Kartenüberprüfungswerts (Card Verification Value, CVV) zurückgegeben wurde. Der Code kann CVV_ACCEPTED, CVV_REJECTED oder CVV_NOT_CHECKED werden. |
|
AVS-Status
|
payment.card_details.avs_status | string |
Der von der Überprüfung des Adressüberprüfungssystems (AVS) zurückgegebene Statuscode. Der Code kann AVS_ACCEPTED, AVS_REJECTED oder AVS_NOT_CHECKED sein. |
|
Authentifizierungsergebniscode
|
payment.card_details.auth_result_code | string |
Der vom Kartenaussteller zurückgegebene Statuscode, der den Autorisierungsstatus der Zahlung beschreibt. |
|
Beschreibung der Anweisung
|
payment.card_details.statement_description | string |
Die Beschreibung der Anweisung, die an die Kartennetzwerke gesendet wird. |
|
Autorisiert bei
|
payment.card_details.card_payment_timeline.authorized_at | string |
Der Zeitstempel, zu dem die Zahlung autorisiert wurde, im RFC 3339-Format. |
|
Erfasst bei
|
payment.card_details.card_payment_timeline.captured_at | string |
Der Zeitstempel, als die Zahlung erfasst wurde, im RFC 3339-Format. |
|
Speicherort-ID
|
payment.location_id | string |
Der Bezeichner des Speicherorts. |
|
Auftrags-ID
|
payment.order_id | string |
Die ID der Bestellung. |
|
Bearbeitungsgebühr
|
payment.processing_fee | array of object | |
|
Effektiv bei
|
payment.processing_fee.effective_at | string |
Der Zeitstempel, zu dem die Gebühr wirksam wird, im RFC 3339-Format. |
|
Typ
|
payment.processing_fee.type | string |
Gibt den Typ an. |
|
Betrag
|
payment.processing_fee.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.processing_fee.amount_money.currency | string |
Die Währung. |
|
Hinweis
|
payment.note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
Betrag
|
payment.total_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.total_money.currency | string |
Die Währung. |
|
Betrag
|
payment.approved_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.approved_money.currency | string |
Die Währung. |
|
Mitarbeiter-ID
|
payment.employee_id | string |
Die quadratisch generierte ID des Mitarbeiters. |
|
Belegnummer
|
payment.receipt_number | string |
Die Belegnummer der Zahlung. Das Feld fehlt, wenn eine Zahlung abgebrochen wird. |
|
Bestätigungs-URL
|
payment.receipt_url | string |
Die URL für den Zahlungsbeleg. Das Feld wird nur für ABGESCHLOSSENe Zahlungen ausgefüllt. |
|
Aktion verzögern
|
payment.delay_action | string |
Die Aktion, die auf die Zahlung angewendet werden soll, wenn der delay_duration verstrichen ist. |
|
Verzögert bis
|
payment.delayed_until | string |
Der schreibgeschützte Zeitstempel der automatischen Anwendung des delay_action im RFC 3339-Format. |
|
Teammitglieds-ID
|
payment.team_member_id | string |
Die ID des Teammitglieds. |
|
Quadratisches Produkt
|
payment.application_details.square_product | string |
Das Quadratprodukt, z. B. Square Point of Sale (POS), Square Invoices oder Square Virtual Terminal. |
|
Anwendungs-ID
|
payment.application_details.application_id | string |
Read-only Quadrat-ID, die der Anwendung zugewiesen ist. |
|
Versionstoken
|
payment.version_token | string |
Dieses undurchsichtige Token identifiziert eine bestimmte Version des Objekts. |
Zahlung erstellen
Erstellt eine Zahlung mithilfe der bereitgestellten Quelle. Sie können diesen Endpunkt verwenden, um eine Karte (Kreditkarte/Debitkarte oder Square-Geschenkkarte) zu belasten oder eine Zahlung aufzuzeichnen, die der Verkäufer außerhalb von Square erhalten hat (Barzahlung von einem Käufer oder einer Zahlung, die eine externe Entität im Namen des Verkäufers verarbeitet hat).
Parameter
| Name | Schlüssel | Erforderlich | 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. |
|
|
Betrag
|
amount | integer |
Der Betrag, der für diese Zahlung akzeptiert werden soll, nicht einschließlich tip_money. |
|
|
Währung
|
currency | string |
Der 3-stellige ISO 4217-Währungscode. |
|
|
Quell-ID
|
source_id | string |
Die ID für die Quelle der Mittel für diese Zahlung. Dies kann ein Zahlungstoken (Karten nonce) sein, das vom Quadrat-Zahlungsformular oder einer Karte in der Datei generiert wird, die mit der Kunden-API erfolgt. Wenn Sie eine Zahlung aufzeichnen, die der Verkäufer außerhalb von Square erhalten hat, geben Sie entweder CASH oder EXTERN an. |
|
|
AutoVervollständigen
|
autocomplete | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird diese Zahlung nach Möglichkeit abgeschlossen. Wenn diese Zahlung auf "false" festgelegt ist, wird diese Zahlung in einem genehmigten Zustand gehalten, bis sie entweder explizit abgeschlossen (erfasst) oder storniert (ungültig) wurde. |
|
|
Kunden-ID
|
customer_id | string |
Die ID des Kunden, der verknüpft werden soll. |
|
|
Speicherort-ID
|
location_id | string |
Der Speicherortbezeichner. |
|
|
Referenz-ID
|
reference_id | string |
Eine optionale zweite ID, die verwendet wird, um das Kundenprofil einer Entität in einem anderen System zuzuordnen. |
|
|
Hinweis
|
note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
|
Betrag
|
amount | integer |
Der Betrag, der für diese Zahlung akzeptiert werden soll, nicht einschließlich tip_money. |
|
|
Währung
|
currency | string |
Der 3-stellige ISO 4217-Währungscode. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
payment.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Erstellt unter
|
payment.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
payment.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Betrag
|
payment.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.amount_money.currency | string |
Die Währung. |
|
Betrag
|
payment.app_fee_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.app_fee_money.currency | string |
Die Währung. |
|
Der Status
|
payment.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Verzögerungsdauer
|
payment.delay_duration | string |
Die Dauer nach der Erstellung der Zahlung, wenn Square automatisch die delay_action auf die Zahlung anwendet. Diese automatische delay_action gilt nur für Zahlungen, die keinen Terminalstatus (ABGESCHLOSSEN, ABGEBROCHEN oder FEHLGESCHLAGEN) vor dem delay_duration Zeitraum erreichen. Dieses Feld wird als Zeitdauer im RFC 3339-Format angegeben. |
|
Quellentyp
|
payment.source_type | string |
Der Quelltyp für diese Zahlung. Aktuelle Werte sind CARD, BANK_ACCOUNT, WALLET, CASH oder EXTERNAL. |
|
Der Status
|
payment.card_details.status | string |
Der aktuelle Status. |
|
Kartenmarke
|
payment.card_details.card.card_brand | string |
Die Marke der Karte. |
|
Letzte 4
|
payment.card_details.card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Ausdrucksmonat
|
payment.card_details.card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Exp Year
|
payment.card_details.card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Fingerabdruck
|
payment.card_details.card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
Kartentyp
|
payment.card_details.card.card_type | string |
Der Typ der Karte. |
|
Prepaid-Typ
|
payment.card_details.card.prepaid_type | string |
Gibt an, ob die Karte im Voraus bezahlt ist. |
|
KASTEN
|
payment.card_details.card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als Bank Identification Number (BIN) bezeichnet werden. |
|
Entry-Methode
|
payment.card_details.entry_method | string |
Die Methode, die zum Eingeben der Kartendetails für die Zahlung verwendet wird. Die Methode kann KEYED, SWIPED, EMV, ON_FILE oder CONTACTLESS sein. |
|
CVV-Status
|
payment.card_details.cvv_status | string |
Der statuscode, der von der Überprüfung des Kartenüberprüfungswerts (Card Verification Value, CVV) zurückgegeben wurde. Der Code kann CVV_ACCEPTED, CVV_REJECTED oder CVV_NOT_CHECKED werden. |
|
AVS-Status
|
payment.card_details.avs_status | string |
Der von der Überprüfung des Adressüberprüfungssystems (AVS) zurückgegebene Statuscode. Der Code kann AVS_ACCEPTED, AVS_REJECTED oder AVS_NOT_CHECKED sein. |
|
Authentifizierungsergebniscode
|
payment.card_details.auth_result_code | string |
Der vom Kartenaussteller zurückgegebene Statuscode, der den Autorisierungsstatus der Zahlung beschreibt. |
|
Beschreibung der Anweisung
|
payment.card_details.statement_description | string |
Die Beschreibung der Anweisung, die an die Kartennetzwerke gesendet wird. |
|
Autorisiert bei
|
payment.card_details.card_payment_timeline.authorized_at | string |
Der Zeitstempel, zu dem die Zahlung autorisiert wurde, im RFC 3339-Format. |
|
Erfasst bei
|
payment.card_details.card_payment_timeline.captured_at | string |
Der Zeitstempel, als die Zahlung erfasst wurde, im RFC 3339-Format. |
|
Speicherort-ID
|
payment.location_id | string |
Der Bezeichner des Speicherorts. |
|
Auftrags-ID
|
payment.order_id | string |
Die ID der Bestellung. |
|
Referenz-ID
|
payment.reference_id | string |
Eine optionale benutzerdefinierte Referenz-ID. |
|
Erstellt unter
|
payment.risk_evaluation.created_at | string |
Der Zeitstempel, wenn er erstellt wurde, im RFC 3339-Format. |
|
Risikostufe
|
payment.risk_evaluation.risk_level | string |
Das Risikoniveau, das der Zahlung zugeordnet ist. |
|
Hinweis
|
payment.note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
Kunden-ID
|
payment.customer_id | string |
Die ID dieses Objekts, das den Kunden darstellt. |
|
Betrag
|
payment.total_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.total_money.currency | string |
Die Währung. |
|
Betrag
|
payment.approved_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.approved_money.currency | string |
Die Währung. |
|
Belegnummer
|
payment.receipt_number | string |
Die Belegnummer der Zahlung. Das Feld fehlt, wenn eine Zahlung abgebrochen wird. |
|
Bestätigungs-URL
|
payment.receipt_url | string |
Die URL für den Zahlungsbeleg. Das Feld wird nur für ABGESCHLOSSENe Zahlungen ausgefüllt. |
|
Aktion verzögern
|
payment.delay_action | string |
Die Aktion, die auf die Zahlung angewendet werden soll, wenn der delay_duration verstrichen ist. |
|
Verzögert bis
|
payment.delayed_until | string |
Der schreibgeschützte Zeitstempel der automatischen Anwendung des delay_action im RFC 3339-Format. |
|
Quadratisches Produkt
|
payment.application_details.square_product | string |
Das Quadratprodukt, z. B. Square Point of Sale (POS), Square Invoices oder Square Virtual Terminal. |
|
Anwendungs-ID
|
payment.application_details.application_id | string |
Read-only Quadrat-ID, die der Anwendung zugewiesen ist. |
|
Versionstoken
|
payment.version_token | string |
Dieses undurchsichtige Token identifiziert eine bestimmte Version des Objekts. |
Zahlung stornieren
Bricht eine Zahlung ab (nichtig). Sie können diesen Endpunkt verwenden, um eine Zahlung mit dem STATUS GENEHMIGT abzubrechen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Zahlungs-ID
|
payment_id | True | string |
Der Bezeichner der Zahlung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
payment.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Erstellt unter
|
payment.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
payment.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Betrag
|
payment.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.amount_money.currency | string |
Die Währung. |
|
Betrag
|
payment.tip_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.tip_money.currency | string |
Die Währung. |
|
Der Status
|
payment.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Verzögerungsdauer
|
payment.delay_duration | string |
Die Dauer nach der Erstellung der Zahlung, wenn Square automatisch die delay_action auf die Zahlung anwendet. Diese automatische delay_action gilt nur für Zahlungen, die keinen Terminalstatus (ABGESCHLOSSEN, ABGEBROCHEN oder FEHLGESCHLAGEN) vor dem delay_duration Zeitraum erreichen. Dieses Feld wird als Zeitdauer im RFC 3339-Format angegeben. |
|
Quellentyp
|
payment.source_type | string |
Der Quelltyp für diese Zahlung. Aktuelle Werte sind CARD, BANK_ACCOUNT, WALLET, CASH oder EXTERNAL. |
|
Der Status
|
payment.card_details.status | string |
Der aktuelle Status. |
|
Kartenmarke
|
payment.card_details.card.card_brand | string |
Die Marke der Karte. |
|
Letzte 4
|
payment.card_details.card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Ausdrucksmonat
|
payment.card_details.card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Exp Year
|
payment.card_details.card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Fingerabdruck
|
payment.card_details.card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
Kartentyp
|
payment.card_details.card.card_type | string |
Der Typ der Karte. |
|
Prepaid-Typ
|
payment.card_details.card.prepaid_type | string |
Gibt an, ob die Karte im Voraus bezahlt ist. |
|
KASTEN
|
payment.card_details.card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als Bank Identification Number (BIN) bezeichnet werden. |
|
Entry-Methode
|
payment.card_details.entry_method | string |
Die Methode, die zum Eingeben der Kartendetails für die Zahlung verwendet wird. Die Methode kann KEYED, SWIPED, EMV, ON_FILE oder CONTACTLESS sein. |
|
CVV-Status
|
payment.card_details.cvv_status | string |
Der statuscode, der von der Überprüfung des Kartenüberprüfungswerts (Card Verification Value, CVV) zurückgegeben wurde. Der Code kann CVV_ACCEPTED, CVV_REJECTED oder CVV_NOT_CHECKED werden. |
|
AVS-Status
|
payment.card_details.avs_status | string |
Der von der Überprüfung des Adressüberprüfungssystems (AVS) zurückgegebene Statuscode. Der Code kann AVS_ACCEPTED, AVS_REJECTED oder AVS_NOT_CHECKED sein. |
|
Authentifizierungsergebniscode
|
payment.card_details.auth_result_code | string |
Der vom Kartenaussteller zurückgegebene Statuscode, der den Autorisierungsstatus der Zahlung beschreibt. |
|
Beschreibung der Anweisung
|
payment.card_details.statement_description | string |
Die Beschreibung der Anweisung, die an die Kartennetzwerke gesendet wird. |
|
Autorisiert bei
|
payment.card_details.card_payment_timeline.authorized_at | string |
Der Zeitstempel, zu dem die Zahlung autorisiert wurde, im RFC 3339-Format. |
|
Ungültig bei
|
payment.card_details.card_payment_timeline.voided_at | string |
Der Zeitstempel, als die Zahlung ungültig wurde, im RFC 3339-Format. |
|
Speicherort-ID
|
payment.location_id | string |
Der Bezeichner des Speicherorts. |
|
Auftrags-ID
|
payment.order_id | string |
Die ID der Bestellung. |
|
Erstellt unter
|
payment.risk_evaluation.created_at | string |
Der Zeitstempel, wenn er erstellt wurde, im RFC 3339-Format. |
|
Risikostufe
|
payment.risk_evaluation.risk_level | string |
Das Risikoniveau, das der Zahlung zugeordnet ist. |
|
Hinweis
|
payment.note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
Kunden-ID
|
payment.customer_id | string |
Die ID dieses Objekts, das den Kunden darstellt. |
|
Betrag
|
payment.total_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.total_money.currency | string |
Die Währung. |
|
Betrag
|
payment.approved_money.amount | integer |
Der Betrag. |
|
Währung
|
payment.approved_money.currency | string |
Die Währung. |
|
Aktion verzögern
|
payment.delay_action | string |
Die Aktion, die auf die Zahlung angewendet werden soll, wenn der delay_duration verstrichen ist. |
|
Verzögert bis
|
payment.delayed_until | string |
Der schreibgeschützte Zeitstempel der automatischen Anwendung des delay_action im RFC 3339-Format. |
|
Quadratisches Produkt
|
payment.application_details.square_product | string |
Das Quadratprodukt, z. B. Square Point of Sale (POS), Square Invoices oder Square Virtual Terminal. |
|
Anwendungs-ID
|
payment.application_details.application_id | string |
Read-only Quadrat-ID, die der Anwendung zugewiesen ist. |
|
Versionstoken
|
payment.version_token | string |
Dieses undurchsichtige Token identifiziert eine bestimmte Version des Objekts. |
Zahlungen auflisten
Ruft eine Liste der Zahlungen ab, die vom Konto übernommen wurden, das die Anforderung vornimmt. Die Ergebnisse sind letztendlich konsistent, und es kann mehrere Sekunden dauern, bis neue Zahlungen oder Änderungen an Zahlungen angezeigt werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
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. |
|
|
Sortierreihenfolge
|
sort_order | string |
Sortiert die zurückgegebene Liste nach dem Zeitpunkt der Erstellung der Karte mit der angegebenen Reihenfolge. |
|
|
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. |
|
|
Total
|
total | integer |
Der genaue Betrag im total_money für eine Zahlung. |
|
|
Letzte 4
|
last_4 | string |
Die letzten vier Ziffern einer Zahlungskarte. |
|
|
Kartenmarke
|
card_brand | string |
Die Marke der Zahlungskarte (z. B. VISA). |
|
|
Limit
|
limit | integer |
Obergrenze für die Zahl, die in der Antwort zurückgegeben werden soll. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zahlungen
|
payments | array of object | |
|
ID
|
payments.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Erstellt unter
|
payments.created_at | string |
Die Ereigniszeit im ISO 8601-Format. |
|
Aktualisiert unter
|
payments.updated_at | string |
Zeitstempel der letzten Änderung im RFC 3339-Format |
|
Betrag
|
payments.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
payments.amount_money.currency | string |
Die Währung. |
|
Der Status
|
payments.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Verzögerungsdauer
|
payments.delay_duration | string |
Die Dauer nach der Erstellung der Zahlung, wenn Square automatisch die delay_action auf die Zahlung anwendet. |
|
Quellentyp
|
payments.source_type | string |
Der Quelltyp für diese Zahlung. |
|
Der Status
|
payments.card_details.status | string |
Der aktuelle Status der Kartenzahlung. Der Status kann AUTORISIERT, CAPTURED, VOIDED oder FAILED sein. |
|
Kartenmarke
|
payments.card_details.card.card_brand | string |
Die Marke der Karte. |
|
last_4
|
payments.card_details.card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Ausdrucksmonat
|
payments.card_details.card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Exp Year
|
payments.card_details.card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Fingerabdruck
|
payments.card_details.card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
Kartentyp
|
payments.card_details.card.card_type | string |
Der Typ der Karte. |
|
Prepaid-Typ
|
payments.card_details.card.prepaid_type | string |
Gibt an, ob die Karte im Voraus bezahlt ist. |
|
KASTEN
|
payments.card_details.card.bin | string |
Die ersten sechs Ziffern der Kartennummer, die als BankIdentifikationsnummer (BIN) bezeichnet werden |
|
Entry-Methode
|
payments.card_details.entry_method | string |
Die Methode, die zum Eingeben der Kartendetails für die Zahlung verwendet wird. Die Methode kann KEYED, SWIPED, EMV, ON_FILE oder CONTACTLESS sein. |
|
Cvv-Status
|
payments.card_details.cvv_status | string |
Der statuscode, der von der Überprüfung des Kartenüberprüfungswerts (Card Verification Value, CVV) zurückgegeben wurde. Der Code kann CVV_ACCEPTED, CVV_REJECTED oder CVV_NOT_CHECKED werden. |
|
Avs-Status
|
payments.card_details.avs_status | string |
Der von der Überprüfung des Adressüberprüfungssystems (AVS) zurückgegebene Statuscode. Der Code kann AVS_ACCEPTED, AVS_REJECTED oder AVS_NOT_CHECKED sein. |
|
Authentifizierungsergebniscode
|
payments.card_details.auth_result_code | string |
Der vom Kartenaussteller zurückgegebene Statuscode, der den Autorisierungsstatus der Zahlung beschreibt. |
|
Beschreibung der Anweisung
|
payments.card_details.statement_description | string |
Die Beschreibung der Anweisung, die an die Kartennetzwerke gesendet wird. |
|
Autorisiert bei
|
payments.card_details.card_payment_timeline.authorized_at | string |
Der Zeitstempel, zu dem die Zahlung autorisiert wurde, im RFC 3339-Format. |
|
Erfasst bei
|
payments.card_details.card_payment_timeline.captured_at | string |
Der Zeitstempel, als die Zahlung erfasst wurde, im RFC 3339-Format. |
|
Speicherort-ID
|
payments.location_id | string |
Der Bezeichner für den Speicherort. |
|
Auftrags-ID
|
payments.order_id | string |
Die ID der Bestellung. |
|
Bearbeitungsgebühr
|
payments.processing_fee | array of object | |
|
Effektiv bei
|
payments.processing_fee.effective_at | string |
Der Zeitstempel, zu dem die Gebühr wirksam wird, im RFC 3339-Format. |
|
Typ
|
payments.processing_fee.type | string |
Der Typ dieses Objekts. |
|
Betrag
|
payments.processing_fee.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
payments.processing_fee.amount_money.currency | string |
Die Währung. |
|
Hinweis
|
payments.note | string |
Eine benutzerdefinierte Notiz, die dem Kundenprofil zugeordnet ist. |
|
Betrag
|
payments.total_money.amount | integer |
Der Betrag. |
|
Währung
|
payments.total_money.currency | string |
Die Währung. |
|
Betrag
|
payments.approved_money.amount | integer |
Der Betrag. |
|
Währung
|
payments.approved_money.currency | string |
Die Währung. |
|
Belegnummer
|
payments.receipt_number | string |
Die Belegnummer der Zahlung. Das Feld fehlt, wenn eine Zahlung abgebrochen wird. |
|
Bestätigungs-URL
|
payments.receipt_url | string |
Die URL für den Zahlungsbeleg. Das Feld wird nur für ABGESCHLOSSENe Zahlungen ausgefüllt. |
|
Aktion verzögern
|
payments.delay_action | string |
Die Aktion, die auf die Zahlung angewendet werden soll, wenn der delay_duration verstrichen ist. |
|
Verzögert bis
|
payments.delayed_until | string |
Der schreibgeschützte Zeitstempel der automatischen Anwendung des delay_action im RFC 3339-Format. |
|
Teammitglieds-ID
|
payments.team_member_id | string |
Die ID des TeamMember-Objekts für das Dem Objekt zugeordnete Teammitglied. |
|
Quadratisches Produkt
|
payments.application_details.square_product | string |
Das Quadratprodukt, z. B. Square Point of Sale (POS), Square Invoices oder Square Virtual Terminal. |
|
Anwendungs-ID
|
payments.application_details.application_id | string |
Die quadratische ID, die der Anwendung zugewiesen wurde, um die Zahlung zu übernehmen. Anwendungsentwickler können diese Informationen verwenden, um Zahlungen zu identifizieren, die ihre Anwendung verarbeitet hat. Wenn ein Entwickler beispielsweise eine benutzerdefinierte Anwendung zum Verarbeiten von Zahlungen verwendet, enthält dieses Feld die Anwendungs-ID aus dem Entwicklerdashboard. Wenn ein Verkäufer eine Square App Marketplace-Anwendung zum Verarbeiten von Zahlungen verwendet, enthält das Feld die entsprechende Anwendungs-ID. |
|
Versionstoken
|
payments.version_token | string |
Wird für optimistische Parallelität verwendet. Dieses undurchsichtige Token identifiziert eine bestimmte Version des Zahlungsobjekts. |
Zahlungsauftrag (Beta)
Zahlen Sie für eine Bestellung mit einer oder mehreren genehmigten Zahlungen oder begleichen Sie eine Bestellung mit insgesamt 0. Die Summe der in der Anforderung aufgeführten payment_ids muss der Bestellsumme entsprechen. Bestellungen mit einem Gesamtbetrag von 0 können als bezahlt gekennzeichnet werden, indem sie ein leeres Array von payment_ids in der Anforderung angeben.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Auftrags-ID
|
order_id | True | string |
Der Bezeichner 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. |
|
|
Zahlungs-IDs
|
payment_ids | array of string |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
order.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Speicherort-ID
|
order.location_id | string |
Der Bezeichner des Speicherorts. |
|
Zeilenelemente
|
order.line_items | array of object | |
|
UID
|
order.line_items.uid | string |
Die quadratisch generierte ID. |
|
Menge
|
order.line_items.quantity | string |
Die Anzahl der Elemente, die von der physischen Anzahl als Dezimalzeichenfolge betroffen sind. Die Zahl kann bis zu 5 Ziffern nach dem Dezimalkomma unterstützen. |
|
Name
|
order.line_items.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. |
|
Betrag
|
order.line_items.base_price_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.base_price_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.gross_sales_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.gross_sales_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.line_items.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.line_items.total_money.currency | string |
Die Währung. |
|
Erstellt unter
|
order.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
order.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Version
|
order.version | integer |
Die aktuelle Version dieses Objekts. |
|
Betrag
|
order.total_tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_money.currency | string |
Die Währung. |
|
Geschlossen am
|
order.closed_at | string |
Die Uhrzeit beim Schließen im ISO 8601-Format. |
|
Ausschreibungen
|
order.tenders | array of object | |
|
ID
|
order.tenders.id | string |
Der Bezeichner des Objekts |
|
Speicherort-ID
|
order.tenders.location_id | string |
Die Standort-ID für einen Empfänger (außer dem Händler), der einen Teil dieses Angebots erhält. |
|
Buchungskennung
|
order.tenders.transaction_id | string |
Die ID der damit verbundenen Transaktion des Angebots. |
|
Erstellt unter
|
order.tenders.created_at | string |
Der Zeitstempel, wenn er erstellt wurde, im RFC 3339-Format. |
|
Betrag
|
order.tenders.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.tenders.amount_money.currency | string |
Die Währung. |
|
Typ
|
order.tenders.type | string |
Gibt den Typ an. |
|
Der Status
|
order.tenders.card_details.status | string |
Der aktuelle Status der Kreditkartenzahlung (z. B. AUTORISIERT oder ERFASST) |
|
Kartenmarke
|
order.tenders.card_details.card.card_brand | string |
Die Marke der Karte. |
|
last_4
|
order.tenders.card_details.card.last_4 | string |
Die letzten 4 Ziffern der Kartennummer. |
|
Ausdrucksmonat
|
order.tenders.card_details.card.exp_month | integer |
Der Ablaufmonat der zugeordneten Karte als ganze Zahl zwischen 1 und 12. |
|
Exp Year
|
order.tenders.card_details.card.exp_year | integer |
Das vierstellige Jahr des Ablaufdatums der Karte. |
|
Fingerabdruck
|
order.tenders.card_details.card.fingerprint | string |
Vorgesehen als quadratischer Bezeichner basierend auf der Kartennummer, um die Karte an mehreren Orten innerhalb einer einzigen Anwendung zu identifizieren. |
|
Entry-Methode
|
order.tenders.card_details.entry_method | string |
Die Methode, die zum Eingeben der Kartendetails für die Transaktion verwendet wird. |
|
Zahlungs-ID
|
order.tenders.payment_id | string |
Square-generierte eindeutige ID der Zahlung. |
|
Betrag
|
order.total_service_charge_money.amount | integer |
Der Betrag. |
|
Währung
|
order.total_service_charge_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.total_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.total_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.tax_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.tax_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.discount_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.discount_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.tip_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.tip_money.currency | string |
Die Währung. |
|
Betrag
|
order.net_amounts.service_charge_money.amount | integer |
Der Betrag. |
|
Währung
|
order.net_amounts.service_charge_money.currency | string |
Die Währung. |
|
Name
|
order.source.name | string |
Der Name. |
|
Staat
|
order.state | string |
Der aktuelle Zustand. |
Zahlungserstattung erhalten
Ruft eine bestimmte Rückerstattung mithilfe des refund_id ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Erstattungs-ID
|
refund_id | True | string |
Der Bezeichner der Rückerstattung. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
ID
|
refund.id | string |
Der eindeutige, quadratisch ausgestellte Bezeichner. |
|
Der Status
|
refund.status | string |
Der aktuelle Überprüfungsstatus dieses Objekts. |
|
Betrag
|
refund.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
refund.amount_money.currency | string |
Die Währung. |
|
Zahlungs-ID
|
refund.payment_id | string |
Die eindeutige ID der Zahlung. |
|
Auftrags-ID
|
refund.order_id | string |
Die ID der Bestellung. |
|
Erstellt unter
|
refund.created_at | string |
Der Zeitstempel, der die Erstellungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Aktualisiert unter
|
refund.updated_at | string |
Der Zeitstempel, der die neueste Aktualisierungszeit dieses Objekts im RFC 3339-Format angibt. |
|
Bearbeitungsgebühr
|
refund.processing_fee | array of object | |
|
Effektiv bei
|
refund.processing_fee.effective_at | string |
Der Zeitstempel, zu dem die Gebühr wirksam wird, im RFC 3339-Format. |
|
Typ
|
refund.processing_fee.type | string |
Gibt den Typ an. |
|
Betrag
|
refund.processing_fee.amount_money.amount | integer |
Der Betrag. |
|
Währung
|
refund.processing_fee.amount_money.currency | string |
Die Währung. |
|
Speicherort-ID
|
refund.location_id | string |
Der Bezeichner des Speicherorts. |
|
Ursache
|
refund.reason | string |
Der Grund für dieses Objekt. |
Definitionen
Objekt
Dies ist der Typ 'object'.