Square Business (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: Lojalność, Karty upominkowe, Rezerwacje, Biznes, Zespół, Finanse, Online i Uwierzytelnianie.
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 |
| 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 członka zespołu |
Aktualizuje pojedynczy obiekt TeamMember. |
| Aktualizowanie konfiguracji workweek |
Aktualizuje plik WorkweekConfig. |
| Aktualizowanie ustawienia płac |
Tworzy lub aktualizuje obiekt WageSetting. |
| Członkowie zespołu wyszukiwania |
Zwraca listę podzielonych na strony obiektów TeamMember dla firmy. |
| Dostosowywanie punktów lojalnościowych |
Dodaje punkty do lub odejmuje punkty z konta kupującego. Użyj tego punktu końcowego tylko wtedy, gdy trzeba ręcznie dostosować punkty. |
| Dostępność wyszukiwania (wersja beta) |
Wyszukuje dostępność rezerwacji. |
| Fragment kodu upsert |
Dodaje fragment kodu do witryny Square Online lub aktualizuje istniejący fragment kodu w witrynie. Kod fragmentu kodu jest dołączany na końcu elementu głównego na każdej stronie witryny, z wyjątkiem stron wyewidencjonowania. Aplikacja fragmentu kodu może dodać jeden fragment kodu do danej witryny. |
| Gromadzenie punktów lojalnościowych |
Dodaje punkty do konta lojalnościowego. |
| Lista kupców |
Zwraca informacje o kupcu dla danego tokenu dostępu. |
| Lista płac członków zespołu |
Zwraca listę z podziałem na strony wystąpień TeamMemberWage dla firmy. |
| Lista zdarzeń przesunięcia szuflady gotówki |
Udostępnia listę zdarzeń podzielonych na strony dla pojedynczej zmiany szuflady gotówkowej. |
| Lista zmian szuflady kasowej |
Zawiera szczegółowe informacje dotyczące wszystkich przesunięć szuflady gotówki dla lokalizacji w zakresie dat. |
| Lokalizacja aktualizacji (wersja beta) |
Aktualizuje lokalizację. |
| Obliczanie punktów lojalnościowych |
Oblicza punkty, które uzyskuje zakup. Aplikacja może wywołać ten punkt końcowy, aby pokazać punkty, które kupujący może zarobić przy użyciu określonego zakupu. |
| Odkupić nagrodę lojalności |
Odkupuje nagrodę lojalnościową. Po osiągnięciu stanu terminalu przez nagrodę nie można go usunąć. Innymi słowy, punkty używane do nagrody nie mogą zostać zwrócone na konto. |
| Odłącz klienta od karty upominkowej (beta) |
Odłącza klienta od karty upominkowej. |
| Pobieranie członka zespołu |
Pobiera obiekt TeamMember dla danego identyfikatora TeamMember. |
| Pobieranie fragmentu kodu |
Pobiera fragment kodu z witryny Square Online. Witryna może zawierać fragmenty kodu z wielu aplikacji fragmentów kodu, ale można pobrać tylko fragment kodu dodany przez aplikację. |
| Pobieranie karty upominkowej (wersja beta) |
Pobiera kartę upominkową przy użyciu jego identyfikatora. |
| Pobieranie karty upominkowej z nonce (beta) |
Pobiera kartę upominkową przy użyciu karty innej niż (bezpieczny token), która reprezentuje kartę upominkową. |
| Pobieranie karty upominkowej z wykresu GAN (beta) |
Pobiera kartę upominkową przy użyciu numeru konta karty upominkowej (GAN). |
| Pobieranie kodu urządzenia |
Pobiera kod urządzenia ze skojarzonym identyfikatorem. |
| Pobieranie konta bankowego według identyfikatora wersji 1 |
Zwraca szczegóły konta BankAccount zidentyfikowanego przez identyfikator konta bankowego w wersji 1. |
| Pobieranie konta lojalnościowego |
Pobiera konto lojalnościowe. |
| Pobieranie lokalizacji |
Pobiera szczegóły lokalizacji. Możesz określić "main" jako identyfikator lokalizacji, aby pobrać szczegóły lokalizacji głównej. |
| Pobieranie nagrody lojalnościowej |
Pobiera nagrodę lojalnościową. |
| Pobieranie profilu rezerwacji biznesowych (wersja beta) |
Pobiera profil rezerwacji sprzedawcy. |
| Pobieranie programu lojalnościowego |
Pobiera program lojalnościowy na koncie sprzedawcy określonym przez identyfikator programu lub główne słowo kluczowe. Programy lojalnościowe określają, w jaki sposób kupujący mogą zdobywać punkty i realizować punkty za nagrody. |
| Pobieranie przesunięcia szuflady gotówkowej |
Zawiera szczegóły podsumowania dla jednej zmiany szuflady gotówkowej. |
| Pobieranie sprzedawcy |
Pobierz obiekt Merchant dla danego merchant_id. |
| Pobieranie typu przerwania |
Zwraca pojedynczy typ przerwania określony przez identyfikator. |
| Pobieranie ustawienia płac |
Pobiera obiekt WageSetting dla członka zespołu określonego przez identyfikator TeamMember. |
| Pobieranie wynagrodzenia członka zespołu |
Zwraca pojedynczy element TeamMemberWage określony przez identyfikator. |
| Pobierz zmianę |
Zwraca pojedynczą zmianę określoną przez identyfikator. |
| Tworzenie członka zespołu |
Tworzy pojedynczy obiekt TeamMember. |
| Tworzenie działań na karcie upominkowej (wersja beta) |
Tworzy działanie karty upominkowej. |
| Tworzenie kodu autoryzacji dla urządzeń przenośnych |
Generuje kod umożliwiający autoryzowanie aplikacji mobilnej w celu nawiązania połączenia z czytnikiem kart kwadratowych. Kody autoryzacji są jednorazowe i wygasają 60 minut po wydaniu. |
| Tworzenie kodu urządzenia |
Tworzy kod urządzenia, który może służyć do logowania się do urządzenia terminalu square w celu wprowadzenia trybu połączonego terminalu. |
| Tworzenie konta lojalnościowego |
Tworzy konto lojalnościowe. |
| Tworzenie listy profilów rezerwacji członków zespołu (wersja beta) |
Wyświetla listę profilów rezerwacji dla członków zespołu. |
| Tworzenie lokalizacji (wersja beta) |
Tworzy lokalizację. |
| Tworzenie nagrody lojalnościowej |
Tworzy nagrodę lojalnościową. Po utworzeniu nagrody punkty są zablokowane i niedostępne dla kupującego, aby zrealizować kolejną nagrodę. |
| Tworzenie rezerwacji (wersja beta) |
Tworzy rezerwację. |
| Tworzenie typu przerwania |
Tworzy nowy typ breaktype. BreakType to szablon do tworzenia obiektów przerwania. |
| Tworzenie wyewidencjonowania |
Łączy identyfikator wyewidencjonowania z checkout_page_url, do którego klienci są kierowani w celu dostarczenia informacji o płatności przy użyciu przepływu pracy przetwarzania płatności. |
| Typ przerwania aktualizacji |
Aktualizuje istniejący typ przerwania. |
| Typy podziału listy |
Zwraca listę podzielonych na strony wystąpień BreakType dla firmy. |
| Usuwanie fragmentu kodu |
Usuwa fragment kodu z witryny Square Online. |
| Usuwanie nagrody lojalnościowej |
Usuwa nagrodę lojalnościową. Zwraca punkty lojalnościowe z powrotem do konta lojalnościowego. Nie można usunąć nagrody, która osiągnęła stan terminalu (REDEEMED). |
| Usuń przesunięcie |
Usuwa przesunięcie |
| Usuń typ przerwania |
Usuwa istniejący typ przerwania. Typ przerwania można usunąć, nawet jeśli odwołuje się do niego shift. |
| Utwórz zmianę |
Tworzy nową zmianę. Zmiana reprezentuje kompletny dzień roboczy dla jednego pracownika |
| Uzyskiwanie konta bankowego |
Zwraca szczegóły konta BankAccount połączonego z kontem kwadratowym. |
| Wyszukaj nagrody lojalnościowe |
Wyszukuje nagrody lojalnościowe na koncie lojalnościowym. |
| Wyszukiwanie kont lojalnościowych |
Wyszukuje konta lojalnościowe w programie lojalnościowym. |
| Wyszukiwanie zdarzeń lojalnościowych |
Wyszukuje wydarzenia lojalnościowe. Program lojalnościowy Square utrzymuje rejestr wydarzeń, które występują w okresie istnienia konta lojalnościowego nabywcy. Każda zmiana salda punktów (na przykład punkty uzyskane, zrealizowane punkty i punkty wygasłe) jest rejestrowana w rejestrze. Korzystając z tego punktu końcowego, możesz wyszukać rejestr zdarzeń. |
| Wyświetlanie listy działań związanych z kartą upominkową (beta) |
Wyświetla listę działań związanych z kartą upominkową. Domyślnie otrzymujesz działania związane z kartami upominkowymi dla wszystkich kart upominkowych na koncie sprzedawcy. Opcjonalnie możesz określić parametry zapytania, aby filtrować listę. Możesz na przykład uzyskać listę działań związanych z kartą upominkową dla karty upominkowej, dla wszystkich kart upominkowych w określonym regionie lub w ramach działań w danym przedziale czasu. |
| Wyświetlanie listy kodów urządzeń |
Wyświetla listę wszystkich kodów urządzeń skojarzonych z sprzedawcą. |
| Wyświetlanie listy konfiguracji workweek |
Zwraca listę wystąpień workweekConfig dla firmy. |
| Wyświetlanie listy kont bankowych |
Zwraca listę obiektów BankAccount połączonych z kontem square. |
| Wyświetlanie listy lokalizacji |
Zawiera informacje o wszystkich lokalizacjach firmy. |
| Wyświetlanie listy witryn |
Wyświetla listę witryn Square Online należących do sprzedawcy. |
| Zbiorcze aktualizowanie członków zespołu |
Aktualizuje wiele obiektów TeamMember. |
| Zbiorcze tworzenie członków zespołu |
Tworzy wiele obiektów TeamMember. |
| Zmiana aktualizacji |
Aktualizuje istniejącą zmianę. |
| Zmiany wyszukiwania |
Zwraca listę rekordów shift z podziałem na strony dla firmy. |
| Łączenie klienta z kartą upominkową (beta) |
Łączy klienta z kartą upominkową |
Aktualizowanie członka zespołu
Aktualizuje pojedynczy obiekt TeamMember.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator członka zespołu
|
team_member_id | True | string |
Identyfikator członka zespołu. |
|
Identyfikator odwołania
|
reference_id | string |
Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika. |
|
|
Status
|
status | string |
Bieżący stan weryfikacji tego obiektu. |
|
|
Imię
|
given_name | string |
Podana (tj. imię) nazwa skojarzona z profilem klienta. |
|
|
Nazwisko
|
family_name | string |
Rodzina (tj. nazwisko) skojarzona z profilem klienta. |
|
|
Adres e-mail
|
email_address | string |
Adres e-mail skojarzony z profilem klienta. |
|
|
Numer telefonu
|
phone_number | string |
11-cyfrowy numer telefonu skojarzony z profilem klienta. |
|
|
Identyfikatory lokalizacji
|
location_ids | array of string | ||
|
Typ przypisania
|
assignment_type | string |
Bieżący typ przypisania członka zespołu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
team_member.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator odwołania
|
team_member.reference_id | string |
Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika. |
|
Jest właścicielem
|
team_member.is_owner | boolean |
Czy członek zespołu jest właścicielem konta Square. |
|
Status
|
team_member.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Imię
|
team_member.given_name | string |
Podana (tj. imię) nazwa skojarzona z profilem klienta. |
|
Nazwisko
|
team_member.family_name | string |
Rodzina (tj. nazwisko) skojarzona z profilem klienta. |
|
Adres e-mail
|
team_member.email_address | string |
Adres e-mail skojarzony z profilem klienta. |
|
Numer telefonu
|
team_member.phone_number | string |
11-cyfrowy numer telefonu skojarzony z profilem klienta. |
|
Utworzono pod adresem
|
team_member.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Typ przypisania
|
team_member.assigned_locations.assignment_type | string |
Bieżący typ przypisania członka zespołu. |
|
Identyfikatory lokalizacji
|
team_member.assigned_locations.location_ids | array of string |
Aktualizowanie konfiguracji workweek
Aktualizuje plik WorkweekConfig.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | string |
Identyfikator. |
|
Początek tygodnia
|
start_of_week | string |
Dzień tygodnia, w którym kończy się tydzień roboczy w celach odszkodowawczych. |
|
|
Godzina rozpoczęcia dnia lokalnego
|
start_of_day_local_time | string |
Czas lokalny, w którym kończy się tydzień roboczy. Reprezentowane jako ciąg w formacie HH:MM (HH:MM:SS jest również akceptowane, ale sekundy są obcinane). |
|
|
wersja
|
version | integer |
Bieżąca wersja tego obiektu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
workweek_config.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Początek tygodnia
|
workweek_config.start_of_week | string |
Dzień tygodnia, w którym kończy się tydzień roboczy w celach odszkodowawczych. |
|
Godzina rozpoczęcia dnia lokalnego
|
workweek_config.start_of_day_local_time | string |
Czas lokalny, w którym kończy się tydzień roboczy. Reprezentowane jako ciąg w formacie HH:MM (HH:MM:SS jest również akceptowane, ale sekundy są obcinane). |
|
wersja
|
workweek_config.version | integer |
Bieżąca wersja tego obiektu. |
|
Utworzono pod adresem
|
workweek_config.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
workweek_config.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Aktualizowanie ustawienia płac
Tworzy lub aktualizuje obiekt WageSetting.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator członka zespołu
|
team_member_id | True | string |
Identyfikator członka zespołu. |
|
Jest zwolniony z pracy w nadgodzinach
|
is_overtime_exempt | boolean |
Czy członek zespołu jest zwolniony z przepisów dotyczących nadgodzin w kraju sprzedawcy. |
|
|
Stanowisko
|
job_title | string |
Tytuł zadania. |
|
|
Typ płatności
|
pay_type | string |
Bieżący typ płatności dla przydziału zadania użytego do obliczenia kwoty płatności w okresie płatności. |
|
|
Kwota
|
amount | integer |
Kwota. |
|
|
Waluta
|
currency | string |
Waluta. |
|
|
Godziny tygodniowe
|
weekly_hours | integer |
Planowane godziny tygodniowe dla zadania. Ustaw, czy zadanie PayType ma wartość SALARY. |
|
|
Kwota
|
amount | integer |
Kwota. |
|
|
Waluta
|
currency | string |
Waluta. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator członka zespołu
|
wage_setting.team_member_id | string |
Identyfikator członka zespołu. |
|
Przypisania zadań
|
wage_setting.job_assignments | array of object | |
|
Stanowisko
|
wage_setting.job_assignments.job_title | string |
Tytuł zadania. |
|
Typ płatności
|
wage_setting.job_assignments.pay_type | string |
Bieżący typ płatności dla przydziału zadania użytego do obliczenia kwoty płatności w okresie płatności. |
|
Kwota
|
wage_setting.job_assignments.hourly_rate.amount | integer |
Kwota. |
|
Waluta
|
wage_setting.job_assignments.hourly_rate.currency | string |
Waluta. |
|
Kwota
|
wage_setting.job_assignments.annual_rate.amount | integer |
Kwota. |
|
Waluta
|
wage_setting.job_assignments.annual_rate.currency | string |
Waluta. |
|
Godziny tygodniowe
|
wage_setting.job_assignments.weekly_hours | integer |
Planowane godziny tygodniowe dla zadania. Ustaw, czy zadanie PayType ma wartość SALARY. |
|
Jest zwolniony z pracy w nadgodzinach
|
wage_setting.is_overtime_exempt | boolean |
Czy członek zespołu jest zwolniony z przepisów dotyczących nadgodzin w kraju sprzedawcy. |
|
wersja
|
wage_setting.version | integer |
Bieżąca wersja tego obiektu. |
|
Utworzono pod adresem
|
wage_setting.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
wage_setting.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Członkowie zespołu wyszukiwania
Zwraca listę podzielonych na strony obiektów TeamMember dla firmy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikatory lokalizacji
|
location_ids | array of string | ||
|
Status
|
status | string |
Bieżący stan. |
|
|
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 |
|---|---|---|---|
|
Członkowie zespołu
|
team_members | array of object | |
|
identyfikator
|
team_members.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator odwołania
|
team_members.reference_id | string |
Opcjonalny drugi identyfikator używany do skojarzenia profilu klienta z jednostką w innym systemie. |
|
Jest właścicielem
|
team_members.is_owner | boolean |
Czy członek zespołu jest właścicielem konta Square. |
|
Status
|
team_members.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Imię
|
team_members.given_name | string |
Podana (tj. imię) nazwa skojarzona z profilem klienta. |
|
Nazwisko
|
team_members.family_name | string |
Rodzina (tj. nazwisko) skojarzona z profilem klienta. |
|
Adres e-mail
|
team_members.email_address | string |
Adres e-mail skojarzony z profilem klienta. |
|
Utworzono pod adresem
|
team_members.created_at | string |
Czas zdarzenia w formacie ISO 8601. |
|
Zaktualizowano o
|
team_members.updated_at | string |
Znacznik czasu ostatniej modyfikacji w formacie RFC 3339 |
|
Typ przypisania
|
team_members.assigned_locations.assignment_type | string |
Bieżący typ przypisania członka zespołu. |
|
Numer telefonu
|
team_members.phone_number | string |
11-cyfrowy numer telefonu skojarzony 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. |
Dostosowywanie punktów lojalnościowych
Dodaje punkty do lub odejmuje punkty z konta kupującego. Użyj tego punktu końcowego tylko wtedy, gdy trzeba ręcznie dostosować punkty.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
account_id | True | string |
Identyfikator konta. |
|
Punktów
|
points | integer |
Liczba dodanych lub usuniętych punktów. |
|
|
Przyczyna
|
reason | string |
Przyczyna tego obiektu. |
|
|
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
|
event.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Typ
|
event.type | string |
Typ tego obiektu. |
|
Utworzono pod adresem
|
event.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Identyfikator programu lojalnościowego
|
event.adjust_points.loyalty_program_id | string |
Identyfikator programu lojalnościowego |
|
Punktów
|
event.adjust_points.points | integer |
Liczba punktów zebranych przez zdarzenie. |
|
Przyczyna
|
event.adjust_points.reason | string |
Przyczyna korekty punktów. |
|
Identyfikator konta lojalnościowego
|
event.loyalty_account_id | string |
Identyfikator konta lojalnościowego, w którym wystąpiło zdarzenie. |
|
Źródło
|
event.source | string |
Źródło. |
Dostępność wyszukiwania (wersja beta)
Wyszukuje dostępność rezerwacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
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. |
|
|
Identyfikator lokalizacji
|
location_id | string |
Wyrażenie zapytania do wyszukiwania dostępności pasujących do określonych identyfikatorów lokalizacji sprzedawcy. |
|
|
Identyfikator odmiany usługi
|
service_variation_id | string |
Identyfikator CatalogItemVariation reprezentujący usługę zarezerwowaną w tym segmencie. |
|
|
Jakikolwiek
|
any | array of string |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Dostępność
|
availabilities | array of object | |
|
Rozpocznij od
|
availabilities.start_at | string |
Sygnatura czasowa RFC 3339 określająca czas rozpoczęcia dostępnego miejsca. |
|
Identyfikator lokalizacji
|
availabilities.location_id | string |
Identyfikator lokalizacji. |
|
Segmenty terminów
|
availabilities.appointment_segments | array of object | |
|
Czas trwania (minuty)
|
availabilities.appointment_segments.duration_minutes | integer |
Przedział czasu w minutach segmentu terminu. |
|
Identyfikator członka zespołu
|
availabilities.appointment_segments.team_member_id | string |
Identyfikator obiektu TeamMember reprezentujący członka zespołu zarezerwowanego w tym segmencie. |
|
Identyfikator odmiany usługi
|
availabilities.appointment_segments.service_variation_id | string |
Identyfikator obiektu CatalogItemVariation reprezentującego usługę zarezerwowaną w tym segmencie. |
|
Wersja odmiany usługi
|
availabilities.appointment_segments.service_variation_version | integer |
Bieżąca wersja odmiany elementu reprezentująca usługę zarezerwowaną w tym segmencie. |
|
Errors
|
errors | array of |
Fragment kodu upsert
Dodaje fragment kodu do witryny Square Online lub aktualizuje istniejący fragment kodu w witrynie. Kod fragmentu kodu jest dołączany na końcu elementu głównego na każdej stronie witryny, z wyjątkiem stron wyewidencjonowania. Aplikacja fragmentu kodu może dodać jeden fragment kodu do danej witryny.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator lokalizacji
|
site_id | True | string |
Identyfikator witryny. |
|
Content
|
content | string |
Kod fragmentu kodu, który może zawierać prawidłowy kod HTML, JavaScript lub oba te elementy. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
snippet.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator lokalizacji
|
snippet.site_id | string |
Identyfikator witryny zawierającej fragment kodu. |
|
Content
|
snippet.content | string |
Kod fragmentu kodu, który może zawierać prawidłowy kod HTML, JavaScript lub oba te elementy. |
|
Utworzono pod adresem
|
snippet.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
snippet.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Gromadzenie punktów lojalnościowych
Dodaje punkty do konta lojalnościowego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
account_id | True | string |
Identyfikator konta. |
|
Identyfikator zamówienia
|
order_id | string |
Identyfikator zamówienia. |
|
|
Identyfikator lokalizacji
|
location_id | string |
Identyfikator lokalizacji. |
|
|
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
|
event.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Typ
|
event.type | string |
Typ tego obiektu. |
|
Utworzono pod adresem
|
event.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Identyfikator programu lojalnościowego
|
event.accumulate_points.loyalty_program_id | string |
Identyfikator programu lojalnościowego |
|
Punktów
|
event.accumulate_points.points | integer |
Liczba punktów zebranych przez zdarzenie. |
|
Identyfikator zamówienia
|
event.accumulate_points.order_id | string |
Identyfikator zamówienia skojarzonego z działaniem. |
|
Identyfikator konta lojalnościowego
|
event.loyalty_account_id | string |
Identyfikator konta lojalnościowego, w którym wystąpiło zdarzenie. |
|
Identyfikator lokalizacji
|
event.location_id | string |
Identyfikator lokalizacji. |
|
Źródło
|
event.source | string |
Źródło. |
Lista kupców
Zwraca informacje o kupcu dla danego tokenu dostępu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Cursor
|
cursor | integer |
Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kupiec
|
merchant | array of object | |
|
identyfikator
|
merchant.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Nazwa firmy
|
merchant.business_name | string |
Nazwa biznesowa lokalizacji To jest nazwa widoczna dla klientów lokalizacji. Na przykład ta nazwa jest wyświetlana na paragonach klientów. |
|
Country
|
merchant.country | string |
Kod kraju ISO 3166 Alpha-2. |
|
Kod języka
|
merchant.language_code | string |
Język skojarzony z lokalizacją w formacie BCP 47. |
|
Waluta
|
merchant.currency | string |
3-znakowy kod waluty ISO 4217. |
|
Status
|
merchant.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Identyfikator lokalizacji głównej
|
merchant.main_location_id | string |
Identyfikator głównej lokalizacji dla tego sprzedawcy. |
Lista płac członków zespołu
Zwraca listę z podziałem na strony wystąpień TeamMemberWage dla firmy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator członka zespołu
|
team_member_id | string |
Przefiltruj zwrócone płace tylko do tych, które są skojarzone z określonym członkiem zespołu. |
|
|
Ograniczenie
|
limit | integer |
Górny limit liczby do zwrócenia w odpowiedzi. |
|
|
Cursor
|
cursor | string |
Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Płace członków zespołu
|
team_member_wages | array of object | |
|
identyfikator
|
team_member_wages.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator członka zespołu
|
team_member_wages.team_member_id | string |
Identyfikator obiektu TeamMember dla członka zespołu skojarzonego z obiektem . |
|
Title
|
team_member_wages.title | string |
Tytuł faktury. |
|
Kwota
|
team_member_wages.hourly_rate.amount | integer |
Kwota. |
|
Waluta
|
team_member_wages.hourly_rate.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. |
Lista zdarzeń przesunięcia szuflady gotówki
Udostępnia listę zdarzeń podzielonych na strony dla pojedynczej zmiany szuflady gotówkowej.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zmiany
|
shift_id | True | string |
Identyfikator zmiany. |
|
Identyfikator lokalizacji
|
location_id | True | string |
Możesz określić ten opcjonalny filtr, aby pobrać tylko rekordy należące do określonej lokalizacji. |
|
Ograniczenie
|
limit | integer |
Górny limit liczby do zwrócenia w odpowiedzi. |
|
|
Cursor
|
cursor | string |
Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Events
|
events | array of object | |
|
identyfikator
|
events.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Typ zdarzenia
|
events.event_type | string |
Typ zdarzenia przesunięcia szuflady gotówki. |
|
Kwota
|
events.event_money.amount | integer |
Kwota. |
|
Waluta
|
events.event_money.currency | string |
Waluta. |
|
Utworzono pod adresem
|
events.created_at | string |
Czas zdarzenia w formacie ISO 8601. |
|
Description
|
events.title | string |
Opis. |
Lista zmian szuflady kasowej
Zawiera szczegółowe informacje dotyczące wszystkich przesunięć szuflady gotówki dla lokalizacji w zakresie dat.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator lokalizacji
|
location_id | string |
Możesz określić ten opcjonalny filtr, aby pobrać tylko rekordy należące do określonej lokalizacji. |
|
|
Kolejność sortowania
|
sort_order | string |
Sortuje zwracaną listę według momentu utworzenia karty z określonym zamówieniem. |
|
|
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. |
|
|
Ograniczenie
|
limit | integer |
Górny limit liczby do zwrócenia w odpowiedzi. |
|
|
Cursor
|
cursor | string |
Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
items | array of object | |
|
identyfikator
|
items.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
State
|
items.state | string |
Bieżący stan. |
|
Otwarte o
|
items.opened_at | string |
Godzina rozpoczęcia zmiany w formacie ISO 8601. |
|
Zakończono od
|
items.ended_at | string |
Godzina zakończenia zmiany w formacie ISO 8601. |
|
Zamknięte o godzinie
|
items.closed_at | string |
Godzina zamknięcia przesunięcia w formacie ISO 8601. |
|
Description
|
items.title | string |
Opis. |
|
Kwota
|
items.opened_cash_money.amount | integer |
Kwota. |
|
Waluta
|
items.opened_cash_money.currency | string |
Waluta. |
|
Kwota
|
items.expected_cash_money.amount | integer |
Kwota. |
|
Waluta
|
items.expected_cash_money.currency | string |
Waluta. |
|
Kwota
|
items.closed_cash_money.amount | integer |
Kwota. |
|
Waluta
|
items.closed_cash_money.currency | string |
Waluta. |
Lokalizacja aktualizacji (wersja beta)
Aktualizuje lokalizację.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator lokalizacji
|
location_id | True | string |
Identyfikator lokalizacji. |
|
Name
|
name | string |
Nazwa obiektu. |
|
|
Description
|
description | string |
Opis. |
|
|
Facebook URL
|
facebook_url | string |
Adres URL profilu serwisu Facebook lokalizacji. Adres URL powinien zaczynać się od "facebook.com/". |
|
|
Nazwa użytkownika usługi Twitter
|
twitter_username | string |
Nazwa użytkownika twittera lokalizacji bez symbolu "@". |
|
|
Nazwa użytkownika instagrama
|
instagram_username | string |
Nazwa użytkownika instagrama lokalizacji bez symbolu "@". |
|
|
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. |
|
|
Poziom okręgu administracyjnego 1
|
administrative_district_level_1 | string |
Jednostka cywilna w kraju adresu. W USA jest to stan. |
|
|
Miejscowość
|
locality | string |
Miasto lub miasto adresu. |
|
|
Kod pocztowy
|
postal_code | string |
Kod pocztowy adresu. |
|
|
Dzień tygodnia
|
day_of_week | string |
Dzień tygodnia dla tego okresu. |
|
|
Godzina rozpoczęcia lokalnego
|
start_local_time | string |
Godzina rozpoczęcia okresu godzin pracy określona w czasie lokalnym przy użyciu formatu RFC 3339 czasu częściowego. |
|
|
Godzina zakończenia lokalnego
|
end_local_time | string |
Godzina zakończenia okresu godzin pracy określona w czasie lokalnym przy użyciu formatu RFC 3339 czasu częściowego. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
location.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Name
|
location.name | string |
Nazwa obiektu. |
|
Linia adresowa 1
|
location.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. |
|
Miejscowość
|
location.address.locality | string |
Miasto lub miasto adresu. |
|
Poziom okręgu administracyjnego 1
|
location.address.administrative_district_level_1 | string |
Jednostka cywilna w kraju adresu. W USA jest to stan. |
|
Kod pocztowy
|
location.address.postal_code | string |
Kod pocztowy adresu. |
|
Timezone
|
location.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. |
|
Capabilities
|
location.capabilities | array of string | |
|
Status
|
location.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Utworzono pod adresem
|
location.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Identyfikator sprzedawcy
|
location.merchant_id | string |
Identyfikator sprzedawcy. |
|
Country
|
location.country | string |
Kod kraju ISO 3166 Alpha-2. |
|
Kod języka
|
location.language_code | string |
Kod języka w formacie BCP 47. |
|
Waluta
|
location.currency | string |
3-znakowy kod waluty ISO 4217. |
|
Numer telefonu
|
location.phone_number | string |
11-cyfrowy numer telefonu skojarzony z profilem klienta. |
|
Nazwa firmy
|
location.business_name | string |
Nazwa biznesowa lokalizacji To jest nazwa widoczna dla klientów lokalizacji. Na przykład ta nazwa jest wyświetlana na paragonach klientów. |
|
Typ
|
location.type | string |
Typ tego obiektu. |
|
Adres URL witryny internetowej
|
location.website_url | string |
Adres URL witryny sieci Web lokalizacji. |
|
Okresy
|
location.business_hours.periods | array of object | |
|
Dzień tygodnia
|
location.business_hours.periods.day_of_week | string |
Dzień tygodnia dla tego okresu. |
|
Godzina rozpoczęcia lokalnego
|
location.business_hours.periods.start_local_time | string |
Godzina rozpoczęcia okresu godzin pracy określona w czasie lokalnym przy użyciu formatu RFC 3339 czasu częściowego. |
|
Godzina zakończenia lokalnego
|
location.business_hours.periods.end_local_time | string |
Godzina zakończenia okresu godzin pracy określona w czasie lokalnym przy użyciu formatu RFC 3339 czasu częściowego. |
|
Służbowa poczta e-mail
|
location.business_email | string |
Adres e-mail lokalizacji. Ta wiadomość e-mail jest widoczna dla klientów lokalizacji. Na przykład wiadomość e-mail jest wyświetlana na paragonach klientów. |
|
Description
|
location.description | string |
Opis. |
|
Nazwa użytkownika usługi Twitter
|
location.twitter_username | string |
Nazwa użytkownika twittera lokalizacji bez symbolu "@". |
|
Nazwa użytkownika instagrama
|
location.instagram_username | string |
Nazwa użytkownika instagrama lokalizacji bez symbolu "@". |
|
Szerokość
|
location.coordinates.latitude | float |
Szerokość geograficzna współrzędnych wyrażona w stopniach. |
|
Długość
|
location.coordinates.longitude | float |
Długość geograficzna współrzędnych wyrażona w stopniach. |
|
MCK
|
location.mcc | string |
Kod kategorii kupców (MCC) lokalizacji, zgodnie z normą ISO 18245. MCC opisuje rodzaj towarów lub usług sprzedawanych w lokalizacji. |
Obliczanie punktów lojalnościowych
Oblicza punkty, które uzyskuje zakup. Aplikacja może wywołać ten punkt końcowy, aby pokazać punkty, które kupujący może zarobić przy użyciu określonego zakupu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator programu
|
program_id | True | string |
Identyfikator programu. |
|
Identyfikator zamówienia
|
order_id | string |
Identyfikator zamówienia. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Punktów
|
points | integer |
Punkty, które kupujący może zarobić z określonego zakupu. |
Odkupić nagrodę lojalności
Odkupuje nagrodę lojalnościową. Po osiągnięciu stanu terminalu przez nagrodę nie można go usunąć. Innymi słowy, punkty używane do nagrody nie mogą zostać zwrócone na konto.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator nagrody
|
reward_id | True | string |
Identyfikator nagrody. |
|
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. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
event.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Typ
|
event.type | string |
Typ tego obiektu. |
|
Utworzono pod adresem
|
event.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Identyfikator programu lojalnościowego
|
event.redeem_reward.loyalty_program_id | string |
Identyfikator programu lojalnościowego |
|
Identyfikator nagrody
|
event.redeem_reward.reward_id | string |
Identyfikator przypisany do kwadratu nagrody lojalnościowej. |
|
Identyfikator konta lojalnościowego
|
event.loyalty_account_id | string |
Identyfikator konta lojalnościowego, w którym wystąpiło zdarzenie. |
|
Identyfikator lokalizacji
|
event.location_id | string |
Identyfikator lokalizacji. |
|
Źródło
|
event.source | string |
Źródło. |
Odłącz klienta od karty upominkowej (beta)
Odłącza klienta od karty upominkowej.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator karty upominkowej
|
gift_card_id | True | string |
Identyfikator karty upominkowej. |
|
Identyfikator klienta
|
customer_id | string |
Identyfikator klienta, który ma być połączony. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
gift_card.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Typ
|
gift_card.type | string |
Typ tego obiektu. |
|
Źródło GAN
|
gift_card.gan_source | string |
Wskazuje, czy numer konta karty upominkowej (GAN) jest generowany przez kwadrat lub importowany z systemu spoza kwadratu. |
|
State
|
gift_card.state | string |
Bieżący stan. |
|
Kwota
|
gift_card.balance_money.amount | integer |
Kwota. |
|
Waluta
|
gift_card.balance_money.currency | string |
Waluta. |
|
Gan
|
gift_card.gan | string |
Numer konta karty upominkowej. |
|
Utworzono pod adresem
|
gift_card.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
Pobieranie członka zespołu
Pobiera obiekt TeamMember dla danego identyfikatora TeamMember.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator członka zespołu
|
team_member_id | True | string |
Identyfikator członka zespołu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
team_member.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator odwołania
|
team_member.reference_id | string |
Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika. |
|
Jest właścicielem
|
team_member.is_owner | boolean |
Czy członek zespołu jest właścicielem konta Square. |
|
Status
|
team_member.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Imię
|
team_member.given_name | string |
Podana (tj. imię) nazwa skojarzona z profilem klienta. |
|
Nazwisko
|
team_member.family_name | string |
Rodzina (tj. nazwisko) skojarzona z profilem klienta. |
|
Adres e-mail
|
team_member.email_address | string |
Adres e-mail skojarzony z profilem klienta. |
|
Numer telefonu
|
team_member.phone_number | string |
11-cyfrowy numer telefonu skojarzony z profilem klienta. |
|
Utworzono pod adresem
|
team_member.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
team_member.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
|
Typ przypisania
|
team_member.assigned_locations.assignment_type | string |
Bieżący typ przypisania członka zespołu. |
|
Identyfikatory lokalizacji
|
team_member.assigned_locations.location_ids | array of string |
Pobieranie fragmentu kodu
Pobiera fragment kodu z witryny Square Online. Witryna może zawierać fragmenty kodu z wielu aplikacji fragmentów kodu, ale można pobrać tylko fragment kodu dodany przez aplikację.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator lokalizacji
|
site_id | True | string |
Identyfikator witryny. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
snippet.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator lokalizacji
|
snippet.site_id | string |
Identyfikator witryny zawierającej fragment kodu. |
|
Content
|
snippet.content | string |
Kod fragmentu kodu, który może zawierać prawidłowy kod HTML, JavaScript lub oba te elementy. |
|
Utworzono pod adresem
|
snippet.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
snippet.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Pobieranie karty upominkowej (wersja beta)
Pobiera kartę upominkową przy użyciu jego identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | string |
Identyfikator. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
gift_card.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Typ
|
gift_card.type | string |
Typ tego obiektu. |
|
Źródło GAN
|
gift_card.gan_source | string |
Wskazuje, czy numer konta karty upominkowej (GAN) jest generowany przez kwadrat lub importowany z systemu spoza kwadratu. |
|
State
|
gift_card.state | string |
Bieżący stan. |
|
Kwota
|
gift_card.balance_money.amount | integer |
Kwota. |
|
Waluta
|
gift_card.balance_money.currency | string |
Waluta. |
|
Gan
|
gift_card.gan | string |
Numer konta karty upominkowej. |
|
Utworzono pod adresem
|
gift_card.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
Pobieranie karty upominkowej z nonce (beta)
Pobiera kartę upominkową przy użyciu karty innej niż (bezpieczny token), która reprezentuje kartę upominkową.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Jednorazowo
|
nonce | string |
Nonce karty upominkowej do pobrania. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
gift_card.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Typ
|
gift_card.type | string |
Typ tego obiektu. |
|
Źródło GAN
|
gift_card.gan_source | string |
Wskazuje, czy numer konta karty upominkowej (GAN) jest generowany przez kwadrat lub importowany z systemu spoza kwadratu. |
|
State
|
gift_card.state | string |
Bieżący stan. |
|
Kwota
|
gift_card.balance_money.amount | integer |
Kwota. |
|
Waluta
|
gift_card.balance_money.currency | string |
Waluta. |
|
Gan
|
gift_card.gan | string |
Numer konta karty upominkowej. |
|
Utworzono pod adresem
|
gift_card.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
Pobieranie karty upominkowej z wykresu GAN (beta)
Pobiera kartę upominkową przy użyciu numeru konta karty upominkowej (GAN).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Gan
|
gan | string |
Numer konta karty upominkowej. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
gift_card.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Typ
|
gift_card.type | string |
Typ tego obiektu. |
|
Źródło GAN
|
gift_card.gan_source | string |
Wskazuje, czy numer konta karty upominkowej (GAN) jest generowany przez kwadrat lub importowany z systemu spoza kwadratu. |
|
State
|
gift_card.state | string |
Bieżący stan. |
|
Kwota
|
gift_card.balance_money.amount | integer |
Kwota. |
|
Waluta
|
gift_card.balance_money.currency | string |
Waluta. |
|
Gan
|
gift_card.gan | string |
Numer konta karty upominkowej. |
|
Utworzono pod adresem
|
gift_card.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
Pobieranie kodu urządzenia
Pobiera kod urządzenia ze skojarzonym identyfikatorem.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | string |
Identyfikator. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
device_code.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Name
|
device_code.name | string |
Nazwa obiektu. |
|
Code
|
device_code.code | string |
Unikatowy kod, który może służyć do logowania. |
|
Typ produktu
|
device_code.product_type | string |
Docelowy typ produktu w kodzie urządzenia. |
|
Identyfikator lokalizacji
|
device_code.location_id | string |
Identyfikator lokalizacji. |
|
Utworzono pod adresem
|
device_code.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Paruj według
|
device_code.pair_by | string |
Gdy kod urządzenia wygaśnie i nie zaloguje się już. Sygnatura czasowa w formacie RFC 3339. |
|
Status
|
device_code.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Identyfikator urządzenia
|
device_code.device_id | string |
Identyfikator urządzenia. |
|
Stan zmieniony o
|
device_code.status_changed_at | string |
Gdy stan tego kodu urządzenia został ostatnio zmieniony. Sygnatura czasowa w formacie RFC 3339. |
Pobieranie konta bankowego według identyfikatora wersji 1
Zwraca szczegóły konta BankAccount zidentyfikowanego przez identyfikator konta bankowego w wersji 1.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta bankowego w wersji 1
|
v1_bank_account_id | True | string |
Połącz identyfikator wersji 1 żądanego konta BankAccount. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
bank_account.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Sufiks numeru konta
|
bank_account.account_number_suffix | string |
Ostatnie kilka cyfr numeru konta. |
|
Country
|
bank_account.country | string |
Kod kraju ISO 3166 Alpha-2. |
|
Waluta
|
bank_account.currency | string |
3-znakowy kod waluty ISO 4217. |
|
Typ konta
|
bank_account.account_type | string |
Typ konta. |
|
Nazwa posiadacza
|
bank_account.holder_name | string |
Nazwa właściciela konta. |
|
Podstawowy numer identyfikacyjny banku
|
bank_account.primary_bank_identification_number | string |
Podstawowy identyfikator banku. |
|
Identyfikator lokalizacji
|
bank_account.location_id | string |
Identyfikator lokalizacji. |
|
Status
|
bank_account.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Wiarygodne
|
bank_account.creditable | boolean |
Wskazuje, czy kwadrat może wysyłać pieniądze na to konto. |
|
Możliwe do zapłaty
|
bank_account.debitable | boolean |
Wskazuje, czy kwadrat może pobrać pieniądze z tego konta. |
|
wersja
|
bank_account.version | integer |
Bieżąca wersja tego obiektu. |
|
Nazwa banku
|
bank_account.bank_name | string |
Nazwa rzeczywistej instytucji finansowej. |
Pobieranie konta lojalnościowego
Pobiera konto lojalnościowe.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta
|
account_id | True | string |
Identyfikator konta. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
loyalty_account.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
identyfikator
|
loyalty_account.mapping.id | string |
Identyfikator przypisany do kwadratu. |
|
Numer telefonu
|
loyalty_account.mapping.phone_number | string |
Numer telefonu odbiorcy. |
|
Utworzono pod adresem
|
loyalty_account.mapping.created_at | string |
Sygnatura czasowa utworzona w formacie RFC 3339. |
|
Identyfikator programu
|
loyalty_account.program_id | string |
Identyfikator przypisany do kwadratu programu. |
|
Saldo
|
loyalty_account.balance | integer |
Dostępne saldo. |
|
Punkty istnienia
|
loyalty_account.lifetime_points | integer |
Łączna liczba punktów naliczanych w okresie istnienia konta. |
|
Identyfikator klienta
|
loyalty_account.customer_id | string |
Identyfikator tego obiektu reprezentującego klienta. |
|
Utworzono pod adresem
|
loyalty_account.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
loyalty_account.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Pobieranie lokalizacji
Pobiera szczegóły lokalizacji. Możesz określić "main" jako identyfikator lokalizacji, aby pobrać szczegóły lokalizacji głównej.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator lokalizacji
|
location_id | True | string |
Identyfikator lokalizacji. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
location.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Name
|
location.name | string |
Nazwa obiektu. |
|
Linia adresowa 1
|
location.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. |
|
Miejscowość
|
location.address.locality | string |
Miasto lub miasto adresu. |
|
Poziom okręgu administracyjnego 1
|
location.address.administrative_district_level_1 | string |
Jednostka cywilna w kraju adresu. W USA jest to stan. |
|
Kod pocztowy
|
location.address.postal_code | string |
Kod pocztowy adresu. |
|
Country
|
location.address.country | string |
Kraj adresu w formacie ISO 3166-1-alfa-2. |
|
Timezone
|
location.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. |
|
Capabilities
|
location.capabilities | array of string | |
|
Status
|
location.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Utworzono pod adresem
|
location.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Identyfikator sprzedawcy
|
location.merchant_id | string |
Identyfikator sprzedawcy. |
|
Country
|
location.country | string |
Kod kraju ISO 3166 Alpha-2. |
|
Kod języka
|
location.language_code | string |
Kod języka w formacie BCP 47. |
|
Waluta
|
location.currency | string |
3-znakowy kod waluty ISO 4217. |
|
Numer telefonu
|
location.phone_number | string |
11-cyfrowy numer telefonu skojarzony z profilem klienta. |
|
Nazwa firmy
|
location.business_name | string |
Nazwa biznesowa lokalizacji To jest nazwa widoczna dla klientów lokalizacji. Na przykład ta nazwa jest wyświetlana na paragonach klientów. |
Pobieranie nagrody lojalnościowej
Pobiera nagrodę lojalnościową.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator nagrody
|
reward_id | True | string |
Identyfikator nagrody. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
reward.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Status
|
reward.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Identyfikator konta lojalnościowego
|
reward.loyalty_account_id | string |
Identyfikator konta lojalnościowego, w którym wystąpiło zdarzenie. |
|
Identyfikator warstwy nagrody
|
reward.reward_tier_id | string |
Identyfikator przypisany do kwadratu warstwy nagrody użytej do utworzenia nagrody. |
|
Punktów
|
reward.points | integer |
Liczba dodanych lub usuniętych punktów. |
|
Utworzono pod adresem
|
reward.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
reward.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
|
Zrealizowano na
|
reward.redeemed_at | string |
Znacznik czasu, kiedy nagroda została zrealizowana, w formacie RFC 3339. |
Pobieranie profilu rezerwacji biznesowych (wersja beta)
Pobiera profil rezerwacji sprzedawcy.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator sprzedawcy
|
business_booking_profile.seller_id | string |
Identyfikator sprzedawcy, który można uzyskać przy użyciu interfejsu API kupców. |
|
Utworzono pod adresem
|
business_booking_profile.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Włączono rezerwację
|
business_booking_profile.booking_enabled | boolean |
Wskazuje, czy sprzedawca jest otwarty do rezerwacji. |
|
Wybór strefy czasowej klienta
|
business_booking_profile.customer_timezone_choice | string |
Wybór informacji o strefie czasowej klienta rezerwacji. Witryna rezerwacji online Square i wszystkie powiadomienia dla klientów używają strefy czasowej sprzedawcy lub strefy czasowej wybranej przez klienta. |
|
Zasady rezerwacji
|
business_booking_profile.booking_policy | string |
Zasady dla sprzedawcy do automatycznego akceptowania żądań rezerwacji (ACCEPT_ALL) lub nie (REQUIRES_ACCEPTANCE). |
|
Zezwalaj użytkownikowi na anulowanie
|
business_booking_profile.allow_user_cancel | boolean |
Wskazuje, czy klienci mogą anulować lub ponownie zaplanować własne rezerwacje (prawda), czy nie (fałsz). |
|
Typy lokalizacji
|
business_booking_profile.business_appointment_settings.location_types | array of string | |
|
Czas wyrównania
|
business_booking_profile.business_appointment_settings.alignment_time | string |
Jednostka czasowa czasu trwania rezerwacji. |
|
Minimalna rezerwacja dokuczała czas w sekundach
|
business_booking_profile.business_appointment_settings.min_booking_lead_time_seconds | integer |
Minimalny czas realizacji w sekundach, zanim będzie można zarezerwować usługę. Rezerwacje muszą być tworzone co najmniej tak daleko przed czasem rozpoczęcia rezerwacji. |
|
Maksymalna liczba sekund czasu realizacji rezerwacji
|
business_booking_profile.business_appointment_settings.max_booking_lead_time_seconds | integer |
Maksymalny czas realizacji w sekundach, zanim będzie można zarezerwować usługę. Rezerwacje muszą być tworzone w większości przed czasem rozpoczęcia rezerwacji. |
|
Włączono rezerwację dowolnego członka zespołu
|
business_booking_profile.business_appointment_settings.any_team_member_booking_enabled | boolean |
Wskazuje, czy klient może wybrać spośród wszystkich dostępnych przedziałów czasu i mieć automatycznie przypisanego członka personelu (true), czy też nie (false). |
|
Włączono wiele rezerwacji usług
|
business_booking_profile.business_appointment_settings.multiple_service_booking_enabled | boolean |
Wskazuje, czy klient może zarezerwować wiele usług w jednej rezerwacji online. |
|
Kwota
|
business_booking_profile.business_appointment_settings.cancellation_fee_money.amount | string |
Kwota pieniędzy, w najmniejszym nominałach waluty wskazanej przez walutę |
|
Waluta
|
business_booking_profile.business_appointment_settings.cancellation_fee_money.currency | string |
Typ waluty w formacie ISO 4217. |
|
Zasady anulowania
|
business_booking_profile.business_appointment_settings.cancellation_policy | string |
Zasady anulowania przyjęte przez sprzedawcę. |
|
Pomiń wybór personelu przepływu rezerwacji
|
business_booking_profile.business_appointment_settings.skip_booking_flow_staff_selection | boolean |
Wskazuje, czy klienci mają przypisanego członka personelu (prawda) lub mogą wybrać wybranego przez siebie członka personelu (false). |
|
Errors
|
errors | array of |
Pobieranie programu lojalnościowego
Pobiera program lojalnościowy na koncie sprzedawcy określonym przez identyfikator programu lub główne słowo kluczowe. Programy lojalnościowe określają, w jaki sposób kupujący mogą zdobywać punkty i realizować punkty za nagrody.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator programu
|
program_id | True | string |
Identyfikator programu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
program.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Status
|
program.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Warstwy nagród
|
program.reward_tiers | array of object | |
|
identyfikator
|
program.reward_tiers.id | string |
Identyfikator obiektu |
|
Punktów
|
program.reward_tiers.points | integer |
Liczba punktów zebranych przez zdarzenie. |
|
Name
|
program.reward_tiers.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. |
|
Scope
|
program.reward_tiers.definition.scope | string |
Wskazuje poziom, na którym ma zastosowanie obiekt. |
|
Typ rabatu
|
program.reward_tiers.definition.discount_type | string |
Typ rabatu dla ofert warstwy nagrody. |
|
Rabat procentowy
|
program.reward_tiers.definition.percentage_discount | string |
Stały procent rabatu. |
|
Utworzono pod adresem
|
program.reward_tiers.created_at | string |
Sygnatura czasowa utworzona w formacie RFC 3339. |
|
Identyfikator obiektu
|
program.reward_tiers.pricing_rule_reference.object_id | string |
Identyfikator obiektu, do których odwołuje się odwołanie. |
|
Wersja wykazu
|
program.reward_tiers.pricing_rule_reference.catalog_version | string |
Wersja obiektu. |
|
One
|
program.terminology.one | string |
Pojedyncza jednostka punktu (na przykład 1 punkt jest nazywana 1 gwiazdką). |
|
Other
|
program.terminology.other | string |
Jednostka mnogiej dla punktu (na przykład 10 punktów nosi nazwę 10 gwiazdek). |
|
Identyfikatory lokalizacji
|
program.location_ids | array of string | |
|
Utworzono pod adresem
|
program.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
program.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
|
Reguły naliczania
|
program.accrual_rules | array of object | |
|
Typ naliczania
|
program.accrual_rules.accrual_type | string |
Typ reguły naliczania, która definiuje sposób, w jaki kupujący mogą zdobywać punkty. |
|
Punktów
|
program.accrual_rules.points | integer |
Liczba punktów zebranych przez zdarzenie. |
|
Kwota
|
program.accrual_rules.spend_amount_money.amount | integer |
Kwota. |
|
Wykluczone identyfikatory kategorii
|
program.accrual_rules.excluded_category_ids | array of string | |
|
Identyfikatory odmiany wykluczonych elementów
|
program.accrual_rules.excluded_item_variation_ids | array of string |
Pobieranie przesunięcia szuflady gotówkowej
Zawiera szczegóły podsumowania dla jednej zmiany szuflady gotówkowej.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zmiany
|
shift_id | True | string |
Identyfikator zmiany. |
|
Identyfikator lokalizacji
|
location_id | True | string |
Możesz określić ten opcjonalny filtr, aby pobrać tylko rekordy należące do określonej lokalizacji. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
cash_drawer_shift.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
State
|
cash_drawer_shift.state | string |
Bieżący stan. |
|
Otwarte o
|
cash_drawer_shift.opened_at | string |
Czas rozpoczęcia zmiany w formacie ISO 8601. |
|
Zakończono od
|
cash_drawer_shift.ended_at | string |
Czas zakończenia zmiany w formacie ISO 8601. |
|
Zamknięte o godzinie
|
cash_drawer_shift.closed_at | string |
Czas zamknięcia w formacie ISO 8601. |
|
Otwieranie identyfikatora pracownika
|
cash_drawer_shift.opening_employee_id | string |
Identyfikator pracownika, który rozpoczął zmianę szuflady gotówki. |
|
Końcowy identyfikator pracownika
|
cash_drawer_shift.ending_employee_id | string |
Identyfikator pracownika, który zakończył zmianę szuflady gotówki. |
|
Zamykanie identyfikatora pracownika
|
cash_drawer_shift.closing_employee_id | string |
Identyfikator pracownika, który zamknął zmianę szuflady gotówkowej, przeprowadzając inspekcję zawartości szuflady gotówkowej. |
|
Description
|
cash_drawer_shift.description | string |
Opis. |
|
Kwota
|
cash_drawer_shift.opened_cash_money.amount | integer |
Kwota. |
|
Waluta
|
cash_drawer_shift.opened_cash_money.currency | string |
Waluta. |
|
Kwota
|
cash_drawer_shift.cash_payment_money.amount | integer |
Kwota. |
|
Waluta
|
cash_drawer_shift.cash_payment_money.currency | string |
Waluta. |
|
Kwota
|
cash_drawer_shift.cash_refunds_money.amount | integer |
Kwota. |
|
Waluta
|
cash_drawer_shift.cash_refunds_money.currency | string |
Waluta. |
|
Kwota
|
cash_drawer_shift.cash_paid_in_money.amount | integer |
Kwota. |
|
Waluta
|
cash_drawer_shift.cash_paid_in_money.currency | string |
Waluta. |
|
Kwota
|
cash_drawer_shift.cash_paid_out_money.amount | integer |
Kwota. |
|
Waluta
|
cash_drawer_shift.cash_paid_out_money.currency | string |
Waluta. |
|
Kwota
|
cash_drawer_shift.expected_cash_money.amount | integer |
Kwota. |
|
Waluta
|
cash_drawer_shift.expected_cash_money.currency | string |
Waluta. |
|
Kwota
|
cash_drawer_shift.closed_cash_money.amount | integer |
Kwota. |
|
Waluta
|
cash_drawer_shift.closed_cash_money.currency | string |
Waluta. |
|
Name
|
cash_drawer_shift.device.name | string |
Nazwa. |
Pobieranie sprzedawcy
Pobierz obiekt Merchant dla danego merchant_id.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator sprzedawcy
|
merchant_id | True | string |
Identyfikator sprzedawcy. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
merchant.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Nazwa firmy
|
merchant.business_name | string |
Nazwa biznesowa lokalizacji To jest nazwa widoczna dla klientów lokalizacji. Na przykład ta nazwa jest wyświetlana na paragonach klientów. |
|
Country
|
merchant.country | string |
Kod kraju ISO 3166 Alpha-2. |
|
Kod języka
|
merchant.language_code | string |
Kod języka w formacie BCP 47. |
|
Waluta
|
merchant.currency | string |
3-znakowy kod waluty ISO 4217. |
|
Status
|
merchant.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Identyfikator lokalizacji głównej
|
merchant.main_location_id | string |
Identyfikator głównej lokalizacji dla tego sprzedawcy. |
Pobieranie typu przerwania
Zwraca pojedynczy typ przerwania określony przez identyfikator.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | string |
Identyfikator. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
break_type.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator lokalizacji
|
break_type.location_id | string |
Identyfikator lokalizacji. |
|
Nazwa przerwania
|
break_type.break_name | string |
Czytelna dla tego typu przerwania. Nazwa jest wyświetlana pracownikom w produktach Square. |
|
Oczekiwany czas trwania
|
break_type.expected_duration | string |
Oczekiwana długość tej przerwy. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precyzja mniejsza niż minuta jest obcinana. |
|
Jest płatna
|
break_type.is_paid | boolean |
Czy ta przerwa liczy się w stosunku do czasu pracy w celach odszkodowawczych. |
|
wersja
|
break_type.version | integer |
Bieżąca wersja tego obiektu. |
|
Utworzono pod adresem
|
break_type.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
break_type.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Pobieranie ustawienia płac
Pobiera obiekt WageSetting dla członka zespołu określonego przez identyfikator TeamMember.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator członka zespołu
|
team_member_id | True | string |
Identyfikator członka zespołu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator członka zespołu
|
wage_setting.team_member_id | string |
Identyfikator członka zespołu. |
|
Przypisania zadań
|
wage_setting.job_assignments | array of object | |
|
Stanowisko
|
wage_setting.job_assignments.job_title | string |
Tytuł zadania. |
|
Typ płatności
|
wage_setting.job_assignments.pay_type | string |
Bieżący typ płatności dla przydziału zadania użytego do obliczenia kwoty płatności w okresie płatności. |
|
Kwota
|
wage_setting.job_assignments.hourly_rate.amount | integer |
Kwota. |
|
Waluta
|
wage_setting.job_assignments.hourly_rate.currency | string |
Waluta. |
|
Kwota
|
wage_setting.job_assignments.annual_rate.amount | integer |
Kwota. |
|
Waluta
|
wage_setting.job_assignments.annual_rate.currency | string |
Waluta. |
|
Godziny tygodniowe
|
wage_setting.job_assignments.weekly_hours | integer |
Planowane godziny tygodniowe dla zadania. Ustaw, czy zadanie PayType ma wartość SALARY. |
|
Jest zwolniony z pracy w nadgodzinach
|
wage_setting.is_overtime_exempt | boolean |
Czy członek zespołu jest zwolniony z przepisów dotyczących nadgodzin w kraju sprzedawcy. |
|
wersja
|
wage_setting.version | integer |
Bieżąca wersja tego obiektu. |
|
Utworzono pod adresem
|
wage_setting.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
wage_setting.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Pobieranie wynagrodzenia członka zespołu
Zwraca pojedynczy element TeamMemberWage określony przez identyfikator.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | string |
Identyfikator. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
team_member_wage.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator członka zespołu
|
team_member_wage.team_member_id | string |
Identyfikator członka zespołu. |
|
Title
|
team_member_wage.title | string |
Tytuł. |
|
Kwota
|
team_member_wage.hourly_rate.amount | integer |
Kwota. |
|
Waluta
|
team_member_wage.hourly_rate.currency | string |
Waluta. |
Pobierz zmianę
Zwraca pojedynczą zmianę określoną przez identyfikator.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | string |
Identyfikator. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
shift.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator członka zespołu
|
shift.team_member_id | string |
Identyfikator członka zespołu. |
|
Identyfikator pracownika
|
shift.employee_id | string |
Identyfikator wygenerowany kwadratowo pracownika. |
|
Identyfikator lokalizacji
|
shift.location_id | string |
Identyfikator lokalizacji. |
|
Timezone
|
shift.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. |
|
Rozpocznij od
|
shift.start_at | string |
Sygnatura czasowa określająca godzinę początkową tego obiektu w formacie RFC 3339. |
|
Koniec od
|
shift.end_at | string |
RFC 3339; przesunięte na strefę czasową i przesunięcie. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
Title
|
shift.wage.title | string |
Nazwa zadania wykonywanego podczas tej zmiany. Kwadratowe interfejsy użytkownika raportowania pracy mogą grupować zmiany według tytułu. |
|
Kwota
|
shift.wage.hourly_rate.amount | integer |
Kwota. |
|
Waluta
|
shift.wage.hourly_rate.currency | string |
Waluta. |
|
Przerwy
|
shift.breaks | array of object | |
|
identyfikator
|
shift.breaks.id | string |
Identyfikator obiektu |
|
Rozpocznij od
|
shift.breaks.start_at | string |
RFC 3339; jest zgodny z tymi samymi informacjami o strefie czasowej co Shift. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
Koniec od
|
shift.breaks.end_at | string |
RFC 3339; jest zgodny z tymi samymi informacjami o strefie czasowej co Shift. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
Identyfikator typu przerwania
|
shift.breaks.break_type_id | string |
BreakType, dla którego utworzono ten podział. |
|
Name
|
shift.breaks.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. |
|
Oczekiwany czas trwania
|
shift.breaks.expected_duration | string |
Oczekiwana długość przerwy. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. |
|
Jest płatna
|
shift.breaks.is_paid | boolean |
Czy ta przerwa liczy się w stosunku do czasu pracy w celach odszkodowawczych. |
|
Status
|
shift.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
wersja
|
shift.version | integer |
Bieżąca wersja tego obiektu. |
|
Utworzono pod adresem
|
shift.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
shift.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Tworzenie członka zespołu
Tworzy pojedynczy obiekt TeamMember.
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). |
|
|
Identyfikator odwołania
|
reference_id | string |
Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika. |
|
|
Status
|
status | string |
Bieżący stan weryfikacji tego obiektu. |
|
|
Imię
|
given_name | string |
Podana (tj. imię) nazwa skojarzona z profilem klienta. |
|
|
Nazwisko
|
family_name | string |
Rodzina (tj. nazwisko) skojarzona z profilem klienta. |
|
|
Adres e-mail
|
email_address | string |
Adres e-mail skojarzony z profilem klienta. |
|
|
Numer telefonu
|
phone_number | string |
11-cyfrowy numer telefonu skojarzony z profilem klienta. |
|
|
Identyfikatory lokalizacji
|
location_ids | array of string | ||
|
Typ przypisania
|
assignment_type | string |
Bieżący typ przypisania członka zespołu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
team_member.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator odwołania
|
team_member.reference_id | string |
Opcjonalny identyfikator odwołania zdefiniowany przez użytkownika. |
|
Jest właścicielem
|
team_member.is_owner | boolean |
Czy członek zespołu jest właścicielem konta Square. |
|
Status
|
team_member.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Imię
|
team_member.given_name | string |
Podana (tj. imię) nazwa skojarzona z profilem klienta. |
|
Nazwisko
|
team_member.family_name | string |
Rodzina (tj. nazwisko) skojarzona z profilem klienta. |
|
Adres e-mail
|
team_member.email_address | string |
Adres e-mail skojarzony z profilem klienta. |
|
Numer telefonu
|
team_member.phone_number | string |
11-cyfrowy numer telefonu skojarzony z profilem klienta. |
|
Typ przypisania
|
team_member.assigned_locations.assignment_type | string |
Bieżący typ przypisania członka zespołu. |
|
Identyfikatory lokalizacji
|
team_member.assigned_locations.location_ids | array of string |
Tworzenie działań na karcie upominkowej (wersja beta)
Tworzy działanie karty upominkowej.
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). |
|
|
Identyfikator karty upominkowej
|
gift_card_id | string |
Identyfikator karty upominkowej. Identyfikator nie jest wymagany, jeśli jest obecny wykres GAN. |
|
|
Typ
|
type | string |
Typ tego obiektu. |
|
|
Identyfikator lokalizacji
|
location_id | string |
Identyfikator lokalizacji. |
|
|
Identyfikator zamówienia
|
order_id | string |
Identyfikator zamówienia skojarzonego z działaniem. |
|
|
Identyfikator UID elementu wiersza
|
line_item_uid | string |
Line_item_uid elementu linii karty upominkowej w zamówieniu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
gift_card_activity.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator karty upominkowej
|
gift_card_activity.gift_card_id | string |
Identyfikator karty upominkowej. Identyfikator nie jest wymagany, jeśli jest obecny wykres GAN. |
|
Karta upominkowa GAN
|
gift_card_activity.gift_card_gan | string |
Karta upominkowa GAN. Wykres GAN nie jest wymagany, jeśli gift_card_id jest obecny. |
|
Typ
|
gift_card_activity.type | string |
Typ tego obiektu. |
|
Kwota
|
gift_card_activity.gift_card_balance_money.amount | integer |
Kwota. |
|
Waluta
|
gift_card_activity.gift_card_balance_money.currency | string |
Waluta. |
|
Identyfikator lokalizacji
|
gift_card_activity.location_id | string |
Identyfikator lokalizacji. |
|
Utworzono pod adresem
|
gift_card_activity.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Kwota
|
gift_card_activity.activate_activity_details.amount_money.amount | integer |
Kwota. |
|
Waluta
|
gift_card_activity.activate_activity_details.amount_money.currency | string |
Waluta. |
|
Identyfikator zamówienia
|
gift_card_activity.activate_activity_details.order_id | string |
Identyfikator zamówienia skojarzonego z działaniem. |
|
Identyfikator UID elementu wiersza
|
gift_card_activity.activate_activity_details.line_item_uid | string |
Line_item_uid elementu linii karty upominkowej w zamówieniu. |
Tworzenie kodu autoryzacji dla urządzeń przenośnych
Generuje kod umożliwiający autoryzowanie aplikacji mobilnej w celu nawiązania połączenia z czytnikiem kart kwadratowych. Kody autoryzacji są jednorazowe i wygasają 60 minut po wydaniu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator lokalizacji
|
location_id | string |
Identyfikator lokalizacji. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kod autoryzacji
|
authorization_code | string |
Wygenerowany kod autoryzacji łączący wystąpienie aplikacji mobilnej z kontem Square. |
|
Wygasa o godzinie
|
expires_at | string |
Znacznik czasu wygaśnięcia authorization_code w formacie RFC 3339. |
Tworzenie kodu urządzenia
Tworzy kod urządzenia, który może służyć do logowania się do urządzenia terminalu square w celu wprowadzenia trybu połączonego terminalu.
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). |
|
|
Name
|
name | string |
Nazwa obiektu. |
|
|
Identyfikator lokalizacji
|
location_id | string |
Identyfikator lokalizacji. |
|
|
Typ produktu
|
product_type | string |
Docelowy typ produktu w kodzie urządzenia. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
device_code.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Name
|
device_code.name | string |
Nazwa obiektu. |
|
Code
|
device_code.code | string |
Unikatowy kod, który może służyć do logowania. |
|
Typ produktu
|
device_code.product_type | string |
Docelowy typ produktu w kodzie urządzenia. |
|
Identyfikator lokalizacji
|
device_code.location_id | string |
Identyfikator lokalizacji. |
|
Utworzono pod adresem
|
device_code.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Paruj według
|
device_code.pair_by | string |
Gdy kod urządzenia wygaśnie i nie zaloguje się już. Sygnatura czasowa w formacie RFC 3339. |
|
Status
|
device_code.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Stan zmieniony o
|
device_code.status_changed_at | string |
Gdy stan tego kodu urządzenia został ostatnio zmieniony. Sygnatura czasowa w formacie RFC 3339. |
Tworzenie konta lojalnościowego
Tworzy konto lojalnościowe.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Numer telefonu
|
phone_number | string |
Numer telefonu odbiorcy. |
|
|
Identyfikator programu
|
program_id | string |
Identyfikator przypisany do kwadratu programu. |
|
|
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
|
loyalty_account.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
identyfikator
|
loyalty_account.mapping.id | string |
Identyfikator przypisany do kwadratu. |
|
Numer telefonu
|
loyalty_account.mapping.phone_number | string |
Numer telefonu odbiorcy. |
|
Utworzono pod adresem
|
loyalty_account.mapping.created_at | string |
Sygnatura czasowa utworzona w formacie RFC 3339. |
|
Identyfikator programu
|
loyalty_account.program_id | string |
Identyfikator przypisany do kwadratu programu. |
|
Saldo
|
loyalty_account.balance | integer |
Dostępne saldo. |
|
Punkty istnienia
|
loyalty_account.lifetime_points | integer |
Łączna liczba punktów naliczanych w okresie istnienia konta. |
|
Utworzono pod adresem
|
loyalty_account.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
loyalty_account.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Tworzenie listy profilów rezerwacji członków zespołu (wersja beta)
Wyświetla listę profilów rezerwacji dla członków zespołu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Tylko zarezerwowane
|
bookable_only | boolean |
Wskazuje, czy w zwróconym wyniku (true) lub nie (false) należy uwzględnić tylko zarezerwowanych członków zespołu. |
|
|
Ograniczenie
|
limit | integer |
Górny limit liczby do zwrócenia w odpowiedzi. |
|
|
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. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Profile rezerwacji członków zespołu
|
team_member_booking_profiles | array of object | |
|
Identyfikator członka zespołu
|
team_member_booking_profiles.team_member_id | string |
Identyfikator obiektu TeamMember dla członka zespołu skojarzonego z obiektem . |
|
Wyświetlana nazwa
|
team_member_booking_profiles.display_name | string |
Nazwa wyświetlana członka zespołu. |
|
Czy można zarezerwować
|
team_member_booking_profiles.is_bookable | boolean |
Wskazuje, czy członek zespołu może być zarezerwowany za pośrednictwem interfejsu API rezerwacji, czy w kanale rezerwacji online sprzedawcy lub w witrynie (prawda), czy też za pośrednictwem strony (fałsz). |
|
Errors
|
errors | array of |
Tworzenie lokalizacji (wersja beta)
Tworzy lokalizację.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Name
|
name | string |
Nazwa obiektu. |
|
|
Description
|
description | string |
Opis. |
|
|
Facebook URL
|
facebook_url | string |
Adres URL profilu serwisu Facebook lokalizacji. Adres URL powinien zaczynać się od "facebook.com/". |
|
|
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. |
|
|
Poziom okręgu administracyjnego 1
|
administrative_district_level_1 | string |
Jednostka cywilna w kraju adresu. W USA jest to stan. |
|
|
Miejscowość
|
locality | string |
Miasto lub miasto adresu. |
|
|
Kod pocztowy
|
postal_code | string |
Kod pocztowy adresu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
location.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Name
|
location.name | string |
Nazwa obiektu. |
|
Linia adresowa 1
|
location.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. |
|
Miejscowość
|
location.address.locality | string |
Miasto lub miasto adresu. |
|
Poziom okręgu administracyjnego 1
|
location.address.administrative_district_level_1 | string |
Jednostka cywilna w kraju adresu. W USA jest to stan. |
|
Kod pocztowy
|
location.address.postal_code | string |
Kod pocztowy adresu. |
|
Capabilities
|
location.capabilities | array of string | |
|
Status
|
location.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Utworzono pod adresem
|
location.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Identyfikator sprzedawcy
|
location.merchant_id | string |
Identyfikator sprzedawcy. |
|
Country
|
location.country | string |
Kod kraju ISO 3166 Alpha-2. |
|
Kod języka
|
location.language_code | string |
Kod języka w formacie BCP 47. |
|
Waluta
|
location.currency | string |
3-znakowy kod waluty ISO 4217. |
|
Typ
|
location.type | string |
Typ tego obiektu. |
|
Description
|
location.description | string |
Opis. |
|
Adres URL witryny internetowej
|
location.website_url | string |
Adres URL witryny sieci Web lokalizacji. |
|
Nazwa użytkownika usługi Twitter
|
location.twitter_username | string |
Nazwa użytkownika twittera lokalizacji bez symbolu "@". |
|
Nazwa użytkownika instagrama
|
location.instagram_username | string |
Nazwa użytkownika instagrama lokalizacji bez symbolu "@". |
|
Szerokość
|
location.coordinates.latitude | float |
Szerokość geograficzna współrzędnych wyrażona w stopniach. |
|
Długość
|
location.coordinates.longitude | float |
Długość geograficzna współrzędnych wyrażona w stopniach. |
|
MCK
|
location.mcc | string |
Kod kategorii kupców (MCC) lokalizacji, zgodnie z normą ISO 18245. MCC opisuje rodzaj towarów lub usług sprzedawanych w lokalizacji. |
Tworzenie nagrody lojalnościowej
Tworzy nagrodę lojalnościową. Po utworzeniu nagrody punkty są zablokowane i niedostępne dla kupującego, aby zrealizować kolejną nagrodę.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta lojalnościowego
|
loyalty_account_id | string |
Identyfikator konta lojalnościowego, w którym wystąpiło zdarzenie. |
|
|
Identyfikator warstwy nagrody
|
reward_tier_id | string |
Identyfikator przypisany do kwadratu warstwy nagrody użytej do utworzenia nagrody. |
|
|
Identyfikator zamówienia
|
order_id | 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). |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
reward.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Status
|
reward.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Identyfikator konta lojalnościowego
|
reward.loyalty_account_id | string |
Identyfikator konta lojalnościowego, w którym wystąpiło zdarzenie. |
|
Identyfikator warstwy nagrody
|
reward.reward_tier_id | string |
Identyfikator przypisany do kwadratu warstwy nagrody użytej do utworzenia nagrody. |
|
Punktów
|
reward.points | integer |
Liczba dodanych lub usuniętych punktów. |
|
Identyfikator zamówienia
|
reward.order_id | string |
Identyfikator zamówienia. |
|
Utworzono pod adresem
|
reward.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
reward.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Tworzenie rezerwacji (wersja beta)
Tworzy rezerwację.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator klienta
|
customer_id | string |
Identyfikator tego obiektu reprezentującego klienta. |
|
|
Rozpocznij od
|
start_at | string |
Sygnatura czasowa określająca godzinę początkową tego obiektu w formacie RFC 3339. |
|
|
Identyfikator lokalizacji
|
location_id | string |
Identyfikator lokalizacji. |
|
|
Czas trwania (minuty)
|
duration_minutes | integer |
Przedział czasu w minutach segmentu terminu. |
|
|
Identyfikator członka zespołu
|
team_member_id | string |
Identyfikator obiektu TeamMember reprezentujący członka zespołu zarezerwowanego w tym segmencie. |
|
|
Identyfikator odmiany usługi
|
service_variation_id | string |
Identyfikator obiektu CatalogItemVariation reprezentującego usługę zarezerwowaną w tym segmencie. |
|
|
Wersja odmiany usługi
|
service_variation_version | integer |
Bieżąca wersja odmiany elementu reprezentująca usługę zarezerwowaną w tym segmencie. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
booking.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
wersja
|
booking.version | integer |
Bieżąca wersja tego obiektu. |
|
Status
|
booking.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Utworzono pod adresem
|
booking.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
booking.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
|
Identyfikator lokalizacji
|
booking.location_id | string |
Identyfikator lokalizacji. |
|
Identyfikator klienta
|
booking.customer_id | string |
Identyfikator tego obiektu reprezentującego klienta. |
|
Notatka klienta
|
booking.customer_note | string |
Pole free-text dla klienta do dostarczenia notatek dotyczących rezerwacji. |
|
Uwaga sprzedawcy
|
booking.seller_note | string |
Pole wolnego tekstu dla sprzedawcy do dostarczenia notatek dotyczących rezerwacji. |
|
Rozpocznij od
|
booking.start_at | string |
Sygnatura czasowa określająca godzinę początkową tego obiektu w formacie RFC 3339. |
|
Segment terminu
|
booking.appointment_segments | array of object | |
|
Czas trwania (minuty)
|
booking.appointment_segments.duration_minutes | integer |
Przedział czasu w minutach segmentu terminu. |
|
Identyfikator odmiany usługi
|
booking.appointment_segments.service_variation_id | string |
Identyfikator obiektu CatalogItemVariation reprezentującego usługę zarezerwowaną w tym segmencie. |
|
Identyfikator członka zespołu
|
booking.appointment_segments.team_member_id | string |
Identyfikator obiektu TeamMember reprezentujący członka zespołu zarezerwowanego w tym segmencie. |
|
Wersja odmiany usługi
|
booking.appointment_segments.service_variation_version | integer |
Bieżąca wersja odmiany elementu reprezentująca usługę zarezerwowaną w tym segmencie. |
|
Errors
|
errors | array of |
Tworzenie typu przerwania
Tworzy nowy typ breaktype. BreakType to szablon do tworzenia obiektów przerwania.
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). |
|
|
Identyfikator lokalizacji
|
location_id | string |
Identyfikator lokalizacji. |
|
|
Nazwa przerwania
|
break_name | string |
Czytelna dla tego typu przerwania. Nazwa jest wyświetlana pracownikom w produktach Square. |
|
|
Oczekiwany czas trwania
|
expected_duration | string |
Oczekiwana długość tej przerwy. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precyzja mniejsza niż minuta jest obcinana. |
|
|
Jest płatna
|
is_paid | boolean |
Czy ta przerwa liczy się w stosunku do czasu pracy w celach odszkodowawczych. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
break_type.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator lokalizacji
|
break_type.location_id | string |
Identyfikator lokalizacji. |
|
Nazwa przerwania
|
break_type.break_name | string |
Czytelna dla tego typu przerwania. Nazwa jest wyświetlana pracownikom w produktach Square. |
|
Oczekiwany czas trwania
|
break_type.expected_duration | string |
Oczekiwana długość tej przerwy. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precyzja mniejsza niż minuta jest obcinana. |
|
Jest płatna
|
break_type.is_paid | boolean |
Czy ta przerwa liczy się w stosunku do czasu pracy w celach odszkodowawczych. |
|
wersja
|
break_type.version | integer |
Bieżąca wersja tego obiektu. |
|
Utworzono pod adresem
|
break_type.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
break_type.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Tworzenie wyewidencjonowania
Łączy identyfikator wyewidencjonowania z checkout_page_url, do którego klienci są kierowani w celu dostarczenia informacji o płatności przy użyciu przepływu pracy przetwarzania płatności.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator lokalizacji
|
location_id | True | string |
Identyfikator lokalizacji. |
|
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). |
|
|
Adres URL przekierowania
|
redirect_url | string |
Jeśli na przykład podany adres URL przekierowania to |
|
|
Klucz idempotentności
|
idempotency_key | string |
Określona wartość, która jednoznacznie identyfikuje tę kolejność wśród utworzonych zamówień. Jeśli nie masz pewności, czy określone zamówienie zostało utworzone pomyślnie, możesz spróbować ponownie przy użyciu tego samego klucza idempotentności bez obaw o tworzenie zduplikowanych zamówień. |
|
|
Identyfikator lokalizacji
|
location_id | string |
Wyrażenie zapytania do wyszukiwania dostępności pasujących do określonych identyfikatorów lokalizacji sprzedawcy. |
|
|
Identyfikator klienta
|
customer_id | string |
Identyfikator klienta skojarzonego z zamówieniem. |
|
|
Identyfikator odwołania
|
reference_id | string |
Identyfikator określony przez klienta w celu skojarzenia jednostki w innym systemie z tą kolejnością. |
|
|
Name
|
name | string |
Nazwa elementu. |
|
|
Ilość
|
quantity | string |
Zakupiona ilość, sformatowana jako liczba dziesiętna. Elementy liniowe z ilością 0 są automatycznie usuwane podczas płacenia za lub w inny sposób kończenia zamówienia. |
|
|
Kwota
|
amount | integer |
Kwota. |
|
|
Waluta
|
currency | string |
Waluta. |
|
|
Identyfikator UID rabatu
|
discount_uid | string |
Identyfikator UID rabatu, który reprezentuje zastosowany rabat. Musi odwoływać się do rabatu obecnego w polu order.discounts. To pole jest niezmienne. Aby zmienić rabaty dotyczące elementu wiersza, należy usunąć rabat i dodać go ponownie jako nowy element OrderLineItemAppliedDiscount. |
|
|
Identyfikator UID podatku
|
tax_uid | string |
Identyfikator UID podatku, dla którego ten zastosowany podatek reprezentuje. Musi odwoływać się do podatku obecnego w polu order.tax. To pole jest niezmienne. Aby zmienić podatki dotyczące elementu wiersza, usuń i dodaj nowy element OrderLineItemAppliedTax. |
|
|
UID
|
uid | string |
Unikatowy identyfikator. |
|
|
Typ
|
type | string |
Typ tego obiektu. |
|
|
Procent
|
percentage | string |
Procent podatku jako ciąg reprezentujący liczbę dziesiętną. |
|
|
Scope
|
scope | string |
Wskazuje poziom, na którym ma zastosowanie obiekt. |
|
|
UID
|
uid | string |
Unikatowy identyfikator. |
|
|
Typ
|
type | string |
Typ tego obiektu. |
|
|
Scope
|
scope | string |
Wskazuje poziom, na którym ma zastosowanie obiekt. |
|
|
Kwota
|
amount | integer |
Kwota. |
|
|
Waluta
|
currency | string |
Waluta. |
|
|
Identyfikator lokalizacji
|
location_id | string |
Identyfikator lokalizacji. |
|
|
Description
|
title | string |
Opis. |
|
|
Kwota
|
amount | integer |
Kwota. |
|
|
Waluta
|
currency | string |
Waluta. |
|
|
Poproś o adres wysyłkowy
|
ask_for_shipping_address | boolean |
Jeśli to prawda, Square Checkout zbiera informacje wysyłkowe w Twoim imieniu i przechowuje te informacje z informacjami o transakcji na pulpicie nawigacyjnym sprzedawcy kwadratowego. |
|
|
Adres e-mail pomocy technicznej dla kupców
|
merchant_support_email | string |
Adres e-mail wyświetlany na stronie potwierdzenia wyewidencjonowania kwadratowego i wiadomość e-mail z potwierdzeniem, że kupujący może skontaktować się z sprzedawcą. Jeśli ta wartość nie jest ustawiona, strona potwierdzenia i wiadomość e-mail będą wyświetlać podstawowy adres e-mail skojarzony z kontem Square sprzedawcy. |
|
|
Wstępnie wypełnij wiadomość e-mail kupującego
|
pre_populate_buyer_email | string |
Jeśli zostanie podana wiadomość e-mail kupującego, zostanie wstępnie wypełniona na stronie wyewidencjonowania jako edytowalne pole tekstowe. |
|
|
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. |
|
|
Imię
|
first_name | string |
Opcjonalne imię, gdy reprezentuje adresata. |
|
|
Nazwisko
|
last_name | string |
Opcjonalne nazwisko, gdy reprezentuje adresata. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
checkout.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Adres URL strony wyewidencjonowania
|
checkout.checkout_page_url | string |
Adres URL, do którego powinna zostać przekierowana przeglądarka kupującego po zakończeniu wyewidencjonowania. |
|
Poproś o adres wysyłkowy
|
checkout.ask_for_shipping_address | boolean |
Jeśli to prawda, Square Checkout będzie zbierać informacje wysyłkowe w Twoim imieniu i przechowywać te informacje z informacjami o transakcji na pulpicie nawigacyjnym Square. |
|
Adres e-mail pomocy technicznej dla kupców
|
checkout.merchant_support_email | string |
Adres e-mail wyświetlany na stronie potwierdzenia wyewidencjonowania kwadratowego i wiadomość e-mail z potwierdzeniem, że kupujący może skontaktować się z sprzedawcą. |
|
Wstępnie wypełnij wiadomość e-mail kupującego
|
checkout.pre_populate_buyer_email | string |
Jeśli zostanie podana wiadomość e-mail kupującego, zostanie wstępnie wypełniona na stronie wyewidencjonowania jako edytowalne pole tekstowe. |
|
Linia adresowa 1
|
checkout.pre_populate_shipping_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
|
checkout.pre_populate_shipping_address.address_line_2 | string |
Drugi wiersz adresu, jeśli istnieje. |
|
Miejscowość
|
checkout.pre_populate_shipping_address.locality | string |
Miasto lub miasto adresu. |
|
Poziom okręgu administracyjnego 1
|
checkout.pre_populate_shipping_address.administrative_district_level_1 | string |
Jednostka cywilna w kraju adresu. W USA jest to stan. |
|
Kod pocztowy
|
checkout.pre_populate_shipping_address.postal_code | string |
Kod pocztowy adresu. |
|
Country
|
checkout.pre_populate_shipping_address.country | string |
Kraj adresu w formacie ISO 3166-1-alfa-2. |
|
Imię
|
checkout.pre_populate_shipping_address.first_name | string |
Opcjonalne imię, gdy reprezentuje adresata. |
|
Nazwisko
|
checkout.pre_populate_shipping_address.last_name | string |
Opcjonalna nazwa lsat, gdy reprezentuje adresata. |
|
Adres URL przekierowania
|
checkout.redirect_url | string |
Adres URL do przekierowania do adresu po zakończeniu wyewidencjonowania z wartością checkoutId, orderId square, transactionId i referenceId dołączony jako parametry adresu URL. Jeśli na przykład podana redirect_url to |
|
Identyfikator lokalizacji
|
checkout.order.location_id | string |
Wyrażenie zapytania do wyszukiwania dostępności pasujących do określonych identyfikatorów lokalizacji sprzedawcy. |
|
Identyfikator klienta
|
checkout.order.customer_id | string |
Identyfikator klienta skojarzonego z zamówieniem. |
|
Identyfikator odwołania
|
checkout.order.reference_id | string |
Identyfikator określony przez klienta w celu skojarzenia jednostki w innym systemie z tą kolejnością. |
|
Elementy wiersza
|
checkout.order.line_items | array of object | |
|
Name
|
checkout.order.line_items.name | string |
Nazwa elementu wiersza. |
|
Ilość
|
checkout.order.line_items.quantity | string |
Zakupiona ilość, sformatowana jako liczba dziesiętna. Elementy liniowe z ilością 0 są automatycznie usuwane podczas płacenia za lub w inny sposób kończenia zamówienia. |
|
Zastosowane podatki
|
checkout.order.line_items.applied_taxes | array of object | |
|
Identyfikator UID podatku
|
checkout.order.line_items.applied_taxes.tax_uid | string |
Identyfikator UID podatku, dla którego ten zastosowany podatek reprezentuje. Musi odwoływać się do podatku obecnego w polu order.tax. To pole jest niezmienne. Aby zmienić podatki dotyczące elementu wiersza, usuń i dodaj nowy element OrderLineItemAppliedTax. |
|
Kwota
|
checkout.order.line_items.applied_taxes.applied_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
|
checkout.order.line_items.applied_taxes.applied_money.currency | string |
Typ waluty w formacie ISO 4217. Na przykład kod waluty dla dolarów amerykańskich to USD. |
|
Zastosowane rabaty
|
checkout.order.line_items.applied_discounts | array of object | |
|
Identyfikator UID rabatu
|
checkout.order.line_items.applied_discounts.discount_uid | string |
Identyfikator UID rabatu, który reprezentuje zastosowany rabat. Musi odwoływać się do rabatu obecnego w polu order.discounts. To pole jest niezmienne. Aby zmienić rabaty dotyczące elementu wiersza, należy usunąć rabat i dodać go ponownie jako nowy element OrderLineItemAppliedDiscount. |
|
Kwota
|
checkout.order.line_items.applied_discounts.applied_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
|
checkout.order.line_items.applied_discounts.applied_money.currency | string |
Typ waluty w formacie ISO 4217. Na przykład kod waluty dla dolarów amerykańskich to USD. |
|
Kwota
|
checkout.order.line_items.base_price_money.amount | integer |
Kwota. |
|
Waluta
|
checkout.order.line_items.base_price_money.currency | string |
Waluta. |
|
Kwota
|
checkout.order.line_items.total_tax_money.amount | integer |
Kwota. |
|
Waluta
|
checkout.order.line_items.total_tax_money.currency | string |
Waluta. |
|
Kwota
|
checkout.order.line_items.total_discount_money.amount | integer |
Kwota. |
|
Waluta
|
checkout.order.line_items.total_discount_money.currency | string |
Waluta. |
|
Kwota
|
checkout.order.line_items.total_money.amount | integer |
Kwota. |
|
Waluta
|
checkout.order.line_items.total_money.currency | string |
Waluta. |
|
Podatki
|
checkout.order.taxes | array of object | |
|
UID
|
checkout.order.taxes.uid | string |
Unikatowy identyfikator. |
|
Typ
|
checkout.order.taxes.type | string |
Typ tego obiektu. |
|
Procent
|
checkout.order.taxes.percentage | string |
Procent podatku jako ciąg reprezentujący liczbę dziesiętną. |
|
Scope
|
checkout.order.taxes.scope | string |
Wskazuje poziom, na którym ma zastosowanie obiekt. |
|
Rabaty
|
checkout.order.discounts | array of object | |
|
UID
|
checkout.order.discounts.uid | string |
Unikatowy identyfikator. |
|
Typ
|
checkout.order.discounts.type | string |
Typ tego obiektu. |
|
Scope
|
checkout.order.discounts.scope | string |
Wskazuje poziom, na którym ma zastosowanie obiekt. |
|
Kwota
|
checkout.order.discounts.amount_money.amount | integer |
Kwota. |
|
Waluta
|
checkout.order.discounts.amount_money.currency | string |
Waluta. |
|
Kwota
|
checkout.order.discounts.applied_money.amount | integer |
Kwota. |
|
Waluta
|
checkout.order.discounts.applied_money.currency | string |
Waluta. |
|
Kwota
|
checkout.order.total_money.amount | integer |
Kwota. |
|
Waluta
|
checkout.order.total_money.currency | string |
Waluta. |
|
Kwota
|
checkout.order.total_tax_money.amount | integer |
Kwota. |
|
Waluta
|
checkout.order.total_tax_money.currency | string |
Waluta. |
|
Kwota
|
checkout.order.total_discount_money.amount | integer |
Kwota. |
|
Waluta
|
checkout.order.total_discount_money.currency | string |
Waluta. |
|
Utworzono pod adresem
|
checkout.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
wersja
|
checkout.version | integer |
Bieżąca wersja tego obiektu. |
|
Dodatkowi adresaci
|
checkout.additional_recipients | array of object | |
|
Identyfikator lokalizacji
|
checkout.additional_recipients.location_id | string |
Identyfikator lokalizacji odbiorcy (innej niż kupca) otrzymującej część tego przetargu. |
|
Description
|
checkout.additional_recipients.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. |
|
Kwota
|
checkout.additional_recipients.amount_money.amount | integer |
Kwota. |
|
Waluta
|
checkout.additional_recipients.amount_money.currency | string |
Waluta. |
Typ przerwania aktualizacji
Aktualizuje istniejący typ przerwania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | string |
Identyfikator. |
|
Identyfikator lokalizacji
|
location_id | string |
Identyfikator lokalizacji. |
|
|
Nazwa przerwania
|
break_name | string |
Czytelna dla tego typu przerwania. Nazwa jest wyświetlana pracownikom w produktach Square. |
|
|
Oczekiwany czas trwania
|
expected_duration | string |
Oczekiwana długość tej przerwy. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precyzja mniejsza niż minuta jest obcinana. |
|
|
Jest płatna
|
is_paid | boolean |
Czy ta przerwa liczy się w stosunku do czasu pracy w celach odszkodowawczych. |
|
|
wersja
|
version | integer |
Bieżąca wersja tego obiektu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
break_type.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator lokalizacji
|
break_type.location_id | string |
Identyfikator lokalizacji. |
|
Nazwa przerwania
|
break_type.break_name | string |
Czytelna dla tego typu przerwania. Nazwa jest wyświetlana pracownikom w produktach Square. |
|
Oczekiwany czas trwania
|
break_type.expected_duration | string |
Oczekiwana długość tej przerwy. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precyzja mniejsza niż minuta jest obcinana. |
|
Jest płatna
|
break_type.is_paid | boolean |
Czy ta przerwa liczy się w stosunku do czasu pracy w celach odszkodowawczych. |
|
wersja
|
break_type.version | integer |
Bieżąca wersja tego obiektu. |
|
Utworzono pod adresem
|
break_type.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
break_type.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Typy podziału listy
Zwraca listę podzielonych na strony wystąpień BreakType dla firmy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator lokalizacji
|
location_id | string |
Możesz określić ten opcjonalny filtr, aby pobrać tylko rekordy należące do określonej lokalizacji. |
|
|
Ograniczenie
|
limit | integer |
Górny limit liczby do zwrócenia w odpowiedzi. |
|
|
Cursor
|
cursor | string |
Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Typy przerwań
|
break_types | array of object | |
|
identyfikator
|
break_types.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator lokalizacji
|
break_types.location_id | string |
Identyfikator lokalizacji. |
|
Nazwa przerwania
|
break_types.break_name | string |
Czytelna dla tego typu przerwania. Nazwa jest wyświetlana pracownikom w produktach Square. |
|
Oczekiwany czas trwania
|
break_types.expected_duration | string |
Oczekiwana długość tej przerwy. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precyzja mniejsza niż minuta jest obcinana. |
|
Jest płatna
|
break_types.is_paid | boolean |
Czy ta przerwa liczy się w stosunku do czasu pracy w celach odszkodowawczych. |
|
wersja
|
break_types.version | integer |
Bieżąca wersja obiektu. |
|
Utworzono pod adresem
|
break_types.created_at | string |
Czas zdarzenia w formacie ISO 8601. |
|
Zaktualizowano o
|
break_types.updated_at | string |
Znacznik czasu ostatniej modyfikacji w formacie RFC 3339 |
|
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. |
Usuwanie fragmentu kodu
Usuwa fragment kodu z witryny Square Online.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator lokalizacji
|
site_id | True | string |
Identyfikator witryny. |
Zwraca
- response
- object
Usuwanie nagrody lojalnościowej
Usuwa nagrodę lojalnościową. Zwraca punkty lojalnościowe z powrotem do konta lojalnościowego. Nie można usunąć nagrody, która osiągnęła stan terminalu (REDEEMED).
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator nagrody
|
reward_id | True | string |
Identyfikator nagrody. |
Zwraca
- response
- object
Usuń przesunięcie
Usuwa przesunięcie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | string |
Identyfikator. |
Zwraca
- response
- object
Usuń typ przerwania
Usuwa istniejący typ przerwania. Typ przerwania można usunąć, nawet jeśli odwołuje się do niego shift.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | string |
Identyfikator. |
Zwraca
- response
- object
Utwórz zmianę
Tworzy nową zmianę. Zmiana reprezentuje kompletny dzień roboczy dla jednego pracownika
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). |
|
|
Identyfikator członka zespołu
|
team_member_id | string |
Identyfikator członka zespołu. |
|
|
Identyfikator lokalizacji
|
location_id | string |
Identyfikator lokalizacji. |
|
|
Rozpocznij od
|
start_at | string |
Sygnatura czasowa określająca godzinę początkową tego obiektu w formacie RFC 3339. |
|
|
Koniec od
|
end_at | string |
RFC 3339; przesunięte na strefę czasową i przesunięcie. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
|
Title
|
title | string |
Nazwa zadania wykonywanego podczas tej zmiany. Kwadratowe interfejsy użytkownika raportowania pracy mogą grupować zmiany według tytułu. |
|
|
Kwota
|
amount | integer |
Kwota. |
|
|
Waluta
|
currency | string |
Waluta. |
|
|
Rozpocznij od
|
start_at | string |
RFC 3339; jest zgodny z tymi samymi informacjami o strefie czasowej co Shift. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
|
Koniec od
|
end_at | string |
RFC 3339; jest zgodny z tymi samymi informacjami o strefie czasowej co Shift. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
|
Identyfikator typu przerwania
|
break_type_id | string |
BreakType, dla którego utworzono ten podział. |
|
|
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. |
|
|
Oczekiwany czas trwania
|
expected_duration | string |
Oczekiwana długość przerwy. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. |
|
|
Jest płatna
|
is_paid | boolean |
Czy ta przerwa liczy się w stosunku do czasu pracy w celach odszkodowawczych. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
shift.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator członka zespołu
|
shift.team_member_id | string |
Identyfikator członka zespołu. |
|
Identyfikator pracownika
|
shift.employee_id | string |
Identyfikator wygenerowany kwadratowo pracownika. |
|
Identyfikator lokalizacji
|
shift.location_id | string |
Identyfikator lokalizacji. |
|
Timezone
|
shift.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. |
|
Rozpocznij od
|
shift.start_at | string |
Sygnatura czasowa określająca godzinę początkową tego obiektu w formacie RFC 3339. |
|
Koniec od
|
shift.end_at | string |
RFC 3339; przesunięte na strefę czasową i przesunięcie. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
Title
|
shift.wage.title | string |
Nazwa zadania wykonywanego podczas tej zmiany. Kwadratowe interfejsy użytkownika raportowania pracy mogą grupować zmiany według tytułu. |
|
Kwota
|
shift.wage.hourly_rate.amount | integer |
Kwota. |
|
Waluta
|
shift.wage.hourly_rate.currency | string |
Waluta. |
|
Przerwy
|
shift.breaks | array of object | |
|
identyfikator
|
shift.breaks.id | string |
Identyfikator obiektu |
|
Rozpocznij od
|
shift.breaks.start_at | string |
RFC 3339; jest zgodny z tymi samymi informacjami o strefie czasowej co Shift. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
Koniec od
|
shift.breaks.end_at | string |
RFC 3339; jest zgodny z tymi samymi informacjami o strefie czasowej co Shift. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
Identyfikator typu przerwania
|
shift.breaks.break_type_id | string |
BreakType, dla którego utworzono ten podział. |
|
Name
|
shift.breaks.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. |
|
Oczekiwany czas trwania
|
shift.breaks.expected_duration | string |
Oczekiwana długość przerwy. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. |
|
Jest płatna
|
shift.breaks.is_paid | boolean |
Czy ta przerwa liczy się w stosunku do czasu pracy w celach odszkodowawczych. |
|
Status
|
shift.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
wersja
|
shift.version | integer |
Bieżąca wersja tego obiektu. |
|
Utworzono pod adresem
|
shift.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
shift.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Uzyskiwanie konta bankowego
Zwraca szczegóły konta BankAccount połączonego z kontem kwadratowym.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta bankowego
|
bank_account_id | True | string |
Identyfikator wystawiony na kwadrat żądanego konta BankAccount. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
bank_account.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Sufiks numeru konta
|
bank_account.account_number_suffix | string |
Ostatnie kilka cyfr numeru konta. |
|
Country
|
bank_account.country | string |
Kod kraju ISO 3166 Alpha-2. |
|
Waluta
|
bank_account.currency | string |
3-znakowy kod waluty ISO 4217. |
|
Typ konta
|
bank_account.account_type | string |
Typ konta. |
|
Nazwa posiadacza
|
bank_account.holder_name | string |
Nazwa właściciela konta. |
|
Podstawowy numer identyfikacyjny banku
|
bank_account.primary_bank_identification_number | string |
Podstawowy identyfikator banku. |
|
Identyfikator lokalizacji
|
bank_account.location_id | string |
Identyfikator lokalizacji. |
|
Status
|
bank_account.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Wiarygodne
|
bank_account.creditable | boolean |
Wskazuje, czy kwadrat może wysyłać pieniądze na to konto. |
|
Możliwe do zapłaty
|
bank_account.debitable | boolean |
Wskazuje, czy kwadrat może pobrać pieniądze z tego konta. |
|
wersja
|
bank_account.version | integer |
Bieżąca wersja tego obiektu. |
|
Nazwa banku
|
bank_account.bank_name | string |
Nazwa rzeczywistej instytucji finansowej. |
Wyszukaj nagrody lojalnościowe
Wyszukuje nagrody lojalnościowe na koncie lojalnościowym.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator konta lojalnościowego
|
loyalty_account_id | string |
Identyfikator konta lojalnościowego, w którym wystąpiło zdarzenie. |
|
|
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 |
|---|---|---|---|
|
Nagrody
|
rewards | array of object | |
|
identyfikator
|
rewards.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Status
|
rewards.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Identyfikator konta lojalnościowego
|
rewards.loyalty_account_id | string |
Identyfikator konta lojalnościowego, w którym wystąpiło zdarzenie. |
|
Identyfikator warstwy nagrody
|
rewards.reward_tier_id | string |
Identyfikator przypisany do kwadratu warstwy nagrody użytej do utworzenia nagrody. |
|
Punktów
|
rewards.points | integer |
Liczba punktów lojalnościowych używanych do nagrody. |
|
Identyfikator zamówienia
|
rewards.order_id | string |
Identyfikator zamówienia. |
|
Utworzono pod adresem
|
rewards.created_at | string |
Czas zdarzenia w formacie ISO 8601. |
|
Zaktualizowano o
|
rewards.updated_at | string |
Znacznik czasu ostatniej modyfikacji w formacie RFC 3339 |
|
Zrealizowano na
|
rewards.redeemed_at | string |
Znacznik czasu, kiedy nagroda została zrealizowana, w formacie RFC 3339. |
Wyszukiwanie kont lojalnościowych
Wyszukuje konta lojalnościowe w programie lojalnościowym.
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. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Konta lojalnościowe
|
loyalty_accounts | array of object | |
|
identyfikator
|
loyalty_accounts.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
identyfikator
|
loyalty_accounts.mapping.id | string |
Identyfikator obiektu |
|
Numer telefonu
|
loyalty_accounts.mapping.phone_number | string |
Numer telefonu odbiorcy. |
|
Utworzono pod adresem
|
loyalty_accounts.mapping.created_at | string |
Sygnatura czasowa utworzona w formacie RFC 3339. |
|
Identyfikator programu
|
loyalty_accounts.program_id | string |
Identyfikator przypisany do kwadratu programu lojalnościowego, do którego należy konto. |
|
Saldo
|
loyalty_accounts.balance | integer |
Dostępne saldo punktów na koncie lojalnościowym. |
|
Punkty istnienia
|
loyalty_accounts.lifetime_points | integer |
Łączna liczba punktów naliczanych w okresie istnienia konta. |
|
Identyfikator klienta
|
loyalty_accounts.customer_id | string |
Identyfikator przypisany do kwadratu klienta skojarzonego z kontem. |
|
Utworzono pod adresem
|
loyalty_accounts.created_at | string |
Czas zdarzenia w formacie ISO 8601. |
|
Zaktualizowano o
|
loyalty_accounts.updated_at | string |
Znacznik czasu ostatniej modyfikacji w formacie RFC 3339 |
|
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 zdarzeń lojalnościowych
Wyszukuje wydarzenia lojalnościowe. Program lojalnościowy Square utrzymuje rejestr wydarzeń, które występują w okresie istnienia konta lojalnościowego nabywcy. Każda zmiana salda punktów (na przykład punkty uzyskane, zrealizowane punkty i punkty wygasłe) jest rejestrowana w rejestrze. Korzystając z tego punktu końcowego, możesz wyszukać rejestr zdarzeń.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zamówienia
|
order_id | string |
Identyfikator zamówienia. |
|
|
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 |
|---|---|---|---|
|
Events
|
events | array of object | |
|
identyfikator
|
events.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Typ
|
events.type | string |
Typ tego obiektu. |
|
Utworzono pod adresem
|
events.created_at | string |
Czas zdarzenia w formacie ISO 8601. |
|
Identyfikator programu lojalnościowego
|
events.accumulate_points.loyalty_program_id | string |
Identyfikator programu lojalnościowego |
|
Punktów
|
events.accumulate_points.points | integer |
Liczba punktów zebranych przez zdarzenie. |
|
Identyfikator zamówienia
|
events.accumulate_points.order_id | string |
Identyfikator zamówienia skojarzonego z działaniem. |
|
Identyfikator konta lojalnościowego
|
events.loyalty_account_id | string |
Identyfikator konta lojalnościowego, w którym wystąpiło zdarzenie. |
|
Identyfikator lokalizacji
|
events.location_id | string |
Identyfikator lokalizacji. |
|
Źródło
|
events.source | string |
Określa, czy zdarzenie zostało wygenerowane przez square point of Sale. |
|
Identyfikator programu lojalnościowego
|
events.redeem_reward.loyalty_program_id | string |
Identyfikator programu lojalnościowego |
|
Identyfikator nagrody
|
events.redeem_reward.reward_id | string |
Identyfikator odkupionej nagrody lojalnościowej. |
|
Identyfikator zamówienia
|
events.redeem_reward.order_id | string |
Identyfikator zamówienia skojarzonego z działaniem. |
|
Identyfikator programu lojalnościowego
|
events.create_reward.loyalty_program_id | string |
Identyfikator programu lojalnościowego |
|
Identyfikator nagrody
|
events.create_reward.reward_id | string |
Identyfikator odkupionej nagrody lojalnościowej. |
|
Punktów
|
events.create_reward.points | integer |
Liczba punktów zebranych przez zdarzenie. |
Wyświetlanie listy działań związanych z kartą upominkową (beta)
Wyświetla listę działań związanych z kartą upominkową. Domyślnie otrzymujesz działania związane z kartami upominkowymi dla wszystkich kart upominkowych na koncie sprzedawcy. Opcjonalnie możesz określić parametry zapytania, aby filtrować listę. Możesz na przykład uzyskać listę działań związanych z kartą upominkową dla karty upominkowej, dla wszystkich kart upominkowych w określonym regionie lub w ramach działań w danym przedziale czasu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator karty upominkowej
|
gift_card_id | string |
Jeśli podasz identyfikator karty upominkowej, punkt końcowy zwróci działania należące do określonej karty upominkowej. W przeciwnym razie punkt końcowy zwraca wszystkie działania dotyczące karty upominkowej dla sprzedawcy. |
|
|
Typ
|
type | string |
Jeśli podasz typ, punkt końcowy zwróci działania dotyczące karty upominkowej tego typu. W przeciwnym razie punkt końcowy zwraca wszystkie typy działań związanych z kartą upominkową. |
|
|
Identyfikator lokalizacji
|
location_id | string |
Możesz określić ten opcjonalny filtr, aby pobrać tylko rekordy należące do określonej lokalizacji. |
|
|
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. |
|
|
Ograniczenie
|
limit | integer |
Górny limit liczby do zwrócenia w odpowiedzi. |
|
|
Cursor
|
cursor | string |
Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego. |
|
|
Kolejność sortowania
|
sort_order | string |
Sortuje zwracaną listę według momentu utworzenia karty z określonym zamówieniem. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Działania związane z kartą upominkową
|
gift_card_activities | array of object | |
|
identyfikator
|
gift_card_activities.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Typ
|
gift_card_activities.type | string |
Typ tego obiektu. |
|
Identyfikator lokalizacji
|
gift_card_activities.location_id | string |
Identyfikator lokalizacji. |
|
Utworzono pod adresem
|
gift_card_activities.created_at | string |
Czas zdarzenia w formacie ISO 8601. |
|
Identyfikator karty upominkowej
|
gift_card_activities.gift_card_id | string |
Identyfikator karty upominkowej. Identyfikator nie jest wymagany, jeśli jest obecny wykres GAN. |
|
Karta upominkowa GAN
|
gift_card_activities.gift_card_gan | string |
Karta upominkowa GAN. Wykres GAN nie jest wymagany, jeśli gift_card_id jest obecny. |
|
Kwota
|
gift_card_activities.gift_card_balance_money.amount | integer |
Kwota. |
|
Waluta
|
gift_card_activities.gift_card_balance_money.currency | string |
Waluta. |
|
Kwota
|
gift_card_activities.redeem_activity_details.amount_money.amount | integer |
Kwota. |
|
Waluta
|
gift_card_activities.redeem_activity_details.amount_money.currency | string |
Waluta. |
|
Kwota
|
gift_card_activities.activate_activity_details.amount_money.amount | integer |
Kwota. |
|
Waluta
|
gift_card_activities.activate_activity_details.amount_money.currency | string |
Waluta. |
|
Identyfikator zamówienia
|
gift_card_activities.activate_activity_details.order_id | string |
Identyfikator zamówienia skojarzonego z działaniem. |
|
Identyfikator UID elementu wiersza
|
gift_card_activities.activate_activity_details.line_item_uid | string |
Line_item_uid elementu linii karty upominkowej w zamówieniu. |
Wyświetlanie listy kodów urządzeń
Wyświetla listę wszystkich kodów urządzeń skojarzonych z sprzedawcą.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
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. |
|
|
Typ produktu
|
product_type | string |
Jeśli zostanie określony, zwraca tylko wartości DeviceCodes przeznaczone dla określonego typu produktu. Zwraca wartość DeviceCodes wszystkich typów produktów, jeśli jest pusta. |
|
|
Status
|
status | string |
Jeśli zostanie określony, zwraca tylko obiekty zgodne z określonymi stanami. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Kody urządzeń
|
device_codes | array of object | |
|
identyfikator
|
device_codes.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Name
|
device_codes.name | string |
Nazwa obiektu. |
|
Code
|
device_codes.code | string |
Unikatowy kod, który może służyć do logowania. |
|
Typ produktu
|
device_codes.product_type | string |
Docelowy typ produktu w kodzie urządzenia. |
|
Identyfikator lokalizacji
|
device_codes.location_id | string |
Identyfikator lokalizacji. |
|
Utworzono pod adresem
|
device_codes.created_at | string |
Czas zdarzenia w formacie ISO 8601. |
|
Paruj według
|
device_codes.pair_by | string |
Gdy kod urządzenia wygaśnie i nie zaloguje się już. Sygnatura czasowa w formacie RFC 3339. |
|
Status
|
device_codes.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Identyfikator urządzenia
|
device_codes.device_id | string |
Unikatowy identyfikator urządzenia, które używało tego kodu. Wypełniane, gdy urządzenie jest sparowane. |
|
Stan zmieniony o
|
device_codes.status_changed_at | string |
Gdy stan tego kodu urządzenia został ostatnio zmieniony. Sygnatura czasowa w formacie RFC 3339. |
Wyświetlanie listy konfiguracji workweek
Zwraca listę wystąpień workweekConfig dla firmy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Ograniczenie
|
limit | integer |
Górny limit liczby do zwrócenia w odpowiedzi. |
|
|
Cursor
|
cursor | string |
Kursor stronicowania zwrócony przez poprzednie wywołanie tego punktu końcowego. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Konfiguracje workweek
|
workweek_configs | array of object | |
|
identyfikator
|
workweek_configs.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Początek tygodnia
|
workweek_configs.start_of_week | string |
Dzień tygodnia, w którym kończy się tydzień roboczy w celach odszkodowawczych. |
|
Godzina rozpoczęcia dnia lokalnego
|
workweek_configs.start_of_day_local_time | string |
Czas lokalny, w którym kończy się tydzień roboczy. Reprezentowane jako ciąg w formacie HH:MM (HH:MM:SS jest również akceptowane, ale sekundy są obcinane). |
|
wersja
|
workweek_configs.version | integer |
Bieżąca wersja obiektu. |
|
Utworzono pod adresem
|
workweek_configs.created_at | string |
Czas zdarzenia w formacie ISO 8601. |
|
Zaktualizowano o
|
workweek_configs.updated_at | string |
Znacznik czasu ostatniej modyfikacji w formacie RFC 3339 |
|
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 kont bankowych
Zwraca listę obiektów BankAccount połączonych z kontem square.
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. |
|
|
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 |
|---|---|---|---|
|
Konto
|
bank_accounts | array of object | |
|
identyfikator
|
bank_accounts.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Sufiks numeru konta
|
bank_accounts.account_number_suffix | string |
Ostatnie kilka cyfr numeru konta. |
|
Country
|
bank_accounts.country | string |
Kod kraju ISO 3166 Alpha-2. |
|
Waluta
|
bank_accounts.currency | string |
3-znakowy kod waluty ISO 4217. |
|
Typ konta
|
bank_accounts.account_type | string |
Cel finansowy skojarzonego konta bankowego. |
|
Nazwa posiadacza
|
bank_accounts.holder_name | string |
Nazwa właściciela konta. Ta nazwa musi być zgodna z nazwą docelowego rekordu konta bankowego. |
|
Podstawowy numer identyfikacyjny banku
|
bank_accounts.primary_bank_identification_number | string |
Podstawowy identyfikator banku. |
|
Identyfikator lokalizacji
|
bank_accounts.location_id | string |
Identyfikator lokalizacji. |
|
Status
|
bank_accounts.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Wiarygodne
|
bank_accounts.creditable | boolean |
Wskazuje, czy kwadrat może wysłać pieniądze na to konto bankowe. |
|
Możliwe do zapłaty
|
bank_accounts.debitable | boolean |
Wskazuje, czy kwadrat może wysłać pieniądze na to konto bankowe. |
|
wersja
|
bank_accounts.version | integer |
Bieżąca wersja obiektu. |
|
Nazwa banku
|
bank_accounts.bank_name | string |
Nazwa rzeczywistej instytucji finansowej. |
Wyświetlanie listy lokalizacji
Zawiera informacje o wszystkich lokalizacjach firmy.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Lokalizacje
|
locations | array of object | |
|
identyfikator
|
locations.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Name
|
locations.name | string |
Nazwa obiektu. |
|
Linia adresowa 1
|
locations.address.address_line_1 | string |
Pierwszy wiersz adresu. |
|
Miejscowość
|
locations.address.locality | string |
Miasto lub miasto adresu. |
|
Poziom okręgu administracyjnego 1
|
locations.address.administrative_district_level_1 | string |
Jednostka cywilna w kraju adresu. W USA jest to stan. |
|
Kod pocztowy
|
locations.address.postal_code | string |
Kod pocztowy adresu. |
|
Country
|
locations.address.country | string |
Kraj adresu w formacie ISO 3166-1-alfa-2. |
|
Timezone
|
locations.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. |
|
Capabilities
|
locations.capabilities | array of string | |
|
Status
|
locations.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
Utworzono pod adresem
|
locations.created_at | string |
Czas zdarzenia w formacie ISO 8601. |
|
Identyfikator sprzedawcy
|
locations.merchant_id | string |
Identyfikator sprzedawcy, który jest właścicielem lokalizacji. |
|
Country
|
locations.country | string |
Kod kraju ISO 3166 Alpha-2. |
|
Kod języka
|
locations.language_code | string |
Język skojarzony z lokalizacją w formacie BCP 47. |
|
Waluta
|
locations.currency | string |
3-znakowy kod waluty ISO 4217. |
|
Numer telefonu
|
locations.phone_number | string |
11-cyfrowy numer telefonu skojarzony z profilem klienta. |
|
Nazwa firmy
|
locations.business_name | string |
Nazwa biznesowa lokalizacji To jest nazwa widoczna dla klientów lokalizacji. Na przykład ta nazwa jest wyświetlana na paragonach klientów. |
Wyświetlanie listy witryn
Wyświetla listę witryn Square Online należących do sprzedawcy.
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Sites
|
sites | array of object | |
|
identyfikator
|
sites.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Tytuł witryny
|
sites.site_title | string |
Tytuł witryny. |
|
Domena
|
sites.domain | string |
Domena lokacji (bez protokołu). |
|
Jest publikowany
|
sites.is_published | boolean |
Wskazuje, czy witryna jest opublikowana. |
|
Utworzono pod adresem
|
sites.created_at | string |
Czas zdarzenia w formacie ISO 8601. |
|
Zaktualizowano o
|
sites.updated_at | string |
Znacznik czasu ostatniej modyfikacji w formacie RFC 3339 |
Zbiorcze aktualizowanie członków zespołu
Aktualizuje wiele obiektów TeamMember.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator odwołania
|
reference_id | string |
Drugi identyfikator używany do skojarzenia członka zespołu z jednostką w innym systemie. |
|
|
Jest właścicielem
|
is_owner | boolean |
Czy członek zespołu jest właścicielem konta Square. |
|
|
Status
|
status | string |
Opisuje stan członka zespołu. |
|
|
Imię
|
given_name | string |
Podana nazwa (czyli imię) skojarzona z członkiem zespołu. |
|
|
Nazwisko
|
family_name | string |
Nazwa rodziny (czyli nazwisko) skojarzona z członkiem zespołu. |
|
|
Adres e-mail
|
email_address | string |
Adres e-mail skojarzony z członkiem zespołu. |
|
|
Numer telefonu
|
phone_number | string |
Numer telefonu członka zespołu w formacie E.164. |
|
|
Identyfikatory lokalizacji
|
location_ids | array of string | ||
|
Typ przypisania
|
assignment_type | string |
Bieżący typ przypisania członka zespołu. |
|
|
Identyfikator odwołania
|
reference_id | string |
Drugi identyfikator używany do skojarzenia członka zespołu z jednostką w innym systemie. |
|
|
Jest właścicielem
|
is_owner | boolean |
Czy członek zespołu jest właścicielem konta Square. |
|
|
Status
|
status | string |
Opisuje stan członka zespołu. |
|
|
Imię
|
given_name | string |
Podana nazwa (czyli imię) skojarzona z członkiem zespołu. |
|
|
Nazwisko
|
family_name | string |
Nazwa rodziny (czyli nazwisko) skojarzona z członkiem zespołu. |
|
|
Adres e-mail
|
email_address | string |
Adres e-mail skojarzony z członkiem zespołu. |
|
|
Numer telefonu
|
phone_number | string |
Numer telefonu członka zespołu w formacie E.164. |
|
|
Typ przypisania
|
assignment_type | string |
Bieżący typ przypisania członka zespołu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
team_members.team_member_id.team_member.id | string |
Identyfikator odwołujący się do tego obiektu. |
|
Identyfikator odwołania
|
team_members.team_member_id.team_member.reference_id | string |
Drugi identyfikator używany do skojarzenia członka zespołu z jednostką w innym systemie. |
|
Jest właścicielem
|
team_members.team_member_id.team_member.is_owner | boolean |
Czy członek zespołu jest właścicielem konta Square. |
|
Status
|
team_members.team_member_id.team_member.status | string |
Opisuje stan członka zespołu. |
|
Imię
|
team_members.team_member_id.team_member.given_name | string |
Podana nazwa (czyli imię) skojarzona z członkiem zespołu. |
|
Nazwisko
|
team_members.team_member_id.team_member.family_name | string |
Nazwa rodziny (czyli nazwisko) skojarzona z członkiem zespołu. |
|
Adres e-mail
|
team_members.team_member_id.team_member.email_address | string |
Adres e-mail skojarzony z członkiem zespołu. |
|
Numer telefonu
|
team_members.team_member_id.team_member.phone_number | string |
Numer telefonu członka zespołu w formacie E.164. |
|
Utworzono pod adresem
|
team_members.team_member_id.team_member.created_at | string |
Znacznik czasu w formacie RFC 3339 opisujący, kiedy członek zespołu został utworzony |
|
Typ przypisania
|
team_members.team_member_id.team_member.assigned_locations.assignment_type | string |
Bieżący typ przypisania członka zespołu. |
|
Identyfikatory lokalizacji
|
team_members.team_member_id.team_member.assigned_locations.location_ids | array of string |
Zbiorcze tworzenie członków zespołu
Tworzy wiele obiektów TeamMember.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Imię
|
given_name | string |
Podana nazwa (czyli imię) skojarzona z członkiem zespołu. |
|
|
Nazwisko
|
family_name | string |
Nazwa rodziny (czyli nazwisko) skojarzona z członkiem zespołu. |
|
|
Adres e-mail
|
email_address | string |
Adres e-mail skojarzony z członkiem zespołu. |
|
|
Identyfikator odwołania
|
reference_id | string |
Drugi identyfikator używany do skojarzenia członka zespołu z jednostką w innym systemie. |
|
|
Numer telefonu
|
phone_number | string |
Numer telefonu członka zespołu w formacie E.164. |
|
|
Identyfikatory lokalizacji
|
location_ids | array of string | ||
|
Typ przypisania
|
assignment_type | string |
Bieżący typ przypisania członka zespołu. |
|
|
Imię
|
given_name | string |
Podana nazwa (czyli imię) skojarzona z członkiem zespołu. |
|
|
Nazwisko
|
family_name | string |
Nazwa rodziny (czyli nazwisko) skojarzona z członkiem zespołu. |
|
|
Adres e-mail
|
email_address | string |
Adres e-mail skojarzony z członkiem zespołu. |
|
|
Identyfikator odwołania
|
reference_id | string |
Drugi identyfikator używany do skojarzenia członka zespołu z jednostką w innym systemie. |
|
|
Numer telefonu
|
phone_number | string |
Numer telefonu członka zespołu w formacie E.164. |
|
|
Typ przypisania
|
assignment_type | string |
Bieżący typ przypisania członka zespołu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
team_members.idempotency-key-1.team_member.id | string |
Identyfikator odwołujący się do tego obiektu. |
|
Identyfikator odwołania
|
team_members.idempotency-key-1.team_member.reference_id | string |
Drugi identyfikator używany do skojarzenia członka zespołu z jednostką w innym systemie. |
|
Jest właścicielem
|
team_members.idempotency-key-1.team_member.is_owner | boolean |
Czy członek zespołu jest właścicielem konta Square. |
|
Status
|
team_members.idempotency-key-1.team_member.status | string |
Opisuje stan członka zespołu. |
|
Imię
|
team_members.idempotency-key-1.team_member.given_name | string |
Podana nazwa (czyli imię) skojarzona z członkiem zespołu. |
|
Nazwisko
|
team_members.idempotency-key-1.team_member.family_name | string |
Nazwa rodziny (czyli nazwisko) skojarzona z członkiem zespołu. |
|
Adres e-mail
|
team_members.idempotency-key-1.team_member.email_address | string |
Adres e-mail skojarzony z członkiem zespołu. |
|
Numer telefonu
|
team_members.idempotency-key-1.team_member.phone_number | string |
Numer telefonu członka zespołu w formacie E.164. |
|
Typ przypisania
|
team_members.idempotency-key-1.team_member.assigned_locations.assignment_type | string |
Bieżący typ przypisania członka zespołu. |
|
Identyfikatory lokalizacji
|
team_members.idempotency-key-1.team_member.assigned_locations.location_ids | array of string | |
|
identyfikator
|
team_members.idempotency-key-2.team_member.id | string |
Identyfikator odwołujący się do tego obiektu. |
|
Identyfikator odwołania
|
team_members.idempotency-key-2.team_member.reference_id | string |
Drugi identyfikator używany do skojarzenia członka zespołu z jednostką w innym systemie. |
|
Jest właścicielem
|
team_members.idempotency-key-2.team_member.is_owner | boolean |
Czy członek zespołu jest właścicielem konta Square. |
|
Status
|
team_members.idempotency-key-2.team_member.status | string |
Opisuje stan członka zespołu. |
|
Imię
|
team_members.idempotency-key-2.team_member.given_name | string |
Podana nazwa (czyli imię) skojarzona z członkiem zespołu. |
|
Nazwisko
|
team_members.idempotency-key-2.team_member.family_name | string |
Nazwa rodziny (czyli nazwisko) skojarzona z członkiem zespołu. |
|
Adres e-mail
|
team_members.idempotency-key-2.team_member.email_address | string |
Adres e-mail skojarzony z członkiem zespołu. |
|
Numer telefonu
|
team_members.idempotency-key-2.team_member.phone_number | string |
Numer telefonu członka zespołu w formacie E.164. |
|
Typ przypisania
|
team_members.idempotency-key-2.team_member.assigned_locations.assignment_type | string |
Bieżący typ przypisania członka zespołu. |
Zmiana aktualizacji
Aktualizuje istniejącą zmianę.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator
|
id | True | string |
Identyfikator. |
|
Identyfikator członka zespołu
|
team_member_id | string |
Identyfikator członka zespołu. |
|
|
Identyfikator lokalizacji
|
location_id | string |
Identyfikator lokalizacji. |
|
|
Rozpocznij od
|
start_at | string |
Sygnatura czasowa określająca godzinę początkową tego obiektu w formacie RFC 3339. |
|
|
Koniec od
|
end_at | string |
RFC 3339; przesunięte na strefę czasową i przesunięcie. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
|
Title
|
title | string |
Nazwa zadania wykonywanego podczas tej zmiany. Kwadratowe interfejsy użytkownika raportowania pracy mogą grupować zmiany według tytułu. |
|
|
Kwota
|
amount | integer |
Kwota. |
|
|
Waluta
|
currency | string |
Waluta. |
|
|
identyfikator
|
id | string |
Identyfikator obiektu |
|
|
Rozpocznij od
|
start_at | string |
RFC 3339; jest zgodny z tymi samymi informacjami o strefie czasowej co Shift. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
|
Koniec od
|
end_at | string |
RFC 3339; jest zgodny z tymi samymi informacjami o strefie czasowej co Shift. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
|
Identyfikator typu przerwania
|
break_type_id | string |
BreakType, dla którego utworzono ten podział. |
|
|
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. |
|
|
Oczekiwany czas trwania
|
expected_duration | string |
Oczekiwana długość przerwy. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. |
|
|
Jest płatna
|
is_paid | boolean |
Czy ta przerwa liczy się w stosunku do czasu pracy w celach odszkodowawczych. |
|
|
wersja
|
version | integer |
Bieżąca wersja tego obiektu. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
shift.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator członka zespołu
|
shift.team_member_id | string |
Identyfikator członka zespołu. |
|
Identyfikator pracownika
|
shift.employee_id | string |
Identyfikator wygenerowany kwadratowo pracownika. |
|
Identyfikator lokalizacji
|
shift.location_id | string |
Identyfikator lokalizacji. |
|
Timezone
|
shift.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. |
|
Rozpocznij od
|
shift.start_at | string |
Sygnatura czasowa określająca godzinę początkową tego obiektu w formacie RFC 3339. |
|
Koniec od
|
shift.end_at | string |
RFC 3339; przesunięte na strefę czasową i przesunięcie. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
Title
|
shift.wage.title | string |
Nazwa zadania wykonywanego podczas tej zmiany. Kwadratowe interfejsy użytkownika raportowania pracy mogą grupować zmiany według tytułu. |
|
Kwota
|
shift.wage.hourly_rate.amount | integer |
Kwota. |
|
Waluta
|
shift.wage.hourly_rate.currency | string |
Waluta. |
|
Przerwy
|
shift.breaks | array of object | |
|
identyfikator
|
shift.breaks.id | string |
Identyfikator obiektu |
|
Rozpocznij od
|
shift.breaks.start_at | string |
RFC 3339; jest zgodny z tymi samymi informacjami o strefie czasowej co Shift. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
Koniec od
|
shift.breaks.end_at | string |
RFC 3339; jest zgodny z tymi samymi informacjami o strefie czasowej co Shift. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
Identyfikator typu przerwania
|
shift.breaks.break_type_id | string |
BreakType, dla którego utworzono ten podział. |
|
Name
|
shift.breaks.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. |
|
Oczekiwany czas trwania
|
shift.breaks.expected_duration | string |
Oczekiwana długość przerwy. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. |
|
Jest płatna
|
shift.breaks.is_paid | boolean |
Czy ta przerwa liczy się w stosunku do czasu pracy w celach odszkodowawczych. |
|
Status
|
shift.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
wersja
|
shift.version | integer |
Bieżąca wersja tego obiektu. |
|
Utworzono pod adresem
|
shift.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Zaktualizowano o
|
shift.updated_at | string |
Sygnatura czasowa określająca najnowszy czas aktualizacji tego obiektu w formacie RFC 3339. |
Zmiany wyszukiwania
Zwraca listę rekordów shift z podziałem na strony dla firmy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Data rozpoczęcia
|
start_date | string |
Ciąg w formacie RRRR-MM-DD, takim jak 2017-10-31, zgodnie z rozszerzonym formatem ISO 8601 dla dat kalendarza. Początek zakresu dat (włącznie). |
|
|
Data zakończenia
|
end_date | string |
Ciąg w formacie RRRR-MM-DD, takim jak 2017-10-31, zgodnie z rozszerzonym formatem ISO 8601 dla dat kalendarza. Koniec zakresu dat (włącznie). |
|
|
Dopasuj zmiany według
|
match_shifts_by | string |
Strategia, w której są stosowane daty. |
|
|
Domyślna strefa czasowa
|
default_timezone | string |
Strefy czasowe specyficzne dla lokalizacji konwertują dni robocze na filtry daty/godziny. Każda lokalizacja zawarta w zapytaniu musi mieć strefę czasową lub to pole musi być podane jako rezerwowe. Format: identyfikator bazy danych strefy czasowej IANA dla odpowiedniej strefy czasowej. |
|
|
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 |
|---|---|---|---|
|
Zmiany
|
shifts | array of object | |
|
identyfikator
|
shifts.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Identyfikator członka zespołu
|
shifts.team_member_id | string |
Identyfikator obiektu TeamMember dla członka zespołu skojarzonego z obiektem . |
|
Identyfikator lokalizacji
|
shifts.location_id | string |
Identyfikator lokalizacji. |
|
Timezone
|
shifts.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. |
|
Rozpocznij od
|
shifts.start_at | string |
Sygnatura czasowa RFC 3339 określająca czas rozpoczęcia dostępnego miejsca. |
|
Koniec od
|
shifts.end_at | string |
RFC 3339; przesunięte na strefę czasową i przesunięcie. Precyzja do minuty jest przestrzegana; sekundy są obcinane. |
|
Title
|
shifts.wage.title | string |
Nazwa zadania wykonywanego podczas tej zmiany. Kwadratowe interfejsy użytkownika raportowania pracy mogą grupować zmiany według tytułu. |
|
Kwota
|
shifts.wage.hourly_rate.amount | integer |
Kwota. |
|
Waluta
|
shifts.wage.hourly_rate.currency | string |
Waluta. |
|
Przerwy
|
shifts.breaks | array of object | |
|
identyfikator
|
shifts.breaks.id | string |
Identyfikator odwołujący się do tego obiektu. |
|
Rozpocznij od
|
shifts.breaks.start_at | string |
Wartość daty/godziny w formacie RFC 3339 wskazująca, kiedy rozpoczyna się zakres czasu. |
|
Koniec od
|
shifts.breaks.end_at | string |
Wartość daty/godziny w formacie RFC 3339 wskazująca, kiedy zakres czasu się kończy. |
|
Identyfikator typu przerwania
|
shifts.breaks.break_type_id | string |
BreakType, dla którego utworzono ten podział. |
|
Name
|
shifts.breaks.name | string |
Czytelna dla człowieka nazwa. |
|
Oczekiwany czas trwania
|
shifts.breaks.expected_duration | string |
Oczekiwana długość przerwy. Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. |
|
Jest płatna
|
shifts.breaks.is_paid | boolean |
Czy ta przerwa liczy się w stosunku do czasu pracy w celach odszkodowawczych. |
|
Status
|
shifts.status | string |
Bieżący stan weryfikacji tego obiektu. |
|
wersja
|
shifts.version | integer |
Bieżąca wersja obiektu. |
|
Utworzono pod adresem
|
shifts.created_at | string |
Czas zdarzenia w formacie ISO 8601. |
|
Zaktualizowano o
|
shifts.updated_at | string |
Znacznik czasu ostatniej modyfikacji w formacie RFC 3339 |
Łączenie klienta z kartą upominkową (beta)
Łączy klienta z kartą upominkową
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator karty upominkowej
|
gift_card_id | True | string |
Identyfikator karty upominkowej. |
|
Identyfikator klienta
|
customer_id | string |
Identyfikator klienta, który ma być połączony. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator
|
gift_card.id | string |
Unikatowy, wystawiony na kwadrat identyfikator. |
|
Typ
|
gift_card.type | string |
Typ tego obiektu. |
|
Źródło GAN
|
gift_card.gan_source | string |
Wskazuje, czy numer konta karty upominkowej (GAN) jest generowany przez kwadrat lub importowany z systemu spoza kwadratu. |
|
State
|
gift_card.state | string |
Bieżący stan. |
|
Kwota
|
gift_card.balance_money.amount | integer |
Kwota. |
|
Waluta
|
gift_card.balance_money.currency | string |
Waluta. |
|
Gan
|
gift_card.gan | string |
Numer konta karty upominkowej. |
|
Utworzono pod adresem
|
gift_card.created_at | string |
Sygnatura czasowa określająca czas utworzenia tego obiektu w formacie RFC 3339. |
|
Identyfikatory klientów
|
gift_card.customer_ids | array of string |
Definicje
obiekt
Jest to typ 'obiekt'.