Płatności kwadratowe (niezależny wydawca) (wersja zapoznawcza)

Square pomaga milionom sprzedawców prowadzić swoją działalność - od bezpiecznego przetwarzania kart kredytowych po rozwiązania do punktu sprzedaży. Ten łącznik zawiera akcje dla następujących punktów końcowych: Płatności, Terminal, Zamówienia, Subskrypcje, Faktury, Wykaz, Spis i Klienci.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa	Class	Regions
Copilot Studio	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Logic Apps	Standard	Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD)
Power Apps	Premium	Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Power Automate	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)

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

Metadane łącznika
Publisher	Troy Taylor
Witryna internetowa	https://squareup.com/
Zasady ochrony prywatności	https://squareup.com/us/en/legal/general/privacy
Kategorie	Handel; Sprzedaż i CRM

Limity ograniczania

Nazwa	Wywołania	Okres odnowienia
Wywołania interfejsu API na połączenie	100	60 sekund

Akcje

Aktualizowanie faktury	Aktualizuje fakturę, modyfikując pola, usuwając pola lub oba te pola.
Aktualizowanie grupy klientów	Aktualizuje grupę klientów.
Aktualizowanie klienta	Aktualizuje profil klienta. Aby zmienić atrybut, określ nową wartość. Aby usunąć atrybut, określ wartość jako pusty ciąg lub pusty obiekt.
Aktualizowanie list modyfikatora elementów	Aktualizuje obiekty CatalogModifierList, które mają zastosowanie do docelowego elementu CatalogItem bez konieczności wykonywania operacji upsert na całym elemencie.
Aktualizowanie podatków od elementów	Aktualizuje obiekty CatalogTax, które mają zastosowanie do docelowego elementu CatalogItem bez konieczności wykonywania operacji upsert na całym elemencie.
Aktualizowanie płatności	Aktualizuje płatność ze stanem APPROVED. Możesz zaktualizować amount_money i tip_money przy użyciu tego punktu końcowego.
Aktualizowanie subskrypcji	Aktualizuje subskrypcję. Możesz ustawić, zmodyfikować i wyczyścić wartości pól subskrypcji.
Anulowanie faktury	Anuluje fakturę. Sprzedawca nie może zbierać płatności za anulowaną fakturę.
Anulowanie płatności	Anuluje (unieważnia) płatność. Możesz użyć tego punktu końcowego, aby anulować płatność ze stanem APPROVED.
Anulowanie płatności przy użyciu klucza idempotentności	Anuluje (unieważnia) płatność zidentyfikowaną przez klucz idempotentności określony w żądaniu. Użyj tej metody, gdy stan żądania CreatePayment jest nieznany (na przykład po wysłaniu żądania CreatePayment wystąpi błąd sieci i nie otrzymasz odpowiedzi). W takim przypadku możesz bezpośrednio anulować płatność przy użyciu tego punktu końcowego. W żądaniu podaj ten sam klucz idempotentności podany w żądaniu CreatePayment, które chcesz anulować. Po anulowaniu płatności możesz ponownie przesłać żądanie CreatePayment. Należy pamiętać, że jeśli nie zostanie znaleziona żadna płatność z określonym kluczem idempotentności, nie zostanie podjęta żadna akcja i punkt końcowy zostanie zwrócony pomyślnie.
Anulowanie subskrypcji	Ustawia pole canceled_date na koniec aktywnego okresu rozliczeniowego. Po tej dacie stan zmieni się z AKTYWNE na ANULOWANE.
Anulowanie wyewidencjonowania terminalu	Anuluje żądanie wyewidencjonowania terminalu, jeśli stan żądania na to zezwala.
Anulowanie zwrotu terminalu	Anuluje żądanie zwrotu kosztów terminalu międzyac według identyfikatora żądania zwrotu pieniędzy, jeśli stan żądania na to zezwala.
Dodawanie grupy do klienta	Dodaje członkostwo w grupie do klienta. Klient jest identyfikowany przez wartość customer_id, a grupa klientów jest identyfikowana przez wartość group_id.
Informacje o katalogu	Pobiera informacje o interfejsie API wykazu kwadratowego, takie jak limity rozmiaru partii, które mogą być używane przez punkt końcowy batchUpsertCatalogObjects.
Karty listy	Pobiera listę kart należących do konta wysyłającego żądanie.
Kolejność aktualizacji (wersja beta)	Aktualizuje kolejność otwierania, dodając, zastępując lub usuwając pola. Nie można zaktualizować zamówień ze stanem UKOŃCZONE lub ANULOWANE.
Kolejność klonowania (wersja beta)	Tworzy nową kolejność w stanie DRAFT przez duplikowanie istniejącego zamówienia. Nowo utworzone zamówienie zawiera tylko podstawowe pola (takie jak elementy wiersza, podatki i rabaty) skopiowane z oryginalnego zamówienia.
Liczba spisów pobierania wsadowego	Zwraca bieżące liczby dla podanych obiektów CatalogObjects w żądanych lokalizacjach.
Obiekt wykazu Upsert	Tworzy lub aktualizuje docelowy obiekt CatalogObject.
Obiekty wykazu upsert usługi Batch	Tworzy lub aktualizuje maksymalnie 10 000 obiektów docelowych na podstawie podanej listy obiektów. Obiekty docelowe są grupowane w partie, a każda partia jest wstawiana/aktualizowana w sposób all-or-nothing. Jeśli obiekt w partii jest źle sformułowany lub narusza ograniczenie bazy danych, cała partia zawierająca ten element zostanie zignorowana. Jednak inne partie w tym samym żądaniu mogą nadal zakończyć się powodzeniem. Każda partia może zawierać maksymalnie 1000 obiektów, a partie będą przetwarzane w kolejności, o ile łączna liczba obiektów dla żądania (elementy, odmiany, listy modyfikatora, rabaty i podatki) nie przekracza 10 000.
Obliczanie kolejności (wersja beta)	Umożliwia aplikacjom wyświetlanie podglądu cen zamówień bez tworzenia zamówienia.
Pobieranie dowodów sporu	Zwraca metadane dowodów określone przez identyfikator dowodu w ścieżce adresu URL żądania. Należy zachować kopię przekazanych dowodów, jeśli chcesz się do niej odwoływać później. Nie można pobrać dowodów po jego przekazaniu.
Pobieranie faktury	Pobiera fakturę według identyfikatora faktury.
Pobieranie grupy klientów	Pobiera określoną grupę klientów.
Pobieranie karty	Pobiera szczegóły dla określonej karty.
Pobieranie klienta	Zwraca szczegóły dla pojedynczego klienta.
Pobieranie korekty spisu	Zwraca obiekt InventoryAdjustment z podanym adjustment_id.
Pobieranie liczby fizycznych spisu	Zwraca obiekt InventoryPhysicalCount z podanym physical_count_id.
Pobieranie liczby spisów	Pobiera bieżącą obliczoną liczbę akcji dla danego obiektu CatalogObject w danym zestawie lokalizacji.
Pobieranie obiektu wykazu	Zwraca pojedynczy element CatalogItem jako obiekt CatalogObject na podstawie podanego identyfikatora. Zwrócony obiekt zawiera wszystkie odpowiednie informacje CatalogItem, w tym: elementy podrzędne CatalogItemVariation, odwołania do obiektów CatalogModifierList oraz identyfikatory wszystkich obiektów CatalogTax, które mają do niego zastosowanie.
Pobieranie obiektów wykazu w usłudze Batch	Zwraca zestaw obiektów na podstawie podanego identyfikatora. Każdy element CatalogItem zwrócony w zestawie zawiera wszystkie jego informacje podrzędne, w tym: wszystkie jego obiekty CatalogItemVariation, odwołania do obiektów CatalogModifierList i identyfikatory wszystkich obiektów CatalogTax, które mają do niego zastosowanie.
Pobieranie segmentu klienta	Pobiera określony segment klienta.
Pobieranie sporu	Zwraca szczegóły dotyczące konkretnego sporu.
Pobieranie subskrypcji	Pobiera subskrypcję.
Pobieranie transferu spisu (wersja beta)	Zwraca obiekt InventoryTransfer z podanym transfer_id.
Pobieranie wyewidencjonowania terminalu	Pobiera żądanie wyewidencjonowania terminalu przez checkout_id.
Pobieranie zamówienia	Pobiera zamówienie według identyfikatora.
Pobieranie zamówień wsadowych	Pobiera zestaw zamówień według ich identyfikatorów. Jeśli dany identyfikator zamówienia nie istnieje, identyfikator jest ignorowany zamiast generowania błędu.
Przeszukiwanie obiektów wykazu	Wyszukuje element CatalogObject dowolnego typu, pasując do obsługiwanych wartości atrybutów wyszukiwania, z wyłączeniem niestandardowych wartości atrybutów dla elementów lub odmian elementów względem co najmniej jednego filtru określonego zapytania.
Prześlij dowody	Przesyła dowody do banku posiadacza karty. Przed przesłaniem dowodów Square skompiluje wszystkie dostępne dowody. Obejmuje to dowody przekazane przy użyciu punktów końcowych CreateDisputeEvidenceFile i CreateDisputeEvidenceText oraz dowodów dostarczonych automatycznie przez square, gdy są dostępne.
Publikowanie faktury	Publikuje określoną fakturę roboczą. Po opublikowaniu faktury square następuje zgodnie z konfiguracją faktury. Na przykład Square wysyła fakturę na adres e-mail klienta, pobiera opłaty za kartę klienta w pliku lub nic nie robi. Kwadrat udostępnia również fakturę na stronie faktury hostowanej na placu.
Płatność za zamówienie (wersja beta)	Zapłać za zamówienie przy użyciu co najmniej jednej zatwierdzonej płatności lub ureguluj zamówienie w sumie 0. Suma payment_ids wymienionych w żądaniu musi być równa sumie zamówień. Zamówienia o łącznej wartości 0 można oznaczyć jako płatne, określając pustą tablicę payment_ids w żądaniu.
Płatność zwrotu	Zwraca płatność. Możesz zwrócić całą kwotę płatności lub część. Możesz użyć tego punktu końcowego, aby uzyskać zwrot płatności kartą lub zarejestrować zwrot gotówki lub płatności zewnętrznej.
Rejestrowanie domeny za usługę Apple Pay	Aktywuje domenę do użycia z usługą Apple Pay w sieci Web i square. Walidacja jest przeprowadzana w tej domenie przez firmę Apple, aby upewnić się, że jest ona prawidłowo skonfigurowana jako domena z włączoną usługą Apple Pay.
Spis zmian wsadowych	Stosuje korekty i liczby do podanych ilości elementów. Po powodzeniu: zwraca bieżące obliczone liczby dla wszystkich obiektów, do których odwołuje się żądanie.
Tworzenie faktury	Tworzy wersję roboczą faktury dla zamówienia utworzonego przy użyciu interfejsu API zamówień. Faktura robocza pozostaje na Twoim koncie i nie jest podejmowana żadna akcja. Musisz opublikować fakturę, zanim square będzie mogła ją przetworzyć (wyślij ją na adres e-mail klienta lub załaduj kartę klienta w pliku).
Tworzenie grupy klientów	Tworzy nową grupę klientów dla firmy.
Tworzenie karty	Dodaje kartę do istniejącego sprzedawcy.
Tworzenie klienta	Tworzy nowego klienta dla firmy.
Tworzenie płatności	Tworzy płatność przy użyciu podanego źródła. Możesz użyć tego punktu końcowego, aby naładować kartę (kartę kredytową/debetową lub kwadratową kartę upominkową) lub zarejestrować płatność, którą sprzedawca otrzymał poza Square (płatność gotówkową od kupującego lub płatność, którą podmiot zewnętrzny przetworzył w imieniu sprzedawcy).
Tworzenie subskrypcji	Tworzy subskrypcję dla klienta w ramach planu subskrypcji. Jeśli podasz kartę w pliku w żądaniu, square pobiera opłaty za kartę dla subskrypcji. W przeciwnym razie kwadrat rozlicza fakturę na adres e-mail klienta. Subskrypcja zostanie uruchomiona natychmiast, chyba że żądanie zawiera opcjonalne start_date. Każda subskrypcja jest skojarzona z określoną lokalizacją.
Tworzenie tekstu dowodów sporu	Przekazuje tekst do użycia jako dowód na zakwestionowanie sporu.
Tworzenie wyewidencjonowania terminalu	Tworzy żądanie wyewidencjonowania terminalu i wysyła je do określonego urządzenia, aby pobrać opłatę za żądaną kwotę.
Tworzenie zamówienia	Tworzy nowe zamówienie, które może zawierać informacje o produktach na potrzeby zakupu i ustawień, które mają być stosowane do zakupu.
Tworzenie zwrotu kosztów terminalu	Tworzy żądanie zwrotu płatności międzyakcjowej ukończonej w terminalu kwadratowym.
Ukończ płatność	Kończy (przechwytuje) płatność. Domyślnie płatności są ustawiane na ukończenie natychmiast po ich utworzeniu.
Usuwanie dowodów sporu	Usuwa określone dowody z sporu.
Usuwanie faktury	Usuwa określoną fakturę. Po usunięciu faktury skojarzony stan zamówienia zmieni się na ANULOWANE. Możesz usunąć tylko wersję roboczą faktury (nie można usunąć opublikowanej faktury, w tym faktury zaplanowanej do przetworzenia).
Usuwanie grupy klientów	Usuwa grupę klientów zidentyfikowaną przez wartość group_id.
Usuwanie grupy z klienta	Usuwa członkostwo w grupie od klienta. Klient jest identyfikowany przez wartość customer_id, a grupa klientów jest identyfikowana przez wartość group_id.
Usuwanie klienta	Usuwa profil klienta z firmy. Ta operacja odłącza również wszystkie skojarzone karty w pliku.
Usuwanie obiektu wykazu	Usuwa pojedynczy obiekt CatalogObject na podstawie podanego identyfikatora i zwraca zestaw pomyślnie usuniętych identyfikatorów w odpowiedzi. Usunięcie jest zdarzeniem kaskadowym, tak aby wszystkie elementy podrzędne obiektu docelowego również zostały usunięte. Na przykład usunięcie elementu CatalogItem spowoduje również usunięcie wszystkich elementów podrzędnych CatalogItemVariation.
Usuwanie obiektów wykazu wsadowego	Usuwa zestaw elementów CatalogItems na podstawie podanej listy identyfikatorów docelowych i zwraca zestaw pomyślnie usuniętych identyfikatorów w odpowiedzi.
Usługa Batch pobiera zmiany spisu	Zwraca historyczne liczby fizyczne i korekty na podstawie podanych kryteriów filtrowania.
Uzyskiwanie płatności	Pobiera szczegóły dla określonej płatności.
Uzyskiwanie zwrotu płatności	Pobiera określony zwrot pieniędzy przy użyciu refund_id.
Uzyskiwanie zwrotu terminalu	Pobiera obiekt zwrotu kosztów terminalu międzyakowego według identyfikatora.
Wykaz list	Zwraca listę obiektów CatalogObject, która zawiera wszystkie obiekty zestawu żądanych typów (na przykład wszystkie obiekty CatalogItem i CatalogTax) w wykazie. ListaCatalog nie zwraca usuniętych elementów wykazu.
Wyszukaj subskrypcje	Wyszukuje subskrypcje. Wyniki są uporządkowane chronologicznie według daty utworzenia subskrypcji. Jeśli żądanie określa więcej niż jeden identyfikator lokalizacji, punkt końcowy porządkuje wynik według identyfikatora lokalizacji, a następnie według daty utworzenia w każdej lokalizacji. Jeśli w zapytaniu nie podano żadnych lokalizacji, przeszukiwane są wszystkie lokalizacje.
Wyszukiwanie faktur	Wyszukuje faktury z lokalizacji określonej w filtrze.
Wyszukiwanie klientów	Wyszukuje profile klientów skojarzone z kontem Square przy użyciu obsługiwanego filtru zapytania. Wywołanie metody SearchCustomers bez żadnego jawnego filtru zapytania zwraca wszystkie profile klientów uporządkowane alfabetycznie na podstawie given_name i family_name.
Wyszukiwanie wyewidencjonowania terminalu	Pobiera odfiltrowaną listę żądań wyewidencjonowania terminalu utworzonych przez konto wysyłające żądanie.
Wyszukiwanie zamówień	Przeszukaj wszystkie zamówienia dla co najmniej jednej lokalizacji. Zamówienia obejmują wszystkie transakcje sprzedaży, zwroty i wymiany niezależnie od tego, jak lub kiedy wchodziły w ekosystem square (np. punkt sprzedaży, faktury i interfejsy API łączenia).
Wyszukiwanie zwrotów terminalu	Pobiera przefiltrowaną listę żądań zwrotu w terminalu międzyakcyjnym utworzonych przez sprzedawcę wysyłającego żądanie.
Wyłączanie karty	Wyłącza kartę, uniemożliwiając dalsze aktualizacje lub opłaty. Wyłączenie już wyłączonej karty jest dozwolone, ale nie ma efektu.
Wyświetlanie listy dowodów sporu	Zwraca listę dowodów skojarzonych z spórem.
Wyświetlanie listy faktur	Zwraca listę faktur dla danej lokalizacji.
Wyświetlanie listy grup klientów	Pobiera listę grup klientów firmy.
Wyświetlanie listy klientów	Wyświetla listę profilów klientów skojarzonych z kontem square. W normalnych warunkach operacyjnych nowo utworzone lub zaktualizowane profile klientów stają się dostępne dla operacji wyświetlania listy w czasie poniżej 30 sekund. Czasami propagacja nowych lub zaktualizowanych profilów może zająć więcej niż minutę lub dłużej, zwłaszcza podczas zdarzeń sieciowych i awarii.
Wyświetlanie listy płatności	Pobiera listę płatności pobieranych przez konto wysyłające żądanie. Wyniki są ostatecznie spójne, a pojawienie się nowych płatności lub zmian w płatnościach może potrwać kilka sekund.
Wyświetlanie listy segmentów klientów	Pobiera listę segmentów klientów firmy.
Wyświetlanie listy sporów	Zwraca listę sporów skojarzonych z określonym kontem.
Wyświetlanie listy zdarzeń subskrypcji	Wyświetla listę wszystkich zdarzeń dla określonej subskrypcji.
Wyświetlanie listy zwrotów płatności	Pobiera listę zwrotów dla konta wysyłającego żądanie. Wyniki są ostatecznie spójne, a pojawienie się nowych zwrotów lub zmian zwrotów może potrwać kilka sekund.
Wznów subskrypcję	Wznawia dezaktywację subskrypcji.
Zaakceptuj spór	Akceptuje stratę w sporze. Square zwraca kwestionowaną kwotę do posiadacza karty i aktualizuje stan sporu do ZAAKCEPTOWANE. Square debetowe spornej kwoty z konta Square sprzedawcy. Jeśli konto Square nie ma wystarczających funduszy, Square debetowe skojarzonego konta bankowego.

Aktualizowanie faktury

Identyfikator operacji:: InvoiceUpdate

Aktualizuje fakturę, modyfikując pola, usuwając pola lub oba te pola.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator faktury	invoice_id	True	string	Identyfikator faktury.
Klucz idempotentności	idempotency_key		string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
UID	uid		string	Identyfikator wygenerowany przez kwadrat.
Włączone przechylanie	tipping_enabled		boolean	Jeśli ustawiono wartość true, zapewnia klientowi miejsce na zapłacenie porady.
Pola do wyczyszczenia	fields_to_clear		array of string

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	invoice.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
wersja	invoice.version	integer	Bieżąca wersja tego obiektu.
Identyfikator lokalizacji	invoice.location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	invoice.order_id	string	Identyfikator zamówienia.
Żądania płatności	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Identyfikator wygenerowany przez kwadrat.
Typ żądania	invoice.payment_requests.request_type	string	Określa typ żądania płatności. Ten typ definiuje sposób określania kwoty żądania płatności.
Data upływu	invoice.payment_requests.due_date	string	Data ukończenia żądania płatności w formacie RRRR-MM-DD.
Włączone przechylanie	invoice.payment_requests.tipping_enabled	boolean	Jeśli ustawiono wartość true, zapewnia klientowi miejsce na zapłacenie porady.
Kwota	invoice.payment_requests.computed_amount_money.amount	integer	Kwota.
Waluta	invoice.payment_requests.computed_amount_money.currency	string	Waluta.
Kwota	invoice.payment_requests.total_completed_amount_money.amount	integer	Kwota.
Waluta	invoice.payment_requests.total_completed_amount_money.currency	string	Waluta.
Automatyczne źródło płatności	invoice.payment_requests.automatic_payment_source	string	Forma płatności za automatyczną płatność.
Numer faktury	invoice.invoice_number	string	Przyjazny dla użytkownika numer faktury. Wartość jest unikatowa w obrębie lokalizacji. Jeśli nie zostanie podana podczas tworzenia faktury, square przypisuje wartość.
Title	invoice.title	string	Tytuł.
Description	invoice.description	string	Opis.
Zaplanowane o godzinie	invoice.scheduled_at	string	Sygnatura czasowa zaplanowana przetwarzania w formacie RFC 3339.
Status	invoice.status	string	Bieżący stan weryfikacji tego obiektu.
Timezone	invoice.timezone	string	Strefa czasowa używana do interpretowania dat kalendarza. Po utworzeniu faktury to pole jest ustawione na strefę czasową określoną dla lokalizacji sprzedawcy. Nie można zmienić wartości.
Utworzono pod adresem	invoice.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	invoice.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Identyfikator klienta	invoice.primary_recipient.customer_id	string	Identyfikator klienta skojarzonego z zamówieniem.
Imię	invoice.primary_recipient.given_name	string	Podane przez adresata (czyli imię).
Nazwisko	invoice.primary_recipient.family_name	string	Rodzina adresata (czyli nazwisko).
Adres e-mail	invoice.primary_recipient.email_address	string	Adres e-mail adresata.
Numer telefonu	invoice.primary_recipient.phone_number	string	Numer telefonu odbiorcy.
Kwota	invoice.next_payment_amount_money.amount	integer	Kwota.
Waluta	invoice.next_payment_amount_money.currency	string	Waluta.
Card	invoice.accepted_payment_methods.card	boolean	Wskazuje, czy płatności kartą kredytową lub debetową są akceptowane.
Kwadratowa karta upominkowa	invoice.accepted_payment_methods.square_gift_card	boolean	Wskazuje, czy płatności kartami upominkowymi square są akceptowane.
Konto	invoice.accepted_payment_methods.bank_account	boolean	Wskazuje, czy płatności przelewów bankowych są akceptowane.
Pola niestandardowe	invoice.custom_fields	array of object
Etykieta	invoice.custom_fields.label	string	Etykieta lub tytuł pola niestandardowego.
Wartość	invoice.custom_fields.value	string	Tekst pola niestandardowego.
Umieszczenie	invoice.custom_fields.placement	string	Lokalizacja pola niestandardowego na fakturze.
Metoda dostarczania	invoice.delivery_method	string	Metoda dostarczania używana przez Square do wysyłania faktury, przypomnień i paragonów do klienta. Po opublikowaniu faktury square przetwarza fakturę na podstawie ustawień metody dostawy i żądania płatności, natychmiast lub w dniu scheduled_at, jeśli określono.
Data sprzedaży lub usługi	invoice.sale_or_service_date	string	Data sprzedaży lub data renderowania usługi w formacie RRRR-MM-DD. To pole może służyć do określenia daty wcześniejszej lub przyszłej wyświetlanej na fakturze.

Aktualizowanie grupy klientów

Identyfikator operacji:: CustomerGroupUpdate

Aktualizuje grupę klientów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator grupy	group_id	True	string	Identyfikator grupy.
Name	name		string	Nazwa obiektu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	group.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Name	group.name	string	Nazwa obiektu.
Utworzono pod adresem	group.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	group.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.

Aktualizowanie klienta

Identyfikator operacji:: CustomerUpdate

Aktualizuje profil klienta. Aby zmienić atrybut, określ nową wartość. Aby usunąć atrybut, określ wartość jako pusty ciąg lub pusty obiekt.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator klienta	customer_id	True	string	Identyfikator klienta.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	customer.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Utworzono pod adresem	customer.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	customer.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Imię	customer.given_name	string	Podana (tj. imię) nazwa skojarzona z profilem klienta.
Nazwisko	customer.family_name	string	Rodzina (tj. nazwisko) skojarzona z profilem klienta.
Adres e-mail	customer.email_address	string	Adres e-mail skojarzony z profilem klienta.
Linia adresowa 1	customer.address.address_line_1	string	Pierwszy wiersz adresu. Pola rozpoczynające się od address_line zawierają najbardziej szczegółowe informacje dotyczące adresu, takie jak numer ulicy, nazwa ulicy i nazwa budynku.
Wiersz adresu 2	customer.address.address_line_2	string	Drugi wiersz adresu, jeśli istnieje.
Miejscowość	customer.address.locality	string	Miasto lub miasto adresu.
Poziom okręgu administracyjnego 1	customer.address.administrative_district_level_1	string	Jednostka cywilna w kraju adresu. W USA jest to stan.
Kod pocztowy	customer.address.postal_code	string	Kod pocztowy adresu.
Country	customer.address.country	string	Kraj adresu w formacie ISO 3166-1-alfa-2.
Identyfikator odwołania	customer.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Uwaga / Notatka	customer.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Wiadomość e-mail anulowana	customer.preferences.email_unsubscribed	boolean	Wskazuje, czy klient anulował subskrypcję wiadomości e-mail kampanii marketingowej. Wartość true oznacza, że klient zdecydował się zrezygnować z marketingu e-mail od bieżącego sprzedawcy Square lub od wszystkich sprzedawców Kwadratowych.
Źródło tworzenia	customer.creation_source	string	Źródło tworzenia reprezentuje metodę używaną do tworzenia profilu klienta.
wersja	customer.version	integer	Bieżąca wersja tego obiektu.

Aktualizowanie list modyfikatora elementów

Identyfikator operacji:: CatalogUpdateModifier

Aktualizuje obiekty CatalogModifierList, które mają zastosowanie do docelowego elementu CatalogItem bez konieczności wykonywania operacji upsert na całym elemencie.

Parametry

Nazwa	Klucz	Typ
Identyfikatory elementów	item_ids	array of string
Listy modyfikatora do włączenia	modifier_lists_to_enable	array of string
Listy modyfikatora do wyłączenia	modifier_lists_to_disable	array of string

Zwraca

Nazwa	Ścieżka	Typ	Opis
Zaktualizowano o	updated_at	string	Sygnatura czasowa bazy danych tej aktualizacji w formacie RFC 3339.

Aktualizowanie podatków od elementów

Identyfikator operacji:: CatalogUpdateTaxes

Aktualizuje obiekty CatalogTax, które mają zastosowanie do docelowego elementu CatalogItem bez konieczności wykonywania operacji upsert na całym elemencie.

Parametry

Nazwa	Klucz	Typ
Identyfikatory elementów	item_ids	array of string
Podatki do włączenia	taxes_to_enable	array of string
Podatki do wyłączenia	taxes_to_disable	array of string

Zwraca

Nazwa	Ścieżka	Typ	Opis
Zaktualizowano o	updated_at	string	Sygnatura czasowa bazy danych tej aktualizacji w formacie RFC 3339.

Aktualizowanie płatności

Identyfikator operacji:: PaymentUpdate

Aktualizuje płatność ze stanem APPROVED. Możesz zaktualizować amount_money i tip_money przy użyciu tego punktu końcowego.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator płatności	payment_id	True	string	Identyfikator płatności.
Klucz idempotentności	idempotency_key		string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
Kwota	amount		integer	Kwota.
Waluta	currency		string	Waluta.
Kwota	amount		integer	Kwota.
Waluta	currency		string	Waluta.
Token wersji	version_token		string	Ten nieprzezroczysty token identyfikuje określoną wersję obiektu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	payment.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Utworzono pod adresem	payment.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	payment.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Kwota	payment.amount_money.amount	integer	Kwota.
Waluta	payment.amount_money.currency	string	Waluta.
Kwota	payment.tip_money.amount	integer	Kwota.
Waluta	payment.tip_money.currency	string	Waluta.
Status	payment.status	string	Bieżący stan weryfikacji tego obiektu.
Czas trwania opóźnienia	payment.delay_duration	string	Czas trwania po utworzeniu płatności, gdy Square automatycznie stosuje delay_action do płatności. Ta automatyczna delay_action dotyczy tylko płatności, które nie docierają do stanu terminalu (UKOŃCZONE, ANULOWANE lub NIEUDANE) przed upływem delay_duration czasu. To pole jest określane jako czas trwania w formacie RFC 3339.
Typ źródła	payment.source_type	string	Typ źródła dla tej płatności. Bieżące wartości to CARD, BANK_ACCOUNT, PORTFEL, CASH lub EXTERNAL.
Status	payment.card_details.status	string	Bieżący stan.
Znak karty	payment.card_details.card.card_brand	string	Marka karty.
Ostatnie 4	payment.card_details.card.last_4	string	Ostatnie 4 cyfry numeru karty.
Miesiąc eksploduj	payment.card_details.card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok eksplorowy	payment.card_details.card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Odcisk palca	payment.card_details.card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
Typ karty	payment.card_details.card.card_type	string	Typ karty.
Typ przedpłacony	payment.card_details.card.prepaid_type	string	Wskazuje, czy karta jest przedpłacona, czy nie.
BIN	payment.card_details.card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN).
Entry, metoda	payment.card_details.entry_method	string	Metoda używana do wprowadzania szczegółów karty dla płatności. Metoda może być KEYED, SWIPED, EMV, ON_FILE lub CONTACTLESS.
Stan CVV	payment.card_details.cvv_status	string	Kod stanu zwrócony z sprawdzania wartości weryfikacji karty (CVV). Kod może być CVV_ACCEPTED, CVV_REJECTED lub CVV_NOT_CHECKED.
Stan usługi AVS	payment.card_details.avs_status	string	Kod stanu zwrócony z sprawdzania systemu weryfikacji adresów (AVS). Kod może być AVS_ACCEPTED, AVS_REJECTED lub AVS_NOT_CHECKED.
Kod wyniku uwierzytelniania	payment.card_details.auth_result_code	string	Kod stanu zwrócony przez wystawcę karty, który opisuje stan autoryzacji płatności.
Opis instrukcji	payment.card_details.statement_description	string	Opis instrukcji wysyłany do sieci kart.
Autoryzowane pod adresem	payment.card_details.card_payment_timeline.authorized_at	string	Sygnatura czasowa autoryzacji płatności w formacie RFC 3339.
Identyfikator lokalizacji	payment.location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	payment.order_id	string	Identyfikator zamówienia.
Utworzono pod adresem	payment.risk_evaluation.created_at	string	Sygnatura czasowa utworzona w formacie RFC 3339.
Poziom ryzyka	payment.risk_evaluation.risk_level	string	Poziom ryzyka skojarzony z płatnością.
Uwaga / Notatka	payment.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Identyfikator klienta	payment.customer_id	string	Identyfikator tego obiektu reprezentującego klienta.
Kwota	payment.total_money.amount	integer	Kwota.
Waluta	payment.total_money.currency	string	Waluta.
Kwota	payment.approved_money.amount	integer	Kwota.
Waluta	payment.approved_money.currency	string	Waluta.
Capabilities	payment.capabilities	array of string
Numer paragonu	payment.receipt_number	string	Numer paragonu płatności. W przypadku anulowania płatności brakuje pola.
Akcja opóźniająca	payment.delay_action	string	Akcja, która ma zostać zastosowana do płatności po upływie delay_duration.
Opóźnione do	payment.delayed_until	string	Sygnatura czasowa tylko do odczytu w przypadku automatycznego zastosowania delay_action w formacie RFC 3339.
Produkt kwadratowy	payment.application_details.square_product	string	Produkt kwadratowy, taki jak Square Point of Sale (POS), faktury kwadratowe lub kwadratowy terminal wirtualny.
Identyfikator aplikacji	payment.application_details.application_id	string	Identyfikator kwadratowy tylko do odczytu przypisany do aplikacji.
Token wersji	payment.version_token	string	Ten nieprzezroczysty token identyfikuje określoną wersję obiektu.

Aktualizowanie subskrypcji

Identyfikator operacji:: SubscriptionUpdate

Aktualizuje subskrypcję. Możesz ustawić, zmodyfikować i wyczyścić wartości pól subskrypcji.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator subskrypcji	subscription_id	True	string	Identyfikator subskrypcji.
wersja	version		integer	Bieżąca wersja tego obiektu.
Procent podatku	tax_percentage		string	Kwota podatku stosowana podczas rozliczeń subskrypcji.
Kwota	amount		integer	Kwota.
Waluta	currency		string	Waluta.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	subscription.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator lokalizacji	subscription.location_id	string	Identyfikator lokalizacji.
Identyfikator planu	subscription.plan_id	string	Identyfikator skojarzonego planu subskrypcji.
Identyfikator klienta	subscription.customer_id	string	Identyfikator tego obiektu reprezentującego klienta.
Status	subscription.status	string	Bieżący stan weryfikacji tego obiektu.
Kwota	subscription.price_override_money.amount	integer	Kwota.
Waluta	subscription.price_override_money.currency	string	Waluta.
wersja	subscription.version	integer	Bieżąca wersja tego obiektu.
Utworzono pod adresem	subscription.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Timezone	subscription.timezone	string	Strefa czasowa używana do interpretowania dat kalendarza. Po utworzeniu faktury to pole jest ustawione na strefę czasową określoną dla lokalizacji sprzedawcy. Nie można zmienić wartości.
Name	subscription.source.name	string	Nazwa.

Anulowanie faktury

Identyfikator operacji:: InvoiceCancel

Anuluje fakturę. Sprzedawca nie może zbierać płatności za anulowaną fakturę.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator faktury	invoice_id	True	string	Identyfikator faktury.
wersja	version		integer	Wersja.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	invoice.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
wersja	invoice.version	integer	Bieżąca wersja tego obiektu.
Identyfikator lokalizacji	invoice.location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	invoice.order_id	string	Identyfikator zamówienia.
Żądania płatności	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Identyfikator wygenerowany przez kwadrat.
Typ żądania	invoice.payment_requests.request_type	string	Określa typ żądania płatności. Ten typ definiuje sposób określania kwoty żądania płatności.
Data upływu	invoice.payment_requests.due_date	string	Data ukończenia żądania płatności w formacie RRRR-MM-DD.
Włączone przechylanie	invoice.payment_requests.tipping_enabled	boolean	Jeśli ustawiono wartość true, zapewnia klientowi miejsce na zapłacenie porady.
Przypomnienia	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Identyfikator przypisany do kwadratu.
Względne dni zaplanowane	invoice.payment_requests.reminders.relative_scheduled_days	integer	Liczba dni przed (liczba ujemna) lub po (liczbie dodatniej) żądanie płatności due_date po wysłaniu przypomnienia.
Message	invoice.payment_requests.reminders.message	string	Wiadomość.
Status	invoice.payment_requests.reminders.status	string	Bieżący stan.
Kwota	invoice.payment_requests.computed_amount_money.amount	integer	Kwota.
Waluta	invoice.payment_requests.computed_amount_money.currency	string	Waluta.
Kwota	invoice.payment_requests.total_completed_amount_money.amount	integer	Kwota.
Waluta	invoice.payment_requests.total_completed_amount_money.currency	string	Waluta.
Automatyczne źródło płatności	invoice.payment_requests.automatic_payment_source	string	Forma płatności za automatyczną płatność.
Numer faktury	invoice.invoice_number	string	Przyjazny dla użytkownika numer faktury. Wartość jest unikatowa w obrębie lokalizacji. Jeśli nie zostanie podana podczas tworzenia faktury, square przypisuje wartość.
Title	invoice.title	string	Tytuł.
Description	invoice.description	string	Opis.
Zaplanowane o godzinie	invoice.scheduled_at	string	Sygnatura czasowa zaplanowana przetwarzania w formacie RFC 3339.
Status	invoice.status	string	Bieżący stan weryfikacji tego obiektu.
Timezone	invoice.timezone	string	Strefa czasowa używana do interpretowania dat kalendarza. Po utworzeniu faktury to pole jest ustawione na strefę czasową określoną dla lokalizacji sprzedawcy. Nie można zmienić wartości.
Utworzono pod adresem	invoice.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	invoice.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Identyfikator klienta	invoice.primary_recipient.customer_id	string	Identyfikator klienta skojarzonego z zamówieniem.
Imię	invoice.primary_recipient.given_name	string	Podane przez adresata (czyli imię).
Nazwisko	invoice.primary_recipient.family_name	string	Rodzina adresata (czyli nazwisko).
Adres e-mail	invoice.primary_recipient.email_address	string	Adres e-mail adresata.
Numer telefonu	invoice.primary_recipient.phone_number	string	Numer telefonu odbiorcy.
Card	invoice.accepted_payment_methods.card	boolean	Wskazuje, czy płatności kartą kredytową lub debetową są akceptowane.
Kwadratowa karta upominkowa	invoice.accepted_payment_methods.square_gift_card	boolean	Wskazuje, czy płatności kartami upominkowymi square są akceptowane.
Konto	invoice.accepted_payment_methods.bank_account	boolean	Wskazuje, czy płatności przelewów bankowych są akceptowane.
Pola niestandardowe	invoice.custom_fields	array of object
Etykieta	invoice.custom_fields.label	string	Etykieta lub tytuł pola niestandardowego.
Wartość	invoice.custom_fields.value	string	Tekst pola niestandardowego.
Umieszczenie	invoice.custom_fields.placement	string	Lokalizacja pola niestandardowego na fakturze.
Metoda dostarczania	invoice.delivery_method	string	Metoda dostarczania używana przez Square do wysyłania faktury, przypomnień i paragonów do klienta. Po opublikowaniu faktury square przetwarza fakturę na podstawie ustawień metody dostawy i żądania płatności, natychmiast lub w dniu scheduled_at, jeśli określono.
Data sprzedaży lub usługi	invoice.sale_or_service_date	string	Data sprzedaży lub data renderowania usługi w formacie RRRR-MM-DD. To pole może służyć do określenia daty wcześniejszej lub przyszłej wyświetlanej na fakturze.

Anulowanie płatności

Identyfikator operacji:: PaymentCancel

Anuluje (unieważnia) płatność. Możesz użyć tego punktu końcowego, aby anulować płatność ze stanem APPROVED.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator płatności	payment_id	True	string	Identyfikator płatności.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	payment.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Utworzono pod adresem	payment.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	payment.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Kwota	payment.amount_money.amount	integer	Kwota.
Waluta	payment.amount_money.currency	string	Waluta.
Kwota	payment.tip_money.amount	integer	Kwota.
Waluta	payment.tip_money.currency	string	Waluta.
Status	payment.status	string	Bieżący stan weryfikacji tego obiektu.
Czas trwania opóźnienia	payment.delay_duration	string	Czas trwania po utworzeniu płatności, gdy Square automatycznie stosuje delay_action do płatności. Ta automatyczna delay_action dotyczy tylko płatności, które nie docierają do stanu terminalu (UKOŃCZONE, ANULOWANE lub NIEUDANE) przed upływem delay_duration czasu. To pole jest określane jako czas trwania w formacie RFC 3339.
Typ źródła	payment.source_type	string	Typ źródła dla tej płatności. Bieżące wartości to CARD, BANK_ACCOUNT, PORTFEL, CASH lub EXTERNAL.
Status	payment.card_details.status	string	Bieżący stan.
Znak karty	payment.card_details.card.card_brand	string	Marka karty.
Ostatnie 4	payment.card_details.card.last_4	string	Ostatnie 4 cyfry numeru karty.
Miesiąc eksploduj	payment.card_details.card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok eksplorowy	payment.card_details.card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Odcisk palca	payment.card_details.card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
Typ karty	payment.card_details.card.card_type	string	Typ karty.
Typ przedpłacony	payment.card_details.card.prepaid_type	string	Wskazuje, czy karta jest przedpłacona, czy nie.
BIN	payment.card_details.card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN).
Entry, metoda	payment.card_details.entry_method	string	Metoda używana do wprowadzania szczegółów karty dla płatności. Metoda może być KEYED, SWIPED, EMV, ON_FILE lub CONTACTLESS.
Stan CVV	payment.card_details.cvv_status	string	Kod stanu zwrócony z sprawdzania wartości weryfikacji karty (CVV). Kod może być CVV_ACCEPTED, CVV_REJECTED lub CVV_NOT_CHECKED.
Stan usługi AVS	payment.card_details.avs_status	string	Kod stanu zwrócony z sprawdzania systemu weryfikacji adresów (AVS). Kod może być AVS_ACCEPTED, AVS_REJECTED lub AVS_NOT_CHECKED.
Kod wyniku uwierzytelniania	payment.card_details.auth_result_code	string	Kod stanu zwrócony przez wystawcę karty, który opisuje stan autoryzacji płatności.
Opis instrukcji	payment.card_details.statement_description	string	Opis instrukcji wysyłany do sieci kart.
Autoryzowane pod adresem	payment.card_details.card_payment_timeline.authorized_at	string	Sygnatura czasowa autoryzacji płatności w formacie RFC 3339.
Unieważnione o	payment.card_details.card_payment_timeline.voided_at	string	Sygnatura czasowa, kiedy płatność została unieważniona, w formacie RFC 3339.
Identyfikator lokalizacji	payment.location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	payment.order_id	string	Identyfikator zamówienia.
Utworzono pod adresem	payment.risk_evaluation.created_at	string	Sygnatura czasowa utworzona w formacie RFC 3339.
Poziom ryzyka	payment.risk_evaluation.risk_level	string	Poziom ryzyka skojarzony z płatnością.
Uwaga / Notatka	payment.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Identyfikator klienta	payment.customer_id	string	Identyfikator tego obiektu reprezentującego klienta.
Kwota	payment.total_money.amount	integer	Kwota.
Waluta	payment.total_money.currency	string	Waluta.
Kwota	payment.approved_money.amount	integer	Kwota.
Waluta	payment.approved_money.currency	string	Waluta.
Akcja opóźniająca	payment.delay_action	string	Akcja, która ma zostać zastosowana do płatności po upływie delay_duration.
Opóźnione do	payment.delayed_until	string	Sygnatura czasowa tylko do odczytu w przypadku automatycznego zastosowania delay_action w formacie RFC 3339.
Produkt kwadratowy	payment.application_details.square_product	string	Produkt kwadratowy, taki jak Square Point of Sale (POS), faktury kwadratowe lub kwadratowy terminal wirtualny.
Identyfikator aplikacji	payment.application_details.application_id	string	Identyfikator kwadratowy tylko do odczytu przypisany do aplikacji.
Token wersji	payment.version_token	string	Ten nieprzezroczysty token identyfikuje określoną wersję obiektu.

Anulowanie płatności przy użyciu klucza idempotentności

Identyfikator operacji:: PaymentCancelIdempotency

Anuluje (unieważnia) płatność zidentyfikowaną przez klucz idempotentności określony w żądaniu. Użyj tej metody, gdy stan żądania CreatePayment jest nieznany (na przykład po wysłaniu żądania CreatePayment wystąpi błąd sieci i nie otrzymasz odpowiedzi). W takim przypadku możesz bezpośrednio anulować płatność przy użyciu tego punktu końcowego. W żądaniu podaj ten sam klucz idempotentności podany w żądaniu CreatePayment, które chcesz anulować. Po anulowaniu płatności możesz ponownie przesłać żądanie CreatePayment. Należy pamiętać, że jeśli nie zostanie znaleziona żadna płatność z określonym kluczem idempotentności, nie zostanie podjęta żadna akcja i punkt końcowy zostanie zwrócony pomyślnie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Klucz idempotentności	idempotency_key		string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).

Zwraca

response: object

Anulowanie subskrypcji

Identyfikator operacji:: SubscriptionCancel

Ustawia pole canceled_date na koniec aktywnego okresu rozliczeniowego. Po tej dacie stan zmieni się z AKTYWNE na ANULOWANE.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator subskrypcji	subscription_id	True	string	Identyfikator subskrypcji.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	subscription.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator lokalizacji	subscription.location_id	string	Identyfikator lokalizacji.
Identyfikator planu	subscription.plan_id	string	Identyfikator skojarzonego planu subskrypcji.
Identyfikator klienta	subscription.customer_id	string	Identyfikator tego obiektu reprezentującego klienta.
Identyfikator karty	subscription.card_id	string	Identyfikator karty klienta, która jest obciążana opłatą za subskrypcję.
Data rozpoczęcia	subscription.start_date	string	Data rozpoczęcia subskrypcji w formacie RRRR-MM-DD.
Data anulowania	subscription.canceled_date	string	Data anulowania subskrypcji w formacie RRRR-MM-DD.
Płatna do daty	subscription.paid_until_date	string	Data płatności do.
Status	subscription.status	string	Bieżący stan weryfikacji tego obiektu.
Utworzono pod adresem	subscription.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
wersja	subscription.version	integer	Bieżąca wersja tego obiektu.
Timezone	subscription.timezone	string	Strefa czasowa używana do interpretowania dat kalendarza. Po utworzeniu faktury to pole jest ustawione na strefę czasową określoną dla lokalizacji sprzedawcy. Nie można zmienić wartości.
Name	subscription.source.name	string	Nazwa.

Anulowanie wyewidencjonowania terminalu

Identyfikator operacji:: TerminalCancelCheckout

Anuluje żądanie wyewidencjonowania terminalu, jeśli stan żądania na to zezwala.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator wyewidencjonowania	checkout_id	True	string	Identyfikator wyewidencjonowania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	checkout.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Kwota	checkout.amount_money.amount	integer	Kwota.
Waluta	checkout.amount_money.currency	string	Waluta.
Identyfikator odwołania	checkout.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Identyfikator urządzenia	checkout.device_options.device_id	string	Unikatowy identyfikator urządzenia przeznaczonego dla tego terminaluCheckout.
Zezwalaj na poradę	checkout.device_options.tip_settings.allow_tipping	boolean	Wskazuje, czy dla tego wyewidencjonowania włączono przechylanie. Wartość domyślna to fałsz.
Ekran pominięcia potwierdzenia	checkout.device_options.skip_receipt_screen	boolean	Nakazuje urządzeniu pominięcie ekranu potwierdzenia. Wartość domyślna to fałsz.
Status	checkout.status	string	Bieżący stan weryfikacji tego obiektu.
Przyczyna anulowania	checkout.cancel_reason	string	Przyczyna anulowanej transakcji.
Utworzono pod adresem	checkout.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	checkout.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
identyfikator aplikacji	checkout.app_id	string	Identyfikator aplikacji, która utworzyła wyewidencjonowania.
Czas trwania terminu trwania	checkout.deadline_duration	string	Czas trwania RFC 3339, po którym kasa zostanie automatycznie anulowana. Sprawdzanie terminalu, które jest oczekujące, jest automatycznie ANULOWANE i ma przyczynę anulowania TIMED_OUT. Ustawienie domyślne: 5 minut od utworzenia

Anulowanie zwrotu terminalu

Identyfikator operacji:: TerminalCancelRefund

Anuluje żądanie zwrotu kosztów terminalu międzyac według identyfikatora żądania zwrotu pieniędzy, jeśli stan żądania na to zezwala.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator zwrotu terminalu	terminal_refund_id	True	string	Identyfikator zwrotu terminalu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	refund.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator płatności	refund.payment_id	string	Unikatowy identyfikator płatności.
Kwota	refund.amount_money.amount	integer	Kwota.
Waluta	refund.amount_money.currency	string	Waluta.
Przyczyna	refund.reason	string	Przyczyna tego obiektu.
Identyfikator urządzenia	refund.device_id	string	Unikatowy identyfikator urządzenia przeznaczonego dla tego terminaluRefund.
Czas trwania terminu trwania	refund.deadline_duration	string	Czas trwania RFC 3339, po którym kasa zostanie automatycznie anulowana. Sprawdzanie terminalu, które jest oczekujące, jest automatycznie ANULOWANE i ma przyczynę anulowania TIMED_OUT. Ustawienie domyślne: 5 minut od utworzenia
Status	refund.status	string	Bieżący stan weryfikacji tego obiektu.
Przyczyna anulowania	refund.cancel_reason	string	Przyczyna anulowanej transakcji.
Utworzono pod adresem	refund.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	refund.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
identyfikator aplikacji	refund.app_id	string	Identyfikator aplikacji, która utworzyła wyewidencjonowania.
Znak karty	refund.card.card_brand	string	Marka karty.
last_4	refund.card.last_4	string	Ostatnie 4 cyfry numeru karty.
Miesiąc eksploduj	refund.card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok eksplorowy	refund.card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Odcisk palca	refund.card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
Typ karty	refund.card.card_type	string	Typ karty.
BIN	refund.card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN).
Identyfikator zamówienia	refund.order_id	string	Identyfikator zamówienia.
Identyfikator lokalizacji	refund.location_id	string	Identyfikator lokalizacji.

Dodawanie grupy do klienta

Identyfikator operacji:: CustomerAddGroup

Dodaje członkostwo w grupie do klienta. Klient jest identyfikowany przez wartość customer_id, a grupa klientów jest identyfikowana przez wartość group_id.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator klienta	customer_id	True	string	Identyfikator klienta.
Identyfikator grupy	group_id	True	string	Identyfikator grupy.

Zwraca

response: object

Informacje o katalogu

Identyfikator operacji:: CatalogInfo

Pobiera informacje o interfejsie API wykazu kwadratowego, takie jak limity rozmiaru partii, które mogą być używane przez punkt końcowy batchUpsertCatalogObjects.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Maksymalna liczba obiektów wsadowych operacji upsert na partię	limits.batch_upsert_max_objects_per_batch	integer	Maksymalna liczba obiektów, które mogą pojawić się w jednej partii w żądaniu /v2/catalog/batch-upsert.
Maksymalna łączna liczba obiektów operacji Upsert wsadowych	limits.batch_upsert_max_total_objects	integer	Maksymalna liczba obiektów, które mogą występować we wszystkich partiach w żądaniu /v2/catalog/batch-upsert.
Pobieranie maksymalnej liczby identyfikatorów obiektów w usłudze Batch	limits.batch_retrieve_max_object_ids	integer	Maksymalna liczba identyfikatorów obiektów, które mogą pojawić się w żądaniu /v2/catalog/batch-retrieve.
Maksymalny limit stron wyszukiwania	limits.search_max_page_limit	integer	Maksymalna liczba wyników, które mogą być zwracane na stronie odpowiedzi /v2/catalog/search.
Usuwanie wsadowego maksymalnej liczby identyfikatorów obiektów	limits.batch_delete_max_object_ids	integer	Maksymalna liczba identyfikatorów obiektów, które mogą być uwzględnione w pojedynczym żądaniu /v2/catalog/batch-delete.
Aktualizowanie identyfikatorów maksymalnych identyfikatorów elementów	limits.update_item_taxes_max_item_ids	integer	Maksymalna liczba identyfikatorów elementów, które mogą być uwzględnione w pojedynczym żądaniu /v2/catalog/update-item-taxes.
Aktualizowanie podatków od elementów maksymalnych podatków w celu włączenia	limits.update_item_taxes_max_taxes_to_enable	integer	Maksymalna liczba identyfikatorów podatkowych, które mają być włączone, które mogą zostać uwzględnione w jednym żądaniu /v2/catalog/update-item-tax.
Aktualizowanie podatków od elementów maksymalnych podatków, aby wyłączyć	limits.update_item_taxes_max_taxes_to_disable	integer	Maksymalna liczba identyfikatorów podatkowych, które mają być wyłączone, które mogą być uwzględnione w jednym żądaniu /v2/catalog/update-item-tax.
Aktualizowanie identyfikatorów elementów modyfikatora elementów	limits.update_item_modifier_lists_max_item_ids	integer	Maksymalna liczba identyfikatorów podatkowych, które mają być wyłączone, które mogą być uwzględnione w jednym żądaniu /v2/catalog/update-item-tax.
Aktualizowanie list modyfikatora elementów maksymalnej liczby list modyfikatora w celu włączenia	limits.update_item_modifier_lists_max_modifier_lists_to_enable	integer	Maksymalna liczba identyfikatorów listy modyfikatora, które mogą być uwzględnione w jednym żądaniu /v2/catalog/update-item-modifier-lists.
Aktualizowanie list modyfikatora elementów w celu wyłączenia maksymalnej liczby list modyfikatora	limits.update_item_modifier_lists_max_modifier_lists_to_disable	integer	Maksymalna liczba identyfikatorów listy modyfikatora, które mogą być uwzględnione w jednym żądaniu /v2/catalog/update-item-modifier-lists.

Karty listy

Identyfikator operacji:: CardList

Pobiera listę kart należących do konta wysyłającego żądanie.

Parametry

Nazwa	Klucz	Typ	Opis
Cursor	cursor	string	Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego.
Identyfikator klienta	customer_id	string	Ogranicz wyniki do kart skojarzonych z dostarczonym klientem. Domyślnie zwracane są wszystkie karty należące do sprzedawcy.
Uwzględnij wyłączone	include_disabled	boolean	Zawiera wyłączone karty. Domyślnie zwracane są wszystkie włączone karty należące do sprzedawcy.
Identyfikator odwołania	reference_id	string	Ogranicz wyniki do kart skojarzonych z podanymi reference_id.
Kolejność sortowania	sort_order	string	Sortuje zwracaną listę według momentu utworzenia karty z określonym zamówieniem.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Cards	cards	array of object
identyfikator	cards.card.id	string	Identyfikator obiektu
Linia adresowa 1	cards.card.billing_address.address_line_1	string	Pola rozpoczynające się od address_line zawierają najbardziej szczegółowe informacje dotyczące adresu, takie jak numer ulicy, nazwa ulicy i nazwa budynku.
Wiersz adresu 2	cards.card.billing_address.address_line_2	string	Drugi wiersz adresu, jeśli istnieje.
Miejscowość	cards.card.billing_address.locality	string	Miasto lub miasto adresu.
Poziom okręgu administracyjnego 1	cards.card.billing_address.administrative_district_level_1	string	Jednostka cywilna w kraju adresu. W USA jest to stan.
Kod pocztowy	cards.card.billing_address.postal_code	string	Kod pocztowy adresu.
Country	cards.card.billing_address.country	string	Kraj adresu w formacie ISO 3166-1-alfa-2.
Odcisk palca	cards.card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
BIN	cards.card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN).
Znak karty	cards.card.card_brand	string	Marka karty.
Typ karty	cards.card.card_type	string	Typ karty.
Nazwa symbolu karty	cards.card.cardholder_name	string	Nazwa symbolu karty.
Identyfikator klienta	cards.card.customer_id	string	Identyfikator klienta do skojarzenia z kartą.
Włączona	cards.card.enabled	boolean	Wskazuje, czy można użyć obiektu.
Miesiąc wygaśnięcia	cards.card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok wygaśnięcia	cards.card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Ostatnie 4	cards.card.last_4	string	Ostatnie 4 cyfry numeru karty.
Typ przedpłacony	cards.card.prepaid_type	string	Wskazuje, czy karta jest przedpłacona, czy nie.
Identyfikator odwołania	cards.card.reference_id	string	Opcjonalny identyfikator referencyjny zdefiniowany przez użytkownika, który kojarzy tę kartę z inną jednostką w systemie zewnętrznym.
wersja	cards.card.version	integer	Bieżący numer wersji karty. Zwiększa się przy każdej aktualizacji karty. Żądania aktualizacji istniejącego obiektu karty zostaną odrzucone, chyba że wersja w żądaniu jest zgodna z bieżącą wersją karty.

Kolejność aktualizacji (wersja beta)

Identyfikator operacji:: OrderUpdate

Aktualizuje kolejność otwierania, dodając, zastępując lub usuwając pola. Nie można zaktualizować zamówień ze stanem UKOŃCZONE lub ANULOWANE.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator zamówienia	order_id	True	string	Identyfikator zamówienia.
Klucz idempotentności	idempotency_key		string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
wersja	version		integer	Bieżąca wersja tego obiektu.
UID	uid		string	Identyfikator wygenerowany przez kwadrat.
Ilość	quantity		string	Liczba elementów, których dotyczy liczba fizyczna jako ciąg dziesiętny. Liczba może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Name	name		string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Kwota	amount		integer	Kwota.
Waluta	currency		string	Waluta.
Pola do wyczyszczenia	fields_to_clear		array of string

Zwraca

Nazwa	Ścieżka	Typ	Opis
wersja	order.version	integer	Bieżąca wersja tego obiektu.
Waluta	order.total_money.currency	string	Waluta.
Kwota	order.total_money.amount	integer	Kwota.
Name	order.source.name	string	Nazwa.
Elementy wiersza	order.line_items	array of object
Waluta	order.line_items.total_tax_money.currency	string	Waluta.
Kwota	order.line_items.total_tax_money.amount	integer	Kwota.
Kwota	order.line_items.total_money.amount	integer	Kwota.
Waluta	order.line_items.total_money.currency	string	Waluta.
Kwota	order.line_items.gross_sales_money.amount	integer	Kwota.
Waluta	order.line_items.gross_sales_money.currency	string	Waluta.
Kwota	order.line_items.base_price_money.amount	integer	Kwota.
Waluta	order.line_items.base_price_money.currency	string	Waluta.
Ilość	order.line_items.quantity	string	Liczba elementów, których dotyczy liczba fizyczna jako ciąg dziesiętny. Liczba może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Waluta	order.line_items.total_discount_money.currency	string	Waluta.
Kwota	order.line_items.total_discount_money.amount	integer	Kwota.
Name	order.line_items.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
UID	order.line_items.uid	string	Identyfikator wygenerowany przez kwadrat.
Kwota	order.line_items.variation_total_price_money.amount	integer	Kwota.
Waluta	order.line_items.variation_total_price_money.currency	string	Waluta.
State	order.state	string	Bieżący stan.
Kwota	order.total_service_charge_money.amount	integer	Kwota.
Waluta	order.total_service_charge_money.currency	string	Waluta.
identyfikator	order.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator lokalizacji	order.location_id	string	Identyfikator lokalizacji.
Kwota	order.total_tax_money.amount	integer	Kwota.
Waluta	order.total_tax_money.currency	string	Waluta.
Utworzono pod adresem	order.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Kwota	order.total_discount_money.amount	integer	Kwota.
Waluta	order.total_discount_money.currency	string	Waluta.
Waluta	order.net_amounts.service_charge_money.currency	string	Waluta.
Kwota	order.net_amounts.service_charge_money.amount	integer	Kwota.
Kwota	order.net_amounts.total_money.amount	integer	Kwota.
Waluta	order.net_amounts.total_money.currency	string	Waluta.
Waluta	order.net_amounts.discount_money.currency	string	Waluta.
Kwota	order.net_amounts.discount_money.amount	integer	Kwota.
Waluta	order.net_amounts.tax_money.currency	string	Waluta.
Kwota	order.net_amounts.tax_money.amount	integer	Kwota.
Zaktualizowano o	order.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.

Kolejność klonowania (wersja beta)

Identyfikator operacji:: OrderClone

Tworzy nową kolejność w stanie DRAFT przez duplikowanie istniejącego zamówienia. Nowo utworzone zamówienie zawiera tylko podstawowe pola (takie jak elementy wiersza, podatki i rabaty) skopiowane z oryginalnego zamówienia.

Parametry

Nazwa	Klucz	Typ	Opis
Identyfikator zamówienia	order_id	string	Identyfikator zamówienia.
wersja	version	integer	Wersja.
Klucz idempotentności	idempotency_key	string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	order.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator lokalizacji	order.location_id	string	Identyfikator lokalizacji.
Elementy wiersza	order.line_items	array of object
UID	order.line_items.uid	string	Identyfikator wygenerowany przez kwadrat.
Name	order.line_items.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Ilość	order.line_items.quantity	string	Liczba elementów, których dotyczy liczba fizyczna jako ciąg dziesiętny. Liczba może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Zastosowane podatki	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	Identyfikator przypisany do kwadratu.
Identyfikator UID podatku	order.line_items.applied_taxes.tax_uid	string	Identyfikator UID podatku, dla którego ten zastosowany podatek reprezentuje.
Kwota	order.line_items.applied_taxes.applied_money.amount	integer	Kwota.
Waluta	order.line_items.applied_taxes.applied_money.currency	string	Waluta.
Zastosowane rabaty	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Identyfikator przypisany do kwadratu.
Identyfikator UID rabatu	order.line_items.applied_discounts.discount_uid	string	Identyfikator uid rabatu, który reprezentuje zastosowany rabat.
Kwota	order.line_items.applied_discounts.applied_money.amount	integer	Kwota.
Waluta	order.line_items.applied_discounts.applied_money.currency	string	Waluta.
Kwota	order.line_items.base_price_money.amount	integer	Kwota.
Waluta	order.line_items.base_price_money.currency	string	Waluta.
Kwota	order.line_items.gross_sales_money.amount	integer	Kwota.
Waluta	order.line_items.gross_sales_money.currency	string	Waluta.
Kwota	order.line_items.total_tax_money.amount	integer	Kwota.
Waluta	order.line_items.total_tax_money.currency	string	Waluta.
Kwota	order.line_items.total_discount_money.amount	integer	Kwota.
Waluta	order.line_items.total_discount_money.currency	string	Waluta.
Kwota	order.line_items.total_money.amount	integer	Kwota.
Waluta	order.line_items.total_money.currency	string	Waluta.
Kwota	order.line_items.variation_total_price_money.amount	integer	Kwota.
Waluta	order.line_items.variation_total_price_money.currency	string	Waluta.
Identyfikator obiektu wykazu	order.line_items.catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
Nazwa odmiany	order.line_items.variation_name	string	Nazwa odmiany zastosowanej do tego elementu wiersza.
Modyfikatory	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	Identyfikator przypisany do kwadratu.
Identyfikator obiektu wykazu	order.line_items.modifiers.catalog_object_id	string	Identyfikator obiektu wykazu.
Name	order.line_items.modifiers.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Kwota	order.line_items.modifiers.base_price_money.amount	integer	Kwota.
Waluta	order.line_items.modifiers.base_price_money.currency	string	Waluta.
Kwota	order.line_items.modifiers.total_price_money.amount	integer	Kwota.
Waluta	order.line_items.modifiers.total_price_money.currency	string	Waluta.
Podatki	order.taxes	array of object
UID	order.taxes.uid	string	Identyfikator wygenerowany przez kwadrat.
Name	order.taxes.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Typ	order.taxes.type	string	Wskazuje typ.
Procent	order.taxes.percentage	string	Wartość procentowa w postaci dziesiętnej, używając znaku "". jako separatora dziesiętnego i bez znaku "%". Wartość 7,5 odpowiada 7,5%.
Kwota	order.taxes.applied_money.amount	integer	Kwota.
Waluta	order.taxes.applied_money.currency	string	Waluta.
Scope	order.taxes.scope	string	Wskazuje bieżący poziom.
Rabaty	order.discounts	array of object
UID	order.discounts.uid	string	Identyfikator wygenerowany przez kwadrat.
Identyfikator obiektu wykazu	order.discounts.catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
Name	order.discounts.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Typ	order.discounts.type	string	Wskazuje typ.
Procent	order.discounts.percentage	string	Wartość procentowa w postaci dziesiętnej, używając znaku "". jako separatora dziesiętnego i bez znaku "%". Wartość 7,5 odpowiada 7,5%.
Kwota	order.discounts.applied_money.amount	integer	Kwota.
Waluta	order.discounts.applied_money.currency	string	Waluta.
Scope	order.discounts.scope	string	Wskazuje bieżący poziom.
Kwota	order.discounts.amount_money.amount	integer	Kwota.
Waluta	order.discounts.amount_money.currency	string	Waluta.
Utworzono pod adresem	order.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	order.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
State	order.state	string	Bieżący stan.
wersja	order.version	integer	Bieżąca wersja tego obiektu.
Identyfikator odwołania	order.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Kwota	order.total_money.amount	integer	Kwota.
Waluta	order.total_money.currency	string	Waluta.
Kwota	order.total_tax_money.amount	integer	Kwota.
Waluta	order.total_tax_money.currency	string	Waluta.
Kwota	order.total_discount_money.amount	integer	Kwota.
Waluta	order.total_discount_money.currency	string	Waluta.
Kwota	order.total_tip_money.amount	integer	Kwota.
Waluta	order.total_tip_money.currency	string	Waluta.
Kwota	order.total_service_charge_money.amount	integer	Kwota.
Waluta	order.total_service_charge_money.currency	string	Waluta.
Kwota	order.net_amounts.total_money.amount	integer	Kwota.
Waluta	order.net_amounts.total_money.currency	string	Waluta.
Kwota	order.net_amounts.tax_money.amount	integer	Kwota.
Waluta	order.net_amounts.tax_money.currency	string	Waluta.
Kwota	order.net_amounts.discount_money.amount	integer	Kwota.
Waluta	order.net_amounts.discount_money.currency	string	Waluta.
Kwota	order.net_amounts.tip_money.amount	integer	Kwota.
Waluta	order.net_amounts.tip_money.currency	string	Waluta.
Kwota	order.net_amounts.service_charge_money.amount	integer	Kwota.
Waluta	order.net_amounts.service_charge_money.currency	string	Waluta.
Name	order.source.name	string	Nazwa.

Liczba spisów pobierania wsadowego

Identyfikator operacji:: InventoryBatchRetrieveCounts

Zwraca bieżące liczby dla podanych obiektów CatalogObjects w żądanych lokalizacjach.

Parametry

Nazwa	Klucz	Typ	Opis
Identyfikatory obiektów wykazu	catalog_object_ids	array of string
Identyfikatory lokalizacji	location_ids	array of string
Zaktualizowano po	updated_after	string	Filtr zwraca wyniki z wartością calculated_at po danym czasie określonym w znaczniku czasu RFC 3339.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Liczy	counts	array of object
Identyfikator obiektu wykazu	counts.catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
Typ obiektu wykazu	counts.catalog_object_type	string	Typ śledzonego obiektu CatalogObject.
State	counts.state	string	Bieżący stan.
Identyfikator lokalizacji	counts.location_id	string	Identyfikator lokalizacji.
Ilość	counts.quantity	string	Liczba elementów, na które ma wpływ szacowana liczba jako ciąg dziesiętny. Może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Obliczane o	counts.calculated_at	string	Sygnatura czasowa w formacie RFC 3339 wskazująca, kiedy zostanie odebrana najnowsza liczba fizyczna lub korekta wpływająca na szacowaną liczbę.

Obiekt wykazu Upsert

Identyfikator operacji:: CatalogUpsert

Tworzy lub aktualizuje docelowy obiekt CatalogObject.

Parametry

Nazwa	Klucz	Typ	Opis
Klucz idempotentności	idempotency_key	string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
identyfikator	id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Typ	type	string	Typ tego obiektu.
Abbreviation	abbreviation	string	Tekst etykiety wyświetlanej elementu w aplikacji Square Point of Sale. Używanych jest tylko pięć pierwszych znaków ciągu. Ten atrybut można przeszukiwać, a jego długość wartości to punkty kodu Unicode.
Description	title	string	Opis elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, a jego długość wartości to punkty kodu Unicode.
Name	name	string	Nazwa.
identyfikator	id	string	Identyfikator odwołujące się do tego obiektu w wykazie.
Typ	type	string	Typ tego obiektu.
Identyfikator elementu	item_id	string	Identyfikator elementu CatalogItem skojarzonego z tą odmianą elementu.
Name	name	string	Nazwa odmiany elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, a jego długość wartości to punkty kodu Unicode.
Typ cennika	pricing_type	string	Wskazuje, czy cena odmiany produktu jest stała, czy określona w momencie sprzedaży.
Kwota	amount	integer	Kwota.
Waluta	currency	string	Waluta.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Typ	catalog_object.type	string	Typ tego obiektu.
identyfikator	catalog_object.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Zaktualizowano o	catalog_object.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
wersja	catalog_object.version	integer	Bieżąca wersja tego obiektu.
Jest usuwany	catalog_object.is_deleted	boolean	Jeśli wartość true, obiekt został usunięty z bazy danych. W wstawianiu nowych obiektów musi być fałsz. Po usunięciu pole updated_at będzie równe czasowi usunięcia.
present_at_all_locations	catalog_object.present_at_all_locations	boolean	Jeśli to prawda, ten obiekt jest obecny we wszystkich lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem sytuacji, w których określono w polu absent_at_location_ids. Jeśli wartość false, ten obiekt nie jest obecny w żadnych lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem przypadków określonych w polu present_at_location_ids. Jeśli nie zostanie określony, wartość domyślna to true.
Name	catalog_object.item_data.name	string	Nazwa.
Description	catalog_object.item_data.title	string	Opis elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, a jego długość wartości to punkty kodu Unicode.
Abbreviation	catalog_object.item_data.abbreviation	string	Tekst etykiety wyświetlanej elementu w aplikacji Square Point of Sale. Używanych jest tylko pięć pierwszych znaków ciągu. Ten atrybut można przeszukiwać, a jego długość wartości to punkty kodu Unicode.
Zmiany	catalog_object.item_data.variations	array of object
Typ	catalog_object.item_data.variations.type	string	Typ tego obiektu.
identyfikator	catalog_object.item_data.variations.id	string	Identyfikator odwołujące się do tego obiektu w wykazie.
Zaktualizowano o	catalog_object.item_data.variations.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339.
wersja	catalog_object.item_data.variations.version	integer	Wersja obiektu. Podczas aktualizowania obiektu podana wersja musi być zgodna z wersją w bazie danych. W przeciwnym razie zapis zostanie odrzucony jako powodujący konflikt.
Jest usuwany	catalog_object.item_data.variations.is_deleted	boolean	Jeśli wartość true, obiekt został usunięty z bazy danych. W wstawianiu nowych obiektów musi być fałsz. Po usunięciu pole updated_at będzie równe czasowi usunięcia.
Obecne we wszystkich lokalizacjach	catalog_object.item_data.variations.present_at_all_locations	boolean	Jeśli to prawda, ten obiekt jest obecny we wszystkich lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem sytuacji, w których określono w polu absent_at_location_ids. Jeśli wartość false, ten obiekt nie jest obecny w żadnych lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem przypadków określonych w polu present_at_location_ids. Jeśli nie zostanie określony, wartość domyślna to true.
Identyfikator elementu	catalog_object.item_data.variations.item_variation_data.item_id	string	Identyfikator elementu CatalogItem skojarzonego z tą odmianą elementu.
Name	catalog_object.item_data.variations.item_variation_data.name	string	Nazwa odmiany elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, a jego długość wartości to punkty kodu Unicode.
Liczba porządkowa	catalog_object.item_data.variations.item_variation_data.ordinal	integer	Kolejność wyświetlania tej odmiany elementu. Ta wartość jest tylko do odczytu. W przypadku zapisów porządkowe dla każdego elementu odmiany w nadrzędnym elemencie CatalogItem jest ustawiane zgodnie z pozycją odmian elementu. Podczas operacji odczytu wartość nie ma gwarancji, że będzie sekwencyjna ani unikatowa.
Typ cennika	catalog_object.item_data.variations.item_variation_data.pricing_type	string	Wskazuje, czy cena odmiany produktu jest stała, czy określona w momencie sprzedaży.
Magazynowe	catalog_object.item_data.variations.item_variation_data.stockable	boolean	Określa, czy akcje są liczone bezpośrednio na tej odmianie (TRUE), czy tylko na jego składnikach (FALSE). W przypadku zgodności z poprzednimi wersjami brakujące wartości zostaną zinterpretowane jako PRAWDA.
Kwota	catalog_object.item_data.variations.item_variation_data.price_money.amount	integer	Kwota.
Waluta	catalog_object.item_data.variations.item_variation_data.price_money.currency	string	Waluta.
Typ produktu	catalog_object.item_data.product_type	string	Typ produktu elementu. Nie można zmienić po utworzeniu elementu.
Mapowania identyfikatorów	id_mappings	array of object
Identyfikator obiektu klienta	id_mappings.client_object_id	string	Dostarczony przez klienta tymczasowy identyfikator #-prefiks dla nowego obiektu CatalogObject.
Identyfikator obiektu	id_mappings.object_id	string	Trwały identyfikator utworzony przez serwer.

Obiekty wykazu upsert usługi Batch

Identyfikator operacji:: CatalogBatchUpsert

Tworzy lub aktualizuje maksymalnie 10 000 obiektów docelowych na podstawie podanej listy obiektów. Obiekty docelowe są grupowane w partie, a każda partia jest wstawiana/aktualizowana w sposób all-or-nothing. Jeśli obiekt w partii jest źle sformułowany lub narusza ograniczenie bazy danych, cała partia zawierająca ten element zostanie zignorowana. Jednak inne partie w tym samym żądaniu mogą nadal zakończyć się powodzeniem. Każda partia może zawierać maksymalnie 1000 obiektów, a partie będą przetwarzane w kolejności, o ile łączna liczba obiektów dla żądania (elementy, odmiany, listy modyfikatora, rabaty i podatki) nie przekracza 10 000.

Parametry

Nazwa	Klucz	Typ	Opis
Klucz idempotentności	idempotency_key	string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
Typ	type	string	Typ tego obiektu.
identyfikator	id	string	Identyfikator odwołujący się do tego obiektu.
Obecne we wszystkich lokalizacjach	present_at_all_locations	boolean	Jeśli to prawda, ten obiekt jest obecny we wszystkich lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem sytuacji, w których określono w polu absent_at_location_ids. Jeśli wartość false, ten obiekt nie jest obecny w żadnych lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem przypadków określonych w polu present_at_location_ids. Jeśli nie zostanie określony, wartość domyślna to true.
Name	name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Description	title	string	Opis elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, a jego długość wartości to punkty kodu Unicode.
Identyfikator kategorii	category_id	string	Identyfikator kategorii elementu, jeśli istnieje.
Identyfikatory podatkowe	tax_ids	array of string
Typ	type	string	Typ tego obiektu. Każdy typ obiektu ma oczekiwane właściwości wyrażone w formacie ustrukturyzowanym w odpowiednim polu *_data poniżej.
identyfikator	id	string	Identyfikator odwołujący się do tego obiektu.
Obecne we wszystkich lokalizacjach	present_at_all_locations	boolean	Czy jest obecny we wszystkich lokalizacjach.
Identyfikator elementu	item_id	string	Identyfikator elementu.
Name	name	string	Nazwa elementu.
Typ cennika	pricing_type	string	Typ cennika.
Kwota	amount	integer	Kwota.
Waluta	currency	string	Waluta.
Name	name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Name	name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Faza obliczania	calculation_phase	string	Czy podatek jest obliczany na podstawie sumy częściowej lub sumy płatności.
Typ dołączania	inclusion_type	string	Niezależnie od tego, czy podatek jest addytywne, czy inkluzywne.
Procent	percentage	string	Procent podatku w postaci dziesiętnej, używając znaku ""." jako separatora dziesiętnego i bez znaku "%". Wartość 7,5 odpowiada 7,5%.
Dotyczy kwot niestandardowych	applies_to_custom_amounts	boolean	Jeśli to prawda, opłata ma zastosowanie do kwot niestandardowych wprowadzonych do aplikacji Square Point of Sale, które nie są skojarzone z określonym CatalogItem.
Włączona	enabled	boolean	Flaga logiczna wskazująca, czy podatek jest wyświetlany jako włączony (prawda) w aplikacji Square Point of Sale, czy nie (false).

Zwraca

Nazwa	Ścieżka	Typ	Opis
Objects	objects	array of object
Typ	objects.type	string	Typ tego obiektu.
identyfikator	objects.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Zaktualizowano o	objects.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
wersja	objects.version	integer	Bieżąca wersja obiektu.
Jest usuwany	objects.is_deleted	boolean	Jeśli wartość true, obiekt został usunięty z bazy danych. W wstawianiu nowych obiektów musi być fałsz. Po usunięciu pole updated_at będzie równe czasowi usunięcia.
Obecne we wszystkich lokalizacjach	objects.present_at_all_locations	boolean	Jeśli to prawda, ten obiekt jest obecny we wszystkich lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem sytuacji, w których określono w polu absent_at_location_ids. Jeśli wartość false, ten obiekt nie jest obecny w żadnych lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem przypadków określonych w polu present_at_location_ids. Jeśli nie zostanie określony, wartość domyślna to true.
Name	objects.item_data.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Description	objects.item_data.title	string	Opis elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, a jego długość wartości to punkty kodu Unicode.
Identyfikator kategorii	objects.item_data.category_id	string	Identyfikator kategorii elementu, jeśli istnieje.
Identyfikatory podatkowe	objects.item_data.tax_ids	array of string
Zmiany	objects.item_data.variations	array of object
Typ	objects.item_data.variations.type	string	Typ tego obiektu. Każdy typ obiektu ma oczekiwane właściwości wyrażone w formacie ustrukturyzowanym w odpowiednim polu *_data poniżej.
identyfikator	objects.item_data.variations.id	string	Identyfikator odwołujący się do tego obiektu.
Zaktualizowano o	objects.item_data.variations.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
wersja	objects.item_data.variations.version	integer	Wersja obiektu. Podczas aktualizowania obiektu podana wersja musi być zgodna z wersją w bazie danych. W przeciwnym razie zapis zostanie odrzucony jako powodujący konflikt.
Jest usuwany	objects.item_data.variations.is_deleted	boolean	Jeśli wartość true, obiekt został usunięty z bazy danych. W wstawianiu nowych obiektów musi być fałsz. Po usunięciu pole updated_at będzie równe czasowi usunięcia.
Obecne we wszystkich lokalizacjach	objects.item_data.variations.present_at_all_locations	boolean	Lista lokalizacji, w których znajduje się obiekt, nawet jeśli present_at_all_locations jest fałszem. Może to obejmować lokalizacje, które są dezaktywowane.
Identyfikator elementu	objects.item_data.variations.item_variation_data.item_id	string	Identyfikator obiektu o tej odmianie elementu.
Name	objects.item_data.variations.item_variation_data.name	string	Nazwa tego elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, a jego długość wartości to punkty kodu Unicode.
Liczba porządkowa	objects.item_data.variations.item_variation_data.ordinal	integer	Kolejność wyświetlania tej odmiany elementu. Ta wartość jest tylko do odczytu.
Typ cennika	objects.item_data.variations.item_variation_data.pricing_type	string	Wskazuje, czy cena odmiany produktu jest stała, czy określona w momencie sprzedaży.
Kwota	objects.item_data.variations.item_variation_data.price_money.amount	integer	Kwota pieniędzy, w najmniejszym nominałach waluty wskazanej przez walutę. Na przykład gdy waluta to USD, kwota jest wyrażona w centach. Kwoty pieniężne mogą być dodatnie lub ujemne. Zapoznaj się z opisem określonego pola, aby określić znaczenie znaku w konkretnym przypadku.
Waluta	objects.item_data.variations.item_variation_data.price_money.currency	string	Typ waluty w formacie ISO 4217. Na przykład kod waluty dla dolarów amerykańskich to USD.
Name	objects.category_data.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Name	objects.tax_data.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Faza obliczania	objects.tax_data.calculation_phase	string	Czy podatek jest obliczany na podstawie sumy częściowej lub sumy płatności.
Typ dołączania	objects.tax_data.inclusion_type	string	Niezależnie od tego, czy podatek jest addytywne, czy inkluzywne.
Procent	objects.tax_data.percentage	string	Wartość procentowa w postaci dziesiętnej, używając znaku "". jako separatora dziesiętnego i bez znaku "%". Wartość 7,5 odpowiada 7,5%.
Dotyczy kwot niestandardowych	objects.tax_data.applies_to_custom_amounts	boolean	Jeśli to prawda, opłata ma zastosowanie do kwot niestandardowych wprowadzonych do aplikacji Square Point of Sale, które nie są skojarzone z określonym CatalogItem.
Włączona	objects.tax_data.enabled	boolean	Wskazuje, czy można użyć obiektu.
Mapowania identyfikatorów	id_mappings	array of object
Identyfikator obiektu klienta	id_mappings.client_object_id	string	Dostarczony przez klienta tymczasowy identyfikator #-prefiks dla nowego obiektu CatalogObject.
Identyfikator obiektu	id_mappings.object_id	string	Trwały identyfikator utworzony przez serwer.

Obliczanie kolejności (wersja beta)

Identyfikator operacji:: OrderCalculate

Umożliwia aplikacjom wyświetlanie podglądu cen zamówień bez tworzenia zamówienia.

Parametry

Nazwa	Klucz	Typ	Opis
Klucz idempotentności	idempotency_key	string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
Identyfikator lokalizacji	location_id	string	Identyfikator lokalizacji.
Name	name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Procent	percentage	string	Wartość procentowa w postaci dziesiętnej, używając znaku "". jako separatora dziesiętnego i bez znaku "%". Wartość 7,5 odpowiada 7,5%.
Scope	scope	string	Wskazuje bieżący poziom.
Name	name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Ilość	quantity	string	Liczba elementów, których dotyczy liczba fizyczna jako ciąg dziesiętny. Liczba może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Kwota	amount	integer	Kwota.
Waluta	currency	string	Waluta.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Identyfikator lokalizacji	order.location_id	string	Identyfikator lokalizacji.
Elementy wiersza	order.line_items	array of object
UID	order.line_items.uid	string	Identyfikator wygenerowany przez kwadrat.
Ilość	order.line_items.quantity	string	Liczba elementów, których dotyczy liczba fizyczna jako ciąg dziesiętny. Liczba może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Name	order.line_items.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Kwota	order.line_items.base_price_money.amount	integer	Kwota.
Waluta	order.line_items.base_price_money.currency	string	Waluta.
Kwota	order.line_items.gross_sales_money.amount	integer	Kwota.
Waluta	order.line_items.gross_sales_money.currency	string	Waluta.
Kwota	order.line_items.total_tax_money.amount	integer	Kwota.
Waluta	order.line_items.total_tax_money.currency	string	Waluta.
Kwota	order.line_items.total_discount_money.amount	integer	Kwota.
Waluta	order.line_items.total_discount_money.currency	string	Waluta.
Kwota	order.line_items.total_money.amount	integer	Kwota.
Waluta	order.line_items.total_money.currency	string	Waluta.
Kwota	order.line_items.variation_total_price_money.amount	integer	Kwota.
Waluta	order.line_items.variation_total_price_money.currency	string	Waluta.
Zastosowane rabaty	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Identyfikator przypisany do kwadratu.
Identyfikator UID rabatu	order.line_items.applied_discounts.discount_uid	string	Identyfikator uid rabatu, który reprezentuje zastosowany rabat.
Kwota	order.line_items.applied_discounts.applied_money.amount	integer	Kwota.
Waluta	order.line_items.applied_discounts.applied_money.currency	string	Waluta.
Rabaty	order.discounts	array of object
UID	order.discounts.uid	string	Identyfikator wygenerowany przez kwadrat.
Name	order.discounts.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Procent	order.discounts.percentage	string	Wartość procentowa w postaci dziesiętnej, używając znaku "". jako separatora dziesiętnego i bez znaku "%". Wartość 7,5 odpowiada 7,5%.
Kwota	order.discounts.applied_money.amount	integer	Kwota.
Waluta	order.discounts.applied_money.currency	string	Waluta.
Typ	order.discounts.type	string	Wskazuje typ.
Scope	order.discounts.scope	string	Wskazuje bieżący poziom.
Utworzono pod adresem	order.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	order.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
State	order.state	string	Bieżący stan.
wersja	order.version	integer	Bieżąca wersja tego obiektu.
Kwota	order.total_tax_money.amount	integer	Kwota.
Waluta	order.total_tax_money.currency	string	Waluta.
Kwota	order.total_discount_money.amount	integer	Kwota.
Waluta	order.total_discount_money.currency	string	Waluta.
Kwota	order.total_tip_money.amount	integer	Kwota.
Waluta	order.total_tip_money.currency	string	Waluta.
Kwota	order.total_money.amount	integer	Kwota.
Waluta	order.total_money.currency	string	Waluta.
Kwota	order.total_service_charge_money.amount	integer	Kwota.
Waluta	order.total_service_charge_money.currency	string	Waluta.
Kwota	order.net_amounts.total_money.amount	integer	Kwota.
Waluta	order.net_amounts.total_money.currency	string	Waluta.
Kwota	order.net_amounts.tax_money.amount	integer	Kwota.
Waluta	order.net_amounts.tax_money.currency	string	Waluta.
Kwota	order.net_amounts.discount_money.amount	integer	Kwota.
Waluta	order.net_amounts.discount_money.currency	string	Waluta.
Kwota	order.net_amounts.tip_money.amount	integer	Kwota.
Waluta	order.net_amounts.tip_money.currency	string	Waluta.
Kwota	order.net_amounts.service_charge_money.amount	integer	Kwota.
Waluta	order.net_amounts.service_charge_money.currency	string	Waluta.

Pobieranie dowodów sporu

Identyfikator operacji:: DisputeRetrieveEvidence

Zwraca metadane dowodów określone przez identyfikator dowodu w ścieżce adresu URL żądania. Należy zachować kopię przekazanych dowodów, jeśli chcesz się do niej odwoływać później. Nie można pobrać dowodów po jego przekazaniu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator sporu	dispute_id	True	string	Identyfikator sporu.
Identyfikator dowodu	evidence_id	True	string	Identyfikator dowodów.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	evidence.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator sporu	evidence.dispute_id	string	Identyfikator sporu jest skojarzony z dowodami.
Filename	evidence.evidence_file.filename	string	Pliki dowodów sporu muszą być plikami aplikacji/pdf, image/heic, image/heif, image/jpeg, image/png lub image/tiff.
Typ pliku	evidence.evidence_file.filetype	string	Nazwa pliku zawierająca rozszerzenie pliku.
Typ dowodu	evidence.evidence_type	string	Dowód pf typu.
Przekazano o	evidence.uploaded_at	string	Czas ukończenia następnej akcji w formacie RFC 3339.

Pobieranie faktury

Identyfikator operacji:: InvoiceGet

Pobiera fakturę według identyfikatora faktury.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator faktury	invoice_id	True	string	Identyfikator faktury.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	invoice.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
wersja	invoice.version	integer	Bieżąca wersja tego obiektu.
Identyfikator lokalizacji	invoice.location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	invoice.order_id	string	Identyfikator zamówienia.
Żądania płatności	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Identyfikator wygenerowany przez kwadrat.
Typ żądania	invoice.payment_requests.request_type	string	Określa typ żądania płatności. Ten typ definiuje sposób określania kwoty żądania płatności.
Data upływu	invoice.payment_requests.due_date	string	Data ukończenia żądania płatności w formacie RRRR-MM-DD.
Włączone przechylanie	invoice.payment_requests.tipping_enabled	boolean	Jeśli ustawiono wartość true, zapewnia klientowi miejsce na zapłacenie porady.
Przypomnienia	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Identyfikator przypisany do kwadratu.
Względne dni zaplanowane	invoice.payment_requests.reminders.relative_scheduled_days	integer	Liczba dni przed (liczba ujemna) lub po (liczbie dodatniej) żądanie płatności due_date po wysłaniu przypomnienia.
Message	invoice.payment_requests.reminders.message	string	Wiadomość.
Status	invoice.payment_requests.reminders.status	string	Bieżący stan.
Kwota	invoice.payment_requests.computed_amount_money.amount	integer	Kwota.
Waluta	invoice.payment_requests.computed_amount_money.currency	string	Waluta.
Kwota	invoice.payment_requests.total_completed_amount_money.amount	integer	Kwota.
Waluta	invoice.payment_requests.total_completed_amount_money.currency	string	Waluta.
Automatyczne źródło płatności	invoice.payment_requests.automatic_payment_source	string	Forma płatności za automatyczną płatność.
Numer faktury	invoice.invoice_number	string	Przyjazny dla użytkownika numer faktury. Wartość jest unikatowa w obrębie lokalizacji. Jeśli nie zostanie podana podczas tworzenia faktury, square przypisuje wartość.
Title	invoice.title	string	Tytuł.
Description	invoice.description	string	Opis.
Zaplanowane o godzinie	invoice.scheduled_at	string	Sygnatura czasowa zaplanowana przetwarzania w formacie RFC 3339.
Status	invoice.status	string	Bieżący stan weryfikacji tego obiektu.
Timezone	invoice.timezone	string	Strefa czasowa używana do interpretowania dat kalendarza. Po utworzeniu faktury to pole jest ustawione na strefę czasową określoną dla lokalizacji sprzedawcy. Nie można zmienić wartości.
Utworzono pod adresem	invoice.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	invoice.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Identyfikator klienta	invoice.primary_recipient.customer_id	string	Identyfikator klienta skojarzonego z zamówieniem.
Imię	invoice.primary_recipient.given_name	string	Podane przez adresata (czyli imię).
Nazwisko	invoice.primary_recipient.family_name	string	Rodzina adresata (czyli nazwisko).
Adres e-mail	invoice.primary_recipient.email_address	string	Adres e-mail adresata.
Numer telefonu	invoice.primary_recipient.phone_number	string	Numer telefonu odbiorcy.
Card	invoice.accepted_payment_methods.card	boolean	Wskazuje, czy płatności kartą kredytową lub debetową są akceptowane.
Kwadratowa karta upominkowa	invoice.accepted_payment_methods.square_gift_card	boolean	Wskazuje, czy płatności kartami upominkowymi square są akceptowane.
Konto	invoice.accepted_payment_methods.bank_account	boolean	Wskazuje, czy płatności przelewów bankowych są akceptowane.
Pola niestandardowe	invoice.custom_fields	array of object
Etykieta	invoice.custom_fields.label	string	Etykieta lub tytuł pola niestandardowego.
Wartość	invoice.custom_fields.value	string	Tekst pola niestandardowego.
Umieszczenie	invoice.custom_fields.placement	string	Lokalizacja pola niestandardowego na fakturze.
Metoda dostarczania	invoice.delivery_method	string	Metoda dostarczania używana przez Square do wysyłania faktury, przypomnień i paragonów do klienta. Po opublikowaniu faktury square przetwarza fakturę na podstawie ustawień metody dostawy i żądania płatności, natychmiast lub w dniu scheduled_at, jeśli określono.
Data sprzedaży lub usługi	invoice.sale_or_service_date	string	Data sprzedaży lub data renderowania usługi w formacie RRRR-MM-DD. To pole może służyć do określenia daty wcześniejszej lub przyszłej wyświetlanej na fakturze.

Pobieranie grupy klientów

Identyfikator operacji:: CustomerGroupRetrieve

Pobiera określoną grupę klientów.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator grupy	group_id	True	string	Identyfikator grupy.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	group.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Name	group.name	string	Nazwa obiektu.
Utworzono pod adresem	group.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	group.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.

Pobieranie karty

Identyfikator operacji:: CardRetrieve

Pobiera szczegóły dla określonej karty.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator karty	card_id	True	string	Identyfikator karty.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	card.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Linia adresowa 1	card.billing_address.address_line_1	string	Pierwszy wiersz adresu. Pola rozpoczynające się od address_line zawierają najbardziej szczegółowe informacje dotyczące adresu, takie jak numer ulicy, nazwa ulicy i nazwa budynku.
Wiersz adresu 2	card.billing_address.address_line_2	string	Drugi wiersz adresu, jeśli istnieje.
Miejscowość	card.billing_address.locality	string	Miasto lub miasto adresu.
Poziom okręgu administracyjnego 1	card.billing_address.administrative_district_level_1	string	Jednostka cywilna w kraju adresu. W USA jest to stan.
Kod pocztowy	card.billing_address.postal_code	string	Kod pocztowy adresu.
Country	card.billing_address.country	string	Kraj adresu w formacie ISO 3166-1-alfa-2.
Odcisk palca	card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
BIN	card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN).
Znak karty	card.card_brand	string	Marka karty.
Typ karty	card.card_type	string	Typ karty.
Nazwa symbolu karty	card.cardholder_name	string	Nazwa symbolu karty.
Identyfikator klienta	card.customer_id	string	Identyfikator tego obiektu reprezentującego klienta.
Włączona	card.enabled	boolean	Czy włączono.
Miesiąc eksploduj	card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok eksplorowy	card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Ostatnie 4	card.last_4	string	Ostatnie 4 cyfry numeru karty.
Typ przedpłacony	card.prepaid_type	string	Wskazuje, czy karta jest przedpłacona, czy nie.
Identyfikator odwołania	card.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
wersja	card.version	integer	Bieżąca wersja tego obiektu.

Pobieranie klienta

Identyfikator operacji:: CustomerRetrieve

Zwraca szczegóły dla pojedynczego klienta.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator klienta	customer_id	True	string	Identyfikator klienta.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	customer.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Utworzono pod adresem	customer.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	customer.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Imię	customer.given_name	string	Podana (tj. imię) nazwa skojarzona z profilem klienta.
Nazwisko	customer.family_name	string	Rodzina (tj. nazwisko) skojarzona z profilem klienta.
Adres e-mail	customer.email_address	string	Adres e-mail skojarzony z profilem klienta.
Linia adresowa 1	customer.address.address_line_1	string	Pierwszy wiersz adresu. Pola rozpoczynające się od address_line zawierają najbardziej szczegółowe informacje dotyczące adresu, takie jak numer ulicy, nazwa ulicy i nazwa budynku.
Wiersz adresu 2	customer.address.address_line_2	string	Drugi wiersz adresu, jeśli istnieje.
Miejscowość	customer.address.locality	string	Miasto lub miasto adresu.
Poziom okręgu administracyjnego 1	customer.address.administrative_district_level_1	string	Jednostka cywilna w kraju adresu. W USA jest to stan.
Kod pocztowy	customer.address.postal_code	string	Kod pocztowy adresu.
Country	customer.address.country	string	Kraj adresu w formacie ISO 3166-1-alfa-2.
Numer telefonu	customer.phone_number	string	11-cyfrowy numer telefonu skojarzony z profilem klienta.
Identyfikator odwołania	customer.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Uwaga / Notatka	customer.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Wiadomość e-mail anulowana	customer.preferences.email_unsubscribed	boolean	Wskazuje, czy klient anulował subskrypcję wiadomości e-mail kampanii marketingowej. Wartość true oznacza, że klient zdecydował się zrezygnować z marketingu e-mail od bieżącego sprzedawcy Square lub od wszystkich sprzedawców Kwadratowych.
Źródło tworzenia	customer.creation_source	string	Źródło tworzenia reprezentuje metodę używaną do tworzenia profilu klienta.
Identyfikatory grup	customer.group_ids	array of string
Identyfikatory segmentów	customer.segment_ids	array of string
wersja	customer.version	integer	Bieżąca wersja tego obiektu.

Pobieranie korekty spisu

Identyfikator operacji:: InventoryRetrieveAdjustment

Zwraca obiekt InventoryAdjustment z podanym adjustment_id.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator korekty	adjustment_id	True	string	Identyfikator korekty.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	adjustment.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator odwołania	adjustment.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Ze stanu	adjustment.from_state	string	Stan zapasów powiązanej ilości elementów przed korektą.
Do stanu	adjustment.to_state	string	Stan zapasów powiązanej ilości elementów po dostosowaniu.
Identyfikator lokalizacji	adjustment.location_id	string	Identyfikator lokalizacji.
Identyfikator obiektu wykazu	adjustment.catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
Typ obiektu wykazu	adjustment.catalog_object_type	string	Typ śledzonego obiektu CatalogObject.
Ilość	adjustment.quantity	string	Liczba elementów, na które ma wpływ korekta jako ciąg dziesiętny. Może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Kwota	adjustment.total_price_money.amount	integer	Kwota.
Waluta	adjustment.total_price_money.currency	string	Waluta.
Wystąpił o	adjustment.occurred_at	string	Sygnatura czasowa w formacie RFC 3339 wygenerowana przez klienta, która wskazuje, kiedy nastąpiła korekta zapasów. W przypadku aktualizacji korekty spisu sygnatura czasowa occurred_at nie może być starsza niż 24 godziny ani w przyszłości względem czasu żądania.
Utworzono pod adresem	adjustment.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Product	adjustment.source.product	string	Typ produktu dla aplikacji.
Identyfikator aplikacji	adjustment.source.application_id	string	Identyfikator kwadratowy tylko do odczytu przypisany do aplikacji.
Name	adjustment.source.name	string	Nazwa.
Identyfikator pracownika	adjustment.employee_id	string	Identyfikator wygenerowany kwadratowo pracownika.

Pobieranie liczby fizycznych spisu

Identyfikator operacji:: InventoryRetrievePhysicalCount

Zwraca obiekt InventoryPhysicalCount z podanym physical_count_id.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator liczby fizycznych	physical_count_id	True	string	Identyfikator liczby fizycznej.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	count.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator odwołania	count.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Identyfikator obiektu wykazu	count.catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
Typ obiektu wykazu	count.catalog_object_type	string	Typ śledzonego obiektu CatalogObject.
State	count.state	string	Bieżący stan.
Identyfikator lokalizacji	count.location_id	string	Identyfikator lokalizacji.
Ilość	count.quantity	string	Liczba elementów, na które ma wpływ korekta jako ciąg dziesiętny. Może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Product	count.source.product	string	Typ produktu dla aplikacji.
Identyfikator aplikacji	count.source.application_id	string	Identyfikator kwadratowy tylko do odczytu przypisany do aplikacji.
Name	count.source.name	string	Nazwa.
Identyfikator pracownika	count.employee_id	string	Identyfikator wygenerowany kwadratowo pracownika.
Wystąpił o	count.occurred_at	string	Sygnatura czasowa w formacie RFC 3339 wygenerowana przez klienta, która wskazuje, kiedy nastąpiła korekta zapasów. W przypadku aktualizacji korekty spisu sygnatura czasowa occurred_at nie może być starsza niż 24 godziny ani w przyszłości względem czasu żądania.
Utworzono pod adresem	count.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.

Pobieranie liczby spisów

Identyfikator operacji:: InventoryRetrieveCount

Pobiera bieżącą obliczoną liczbę akcji dla danego obiektu CatalogObject w danym zestawie lokalizacji.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator obiektu wykazu	catalog_object_id	True	string	Identyfikator obiektu wykazu.
Identyfikatory lokalizacji	location_ids		string	Identyfikatory lokalizacji do wyszukania jako listy rozdzielanej przecinkami. Pusta lista wysyła zapytanie do wszystkich lokalizacji.
Cursor	cursor		string	Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Liczy	counts	array of object
Identyfikator obiektu wykazu	counts.catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
Typ obiektu wykazu	counts.catalog_object_type	string	Typ śledzonego obiektu CatalogObject.
State	counts.state	string	Bieżący stan.
Identyfikator lokalizacji	counts.location_id	string	Identyfikator lokalizacji.
Ilość	counts.quantity	string	Liczba elementów, na które ma wpływ szacowana liczba jako ciąg dziesiętny. Może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Obliczane o	counts.calculated_at	string	Sygnatura czasowa w formacie RFC 3339 wskazująca, kiedy zostanie odebrana najnowsza liczba fizyczna lub korekta wpływająca na szacowaną liczbę.

Pobieranie obiektu wykazu

Identyfikator operacji:: CatalogRetrieve

Zwraca pojedynczy element CatalogItem jako obiekt CatalogObject na podstawie podanego identyfikatora. Zwrócony obiekt zawiera wszystkie odpowiednie informacje CatalogItem, w tym: elementy podrzędne CatalogItemVariation, odwołania do obiektów CatalogModifierList oraz identyfikatory wszystkich obiektów CatalogTax, które mają do niego zastosowanie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator obiektu	object_id	True	string	Identyfikator obiektu.
Uwzględnij powiązane obiekty	include_related_objects		boolean	Jeśli wartość true, odpowiedź będzie zawierać dodatkowe obiekty, które są powiązane z żądanym obiektem, w następujący sposób: Jeśli pole obiektu odpowiedzi zawiera atrybut CatalogItem, skojarzone z nią obiekty CatalogCategory, CatalogTax, CatalogImage i CatalogModifierList zostaną zwrócone w polu related_objects odpowiedzi. Jeśli pole obiektu odpowiedzi zawiera atrybut CatalogItemVariation, jego nadrzędny element CatalogItem zostanie zwrócony w polu related_objects odpowiedzi.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Typ	object.type	string	Typ tego obiektu.
identyfikator	object.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Zaktualizowano o	object.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
wersja	object.version	integer	Bieżąca wersja tego obiektu.
Jest usuwany	object.is_deleted	boolean	Jeśli wartość true, obiekt został usunięty z bazy danych. W wstawianiu nowych obiektów musi być fałsz. Po usunięciu pole updated_at będzie równe czasowi usunięcia.
present_at_all_locations	object.present_at_all_locations	boolean	Jeśli to prawda, ten obiekt jest obecny we wszystkich lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem sytuacji, w których określono w polu absent_at_location_ids. Jeśli wartość false, ten obiekt nie jest obecny w żadnych lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem przypadków określonych w polu present_at_location_ids. Jeśli nie zostanie określony, wartość domyślna to true.
Name	object.item_data.name	string	Nazwa.
Description	object.item_data.title	string	Opis elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, a jego długość wartości to punkty kodu Unicode.
Identyfikator kategorii	object.item_data.category_id	string	Identyfikator kategorii elementu, jeśli istnieje.
Identyfikatory podatkowe	object.item_data.tax_ids	array of string
Zmiany	object.item_data.variations	array of object
Typ	object.item_data.variations.type	string	Typ tego obiektu.
identyfikator	object.item_data.variations.id	string	Identyfikator odwołujące się do tego obiektu w wykazie.
Zaktualizowano o	object.item_data.variations.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339.
wersja	object.item_data.variations.version	integer	Wersja obiektu. Podczas aktualizowania obiektu podana wersja musi być zgodna z wersją w bazie danych. W przeciwnym razie zapis zostanie odrzucony jako powodujący konflikt.
Jest usuwany	object.item_data.variations.is_deleted	boolean	Jeśli wartość true, obiekt został usunięty z bazy danych. W wstawianiu nowych obiektów musi być fałsz. Po usunięciu pole updated_at będzie równe czasowi usunięcia.
Obecne we wszystkich lokalizacjach	object.item_data.variations.present_at_all_locations	boolean	Jeśli to prawda, ten obiekt jest obecny we wszystkich lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem sytuacji, w których określono w polu absent_at_location_ids. Jeśli wartość false, ten obiekt nie jest obecny w żadnych lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem przypadków określonych w polu present_at_location_ids. Jeśli nie zostanie określony, wartość domyślna to true.
Identyfikator elementu	object.item_data.variations.item_variation_data.item_id	string	Identyfikator elementu CatalogItem skojarzonego z tą odmianą elementu.
Name	object.item_data.variations.item_variation_data.name	string	Nazwa odmiany elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, a jego długość wartości to punkty kodu Unicode.
Liczba porządkowa	object.item_data.variations.item_variation_data.ordinal	integer	Kolejność wyświetlania tej odmiany elementu. Ta wartość jest tylko do odczytu. W przypadku zapisów porządkowe dla każdego elementu odmiany w nadrzędnym elemencie CatalogItem jest ustawiane zgodnie z pozycją odmian elementu. Podczas operacji odczytu wartość nie ma gwarancji, że będzie sekwencyjna ani unikatowa.
Typ cennika	object.item_data.variations.item_variation_data.pricing_type	string	Wskazuje, czy cena odmiany produktu jest stała, czy określona w momencie sprzedaży.
Kwota	object.item_data.variations.item_variation_data.price_money.amount	integer	Kwota.
Waluta	object.item_data.variations.item_variation_data.price_money.currency	string	Waluta.

Pobieranie obiektów wykazu w usłudze Batch

Identyfikator operacji:: CatalogBatchRetrieve

Zwraca zestaw obiektów na podstawie podanego identyfikatora. Każdy element CatalogItem zwrócony w zestawie zawiera wszystkie jego informacje podrzędne, w tym: wszystkie jego obiekty CatalogItemVariation, odwołania do obiektów CatalogModifierList i identyfikatory wszystkich obiektów CatalogTax, które mają do niego zastosowanie.

Parametry

Nazwa	Klucz	Typ	Opis
Identyfikatory obiektów	object_ids	array of string
Wersja wykazu	catalog_version	integer	Określona wersja obiektów wykazu, które mają zostać uwzględnione w odpowiedzi. Dzięki temu można pobierać historyczne wersje obiektów. Określona wartość wersji jest dopasowywana do atrybutu wersji catalogObjects.
Uwzględnij powiązane obiekty	include_related_objects	boolean	Jeśli wartość true, odpowiedź będzie zawierać dodatkowe obiekty, które są powiązane z żądanymi obiektami, w następujący sposób: Jeśli pole obiektów odpowiedzi zawiera atrybut CatalogItem, skojarzone obiekty CatalogCategory, obiekty CatalogTax, obiekty CatalogImage i CatalogModifierLists zostaną zwrócone w polu related_objects odpowiedzi. Jeśli pole obiektów odpowiedzi zawiera atrybut CatalogItemVariation, jego nadrzędny element CatalogItem zostanie zwrócony w polu related_objects odpowiedzi.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Objects	objects	array of object
Typ	objects.type	string	Typ tego obiektu.
identyfikator	objects.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Zaktualizowano o	objects.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
wersja	objects.version	integer	Bieżąca wersja obiektu.
Jest usuwany	objects.is_deleted	boolean	Jeśli wartość true, obiekt został usunięty z bazy danych. W wstawianiu nowych obiektów musi być fałsz. Po usunięciu pole updated_at będzie równe czasowi usunięcia.
Obecne we wszystkich lokalizacjach	objects.present_at_all_locations	boolean	Jeśli to prawda, ten obiekt jest obecny we wszystkich lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem sytuacji, w których określono w polu absent_at_location_ids. Jeśli wartość false, ten obiekt nie jest obecny w żadnych lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem przypadków określonych w polu present_at_location_ids. Jeśli nie zostanie określony, wartość domyślna to true.
Name	objects.item_data.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Description	objects.item_data.title	string	Opis elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, a jego długość wartości to punkty kodu Unicode.
Identyfikator kategorii	objects.item_data.category_id	string	Identyfikator kategorii elementu, jeśli istnieje.
Identyfikatory podatkowe	objects.item_data.tax_ids	array of string
Zmiany	objects.item_data.variations	array of object
Typ	objects.item_data.variations.type	string	Typ tego obiektu. Każdy typ obiektu ma oczekiwane właściwości wyrażone w formacie ustrukturyzowanym w odpowiednim polu *_data poniżej.
identyfikator	objects.item_data.variations.id	string	Identyfikator odwołujący się do tego obiektu.
Zaktualizowano o	objects.item_data.variations.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
wersja	objects.item_data.variations.version	integer	Wersja obiektu. Podczas aktualizowania obiektu podana wersja musi być zgodna z wersją w bazie danych. W przeciwnym razie zapis zostanie odrzucony jako powodujący konflikt.
Jest usuwany	objects.item_data.variations.is_deleted	boolean	Jeśli wartość true, obiekt został usunięty z bazy danych. W wstawianiu nowych obiektów musi być fałsz. Po usunięciu pole updated_at będzie równe czasowi usunięcia.
Obecne we wszystkich lokalizacjach	objects.item_data.variations.present_at_all_locations	boolean	Lista lokalizacji, w których znajduje się obiekt, nawet jeśli present_at_all_locations jest fałszem. Może to obejmować lokalizacje, które są dezaktywowane.
Identyfikator elementu	objects.item_data.variations.item_variation_data.item_id	string	Identyfikator obiektu o tej odmianie elementu.
Name	objects.item_data.variations.item_variation_data.name	string	Nazwa tego elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, a jego długość wartości to punkty kodu Unicode.
Liczba porządkowa	objects.item_data.variations.item_variation_data.ordinal	integer	Kolejność wyświetlania tej odmiany elementu. Ta wartość jest tylko do odczytu.
Typ cennika	objects.item_data.variations.item_variation_data.pricing_type	string	Wskazuje, czy cena odmiany produktu jest stała, czy określona w momencie sprzedaży.
Kwota	objects.item_data.variations.item_variation_data.price_money.amount	integer	Kwota pieniędzy, w najmniejszym nominałach waluty wskazanej przez walutę. Na przykład gdy waluta to USD, kwota jest wyrażona w centach. Kwoty pieniężne mogą być dodatnie lub ujemne. Zapoznaj się z opisem określonego pola, aby określić znaczenie znaku w konkretnym przypadku.
Waluta	objects.item_data.variations.item_variation_data.price_money.currency	string	Typ waluty w formacie ISO 4217. Na przykład kod waluty dla dolarów amerykańskich to USD.
Obiekty pokrewne	related_objects	array of object
Typ	related_objects.type	string	Typ tego obiektu.
identyfikator	related_objects.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Zaktualizowano o	related_objects.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
wersja	related_objects.version	integer	Bieżąca wersja obiektu.
Jest usuwany	related_objects.is_deleted	boolean	Jeśli wartość true, obiekt został usunięty z bazy danych. W wstawianiu nowych obiektów musi być fałsz. Po usunięciu pole updated_at będzie równe czasowi usunięcia.
Obecne we wszystkich lokalizacjach	related_objects.present_at_all_locations	boolean	Jeśli to prawda, ten obiekt jest obecny we wszystkich lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem sytuacji, w których określono w polu absent_at_location_ids. Jeśli wartość false, ten obiekt nie jest obecny w żadnych lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem przypadków określonych w polu present_at_location_ids. Jeśli nie zostanie określony, wartość domyślna to true.
Name	related_objects.category_data.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Name	related_objects.tax_data.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Faza obliczania	related_objects.tax_data.calculation_phase	string	Czy podatek jest obliczany na podstawie sumy częściowej lub sumy płatności.
Typ dołączania	related_objects.tax_data.inclusion_type	string	Niezależnie od tego, czy podatek jest addytywne, czy inkluzywne.
Procent	related_objects.tax_data.percentage	string	Wartość procentowa w postaci dziesiętnej, używając znaku "". jako separatora dziesiętnego i bez znaku "%". Wartość 7,5 odpowiada 7,5%.
Włączona	related_objects.tax_data.enabled	boolean	Wskazuje, czy można użyć obiektu.

Pobieranie segmentu klienta

Identyfikator operacji:: CustomerSegmentRetrieve

Pobiera określony segment klienta.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator segmentu	segment_id	True	string	Identyfikator segmentu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	segment.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Name	segment.name	string	Nazwa obiektu.
Utworzono pod adresem	segment.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	segment.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.

Pobieranie sporu

Identyfikator operacji:: DisputeRetrieve

Zwraca szczegóły dotyczące konkretnego sporu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator sporu	dispute_id	True	string	Identyfikator sporu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	dispute.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Kwota	dispute.amount_money.amount	integer	Kwota.
Waluta	dispute.amount_money.currency	string	Waluta.
Przyczyna	dispute.reason	string	Przyczyna tego obiektu.
State	dispute.state	string	Bieżący stan.
Termin ukończenia o	dispute.due_at	string	Czas ukończenia następnej akcji w formacie RFC 3339.
Sporne płatności	dispute.disputed_payments	array of object
Identyfikator płatności	dispute.disputed_payments.payment_id	string	Unikatowy identyfikator płatności wygenerowany kwadratowo.
Znak karty	dispute.card_brand	string	Marka karty.
Utworzono pod adresem	dispute.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	dispute.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Identyfikator sporu marki	dispute.brand_dispute_id	string	Identyfikator sporu w systemie marki kart wygenerowany przez markę kart.

Pobieranie subskrypcji

Identyfikator operacji:: SubscriptionRetrieve

Pobiera subskrypcję.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator subskrypcji	subscription_id	True	string	Identyfikator subskrypcji.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	subscription.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator lokalizacji	subscription.location_id	string	Identyfikator lokalizacji.
Identyfikator planu	subscription.plan_id	string	Identyfikator skojarzonego planu subskrypcji.
Identyfikator klienta	subscription.customer_id	string	Identyfikator tego obiektu reprezentującego klienta.
Data rozpoczęcia	subscription.start_date	string	Data rozpoczęcia subskrypcji w formacie RRRR-MM-DD.
Opłata za datę	subscription.charged_through_date	string	Data, do której klient jest fakturowany za subskrypcję w formacie RRRR-MM-DD.
Status	subscription.status	string	Bieżący stan weryfikacji tego obiektu.
Identyfikatory faktur	subscription.invoice_ids	array of string
Kwota	subscription.price_override_money.amount	integer	Kwota.
Waluta	subscription.price_override_money.currency	string	Waluta.
Utworzono pod adresem	subscription.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Płatna do daty	subscription.paid_until_date	string	Data płatności do.
Timezone	subscription.timezone	string	Strefa czasowa używana do interpretowania dat kalendarza. Po utworzeniu faktury to pole jest ustawione na strefę czasową określoną dla lokalizacji sprzedawcy. Nie można zmienić wartości.
Name	subscription.source.name	string	Nazwa.

Pobieranie transferu spisu (wersja beta)

Identyfikator operacji:: InventoryRetrieveTransfer

Zwraca obiekt InventoryTransfer z podanym transfer_id.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator transferu	transfer_id	True	string	Identyfikator transferu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	transfer.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator obiektu wykazu	transfer.catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
Typ obiektu wykazu	transfer.catalog_object_type	string	Typ śledzonego obiektu CatalogObject.
Utworzono pod adresem	transfer.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Identyfikator pracownika	transfer.employee_id	string	Identyfikator wygenerowany kwadratowo pracownika.
Z identyfikatora lokalizacji	transfer.from_location_id	string	Identyfikator wygenerowany przez kwadrat lokalizacji, w której powiązana ilość elementów została śledzona przed przeniesieniem.
Do identyfikatora lokalizacji	transfer.to_location_id	string	Identyfikator wygenerowany przez kwadrat lokalizacji, w której powiązana ilość elementów została śledzona po przeniesieniu.
Wystąpił o	transfer.occurred_at	string	Sygnatura czasowa w formacie RFC 3339 wygenerowana przez klienta, która wskazuje, kiedy nastąpiła korekta zapasów. W przypadku aktualizacji korekty spisu sygnatura czasowa occurred_at nie może być starsza niż 24 godziny ani w przyszłości względem czasu żądania.
Ilość	transfer.quantity	string	Liczba elementów, na które ma wpływ korekta jako ciąg dziesiętny. Może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Identyfikator odwołania	transfer.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Product	transfer.source.product	string	Typ produktu dla aplikacji.
Identyfikator aplikacji	transfer.source.application_id	string	Identyfikator kwadratowy tylko do odczytu przypisany do aplikacji.
Name	transfer.source.name	string	Nazwa.
State	transfer.state	string	Bieżący stan.

Pobieranie wyewidencjonowania terminalu

Identyfikator operacji:: TerminalGetCheckout

Pobiera żądanie wyewidencjonowania terminalu przez checkout_id.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator wyewidencjonowania	checkout_id	True	string	Identyfikator wyewidencjonowania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	checkout.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Kwota	checkout.amount_money.amount	integer	Kwota.
Waluta	checkout.amount_money.currency	string	Waluta.
Identyfikator odwołania	checkout.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Uwaga / Notatka	checkout.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Identyfikator urządzenia	checkout.device_options.device_id	string	Unikatowy identyfikator urządzenia przeznaczonego dla tego terminaluCheckout.
Zezwalaj na poradę	checkout.device_options.tip_settings.allow_tipping	boolean	Wskazuje, czy dla tego wyewidencjonowania włączono przechylanie. Wartość domyślna to fałsz.
Ekran pominięcia potwierdzenia	checkout.device_options.skip_receipt_screen	boolean	Nakazuje urządzeniu pominięcie ekranu potwierdzenia. Wartość domyślna to fałsz.
Status	checkout.status	string	Bieżący stan weryfikacji tego obiektu.
Utworzono pod adresem	checkout.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	checkout.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
identyfikator aplikacji	checkout.app_id	string	Identyfikator aplikacji, która utworzyła wyewidencjonowania.
Czas trwania terminu trwania	checkout.deadline_duration	string	Czas trwania RFC 3339, po którym kasa zostanie automatycznie anulowana. Sprawdzanie terminalu, które jest oczekujące, jest automatycznie ANULOWANE i ma przyczynę anulowania TIMED_OUT. Ustawienie domyślne: 5 minut od utworzenia

Pobieranie zamówienia

Identyfikator operacji:: OrderRetrieve

Pobiera zamówienie według identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator zamówienia	order_id	True	string	Identyfikator zamówienia.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	order.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator lokalizacji	order.location_id	string	Identyfikator lokalizacji.
Elementy wiersza	order.line_items	array of object
UID	order.line_items.uid	string	Identyfikator wygenerowany przez kwadrat.
Ilość	order.line_items.quantity	string	Liczba elementów, których dotyczy liczba fizyczna jako ciąg dziesiętny. Liczba może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Name	order.line_items.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Kwota	order.line_items.base_price_money.amount	integer	Kwota.
Waluta	order.line_items.base_price_money.currency	string	Waluta.
Kwota	order.line_items.gross_sales_money.amount	integer	Kwota.
Waluta	order.line_items.gross_sales_money.currency	string	Waluta.
Kwota	order.line_items.total_tax_money.amount	integer	Kwota.
Waluta	order.line_items.total_tax_money.currency	string	Waluta.
Kwota	order.line_items.total_discount_money.amount	integer	Kwota.
Waluta	order.line_items.total_discount_money.currency	string	Waluta.
Kwota	order.line_items.total_money.amount	integer	Kwota.
Waluta	order.line_items.total_money.currency	string	Waluta.
Kwota	order.line_items.variation_total_price_money.amount	integer	Kwota.
Waluta	order.line_items.variation_total_price_money.currency	string	Waluta.
Zastosowane rabaty	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Identyfikator przypisany do kwadratu.
Identyfikator UID rabatu	order.line_items.applied_discounts.discount_uid	string	Identyfikator uid rabatu, który reprezentuje zastosowany rabat.
Kwota	order.line_items.applied_discounts.applied_money.amount	integer	Kwota.
Waluta	order.line_items.applied_discounts.applied_money.currency	string	Waluta.
Rabaty	order.discounts	array of object
UID	order.discounts.uid	string	Identyfikator wygenerowany przez kwadrat.
Name	order.discounts.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Procent	order.discounts.percentage	string	Wartość procentowa w postaci dziesiętnej, używając znaku "". jako separatora dziesiętnego i bez znaku "%". Wartość 7,5 odpowiada 7,5%.
Kwota	order.discounts.applied_money.amount	integer	Kwota.
Waluta	order.discounts.applied_money.currency	string	Waluta.
Typ	order.discounts.type	string	Wskazuje typ.
Scope	order.discounts.scope	string	Wskazuje bieżący poziom.
Utworzono pod adresem	order.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	order.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
State	order.state	string	Bieżący stan.
wersja	order.version	integer	Bieżąca wersja tego obiektu.
Kwota	order.total_tax_money.amount	integer	Kwota.
Waluta	order.total_tax_money.currency	string	Waluta.
Kwota	order.total_discount_money.amount	integer	Kwota.
Waluta	order.total_discount_money.currency	string	Waluta.
Kwota	order.total_tip_money.amount	integer	Kwota.
Waluta	order.total_tip_money.currency	string	Waluta.
Kwota	order.total_money.amount	integer	Kwota.
Waluta	order.total_money.currency	string	Waluta.
Kwota	order.total_service_charge_money.amount	integer	Kwota.
Waluta	order.total_service_charge_money.currency	string	Waluta.
Kwota	order.net_amounts.total_money.amount	integer	Kwota.
Waluta	order.net_amounts.total_money.currency	string	Waluta.
Kwota	order.net_amounts.tax_money.amount	integer	Kwota.
Waluta	order.net_amounts.tax_money.currency	string	Waluta.
Kwota	order.net_amounts.discount_money.amount	integer	Kwota.
Waluta	order.net_amounts.discount_money.currency	string	Waluta.
Kwota	order.net_amounts.tip_money.amount	integer	Kwota.
Waluta	order.net_amounts.tip_money.currency	string	Waluta.
Kwota	order.net_amounts.service_charge_money.amount	integer	Kwota.
Waluta	order.net_amounts.service_charge_money.currency	string	Waluta.

Pobieranie zamówień wsadowych

Identyfikator operacji:: OrderBatchRetrieve

Pobiera zestaw zamówień według ich identyfikatorów. Jeśli dany identyfikator zamówienia nie istnieje, identyfikator jest ignorowany zamiast generowania błędu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator lokalizacji	location_id		string	Identyfikator lokalizacji.
Identyfikatory zamówień	order_ids		array of string

Zwraca

Nazwa	Ścieżka	Typ	Opis
Zamówienia	orders	array of object
identyfikator	orders.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator lokalizacji	orders.location_id	string	Identyfikator lokalizacji.
Identyfikator odwołania	orders.reference_id	string	Opcjonalny drugi identyfikator używany do skojarzenia profilu klienta z jednostką w innym systemie.
Elementy wiersza	orders.line_items	array of object
UID	orders.line_items.uid	string	Identyfikator wygenerowany kwadratowo żądania płatności na fakturze.
Name	orders.line_items.name	string	Czytelna dla człowieka nazwa.
Ilość	orders.line_items.quantity	string	Zakupiona ilość, sformatowana jako liczba dziesiętna.
Kwota	orders.line_items.base_price_money.amount	integer	Kwota.
Waluta	orders.line_items.base_price_money.currency	string	Waluta.
Kwota	orders.line_items.total_money.amount	integer	Kwota.
Waluta	orders.line_items.total_money.currency	string	Waluta.
Kwota	orders.total_money.amount	integer	Kwota.
Waluta	orders.total_money.currency	string	Waluta.

Przeszukiwanie obiektów wykazu

Identyfikator operacji:: CatalogSearch

Wyszukuje element CatalogObject dowolnego typu, pasując do obsługiwanych wartości atrybutów wyszukiwania, z wyłączeniem niestandardowych wartości atrybutów dla elementów lub odmian elementów względem co najmniej jednego filtru określonego zapytania.

Parametry

Nazwa	Klucz	Typ	Opis
Typy obiektów	object_types	array of string
Nazwa atrybutu	attribute_name	string	Nazwa atrybutu do wyszukania.
Prefiks atrybutu	attribute_prefix	string	Żądany prefiks wartości atrybutu wyszukiwania.
Ograniczenie	limit	integer	Limit liczby wyników, które mają być zwracane na jednej stronie. Limit jest poradą — implementacja może zwrócić więcej lub mniej wyników. Jeśli podany limit jest ujemny, zero lub jest wyższy niż maksymalny limit wynoszący 1000, zostanie zignorowany.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Objects	objects	array of object
Typ	objects.type	string	Typ tego obiektu.
identyfikator	objects.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Zaktualizowano o	objects.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
wersja	objects.version	integer	Bieżąca wersja obiektu.
Jest usuwany	objects.is_deleted	boolean	Jeśli wartość true, obiekt został usunięty z bazy danych. W wstawianiu nowych obiektów musi być fałsz. Po usunięciu pole updated_at będzie równe czasowi usunięcia.
Obecne we wszystkich lokalizacjach	objects.present_at_all_locations	boolean	Jeśli to prawda, ten obiekt jest obecny we wszystkich lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem sytuacji, w których określono w polu absent_at_location_ids. Jeśli wartość false, ten obiekt nie jest obecny w żadnych lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem przypadków określonych w polu present_at_location_ids. Jeśli nie zostanie określony, wartość domyślna to true.
Name	objects.item_data.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Description	objects.item_data.title	string	Opis elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, a jego długość wartości to punkty kodu Unicode.
Identyfikator kategorii	objects.item_data.category_id	string	Identyfikator kategorii elementu, jeśli istnieje.
Typ produktu	objects.item_data.product_type	string	Wyrażenie zapytania typów produktów zwraca elementy lub odmiany elementów o określonych typach produktów.
Identyfikatory podatkowe	objects.item_data.tax_ids	array of string
Zmiany	objects.item_data.variations	array of object
Typ	objects.item_data.variations.type	string	Typ tego obiektu. Każdy typ obiektu ma oczekiwane właściwości wyrażone w formacie ustrukturyzowanym w odpowiednim polu *_data poniżej.
identyfikator	objects.item_data.variations.id	string	Identyfikator odwołujący się do tego obiektu.
Zaktualizowano o	objects.item_data.variations.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
wersja	objects.item_data.variations.version	integer	Wersja obiektu. Podczas aktualizowania obiektu podana wersja musi być zgodna z wersją w bazie danych. W przeciwnym razie zapis zostanie odrzucony jako powodujący konflikt.
Jest usuwany	objects.item_data.variations.is_deleted	boolean	Jeśli wartość true, obiekt został usunięty z bazy danych. W wstawianiu nowych obiektów musi być fałsz. Po usunięciu pole updated_at będzie równe czasowi usunięcia.
Obecne we wszystkich lokalizacjach	objects.item_data.variations.present_at_all_locations	boolean	Lista lokalizacji, w których znajduje się obiekt, nawet jeśli present_at_all_locations jest fałszem. Może to obejmować lokalizacje, które są dezaktywowane.
Identyfikator elementu	objects.item_data.variations.item_variation_data.item_id	string	Identyfikator obiektu o tej odmianie elementu.
Name	objects.item_data.variations.item_variation_data.name	string	Nazwa tego elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, a jego długość wartości to punkty kodu Unicode.
Liczba porządkowa	objects.item_data.variations.item_variation_data.ordinal	integer	Kolejność wyświetlania tej odmiany elementu. Ta wartość jest tylko do odczytu.
Kwota	objects.item_data.variations.item_variation_data.price_money.amount	integer	Kwota pieniędzy, w najmniejszym nominałach waluty wskazanej przez walutę. Na przykład gdy waluta to USD, kwota jest wyrażona w centach. Kwoty pieniężne mogą być dodatnie lub ujemne. Zapoznaj się z opisem określonego pola, aby określić znaczenie znaku w konkretnym przypadku.
Waluta	objects.item_data.variations.item_variation_data.price_money.currency	string	Typ waluty w formacie ISO 4217. Na przykład kod waluty dla dolarów amerykańskich to USD.
Typ cennika	objects.item_data.variations.item_variation_data.pricing_type	string	Wskazuje, czy cena odmiany produktu jest stała, czy określona w momencie sprzedaży.
Widoczność	objects.item_data.visibility	string	Widoczność.

Prześlij dowody

Identyfikator operacji:: EvidenceSubmit

Przesyła dowody do banku posiadacza karty. Przed przesłaniem dowodów Square skompiluje wszystkie dostępne dowody. Obejmuje to dowody przekazane przy użyciu punktów końcowych CreateDisputeEvidenceFile i CreateDisputeEvidenceText oraz dowodów dostarczonych automatycznie przez square, gdy są dostępne.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator sporu	dispute_id	True	string	Identyfikator sporu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	dispute.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Kwota	dispute.amount_money.amount	integer	Kwota.
Waluta	dispute.amount_money.currency	string	Waluta.
Przyczyna	dispute.reason	string	Przyczyna tego obiektu.
State	dispute.state	string	Bieżący stan.
Termin ukończenia o	dispute.due_at	string	Czas ukończenia następnej akcji w formacie RFC 3339.
Sporne płatności	dispute.disputed_payments	array of object
Identyfikator płatności	dispute.disputed_payments.payment_id	string	Unikatowy identyfikator płatności wygenerowany kwadratowo.
Znak karty	dispute.card_brand	string	Marka karty.
Utworzono pod adresem	dispute.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	dispute.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Identyfikator sporu marki	dispute.brand_dispute_id	string	Identyfikator sporu w systemie marki kart wygenerowany przez markę kart.

Publikowanie faktury

Identyfikator operacji:: InvoicePublish

Publikuje określoną fakturę roboczą. Po opublikowaniu faktury square następuje zgodnie z konfiguracją faktury. Na przykład Square wysyła fakturę na adres e-mail klienta, pobiera opłaty za kartę klienta w pliku lub nic nie robi. Kwadrat udostępnia również fakturę na stronie faktury hostowanej na placu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator faktury	invoice_id	True	string	Identyfikator faktury.
wersja	version		integer	Wersja.
Klucz idempotentności	idempotency_key		string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	invoice.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
wersja	invoice.version	integer	Bieżąca wersja tego obiektu.
Identyfikator lokalizacji	invoice.location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	invoice.order_id	string	Identyfikator zamówienia.
Żądania płatności	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Identyfikator wygenerowany przez kwadrat.
Typ żądania	invoice.payment_requests.request_type	string	Określa typ żądania płatności. Ten typ definiuje sposób określania kwoty żądania płatności.
Data upływu	invoice.payment_requests.due_date	string	Data ukończenia żądania płatności w formacie RRRR-MM-DD.
Włączone przechylanie	invoice.payment_requests.tipping_enabled	boolean	Jeśli ustawiono wartość true, zapewnia klientowi miejsce na zapłacenie porady.
Przypomnienia	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Identyfikator przypisany do kwadratu.
Względne dni zaplanowane	invoice.payment_requests.reminders.relative_scheduled_days	integer	Liczba dni przed (liczba ujemna) lub po (liczbie dodatniej) żądanie płatności due_date po wysłaniu przypomnienia.
Message	invoice.payment_requests.reminders.message	string	Wiadomość.
Status	invoice.payment_requests.reminders.status	string	Bieżący stan.
Kwota	invoice.payment_requests.computed_amount_money.amount	integer	Kwota.
Waluta	invoice.payment_requests.computed_amount_money.currency	string	Waluta.
Kwota	invoice.payment_requests.total_completed_amount_money.amount	integer	Kwota.
Waluta	invoice.payment_requests.total_completed_amount_money.currency	string	Waluta.
Automatyczne źródło płatności	invoice.payment_requests.automatic_payment_source	string	Forma płatności za automatyczną płatność.
Numer faktury	invoice.invoice_number	string	Przyjazny dla użytkownika numer faktury. Wartość jest unikatowa w obrębie lokalizacji. Jeśli nie zostanie podana podczas tworzenia faktury, square przypisuje wartość.
Title	invoice.title	string	Tytuł.
Description	invoice.description	string	Opis.
Zaplanowane o godzinie	invoice.scheduled_at	string	Sygnatura czasowa zaplanowana przetwarzania w formacie RFC 3339.
Status	invoice.status	string	Bieżący stan weryfikacji tego obiektu.
Timezone	invoice.timezone	string	Strefa czasowa używana do interpretowania dat kalendarza. Po utworzeniu faktury to pole jest ustawione na strefę czasową określoną dla lokalizacji sprzedawcy. Nie można zmienić wartości.
Utworzono pod adresem	invoice.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	invoice.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Identyfikator klienta	invoice.primary_recipient.customer_id	string	Identyfikator klienta skojarzonego z zamówieniem.
Imię	invoice.primary_recipient.given_name	string	Podane przez adresata (czyli imię).
Nazwisko	invoice.primary_recipient.family_name	string	Rodzina adresata (czyli nazwisko).
Adres e-mail	invoice.primary_recipient.email_address	string	Adres e-mail adresata.
Numer telefonu	invoice.primary_recipient.phone_number	string	Numer telefonu odbiorcy.
Publiczny adres URL	invoice.public_url	string	Adres URL strony faktury hostowanej na placu. Po opublikowaniu faktury przy użyciu punktu końcowego PublishInvoice square hostuje stronę faktury i zwraca adres URL strony w odpowiedzi.
Card	invoice.accepted_payment_methods.card	boolean	Wskazuje, czy płatności kartą kredytową lub debetową są akceptowane.
Kwadratowa karta upominkowa	invoice.accepted_payment_methods.square_gift_card	boolean	Wskazuje, czy płatności kartami upominkowymi square są akceptowane.
Konto	invoice.accepted_payment_methods.bank_account	boolean	Wskazuje, czy płatności przelewów bankowych są akceptowane.
Pola niestandardowe	invoice.custom_fields	array of object
Etykieta	invoice.custom_fields.label	string	Etykieta lub tytuł pola niestandardowego.
Wartość	invoice.custom_fields.value	string	Tekst pola niestandardowego.
Umieszczenie	invoice.custom_fields.placement	string	Lokalizacja pola niestandardowego na fakturze.
Metoda dostarczania	invoice.delivery_method	string	Metoda dostarczania używana przez Square do wysyłania faktury, przypomnień i paragonów do klienta. Po opublikowaniu faktury square przetwarza fakturę na podstawie ustawień metody dostawy i żądania płatności, natychmiast lub w dniu scheduled_at, jeśli określono.
Data sprzedaży lub usługi	invoice.sale_or_service_date	string	Data sprzedaży lub data renderowania usługi w formacie RRRR-MM-DD. To pole może służyć do określenia daty wcześniejszej lub przyszłej wyświetlanej na fakturze.

Płatność za zamówienie (wersja beta)

Identyfikator operacji:: OrderPay

Zapłać za zamówienie przy użyciu co najmniej jednej zatwierdzonej płatności lub ureguluj zamówienie w sumie 0. Suma payment_ids wymienionych w żądaniu musi być równa sumie zamówień. Zamówienia o łącznej wartości 0 można oznaczyć jako płatne, określając pustą tablicę payment_ids w żądaniu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator zamówienia	order_id	True	string	Identyfikator zamówienia.
Klucz idempotentności	idempotency_key		string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
Identyfikatory płatności	payment_ids		array of string

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	order.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator lokalizacji	order.location_id	string	Identyfikator lokalizacji.
Elementy wiersza	order.line_items	array of object
UID	order.line_items.uid	string	Identyfikator wygenerowany przez kwadrat.
Ilość	order.line_items.quantity	string	Liczba elementów, których dotyczy liczba fizyczna jako ciąg dziesiętny. Liczba może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Name	order.line_items.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Kwota	order.line_items.base_price_money.amount	integer	Kwota.
Waluta	order.line_items.base_price_money.currency	string	Waluta.
Kwota	order.line_items.gross_sales_money.amount	integer	Kwota.
Waluta	order.line_items.gross_sales_money.currency	string	Waluta.
Kwota	order.line_items.total_tax_money.amount	integer	Kwota.
Waluta	order.line_items.total_tax_money.currency	string	Waluta.
Kwota	order.line_items.total_discount_money.amount	integer	Kwota.
Waluta	order.line_items.total_discount_money.currency	string	Waluta.
Kwota	order.line_items.total_money.amount	integer	Kwota.
Waluta	order.line_items.total_money.currency	string	Waluta.
Utworzono pod adresem	order.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	order.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
wersja	order.version	integer	Bieżąca wersja tego obiektu.
Kwota	order.total_tax_money.amount	integer	Kwota.
Waluta	order.total_tax_money.currency	string	Waluta.
Kwota	order.total_discount_money.amount	integer	Kwota.
Waluta	order.total_discount_money.currency	string	Waluta.
Kwota	order.total_money.amount	integer	Kwota.
Waluta	order.total_money.currency	string	Waluta.
Zamknięte o godzinie	order.closed_at	string	Czas zamknięcia w formacie ISO 8601.
Ofert	order.tenders	array of object
identyfikator	order.tenders.id	string	Identyfikator obiektu
Identyfikator lokalizacji	order.tenders.location_id	string	Identyfikator lokalizacji odbiorcy (innej niż kupca) otrzymującej część tego przetargu.
Identyfikator transakcji	order.tenders.transaction_id	string	Identyfikator skojarzonej transakcji przetargowej.
Utworzono pod adresem	order.tenders.created_at	string	Sygnatura czasowa utworzona w formacie RFC 3339.
Kwota	order.tenders.amount_money.amount	integer	Kwota.
Waluta	order.tenders.amount_money.currency	string	Waluta.
Typ	order.tenders.type	string	Wskazuje typ.
Status	order.tenders.card_details.status	string	Bieżący stan płatności karty kredytowej (na przykład AUTORYZOWANY LUB PRZECHWYCONY)
Znak karty	order.tenders.card_details.card.card_brand	string	Marka karty.
last_4	order.tenders.card_details.card.last_4	string	Ostatnie 4 cyfry numeru karty.
Miesiąc eksploduj	order.tenders.card_details.card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok eksplorowy	order.tenders.card_details.card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Odcisk palca	order.tenders.card_details.card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
Entry, metoda	order.tenders.card_details.entry_method	string	Metoda używana do wprowadzania szczegółów karty dla transakcji.
Identyfikator płatności	order.tenders.payment_id	string	Unikatowy identyfikator płatności wygenerowany kwadratowo.
Kwota	order.total_service_charge_money.amount	integer	Kwota.
Waluta	order.total_service_charge_money.currency	string	Waluta.
Kwota	order.net_amounts.total_money.amount	integer	Kwota.
Waluta	order.net_amounts.total_money.currency	string	Waluta.
Kwota	order.net_amounts.tax_money.amount	integer	Kwota.
Waluta	order.net_amounts.tax_money.currency	string	Waluta.
Kwota	order.net_amounts.discount_money.amount	integer	Kwota.
Waluta	order.net_amounts.discount_money.currency	string	Waluta.
Kwota	order.net_amounts.tip_money.amount	integer	Kwota.
Waluta	order.net_amounts.tip_money.currency	string	Waluta.
Kwota	order.net_amounts.service_charge_money.amount	integer	Kwota.
Waluta	order.net_amounts.service_charge_money.currency	string	Waluta.
Name	order.source.name	string	Nazwa.
State	order.state	string	Bieżący stan.

Płatność zwrotu

Identyfikator operacji:: RefundPayment

Zwraca płatność. Możesz zwrócić całą kwotę płatności lub część. Możesz użyć tego punktu końcowego, aby uzyskać zwrot płatności kartą lub zarejestrować zwrot gotówki lub płatności zewnętrznej.

Parametry

Nazwa	Klucz	Typ	Opis
Klucz idempotentności	idempotency_key	string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
Identyfikator płatności	payment_id	string	Unikatowy identyfikator zwracanej płatności.
Kwota	amount	integer	Kwota pieniędzy do zaakceptowania za tę płatność, nie w tym tip_money.
Waluta	currency	string	3-znakowy kod waluty ISO 4217.
Kwota	amount	integer	Kwota pieniędzy do zaakceptowania za tę płatność, nie w tym tip_money.
Waluta	currency	string	3-znakowy kod waluty ISO 4217.
Przyczyna	reason	string	Opis przyczyny zwrotu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	refund.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Status	refund.status	string	Bieżący stan weryfikacji tego obiektu.
Kwota	refund.amount_money.amount	integer	Kwota.
Waluta	refund.amount_money.currency	string	Waluta.
Identyfikator płatności	refund.payment_id	string	Unikatowy identyfikator płatności.
Identyfikator zamówienia	refund.order_id	string	Identyfikator zamówienia.
Utworzono pod adresem	refund.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	refund.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Kwota	refund.app_fee_money.amount	integer	Kwota.
Waluta	refund.app_fee_money.currency	string	Waluta.
Identyfikator lokalizacji	refund.location_id	string	Identyfikator lokalizacji.
Przyczyna	refund.reason	string	Przyczyna tego obiektu.

Rejestrowanie domeny za usługę Apple Pay

Identyfikator operacji:: ApplePayRegister

Aktywuje domenę do użycia z usługą Apple Pay w sieci Web i square. Walidacja jest przeprowadzana w tej domenie przez firmę Apple, aby upewnić się, że jest ona prawidłowo skonfigurowana jako domena z włączoną usługą Apple Pay.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Nazwa domeny	domain_name	True	string	Nazwa domeny zgodnie z opisem w RFC-1034, która zostanie zarejestrowana w usłudze Apple Pay.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Status	status	string	Stan rejestracji domeny.

Spis zmian wsadowych

Identyfikator operacji:: InventoryBatchChange

Stosuje korekty i liczby do podanych ilości elementów. Po powodzeniu: zwraca bieżące obliczone liczby dla wszystkich obiektów, do których odwołuje się żądanie.

Parametry

Nazwa	Klucz	Typ	Opis
Klucz idempotentności	idempotency_key	string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
Typ	type	string	Typ tego obiektu.
Identyfikator odwołania	reference_id	string	Opcjonalny identyfikator referencyjny zdefiniowany przez użytkownika, który kojarzy tę kartę z inną jednostką w systemie zewnętrznym.
Identyfikator obiektu wykazu	catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
State	state	string	Bieżący stan spisu dla powiązanej ilości elementów.
Identyfikator lokalizacji	location_id	string	Identyfikator lokalizacji odbiorcy (innej niż kupca) otrzymującej część tego przetargu.
Ilość	quantity	string	Liczba elementów, których dotyczy liczba fizyczna jako ciąg dziesiętny. Liczba może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Identyfikator pracownika	employee_id	string	Identyfikator wygenerowany kwadratowo pracownika odpowiedzialnego za liczbę fizyczną.
Wystąpił o	occurred_at	string	Wygenerowany przez klienta znacznik czasu w formacie RFC 3339, który wskazuje, kiedy liczba fizyczna została zbadana. W przypadku aktualizacji liczby fizycznej sygnatura czasowa occurred_at nie może być starsza niż 24 godziny ani w przyszłości w stosunku do czasu żądania.
Ignoruj niezmienione liczby	ignore_unchanged_counts	boolean	Wskazuje, czy bieżąca liczba fizyczna powinna być ignorowana, jeśli ilość pozostaje niezmieniona od ostatniej liczby fizycznej.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Liczy	counts	array of object
Identyfikator obiektu wykazu	counts.catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
Typ obiektu wykazu	counts.catalog_object_type	string	Typ śledzonego obiektu CatalogObject.
State	counts.state	string	Bieżący stan.
Identyfikator lokalizacji	counts.location_id	string	Identyfikator lokalizacji.
Ilość	counts.quantity	string	Liczba elementów, na które ma wpływ szacowana liczba jako ciąg dziesiętny. Może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Obliczane o	counts.calculated_at	string	Sygnatura czasowa w formacie RFC 3339 wskazująca, kiedy zostanie odebrana najnowsza liczba fizyczna lub korekta wpływająca na szacowaną liczbę.

Tworzenie faktury

Identyfikator operacji:: InvoiceCreate

Tworzy wersję roboczą faktury dla zamówienia utworzonego przy użyciu interfejsu API zamówień. Faktura robocza pozostaje na Twoim koncie i nie jest podejmowana żadna akcja. Musisz opublikować fakturę, zanim square będzie mogła ją przetworzyć (wyślij ją na adres e-mail klienta lub załaduj kartę klienta w pliku).

Parametry

Nazwa	Klucz	Typ	Opis
Klucz idempotentności	idempotency_key	string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
Identyfikator lokalizacji	location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	order_id	string	Identyfikator zamówienia.
Zaplanowane o godzinie	scheduled_at	string	Sygnatura czasowa zaplanowana przetwarzania w formacie RFC 3339.
Identyfikator klienta	customer_id	string	Identyfikator klienta skojarzonego z zamówieniem.
Metoda dostarczania	delivery_method	string	Metoda dostarczania używana przez Square do wysyłania faktury, przypomnień i paragonów do klienta. Po opublikowaniu faktury square przetwarza fakturę na podstawie ustawień metody dostawy i żądania płatności, natychmiast lub w dniu scheduled_at, jeśli określono.
Typ żądania	request_type	string	Określa typ żądania płatności. Ten typ definiuje sposób określania kwoty żądania płatności.
Data upływu	due_date	string	Data ukończenia żądania płatności w formacie RRRR-MM-DD.
Włączone przechylanie	tipping_enabled	boolean	Jeśli ustawiono wartość true, zapewnia klientowi miejsce na zapłacenie porady.
Automatyczne źródło płatności	automatic_payment_source	string	Forma płatności za automatyczną płatność.
Message	message	string	Wiadomość.
Względne dni zaplanowane	relative_scheduled_days	integer	Liczba dni przed (liczba ujemna) lub po (liczbie dodatniej) żądanie płatności due_date po wysłaniu przypomnienia.
Numer faktury	invoice_number	string	Przyjazny dla użytkownika numer faktury. Wartość jest unikatowa w obrębie lokalizacji. Jeśli nie zostanie podana podczas tworzenia faktury, square przypisuje wartość.
Title	title	string	Tytuł.
Description	description	string	Opis.
Card	card	boolean	Wskazuje, czy płatności kartą kredytową lub debetową są akceptowane.
Kwadratowa karta upominkowa	square_gift_card	boolean	Wskazuje, czy płatności kartami upominkowymi square są akceptowane.
Konto	bank_account	boolean	Wskazuje, czy płatności przelewów bankowych są akceptowane.
Etykieta	label	string	Etykieta lub tytuł pola niestandardowego.
Wartość	value	string	Tekst pola niestandardowego.
Umieszczenie	placement	string	Lokalizacja pola niestandardowego na fakturze.
Data sprzedaży lub usługi	sale_or_service_date	string	Data sprzedaży lub data renderowania usługi w formacie RRRR-MM-DD. To pole może służyć do określenia daty wcześniejszej lub przyszłej wyświetlanej na fakturze.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	invoice.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
wersja	invoice.version	integer	Bieżąca wersja tego obiektu.
Identyfikator lokalizacji	invoice.location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	invoice.order_id	string	Identyfikator zamówienia.
Żądania płatności	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	Identyfikator wygenerowany przez kwadrat.
Typ żądania	invoice.payment_requests.request_type	string	Określa typ żądania płatności. Ten typ definiuje sposób określania kwoty żądania płatności.
Data upływu	invoice.payment_requests.due_date	string	Data ukończenia żądania płatności w formacie RRRR-MM-DD.
Włączone przechylanie	invoice.payment_requests.tipping_enabled	boolean	Jeśli ustawiono wartość true, zapewnia klientowi miejsce na zapłacenie porady.
Przypomnienia	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	Identyfikator przypisany do kwadratu.
Względne dni zaplanowane	invoice.payment_requests.reminders.relative_scheduled_days	integer	Liczba dni przed (liczba ujemna) lub po (liczbie dodatniej) żądanie płatności due_date po wysłaniu przypomnienia.
Message	invoice.payment_requests.reminders.message	string	Wiadomość.
Status	invoice.payment_requests.reminders.status	string	Bieżący stan.
Kwota	invoice.payment_requests.computed_amount_money.amount	integer	Kwota.
Waluta	invoice.payment_requests.computed_amount_money.currency	string	Waluta.
Kwota	invoice.payment_requests.total_completed_amount_money.amount	integer	Kwota.
Waluta	invoice.payment_requests.total_completed_amount_money.currency	string	Waluta.
Automatyczne źródło płatności	invoice.payment_requests.automatic_payment_source	string	Forma płatności za automatyczną płatność.
Numer faktury	invoice.invoice_number	string	Przyjazny dla użytkownika numer faktury. Wartość jest unikatowa w obrębie lokalizacji. Jeśli nie zostanie podana podczas tworzenia faktury, square przypisuje wartość.
Title	invoice.title	string	Tytuł.
Description	invoice.description	string	Opis.
Zaplanowane o godzinie	invoice.scheduled_at	string	Sygnatura czasowa zaplanowana przetwarzania w formacie RFC 3339.
Status	invoice.status	string	Bieżący stan weryfikacji tego obiektu.
Timezone	invoice.timezone	string	Strefa czasowa używana do interpretowania dat kalendarza. Po utworzeniu faktury to pole jest ustawione na strefę czasową określoną dla lokalizacji sprzedawcy. Nie można zmienić wartości.
Utworzono pod adresem	invoice.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	invoice.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Identyfikator klienta	invoice.primary_recipient.customer_id	string	Identyfikator klienta skojarzonego z zamówieniem.
Imię	invoice.primary_recipient.given_name	string	Podane przez adresata (czyli imię).
Nazwisko	invoice.primary_recipient.family_name	string	Rodzina adresata (czyli nazwisko).
Adres e-mail	invoice.primary_recipient.email_address	string	Adres e-mail adresata.
Numer telefonu	invoice.primary_recipient.phone_number	string	Numer telefonu odbiorcy.
Card	invoice.accepted_payment_methods.card	boolean	Wskazuje, czy płatności kartą kredytową lub debetową są akceptowane.
Kwadratowa karta upominkowa	invoice.accepted_payment_methods.square_gift_card	boolean	Wskazuje, czy płatności kartami upominkowymi square są akceptowane.
Konto	invoice.accepted_payment_methods.bank_account	boolean	Wskazuje, czy płatności przelewów bankowych są akceptowane.
Pola niestandardowe	invoice.custom_fields	array of object
Etykieta	invoice.custom_fields.label	string	Etykieta lub tytuł pola niestandardowego.
Wartość	invoice.custom_fields.value	string	Tekst pola niestandardowego.
Umieszczenie	invoice.custom_fields.placement	string	Lokalizacja pola niestandardowego na fakturze.
Metoda dostarczania	invoice.delivery_method	string	Metoda dostarczania używana przez Square do wysyłania faktury, przypomnień i paragonów do klienta. Po opublikowaniu faktury square przetwarza fakturę na podstawie ustawień metody dostawy i żądania płatności, natychmiast lub w dniu scheduled_at, jeśli określono.
Data sprzedaży lub usługi	invoice.sale_or_service_date	string	Data sprzedaży lub data renderowania usługi w formacie RRRR-MM-DD. To pole może służyć do określenia daty wcześniejszej lub przyszłej wyświetlanej na fakturze.

Tworzenie grupy klientów

Identyfikator operacji:: CustomGroupCreate

Tworzy nową grupę klientów dla firmy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Name	name		string	Nazwa obiektu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	group.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Name	group.name	string	Nazwa obiektu.
Utworzono pod adresem	group.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	group.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.

Tworzenie karty

Identyfikator operacji:: CardCreate

Dodaje kartę do istniejącego sprzedawcy.

Parametry

Nazwa	Klucz	Typ	Opis
Klucz idempotentności	idempotency_key	string	Klucz idempotentności.
Identyfikator źródła	source_id	string	Identyfikator źródła.
Linia adresowa 1	address_line_1	string	Pierwszy wiersz adresu. Pola rozpoczynające się od address_line zawierają najbardziej szczegółowe informacje dotyczące adresu, takie jak numer ulicy, nazwa ulicy i nazwa budynku.
Wiersz adresu 2	address_line_2	string	Drugi wiersz adresu, jeśli istnieje.
Miejscowość	locality	string	Miasto lub miasto adresu.
Poziom okręgu administracyjnego 1	administrative_district_level_1	string	Jednostka cywilna w kraju adresu. W USA jest to stan.
Kod pocztowy	postal_code	string	Kod pocztowy adresu.
Country	country	string	Kraj adresu w formacie ISO 3166-1-alfa-2.
Nazwa symbolu karty	cardholder_name	string	Nazwa symbolu karty.
Identyfikator klienta	customer_id	string	Identyfikator tego obiektu reprezentującego klienta.
Identyfikator odwołania	reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	card.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Linia adresowa 1	card.billing_address.address_line_1	string	Pierwszy wiersz adresu. Pola rozpoczynające się od address_line zawierają najbardziej szczegółowe informacje dotyczące adresu, takie jak numer ulicy, nazwa ulicy i nazwa budynku.
Wiersz adresu 2	card.billing_address.address_line_2	string	Drugi wiersz adresu, jeśli istnieje.
Miejscowość	card.billing_address.locality	string	Miasto lub miasto adresu.
Poziom okręgu administracyjnego 1	card.billing_address.administrative_district_level_1	string	Jednostka cywilna w kraju adresu. W USA jest to stan.
Kod pocztowy	card.billing_address.postal_code	string	Kod pocztowy adresu.
Country	card.billing_address.country	string	Kraj adresu w formacie ISO 3166-1-alfa-2.
Odcisk palca	card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
BIN	card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN).
Znak karty	card.card_brand	string	Marka karty.
Typ karty	card.card_type	string	Typ karty.
Nazwa symbolu karty	card.cardholder_name	string	Nazwa symbolu karty.
Identyfikator klienta	card.customer_id	string	Identyfikator tego obiektu reprezentującego klienta.
Włączona	card.enabled	boolean	Czy włączono.
Miesiąc eksploduj	card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok eksplorowy	card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Ostatnie 4	card.last_4	string	Ostatnie 4 cyfry numeru karty.
Typ przedpłacony	card.prepaid_type	string	Wskazuje, czy karta jest przedpłacona, czy nie.
Identyfikator odwołania	card.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
wersja	card.version	integer	Bieżąca wersja tego obiektu.

Tworzenie klienta

Identyfikator operacji:: CustomerCreate

Tworzy nowego klienta dla firmy.

Parametry

Nazwa	Klucz	Typ	Opis
Imię	given_name	string	Podana nazwa (czyli imię) skojarzona z profilem klienta.
Nazwisko	family_name	string	Nazwa rodziny (czyli nazwisko) skojarzona z profilem klienta.
Adres e-mail	email_address	string	Adres e-mail skojarzony z profilem klienta.
Nazwa firmy	company_name	string	Nazwa biznesowa skojarzona z profilem klienta.
Pseudonim	nickname	string	Pseudonim profilu klienta.
Linia adresowa 1	address_line_1	string	Pierwszy wiersz adresu.
Wiersz adresu 2	address_line_2	string	Drugi wiersz adresu, jeśli istnieje.
Miejscowość	locality	string	Miasto lub miasto adresu.
Poziom okręgu administracyjnego 1	administrative_district_level_1	string	Jednostka cywilna w kraju adresu. W USA jest to stan.
Kod pocztowy	postal_code	string	Kod pocztowy adresu.
Country	country	string	Kod kraju ISO 3166 Alpha-2.
Numer telefonu	phone_number	string	11-cyfrowy numer telefonu skojarzony z profilem klienta.
Identyfikator odwołania	reference_id	string	Opcjonalny drugi identyfikator używany do skojarzenia profilu klienta z jednostką w innym systemie.
Uwaga / Notatka	note	string	Niestandardowa notatka skojarzona z profilem klienta.
Urodziny	birthday	string	Urodziny skojarzone z profilem klienta w formacie RFC 3339. Rok jest opcjonalny. Strefa czasowa i czas nie są dozwolone. Na przykład 0000-09-21T00:00:00-00:00 reprezentuje urodziny 21 września i 1998-09-21T00:00:00-00:00 w dniu 21 września 1998 r. Tę wartość można również określić w formacie RRRR-MM-DD.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	customer.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Utworzono pod adresem	customer.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	customer.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Imię	customer.given_name	string	Podana (tj. imię) nazwa skojarzona z profilem klienta.
Nazwisko	customer.family_name	string	Rodzina (tj. nazwisko) skojarzona z profilem klienta.
Adres e-mail	customer.email_address	string	Adres e-mail skojarzony z profilem klienta.
Nazwa firmy	customer.company_name	string	Nazwa biznesowa skojarzona z profilem klienta.
Pseudonim	customer.nickname	string	Pseudonim profilu klienta.
Linia adresowa 1	customer.address.address_line_1	string	Pierwszy wiersz adresu. Pola rozpoczynające się od address_line zawierają najbardziej szczegółowe informacje dotyczące adresu, takie jak numer ulicy, nazwa ulicy i nazwa budynku.
Wiersz adresu 2	customer.address.address_line_2	string	Drugi wiersz adresu, jeśli istnieje.
Miejscowość	customer.address.locality	string	Miasto lub miasto adresu.
Poziom okręgu administracyjnego 1	customer.address.administrative_district_level_1	string	Jednostka cywilna w kraju adresu. W USA jest to stan.
Kod pocztowy	customer.address.postal_code	string	Kod pocztowy adresu.
Country	customer.address.country	string	Kraj adresu w formacie ISO 3166-1-alfa-2.
Numer telefonu	customer.phone_number	string	11-cyfrowy numer telefonu skojarzony z profilem klienta.
Identyfikator odwołania	customer.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Uwaga / Notatka	customer.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Urodziny	customer.birthday	string	Urodziny skojarzone z profilem klienta w formacie RFC 3339. Rok jest opcjonalny. Strefa czasowa i czas nie są dozwolone. Na przykład 0000-09-21T00:00:00-00:00 reprezentuje urodziny 21 września i 1998-09-21T00:00:00-00:00 w dniu 21 września 1998 r.
Wiadomość e-mail anulowana	customer.preferences.email_unsubscribed	boolean	Wskazuje, czy klient anulował subskrypcję wiadomości e-mail kampanii marketingowej. Wartość true oznacza, że klient zdecydował się zrezygnować z marketingu e-mail od bieżącego sprzedawcy Square lub od wszystkich sprzedawców Kwadratowych.
Źródło tworzenia	customer.creation_source	string	Źródło tworzenia reprezentuje metodę używaną do tworzenia profilu klienta.
wersja	customer.version	integer	Bieżąca wersja tego obiektu.

Tworzenie płatności

Identyfikator operacji:: PaymentCreate

Tworzy płatność przy użyciu podanego źródła. Możesz użyć tego punktu końcowego, aby naładować kartę (kartę kredytową/debetową lub kwadratową kartę upominkową) lub zarejestrować płatność, którą sprzedawca otrzymał poza Square (płatność gotówkową od kupującego lub płatność, którą podmiot zewnętrzny przetworzył w imieniu sprzedawcy).

Parametry

Nazwa	Klucz	Typ	Opis
Klucz idempotentności	idempotency_key	string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
Kwota	amount	integer	Kwota pieniędzy do zaakceptowania za tę płatność, nie w tym tip_money.
Waluta	currency	string	3-znakowy kod waluty ISO 4217.
Identyfikator źródła	source_id	string	Identyfikator źródła funduszy dla tej płatności. Może to być token płatniczy (bez karty) generowany przez formularz płatności Square lub kartę w pliku wykonanym za pomocą interfejsu API klientów. W przypadku zarejestrowania płatności otrzymanej przez sprzedawcę poza kwadratem określ wartość CASH lub EXTERNAL.
Autouzupełnianie	autocomplete	boolean	Jeśli zostanie ustawiona wartość true, ta płatność zostanie ukończona, gdy będzie to możliwe. Jeśli ustawiono wartość false, ta płatność jest przechowywana w stanie zatwierdzonym do momentu jawnego ukończenia (przechwyconego) lub anulowania (unieważnionej).
Identyfikator klienta	customer_id	string	Identyfikator klienta, który ma być połączony.
Identyfikator lokalizacji	location_id	string	Identyfikator lokalizacji.
Identyfikator odwołania	reference_id	string	Opcjonalny drugi identyfikator używany do skojarzenia profilu klienta z jednostką w innym systemie.
Uwaga / Notatka	note	string	Niestandardowa notatka skojarzona z profilem klienta.
Kwota	amount	integer	Kwota pieniędzy do zaakceptowania za tę płatność, nie w tym tip_money.
Waluta	currency	string	3-znakowy kod waluty ISO 4217.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	payment.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Utworzono pod adresem	payment.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	payment.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Kwota	payment.amount_money.amount	integer	Kwota.
Waluta	payment.amount_money.currency	string	Waluta.
Kwota	payment.app_fee_money.amount	integer	Kwota.
Waluta	payment.app_fee_money.currency	string	Waluta.
Status	payment.status	string	Bieżący stan weryfikacji tego obiektu.
Czas trwania opóźnienia	payment.delay_duration	string	Czas trwania po utworzeniu płatności, gdy Square automatycznie stosuje delay_action do płatności. Ta automatyczna delay_action dotyczy tylko płatności, które nie docierają do stanu terminalu (UKOŃCZONE, ANULOWANE lub NIEUDANE) przed upływem delay_duration czasu. To pole jest określane jako czas trwania w formacie RFC 3339.
Typ źródła	payment.source_type	string	Typ źródła dla tej płatności. Bieżące wartości to CARD, BANK_ACCOUNT, PORTFEL, CASH lub EXTERNAL.
Status	payment.card_details.status	string	Bieżący stan.
Znak karty	payment.card_details.card.card_brand	string	Marka karty.
Ostatnie 4	payment.card_details.card.last_4	string	Ostatnie 4 cyfry numeru karty.
Miesiąc eksploduj	payment.card_details.card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok eksplorowy	payment.card_details.card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Odcisk palca	payment.card_details.card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
Typ karty	payment.card_details.card.card_type	string	Typ karty.
Typ przedpłacony	payment.card_details.card.prepaid_type	string	Wskazuje, czy karta jest przedpłacona, czy nie.
BIN	payment.card_details.card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN).
Entry, metoda	payment.card_details.entry_method	string	Metoda używana do wprowadzania szczegółów karty dla płatności. Metoda może być KEYED, SWIPED, EMV, ON_FILE lub CONTACTLESS.
Stan CVV	payment.card_details.cvv_status	string	Kod stanu zwrócony z sprawdzania wartości weryfikacji karty (CVV). Kod może być CVV_ACCEPTED, CVV_REJECTED lub CVV_NOT_CHECKED.
Stan usługi AVS	payment.card_details.avs_status	string	Kod stanu zwrócony z sprawdzania systemu weryfikacji adresów (AVS). Kod może być AVS_ACCEPTED, AVS_REJECTED lub AVS_NOT_CHECKED.
Kod wyniku uwierzytelniania	payment.card_details.auth_result_code	string	Kod stanu zwrócony przez wystawcę karty, który opisuje stan autoryzacji płatności.
Opis instrukcji	payment.card_details.statement_description	string	Opis instrukcji wysyłany do sieci kart.
Autoryzowane pod adresem	payment.card_details.card_payment_timeline.authorized_at	string	Sygnatura czasowa autoryzacji płatności w formacie RFC 3339.
Przechwycone o	payment.card_details.card_payment_timeline.captured_at	string	Sygnatura czasowa przechwycenia płatności w formacie RFC 3339.
Identyfikator lokalizacji	payment.location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	payment.order_id	string	Identyfikator zamówienia.
Identyfikator odwołania	payment.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Utworzono pod adresem	payment.risk_evaluation.created_at	string	Sygnatura czasowa utworzona w formacie RFC 3339.
Poziom ryzyka	payment.risk_evaluation.risk_level	string	Poziom ryzyka skojarzony z płatnością.
Uwaga / Notatka	payment.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Identyfikator klienta	payment.customer_id	string	Identyfikator tego obiektu reprezentującego klienta.
Kwota	payment.total_money.amount	integer	Kwota.
Waluta	payment.total_money.currency	string	Waluta.
Kwota	payment.approved_money.amount	integer	Kwota.
Waluta	payment.approved_money.currency	string	Waluta.
Numer paragonu	payment.receipt_number	string	Numer paragonu płatności. W przypadku anulowania płatności brakuje pola.
Adres URL potwierdzenia	payment.receipt_url	string	Adres URL potwierdzenia płatności. Pole jest wypełniane tylko w przypadku płatności UKOŃCZONE.
Akcja opóźniająca	payment.delay_action	string	Akcja, która ma zostać zastosowana do płatności po upływie delay_duration.
Opóźnione do	payment.delayed_until	string	Sygnatura czasowa tylko do odczytu w przypadku automatycznego zastosowania delay_action w formacie RFC 3339.
Produkt kwadratowy	payment.application_details.square_product	string	Produkt kwadratowy, taki jak Square Point of Sale (POS), faktury kwadratowe lub kwadratowy terminal wirtualny.
Identyfikator aplikacji	payment.application_details.application_id	string	Identyfikator kwadratowy tylko do odczytu przypisany do aplikacji.
Token wersji	payment.version_token	string	Ten nieprzezroczysty token identyfikuje określoną wersję obiektu.

Tworzenie subskrypcji

Identyfikator operacji:: SubscriptionCreate

Tworzy subskrypcję dla klienta w ramach planu subskrypcji. Jeśli podasz kartę w pliku w żądaniu, square pobiera opłaty za kartę dla subskrypcji. W przeciwnym razie kwadrat rozlicza fakturę na adres e-mail klienta. Subskrypcja zostanie uruchomiona natychmiast, chyba że żądanie zawiera opcjonalne start_date. Każda subskrypcja jest skojarzona z określoną lokalizacją.

Parametry

Nazwa	Klucz	Typ	Opis
Klucz idempotentności	idempotency_key	string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
Identyfikator lokalizacji	location_id	string	Identyfikator lokalizacji.
Identyfikator planu	plan_id	string	Identyfikator planu subskrypcji utworzonego przy użyciu interfejsu API wykazu.
Identyfikator klienta	customer_id	string	Identyfikator klienta, który ma być połączony.
Identyfikator karty	card_id	string	Identyfikator karty klienta do naliczania opłat.
Data rozpoczęcia	start_date	string	Data rozpoczęcia subskrypcji w formacie RRRR-MM-DD.
Procent podatku	tax_percentage	string	Podatek do dodania podczas rozliczeń subskrypcji.
Kwota	amount	integer	Kwota pieniędzy do zaakceptowania za tę płatność, nie w tym tip_money.
Waluta	currency	string	3-znakowy kod waluty ISO 4217.
Timezone	timezone	string	Strefa czasowa używana w obliczeniach dat dla subskrypcji.
Name	name	string	Nazwa obiektu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	subscription.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator lokalizacji	subscription.location_id	string	Identyfikator lokalizacji.
Identyfikator planu	subscription.plan_id	string	Identyfikator skojarzonego planu subskrypcji.
Identyfikator klienta	subscription.customer_id	string	Identyfikator tego obiektu reprezentującego klienta.
Data rozpoczęcia	subscription.start_date	string	Data rozpoczęcia subskrypcji w formacie RRRR-MM-DD.
Status	subscription.status	string	Bieżący stan weryfikacji tego obiektu.
Procent podatku	subscription.tax_percentage	string	Kwota podatku stosowana podczas rozliczeń subskrypcji.
Kwota	subscription.price_override_money.amount	integer	Kwota.
Waluta	subscription.price_override_money.currency	string	Waluta.
wersja	subscription.version	integer	Bieżąca wersja tego obiektu.
Utworzono pod adresem	subscription.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Identyfikator karty	subscription.card_id	string	Identyfikator karty klienta, która jest obciążana opłatą za subskrypcję.
Timezone	subscription.timezone	string	Strefa czasowa używana do interpretowania dat kalendarza. Po utworzeniu faktury to pole jest ustawione na strefę czasową określoną dla lokalizacji sprzedawcy. Nie można zmienić wartości.
Name	subscription.source.name	string	Nazwa.

Tworzenie tekstu dowodów sporu

Identyfikator operacji:: DisputeCreateEvidenceText

Przekazuje tekst do użycia jako dowód na zakwestionowanie sporu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator sporu	dispute_id	True	string	Identyfikator sporu.
Typ dowodu	evidence_type		string	Typ przekazywanych dowodów.
Tekst dowodu	evidence_text		string	Ciąg dowodowy.
Klucz idempotentności	idempotency_key		string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	evidence.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator sporu	evidence.dispute_id	string	Identyfikator sporu jest skojarzony z dowodami.
Tekst dowodu	evidence.evidence_text	string	Tekst pierwotny.
Typ dowodu	evidence.evidence_type	string	Dowód pf typu.
Przekazano o	evidence.uploaded_at	string	Czas ukończenia następnej akcji w formacie RFC 3339.

Tworzenie wyewidencjonowania terminalu

Identyfikator operacji:: TerminalCreateCheckout

Tworzy żądanie wyewidencjonowania terminalu i wysyła je do określonego urządzenia, aby pobrać opłatę za żądaną kwotę.

Parametry

Nazwa	Klucz	Typ	Opis
Klucz idempotentności	idempotency_key	string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
Kwota	amount	integer	Kwota.
Waluta	currency	string	Waluta.
Identyfikator odwołania	reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Identyfikator urządzenia	device_id	string	Unikatowy identyfikator urządzenia przeznaczonego dla tego terminaluCheckout.
Uwaga / Notatka	note	string	Niestandardowa notatka skojarzona z profilem klienta.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	checkout.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Kwota	checkout.amount_money.amount	integer	Kwota.
Waluta	checkout.amount_money.currency	string	Waluta.
Identyfikator odwołania	checkout.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Uwaga / Notatka	checkout.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Identyfikator urządzenia	checkout.device_options.device_id	string	Unikatowy identyfikator urządzenia przeznaczonego dla tego terminaluCheckout.
Zezwalaj na poradę	checkout.device_options.tip_settings.allow_tipping	boolean	Wskazuje, czy dla tego wyewidencjonowania włączono przechylanie. Wartość domyślna to fałsz.
Ekran pominięcia potwierdzenia	checkout.device_options.skip_receipt_screen	boolean	Nakazuje urządzeniu pominięcie ekranu potwierdzenia. Wartość domyślna to fałsz.
Status	checkout.status	string	Bieżący stan weryfikacji tego obiektu.
Utworzono pod adresem	checkout.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	checkout.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
identyfikator aplikacji	checkout.app_id	string	Identyfikator aplikacji, która utworzyła wyewidencjonowania.
Czas trwania terminu trwania	checkout.deadline_duration	string	Czas trwania RFC 3339, po którym kasa zostanie automatycznie anulowana. Sprawdzanie terminalu, które jest oczekujące, jest automatycznie ANULOWANE i ma przyczynę anulowania TIMED_OUT. Ustawienie domyślne: 5 minut od utworzenia
Typ płatności	checkout.payment_type	string	Typ płatności terminal powinien podjąć próbę przechwycenia. Wartość domyślna to CARD_PRESENT.

Tworzenie zamówienia

Identyfikator operacji:: OrderCreate

Tworzy nowe zamówienie, które może zawierać informacje o produktach na potrzeby zakupu i ustawień, które mają być stosowane do zakupu.

Parametry

Nazwa	Klucz	Typ	Opis
Klucz idempotentności	idempotency_key	string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
Identyfikator odwołania	reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Identyfikator lokalizacji	location_id	string	Identyfikator lokalizacji.
Name	name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Ilość	quantity	string	Liczba elementów, których dotyczy liczba fizyczna jako ciąg dziesiętny. Liczba może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Kwota	amount	integer	Kwota.
Waluta	currency	string	Waluta.
Identyfikator obiektu wykazu	catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
Identyfikator obiektu wykazu	catalog_object_id	string	Identyfikator obiektu wykazu.
Identyfikator UID rabatu	discount_uid	string	Identyfikator uid rabatu, który reprezentuje zastosowany rabat.
UID	uid	string	Identyfikator wygenerowany przez kwadrat.
Name	name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Procent	percentage	string	Wartość procentowa w postaci dziesiętnej, używając znaku "". jako separatora dziesiętnego i bez znaku "%". Wartość 7,5 odpowiada 7,5%.
Scope	scope	string	Wskazuje bieżący poziom.
UID	uid	string	Identyfikator wygenerowany przez kwadrat.
Name	name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Procent	percentage	string	Wartość procentowa w postaci dziesiętnej, używając znaku "". jako separatora dziesiętnego i bez znaku "%". Wartość 7,5 odpowiada 7,5%.
Scope	scope	string	Wskazuje bieżący poziom.
Identyfikator obiektu wykazu	catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
Kwota	amount	integer	Kwota.
Waluta	currency	string	Waluta.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	order.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator lokalizacji	order.location_id	string	Identyfikator lokalizacji.
Elementy wiersza	order.line_items	array of object
UID	order.line_items.uid	string	Identyfikator wygenerowany przez kwadrat.
Name	order.line_items.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Ilość	order.line_items.quantity	string	Liczba elementów, których dotyczy liczba fizyczna jako ciąg dziesiętny. Liczba może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Zastosowane podatki	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	Identyfikator przypisany do kwadratu.
Identyfikator UID podatku	order.line_items.applied_taxes.tax_uid	string	Identyfikator UID podatku, dla którego ten zastosowany podatek reprezentuje.
Kwota	order.line_items.applied_taxes.applied_money.amount	integer	Kwota.
Waluta	order.line_items.applied_taxes.applied_money.currency	string	Waluta.
Zastosowane rabaty	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	Identyfikator przypisany do kwadratu.
Identyfikator UID rabatu	order.line_items.applied_discounts.discount_uid	string	Identyfikator uid rabatu, który reprezentuje zastosowany rabat.
Kwota	order.line_items.applied_discounts.applied_money.amount	integer	Kwota.
Waluta	order.line_items.applied_discounts.applied_money.currency	string	Waluta.
Kwota	order.line_items.base_price_money.amount	integer	Kwota.
Waluta	order.line_items.base_price_money.currency	string	Waluta.
Kwota	order.line_items.gross_sales_money.amount	integer	Kwota.
Waluta	order.line_items.gross_sales_money.currency	string	Waluta.
Kwota	order.line_items.total_tax_money.amount	integer	Kwota.
Waluta	order.line_items.total_tax_money.currency	string	Waluta.
Kwota	order.line_items.total_discount_money.amount	integer	Kwota.
Waluta	order.line_items.total_discount_money.currency	string	Waluta.
Kwota	order.line_items.total_money.amount	integer	Kwota.
Waluta	order.line_items.total_money.currency	string	Waluta.
Kwota	order.line_items.variation_total_price_money.amount	integer	Kwota.
Waluta	order.line_items.variation_total_price_money.currency	string	Waluta.
Identyfikator obiektu wykazu	order.line_items.catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
Nazwa odmiany	order.line_items.variation_name	string	Nazwa odmiany zastosowanej do tego elementu wiersza.
Modyfikatory	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	Identyfikator przypisany do kwadratu.
Identyfikator obiektu wykazu	order.line_items.modifiers.catalog_object_id	string	Identyfikator obiektu wykazu.
Name	order.line_items.modifiers.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Kwota	order.line_items.modifiers.base_price_money.amount	integer	Kwota.
Waluta	order.line_items.modifiers.base_price_money.currency	string	Waluta.
Kwota	order.line_items.modifiers.total_price_money.amount	integer	Kwota.
Waluta	order.line_items.modifiers.total_price_money.currency	string	Waluta.
Podatki	order.taxes	array of object
UID	order.taxes.uid	string	Identyfikator wygenerowany przez kwadrat.
Name	order.taxes.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Typ	order.taxes.type	string	Wskazuje typ.
Procent	order.taxes.percentage	string	Wartość procentowa w postaci dziesiętnej, używając znaku "". jako separatora dziesiętnego i bez znaku "%". Wartość 7,5 odpowiada 7,5%.
Kwota	order.taxes.applied_money.amount	integer	Kwota.
Waluta	order.taxes.applied_money.currency	string	Waluta.
Scope	order.taxes.scope	string	Wskazuje bieżący poziom.
Rabaty	order.discounts	array of object
UID	order.discounts.uid	string	Identyfikator wygenerowany przez kwadrat.
Identyfikator obiektu wykazu	order.discounts.catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
Name	order.discounts.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Typ	order.discounts.type	string	Wskazuje typ.
Procent	order.discounts.percentage	string	Wartość procentowa w postaci dziesiętnej, używając znaku "". jako separatora dziesiętnego i bez znaku "%". Wartość 7,5 odpowiada 7,5%.
Kwota	order.discounts.applied_money.amount	integer	Kwota.
Waluta	order.discounts.applied_money.currency	string	Waluta.
Scope	order.discounts.scope	string	Wskazuje bieżący poziom.
Kwota	order.discounts.amount_money.amount	integer	Kwota.
Waluta	order.discounts.amount_money.currency	string	Waluta.
Utworzono pod adresem	order.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	order.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
State	order.state	string	Bieżący stan.
wersja	order.version	integer	Bieżąca wersja tego obiektu.
Identyfikator odwołania	order.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
Kwota	order.total_money.amount	integer	Kwota.
Waluta	order.total_money.currency	string	Waluta.
Kwota	order.total_tax_money.amount	integer	Kwota.
Waluta	order.total_tax_money.currency	string	Waluta.
Kwota	order.total_discount_money.amount	integer	Kwota.
Waluta	order.total_discount_money.currency	string	Waluta.
Kwota	order.total_tip_money.amount	integer	Kwota.
Waluta	order.total_tip_money.currency	string	Waluta.
Kwota	order.total_service_charge_money.amount	integer	Kwota.
Waluta	order.total_service_charge_money.currency	string	Waluta.
Kwota	order.net_amounts.total_money.amount	integer	Kwota.
Waluta	order.net_amounts.total_money.currency	string	Waluta.
Kwota	order.net_amounts.tax_money.amount	integer	Kwota.
Waluta	order.net_amounts.tax_money.currency	string	Waluta.
Kwota	order.net_amounts.discount_money.amount	integer	Kwota.
Waluta	order.net_amounts.discount_money.currency	string	Waluta.
Kwota	order.net_amounts.tip_money.amount	integer	Kwota.
Waluta	order.net_amounts.tip_money.currency	string	Waluta.
Kwota	order.net_amounts.service_charge_money.amount	integer	Kwota.
Waluta	order.net_amounts.service_charge_money.currency	string	Waluta.
Name	order.source.name	string	Nazwa.

Tworzenie zwrotu kosztów terminalu

Identyfikator operacji:: TerminalCreateRefund

Tworzy żądanie zwrotu płatności międzyakcjowej ukończonej w terminalu kwadratowym.

Parametry

Nazwa	Klucz	Typ	Opis
Klucz idempotentności	idempotency_key	string	Określona wartość, która jednoznacznie identyfikuje to żądanie wśród wszystkich żądań. Typowym sposobem utworzenia prawidłowego klucza idempotentności jest użycie uniwersalnego unikatowego identyfikatora (UUID).
Kwota	amount	integer	Kwota.
Waluta	currency	string	Waluta.
Identyfikator urządzenia	device_id	string	Unikatowy identyfikator urządzenia przeznaczonego dla tego terminaluRefund.
Przyczyna	reason	string	Przyczyna tego obiektu.
Identyfikator płatności	payment_id	string	Unikatowy identyfikator płatności.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	refund.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator płatności	refund.payment_id	string	Unikatowy identyfikator płatności.
Kwota	refund.amount_money.amount	integer	Kwota.
Waluta	refund.amount_money.currency	string	Waluta.
Przyczyna	refund.reason	string	Przyczyna tego obiektu.
Identyfikator urządzenia	refund.device_id	string	Unikatowy identyfikator urządzenia przeznaczonego dla tego terminaluRefund.
Czas trwania terminu trwania	refund.deadline_duration	string	Czas trwania RFC 3339, po którym kasa zostanie automatycznie anulowana. Sprawdzanie terminalu, które jest oczekujące, jest automatycznie ANULOWANE i ma przyczynę anulowania TIMED_OUT. Ustawienie domyślne: 5 minut od utworzenia
Status	refund.status	string	Bieżący stan weryfikacji tego obiektu.
Utworzono pod adresem	refund.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	refund.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
identyfikator aplikacji	refund.app_id	string	Identyfikator aplikacji, która utworzyła wyewidencjonowania.
Znak karty	refund.card.card_brand	string	Marka karty.
last_4	refund.card.last_4	string	Ostatnie 4 cyfry numeru karty.
Miesiąc eksploduj	refund.card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok eksplorowy	refund.card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Odcisk palca	refund.card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
Typ karty	refund.card.card_type	string	Typ karty.
BIN	refund.card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN).
Identyfikator zamówienia	refund.order_id	string	Identyfikator zamówienia.
Identyfikator lokalizacji	refund.location_id	string	Identyfikator lokalizacji.

Ukończ płatność

Identyfikator operacji:: PaymentComplete

Kończy (przechwytuje) płatność. Domyślnie płatności są ustawiane na ukończenie natychmiast po ich utworzeniu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator płatności	payment_id	True	string	Identyfikator płatności.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	payment.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Utworzono pod adresem	payment.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	payment.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Kwota	payment.amount_money.amount	integer	Kwota.
Waluta	payment.amount_money.currency	string	Waluta.
Status	payment.status	string	Bieżący stan weryfikacji tego obiektu.
Czas trwania opóźnienia	payment.delay_duration	string	Czas trwania po utworzeniu płatności, gdy Square automatycznie stosuje delay_action do płatności. Ta automatyczna delay_action dotyczy tylko płatności, które nie docierają do stanu terminalu (UKOŃCZONE, ANULOWANE lub NIEUDANE) przed upływem delay_duration czasu. To pole jest określane jako czas trwania w formacie RFC 3339.
Typ źródła	payment.source_type	string	Typ źródła dla tej płatności. Bieżące wartości to CARD, BANK_ACCOUNT, PORTFEL, CASH lub EXTERNAL.
Status	payment.card_details.status	string	Bieżący stan.
Znak karty	payment.card_details.card.card_brand	string	Marka karty.
Ostatnie 4	payment.card_details.card.last_4	string	Ostatnie 4 cyfry numeru karty.
Miesiąc eksploduj	payment.card_details.card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok eksplorowy	payment.card_details.card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Odcisk palca	payment.card_details.card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
Typ karty	payment.card_details.card.card_type	string	Typ karty.
Typ przedpłacony	payment.card_details.card.prepaid_type	string	Wskazuje, czy karta jest przedpłacona, czy nie.
BIN	payment.card_details.card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN).
Entry, metoda	payment.card_details.entry_method	string	Metoda używana do wprowadzania szczegółów karty dla płatności. Metoda może być KEYED, SWIPED, EMV, ON_FILE lub CONTACTLESS.
Stan CVV	payment.card_details.cvv_status	string	Kod stanu zwrócony z sprawdzania wartości weryfikacji karty (CVV). Kod może być CVV_ACCEPTED, CVV_REJECTED lub CVV_NOT_CHECKED.
Stan usługi AVS	payment.card_details.avs_status	string	Kod stanu zwrócony z sprawdzania systemu weryfikacji adresów (AVS). Kod może być AVS_ACCEPTED, AVS_REJECTED lub AVS_NOT_CHECKED.
Kod wyniku uwierzytelniania	payment.card_details.auth_result_code	string	Kod stanu zwrócony przez wystawcę karty, który opisuje stan autoryzacji płatności.
Opis instrukcji	payment.card_details.statement_description	string	Opis instrukcji wysyłany do sieci kart.
Autoryzowane pod adresem	payment.card_details.card_payment_timeline.authorized_at	string	Sygnatura czasowa autoryzacji płatności w formacie RFC 3339.
Przechwycone o	payment.card_details.card_payment_timeline.captured_at	string	Sygnatura czasowa przechwycenia płatności w formacie RFC 3339.
Identyfikator lokalizacji	payment.location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	payment.order_id	string	Identyfikator zamówienia.
Opłata za przetwarzanie	payment.processing_fee	array of object
Obowiązującą	payment.processing_fee.effective_at	string	Znacznik czasu stosowania opłaty w formacie RFC 3339.
Typ	payment.processing_fee.type	string	Wskazuje typ.
Kwota	payment.processing_fee.amount_money.amount	integer	Kwota.
Waluta	payment.processing_fee.amount_money.currency	string	Waluta.
Uwaga / Notatka	payment.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Kwota	payment.total_money.amount	integer	Kwota.
Waluta	payment.total_money.currency	string	Waluta.
Kwota	payment.approved_money.amount	integer	Kwota.
Waluta	payment.approved_money.currency	string	Waluta.
Identyfikator pracownika	payment.employee_id	string	Identyfikator wygenerowany kwadratowo pracownika.
Numer paragonu	payment.receipt_number	string	Numer paragonu płatności. W przypadku anulowania płatności brakuje pola.
Adres URL potwierdzenia	payment.receipt_url	string	Adres URL potwierdzenia płatności. Pole jest wypełniane tylko w przypadku płatności UKOŃCZONE.
Akcja opóźniająca	payment.delay_action	string	Akcja, która ma zostać zastosowana do płatności po upływie delay_duration.
Opóźnione do	payment.delayed_until	string	Sygnatura czasowa tylko do odczytu w przypadku automatycznego zastosowania delay_action w formacie RFC 3339.
Identyfikator członka zespołu	payment.team_member_id	string	Identyfikator członka zespołu.
Produkt kwadratowy	payment.application_details.square_product	string	Produkt kwadratowy, taki jak Square Point of Sale (POS), faktury kwadratowe lub kwadratowy terminal wirtualny.
Identyfikator aplikacji	payment.application_details.application_id	string	Identyfikator kwadratowy tylko do odczytu przypisany do aplikacji.
Token wersji	payment.version_token	string	Ten nieprzezroczysty token identyfikuje określoną wersję obiektu.

Usuwanie dowodów sporu

Identyfikator operacji:: DisputeDeleteEvidence

Usuwa określone dowody z sporu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator sporu	dispute_id	True	string	Identyfikator sporu.
Identyfikator dowodu	evidence_id	True	string	Identyfikator dowodów.

Zwraca

response: object

Usuwanie faktury

Identyfikator operacji:: InvoiceDelete

Usuwa określoną fakturę. Po usunięciu faktury skojarzony stan zamówienia zmieni się na ANULOWANE. Możesz usunąć tylko wersję roboczą faktury (nie można usunąć opublikowanej faktury, w tym faktury zaplanowanej do przetworzenia).

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator faktury	invoice_id	True	string	Identyfikator faktury.
wersja	version		integer	Wersja faktury do usunięcia.

Zwraca

response: object

Usuwanie grupy klientów

Identyfikator operacji:: CustomerGroupDelete

Usuwa grupę klientów zidentyfikowaną przez wartość group_id.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator grupy	group_id	True	string	Identyfikator grupy.

Zwraca

response: object

Usuwanie grupy z klienta

Identyfikator operacji:: CustomerRemoveGroup

Usuwa członkostwo w grupie od klienta. Klient jest identyfikowany przez wartość customer_id, a grupa klientów jest identyfikowana przez wartość group_id.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator klienta	customer_id	True	string	Identyfikator klienta.
Identyfikator grupy	group_id	True	string	Identyfikator grupy.

Zwraca

response: object

Usuwanie klienta

Identyfikator operacji:: CustomerDelete

Usuwa profil klienta z firmy. Ta operacja odłącza również wszystkie skojarzone karty w pliku.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator klienta	customer_id	True	string	Identyfikator klienta.

Zwraca

response: object

Usuwanie obiektu wykazu

Identyfikator operacji:: CatalogDelete

Usuwa pojedynczy obiekt CatalogObject na podstawie podanego identyfikatora i zwraca zestaw pomyślnie usuniętych identyfikatorów w odpowiedzi. Usunięcie jest zdarzeniem kaskadowym, tak aby wszystkie elementy podrzędne obiektu docelowego również zostały usunięte. Na przykład usunięcie elementu CatalogItem spowoduje również usunięcie wszystkich elementów podrzędnych CatalogItemVariation.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator obiektu	object_id	True	string	Identyfikator obiektu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Usunięte identyfikatory obiektów	deleted_object_ids	array of string
Usunięto o	deleted_at	string	Sygnatura czasowa bazy danych tego usunięcia w formacie RFC 3339

Usuwanie obiektów wykazu wsadowego

Identyfikator operacji:: CatalogBatchDelete

Usuwa zestaw elementów CatalogItems na podstawie podanej listy identyfikatorów docelowych i zwraca zestaw pomyślnie usuniętych identyfikatorów w odpowiedzi.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikatory obiektów	object_ids		array of string

Zwraca

Nazwa	Ścieżka	Typ	Opis
Usunięte identyfikatory obiektów	deleted_object_ids	array of string
Usunięto o	deleted_at	string	Sygnatura czasowa bazy danych tego usunięcia w formacie RFC 3339

Usługa Batch pobiera zmiany spisu

Identyfikator operacji:: InventoryBatchRetrieveChanges

Zwraca historyczne liczby fizyczne i korekty na podstawie podanych kryteriów filtrowania.

Parametry

Nazwa	Klucz	Typ	Opis
Identyfikatory obiektów wykazu	catalog_object_ids	array of string
Identyfikatory lokalizacji	location_ids	array of string
Types	types	array of string
States	states	array of string
Zaktualizowano po	updated_after	string	Filtr zwraca wyniki z wartością calculated_at po danym czasie określonym w znaczniku czasu RFC 3339.
Zaktualizowano przed	updated_before	string	Filtr zwracający wyniki z wartością created_at lub calculated_at ściśle przed danym czasem określonym w sygnaturze czasowej RFC 3339.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Changes	changes	array of object
Typ	changes.type	string	Typ tego obiektu.
identyfikator	changes.physical_count.id	string	Identyfikator obiektu
Identyfikator odwołania	changes.physical_count.reference_id	string	Opcjonalny identyfikator referencyjny zdefiniowany przez użytkownika, który kojarzy tę kartę z inną jednostką w systemie zewnętrznym.
Identyfikator obiektu wykazu	changes.physical_count.catalog_object_id	string	Identyfikator wygenerowany przez kwadrat śledzonego obiektu CatalogObject.
Typ obiektu wykazu	changes.physical_count.catalog_object_type	string	Typ śledzonego obiektu CatalogObject.
State	changes.physical_count.state	string	Bieżący stan spisu dla powiązanej ilości elementów.
Identyfikator lokalizacji	changes.physical_count.location_id	string	Identyfikator lokalizacji odbiorcy (innej niż kupca) otrzymującej część tego przetargu.
Ilość	changes.physical_count.quantity	string	Liczba elementów, których dotyczy liczba fizyczna jako ciąg dziesiętny. Liczba może obsługiwać maksymalnie 5 cyfr po przecinku dziesiętny.
Product	changes.physical_count.source.product	string	Typ produktu dla aplikacji.
Identyfikator aplikacji	changes.physical_count.source.application_id	string	Identyfikator kwadratowy przypisany do aplikacji.
Name	changes.physical_count.source.name	string	Nazwa elementu.
Identyfikator pracownika	changes.physical_count.employee_id	string	Identyfikator wygenerowany kwadratowo pracownika odpowiedzialnego za liczbę fizyczną.
Wystąpił o	changes.physical_count.occurred_at	string	Wygenerowany przez klienta znacznik czasu w formacie RFC 3339, który wskazuje, kiedy liczba fizyczna została zbadana. W przypadku aktualizacji liczby fizycznej sygnatura czasowa occurred_at nie może być starsza niż 24 godziny ani w przyszłości w stosunku do czasu żądania.
Utworzono pod adresem	changes.physical_count.created_at	string	Sygnatura czasowa wygenerowana przez klienta RFC 3339, która wskazuje, kiedy została utworzona liczba fizyczna.

Uzyskiwanie płatności

Identyfikator operacji:: PaymentGet

Pobiera szczegóły dla określonej płatności.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator płatności	payment_id	True	string	Identyfikator płatności.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	payment.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Utworzono pod adresem	payment.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	payment.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Kwota	payment.amount_money.amount	integer	Kwota.
Waluta	payment.amount_money.currency	string	Waluta.
Status	payment.status	string	Bieżący stan weryfikacji tego obiektu.
Czas trwania opóźnienia	payment.delay_duration	string	Czas trwania po utworzeniu płatności, gdy Square automatycznie stosuje delay_action do płatności. Ta automatyczna delay_action dotyczy tylko płatności, które nie docierają do stanu terminalu (UKOŃCZONE, ANULOWANE lub NIEUDANE) przed upływem delay_duration czasu. To pole jest określane jako czas trwania w formacie RFC 3339.
Typ źródła	payment.source_type	string	Typ źródła dla tej płatności. Bieżące wartości to CARD, BANK_ACCOUNT, PORTFEL, CASH lub EXTERNAL.
Status	payment.card_details.status	string	Bieżący stan.
Znak karty	payment.card_details.card.card_brand	string	Marka karty.
Ostatnie 4	payment.card_details.card.last_4	string	Ostatnie 4 cyfry numeru karty.
Miesiąc eksploduj	payment.card_details.card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok eksplorowy	payment.card_details.card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Odcisk palca	payment.card_details.card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
Typ karty	payment.card_details.card.card_type	string	Typ karty.
Typ przedpłacony	payment.card_details.card.prepaid_type	string	Wskazuje, czy karta jest przedpłacona, czy nie.
BIN	payment.card_details.card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN).
Entry, metoda	payment.card_details.entry_method	string	Metoda używana do wprowadzania szczegółów karty dla płatności. Metoda może być KEYED, SWIPED, EMV, ON_FILE lub CONTACTLESS.
Stan CVV	payment.card_details.cvv_status	string	Kod stanu zwrócony z sprawdzania wartości weryfikacji karty (CVV). Kod może być CVV_ACCEPTED, CVV_REJECTED lub CVV_NOT_CHECKED.
Stan usługi AVS	payment.card_details.avs_status	string	Kod stanu zwrócony z sprawdzania systemu weryfikacji adresów (AVS). Kod może być AVS_ACCEPTED, AVS_REJECTED lub AVS_NOT_CHECKED.
Kod wyniku uwierzytelniania	payment.card_details.auth_result_code	string	Kod stanu zwrócony przez wystawcę karty, który opisuje stan autoryzacji płatności.
Opis instrukcji	payment.card_details.statement_description	string	Opis instrukcji wysyłany do sieci kart.
Autoryzowane pod adresem	payment.card_details.card_payment_timeline.authorized_at	string	Sygnatura czasowa autoryzacji płatności w formacie RFC 3339.
Przechwycone o	payment.card_details.card_payment_timeline.captured_at	string	Sygnatura czasowa przechwycenia płatności w formacie RFC 3339.
Identyfikator lokalizacji	payment.location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	payment.order_id	string	Identyfikator zamówienia.
Opłata za przetwarzanie	payment.processing_fee	array of object
Obowiązującą	payment.processing_fee.effective_at	string	Znacznik czasu stosowania opłaty w formacie RFC 3339.
Typ	payment.processing_fee.type	string	Wskazuje typ.
Kwota	payment.processing_fee.amount_money.amount	integer	Kwota.
Waluta	payment.processing_fee.amount_money.currency	string	Waluta.
Uwaga / Notatka	payment.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Kwota	payment.total_money.amount	integer	Kwota.
Waluta	payment.total_money.currency	string	Waluta.
Kwota	payment.approved_money.amount	integer	Kwota.
Waluta	payment.approved_money.currency	string	Waluta.
Identyfikator pracownika	payment.employee_id	string	Identyfikator wygenerowany kwadratowo pracownika.
Numer paragonu	payment.receipt_number	string	Numer paragonu płatności. W przypadku anulowania płatności brakuje pola.
Adres URL potwierdzenia	payment.receipt_url	string	Adres URL potwierdzenia płatności. Pole jest wypełniane tylko w przypadku płatności UKOŃCZONE.
Akcja opóźniająca	payment.delay_action	string	Akcja, która ma zostać zastosowana do płatności po upływie delay_duration.
Opóźnione do	payment.delayed_until	string	Sygnatura czasowa tylko do odczytu w przypadku automatycznego zastosowania delay_action w formacie RFC 3339.
Identyfikator członka zespołu	payment.team_member_id	string	Identyfikator członka zespołu.
Produkt kwadratowy	payment.application_details.square_product	string	Produkt kwadratowy, taki jak Square Point of Sale (POS), faktury kwadratowe lub kwadratowy terminal wirtualny.
Identyfikator aplikacji	payment.application_details.application_id	string	Identyfikator kwadratowy tylko do odczytu przypisany do aplikacji.
Token wersji	payment.version_token	string	Ten nieprzezroczysty token identyfikuje określoną wersję obiektu.

Uzyskiwanie zwrotu płatności

Identyfikator operacji:: RefundGet

Pobiera określony zwrot pieniędzy przy użyciu refund_id.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator zwrotu pieniędzy	refund_id	True	string	Identyfikator zwrotu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	refund.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Status	refund.status	string	Bieżący stan weryfikacji tego obiektu.
Kwota	refund.amount_money.amount	integer	Kwota.
Waluta	refund.amount_money.currency	string	Waluta.
Identyfikator płatności	refund.payment_id	string	Unikatowy identyfikator płatności.
Identyfikator zamówienia	refund.order_id	string	Identyfikator zamówienia.
Utworzono pod adresem	refund.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	refund.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Opłata za przetwarzanie	refund.processing_fee	array of object
Obowiązującą	refund.processing_fee.effective_at	string	Znacznik czasu stosowania opłaty w formacie RFC 3339.
Typ	refund.processing_fee.type	string	Wskazuje typ.
Kwota	refund.processing_fee.amount_money.amount	integer	Kwota.
Waluta	refund.processing_fee.amount_money.currency	string	Waluta.
Identyfikator lokalizacji	refund.location_id	string	Identyfikator lokalizacji.
Przyczyna	refund.reason	string	Przyczyna tego obiektu.

Uzyskiwanie zwrotu terminalu

Identyfikator operacji:: TerminalGetRefund

Pobiera obiekt zwrotu kosztów terminalu międzyakowego według identyfikatora.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator zwrotu terminalu	terminal_refund_id	True	string	Identyfikator zwrotu terminalu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	refund.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator zwrotu pieniędzy	refund.refund_id	string	Unikatowy identyfikator tego zwrotu wygenerowany przez square.
Identyfikator płatności	refund.payment_id	string	Unikatowy identyfikator płatności.
Kwota	refund.amount_money.amount	integer	Kwota.
Waluta	refund.amount_money.currency	string	Waluta.
Przyczyna	refund.reason	string	Przyczyna tego obiektu.
Identyfikator urządzenia	refund.device_id	string	Unikatowy identyfikator urządzenia przeznaczonego dla tego terminaluRefund.
Czas trwania terminu trwania	refund.deadline_duration	string	Czas trwania RFC 3339, po którym kasa zostanie automatycznie anulowana. Sprawdzanie terminalu, które jest oczekujące, jest automatycznie ANULOWANE i ma przyczynę anulowania TIMED_OUT. Ustawienie domyślne: 5 minut od utworzenia
Status	refund.status	string	Bieżący stan weryfikacji tego obiektu.
Utworzono pod adresem	refund.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	refund.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
identyfikator aplikacji	refund.app_id	string	Identyfikator aplikacji, która utworzyła wyewidencjonowania.
Znak karty	refund.card.card_brand	string	Marka karty.
last_4	refund.card.last_4	string	Ostatnie 4 cyfry numeru karty.
Miesiąc eksploduj	refund.card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok eksplorowy	refund.card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Odcisk palca	refund.card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
Typ karty	refund.card.card_type	string	Typ karty.
BIN	refund.card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN).
Identyfikator zamówienia	refund.order_id	string	Identyfikator zamówienia.
Identyfikator lokalizacji	refund.location_id	string	Identyfikator lokalizacji.

Wykaz list

Identyfikator operacji:: CatalogList

Zwraca listę obiektów CatalogObject, która zawiera wszystkie obiekty zestawu żądanych typów (na przykład wszystkie obiekty CatalogItem i CatalogTax) w wykazie. ListaCatalog nie zwraca usuniętych elementów wykazu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Cursor	cursor		integer	Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego.
Types	types		string	Opcjonalna lista typów obiektów rozdzielonych przecinkami bez uwzględniania wielkości liter. Prawidłowe wartości są zdefiniowane w wyliczenie CatalogObjectType, w tym ITEM, ITEM_VARIATION, CATEGORY, DISCOUNT, TAX, MODIFIER, MODIFIER_LIST lub IMAGE. Jeśli jest to nieokreślone, operacja zwraca obiekty wszystkich typów w wersji interfejsu API Square użytego do wykonania żądania.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Objects	objects	array of object
Typ	objects.type	string	Typ tego obiektu.
identyfikator	objects.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Zaktualizowano o	objects.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
wersja	objects.version	integer	Bieżąca wersja obiektu.
Jest usuwany	objects.is_deleted	boolean	Jeśli wartość true, obiekt został usunięty z bazy danych. W wstawianiu nowych obiektów musi być fałsz. Po usunięciu pole updated_at będzie równe czasowi usunięcia.
Obecne we wszystkich lokalizacjach	objects.present_at_all_locations	boolean	Jeśli to prawda, ten obiekt jest obecny we wszystkich lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem sytuacji, w których określono w polu absent_at_location_ids. Jeśli wartość false, ten obiekt nie jest obecny w żadnych lokalizacjach (w tym w przyszłych lokalizacjach), z wyjątkiem przypadków określonych w polu present_at_location_ids. Jeśli nie zostanie określony, wartość domyślna to true.
Name	objects.category_data.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Name	objects.tax_data.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Faza obliczania	objects.tax_data.calculation_phase	string	Czy podatek jest obliczany na podstawie sumy częściowej lub sumy płatności.
Typ dołączania	objects.tax_data.inclusion_type	string	Niezależnie od tego, czy podatek jest addytywne, czy inkluzywne.
Procent	objects.tax_data.percentage	string	Wartość procentowa w postaci dziesiętnej, używając znaku "". jako separatora dziesiętnego i bez znaku "%". Wartość 7,5 odpowiada 7,5%.
Włączona	objects.tax_data.enabled	boolean	Wskazuje, czy można użyć obiektu.

Wyszukaj subskrypcje

Identyfikator operacji:: SubscriptionSearch

Wyszukuje subskrypcje. Wyniki są uporządkowane chronologicznie według daty utworzenia subskrypcji. Jeśli żądanie określa więcej niż jeden identyfikator lokalizacji, punkt końcowy porządkuje wynik według identyfikatora lokalizacji, a następnie według daty utworzenia w każdej lokalizacji. Jeśli w zapytaniu nie podano żadnych lokalizacji, przeszukiwane są wszystkie lokalizacje.

Parametry

Nazwa	Klucz	Typ
Identyfikatory lokalizacji	location_ids	array of string
Identyfikatory klientów	customer_ids	array of string
Nazwy źródłowe	source_names	array of string

Zwraca

Nazwa	Ścieżka	Typ	Opis
Subskrypcje	subscriptions	array of object
identyfikator	subscriptions.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator lokalizacji	subscriptions.location_id	string	Identyfikator lokalizacji.
Identyfikator planu	subscriptions.plan_id	string	Identyfikator skojarzonego planu subskrypcji
Identyfikator klienta	subscriptions.customer_id	string	Identyfikator przypisany do kwadratu klienta skojarzonego z kontem.
Data rozpoczęcia	subscriptions.start_date	string	Data rozpoczęcia subskrypcji w formacie RRRR-MM-DD.
Data anulowania	subscriptions.canceled_date	string	Data anulowania subskrypcji w formacie RRRR-MM-DD.
Opłata za datę	subscriptions.charged_through_date	string	Data, do której klient jest fakturowany za subskrypcję w formacie RRRR-MM-DD.
Status	subscriptions.status	string	Bieżący stan weryfikacji tego obiektu.
Utworzono pod adresem	subscriptions.created_at	string	Czas zdarzenia w formacie ISO 8601.
Identyfikator karty	subscriptions.card_id	string	Identyfikator karty klienta, która jest obciążana opłatą za subskrypcję.
Płatna do daty	subscriptions.paid_until_date	string	Data płatności do.
Timezone	subscriptions.timezone	string	Strefa czasowa używana do interpretowania dat kalendarza na fakturze, takich jak due_date. Po utworzeniu faktury to pole jest ustawione na strefę czasową określoną dla lokalizacji sprzedawcy. Nie można zmienić wartości.
Name	subscriptions.source.name	string	Nazwa elementu. Jest to atrybut z możliwością wyszukiwania do użycia w odpowiednich filtrach zapytań, jego wartość nie może być pusta, a długość to punkty kodu Unicode.
Procent podatku	subscriptions.tax_percentage	string	Kwota podatku stosowana podczas rozliczeń subskrypcji.
Kwota	subscriptions.price_override_money.amount	integer	Kwota.
Waluta	subscriptions.price_override_money.currency	string	Waluta.
wersja	subscriptions.version	integer	Bieżąca wersja obiektu.
Identyfikatory faktur	subscriptions.invoice_ids	array of string

Wyszukiwanie faktur

Identyfikator operacji:: InvoiceSearch

Wyszukuje faktury z lokalizacji określonej w filtrze.

Parametry

Nazwa	Klucz	Typ	Opis
Identyfikatory lokalizacji	location_ids	array of string
Identyfikatory klientów	customer_ids	array of string
(No changes needed)	field	string	Użyj co najmniej jednego atrybutu klienta jako klucza sortowania do sortowania przeszukanych profilów klientów.
Zamówienie	order	string	Wskazuje kolejność sortowania wyników na podstawie wartości pola sortowania. Ciągi używają standardowego porównania alfabetycznego w celu określenia kolejności.
Ograniczenie	limit	integer	Maksymalna liczba faktur do zwrócenia (200 to maksymalny limit). Jeśli nie zostanie podana, serwer używa domyślnego limitu 100 faktur.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Invoices	invoices	array of object
identyfikator	invoices.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
wersja	invoices.version	integer	Bieżąca wersja obiektu.
Identyfikator lokalizacji	invoices.location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	invoices.order_id	string	Identyfikator zamówienia.
Żądania płatności	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	Identyfikator wygenerowany kwadratowo żądania płatności na fakturze.
Typ żądania	invoices.payment_requests.request_type	string	Określa typ żądania płatności. Ten typ definiuje sposób określania kwoty żądania płatności.
Data upływu	invoices.payment_requests.due_date	string	Data ukończenia (w strefie czasowej faktury) dla żądania płatności w formacie RRRR-MM-DD.
Włączone przechylanie	invoices.payment_requests.tipping_enabled	boolean	Jeśli ustawiono wartość true, strona faktury hostowanej na placu (pole public_url faktury) udostępnia miejsce, w ramach którego klient zapłaci poradę.
Przypomnienia	invoices.payment_requests.reminders	array of object	Przypomnienia
UID	invoices.payment_requests.reminders.uid	string	Identyfikator przypisany do kwadratu, który jednoznacznie identyfikuje przypomnienie w poleceniu InvoicePaymentRequest.
Względne dni zaplanowane	invoices.payment_requests.reminders.relative_scheduled_days	integer	Liczba dni przed (liczba ujemna) lub po (liczbie dodatniej) żądanie płatności due_date po wysłaniu przypomnienia.
Message	invoices.payment_requests.reminders.message	string	Wiadomość z przypomnieniem.
Status	invoices.payment_requests.reminders.status	string	Stan przypomnienia.
Kwota	invoices.payment_requests.computed_amount_money.amount	integer	Kwota.
Waluta	invoices.payment_requests.computed_amount_money.currency	string	Waluta.
Kwota	invoices.payment_requests.total_completed_amount_money.amount	integer	Kwota.
Waluta	invoices.payment_requests.total_completed_amount_money.currency	string	Waluta.
Automatyczne źródło płatności	invoices.payment_requests.automatic_payment_source	string	Forma płatności za automatyczną płatność.
Żądany procent	invoices.payment_requests.percentage_requested	string	Określa kwotę żądania płatności w procentach.
Identyfikator karty	invoices.payment_requests.card_id	string	Identyfikator karty kredytowej lub debetowej w pliku do naliczania opłat za żądanie płatności.
Numer faktury	invoices.invoice_number	string	Przyjazny dla użytkownika numer faktury.
Title	invoices.title	string	Tytuł faktury.
Description	invoices.description	string	Opis.
Zaplanowane o godzinie	invoices.scheduled_at	string	Sygnatura czasowa zaplanowana do przetworzenia faktury w formacie RFC 3339. Po opublikowaniu faktury square przetwarza fakturę w określonej dacie zgodnie z ustawieniami metody dostawy i żądania płatności.
Status	invoices.status	string	Bieżący stan weryfikacji tego obiektu.
Timezone	invoices.timezone	string	Strefa czasowa używana do interpretowania dat kalendarza na fakturze, takich jak due_date. Po utworzeniu faktury to pole jest ustawione na strefę czasową określoną dla lokalizacji sprzedawcy. Nie można zmienić wartości.
Utworzono pod adresem	invoices.created_at	string	Czas zdarzenia w formacie ISO 8601.
Zaktualizowano o	invoices.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
Identyfikator klienta	invoices.primary_recipient.customer_id	string	Identyfikator klienta do skojarzenia z kartą.
Imię	invoices.primary_recipient.given_name	string	Podane przez adresata (czyli imię).
Nazwisko	invoices.primary_recipient.family_name	string	Rodzina adresata (czyli nazwisko).
Adres e-mail	invoices.primary_recipient.email_address	string	Adres e-mail adresata.
Numer telefonu	invoices.primary_recipient.phone_number	string	Numer telefonu odbiorcy.
Card	invoices.accepted_payment_methods.card	boolean	Wskazuje, czy płatności kartą kredytową lub debetową są akceptowane.
Kwadratowa karta upominkowa	invoices.accepted_payment_methods.square_gift_card	boolean	Wskazuje, czy płatności kartami upominkowymi square są akceptowane.
Konto	invoices.accepted_payment_methods.bank_account	boolean	Wskazuje, czy płatności przelewów bankowych są akceptowane.
Pola niestandardowe	invoices.custom_fields	array of object
Etykieta	invoices.custom_fields.label	string	Etykieta lub tytuł pola niestandardowego.
Wartość	invoices.custom_fields.value	string	Tekst pola niestandardowego.
Umieszczenie	invoices.custom_fields.placement	string	Lokalizacja pola niestandardowego na fakturze
Metoda dostarczania	invoices.delivery_method	string	Metoda dostarczania używana przez Square do wysyłania faktury, przypomnień i paragonów do klienta.
Data sprzedaży lub usługi	invoices.sale_or_service_date	string	Data sprzedaży lub data renderowania usługi w formacie RRRR-MM-DD. To pole może służyć do określenia daty wcześniejszej lub przyszłej wyświetlanej na fakturze.
Publiczny adres URL	invoices.public_url	string	Adres URL strony faktury hostowanej na placu. Po opublikowaniu faktury przy użyciu punktu końcowego PublishInvoice square hostuje stronę faktury i zwraca adres URL strony w odpowiedzi.
Kwota	invoices.next_payment_amount_money.amount	integer	Kwota.
Waluta	invoices.next_payment_amount_money.currency	string	Waluta.
Cursor	cursor	string	Uwzględnij kursor stronicowania w kolejnych wywołaniach tego punktu końcowego, aby pobrać następny zestaw wyników skojarzonych z oryginalnym zapytaniem.

Wyszukiwanie klientów

Identyfikator operacji:: CustomerSearch

Wyszukuje profile klientów skojarzone z kontem Square przy użyciu obsługiwanego filtru zapytania. Wywołanie metody SearchCustomers bez żadnego jawnego filtru zapytania zwraca wszystkie profile klientów uporządkowane alfabetycznie na podstawie given_name i family_name.

Parametry

Nazwa	Klucz	Typ	Opis
Rozmyty	fuzzy	string	Użyj filtru rozmytego, aby wybrać klientów, których atrybuty pasują do określonego zapytania w sposób rozmyty. Gdy jest używana opcja rozmytego, zapytania wyszukiwania są tokenizowane, a następnie każdy token zapytania musi być dopasowany gdzieś w wyszukiwanym atrybucie. W przypadku zapytań dotyczących pojedynczego tokenu jest to samo zachowanie co operacja częściowego dopasowania.
Wartości	values	array of string
Reguła	rule	string	Wskazuje, czy profil klienta pasujący do kryteriów filtrowania powinien zostać uwzględniony w wyniku, czy wykluczony z wyniku.
Rozpocznij od	start_at	string	Wartość daty/godziny w formacie RFC 3339 wskazująca, kiedy rozpoczyna się zakres czasu.
Koniec od	end_at	string	Wartość daty/godziny w formacie RFC 3339 wskazująca, kiedy zakres czasu się kończy.
Wszystko	all	array of string
(No changes needed)	field	string	Użyj co najmniej jednego atrybutu klienta jako klucza sortowania do sortowania przeszukanych profilów klientów.
Zamówienie	order	string	Wskazuje kolejność sortowania wyników na podstawie wartości pola sortowania. Ciągi używają standardowego porównania alfabetycznego w celu określenia kolejności.
Ograniczenie	limit	integer	Limit liczby wyników, które mają być zwracane na jednej stronie. Limit jest poradą — implementacja może zwrócić więcej lub mniej wyników. Jeśli podany limit jest ujemny, zero lub jest wyższy niż maksymalny limit wynoszący 1000, zostanie zignorowany.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Klientela	customers	array of object
identyfikator	customers.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Utworzono pod adresem	customers.created_at	string	Czas zdarzenia w formacie ISO 8601.
Zaktualizowano o	customers.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
Imię	customers.given_name	string	Podana (tj. imię) nazwa skojarzona z profilem klienta.
Nazwisko	customers.family_name	string	Rodzina (tj. nazwisko) skojarzona z profilem klienta.
Adres e-mail	customers.email_address	string	Adres e-mail skojarzony z profilem klienta.
Linia adresowa 1	customers.address.address_line_1	string	Pierwszy wiersz adresu.
Wiersz adresu 2	customers.address.address_line_2	string	Drugi wiersz adresu, jeśli istnieje.
Miejscowość	customers.address.locality	string	Miasto lub miasto adresu.
Poziom okręgu administracyjnego 1	customers.address.administrative_district_level_1	string	Jednostka cywilna w kraju adresu. W USA jest to stan.
Kod pocztowy	customers.address.postal_code	string	Kod pocztowy adresu.
Country	customers.address.country	string	Kraj adresu w formacie ISO 3166-1-alfa-2.
Numer telefonu	customers.phone_number	string	11-cyfrowy numer telefonu skojarzony z profilem klienta.
Identyfikator odwołania	customers.reference_id	string	Opcjonalny drugi identyfikator używany do skojarzenia profilu klienta z jednostką w innym systemie.
Wiadomość e-mail anulowana	customers.preferences.email_unsubscribed	boolean	Wskazuje, czy klient anulował subskrypcję wiadomości e-mail kampanii marketingowej. Wartość true oznacza, że klient zdecydował się zrezygnować z marketingu e-mail od bieżącego sprzedawcy Square lub od wszystkich sprzedawców Kwadratowych. Ta wartość jest tylko do odczytu z interfejsu API Customers.
Źródło tworzenia	customers.creation_source	string	Źródło tworzenia reprezentuje metodę używaną do tworzenia profilu klienta.
Identyfikatory grup	customers.group_ids	array of string
Identyfikatory segmentów	customers.segment_ids	array of string
wersja	customers.version	integer	Bieżąca wersja obiektu.
Uwaga / Notatka	customers.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Cursor	cursor	string	Uwzględnij kursor stronicowania w kolejnych wywołaniach tego punktu końcowego, aby pobrać następny zestaw wyników skojarzonych z oryginalnym zapytaniem.

Wyszukiwanie wyewidencjonowania terminalu

Identyfikator operacji:: TerminalSearchCheckouts

Pobiera odfiltrowaną listę żądań wyewidencjonowania terminalu utworzonych przez konto wysyłające żądanie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Ograniczenie	limit		integer	Limit liczby wyników, które mają być zwracane na jednej stronie. Limit jest poradą — implementacja może zwrócić więcej lub mniej wyników. Jeśli podany limit jest ujemny, zero lub jest wyższy niż maksymalny limit wynoszący 1000, zostanie zignorowany.
Status	status		string	Bieżący stan.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Wyewidencjonowania	checkouts	array of object
identyfikator	checkouts.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Kwota	checkouts.amount_money.amount	integer	Kwota.
Waluta	checkouts.amount_money.currency	string	Waluta.
Identyfikator odwołania	checkouts.reference_id	string	Opcjonalny drugi identyfikator używany do skojarzenia profilu klienta z jednostką w innym systemie.
Uwaga / Notatka	checkouts.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Identyfikator urządzenia	checkouts.device_options.device_id	string	Unikatowy identyfikator urządzenia przeznaczonego dla tego terminaluCheckout.
Zezwalaj na poradę	checkouts.device_options.tip_settings.allow_tipping	boolean	Wskazuje, czy dla tego wyewidencjonowania włączono przechylanie. Wartość domyślna to fałsz.
Ekran pominięcia potwierdzenia	checkouts.device_options.skip_receipt_screen	boolean	Nakazuje urządzeniu pominięcie ekranu potwierdzenia. Wartość domyślna to fałsz.
Status	checkouts.status	string	Bieżący stan weryfikacji tego obiektu.
Identyfikatory płatności	checkouts.payment_ids	array of string
Utworzono pod adresem	checkouts.created_at	string	Czas zdarzenia w formacie ISO 8601.
Zaktualizowano o	checkouts.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
identyfikator aplikacji	checkouts.app_id	string	Identyfikator aplikacji, która utworzyła wyewidencjonowania.
Czas trwania terminu trwania	checkouts.deadline_duration	string	Czas trwania RFC 3339, po którym kasa zostanie automatycznie anulowana. Sprawdzanie terminalu, które jest oczekujące, jest automatycznie ANULOWANE i ma przyczynę anulowania TIMED_OUT. Ustawienie domyślne: 5 minut od utworzenia
Cursor	cursor	string	Uwzględnij kursor stronicowania w kolejnych wywołaniach tego punktu końcowego, aby pobrać następny zestaw wyników skojarzonych z oryginalnym zapytaniem.

Wyszukiwanie zamówień

Identyfikator operacji:: OrderSearch

Przeszukaj wszystkie zamówienia dla co najmniej jednej lokalizacji. Zamówienia obejmują wszystkie transakcje sprzedaży, zwroty i wymiany niezależnie od tego, jak lub kiedy wchodziły w ekosystem square (np. punkt sprzedaży, faktury i interfejsy API łączenia).

Parametry

Nazwa	Klucz	Typ	Opis
Zwracane wpisy	return_entries	boolean	Wartość logiczna, która kontroluje format wyników wyszukiwania. Jeśli wartość true, funkcja SearchOrders zwraca obiekty OrderEntry. Jeśli wartość false, funkcja SearchOrders zwraca obiekty zamówienia kompletnego.
Ograniczenie	limit	integer	Limit liczby wyników, które mają być zwracane na jednej stronie. Limit jest poradą — implementacja może zwrócić więcej lub mniej wyników. Jeśli podany limit jest ujemny, zero lub jest wyższy niż maksymalny limit wynoszący 1000, zostanie zignorowany.
Identyfikatory lokalizacji	location_ids	array of string
Rozpocznij od	start_at	string	Wartość daty/godziny w formacie RFC 3339 wskazująca, kiedy rozpoczyna się zakres czasu.
Koniec od	end_at	string	Wartość daty/godziny w formacie RFC 3339 wskazująca, kiedy zakres czasu się kończy.
States	states	array of string
Sortuj pole	sort_field	string	Pole do sortowania według.
Kolejność sortowania	sort_order	string	Kolejność chronologiczna, w której są zwracane wyniki.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Pozycje zamówienia	order_entries	array of object
Identyfikator zamówienia	order_entries.order_id	string	Identyfikator zamówienia.
Identyfikator lokalizacji	order_entries.location_id	string	Identyfikator lokalizacji.
wersja	order_entries.version	integer	Bieżąca wersja obiektu.
Cursor	cursor	string	Uwzględnij kursor stronicowania w kolejnych wywołaniach tego punktu końcowego, aby pobrać następny zestaw wyników skojarzonych z oryginalnym zapytaniem.

Wyszukiwanie zwrotów terminalu

Identyfikator operacji:: TerminalSearchRefunds

Pobiera przefiltrowaną listę żądań zwrotu w terminalu międzyakcyjnym utworzonych przez sprzedawcę wysyłającego żądanie.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Ograniczenie	limit		integer	Limit liczby wyników, które mają być zwracane na jednej stronie. Limit jest poradą — implementacja może zwrócić więcej lub mniej wyników. Jeśli podany limit jest ujemny, zero lub jest wyższy niż maksymalny limit wynoszący 1000, zostanie zignorowany.
Status	status		string	Bieżący stan.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Refundacji	refunds	array of object
identyfikator	refunds.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator zwrotu pieniędzy	refunds.refund_id	string	Unikatowy identyfikator tego zwrotu wygenerowany przez square.
Identyfikator płatności	refunds.payment_id	string	Identyfikator płatności.
Kwota	refunds.amount_money.amount	integer	Kwota.
Waluta	refunds.amount_money.currency	string	Waluta.
Przyczyna	refunds.reason	string	Powód sporu, dlaczego posiadacz karty zainicjował spór ze swoim bankiem.
Identyfikator urządzenia	refunds.device_id	string	Unikatowy identyfikator urządzenia, które używało tego kodu. Wypełniane, gdy urządzenie jest sparowane.
Czas trwania terminu trwania	refunds.deadline_duration	string	Czas trwania RFC 3339, po którym kasa zostanie automatycznie anulowana. Sprawdzanie terminalu, które jest oczekujące, jest automatycznie ANULOWANE i ma przyczynę anulowania TIMED_OUT. Ustawienie domyślne: 5 minut od utworzenia
Status	refunds.status	string	Bieżący stan weryfikacji tego obiektu.
Utworzono pod adresem	refunds.created_at	string	Czas zdarzenia w formacie ISO 8601.
Zaktualizowano o	refunds.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
identyfikator aplikacji	refunds.app_id	string	Identyfikator aplikacji, która utworzyła wyewidencjonowania.
Znak karty	refunds.card.card_brand	string	Marka karty.
Ostatnie 4	refunds.card.last_4	string	Ostatnie 4 cyfry numeru karty.
Miesiąc wygaśnięcia	refunds.card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok wygaśnięcia	refunds.card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Odcisk palca	refunds.card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
Typ karty	refunds.card.card_type	string	Typ karty.
BIN	refunds.card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN).
Identyfikator zamówienia	refunds.order_id	string	Identyfikator zamówienia.
Identyfikator lokalizacji	refunds.location_id	string	Identyfikator lokalizacji.

Wyłączanie karty

Identyfikator operacji:: CardDisable

Wyłącza kartę, uniemożliwiając dalsze aktualizacje lub opłaty. Wyłączenie już wyłączonej karty jest dozwolone, ale nie ma efektu.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator karty	card_id	True	string	Identyfikator karty.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	card.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Linia adresowa 1	card.billing_address.address_line_1	string	Pierwszy wiersz adresu. Pola rozpoczynające się od address_line zawierają najbardziej szczegółowe informacje dotyczące adresu, takie jak numer ulicy, nazwa ulicy i nazwa budynku.
Wiersz adresu 2	card.billing_address.address_line_2	string	Drugi wiersz adresu, jeśli istnieje.
Miejscowość	card.billing_address.locality	string	Miasto lub miasto adresu.
Poziom okręgu administracyjnego 1	card.billing_address.administrative_district_level_1	string	Jednostka cywilna w kraju adresu. W USA jest to stan.
Kod pocztowy	card.billing_address.postal_code	string	Kod pocztowy adresu.
Country	card.billing_address.country	string	Kraj adresu w formacie ISO 3166-1-alfa-2.
Odcisk palca	card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
BIN	card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN).
Znak karty	card.card_brand	string	Marka karty.
Typ karty	card.card_type	string	Typ karty.
Nazwa symbolu karty	card.cardholder_name	string	Nazwa symbolu karty.
Identyfikator klienta	card.customer_id	string	Identyfikator tego obiektu reprezentującego klienta.
Włączona	card.enabled	boolean	Czy włączono.
Miesiąc eksploduj	card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok eksplorowy	card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Ostatnie 4	card.last_4	string	Ostatnie 4 cyfry numeru karty.
Typ przedpłacony	card.prepaid_type	string	Wskazuje, czy karta jest przedpłacona, czy nie.
Identyfikator odwołania	card.reference_id	string	Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika.
wersja	card.version	integer	Bieżąca wersja tego obiektu.

Wyświetlanie listy dowodów sporu

Identyfikator operacji:: DisputeListEvidence

Zwraca listę dowodów skojarzonych z spórem.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator sporu	dispute_id	True	string	Identyfikator sporu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Evidence	evidence	array of object
identyfikator	evidence.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator sporu	evidence.dispute_id	string	Identyfikator sporu jest skojarzony z dowodami.
Tekst dowodu	evidence.evidence_text	string	Tekst pierwotny.
Typ dowodu	evidence.evidence_type	string	Typ dowodów.
Przekazano o	evidence.uploaded_at	string	Czas ukończenia następnej akcji w formacie RFC 3339.
Identyfikator dowodu	evidence.evidence_id	string	Identyfikator wygenerowany na kwadrat dowodu.
Filename	evidence.evidence_file.filename	string	Nazwa pliku zawierająca rozszerzenie pliku
Typ pliku	evidence.evidence_file.filetype	string	Pliki dowodów sporu muszą być plikami aplikacji/pdf, image/heic, image/heif, image/jpeg, image/png lub image/tiff.
Cursor	cursor	string	Uwzględnij kursor stronicowania w kolejnych wywołaniach tego punktu końcowego, aby pobrać następny zestaw wyników skojarzonych z oryginalnym zapytaniem.

Wyświetlanie listy faktur

Identyfikator operacji:: InvoiceList

Zwraca listę faktur dla danej lokalizacji.

Parametry

Nazwa	Klucz	Typ	Opis
Identyfikator lokalizacji	location_id	string	Możesz określić ten opcjonalny filtr, aby pobrać tylko rekordy należące do określonej lokalizacji.
Cursor	cursor	string	Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego.
Ograniczenie	limit	integer	Górny limit liczby do zwrócenia w odpowiedzi.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Invoices	invoices	array of object
identyfikator	invoices.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
wersja	invoices.version	integer	Bieżąca wersja obiektu.
Identyfikator lokalizacji	invoices.location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	invoices.order_id	string	Identyfikator zamówienia.
Żądania płatności	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	Identyfikator wygenerowany kwadratowo żądania płatności na fakturze.
Typ żądania	invoices.payment_requests.request_type	string	Określa typ żądania płatności. Ten typ definiuje sposób określania kwoty żądania płatności.
Data upływu	invoices.payment_requests.due_date	string	Data ukończenia (w strefie czasowej faktury) dla żądania płatności w formacie RRRR-MM-DD.
Włączone przechylanie	invoices.payment_requests.tipping_enabled	boolean	Jeśli ustawiono wartość true, strona faktury hostowanej na placu (pole public_url faktury) udostępnia miejsce, w ramach którego klient zapłaci poradę.
Przypomnienia	invoices.payment_requests.reminders	array of object	Przypomnienia
UID	invoices.payment_requests.reminders.uid	string	Identyfikator przypisany do kwadratu, który jednoznacznie identyfikuje przypomnienie w poleceniu InvoicePaymentRequest.
Względne dni zaplanowane	invoices.payment_requests.reminders.relative_scheduled_days	integer	Liczba dni przed (liczba ujemna) lub po (liczbie dodatniej) żądanie płatności due_date po wysłaniu przypomnienia.
Message	invoices.payment_requests.reminders.message	string	Wiadomość z przypomnieniem.
Status	invoices.payment_requests.reminders.status	string	Stan przypomnienia.
Kwota	invoices.payment_requests.computed_amount_money.amount	integer	Kwota.
Waluta	invoices.payment_requests.computed_amount_money.currency	string	Waluta.
Kwota	invoices.payment_requests.total_completed_amount_money.amount	integer	Kwota.
Waluta	invoices.payment_requests.total_completed_amount_money.currency	string	Waluta.
Automatyczne źródło płatności	invoices.payment_requests.automatic_payment_source	string	Forma płatności za automatyczną płatność.
Żądany procent	invoices.payment_requests.percentage_requested	string	Określa kwotę żądania płatności w procentach.
Identyfikator karty	invoices.payment_requests.card_id	string	Identyfikator karty kredytowej lub debetowej w pliku do naliczania opłat za żądanie płatności.
Numer faktury	invoices.invoice_number	string	Przyjazny dla użytkownika numer faktury.
Title	invoices.title	string	Tytuł faktury.
Description	invoices.description	string	Opis.
Zaplanowane o godzinie	invoices.scheduled_at	string	Sygnatura czasowa zaplanowana do przetworzenia faktury w formacie RFC 3339. Po opublikowaniu faktury square przetwarza fakturę w określonej dacie zgodnie z ustawieniami metody dostawy i żądania płatności.
Status	invoices.status	string	Bieżący stan weryfikacji tego obiektu.
Timezone	invoices.timezone	string	Strefa czasowa używana do interpretowania dat kalendarza na fakturze, takich jak due_date. Po utworzeniu faktury to pole jest ustawione na strefę czasową określoną dla lokalizacji sprzedawcy. Nie można zmienić wartości.
Utworzono pod adresem	invoices.created_at	string	Czas zdarzenia w formacie ISO 8601.
Zaktualizowano o	invoices.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
Identyfikator klienta	invoices.primary_recipient.customer_id	string	Identyfikator klienta do skojarzenia z kartą.
Imię	invoices.primary_recipient.given_name	string	Podane przez adresata (czyli imię).
Nazwisko	invoices.primary_recipient.family_name	string	Rodzina adresata (czyli nazwisko).
Adres e-mail	invoices.primary_recipient.email_address	string	Adres e-mail adresata.
Numer telefonu	invoices.primary_recipient.phone_number	string	Numer telefonu odbiorcy.
Card	invoices.accepted_payment_methods.card	boolean	Wskazuje, czy płatności kartą kredytową lub debetową są akceptowane.
Kwadratowa karta upominkowa	invoices.accepted_payment_methods.square_gift_card	boolean	Wskazuje, czy płatności kartami upominkowymi square są akceptowane.
Konto	invoices.accepted_payment_methods.bank_account	boolean	Wskazuje, czy płatności przelewów bankowych są akceptowane.
Pola niestandardowe	invoices.custom_fields	array of object
Etykieta	invoices.custom_fields.label	string	Etykieta lub tytuł pola niestandardowego.
Wartość	invoices.custom_fields.value	string	Tekst pola niestandardowego.
Umieszczenie	invoices.custom_fields.placement	string	Lokalizacja pola niestandardowego na fakturze
Metoda dostarczania	invoices.delivery_method	string	Metoda dostarczania używana przez Square do wysyłania faktury, przypomnień i paragonów do klienta.
Data sprzedaży lub usługi	invoices.sale_or_service_date	string	Data sprzedaży lub data renderowania usługi w formacie RRRR-MM-DD. To pole może służyć do określenia daty wcześniejszej lub przyszłej wyświetlanej na fakturze.
Publiczny adres URL	invoices.public_url	string	Adres URL strony faktury hostowanej na placu. Po opublikowaniu faktury przy użyciu punktu końcowego PublishInvoice square hostuje stronę faktury i zwraca adres URL strony w odpowiedzi.
Kwota	invoices.next_payment_amount_money.amount	integer	Kwota.
Waluta	invoices.next_payment_amount_money.currency	string	Waluta.
Cursor	cursor	string	Uwzględnij kursor stronicowania w kolejnych wywołaniach tego punktu końcowego, aby pobrać następny zestaw wyników skojarzonych z oryginalnym zapytaniem.

Wyświetlanie listy grup klientów

Identyfikator operacji:: CustomerGroupList

Pobiera listę grup klientów firmy.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Groups	groups	array of object
identyfikator	groups.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Name	groups.name	string	Nazwa obiektu.
Utworzono pod adresem	groups.created_at	string	Czas zdarzenia w formacie ISO 8601.
Zaktualizowano o	groups.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339

Wyświetlanie listy klientów

Identyfikator operacji:: CustomerList

Wyświetla listę profilów klientów skojarzonych z kontem square. W normalnych warunkach operacyjnych nowo utworzone lub zaktualizowane profile klientów stają się dostępne dla operacji wyświetlania listy w czasie poniżej 30 sekund. Czasami propagacja nowych lub zaktualizowanych profilów może zająć więcej niż minutę lub dłużej, zwłaszcza podczas zdarzeń sieciowych i awarii.

Parametry

Nazwa	Klucz	Typ	Opis
Cursor	cursor	string	Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego.
Ograniczenie	limit	integer	Górny limit liczby do zwrócenia w odpowiedzi.
Sortuj pole	sort_field	string	Wskazuje sposób sortowania klientów. Wartość domyślna to DEFAULT.
Kolejność sortowania	sort_order	string	Sortuje zwracaną listę według momentu utworzenia karty z określonym zamówieniem.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Klientela	customers	array of object
identyfikator	customers.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Utworzono pod adresem	customers.created_at	string	Czas zdarzenia w formacie ISO 8601.
Zaktualizowano o	customers.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
Imię	customers.given_name	string	Podana (tj. imię) nazwa skojarzona z profilem klienta.
Nazwisko	customers.family_name	string	Rodzina (tj. nazwisko) skojarzona z profilem klienta.
Adres e-mail	customers.email_address	string	Adres e-mail skojarzony z profilem klienta.
Linia adresowa 1	customers.address.address_line_1	string	Pierwszy wiersz adresu.
Wiersz adresu 2	customers.address.address_line_2	string	Drugi wiersz adresu, jeśli istnieje.
Miejscowość	customers.address.locality	string	Miasto lub miasto adresu.
Poziom okręgu administracyjnego 1	customers.address.administrative_district_level_1	string	Jednostka cywilna w kraju adresu. W USA jest to stan.
Kod pocztowy	customers.address.postal_code	string	Kod pocztowy adresu.
Country	customers.address.country	string	Kraj adresu w formacie ISO 3166-1-alfa-2.
Numer telefonu	customers.phone_number	string	11-cyfrowy numer telefonu skojarzony z profilem klienta.
Identyfikator odwołania	customers.reference_id	string	Opcjonalny drugi identyfikator używany do skojarzenia profilu klienta z jednostką w innym systemie.
Uwaga / Notatka	customers.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Wiadomość e-mail anulowana	customers.preferences.email_unsubscribed	boolean	Wskazuje, czy klient anulował subskrypcję wiadomości e-mail kampanii marketingowej. Wartość true oznacza, że klient zdecydował się zrezygnować z marketingu e-mail od bieżącego sprzedawcy Square lub od wszystkich sprzedawców Kwadratowych. Ta wartość jest tylko do odczytu z interfejsu API Customers.
Źródło tworzenia	customers.creation_source	string	Źródło tworzenia reprezentuje metodę używaną do tworzenia profilu klienta.
Identyfikatory grup	customers.group_ids	array of string
Identyfikatory segmentów	customers.segment_ids	array of string
wersja	customers.version	integer	Bieżąca wersja obiektu.

Wyświetlanie listy płatności

Identyfikator operacji:: PaymentList

Pobiera listę płatności pobieranych przez konto wysyłające żądanie. Wyniki są ostatecznie spójne, a pojawienie się nowych płatności lub zmian w płatnościach może potrwać kilka sekund.

Parametry

Nazwa	Klucz	Typ	Opis
Godzina rozpoczęcia	begin_time	string	Inkluzywny czas rozpoczęcia zapytania w opened_at w formacie ISO 8601.
Godzina zakończenia	end_time	string	Wyłączna data zakończenia zapytania w opened_at w formacie ISO 8601.
Kolejność sortowania	sort_order	string	Sortuje zwracaną listę według momentu utworzenia karty z określonym zamówieniem.
Cursor	cursor	string	Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego.
Identyfikator lokalizacji	location_id	string	Możesz określić ten opcjonalny filtr, aby pobrać tylko rekordy należące do określonej lokalizacji.
Total	total	integer	Dokładna kwota w total_money na płatność.
Ostatnie 4	last_4	string	Ostatnie cztery cyfry karty płatniczej.
Znak karty	card_brand	string	Marka karty płatniczej (na przykład VISA).
Ograniczenie	limit	integer	Górny limit liczby do zwrócenia w odpowiedzi.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Payments	payments	array of object
identyfikator	payments.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Utworzono pod adresem	payments.created_at	string	Czas zdarzenia w formacie ISO 8601.
Zaktualizowano o	payments.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
Kwota	payments.amount_money.amount	integer	Kwota.
Waluta	payments.amount_money.currency	string	Waluta.
Status	payments.status	string	Bieżący stan weryfikacji tego obiektu.
Czas trwania opóźnienia	payments.delay_duration	string	Czas trwania po utworzeniu płatności, gdy Square automatycznie stosuje delay_action do płatności.
Typ źródła	payments.source_type	string	Typ źródła dla tej płatności.
Status	payments.card_details.status	string	Bieżący stan płatności kartą. Stan może być AUTORYZOWANY, PRZECHWYCONY, UNIEWAŻNIONY lub NIEPOWODZENIE.
Znak karty	payments.card_details.card.card_brand	string	Marka karty.
last_4	payments.card_details.card.last_4	string	Ostatnie 4 cyfry numeru karty.
Miesiąc eksploduj	payments.card_details.card.exp_month	integer	Miesiąc wygaśnięcia skojarzonej karty jako liczba całkowita z zakresu od 1 do 12.
Rok eksplorowy	payments.card_details.card.exp_year	integer	Czterocyfrowy rok daty wygaśnięcia karty.
Odcisk palca	payments.card_details.card.fingerprint	string	Ma być identyfikatorem przypisanym do kwadratu na podstawie numeru karty, aby zidentyfikować kartę w wielu lokalizacjach w ramach jednej aplikacji.
Typ karty	payments.card_details.card.card_type	string	Typ karty.
Typ przedpłacony	payments.card_details.card.prepaid_type	string	Wskazuje, czy karta jest przedpłacona, czy nie.
BIN	payments.card_details.card.bin	string	Pierwsze sześć cyfr numeru karty, nazywane numerem identyfikacyjnym banku (BIN)
Entry, metoda	payments.card_details.entry_method	string	Metoda używana do wprowadzania szczegółów karty dla płatności. Metoda może być KEYED, SWIPED, EMV, ON_FILE lub CONTACTLESS.
Stan Cvv	payments.card_details.cvv_status	string	Kod stanu zwrócony z sprawdzania wartości weryfikacji karty (CVV). Kod może być CVV_ACCEPTED, CVV_REJECTED lub CVV_NOT_CHECKED.
Stan avs	payments.card_details.avs_status	string	Kod stanu zwrócony z sprawdzania systemu weryfikacji adresów (AVS). Kod może być AVS_ACCEPTED, AVS_REJECTED lub AVS_NOT_CHECKED.
Kod wyniku uwierzytelniania	payments.card_details.auth_result_code	string	Kod stanu zwrócony przez wystawcę karty, który opisuje stan autoryzacji płatności.
Opis instrukcji	payments.card_details.statement_description	string	Opis instrukcji wysyłany do sieci kart.
Autoryzowane pod adresem	payments.card_details.card_payment_timeline.authorized_at	string	Sygnatura czasowa autoryzacji płatności w formacie RFC 3339.
Przechwycone o	payments.card_details.card_payment_timeline.captured_at	string	Sygnatura czasowa przechwycenia płatności w formacie RFC 3339.
Identyfikator lokalizacji	payments.location_id	string	Identyfikator lokalizacji.
Identyfikator zamówienia	payments.order_id	string	Identyfikator zamówienia.
Opłata za przetwarzanie	payments.processing_fee	array of object
Obowiązującą	payments.processing_fee.effective_at	string	Znacznik czasu stosowania opłaty w formacie RFC 3339.
Typ	payments.processing_fee.type	string	Typ tego obiektu.
Kwota	payments.processing_fee.amount_money.amount	integer	Kwota.
Waluta	payments.processing_fee.amount_money.currency	string	Waluta.
Uwaga / Notatka	payments.note	string	Niestandardowa notatka skojarzona z profilem klienta.
Kwota	payments.total_money.amount	integer	Kwota.
Waluta	payments.total_money.currency	string	Waluta.
Kwota	payments.approved_money.amount	integer	Kwota.
Waluta	payments.approved_money.currency	string	Waluta.
Numer paragonu	payments.receipt_number	string	Numer paragonu płatności. W przypadku anulowania płatności brakuje pola.
Adres URL potwierdzenia	payments.receipt_url	string	Adres URL potwierdzenia płatności. Pole jest wypełniane tylko w przypadku płatności UKOŃCZONE.
Akcja opóźniająca	payments.delay_action	string	Akcja, która ma zostać zastosowana do płatności po upływie delay_duration.
Opóźnione do	payments.delayed_until	string	Sygnatura czasowa tylko do odczytu w przypadku automatycznego zastosowania delay_action w formacie RFC 3339.
Identyfikator członka zespołu	payments.team_member_id	string	Identyfikator obiektu TeamMember dla członka zespołu skojarzonego z obiektem .
Produkt kwadratowy	payments.application_details.square_product	string	Produkt kwadratowy, taki jak Square Point of Sale (POS), faktury kwadratowe lub kwadratowy terminal wirtualny.
Identyfikator aplikacji	payments.application_details.application_id	string	Identyfikator kwadratowy przypisany do aplikacji użytej do wykonania płatności. Deweloperzy aplikacji mogą używać tych informacji do identyfikowania płatności przetwarzanych przez ich aplikację. Jeśli na przykład deweloper używa niestandardowej aplikacji do przetwarzania płatności, to pole zawiera identyfikator aplikacji z pulpitu nawigacyjnego dewelopera. Jeśli sprzedawca używa aplikacji Marketplace aplikacji Square App Do przetwarzania płatności, pole zawiera odpowiedni identyfikator aplikacji.
Token wersji	payments.version_token	string	Służy do optymistycznej współbieżności. Ten nieprzezroczysty token identyfikuje określoną wersję obiektu Payment.

Wyświetlanie listy segmentów klientów

Identyfikator operacji:: CustomerSegmentList

Pobiera listę segmentów klientów firmy.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Cursor	cursor		string	Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego.
Ograniczenie	limit		integer	Górny limit liczby do zwrócenia w odpowiedzi.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Segments	segments	array of object
identyfikator	segments.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Name	segments.name	string	Nazwa obiektu.
Utworzono pod adresem	segments.created_at	string	Czas zdarzenia w formacie ISO 8601.
Zaktualizowano o	segments.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339

Wyświetlanie listy sporów

Identyfikator operacji:: DisputeList

Zwraca listę sporów skojarzonych z określonym kontem.

Parametry

Nazwa	Klucz	Typ	Opis
Cursor	cursor	string	Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego.
States	states	string	Stany sporu, aby filtrować wynik. Jeśli nie zostanie określony, punkt końcowy zwraca wszystkie otwarte spory (stan sporu nie jest INQUIRY_CLOSED, WON lub LOST).
Identyfikator lokalizacji	location_id	string	Możesz określić ten opcjonalny filtr, aby pobrać tylko rekordy należące do określonej lokalizacji.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Spory	disputes	array of object
identyfikator	disputes.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Kwota	disputes.amount_money.amount	integer	Kwota.
Waluta	disputes.amount_money.currency	string	Waluta.
Przyczyna	disputes.reason	string	Powód sporu, dlaczego posiadacz karty zainicjował spór ze swoim bankiem.
State	disputes.state	string	Bieżący stan.
Termin ukończenia o	disputes.due_at	string	Czas ukończenia następnej akcji w formacie RFC 3339.
Sporne płatności	disputes.disputed_payments	array of object
Identyfikator płatności	disputes.disputed_payments.payment_id	string	Unikatowy identyfikator płatności generowany przez kwadrat.
Znak karty	disputes.card_brand	string	Marka kart używana w spornej płatności.
Utworzono pod adresem	disputes.created_at	string	Czas zdarzenia w formacie ISO 8601.
Zaktualizowano o	disputes.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
Identyfikator sporu marki	disputes.brand_dispute_id	string	Identyfikator sporu w systemie marki kart wygenerowany przez markę kart.
Cursor	cursor	string	Uwzględnij kursor stronicowania w kolejnych wywołaniach tego punktu końcowego, aby pobrać następny zestaw wyników skojarzonych z oryginalnym zapytaniem.

Wyświetlanie listy zdarzeń subskrypcji

Identyfikator operacji:: SubscriptionListEvents

Wyświetla listę wszystkich zdarzeń dla określonej subskrypcji.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator subskrypcji	subscription_id	True	string	Identyfikator subskrypcji.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Zdarzenia subskrypcji	subscription_events	array of object
identyfikator	subscription_events.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Typ zdarzenia subskrypcji	subscription_events.subscription_event_type	string	Typ zdarzenia subskrypcji.
Data wejścia w życie	subscription_events.effective_date	string	Data w formacie RRRR-MM-DD, kiedy zdarzenie subskrypcji zostało wprowadzone.
Identyfikator planu	subscription_events.plan_id	string	Identyfikator skojarzonego planu subskrypcji

Wyświetlanie listy zwrotów płatności

Identyfikator operacji:: RefundList

Pobiera listę zwrotów dla konta wysyłającego żądanie. Wyniki są ostatecznie spójne, a pojawienie się nowych zwrotów lub zmian zwrotów może potrwać kilka sekund.

Parametry

Nazwa	Klucz	Typ	Opis
Godzina rozpoczęcia	begin_time	string	Inkluzywny czas rozpoczęcia zapytania w opened_at w formacie ISO 8601.
Godzina zakończenia	end_time	string	Wyłączna data zakończenia zapytania w opened_at w formacie ISO 8601.
Kolejność sortowania	sort_order	string	Sortuje zwracaną listę według momentu utworzenia karty z określonym zamówieniem.
Cursor	cursor	string	Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego.
Identyfikator lokalizacji	location_id	string	Możesz określić ten opcjonalny filtr, aby pobrać tylko rekordy należące do określonej lokalizacji.
Status	status	string	Jeśli zostanie określony, zwraca tylko obiekty zgodne z określonymi stanami.
Typ źródła	source_type	string	Jeśli zostanie podana, zwracane są tylko zwroty kosztów z danym typem źródłowym.
Ograniczenie	limit	integer	Górny limit liczby do zwrócenia w odpowiedzi.

Zwraca

Nazwa	Ścieżka	Typ	Opis
Refundacji	refunds	array of object
identyfikator	refunds.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Status	refunds.status	string	Bieżący stan weryfikacji tego obiektu.
Kwota	refunds.amount_money.amount	integer	Kwota.
Waluta	refunds.amount_money.currency	string	Waluta.
Identyfikator płatności	refunds.payment_id	string	Identyfikator płatności.
Identyfikator zamówienia	refunds.order_id	string	Identyfikator zamówienia.
Utworzono pod adresem	refunds.created_at	string	Czas zdarzenia w formacie ISO 8601.
Zaktualizowano o	refunds.updated_at	string	Znacznik czasu ostatniej modyfikacji w formacie RFC 3339
Opłata za przetwarzanie	refunds.processing_fee	array of object
Obowiązującą	refunds.processing_fee.effective_at	string	Znacznik czasu stosowania opłaty w formacie RFC 3339.
Typ	refunds.processing_fee.type	string	Typ tego obiektu.
Kwota	refunds.processing_fee.amount_money.amount	integer	Kwota.
Waluta	refunds.processing_fee.amount_money.currency	string	Waluta.
Identyfikator lokalizacji	refunds.location_id	string	Identyfikator lokalizacji.
Przyczyna	refunds.reason	string	Powód sporu, dlaczego posiadacz karty zainicjował spór ze swoim bankiem.
Cursor	cursor	string	Uwzględnij kursor stronicowania w kolejnych wywołaniach tego punktu końcowego, aby pobrać następny zestaw wyników skojarzonych z oryginalnym zapytaniem.

Wznów subskrypcję

Identyfikator operacji:: SubscriptionResume

Wznawia dezaktywację subskrypcji.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator subskrypcji	subscription_id	True	string	Identyfikator subskrypcji.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	subscription.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Identyfikator lokalizacji	subscription.location_id	string	Identyfikator lokalizacji.
Identyfikator planu	subscription.plan_id	string	Identyfikator skojarzonego planu subskrypcji.
Identyfikator klienta	subscription.customer_id	string	Identyfikator tego obiektu reprezentującego klienta.
Status	subscription.status	string	Bieżący stan weryfikacji tego obiektu.
Kwota	subscription.price_override_money.amount	integer	Kwota.
Waluta	subscription.price_override_money.currency	string	Waluta.
wersja	subscription.version	integer	Bieżąca wersja tego obiektu.
Utworzono pod adresem	subscription.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Timezone	subscription.timezone	string	Strefa czasowa używana do interpretowania dat kalendarza. Po utworzeniu faktury to pole jest ustawione na strefę czasową określoną dla lokalizacji sprzedawcy. Nie można zmienić wartości.
Name	subscription.source.name	string	Nazwa.

Zaakceptuj spór

Identyfikator operacji:: DisputeAccept

Akceptuje stratę w sporze. Square zwraca kwestionowaną kwotę do posiadacza karty i aktualizuje stan sporu do ZAAKCEPTOWANE. Square debetowe spornej kwoty z konta Square sprzedawcy. Jeśli konto Square nie ma wystarczających funduszy, Square debetowe skojarzonego konta bankowego.

Parametry

Nazwa	Klucz	Wymagane	Typ	Opis
Identyfikator sporu	dispute_id	True	string	Identyfikator sporu.

Zwraca

Nazwa	Ścieżka	Typ	Opis
identyfikator	dispute.id	string	Unikatowy, wystawiony na kwadrat identyfikator.
Kwota	dispute.amount_money.amount	integer	Kwota.
Waluta	dispute.amount_money.currency	string	Waluta.
Przyczyna	dispute.reason	string	Przyczyna tego obiektu.
State	dispute.state	string	Bieżący stan.
Termin ukończenia o	dispute.due_at	string	Czas ukończenia następnej akcji w formacie RFC 3339.
Sporne płatności	dispute.disputed_payments	array of object
Identyfikator płatności	dispute.disputed_payments.payment_id	string	Unikatowy identyfikator płatności wygenerowany kwadratowo.
Znak karty	dispute.card_brand	string	Marka karty.
Utworzono pod adresem	dispute.created_at	string	Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339.
Zaktualizowano o	dispute.updated_at	string	Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339.
Identyfikator sporu marki	dispute.brand_dispute_id	string	Identyfikator sporu w systemie marki kart wygenerowany przez markę kart.

Definicje

obiekt

Jest to typ 'obiekt'.

Udostępnij przez

Płatności kwadratowe (niezależny wydawca) (wersja zapoznawcza)

Limity ograniczania

Akcje

Aktualizowanie faktury

Parametry

Zwraca

Aktualizowanie grupy klientów

Parametry

Zwraca

Aktualizowanie klienta

Parametry

Zwraca

Aktualizowanie list modyfikatora elementów

Parametry

Zwraca

Aktualizowanie podatków od elementów

Parametry

Zwraca

Aktualizowanie płatności

Parametry

Zwraca

Aktualizowanie subskrypcji

Parametry

Zwraca

Anulowanie faktury

Parametry

Zwraca

Anulowanie płatności

Parametry

Zwraca

Anulowanie płatności przy użyciu klucza idempotentności

Parametry

Zwraca

Anulowanie subskrypcji

Parametry

Zwraca

Anulowanie wyewidencjonowania terminalu

Parametry

Zwraca

Anulowanie zwrotu terminalu

Parametry

Zwraca

Dodawanie grupy do klienta

Parametry

Zwraca

Informacje o katalogu

Zwraca

Karty listy

Parametry

Zwraca

Kolejność aktualizacji (wersja beta)

Parametry

Zwraca

Kolejność klonowania (wersja beta)

Parametry

Zwraca

Liczba spisów pobierania wsadowego

Parametry

Zwraca

Obiekt wykazu Upsert

Parametry

Zwraca

Obiekty wykazu upsert usługi Batch

Parametry

Zwraca

Obliczanie kolejności (wersja beta)

Parametry

Zwraca

Pobieranie dowodów sporu

Parametry

Zwraca

Pobieranie faktury

Parametry

Zwraca

Pobieranie grupy klientów

Parametry

Zwraca

Pobieranie karty

Parametry