Delen via


Square Business (onafhankelijke uitgever) (preview)

Square helpt miljoenen verkopers hun bedrijf te runnen- van veilige creditcardverwerking tot oplossingen voor verkooppunten. Deze connector bevat acties voor de volgende eindpunten: Loyaliteit, Cadeaubonnen, Bookings, Business, Team, Financials, Online en Auth.

Deze connector is beschikbaar in de volgende producten en regio's:

Dienst Class Regions
Copilot Studio Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Logic-apps Standaard Alle Logic Apps-regio's , met uitzondering van het volgende:
     - Azure Government-regio's
     - Azure China-regio's
     - Us Department of Defense (DoD)
Power Apps Premium Alle Power Apps-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Alle Power Automate-regio's , met uitzondering van het volgende:
     - Amerikaanse overheid (GCC)
     - Amerikaanse overheid (GCC High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Contactpersoon
Naam Troy Taylor
URL https://www.hitachisolutions.com
E-mailen ttaylor@hitachisolutions.com
Connector-metagegevens
Uitgever Troy Taylor
Webpagina https://squareup.com/
Privacybeleid https://squareup.com/us/en/legal/general/privacy
Categorieën Handel; Verkoop en CRM

Beperkingslimieten

Name Aanroepen Verlengingsperiode
API-aanroepen per verbinding 100 60 seconden

Acties

Activiteit cadeaukaart maken (bèta)

Hiermee maakt u een cadeaukaartactiviteit.

Activiteiten van cadeaukaarten vermelden (bèta)

Geeft een lijst met cadeaukaartactiviteiten weer. Standaard krijgt u activiteiten voor cadeaukaarten voor alle cadeaubonnen in het account van de verkoper. U kunt desgewenst queryparameters opgeven om de lijst te filteren. U kunt bijvoorbeeld een lijst met cadeaukaartactiviteiten ophalen voor een cadeaukaart, voor alle cadeaukaarten in een specifieke regio of voor activiteiten binnen een tijdvenster.

Apparaatcode maken

Hiermee maakt u een DeviceCode die kan worden gebruikt om u aan te melden bij een Square Terminal-apparaat om de verbonden terminalmodus in te voeren.

Apparaatcode ophalen

Hiermee haalt u DeviceCode op met de bijbehorende id.

Apparaatcodes vermelden

Geeft een lijst weer van alle DeviceCodes die aan de verkoper zijn gekoppeld.

Bankrekening ophalen

Retourneert gegevens van een bankrekening die is gekoppeld aan een vierkante rekening.

Bankrekening ophalen op V1-id

Retourneert gegevens van een bankrekening die is geïdentificeerd door de id van de V1-bankrekening.

Bankrekeningen vermelden

Retourneert een lijst met BankAccount-objecten die zijn gekoppeld aan een Vierkant-account.

Bedrijfsboekingsprofiel ophalen (bèta)

Haalt het reserveringsprofiel van een verkoper op.

Beschikbaarheid zoeken (bèta)

Zoekt naar beschikbaarheid voor reservering.

Cadeaukaart ophalen (bèta)

Hiermee haalt u een cadeaukaart op met behulp van de id.

Cadeaukaart ophalen uit GAN (bèta)

Hiermee haalt u een cadeaukaart op met behulp van het accountnummer van de cadeaukaart (GAN).

Cadeaukaart ophalen uit nonce (bèta)

Hiermee haalt u een cadeaukaart op met behulp van een nonce (een beveiligd token) dat de cadeaukaart vertegenwoordigt.

Cash drawer shift ophalen

Geeft de samenvattingsdetails voor één cashladedienst.

Een lijst weergeven van cash ladediensten

Geeft de details voor alle cashladediensten voor een locatie in een datumbereik.

Fragment ophalen

Haalt uw fragment op van een Square Online-site. Een site kan fragmenten uit meerdere codefragmenttoepassingen bevatten, maar u kunt alleen het fragment ophalen dat door uw toepassing is toegevoegd.

Fragment verwijderen

Hiermee verwijdert u het fragment van een Square Online-site.

Gebeurtenissen van cash drawer shift weergeven

Biedt een gepagineerde lijst met gebeurtenissen voor één cash drawer shift.

Klant koppelen aan cadeaukaart (bèta)

Een klant koppelen aan een cadeaukaart

Klant loskoppelen van cadeaukaart (bèta)

Koppelt een klant los van een cadeaukaart.

Lijstlocaties

Biedt informatie over alle locaties van een bedrijf.

Locatie bijwerken (bèta)

Hiermee werkt u een locatie bij.

Locatie maken (bèta)

Hiermee maakt u een locatie.

Locatie ophalen

Hiermee worden details van een locatie opgehaald. U kunt 'main' opgeven als de locatie-id om details van de hoofdlocatie op te halen.

Loon van teamlid ophalen

Hiermee wordt één TeamMemberWage geretourneerd die is opgegeven door de id.

Looninstelling bijwerken

Hiermee maakt of werkt u een WageSetting-object bij.

Looninstelling ophalen

Hiermee wordt een WageSetting-object opgehaald voor een teamlid dat is opgegeven door teamlid-id.

Loyaliteitsaccount maken

Hiermee maakt u een loyaliteitsaccount.

Loyaliteitsaccount ophalen

Haalt een loyaliteitsaccount op.

Loyaliteitsbeloning inwisselen

Verzilvert een loyaliteitsbeloning. Nadat de beloning de terminalstatus heeft bereikt, kan deze niet worden verwijderd. Met andere woorden, punten die voor de beloning worden gebruikt, kunnen niet worden geretourneerd naar het account.

Loyaliteitsbeloning maken

Creëert een loyaliteitsbeloning. Nadat een beloning is gemaakt, zijn de punten vergrendeld en niet beschikbaar voor de koper om een andere beloning in te wisselen.

Loyaliteitsbeloning ophalen

Haalt een loyaliteitsbeloning op.

Loyaliteitsbeloning verwijderen

Hiermee verwijdert u een loyaliteitsbeloning. Retourneert de loyaliteitspunten terug naar het loyaliteitsaccount. U kunt een beloning die de terminalstatus (INGEWISSELD) heeft bereikt, niet verwijderen.

Loyaliteitsbeloningen zoeken

Zoekt naar loyaliteitsbeloningen in een loyaliteitsrekening.

Loyaliteitsprogramma ophalen

Haalt het loyaliteitsprogramma op in het account van een verkoper, opgegeven door de programma-id of het belangrijkste trefwoord. Loyaliteitsprogramma's bepalen hoe kopers punten kunnen verdienen en punten kunnen inwisselen voor beloningen.

Loyaliteitspunten aanpassen

Hiermee voegt u punten toe aan of trekt u punten af van het account van een koper. Gebruik dit eindpunt alleen als u punten handmatig moet aanpassen.

Loyaliteitspunten berekenen

Berekent de punten die een aankoop verdient. Een toepassing kan dit eindpunt aanroepen om de punten weer te geven die een koper kan verdienen met de specifieke aankoop.

Loyaliteitspunten verzamelen

Voegt punten toe aan een loyaliteitsrekening.

Mobiele autorisatiecode maken

Hiermee genereert u code voor het autoriseren van een mobiele toepassing om verbinding te maken met een vierkante kaartlezer. Autorisatiecodes zijn eenmalig en verlopen 60 minuten nadat ze zijn uitgegeven.

Reservering maken (bèta)

Hiermee maakt u een reservering.

Reserveringsprofielen voor teamleden vermelden (bèta)

Bevat reserveringsprofielen voor teamleden.

Salarissen van teamleden vermelden

Retourneert een gepagineerde lijst met TeamMemberWage-exemplaren voor een bedrijf.

Shift bijwerken

Hiermee wordt een bestaande Shift bijgewerkt.

Shift maken

Hiermee maakt u een nieuwe Shift. Een dienst vertegenwoordigt een volledige werkdag voor één werknemer

Shift ophalen

Retourneert één shift die is opgegeven met id.

Shift verwijderen

Hiermee verwijdert u een dienst

Sites weergeven

Geeft een lijst weer van de Square Online sites die deel uitmaken van een verkoper.

Teamleden bulksgewijs bijwerken

Hiermee worden meerdere TeamMember-objecten bijgewerkt.

Teamleden bulksgewijs maken

Hiermee maakt u meerdere TeamMember-objecten.

Teamleden zoeken

Hiermee wordt een gepagineerde lijst met TeamMember-objecten voor een bedrijf geretourneerd.

Teamlid bijwerken

Hiermee wordt één TeamMember-object bijgewerkt.

Teamlid maken

Hiermee maakt u één TeamMember-object.

Teamlid ophalen

Hiermee wordt een TeamMember-object opgehaald voor de opgegeven TeamMember-id.

Type einde maken

Hiermee maakt u een nieuw BreakType. Een BreakType is een sjabloon voor het maken van break-objecten.

Type einde verwijderen

Hiermee verwijdert u een bestaand BreakType. Een BreakType kan worden verwijderd, zelfs als ernaar wordt verwezen vanuit een Shift.

Type onderbreking ophalen

Retourneert één BreakType dat is opgegeven door de id.

Type update-einde

Hiermee wordt een bestaand BreakType bijgewerkt.

Typen lijstonderbrekingen

Retourneert een gepagineerde lijst met BreakType-exemplaren voor een bedrijf.

Uitchecken maken

Koppelt een checkoutId aan een checkout_page_url waarnaar klanten worden doorgestuurd om hun betalingsgegevens op te geven met behulp van een werkstroom voor betalingsverwerking.

Upsert-fragment

Voegt een fragment toe aan een Square Online-site of werkt het bestaande fragment op de site bij. De code van het codefragment wordt toegevoegd aan het einde van het hoofdelement op elke pagina van de site, met uitzondering van uitcheckpagina's. Een codefragmenttoepassing kan één fragment toevoegen aan een bepaalde site.

Verkoper ophalen

Haal een Merchant-object op voor de opgegeven merchant_id.

Verkopers vermelden

Retourneert Merchant-informatie voor een bepaald toegangstoken.

Werkweekconfiguratie bijwerken

Hiermee werkt u een WorkweekConfig bij.

Werkweekconfiguraties vermelden

Retourneert een lijst met WorkweekConfig-exemplaren voor een bedrijf.

Zoek loyaliteitsaccounts

Zoekt naar loyaliteitsrekeningen in een loyaliteitsprogramma.

Zoek loyaliteitsevenementen

Zoekt naar loyaliteitsevenementen. Een square loyaliteitsprogramma onderhoudt een grootboek van gebeurtenissen die plaatsvinden tijdens de levensduur van een loyaliteitsrekening van een koper. Elke wijziging in het puntsaldo (bijvoorbeeld punten verdiend, punten die zijn ingewisseld en punten verlopen) wordt vastgelegd in het grootboek. Met dit eindpunt kunt u het grootboek doorzoeken op gebeurtenissen.

Zoekdiensten

Hiermee wordt een gepagineerde lijst met Shift-records voor een bedrijf geretourneerd.

Activiteit cadeaukaart maken (bèta)

Hiermee maakt u een cadeaukaartactiviteit.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Cadeaukaart-id
gift_card_id string

De cadeaukaart-id. De id is niet vereist als er een GAN aanwezig is.

Typologie
type string

Het type van dit object.

Locatie-id
location_id string

De id van de locatie.

Order-id
order_id string

De id van de volgorde die aan de activiteit is gekoppeld.

UID van regelitem
line_item_uid string

De line_item_uid van het cadeaukaartregelitem in een bestelling.

Retouren

Name Pad Type Description
ID-kaart
gift_card_activity.id string

De unieke, door square uitgegeven id.

Cadeaukaart-id
gift_card_activity.gift_card_id string

De cadeaukaart-id. De id is niet vereist als er een GAN aanwezig is.

Cadeaukaart GAN
gift_card_activity.gift_card_gan string

De cadeaukaart GAN. De GAN is niet vereist als gift_card_id aanwezig is.

Typologie
gift_card_activity.type string

Het type van dit object.

Aantal
gift_card_activity.gift_card_balance_money.amount integer

Het bedrag.

Valuta
gift_card_activity.gift_card_balance_money.currency string

De valuta.

Locatie-id
gift_card_activity.location_id string

De id van de locatie.

Gemaakt op
gift_card_activity.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Aantal
gift_card_activity.activate_activity_details.amount_money.amount integer

Het bedrag.

Valuta
gift_card_activity.activate_activity_details.amount_money.currency string

De valuta.

Order-id
gift_card_activity.activate_activity_details.order_id string

De id van de volgorde die aan de activiteit is gekoppeld.

UID van regelitem
gift_card_activity.activate_activity_details.line_item_uid string

De line_item_uid van het cadeaukaartregelitem in een bestelling.

Activiteiten van cadeaukaarten vermelden (bèta)

Geeft een lijst met cadeaukaartactiviteiten weer. Standaard krijgt u activiteiten voor cadeaukaarten voor alle cadeaubonnen in het account van de verkoper. U kunt desgewenst queryparameters opgeven om de lijst te filteren. U kunt bijvoorbeeld een lijst met cadeaukaartactiviteiten ophalen voor een cadeaukaart, voor alle cadeaukaarten in een specifieke regio of voor activiteiten binnen een tijdvenster.

Parameters

Name Sleutel Vereist Type Description
Cadeaukaart-id
gift_card_id string

Als u een cadeaukaart-id opgeeft, retourneert het eindpunt activiteiten die deel uitmaken van de opgegeven cadeaukaart. Anders retourneert het eindpunt alle activiteiten van de cadeaukaart voor de verkoper.

Typologie
type string

Als u een type opgeeft, retourneert het eindpunt activiteiten voor cadeaukaarten van dit type. Anders retourneert het eindpunt alle soorten cadeaukaartactiviteiten.

Locatie-id
location_id string

U kunt dit optionele filter opgeven om alleen de records op te halen die behoren tot een specifieke locatie.

Begintijd
begin_time string

De inclusieve begintijd van de query op opened_at, in ISO 8601-indeling.

Eindtijd
end_time string

De exclusieve einddatum van de query op opened_at, in ISO 8601-indeling.

Limit
limit integer

Bovengrens voor het getal dat moet worden geretourneerd in het antwoord.

Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Sorteervolgorde
sort_order string

Hiermee sorteert u de geretourneerde lijst op het moment dat de kaart is gemaakt met de opgegeven volgorde.

Retouren

Name Pad Type Description
Cadeaukaartactiviteiten
gift_card_activities array of object
ID-kaart
gift_card_activities.id string

De unieke, door square uitgegeven id.

Typologie
gift_card_activities.type string

Het type van dit object.

Locatie-id
gift_card_activities.location_id string

De id voor de locatie.

Gemaakt op
gift_card_activities.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Cadeaukaart-id
gift_card_activities.gift_card_id string

De cadeaukaart-id. De id is niet vereist als er een GAN aanwezig is.

Cadeaukaart GAN
gift_card_activities.gift_card_gan string

De cadeaukaart GAN. De GAN is niet vereist als gift_card_id aanwezig is.

Aantal
gift_card_activities.gift_card_balance_money.amount integer

Het bedrag.

Valuta
gift_card_activities.gift_card_balance_money.currency string

De valuta.

Aantal
gift_card_activities.redeem_activity_details.amount_money.amount integer

Het bedrag.

Valuta
gift_card_activities.redeem_activity_details.amount_money.currency string

De valuta.

Aantal
gift_card_activities.activate_activity_details.amount_money.amount integer

Het bedrag.

Valuta
gift_card_activities.activate_activity_details.amount_money.currency string

De valuta.

Order-id
gift_card_activities.activate_activity_details.order_id string

De id van de volgorde die aan de activiteit is gekoppeld.

UID van regelitem
gift_card_activities.activate_activity_details.line_item_uid string

De line_item_uid van het cadeaukaartregelitem in een bestelling.

Apparaatcode maken

Hiermee maakt u een DeviceCode die kan worden gebruikt om u aan te melden bij een Square Terminal-apparaat om de verbonden terminalmodus in te voeren.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Naam
name string

De naam van het object.

Locatie-id
location_id string

De id van de locatie.

Producttype
product_type string

Het doelproducttype van de apparaatcode.

Retouren

Name Pad Type Description
ID-kaart
device_code.id string

De unieke, door square uitgegeven id.

Naam
device_code.name string

De naam van het object.

Code
device_code.code string

De unieke code die kan worden gebruikt om u aan te melden.

Producttype
device_code.product_type string

Het doelproducttype van de apparaatcode.

Locatie-id
device_code.location_id string

De id van de locatie.

Gemaakt op
device_code.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Koppelen door
device_code.pair_by string

Wanneer deze DeviceCode verloopt en zich niet meer aanmeldt. Tijdstempel in RFC 3339-indeling.

Toestand
device_code.status string

De huidige verificatiestatus van dit object.

Status gewijzigd op
device_code.status_changed_at string

Wanneer de status van deze DeviceCode voor het laatst is gewijzigd. Tijdstempel in RFC 3339-indeling.

Apparaatcode ophalen

Hiermee haalt u DeviceCode op met de bijbehorende id.

Parameters

Name Sleutel Vereist Type Description
ID-kaart
id True string

De id.

Retouren

Name Pad Type Description
ID-kaart
device_code.id string

De unieke, door square uitgegeven id.

Naam
device_code.name string

De naam van het object.

Code
device_code.code string

De unieke code die kan worden gebruikt om u aan te melden.

Producttype
device_code.product_type string

Het doelproducttype van de apparaatcode.

Locatie-id
device_code.location_id string

De id van de locatie.

Gemaakt op
device_code.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Koppelen door
device_code.pair_by string

Wanneer deze DeviceCode verloopt en zich niet meer aanmeldt. Tijdstempel in RFC 3339-indeling.

Toestand
device_code.status string

De huidige verificatiestatus van dit object.

Apparaat-id
device_code.device_id string

De id van het apparaat.

Status gewijzigd op
device_code.status_changed_at string

Wanneer de status van deze DeviceCode voor het laatst is gewijzigd. Tijdstempel in RFC 3339-indeling.

Apparaatcodes vermelden

Geeft een lijst weer van alle DeviceCodes die aan de verkoper zijn gekoppeld.

Parameters

Name Sleutel Vereist Type Description
Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Locatie-id
location_id string

U kunt dit optionele filter opgeven om alleen de records op te halen die behoren tot een specifieke locatie.

Producttype
product_type string

Indien opgegeven, retourneert alleen DeviceCodes die gericht zijn op het opgegeven producttype. Retourneert DeviceCodes van alle producttypen indien leeg.

Toestand
status string

Indien opgegeven, worden alleen objecten geretourneerd die overeenkomen met de opgegeven statussen.

Retouren

Name Pad Type Description
Apparaatcodes
device_codes array of object
ID-kaart
device_codes.id string

De unieke, door square uitgegeven id.

Naam
device_codes.name string

De naam van het object.

Code
device_codes.code string

De unieke code die kan worden gebruikt om u aan te melden.

Producttype
device_codes.product_type string

Het doelproducttype van de apparaatcode.

Locatie-id
device_codes.location_id string

De id voor de locatie.

Gemaakt op
device_codes.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Koppelen door
device_codes.pair_by string

Wanneer deze DeviceCode verloopt en zich niet meer aanmeldt. Tijdstempel in RFC 3339-indeling.

Toestand
device_codes.status string

De huidige verificatiestatus van dit object.

Apparaat-id
device_codes.device_id string

De unieke id van het apparaat dat deze code heeft gebruikt. Wordt ingevuld wanneer het apparaat is gekoppeld.

Status gewijzigd op
device_codes.status_changed_at string

Wanneer de status van deze DeviceCode voor het laatst is gewijzigd. Tijdstempel in RFC 3339-indeling.

Bankrekening ophalen

Retourneert gegevens van een bankrekening die is gekoppeld aan een vierkante rekening.

Parameters

Name Sleutel Vereist Type Description
Bankrekening-id
bank_account_id True string

Door vierkanten uitgegeven id van het gewenste bankaccount.

Retouren

Name Pad Type Description
ID-kaart
bank_account.id string

De unieke, door square uitgegeven id.

Achtervoegsel rekeningnummer
bank_account.account_number_suffix string

De laatste cijfers van het rekeningnummer.

Country
bank_account.country string

De ISO 3166 Alpha-2-landcode.

Valuta
bank_account.currency string

De ISO 4217-valutacode van 3 tekens.

Accounttype
bank_account.account_type string

Het type account.

Naam van houder
bank_account.holder_name string

Naam van de rekeninghouder.

Primaire bankidentificatienummer
bank_account.primary_bank_identification_number string

Primaire id voor de bank.

Locatie-id
bank_account.location_id string

De id van de locatie.

Toestand
bank_account.status string

De huidige verificatiestatus van dit object.

Prijzenswaardig
bank_account.creditable boolean

Hiermee wordt aangegeven of square geld naar dit account kan verzenden.

Debitable
bank_account.debitable boolean

Geeft aan of het mogelijk is dat Square geld van deze rekening neemt.

Versie
bank_account.version integer

De huidige versie van dit object.

Banknaam
bank_account.bank_name string

Naam van de werkelijke financiële instelling.

Bankrekening ophalen op V1-id

Retourneert gegevens van een bankrekening die is geïdentificeerd door de id van de V1-bankrekening.

Parameters

Name Sleutel Vereist Type Description
V1 Bankrekening-id
v1_bank_account_id True string

Verbind de V1-id van het gewenste bankaccount.

Retouren

Name Pad Type Description
ID-kaart
bank_account.id string

De unieke, door square uitgegeven id.

Achtervoegsel rekeningnummer
bank_account.account_number_suffix string

De laatste cijfers van het rekeningnummer.

Country
bank_account.country string

De ISO 3166 Alpha-2-landcode.

Valuta
bank_account.currency string

De ISO 4217-valutacode van 3 tekens.

Accounttype
bank_account.account_type string

Het type account.

Naam van houder
bank_account.holder_name string

Naam van de rekeninghouder.

Primaire bankidentificatienummer
bank_account.primary_bank_identification_number string

Primaire id voor de bank.

Locatie-id
bank_account.location_id string

De id van de locatie.

Toestand
bank_account.status string

De huidige verificatiestatus van dit object.

Prijzenswaardig
bank_account.creditable boolean

Hiermee wordt aangegeven of square geld naar dit account kan verzenden.

Debitable
bank_account.debitable boolean

Geeft aan of het mogelijk is dat Square geld van deze rekening neemt.

Versie
bank_account.version integer

De huidige versie van dit object.

Banknaam
bank_account.bank_name string

Naam van de werkelijke financiële instelling.

Bankrekeningen vermelden

Retourneert een lijst met BankAccount-objecten die zijn gekoppeld aan een Vierkant-account.

Parameters

Name Sleutel Vereist Type Description
Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Limit
limit integer

Bovengrens voor het getal dat moet worden geretourneerd in het antwoord.

Locatie-id
location_id string

U kunt dit optionele filter opgeven om alleen de records op te halen die behoren tot een specifieke locatie.

Retouren

Name Pad Type Description
Bankrekening
bank_accounts array of object
ID-kaart
bank_accounts.id string

De unieke, door square uitgegeven id.

Achtervoegsel rekeningnummer
bank_accounts.account_number_suffix string

De laatste cijfers van het rekeningnummer.

Country
bank_accounts.country string

De ISO 3166 Alpha-2-landcode.

Valuta
bank_accounts.currency string

De ISO 4217-valutacode van 3 tekens.

Accounttype
bank_accounts.account_type string

Het financiële doel van de gekoppelde bankrekening.

Naam van houder
bank_accounts.holder_name string

Naam van de rekeninghouder. Deze naam moet overeenkomen met de naam van de doelrekeningrecord.

Primaire bankidentificatienummer
bank_accounts.primary_bank_identification_number string

Primaire id voor de bank.

Locatie-id
bank_accounts.location_id string

De id voor de locatie.

Toestand
bank_accounts.status string

De huidige verificatiestatus van dit object.

Prijzenswaardig
bank_accounts.creditable boolean

Hiermee wordt aangegeven of het mogelijk is dat Square geld naar deze bankrekening verzendt.

Debitable
bank_accounts.debitable boolean

Hiermee wordt aangegeven of het mogelijk is dat Square geld naar deze bankrekening verzendt.

Versie
bank_accounts.version integer

De huidige versie van het object.

Banknaam
bank_accounts.bank_name string

Naam van de werkelijke financiële instelling.

Bedrijfsboekingsprofiel ophalen (bèta)

Haalt het reserveringsprofiel van een verkoper op.

Retouren

Name Pad Type Description
Verkoper-id
business_booking_profile.seller_id string

De id van de verkoper die kan worden verkregen met behulp van de Merchants-API.

Gemaakt op
business_booking_profile.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Reservering ingeschakeld
business_booking_profile.booking_enabled boolean

Geeft aan of de verkoper open is voor boeking.

Keuze voor tijdzone van klant
business_booking_profile.customer_timezone_choice string

De keuze van de tijdzonegegevens van de klant van een boeking. De square online boekingssite en alle meldingen aan klanten maken gebruik van de tijdzone van de verkoper of de tijdzone die de klant kiest bij het boeken.

Reserveringsbeleid
business_booking_profile.booking_policy string

Het beleid voor de verkoper om automatisch reserveringsaanvragen (ACCEPT_ALL) te accepteren of niet (REQUIRES_ACCEPTANCE).

Gebruiker annuleren toestaan
business_booking_profile.allow_user_cancel boolean

Geeft aan of klanten hun eigen reserveringen kunnen annuleren of opnieuw kunnen plannen (waar) of niet (onwaar).

Locatietypen
business_booking_profile.business_appointment_settings.location_types array of string
Uitlijningstijd
business_booking_profile.business_appointment_settings.alignment_time string

De tijdseenheid van de serviceduur voor boekingen.

Minimale reservering Tead Time Seconds
business_booking_profile.business_appointment_settings.min_booking_lead_time_seconds integer

De minimale doorlooptijd in seconden voordat een service kan worden geboekt. Reserveringen moeten ten minste zo ver voor de begintijd van de boeking worden gemaakt.

Maximale boekingstijd seconden
business_booking_profile.business_appointment_settings.max_booking_lead_time_seconds integer

De maximale doorlooptijd in seconden voordat een service kan worden geboekt. Reserveringen moeten maximaal zo ver voor de begintijd van de boeking worden gemaakt.

Een teamlidboeking is ingeschakeld
business_booking_profile.business_appointment_settings.any_team_member_booking_enabled boolean

Geeft aan of een klant kan kiezen uit alle beschikbare tijdvakken en een personeelslid automatisch (waar) of niet (onwaar) kan toewijzen.

Meerdere servicereservering ingeschakeld
business_booking_profile.business_appointment_settings.multiple_service_booking_enabled boolean

Geeft aan of een klant meerdere services kan boeken in één onlineboeking.

Aantal
business_booking_profile.business_appointment_settings.cancellation_fee_money.amount string

Het bedrag van het geld, in de kleinste benaming van de valuta aangegeven door valuta

Valuta
business_booking_profile.business_appointment_settings.cancellation_fee_money.currency string

Het type valuta, in ISO 4217-indeling.

Annuleringsbeleid
business_booking_profile.business_appointment_settings.cancellation_policy string

Het annuleringsbeleid dat door de verkoper is vastgesteld.

Selectie van personeel van boekingsstroom overslaan
business_booking_profile.business_appointment_settings.skip_booking_flow_staff_selection boolean

Hiermee wordt aangegeven of klanten een toegewezen personeelslid (waar) hebben of het personeelslid van hun keuze (onwaar) kunnen selecteren.

Errors
errors array of

Beschikbaarheid zoeken (bèta)

Zoekt naar beschikbaarheid voor reservering.

Parameters

Name Sleutel Vereist Type Description
Beginnen bij
start_at string

Een datum/tijd-waarde in RFC 3339-indeling die aangeeft wanneer het tijdsbereik begint.

Eindigen op
end_at string

Een datum/tijd-waarde in RFC 3339-indeling die aangeeft wanneer het tijdsbereik eindigt.

Locatie-id
location_id string

De queryexpressie om te zoeken naar beschikbaarheid die overeenkomt met de opgegeven locatie-id's van de verkoper.

Servicevariatie-id
service_variation_id string

De id van de CatalogItemVariation die de service vertegenwoordigt die in dit segment is geboekt.

Welke dan ook
any array of string

Retouren

Name Pad Type Description
Beschikbaarheid
availabilities array of object
Beginnen bij
availabilities.start_at string

De RFC 3339-tijdstempel die de begintijd van de beschikbare sleuf aangeeft.

Locatie-id
availabilities.location_id string

De id voor de locatie.

Afspraaksegmenten
availabilities.appointment_segments array of object
Duur van minuten
availabilities.appointment_segments.duration_minutes integer

De tijdsduur in minuten van een afspraaksegment.

Teamlid-id
availabilities.appointment_segments.team_member_id string

De id van het TeamMember-object dat het teamlid vertegenwoordigt dat in dit segment is geboekt.

Servicevariatie-id
availabilities.appointment_segments.service_variation_id string

De id van het Object CatalogItemVariation die de service vertegenwoordigt die in dit segment is geboekt.

Servicevariatieversie
availabilities.appointment_segments.service_variation_version integer

De huidige versie van de itemvariatie die de service vertegenwoordigt die in dit segment is geboekt.

Errors
errors array of

Cadeaukaart ophalen (bèta)

Hiermee haalt u een cadeaukaart op met behulp van de id.

Parameters

Name Sleutel Vereist Type Description
ID-kaart
id True string

De id.

Retouren

Name Pad Type Description
ID-kaart
gift_card.id string

De unieke, door square uitgegeven id.

Typologie
gift_card.type string

Het type van dit object.

GAN-bron
gift_card.gan_source string

Geeft aan of het accountnummer van de cadeaukaart (GAN) wordt gegenereerd door Square of geïmporteerd uit een niet-Vierkant systeem.

Staat
gift_card.state string

De huidige status.

Aantal
gift_card.balance_money.amount integer

Het bedrag.

Valuta
gift_card.balance_money.currency string

De valuta.

Gan
gift_card.gan string

Het rekeningnummer van de cadeaukaart.

Gemaakt op
gift_card.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Cadeaukaart ophalen uit GAN (bèta)

Hiermee haalt u een cadeaukaart op met behulp van het accountnummer van de cadeaukaart (GAN).

Parameters

Name Sleutel Vereist Type Description
Gan
gan string

Het rekeningnummer van de cadeaukaart.

Retouren

Name Pad Type Description
ID-kaart
gift_card.id string

De unieke, door square uitgegeven id.

Typologie
gift_card.type string

Het type van dit object.

GAN-bron
gift_card.gan_source string

Geeft aan of het accountnummer van de cadeaukaart (GAN) wordt gegenereerd door Square of geïmporteerd uit een niet-Vierkant systeem.

Staat
gift_card.state string

De huidige status.

Aantal
gift_card.balance_money.amount integer

Het bedrag.

Valuta
gift_card.balance_money.currency string

De valuta.

Gan
gift_card.gan string

Het rekeningnummer van de cadeaukaart.

Gemaakt op
gift_card.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Cadeaukaart ophalen uit nonce (bèta)

Hiermee haalt u een cadeaukaart op met behulp van een nonce (een beveiligd token) dat de cadeaukaart vertegenwoordigt.

Parameters

Name Sleutel Vereist Type Description
Nonce
nonce string

De nonce van de cadeaukaart die moet worden opgehaald.

Retouren

Name Pad Type Description
ID-kaart
gift_card.id string

De unieke, door square uitgegeven id.

Typologie
gift_card.type string

Het type van dit object.

GAN-bron
gift_card.gan_source string

Geeft aan of het accountnummer van de cadeaukaart (GAN) wordt gegenereerd door Square of geïmporteerd uit een niet-Vierkant systeem.

Staat
gift_card.state string

De huidige status.

Aantal
gift_card.balance_money.amount integer

Het bedrag.

Valuta
gift_card.balance_money.currency string

De valuta.

Gan
gift_card.gan string

Het rekeningnummer van de cadeaukaart.

Gemaakt op
gift_card.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Cash drawer shift ophalen

Geeft de samenvattingsdetails voor één cashladedienst.

Parameters

Name Sleutel Vereist Type Description
Shift-id
shift_id True string

De id van de dienst.

Locatie-id
location_id True string

U kunt dit optionele filter opgeven om alleen de records op te halen die behoren tot een specifieke locatie.

Retouren

Name Pad Type Description
ID-kaart
cash_drawer_shift.id string

De unieke, door square uitgegeven id.

Staat
cash_drawer_shift.state string

De huidige status.

Geopend op
cash_drawer_shift.opened_at string

De tijd waarop de dienst begon, in ISO 8601-indeling.

Beëindigd op
cash_drawer_shift.ended_at string

Het tijdstip waarop de dienst is beëindigd, in ISO 8601-indeling.

Gesloten om
cash_drawer_shift.closed_at string

De tijd waarop gesloten, in ISO 8601-indeling.

Werknemer-id openen
cash_drawer_shift.opening_employee_id string

De id van de werknemer die de kaslade heeft gestart.

Werknemer-id beëindigen
cash_drawer_shift.ending_employee_id string

De id van de werknemer die de kaslade heeft beëindigd.

Werknemer-id sluiten
cash_drawer_shift.closing_employee_id string

De id van de werknemer die de kasladedienst heeft gesloten door de inhoud van de kaslade te controleren.

Description
cash_drawer_shift.description string

De beschrijving.

Aantal
cash_drawer_shift.opened_cash_money.amount integer

Het bedrag.

Valuta
cash_drawer_shift.opened_cash_money.currency string

De valuta.

Aantal
cash_drawer_shift.cash_payment_money.amount integer

Het bedrag.

Valuta
cash_drawer_shift.cash_payment_money.currency string

De valuta.

Aantal
cash_drawer_shift.cash_refunds_money.amount integer

Het bedrag.

Valuta
cash_drawer_shift.cash_refunds_money.currency string

De valuta.

Aantal
cash_drawer_shift.cash_paid_in_money.amount integer

Het bedrag.

Valuta
cash_drawer_shift.cash_paid_in_money.currency string

De valuta.

Aantal
cash_drawer_shift.cash_paid_out_money.amount integer

Het bedrag.

Valuta
cash_drawer_shift.cash_paid_out_money.currency string

De valuta.

Aantal
cash_drawer_shift.expected_cash_money.amount integer

Het bedrag.

Valuta
cash_drawer_shift.expected_cash_money.currency string

De valuta.

Aantal
cash_drawer_shift.closed_cash_money.amount integer

Het bedrag.

Valuta
cash_drawer_shift.closed_cash_money.currency string

De valuta.

Naam
cash_drawer_shift.device.name string

De naam.

Een lijst weergeven van cash ladediensten

Geeft de details voor alle cashladediensten voor een locatie in een datumbereik.

Parameters

Name Sleutel Vereist Type Description
Locatie-id
location_id string

U kunt dit optionele filter opgeven om alleen de records op te halen die behoren tot een specifieke locatie.

Sorteervolgorde
sort_order string

Hiermee sorteert u de geretourneerde lijst op het moment dat de kaart is gemaakt met de opgegeven volgorde.

Begintijd
begin_time string

De inclusieve begintijd van de query op opened_at, in ISO 8601-indeling.

Eindtijd
end_time string

De exclusieve einddatum van de query op opened_at, in ISO 8601-indeling.

Limit
limit integer

Bovengrens voor het getal dat moet worden geretourneerd in het antwoord.

Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Retouren

Name Pad Type Description
Artikelen
items array of object
ID-kaart
items.id string

De unieke, door square uitgegeven id.

Staat
items.state string

De huidige status.

Geopend op
items.opened_at string

De begintijd van de dienst in ISO 8601-indeling.

Beëindigd op
items.ended_at string

De eindtijd van de dienst in ISO 8601-indeling.

Gesloten om
items.closed_at string

De sluitingstijd van de dienst in ISO 8601-indeling.

Description
items.title string

De beschrijving.

Aantal
items.opened_cash_money.amount integer

Het bedrag.

Valuta
items.opened_cash_money.currency string

De valuta.

Aantal
items.expected_cash_money.amount integer

Het bedrag.

Valuta
items.expected_cash_money.currency string

De valuta.

Aantal
items.closed_cash_money.amount integer

Het bedrag.

Valuta
items.closed_cash_money.currency string

De valuta.

Fragment ophalen

Haalt uw fragment op van een Square Online-site. Een site kan fragmenten uit meerdere codefragmenttoepassingen bevatten, maar u kunt alleen het fragment ophalen dat door uw toepassing is toegevoegd.

Parameters

Name Sleutel Vereist Type Description
Site-id
site_id True string

De id van de site.

Retouren

Name Pad Type Description
ID-kaart
snippet.id string

De unieke, door square uitgegeven id.

Site-id
snippet.site_id string

De id van de site die het codefragment bevat.

Content
snippet.content string

De code voor codefragmenten, die geldige HTML, JavaScript of beide kan bevatten.

Gemaakt op
snippet.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
snippet.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Fragment verwijderen

Hiermee verwijdert u het fragment van een Square Online-site.

Parameters

Name Sleutel Vereist Type Description
Site-id
site_id True string

De id van de site.

Retouren

response
object

Gebeurtenissen van cash drawer shift weergeven

Biedt een gepagineerde lijst met gebeurtenissen voor één cash drawer shift.

Parameters

Name Sleutel Vereist Type Description
Shift-id
shift_id True string

De id van de dienst.

Locatie-id
location_id True string

U kunt dit optionele filter opgeven om alleen de records op te halen die behoren tot een specifieke locatie.

Limit
limit integer

Bovengrens voor het getal dat moet worden geretourneerd in het antwoord.

Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Retouren

Name Pad Type Description
Evenementen
events array of object
ID-kaart
events.id string

De unieke, door square uitgegeven id.

Gebeurtenistype
events.event_type string

Het type cash drawer shift-gebeurtenis.

Aantal
events.event_money.amount integer

Het bedrag.

Valuta
events.event_money.currency string

De valuta.

Gemaakt op
events.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Description
events.title string

De beschrijving.

Klant koppelen aan cadeaukaart (bèta)

Een klant koppelen aan een cadeaukaart

Parameters

Name Sleutel Vereist Type Description
Cadeaukaart-id
gift_card_id True string

De id van de cadeaukaart.

Klant-id
customer_id string

De id van de klant die moet worden gekoppeld.

Retouren

Name Pad Type Description
ID-kaart
gift_card.id string

De unieke, door square uitgegeven id.

Typologie
gift_card.type string

Het type van dit object.

GAN-bron
gift_card.gan_source string

Geeft aan of het accountnummer van de cadeaukaart (GAN) wordt gegenereerd door Square of geïmporteerd uit een niet-Vierkant systeem.

Staat
gift_card.state string

De huidige status.

Aantal
gift_card.balance_money.amount integer

Het bedrag.

Valuta
gift_card.balance_money.currency string

De valuta.

Gan
gift_card.gan string

Het rekeningnummer van de cadeaukaart.

Gemaakt op
gift_card.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Klant-id's
gift_card.customer_ids array of string

Klant loskoppelen van cadeaukaart (bèta)

Koppelt een klant los van een cadeaukaart.

Parameters

Name Sleutel Vereist Type Description
Cadeaukaart-id
gift_card_id True string

De id van de cadeaukaart.

Klant-id
customer_id string

De id van de klant die moet worden gekoppeld.

Retouren

Name Pad Type Description
ID-kaart
gift_card.id string

De unieke, door square uitgegeven id.

Typologie
gift_card.type string

Het type van dit object.

GAN-bron
gift_card.gan_source string

Geeft aan of het accountnummer van de cadeaukaart (GAN) wordt gegenereerd door Square of geïmporteerd uit een niet-Vierkant systeem.

Staat
gift_card.state string

De huidige status.

Aantal
gift_card.balance_money.amount integer

Het bedrag.

Valuta
gift_card.balance_money.currency string

De valuta.

Gan
gift_card.gan string

Het rekeningnummer van de cadeaukaart.

Gemaakt op
gift_card.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Lijstlocaties

Biedt informatie over alle locaties van een bedrijf.

Retouren

Name Pad Type Description
Locaties
locations array of object
ID-kaart
locations.id string

De unieke, door square uitgegeven id.

Naam
locations.name string

De naam van het object.

Adresregel 1
locations.address.address_line_1 string

De eerste regel van het adres.

Localiteit
locations.address.locality string

De stad of stad van het adres.

Administratief district niveau 1
locations.address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
locations.address.postal_code string

De postcode van het adres.

Country
locations.address.country string

Het land van het adres, in ISO 3166-1-alfa-2-indeling.

Timezone
locations.timezone string

De tijdzone die wordt gebruikt om kalenderdatums op de factuur te interpreteren, zoals due_date. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Capabilities
locations.capabilities array of string
Toestand
locations.status string

De huidige verificatiestatus van dit object.

Gemaakt op
locations.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Verkoop-id
locations.merchant_id string

De id van de verkoper die eigenaar is van de locatie.

Country
locations.country string

De ISO 3166 Alpha-2-landcode.

Taalcode
locations.language_code string

De taal die is gekoppeld aan de locatie, in BCP 47-indeling.

Valuta
locations.currency string

De ISO 4217-valutacode van 3 tekens.

Telefoonnummer
locations.phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Bedrijfsnaam
locations.business_name string

De bedrijfsnaam van de locatie Dit is de naam die zichtbaar is voor de klanten van de locatie. Deze naam wordt bijvoorbeeld weergegeven op klantbevestigingen.

Locatie bijwerken (bèta)

Hiermee werkt u een locatie bij.

Parameters

Name Sleutel Vereist Type Description
Locatie-id
location_id True string

De id van de locatie.

Naam
name string

De naam van het object.

Description
description string

De beschrijving.

Facebook-URL
facebook_url string

De URL van het Facebook-profiel van de locatie. De URL moet beginnen met 'facebook.com/'.

Twitter-gebruikersnaam
twitter_username string

De Twitter-gebruikersnaam van de locatie zonder het symbool @.

Instagram-gebruikersnaam
instagram_username string

De Instagram-gebruikersnaam van de locatie zonder het @-symbool.

Adresregel 1
address_line_1 string

De eerste regel van het adres. Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Administratief district niveau 1
administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Localiteit
locality string

De stad of stad van het adres.

Postcode
postal_code string

De postcode van het adres.

Dag van de week
day_of_week string

De dag van de week voor deze periode.

Lokale tijd starten
start_local_time string

De begintijd van een kantoorurenperiode, die is opgegeven in de lokale tijd met de rfc 3339-indeling voor gedeeltelijke tijd.

Lokale tijd beëindigen
end_local_time string

De eindtijd van een kantoorurenperiode, opgegeven in lokale tijd met de rfc 3339-indeling voor gedeeltelijke tijd.

Retouren

Name Pad Type Description
ID-kaart
location.id string

De unieke, door square uitgegeven id.

Naam
location.name string

De naam van het object.

Adresregel 1
location.address.address_line_1 string

De eerste regel van het adres. Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Localiteit
location.address.locality string

De stad of stad van het adres.

Administratief district niveau 1
location.address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
location.address.postal_code string

De postcode van het adres.

Timezone
location.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Capabilities
location.capabilities array of string
Toestand
location.status string

De huidige verificatiestatus van dit object.

Gemaakt op
location.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Verkoop-id
location.merchant_id string

De id van de verkoper.

Country
location.country string

De ISO 3166 Alpha-2-landcode.

Taalcode
location.language_code string

De taalcode, in BCP 47-indeling.

Valuta
location.currency string

De ISO 4217-valutacode van 3 tekens.

Telefoonnummer
location.phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Bedrijfsnaam
location.business_name string

De bedrijfsnaam van de locatie Dit is de naam die zichtbaar is voor de klanten van de locatie. Deze naam wordt bijvoorbeeld weergegeven op klantbevestigingen.

Typologie
location.type string

Het type van dit object.

Website-URL
location.website_url string

De URL van de website van de locatie.

Perioden
location.business_hours.periods array of object
Dag van de week
location.business_hours.periods.day_of_week string

De dag van de week voor deze periode.

Lokale tijd starten
location.business_hours.periods.start_local_time string

De begintijd van een kantoorurenperiode, die is opgegeven in de lokale tijd met de rfc 3339-indeling voor gedeeltelijke tijd.

Lokale tijd beëindigen
location.business_hours.periods.end_local_time string

De eindtijd van een kantoorurenperiode, opgegeven in lokale tijd met de rfc 3339-indeling voor gedeeltelijke tijd.

Zakelijke e-mail
location.business_email string

Het e-mailadres van de locatie. Deze e-mail is zichtbaar voor de klanten van de locatie. Het e-mailbericht wordt bijvoorbeeld weergegeven op klantbevestigingen.

Description
location.description string

De beschrijving.

Twitter-gebruikersnaam
location.twitter_username string

De Twitter-gebruikersnaam van de locatie zonder het symbool @.

Instagram-gebruikersnaam
location.instagram_username string

De Instagram-gebruikersnaam van de locatie zonder het @-symbool.

Breedtegraad
location.coordinates.latitude float

De breedtegraad van de coördinaat uitgedrukt in graden.

Lengtegraad
location.coordinates.longitude float

De lengtegraad van de coördinaat uitgedrukt in graden.

MCC
location.mcc string

De handelscategoriecode (MCC) van de locatie, zoals gestandaardiseerde door ISO 18245. Het MCC beschrijft het soort goederen of diensten dat op de locatie wordt verkocht.

Locatie maken (bèta)

Hiermee maakt u een locatie.

Parameters

Name Sleutel Vereist Type Description
Naam
name string

De naam van het object.

Description
description string

De beschrijving.

Facebook-URL
facebook_url string

De URL van het Facebook-profiel van de locatie. De URL moet beginnen met 'facebook.com/'.

Adresregel 1
address_line_1 string

De eerste regel van het adres. Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Administratief district niveau 1
administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Localiteit
locality string

De stad of stad van het adres.

Postcode
postal_code string

De postcode van het adres.

Retouren

Name Pad Type Description
ID-kaart
location.id string

De unieke, door square uitgegeven id.

Naam
location.name string

De naam van het object.

Adresregel 1
location.address.address_line_1 string

De eerste regel van het adres. Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Localiteit
location.address.locality string

De stad of stad van het adres.

Administratief district niveau 1
location.address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
location.address.postal_code string

De postcode van het adres.

Capabilities
location.capabilities array of string
Toestand
location.status string

De huidige verificatiestatus van dit object.

Gemaakt op
location.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Verkoop-id
location.merchant_id string

De id van de verkoper.

Country
location.country string

De ISO 3166 Alpha-2-landcode.

Taalcode
location.language_code string

De taalcode, in BCP 47-indeling.

Valuta
location.currency string

De ISO 4217-valutacode van 3 tekens.

Typologie
location.type string

Het type van dit object.

Description
location.description string

De beschrijving.

Website-URL
location.website_url string

De URL van de website van de locatie.

Twitter-gebruikersnaam
location.twitter_username string

De Twitter-gebruikersnaam van de locatie zonder het symbool @.

Instagram-gebruikersnaam
location.instagram_username string

De Instagram-gebruikersnaam van de locatie zonder het @-symbool.

Breedtegraad
location.coordinates.latitude float

De breedtegraad van de coördinaat uitgedrukt in graden.

Lengtegraad
location.coordinates.longitude float

De lengtegraad van de coördinaat uitgedrukt in graden.

MCC
location.mcc string

De handelscategoriecode (MCC) van de locatie, zoals gestandaardiseerde door ISO 18245. Het MCC beschrijft het soort goederen of diensten dat op de locatie wordt verkocht.

Locatie ophalen

Hiermee worden details van een locatie opgehaald. U kunt 'main' opgeven als de locatie-id om details van de hoofdlocatie op te halen.

Parameters

Name Sleutel Vereist Type Description
Locatie-id
location_id True string

De id van de locatie.

Retouren

Name Pad Type Description
ID-kaart
location.id string

De unieke, door square uitgegeven id.

Naam
location.name string

De naam van het object.

Adresregel 1
location.address.address_line_1 string

De eerste regel van het adres. Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Localiteit
location.address.locality string

De stad of stad van het adres.

Administratief district niveau 1
location.address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
location.address.postal_code string

De postcode van het adres.

Country
location.address.country string

Het land van het adres, in ISO 3166-1-alfa-2-indeling.

Timezone
location.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Capabilities
location.capabilities array of string
Toestand
location.status string

De huidige verificatiestatus van dit object.

Gemaakt op
location.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Verkoop-id
location.merchant_id string

De id van de verkoper.

Country
location.country string

De ISO 3166 Alpha-2-landcode.

Taalcode
location.language_code string

De taalcode, in BCP 47-indeling.

Valuta
location.currency string

De ISO 4217-valutacode van 3 tekens.

Telefoonnummer
location.phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Bedrijfsnaam
location.business_name string

De bedrijfsnaam van de locatie Dit is de naam die zichtbaar is voor de klanten van de locatie. Deze naam wordt bijvoorbeeld weergegeven op klantbevestigingen.

Loon van teamlid ophalen

Hiermee wordt één TeamMemberWage geretourneerd die is opgegeven door de id.

Parameters

Name Sleutel Vereist Type Description
ID-kaart
id True string

De id.

Retouren

Name Pad Type Description
ID-kaart
team_member_wage.id string

De unieke, door square uitgegeven id.

Teamlid-id
team_member_wage.team_member_id string

De id van het teamlid.

Title
team_member_wage.title string

De titel.

Aantal
team_member_wage.hourly_rate.amount integer

Het bedrag.

Valuta
team_member_wage.hourly_rate.currency string

De valuta.

Looninstelling bijwerken

Hiermee maakt of werkt u een WageSetting-object bij.

Parameters

Name Sleutel Vereist Type Description
Teamlid-id
team_member_id True string

De id van het teamlid.

Is vrijgesteld van overuren
is_overtime_exempt boolean

Of het teamlid is vrijgesteld van de overurenregels van het land van de verkoper.

Functietitel
job_title string

De titel van de taak.

Betalingstype
pay_type string

Het huidige betalingstype voor de taaktoewijzing die wordt gebruikt om het betalingsbedrag in een betalingsperiode te berekenen.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Wekelijkse uren
weekly_hours integer

De geplande uren per week voor de taak. Stel in of de job PayType SALARIS is.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Retouren

Name Pad Type Description
Teamlid-id
wage_setting.team_member_id string

De id van het teamlid.

Taaktoewijzingen
wage_setting.job_assignments array of object
Functietitel
wage_setting.job_assignments.job_title string

De titel van de taak.

Betalingstype
wage_setting.job_assignments.pay_type string

Het huidige betalingstype voor de taaktoewijzing die wordt gebruikt om het betalingsbedrag in een betalingsperiode te berekenen.

Aantal
wage_setting.job_assignments.hourly_rate.amount integer

Het bedrag.

Valuta
wage_setting.job_assignments.hourly_rate.currency string

De valuta.

Aantal
wage_setting.job_assignments.annual_rate.amount integer

Het bedrag.

Valuta
wage_setting.job_assignments.annual_rate.currency string

De valuta.

Wekelijkse uren
wage_setting.job_assignments.weekly_hours integer

De geplande uren per week voor de taak. Stel in of de job PayType SALARIS is.

Is vrijgesteld van overuren
wage_setting.is_overtime_exempt boolean

Of het teamlid is vrijgesteld van de overurenregels van het land van de verkoper.

Versie
wage_setting.version integer

De huidige versie van dit object.

Gemaakt op
wage_setting.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
wage_setting.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Looninstelling ophalen

Hiermee wordt een WageSetting-object opgehaald voor een teamlid dat is opgegeven door teamlid-id.

Parameters

Name Sleutel Vereist Type Description
Teamlid-id
team_member_id True string

De id van het teamlid.

Retouren

Name Pad Type Description
Teamlid-id
wage_setting.team_member_id string

De id van het teamlid.

Taaktoewijzingen
wage_setting.job_assignments array of object
Functietitel
wage_setting.job_assignments.job_title string

De titel van de taak.

Betalingstype
wage_setting.job_assignments.pay_type string

Het huidige betalingstype voor de taaktoewijzing die wordt gebruikt om het betalingsbedrag in een betalingsperiode te berekenen.

Aantal
wage_setting.job_assignments.hourly_rate.amount integer

Het bedrag.

Valuta
wage_setting.job_assignments.hourly_rate.currency string

De valuta.

Aantal
wage_setting.job_assignments.annual_rate.amount integer

Het bedrag.

Valuta
wage_setting.job_assignments.annual_rate.currency string

De valuta.

Wekelijkse uren
wage_setting.job_assignments.weekly_hours integer

De geplande uren per week voor de taak. Stel in of de job PayType SALARIS is.

Is vrijgesteld van overuren
wage_setting.is_overtime_exempt boolean

Of het teamlid is vrijgesteld van de overurenregels van het land van de verkoper.

Versie
wage_setting.version integer

De huidige versie van dit object.

Gemaakt op
wage_setting.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
wage_setting.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Loyaliteitsaccount maken

Hiermee maakt u een loyaliteitsaccount.

Parameters

Name Sleutel Vereist Type Description
Telefoonnummer
phone_number string

Het telefoonnummer van de geadresseerde.

Programma-id
program_id string

De door het vierkant toegewezen id van het programma.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Retouren

Name Pad Type Description
ID-kaart
loyalty_account.id string

De unieke, door square uitgegeven id.

ID-kaart
loyalty_account.mapping.id string

De door het vierkant toegewezen id.

Telefoonnummer
loyalty_account.mapping.phone_number string

Het telefoonnummer van de geadresseerde.

Gemaakt op
loyalty_account.mapping.created_at string

De tijdstempel bij het maken, in RFC 3339-indeling.

Programma-id
loyalty_account.program_id string

De door het vierkant toegewezen id van het programma.

Saldo
loyalty_account.balance integer

Het beschikbare saldo.

Levensduurpunten
loyalty_account.lifetime_points integer

Het totale aantal punten dat is opgebouwd tijdens de levensduur van het account.

Gemaakt op
loyalty_account.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
loyalty_account.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Loyaliteitsaccount ophalen

Haalt een loyaliteitsaccount op.

Parameters

Name Sleutel Vereist Type Description
Account-ID
account_id True string

De id van het account.

Retouren

Name Pad Type Description
ID-kaart
loyalty_account.id string

De unieke, door square uitgegeven id.

ID-kaart
loyalty_account.mapping.id string

De door het vierkant toegewezen id.

Telefoonnummer
loyalty_account.mapping.phone_number string

Het telefoonnummer van de geadresseerde.

Gemaakt op
loyalty_account.mapping.created_at string

De tijdstempel bij het maken, in RFC 3339-indeling.

Programma-id
loyalty_account.program_id string

De door het vierkant toegewezen id van het programma.

Saldo
loyalty_account.balance integer

Het beschikbare saldo.

Levensduurpunten
loyalty_account.lifetime_points integer

Het totale aantal punten dat is opgebouwd tijdens de levensduur van het account.

Klant-id
loyalty_account.customer_id string

De id van dit object die de klant vertegenwoordigt.

Gemaakt op
loyalty_account.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
loyalty_account.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Loyaliteitsbeloning inwisselen

Verzilvert een loyaliteitsbeloning. Nadat de beloning de terminalstatus heeft bereikt, kan deze niet worden verwijderd. Met andere woorden, punten die voor de beloning worden gebruikt, kunnen niet worden geretourneerd naar het account.

Parameters

Name Sleutel Vereist Type Description
Belonings-id
reward_id True string

De id van de beloning.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Locatie-id
location_id string

De locatie-id.

Retouren

Name Pad Type Description
ID-kaart
event.id string

De unieke, door square uitgegeven id.

Typologie
event.type string

Het type van dit object.

Gemaakt op
event.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Loyaliteitsprogramma-id
event.redeem_reward.loyalty_program_id string

De id van het loyaliteitsprogramma

Belonings-id
event.redeem_reward.reward_id string

De door square toegewezen id van de loyaliteitsbeloning.

Loyaliteitsaccount-id
event.loyalty_account_id string

De id van het loyaliteitsaccount waarin de gebeurtenis plaatsvond.

Locatie-id
event.location_id string

De id van de locatie.

Bron
event.source string

De bron.

Loyaliteitsbeloning maken

Creëert een loyaliteitsbeloning. Nadat een beloning is gemaakt, zijn de punten vergrendeld en niet beschikbaar voor de koper om een andere beloning in te wisselen.

Parameters

Name Sleutel Vereist Type Description
Loyaliteitsaccount-id
loyalty_account_id string

De id van het loyaliteitsaccount waarin de gebeurtenis plaatsvond.

Id van beloningslaag
reward_tier_id string

De door square toegewezen id van de beloningslaag die wordt gebruikt om de beloning te maken.

Order-id
order_id string

De id van de order.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Retouren

Name Pad Type Description
ID-kaart
reward.id string

De unieke, door square uitgegeven id.

Toestand
reward.status string

De huidige verificatiestatus van dit object.

Loyaliteitsaccount-id
reward.loyalty_account_id string

De id van het loyaliteitsaccount waarin de gebeurtenis plaatsvond.

Id van beloningslaag
reward.reward_tier_id string

De door square toegewezen id van de beloningslaag die wordt gebruikt om de beloning te maken.

Punten
reward.points integer

Het aantal toegevoegde of verwijderde punten.

Order-id
reward.order_id string

De id van de order.

Gemaakt op
reward.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
reward.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Loyaliteitsbeloning ophalen

Haalt een loyaliteitsbeloning op.

Parameters

Name Sleutel Vereist Type Description
Belonings-id
reward_id True string

De id van de beloning.

Retouren

Name Pad Type Description
ID-kaart
reward.id string

De unieke, door square uitgegeven id.

Toestand
reward.status string

De huidige verificatiestatus van dit object.

Loyaliteitsaccount-id
reward.loyalty_account_id string

De id van het loyaliteitsaccount waarin de gebeurtenis plaatsvond.

Id van beloningslaag
reward.reward_tier_id string

De door square toegewezen id van de beloningslaag die wordt gebruikt om de beloning te maken.

Punten
reward.points integer

Het aantal toegevoegde of verwijderde punten.

Gemaakt op
reward.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
reward.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Ingewisseld op
reward.redeemed_at string

De tijdstempel toen de beloning werd ingewisseld, in RFC 3339-indeling.

Loyaliteitsbeloning verwijderen

Hiermee verwijdert u een loyaliteitsbeloning. Retourneert de loyaliteitspunten terug naar het loyaliteitsaccount. U kunt een beloning die de terminalstatus (INGEWISSELD) heeft bereikt, niet verwijderen.

Parameters

Name Sleutel Vereist Type Description
Belonings-id
reward_id True string

De id van de beloning.

Retouren

response
object

Loyaliteitsbeloningen zoeken

Zoekt naar loyaliteitsbeloningen in een loyaliteitsrekening.

Parameters

Name Sleutel Vereist Type Description
Loyaliteitsaccount-id
loyalty_account_id string

De id van het loyaliteitsaccount waarin de gebeurtenis plaatsvond.

Limit
limit integer

Een limiet voor het aantal resultaten dat op één pagina moet worden geretourneerd. De limiet is advies: de implementatie kan meer of minder resultaten opleveren. Als de opgegeven limiet negatief, nul of hoger is dan de maximumlimiet van 1000, wordt deze genegeerd.

Retouren

Name Pad Type Description
Beloningen
rewards array of object
ID-kaart
rewards.id string

De unieke, door square uitgegeven id.

Toestand
rewards.status string

De huidige verificatiestatus van dit object.

Loyaliteitsaccount-id
rewards.loyalty_account_id string

De id van het loyaliteitsaccount waarin de gebeurtenis plaatsvond.

Id van beloningslaag
rewards.reward_tier_id string

De door square toegewezen id van de beloningslaag die wordt gebruikt om de beloning te maken.

Punten
rewards.points integer

Het aantal loyaliteitspunten dat wordt gebruikt voor de beloning.

Order-id
rewards.order_id string

De id van de order.

Gemaakt op
rewards.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
rewards.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Ingewisseld op
rewards.redeemed_at string

De tijdstempel toen de beloning werd ingewisseld, in RFC 3339-indeling.

Loyaliteitsprogramma ophalen

Haalt het loyaliteitsprogramma op in het account van een verkoper, opgegeven door de programma-id of het belangrijkste trefwoord. Loyaliteitsprogramma's bepalen hoe kopers punten kunnen verdienen en punten kunnen inwisselen voor beloningen.

Parameters

Name Sleutel Vereist Type Description
Programma-id
program_id True string

De id van het programma.

Retouren

Name Pad Type Description
ID-kaart
program.id string

De unieke, door square uitgegeven id.

Toestand
program.status string

De huidige verificatiestatus van dit object.

Beloningslagen
program.reward_tiers array of object
ID-kaart
program.reward_tiers.id string

De id van het object

Punten
program.reward_tiers.points integer

Het aantal punten dat door de gebeurtenis is verzameld.

Naam
program.reward_tiers.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Scope
program.reward_tiers.definition.scope string

Geeft het niveau aan waarop het object van toepassing is.

Kortingstype
program.reward_tiers.definition.discount_type string

Het type korting dat de beloningslaag biedt.

Kortingspercentage
program.reward_tiers.definition.percentage_discount string

Het vaste percentage van de korting.

Gemaakt op
program.reward_tiers.created_at string

De tijdstempel bij het maken, in RFC 3339-indeling.

Object-ID
program.reward_tiers.pricing_rule_reference.object_id string

De id van het object waarnaar wordt verwezen.

Catalogusversie
program.reward_tiers.pricing_rule_reference.catalog_version string

De versie van het object.

One
program.terminology.one string

Een enkelvoudige eenheid voor een punt (bijvoorbeeld 1 punt wordt 1 ster genoemd).

Other
program.terminology.other string

Een meervoudseenheid voor punt (bijvoorbeeld 10 punten wordt 10 sterren genoemd).

Locatie-id's
program.location_ids array of string
Gemaakt op
program.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
program.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Toerekeningsregels
program.accrual_rules array of object
Toerekeningstype
program.accrual_rules.accrual_type string

Het type van de toerekeningsregel die definieert hoe kopers punten kunnen verdienen.

Punten
program.accrual_rules.points integer

Het aantal punten dat door de gebeurtenis is verzameld.

Aantal
program.accrual_rules.spend_amount_money.amount integer

Het bedrag.

Uitgesloten categorie-id's
program.accrual_rules.excluded_category_ids array of string
Uitgesloten itemvariatie-id's
program.accrual_rules.excluded_item_variation_ids array of string

Loyaliteitspunten aanpassen

Hiermee voegt u punten toe aan of trekt u punten af van het account van een koper. Gebruik dit eindpunt alleen als u punten handmatig moet aanpassen.

Parameters

Name Sleutel Vereist Type Description
Account-ID
account_id True string

De id van het account.

Punten
points integer

Het aantal toegevoegde of verwijderde punten.

Reden
reason string

De reden voor dit object.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Retouren

Name Pad Type Description
ID-kaart
event.id string

De unieke, door square uitgegeven id.

Typologie
event.type string

Het type van dit object.

Gemaakt op
event.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Loyaliteitsprogramma-id
event.adjust_points.loyalty_program_id string

De id van het loyaliteitsprogramma

Punten
event.adjust_points.points integer

Het aantal punten dat door de gebeurtenis is verzameld.

Reden
event.adjust_points.reason string

De reden voor de aanpassing van punten.

Loyaliteitsaccount-id
event.loyalty_account_id string

De id van het loyaliteitsaccount waarin de gebeurtenis plaatsvond.

Bron
event.source string

De bron.

Loyaliteitspunten berekenen

Berekent de punten die een aankoop verdient. Een toepassing kan dit eindpunt aanroepen om de punten weer te geven die een koper kan verdienen met de specifieke aankoop.

Parameters

Name Sleutel Vereist Type Description
Programma-id
program_id True string

De id van het programma.

Order-id
order_id string

De order-id.

Retouren

Name Pad Type Description
Punten
points integer

De punten die de koper kan verdienen bij een opgegeven aankoop.

Loyaliteitspunten verzamelen

Voegt punten toe aan een loyaliteitsrekening.

Parameters

Name Sleutel Vereist Type Description
Account-ID
account_id True string

De id van het account.

Order-id
order_id string

De id van de order.

Locatie-id
location_id string

De locatie-id.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Retouren

Name Pad Type Description
ID-kaart
event.id string

De unieke, door square uitgegeven id.

Typologie
event.type string

Het type van dit object.

Gemaakt op
event.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Loyaliteitsprogramma-id
event.accumulate_points.loyalty_program_id string

De id van het loyaliteitsprogramma

Punten
event.accumulate_points.points integer

Het aantal punten dat door de gebeurtenis is verzameld.

Order-id
event.accumulate_points.order_id string

De id van de volgorde die aan de activiteit is gekoppeld.

Loyaliteitsaccount-id
event.loyalty_account_id string

De id van het loyaliteitsaccount waarin de gebeurtenis plaatsvond.

Locatie-id
event.location_id string

De id van de locatie.

Bron
event.source string

De bron.

Mobiele autorisatiecode maken

Hiermee genereert u code voor het autoriseren van een mobiele toepassing om verbinding te maken met een vierkante kaartlezer. Autorisatiecodes zijn eenmalig en verlopen 60 minuten nadat ze zijn uitgegeven.

Parameters

Name Sleutel Vereist Type Description
Locatie-id
location_id string

De locatie-id.

Retouren

Name Pad Type Description
Autorisatiecode
authorization_code string

Gegenereerde autorisatiecode waarmee een exemplaar van een mobiele toepassing wordt verbonden met een Square-account.

Verloopt op
expires_at string

De tijdstempel wanneer authorization_code verloopt in RFC 3339-indeling.

Reservering maken (bèta)

Hiermee maakt u een reservering.

Parameters

Name Sleutel Vereist Type Description
Klant-id
customer_id string

De id van dit object die de klant vertegenwoordigt.

Beginnen bij
start_at string

De tijdstempel die de begintijd van dit object aangeeft, in RFC 3339-indeling.

Locatie-id
location_id string

De id van de locatie.

Duur van minuten
duration_minutes integer

De tijdsduur in minuten van een afspraaksegment.

Teamlid-id
team_member_id string

De id van het TeamMember-object dat het teamlid vertegenwoordigt dat in dit segment is geboekt.

Servicevariatie-id
service_variation_id string

De id van het Object CatalogItemVariation die de service vertegenwoordigt die in dit segment is geboekt.

Servicevariatieversie
service_variation_version integer

De huidige versie van de itemvariatie die de service vertegenwoordigt die in dit segment is geboekt.

Retouren

Name Pad Type Description
ID-kaart
booking.id string

De unieke, door square uitgegeven id.

Versie
booking.version integer

De huidige versie van dit object.

Toestand
booking.status string

De huidige verificatiestatus van dit object.

Gemaakt op
booking.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
booking.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Locatie-id
booking.location_id string

De id van de locatie.

Klant-id
booking.customer_id string

De id van dit object die de klant vertegenwoordigt.

Klantnotitie
booking.customer_note string

Het veld vrije tekst voor de klant om notities over de boeking te verstrekken.

Verkopernotitie
booking.seller_note string

Het veld vrije tekst voor de verkoper om notities over de boeking te verstrekken.

Beginnen bij
booking.start_at string

De tijdstempel die de begintijd van dit object aangeeft, in RFC 3339-indeling.

Afspraaksegment
booking.appointment_segments array of object
Duur van minuten
booking.appointment_segments.duration_minutes integer

De tijdsduur in minuten van een afspraaksegment.

Servicevariatie-id
booking.appointment_segments.service_variation_id string

De id van het Object CatalogItemVariation die de service vertegenwoordigt die in dit segment is geboekt.

Teamlid-id
booking.appointment_segments.team_member_id string

De id van het TeamMember-object dat het teamlid vertegenwoordigt dat in dit segment is geboekt.

Servicevariatieversie
booking.appointment_segments.service_variation_version integer

De huidige versie van de itemvariatie die de service vertegenwoordigt die in dit segment is geboekt.

Errors
errors array of

Reserveringsprofielen voor teamleden vermelden (bèta)

Bevat reserveringsprofielen voor teamleden.

Parameters

Name Sleutel Vereist Type Description
Alleen boekbaar
bookable_only boolean

Geeft aan of alleen boekbare teamleden moeten worden opgenomen in het geretourneerde resultaat (true) of niet (onwaar).

Limit
limit integer

Bovengrens voor het getal dat moet worden geretourneerd in het antwoord.

Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Locatie-id
location_id string

U kunt dit optionele filter opgeven om alleen de records op te halen die behoren tot een specifieke locatie.

Retouren

Name Pad Type Description
Reserveringsprofielen voor teamleden
team_member_booking_profiles array of object
Teamlid-id
team_member_booking_profiles.team_member_id string

De id van het TeamMember-object voor het teamlid dat aan het object is gekoppeld.

Weergavenaam
team_member_booking_profiles.display_name string

De weergavenaam van het teamlid.

Is boekbaar
team_member_booking_profiles.is_bookable boolean

Hiermee wordt aangegeven of het teamlid kan worden geboekt via de Bookings-API of het online boekingskanaal of de site van de verkoper (waar) of niet (onwaar).'

Errors
errors array of

Salarissen van teamleden vermelden

Retourneert een gepagineerde lijst met TeamMemberWage-exemplaren voor een bedrijf.

Parameters

Name Sleutel Vereist Type Description
Teamlid-id
team_member_id string

Filter de geretourneerde lonen alleen op de lonen die zijn gekoppeld aan het opgegeven teamlid.

Limit
limit integer

Bovengrens voor het getal dat moet worden geretourneerd in het antwoord.

Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Retouren

Name Pad Type Description
Salarissen van teamlid
team_member_wages array of object
ID-kaart
team_member_wages.id string

De unieke, door square uitgegeven id.

Teamlid-id
team_member_wages.team_member_id string

De id van het TeamMember-object voor het teamlid dat aan het object is gekoppeld.

Title
team_member_wages.title string

De titel van de factuur.

Aantal
team_member_wages.hourly_rate.amount integer

Het bedrag.

Valuta
team_member_wages.hourly_rate.currency string

De valuta.

Cursor
cursor string

Neem de pagineringscursor op in volgende aanroepen naar dit eindpunt om de volgende set resultaten op te halen die zijn gekoppeld aan de oorspronkelijke query.

Shift bijwerken

Hiermee wordt een bestaande Shift bijgewerkt.

Parameters

Name Sleutel Vereist Type Description
ID-kaart
id True string

De id.

Teamlid-id
team_member_id string

De id van het teamlid.

Locatie-id
location_id string

De id van de locatie.

Beginnen bij
start_at string

De tijdstempel die de begintijd van dit object aangeeft, in RFC 3339-indeling.

Eindigen op
end_at string

RFC 3339; verschoven naar de tijdzone + offset. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Title
title string

De naam van de taak die tijdens deze dienst is uitgevoerd. Vierkante arbeidsrapportage-URI's kunnen verschuivingen groeperen op titel.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

ID-kaart
id string

De id van het object

Beginnen bij
start_at string

RFC 3339; volgt dezelfde tijdzone-informatie als Shift. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Eindigen op
end_at string

RFC 3339; volgt dezelfde tijdzone-informatie als Shift. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Type-id einde
break_type_id string

Het BreakType waarop dit einde is geconfigureerd.

Naam
name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Verwachte duur
expected_duration string

De verwachte lengte van de onderbreking. Indeling: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.

Wordt betaald
is_paid boolean

Of deze onderbreking telt voor tijd die voor compensatiedoeleinden wordt gewerkt.

Versie
version integer

De huidige versie van dit object.

Retouren

Name Pad Type Description
ID-kaart
shift.id string

De unieke, door square uitgegeven id.

Teamlid-id
shift.team_member_id string

De id van het teamlid.

Werknemer-id
shift.employee_id string

De door het vierkant gegenereerde id van de werknemer.

Locatie-id
shift.location_id string

De id van de locatie.

Timezone
shift.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Beginnen bij
shift.start_at string

De tijdstempel die de begintijd van dit object aangeeft, in RFC 3339-indeling.

Eindigen op
shift.end_at string

RFC 3339; verschoven naar de tijdzone + offset. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Title
shift.wage.title string

De naam van de taak die tijdens deze dienst is uitgevoerd. Vierkante arbeidsrapportage-URI's kunnen verschuivingen groeperen op titel.

Aantal
shift.wage.hourly_rate.amount integer

Het bedrag.

Valuta
shift.wage.hourly_rate.currency string

De valuta.

Pauzes
shift.breaks array of object
ID-kaart
shift.breaks.id string

De id van het object

Beginnen bij
shift.breaks.start_at string

RFC 3339; volgt dezelfde tijdzone-informatie als Shift. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Eindigen op
shift.breaks.end_at string

RFC 3339; volgt dezelfde tijdzone-informatie als Shift. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Type-id einde
shift.breaks.break_type_id string

Het BreakType waarop dit einde is geconfigureerd.

Naam
shift.breaks.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Verwachte duur
shift.breaks.expected_duration string

De verwachte lengte van de onderbreking. Indeling: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.

Wordt betaald
shift.breaks.is_paid boolean

Of deze onderbreking telt voor tijd die voor compensatiedoeleinden wordt gewerkt.

Toestand
shift.status string

De huidige verificatiestatus van dit object.

Versie
shift.version integer

De huidige versie van dit object.

Gemaakt op
shift.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
shift.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Shift maken

Hiermee maakt u een nieuwe Shift. Een dienst vertegenwoordigt een volledige werkdag voor één werknemer

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Teamlid-id
team_member_id string

De id van het teamlid.

Locatie-id
location_id string

De id van de locatie.

Beginnen bij
start_at string

De tijdstempel die de begintijd van dit object aangeeft, in RFC 3339-indeling.

Eindigen op
end_at string

RFC 3339; verschoven naar de tijdzone + offset. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Title
title string

De naam van de taak die tijdens deze dienst is uitgevoerd. Vierkante arbeidsrapportage-URI's kunnen verschuivingen groeperen op titel.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Beginnen bij
start_at string

RFC 3339; volgt dezelfde tijdzone-informatie als Shift. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Eindigen op
end_at string

RFC 3339; volgt dezelfde tijdzone-informatie als Shift. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Type-id einde
break_type_id string

Het BreakType waarop dit einde is geconfigureerd.

Naam
name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Verwachte duur
expected_duration string

De verwachte lengte van de onderbreking. Indeling: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.

Wordt betaald
is_paid boolean

Of deze onderbreking telt voor tijd die voor compensatiedoeleinden wordt gewerkt.

Retouren

Name Pad Type Description
ID-kaart
shift.id string

De unieke, door square uitgegeven id.

Teamlid-id
shift.team_member_id string

De id van het teamlid.

Werknemer-id
shift.employee_id string

De door het vierkant gegenereerde id van de werknemer.

Locatie-id
shift.location_id string

De id van de locatie.

Timezone
shift.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Beginnen bij
shift.start_at string

De tijdstempel die de begintijd van dit object aangeeft, in RFC 3339-indeling.

Eindigen op
shift.end_at string

RFC 3339; verschoven naar de tijdzone + offset. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Title
shift.wage.title string

De naam van de taak die tijdens deze dienst is uitgevoerd. Vierkante arbeidsrapportage-URI's kunnen verschuivingen groeperen op titel.

Aantal
shift.wage.hourly_rate.amount integer

Het bedrag.

Valuta
shift.wage.hourly_rate.currency string

De valuta.

Pauzes
shift.breaks array of object
ID-kaart
shift.breaks.id string

De id van het object

Beginnen bij
shift.breaks.start_at string

RFC 3339; volgt dezelfde tijdzone-informatie als Shift. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Eindigen op
shift.breaks.end_at string

RFC 3339; volgt dezelfde tijdzone-informatie als Shift. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Type-id einde
shift.breaks.break_type_id string

Het BreakType waarop dit einde is geconfigureerd.

Naam
shift.breaks.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Verwachte duur
shift.breaks.expected_duration string

De verwachte lengte van de onderbreking. Indeling: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.

Wordt betaald
shift.breaks.is_paid boolean

Of deze onderbreking telt voor tijd die voor compensatiedoeleinden wordt gewerkt.

Toestand
shift.status string

De huidige verificatiestatus van dit object.

Versie
shift.version integer

De huidige versie van dit object.

Gemaakt op
shift.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
shift.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Shift ophalen

Retourneert één shift die is opgegeven met id.

Parameters

Name Sleutel Vereist Type Description
ID-kaart
id True string

De id.

Retouren

Name Pad Type Description
ID-kaart
shift.id string

De unieke, door square uitgegeven id.

Teamlid-id
shift.team_member_id string

De id van het teamlid.

Werknemer-id
shift.employee_id string

De door het vierkant gegenereerde id van de werknemer.

Locatie-id
shift.location_id string

De id van de locatie.

Timezone
shift.timezone string

De tijdzone die wordt gebruikt om kalenderdatums te interpreteren. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Beginnen bij
shift.start_at string

De tijdstempel die de begintijd van dit object aangeeft, in RFC 3339-indeling.

Eindigen op
shift.end_at string

RFC 3339; verschoven naar de tijdzone + offset. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Title
shift.wage.title string

De naam van de taak die tijdens deze dienst is uitgevoerd. Vierkante arbeidsrapportage-URI's kunnen verschuivingen groeperen op titel.

Aantal
shift.wage.hourly_rate.amount integer

Het bedrag.

Valuta
shift.wage.hourly_rate.currency string

De valuta.

Pauzes
shift.breaks array of object
ID-kaart
shift.breaks.id string

De id van het object

Beginnen bij
shift.breaks.start_at string

RFC 3339; volgt dezelfde tijdzone-informatie als Shift. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Eindigen op
shift.breaks.end_at string

RFC 3339; volgt dezelfde tijdzone-informatie als Shift. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Type-id einde
shift.breaks.break_type_id string

Het BreakType waarop dit einde is geconfigureerd.

Naam
shift.breaks.name string

De naam van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters, de waarde mag niet leeg zijn en de lengte is van Unicode-codepunten.

Verwachte duur
shift.breaks.expected_duration string

De verwachte lengte van de onderbreking. Indeling: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.

Wordt betaald
shift.breaks.is_paid boolean

Of deze onderbreking telt voor tijd die voor compensatiedoeleinden wordt gewerkt.

Toestand
shift.status string

De huidige verificatiestatus van dit object.

Versie
shift.version integer

De huidige versie van dit object.

Gemaakt op
shift.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
shift.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Shift verwijderen

Hiermee verwijdert u een dienst

Parameters

Name Sleutel Vereist Type Description
ID-kaart
id True string

De id.

Retouren

response
object

Sites weergeven

Geeft een lijst weer van de Square Online sites die deel uitmaken van een verkoper.

Retouren

Name Pad Type Description
Sites
sites array of object
ID-kaart
sites.id string

De unieke, door square uitgegeven id.

Sitetitel
sites.site_title string

De titel van de site.

Domein
sites.domain string

Het domein van de site (zonder het protocol).

Is gepubliceerd
sites.is_published boolean

Geeft aan of de site is gepubliceerd.

Gemaakt op
sites.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
sites.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Teamleden bulksgewijs bijwerken

Hiermee worden meerdere TeamMember-objecten bijgewerkt.

Parameters

Name Sleutel Vereist Type Description
Referentie-id
reference_id string

Een tweede id die wordt gebruikt om het teamlid te koppelen aan een entiteit in een ander systeem.

Is eigenaar
is_owner boolean

Of het teamlid de eigenaar is van het Square-account.

Toestand
status string

Beschrijft de status van het teamlid.

Voornaam
given_name string

De opgegeven naam (de voornaam) die is gekoppeld aan het teamlid.

Achternaam
family_name string

De familienaam (de achternaam) die is gekoppeld aan het teamlid.

E-mailadres
email_address string

Het e-mailadres dat is gekoppeld aan het teamlid.

Telefoonnummer
phone_number string

Het telefoonnummer van het teamlid, in E.164-indeling.

Locatie-id's
location_ids array of string
Toewijzingstype
assignment_type string

Het huidige toewijzingstype van het teamlid.

Referentie-id
reference_id string

Een tweede id die wordt gebruikt om het teamlid te koppelen aan een entiteit in een ander systeem.

Is eigenaar
is_owner boolean

Of het teamlid de eigenaar is van het Square-account.

Toestand
status string

Beschrijft de status van het teamlid.

Voornaam
given_name string

De opgegeven naam (de voornaam) die is gekoppeld aan het teamlid.

Achternaam
family_name string

De familienaam (de achternaam) die is gekoppeld aan het teamlid.

E-mailadres
email_address string

Het e-mailadres dat is gekoppeld aan het teamlid.

Telefoonnummer
phone_number string

Het telefoonnummer van het teamlid, in E.164-indeling.

Toewijzingstype
assignment_type string

Het huidige toewijzingstype van het teamlid.

Retouren

Name Pad Type Description
ID-kaart
team_members.team_member_id.team_member.id string

Een id om naar dit object te verwijzen.

Referentie-id
team_members.team_member_id.team_member.reference_id string

Een tweede id die wordt gebruikt om het teamlid te koppelen aan een entiteit in een ander systeem.

Is eigenaar
team_members.team_member_id.team_member.is_owner boolean

Of het teamlid de eigenaar is van het Square-account.

Toestand
team_members.team_member_id.team_member.status string

Beschrijft de status van het teamlid.

Voornaam
team_members.team_member_id.team_member.given_name string

De opgegeven naam (de voornaam) die is gekoppeld aan het teamlid.

Achternaam
team_members.team_member_id.team_member.family_name string

De familienaam (de achternaam) die is gekoppeld aan het teamlid.

E-mailadres
team_members.team_member_id.team_member.email_address string

Het e-mailadres dat is gekoppeld aan het teamlid.

Telefoonnummer
team_members.team_member_id.team_member.phone_number string

Het telefoonnummer van het teamlid, in E.164-indeling.

Gemaakt op
team_members.team_member_id.team_member.created_at string

De tijdstempel, in RFC 3339-indeling, die beschrijft wanneer het teamlid is gemaakt

Toewijzingstype
team_members.team_member_id.team_member.assigned_locations.assignment_type string

Het huidige toewijzingstype van het teamlid.

Locatie-id's
team_members.team_member_id.team_member.assigned_locations.location_ids array of string

Teamleden bulksgewijs maken

Hiermee maakt u meerdere TeamMember-objecten.

Parameters

Name Sleutel Vereist Type Description
Voornaam
given_name string

De opgegeven naam (de voornaam) die is gekoppeld aan het teamlid.

Achternaam
family_name string

De familienaam (de achternaam) die is gekoppeld aan het teamlid.

E-mailadres
email_address string

Het e-mailadres dat is gekoppeld aan het teamlid.

Referentie-id
reference_id string

Een tweede id die wordt gebruikt om het teamlid te koppelen aan een entiteit in een ander systeem.

Telefoonnummer
phone_number string

Het telefoonnummer van het teamlid, in E.164-indeling.

Locatie-id's
location_ids array of string
Toewijzingstype
assignment_type string

Het huidige toewijzingstype van het teamlid.

Voornaam
given_name string

De opgegeven naam (de voornaam) die is gekoppeld aan het teamlid.

Achternaam
family_name string

De familienaam (de achternaam) die is gekoppeld aan het teamlid.

E-mailadres
email_address string

Het e-mailadres dat is gekoppeld aan het teamlid.

Referentie-id
reference_id string

Een tweede id die wordt gebruikt om het teamlid te koppelen aan een entiteit in een ander systeem.

Telefoonnummer
phone_number string

Het telefoonnummer van het teamlid, in E.164-indeling.

Toewijzingstype
assignment_type string

Het huidige toewijzingstype van het teamlid.

Retouren

Name Pad Type Description
ID-kaart
team_members.idempotency-key-1.team_member.id string

Een id om naar dit object te verwijzen.

Referentie-id
team_members.idempotency-key-1.team_member.reference_id string

Een tweede id die wordt gebruikt om het teamlid te koppelen aan een entiteit in een ander systeem.

Is eigenaar
team_members.idempotency-key-1.team_member.is_owner boolean

Of het teamlid de eigenaar is van het Square-account.

Toestand
team_members.idempotency-key-1.team_member.status string

Beschrijft de status van het teamlid.

Voornaam
team_members.idempotency-key-1.team_member.given_name string

De opgegeven naam (de voornaam) die is gekoppeld aan het teamlid.

Achternaam
team_members.idempotency-key-1.team_member.family_name string

De familienaam (de achternaam) die is gekoppeld aan het teamlid.

E-mailadres
team_members.idempotency-key-1.team_member.email_address string

Het e-mailadres dat is gekoppeld aan het teamlid.

Telefoonnummer
team_members.idempotency-key-1.team_member.phone_number string

Het telefoonnummer van het teamlid, in E.164-indeling.

Toewijzingstype
team_members.idempotency-key-1.team_member.assigned_locations.assignment_type string

Het huidige toewijzingstype van het teamlid.

Locatie-id's
team_members.idempotency-key-1.team_member.assigned_locations.location_ids array of string
ID-kaart
team_members.idempotency-key-2.team_member.id string

Een id om naar dit object te verwijzen.

Referentie-id
team_members.idempotency-key-2.team_member.reference_id string

Een tweede id die wordt gebruikt om het teamlid te koppelen aan een entiteit in een ander systeem.

Is eigenaar
team_members.idempotency-key-2.team_member.is_owner boolean

Of het teamlid de eigenaar is van het Square-account.

Toestand
team_members.idempotency-key-2.team_member.status string

Beschrijft de status van het teamlid.

Voornaam
team_members.idempotency-key-2.team_member.given_name string

De opgegeven naam (de voornaam) die is gekoppeld aan het teamlid.

Achternaam
team_members.idempotency-key-2.team_member.family_name string

De familienaam (de achternaam) die is gekoppeld aan het teamlid.

E-mailadres
team_members.idempotency-key-2.team_member.email_address string

Het e-mailadres dat is gekoppeld aan het teamlid.

Telefoonnummer
team_members.idempotency-key-2.team_member.phone_number string

Het telefoonnummer van het teamlid, in E.164-indeling.

Toewijzingstype
team_members.idempotency-key-2.team_member.assigned_locations.assignment_type string

Het huidige toewijzingstype van het teamlid.

Teamleden zoeken

Hiermee wordt een gepagineerde lijst met TeamMember-objecten voor een bedrijf geretourneerd.

Parameters

Name Sleutel Vereist Type Description
Locatie-id's
location_ids array of string
Toestand
status string

De huidige status.

Limit
limit integer

Een limiet voor het aantal resultaten dat op één pagina moet worden geretourneerd. De limiet is advies: de implementatie kan meer of minder resultaten opleveren. Als de opgegeven limiet negatief, nul of hoger is dan de maximumlimiet van 1000, wordt deze genegeerd.

Retouren

Name Pad Type Description
Teamleden
team_members array of object
ID-kaart
team_members.id string

De unieke, door square uitgegeven id.

Referentie-id
team_members.reference_id string

Een optionele tweede id die wordt gebruikt om het klantprofiel te koppelen aan een entiteit in een ander systeem.

Is eigenaar
team_members.is_owner boolean

Of het teamlid de eigenaar is van het Square-account.

Toestand
team_members.status string

De huidige verificatiestatus van dit object.

Voornaam
team_members.given_name string

De opgegeven naam (bijvoorbeeld voornaam) die is gekoppeld aan het klantprofiel.

Achternaam
team_members.family_name string

De familienaam (bijvoorbeeld achternaam) die is gekoppeld aan het klantprofiel.

E-mailadres
team_members.email_address string

Het e-mailadres dat is gekoppeld aan het klantprofiel.

Gemaakt op
team_members.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
team_members.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Toewijzingstype
team_members.assigned_locations.assignment_type string

Het huidige toewijzingstype van het teamlid.

Telefoonnummer
team_members.phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Cursor
cursor string

Neem de pagineringscursor op in volgende aanroepen naar dit eindpunt om de volgende set resultaten op te halen die zijn gekoppeld aan de oorspronkelijke query.

Teamlid bijwerken

Hiermee wordt één TeamMember-object bijgewerkt.

Parameters

Name Sleutel Vereist Type Description
Teamlid-id
team_member_id True string

De id van het teamlid.

Referentie-id
reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Toestand
status string

De huidige verificatiestatus van dit object.

Voornaam
given_name string

De opgegeven naam (bijvoorbeeld voornaam) die is gekoppeld aan het klantprofiel.

Achternaam
family_name string

De familienaam (bijvoorbeeld achternaam) die is gekoppeld aan het klantprofiel.

E-mailadres
email_address string

Het e-mailadres dat is gekoppeld aan het klantprofiel.

Telefoonnummer
phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Locatie-id's
location_ids array of string
Toewijzingstype
assignment_type string

Het huidige toewijzingstype van het teamlid.

Retouren

Name Pad Type Description
ID-kaart
team_member.id string

De unieke, door square uitgegeven id.

Referentie-id
team_member.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Is eigenaar
team_member.is_owner boolean

Of het teamlid de eigenaar is van het Square-account.

Toestand
team_member.status string

De huidige verificatiestatus van dit object.

Voornaam
team_member.given_name string

De opgegeven naam (bijvoorbeeld voornaam) die is gekoppeld aan het klantprofiel.

Achternaam
team_member.family_name string

De familienaam (bijvoorbeeld achternaam) die is gekoppeld aan het klantprofiel.

E-mailadres
team_member.email_address string

Het e-mailadres dat is gekoppeld aan het klantprofiel.

Telefoonnummer
team_member.phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Gemaakt op
team_member.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Toewijzingstype
team_member.assigned_locations.assignment_type string

Het huidige toewijzingstype van het teamlid.

Locatie-id's
team_member.assigned_locations.location_ids array of string

Teamlid maken

Hiermee maakt u één TeamMember-object.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Referentie-id
reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Toestand
status string

De huidige verificatiestatus van dit object.

Voornaam
given_name string

De opgegeven naam (bijvoorbeeld voornaam) die is gekoppeld aan het klantprofiel.

Achternaam
family_name string

De familienaam (bijvoorbeeld achternaam) die is gekoppeld aan het klantprofiel.

E-mailadres
email_address string

Het e-mailadres dat is gekoppeld aan het klantprofiel.

Telefoonnummer
phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Locatie-id's
location_ids array of string
Toewijzingstype
assignment_type string

Het huidige toewijzingstype van het teamlid.

Retouren

Name Pad Type Description
ID-kaart
team_member.id string

De unieke, door square uitgegeven id.

Referentie-id
team_member.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Is eigenaar
team_member.is_owner boolean

Of het teamlid de eigenaar is van het Square-account.

Toestand
team_member.status string

De huidige verificatiestatus van dit object.

Voornaam
team_member.given_name string

De opgegeven naam (bijvoorbeeld voornaam) die is gekoppeld aan het klantprofiel.

Achternaam
team_member.family_name string

De familienaam (bijvoorbeeld achternaam) die is gekoppeld aan het klantprofiel.

E-mailadres
team_member.email_address string

Het e-mailadres dat is gekoppeld aan het klantprofiel.

Telefoonnummer
team_member.phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Toewijzingstype
team_member.assigned_locations.assignment_type string

Het huidige toewijzingstype van het teamlid.

Locatie-id's
team_member.assigned_locations.location_ids array of string

Teamlid ophalen

Hiermee wordt een TeamMember-object opgehaald voor de opgegeven TeamMember-id.

Parameters

Name Sleutel Vereist Type Description
Teamlid-id
team_member_id True string

De id van het teamlid.

Retouren

Name Pad Type Description
ID-kaart
team_member.id string

De unieke, door square uitgegeven id.

Referentie-id
team_member.reference_id string

Een optionele door de gebruiker gedefinieerde referentie-id.

Is eigenaar
team_member.is_owner boolean

Of het teamlid de eigenaar is van het Square-account.

Toestand
team_member.status string

De huidige verificatiestatus van dit object.

Voornaam
team_member.given_name string

De opgegeven naam (bijvoorbeeld voornaam) die is gekoppeld aan het klantprofiel.

Achternaam
team_member.family_name string

De familienaam (bijvoorbeeld achternaam) die is gekoppeld aan het klantprofiel.

E-mailadres
team_member.email_address string

Het e-mailadres dat is gekoppeld aan het klantprofiel.

Telefoonnummer
team_member.phone_number string

Het 11-cijferige telefoonnummer dat is gekoppeld aan het klantprofiel.

Gemaakt op
team_member.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
team_member.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Toewijzingstype
team_member.assigned_locations.assignment_type string

Het huidige toewijzingstype van het teamlid.

Locatie-id's
team_member.assigned_locations.location_ids array of string

Type einde maken

Hiermee maakt u een nieuw BreakType. Een BreakType is een sjabloon voor het maken van break-objecten.

Parameters

Name Sleutel Vereist Type Description
Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Locatie-id
location_id string

De id van de locatie.

Naam einde
break_name string

Een door mensen leesbare naam voor dit type onderbreking. De naam wordt weergegeven aan werknemers in Square-producten.

Verwachte duur
expected_duration string

De verwachte lengte van deze onderbreking. Indeling: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precisie minder dan minuten wordt afgekapt.

Wordt betaald
is_paid boolean

Of deze onderbreking telt voor tijd die voor compensatiedoeleinden wordt gewerkt.

Retouren

Name Pad Type Description
ID-kaart
break_type.id string

De unieke, door square uitgegeven id.

Locatie-id
break_type.location_id string

De id van de locatie.

Naam einde
break_type.break_name string

Een door mensen leesbare naam voor dit type onderbreking. De naam wordt weergegeven aan werknemers in Square-producten.

Verwachte duur
break_type.expected_duration string

De verwachte lengte van deze onderbreking. Indeling: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precisie minder dan minuten wordt afgekapt.

Wordt betaald
break_type.is_paid boolean

Of deze onderbreking telt voor tijd die voor compensatiedoeleinden wordt gewerkt.

Versie
break_type.version integer

De huidige versie van dit object.

Gemaakt op
break_type.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
break_type.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Type einde verwijderen

Hiermee verwijdert u een bestaand BreakType. Een BreakType kan worden verwijderd, zelfs als ernaar wordt verwezen vanuit een Shift.

Parameters

Name Sleutel Vereist Type Description
ID-kaart
id True string

De id.

Retouren

response
object

Type onderbreking ophalen

Retourneert één BreakType dat is opgegeven door de id.

Parameters

Name Sleutel Vereist Type Description
ID-kaart
id True string

De id.

Retouren

Name Pad Type Description
ID-kaart
break_type.id string

De unieke, door square uitgegeven id.

Locatie-id
break_type.location_id string

De id van de locatie.

Naam einde
break_type.break_name string

Een door mensen leesbare naam voor dit type onderbreking. De naam wordt weergegeven aan werknemers in Square-producten.

Verwachte duur
break_type.expected_duration string

De verwachte lengte van deze onderbreking. Indeling: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precisie minder dan minuten wordt afgekapt.

Wordt betaald
break_type.is_paid boolean

Of deze onderbreking telt voor tijd die voor compensatiedoeleinden wordt gewerkt.

Versie
break_type.version integer

De huidige versie van dit object.

Gemaakt op
break_type.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
break_type.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Type update-einde

Hiermee wordt een bestaand BreakType bijgewerkt.

Parameters

Name Sleutel Vereist Type Description
ID-kaart
id True string

De id.

Locatie-id
location_id string

De id van de locatie.

Naam einde
break_name string

Een door mensen leesbare naam voor dit type onderbreking. De naam wordt weergegeven aan werknemers in Square-producten.

Verwachte duur
expected_duration string

De verwachte lengte van deze onderbreking. Indeling: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precisie minder dan minuten wordt afgekapt.

Wordt betaald
is_paid boolean

Of deze onderbreking telt voor tijd die voor compensatiedoeleinden wordt gewerkt.

Versie
version integer

De huidige versie van dit object.

Retouren

Name Pad Type Description
ID-kaart
break_type.id string

De unieke, door square uitgegeven id.

Locatie-id
break_type.location_id string

De id van de locatie.

Naam einde
break_type.break_name string

Een door mensen leesbare naam voor dit type onderbreking. De naam wordt weergegeven aan werknemers in Square-producten.

Verwachte duur
break_type.expected_duration string

De verwachte lengte van deze onderbreking. Indeling: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precisie minder dan minuten wordt afgekapt.

Wordt betaald
break_type.is_paid boolean

Of deze onderbreking telt voor tijd die voor compensatiedoeleinden wordt gewerkt.

Versie
break_type.version integer

De huidige versie van dit object.

Gemaakt op
break_type.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
break_type.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Typen lijstonderbrekingen

Retourneert een gepagineerde lijst met BreakType-exemplaren voor een bedrijf.

Parameters

Name Sleutel Vereist Type Description
Locatie-id
location_id string

U kunt dit optionele filter opgeven om alleen de records op te halen die behoren tot een specifieke locatie.

Limit
limit integer

Bovengrens voor het getal dat moet worden geretourneerd in het antwoord.

Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Retouren

Name Pad Type Description
Typen onderbrekingen
break_types array of object
ID-kaart
break_types.id string

De unieke, door square uitgegeven id.

Locatie-id
break_types.location_id string

De id voor de locatie.

Naam einde
break_types.break_name string

Een door mensen leesbare naam voor dit type onderbreking. De naam wordt weergegeven aan werknemers in Square-producten.

Verwachte duur
break_types.expected_duration string

De verwachte lengte van deze onderbreking. Indeling: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precisie minder dan minuten wordt afgekapt.

Wordt betaald
break_types.is_paid boolean

Of deze onderbreking telt voor tijd die voor compensatiedoeleinden wordt gewerkt.

Versie
break_types.version integer

De huidige versie van het object.

Gemaakt op
break_types.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
break_types.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Cursor
cursor string

Neem de pagineringscursor op in volgende aanroepen naar dit eindpunt om de volgende set resultaten op te halen die zijn gekoppeld aan de oorspronkelijke query.

Uitchecken maken

Koppelt een checkoutId aan een checkout_page_url waarnaar klanten worden doorgestuurd om hun betalingsgegevens op te geven met behulp van een werkstroom voor betalingsverwerking.

Parameters

Name Sleutel Vereist Type Description
Locatie-id
location_id True string

De id van de locatie.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze aanvraag uniek identificeert voor al uw aanvragen. Een veelgebruikte manier om een geldige idempotentiesleutel te maken, is door een UUID (Universally Unique Identifier) te gebruiken.

Omleidings-URL
redirect_url string

Als de opgegeven omleidings-URL bijvoorbeeld is http://www.example.com/order-complete, leidt een geslaagde transactie de klant om naar:

http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx
Als u geen omleidings-URL opgeeft, geeft Square Checkout namens u een orderbevestigingspagina weer; Het wordt echter sterk aanbevolen om een omleidings-URL op te geven, zodat u de transactieresultaten kunt verifiëren en de bestelling kunt voltooien via uw bestaande/normale bevestigingswerkstroom.

Idempotentiesleutel
idempotency_key string

Een waarde die u opgeeft die deze order uniek identificeert tussen orders die u hebt gemaakt. Als u niet zeker weet of een bepaalde order is gemaakt, kunt u het opnieuw proberen met dezelfde idempotentiesleutel zonder dat u zich zorgen hoeft te maken over het maken van dubbele orders.

Locatie-id
location_id string

De queryexpressie om te zoeken naar beschikbaarheid die overeenkomt met de opgegeven locatie-id's van de verkoper.

Klant-id
customer_id string

De id van de klant die aan de order is gekoppeld.

Referentie-id
reference_id string

Een door de client opgegeven id om een entiteit in een ander systeem aan deze order te koppelen.

Naam
name string

De naam van het item.

Hoeveelheid
quantity string

De aangeschafte hoeveelheid, opgemaakt als een decimaal getal. Regelitems met een hoeveelheid van 0 worden automatisch verwijderd bij het betalen voor of anderszins voltooien van de bestelling.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Kortings-UID
discount_uid string

De UID van de korting die de toegepaste korting vertegenwoordigt. Deze moet verwijzen naar een korting die aanwezig is in het veld order.kortingen. Dit veld is onveranderlijk. Als u wilt wijzigen welke kortingen van toepassing zijn op een regelitem, moet u de korting verwijderen en opnieuw toevoegen als een nieuw OrderLineItemAppliedDiscount.

Btw-UID
tax_uid string

De UID van de belasting waarvoor deze toegepaste belasting staat. Het moet verwijzen naar een belasting die aanwezig is in het veld order.taxes. Dit veld is onveranderlijk. Als u wilt wijzigen welke belastingen van toepassing zijn op een regelitem, verwijdert en voegt u een nieuwe OrderLineItemAppliedTax toe.

UID
uid string

Een unieke id.

Typologie
type string

Het type van dit object.

Procent
percentage string

Het percentage van de belasting, als een tekenreeksweergave van een decimaal getal.

Scope
scope string

Geeft het niveau aan waarop het object van toepassing is.

UID
uid string

Een unieke id.

Typologie
type string

Het type van dit object.

Scope
scope string

Geeft het niveau aan waarop het object van toepassing is.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Locatie-id
location_id string

De id voor de locatie.

Description
title string

De beschrijving.

Aantal
amount integer

Het bedrag.

Valuta
currency string

De valuta.

Vraag om verzendadres
ask_for_shipping_address boolean

Indien waar, verzamelt Square Checkout verzendgegevens namens u en slaat deze informatie op met de transactiegegevens in het square verkoperdashboard.

E-mail voor merchant-ondersteuning
merchant_support_email string

Het e-mailadres dat moet worden weergegeven op de bevestigingspagina en bevestigingsmail die de koper kan gebruiken om contact op te leggen met de verkoper. Als deze waarde niet is ingesteld, worden op de bevestigingspagina en het e-mailbericht het primaire e-mailadres weergegeven dat is gekoppeld aan het vierkante account van de verkoper.

Vooraf ingevulde koper-e-mail
pre_populate_buyer_email string

Indien opgegeven, wordt het e-mailadres van de koper vooraf ingevuld op de betaalpagina als een bewerkbaar tekstveld.

Adresregel 1
address_line_1 string

De eerste regel van het adres.

Adresregel 2
address_line_2 string

De tweede regel van het adres, indien van toepassing.

Localiteit
locality string

De stad of stad van het adres.

Administratief district niveau 1
administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
postal_code string

De postcode van het adres.

Country
country string

De ISO 3166 Alpha-2-landcode.

Voornaam
first_name string

Optionele voornaam wanneer deze geadresseerde vertegenwoordigt.

Achternaam
last_name string

Optionele achternaam wanneer deze de ontvanger vertegenwoordigt.

Retouren

Name Pad Type Description
ID-kaart
checkout.id string

De unieke, door square uitgegeven id.

URL van uitcheckpagina
checkout.checkout_page_url string

De URL waarnaar de browser van de koper moet worden omgeleid nadat het uitchecken is voltooid.

Vraag om verzendadres
checkout.ask_for_shipping_address boolean

Indien waar, verzamelt Square Checkout namens u verzendgegevens en slaat u deze informatie op met de transactiegegevens in uw Square Dashboard.

E-mail voor merchant-ondersteuning
checkout.merchant_support_email string

Het e-mailadres dat moet worden weergegeven op de bevestigingspagina en bevestigingsmail die de koper kan gebruiken om contact op te leggen met de verkoper.

Vooraf ingevulde koper-e-mail
checkout.pre_populate_buyer_email string

Indien opgegeven, wordt het e-mailadres van de koper vooraf ingevuld op de betaalpagina als een bewerkbaar tekstveld.

Adresregel 1
checkout.pre_populate_shipping_address.address_line_1 string

De eerste regel van het adres. Velden die beginnen met address_line de meest specifieke gegevens van het adres opgeven, zoals straatnummer, straatnaam en bouwnaam.

Adresregel 2
checkout.pre_populate_shipping_address.address_line_2 string

De tweede regel van het adres, indien van toepassing.

Localiteit
checkout.pre_populate_shipping_address.locality string

De stad of stad van het adres.

Administratief district niveau 1
checkout.pre_populate_shipping_address.administrative_district_level_1 string

Een burgerlijke entiteit binnen het land van het adres. In de VS is dit de staat.

Postcode
checkout.pre_populate_shipping_address.postal_code string

De postcode van het adres.

Country
checkout.pre_populate_shipping_address.country string

Het land van het adres, in ISO 3166-1-alfa-2-indeling.

Voornaam
checkout.pre_populate_shipping_address.first_name string

Optionele voornaam wanneer deze geadresseerde vertegenwoordigt.

Achternaam
checkout.pre_populate_shipping_address.last_name string

Optionele lsat-naam wanneer deze de ontvanger vertegenwoordigt.

Omleidings-URL
checkout.redirect_url string

De URL waarnaar moet worden omgeleid nadat het uitchecken is voltooid met de checkoutId, de orderId, transactionId en referenceId die als URL-parameters zijn toegevoegd. Als de opgegeven redirect_url bijvoorbeeld is http://www.example.com/order-complete, leidt een geslaagde transactie de klant om naar:

http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx
Als u geen omleidings-URL opgeeft, geeft Square Checkout namens u een orderbevestigingspagina weer; Square raadt echter ten zeerste aan dat u een omleidings-URL opgeeft, zodat u de transactieresultaten kunt controleren en de bestelling kunt voltooien via uw bestaande/normale bevestigingswerkstroom.

Locatie-id
checkout.order.location_id string

De queryexpressie om te zoeken naar beschikbaarheid die overeenkomt met de opgegeven locatie-id's van de verkoper.

Klant-id
checkout.order.customer_id string

De id van de klant die aan de order is gekoppeld.

Referentie-id
checkout.order.reference_id string

Een door de client opgegeven id om een entiteit in een ander systeem aan deze order te koppelen.

Regelitems
checkout.order.line_items array of object
Naam
checkout.order.line_items.name string

De naam van het regelitem.

Hoeveelheid
checkout.order.line_items.quantity string

De aangeschafte hoeveelheid, opgemaakt als een decimaal getal. Regelitems met een hoeveelheid van 0 worden automatisch verwijderd bij het betalen voor of anderszins voltooien van de bestelling.

Toegepaste belastingen
checkout.order.line_items.applied_taxes array of object
Btw-UID
checkout.order.line_items.applied_taxes.tax_uid string

De UID van de belasting waarvoor deze toegepaste belasting staat. Het moet verwijzen naar een belasting die aanwezig is in het veld order.taxes. Dit veld is onveranderlijk. Als u wilt wijzigen welke belastingen van toepassing zijn op een regelitem, verwijdert en voegt u een nieuwe OrderLineItemAppliedTax toe.

Aantal
checkout.order.line_items.applied_taxes.applied_money.amount integer

Het bedrag van het geld, in de kleinste benaming van de valuta aangegeven door valuta. Als valuta bijvoorbeeld USD is, is het bedrag in centen. Monetaire bedragen kunnen positief of negatief zijn. Zie de beschrijving van het specifieke veld om de betekenis van het teken in een bepaald geval te bepalen.

Valuta
checkout.order.line_items.applied_taxes.applied_money.currency string

Het type valuta, in ISO 4217-indeling. De valutacode voor Amerikaanse dollars is bijvoorbeeld USD.

Toegepaste kortingen
checkout.order.line_items.applied_discounts array of object
Kortings-UID
checkout.order.line_items.applied_discounts.discount_uid string

De UID van de korting die de toegepaste korting vertegenwoordigt. Deze moet verwijzen naar een korting die aanwezig is in het veld order.kortingen. Dit veld is onveranderlijk. Als u wilt wijzigen welke kortingen van toepassing zijn op een regelitem, moet u de korting verwijderen en opnieuw toevoegen als een nieuw OrderLineItemAppliedDiscount.

Aantal
checkout.order.line_items.applied_discounts.applied_money.amount integer

Het bedrag van het geld, in de kleinste benaming van de valuta aangegeven door valuta. Als valuta bijvoorbeeld USD is, is het bedrag in centen. Monetaire bedragen kunnen positief of negatief zijn. Zie de beschrijving van het specifieke veld om de betekenis van het teken in een bepaald geval te bepalen.

Valuta
checkout.order.line_items.applied_discounts.applied_money.currency string

Het type valuta, in ISO 4217-indeling. De valutacode voor Amerikaanse dollars is bijvoorbeeld USD.

Aantal
checkout.order.line_items.base_price_money.amount integer

Het bedrag.

Valuta
checkout.order.line_items.base_price_money.currency string

De valuta.

Aantal
checkout.order.line_items.total_tax_money.amount integer

Het bedrag.

Valuta
checkout.order.line_items.total_tax_money.currency string

De valuta.

Aantal
checkout.order.line_items.total_discount_money.amount integer

Het bedrag.

Valuta
checkout.order.line_items.total_discount_money.currency string

De valuta.

Aantal
checkout.order.line_items.total_money.amount integer

Het bedrag.

Valuta
checkout.order.line_items.total_money.currency string

De valuta.

Belastingen
checkout.order.taxes array of object
UID
checkout.order.taxes.uid string

Een unieke id.

Typologie
checkout.order.taxes.type string

Het type van dit object.

Procent
checkout.order.taxes.percentage string

Het percentage van de belasting, als een tekenreeksweergave van een decimaal getal.

Scope
checkout.order.taxes.scope string

Geeft het niveau aan waarop het object van toepassing is.

Kortingen
checkout.order.discounts array of object
UID
checkout.order.discounts.uid string

Een unieke id.

Typologie
checkout.order.discounts.type string

Het type van dit object.

Scope
checkout.order.discounts.scope string

Geeft het niveau aan waarop het object van toepassing is.

Aantal
checkout.order.discounts.amount_money.amount integer

Het bedrag.

Valuta
checkout.order.discounts.amount_money.currency string

De valuta.

Aantal
checkout.order.discounts.applied_money.amount integer

Het bedrag.

Valuta
checkout.order.discounts.applied_money.currency string

De valuta.

Aantal
checkout.order.total_money.amount integer

Het bedrag.

Valuta
checkout.order.total_money.currency string

De valuta.

Aantal
checkout.order.total_tax_money.amount integer

Het bedrag.

Valuta
checkout.order.total_tax_money.currency string

De valuta.

Aantal
checkout.order.total_discount_money.amount integer

Het bedrag.

Valuta
checkout.order.total_discount_money.currency string

De valuta.

Gemaakt op
checkout.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Versie
checkout.version integer

De huidige versie van dit object.

Extra geadresseerden
checkout.additional_recipients array of object
Locatie-id
checkout.additional_recipients.location_id string

De locatie-id voor een ontvanger (anders dan de verkoper) die een deel van deze aanbesteding ontvangt.

Description
checkout.additional_recipients.title string

De beschrijving van het item. Dit is een doorzoekbaar kenmerk voor gebruik in toepasselijke queryfilters en de waardelengte is van Unicode-codepunten.

Aantal
checkout.additional_recipients.amount_money.amount integer

Het bedrag.

Valuta
checkout.additional_recipients.amount_money.currency string

De valuta.

Upsert-fragment

Voegt een fragment toe aan een Square Online-site of werkt het bestaande fragment op de site bij. De code van het codefragment wordt toegevoegd aan het einde van het hoofdelement op elke pagina van de site, met uitzondering van uitcheckpagina's. Een codefragmenttoepassing kan één fragment toevoegen aan een bepaalde site.

Parameters

Name Sleutel Vereist Type Description
Site-id
site_id True string

De id van de site.

Content
content string

De code voor codefragmenten, die geldige HTML, JavaScript of beide kan bevatten.

Retouren

Name Pad Type Description
ID-kaart
snippet.id string

De unieke, door square uitgegeven id.

Site-id
snippet.site_id string

De id van de site die het codefragment bevat.

Content
snippet.content string

De code voor codefragmenten, die geldige HTML, JavaScript of beide kan bevatten.

Gemaakt op
snippet.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
snippet.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Verkoper ophalen

Haal een Merchant-object op voor de opgegeven merchant_id.

Parameters

Name Sleutel Vereist Type Description
Verkoop-id
merchant_id True string

De id van de verkoper.

Retouren

Name Pad Type Description
ID-kaart
merchant.id string

De unieke, door square uitgegeven id.

Bedrijfsnaam
merchant.business_name string

De bedrijfsnaam van de locatie Dit is de naam die zichtbaar is voor de klanten van de locatie. Deze naam wordt bijvoorbeeld weergegeven op klantbevestigingen.

Country
merchant.country string

De ISO 3166 Alpha-2-landcode.

Taalcode
merchant.language_code string

De taalcode, in BCP 47-indeling.

Valuta
merchant.currency string

De ISO 4217-valutacode van 3 tekens.

Toestand
merchant.status string

De huidige verificatiestatus van dit object.

Hoofdlocatie-id
merchant.main_location_id string

De id van de hoofdlocatie voor deze verkoper.

Verkopers vermelden

Retourneert Merchant-informatie voor een bepaald toegangstoken.

Parameters

Name Sleutel Vereist Type Description
Cursor
cursor integer

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Retouren

Name Pad Type Description
Handelaar
merchant array of object
ID-kaart
merchant.id string

De unieke, door square uitgegeven id.

Bedrijfsnaam
merchant.business_name string

De bedrijfsnaam van de locatie Dit is de naam die zichtbaar is voor de klanten van de locatie. Deze naam wordt bijvoorbeeld weergegeven op klantbevestigingen.

Country
merchant.country string

De ISO 3166 Alpha-2-landcode.

Taalcode
merchant.language_code string

De taal die is gekoppeld aan de locatie, in BCP 47-indeling.

Valuta
merchant.currency string

De ISO 4217-valutacode van 3 tekens.

Toestand
merchant.status string

De huidige verificatiestatus van dit object.

Hoofdlocatie-id
merchant.main_location_id string

De id van de hoofdlocatie voor deze verkoper.

Werkweekconfiguratie bijwerken

Hiermee werkt u een WorkweekConfig bij.

Parameters

Name Sleutel Vereist Type Description
ID-kaart
id True string

De id.

Begin van de week
start_of_week string

De dag van de week waarop een bedrijfsweek eindigt voor compensatiedoeleinden.

Lokale begintijd van de dag
start_of_day_local_time string

Het lokale tijdstip waarop een bedrijfsweek eindigt. Vertegenwoordigd als een tekenreeks in HH:MM-indeling (UU:MM:SS wordt ook geaccepteerd, maar seconden worden afgekapt).

Versie
version integer

De huidige versie van dit object.

Retouren

Name Pad Type Description
ID-kaart
workweek_config.id string

De unieke, door square uitgegeven id.

Begin van de week
workweek_config.start_of_week string

De dag van de week waarop een bedrijfsweek eindigt voor compensatiedoeleinden.

Lokale begintijd van de dag
workweek_config.start_of_day_local_time string

Het lokale tijdstip waarop een bedrijfsweek eindigt. Vertegenwoordigd als een tekenreeks in HH:MM-indeling (UU:MM:SS wordt ook geaccepteerd, maar seconden worden afgekapt).

Versie
workweek_config.version integer

De huidige versie van dit object.

Gemaakt op
workweek_config.created_at string

De tijdstempel waarmee de aanmaaktijd van dit object wordt opgegeven, in RFC 3339-indeling.

Bijgewerkt op
workweek_config.updated_at string

De tijdstempel die de meest recente updatetijd van dit object opgeeft, in RFC 3339-indeling.

Werkweekconfiguraties vermelden

Retourneert een lijst met WorkweekConfig-exemplaren voor een bedrijf.

Parameters

Name Sleutel Vereist Type Description
Limit
limit integer

Bovengrens voor het getal dat moet worden geretourneerd in het antwoord.

Cursor
cursor string

De pagineringscursor die is geretourneerd door een eerdere aanroep naar dit eindpunt.

Retouren

Name Pad Type Description
Werkweekconfiguraties
workweek_configs array of object
ID-kaart
workweek_configs.id string

De unieke, door square uitgegeven id.

Begin van de week
workweek_configs.start_of_week string

De dag van de week waarop een bedrijfsweek eindigt voor compensatiedoeleinden.

Lokale begintijd van de dag
workweek_configs.start_of_day_local_time string

Het lokale tijdstip waarop een bedrijfsweek eindigt. Vertegenwoordigd als een tekenreeks in HH:MM-indeling (UU:MM:SS wordt ook geaccepteerd, maar seconden worden afgekapt).

Versie
workweek_configs.version integer

De huidige versie van het object.

Gemaakt op
workweek_configs.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
workweek_configs.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Cursor
cursor string

Neem de pagineringscursor op in volgende aanroepen naar dit eindpunt om de volgende set resultaten op te halen die zijn gekoppeld aan de oorspronkelijke query.

Zoek loyaliteitsaccounts

Zoekt naar loyaliteitsrekeningen in een loyaliteitsprogramma.

Parameters

Name Sleutel Vereist Type Description
Limit
limit integer

Een limiet voor het aantal resultaten dat op één pagina moet worden geretourneerd. De limiet is advies: de implementatie kan meer of minder resultaten opleveren. Als de opgegeven limiet negatief, nul of hoger is dan de maximumlimiet van 1000, wordt deze genegeerd.

Retouren

Name Pad Type Description
Loyaliteitsrekeningen
loyalty_accounts array of object
ID-kaart
loyalty_accounts.id string

De unieke, door square uitgegeven id.

ID-kaart
loyalty_accounts.mapping.id string

De id van het object

Telefoonnummer
loyalty_accounts.mapping.phone_number string

Het telefoonnummer van de geadresseerde.

Gemaakt op
loyalty_accounts.mapping.created_at string

De tijdstempel bij het maken, in RFC 3339-indeling.

Programma-id
loyalty_accounts.program_id string

De door square toegewezen id van het loyaliteitsprogramma waartoe het account behoort.

Saldo
loyalty_accounts.balance integer

Het beschikbare puntenaldo in de loyaliteitsrekening.

Levensduurpunten
loyalty_accounts.lifetime_points integer

Het totale aantal punten dat is opgebouwd tijdens de levensduur van het account.

Klant-id
loyalty_accounts.customer_id string

De door het vierkant toegewezen id van de klant die is gekoppeld aan het account.

Gemaakt op
loyalty_accounts.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
loyalty_accounts.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Cursor
cursor string

Neem de pagineringscursor op in volgende aanroepen naar dit eindpunt om de volgende set resultaten op te halen die zijn gekoppeld aan de oorspronkelijke query.

Zoek loyaliteitsevenementen

Zoekt naar loyaliteitsevenementen. Een square loyaliteitsprogramma onderhoudt een grootboek van gebeurtenissen die plaatsvinden tijdens de levensduur van een loyaliteitsrekening van een koper. Elke wijziging in het puntsaldo (bijvoorbeeld punten verdiend, punten die zijn ingewisseld en punten verlopen) wordt vastgelegd in het grootboek. Met dit eindpunt kunt u het grootboek doorzoeken op gebeurtenissen.

Parameters

Name Sleutel Vereist Type Description
Order-id
order_id string

De order-id.

Limit
limit integer

Een limiet voor het aantal resultaten dat op één pagina moet worden geretourneerd. De limiet is advies: de implementatie kan meer of minder resultaten opleveren. Als de opgegeven limiet negatief, nul of hoger is dan de maximumlimiet van 1000, wordt deze genegeerd.

Retouren

Name Pad Type Description
Evenementen
events array of object
ID-kaart
events.id string

De unieke, door square uitgegeven id.

Typologie
events.type string

Het type van dit object.

Gemaakt op
events.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Loyaliteitsprogramma-id
events.accumulate_points.loyalty_program_id string

De id van het loyaliteitsprogramma

Punten
events.accumulate_points.points integer

Het aantal punten dat door de gebeurtenis is verzameld.

Order-id
events.accumulate_points.order_id string

De id van de volgorde die aan de activiteit is gekoppeld.

Loyaliteitsaccount-id
events.loyalty_account_id string

De id van het loyaliteitsaccount waarin de gebeurtenis plaatsvond.

Locatie-id
events.location_id string

De id voor de locatie.

Bron
events.source string

Hiermee definieert u of de gebeurtenis is gegenereerd door het Square Point of Sale.

Loyaliteitsprogramma-id
events.redeem_reward.loyalty_program_id string

De id van het loyaliteitsprogramma

Belonings-id
events.redeem_reward.reward_id string

De id van de ingewisselde loyaliteitsbeloning.

Order-id
events.redeem_reward.order_id string

De id van de volgorde die aan de activiteit is gekoppeld.

Loyaliteitsprogramma-id
events.create_reward.loyalty_program_id string

De id van het loyaliteitsprogramma

Belonings-id
events.create_reward.reward_id string

De id van de ingewisselde loyaliteitsbeloning.

Punten
events.create_reward.points integer

Het aantal punten dat door de gebeurtenis is verzameld.

Zoekdiensten

Hiermee wordt een gepagineerde lijst met Shift-records voor een bedrijf geretourneerd.

Parameters

Name Sleutel Vereist Type Description
Begindatum
start_date string

Een tekenreeks in JJJJ-MM-DD indeling, zoals 2017-10-31, volgens de ISO 8601-uitgebreide indeling voor kalenderdatums. Het begin van een datumbereik (inclusief).

Einddatum
end_date string

Een tekenreeks in JJJJ-MM-DD indeling, zoals 2017-10-31, volgens de ISO 8601-uitgebreide indeling voor kalenderdatums. Het einde van een datumbereik (inclusief).

Verschuivingen vergelijken op
match_shifts_by string

De strategie waarop de datums worden toegepast.

Standaardtijdzone
default_timezone string

Locatiespecifieke tijdzones converteren werkdagen naar datum/tijd-filters. Elke locatie in de query moet een tijdzone hebben of dit veld moet worden opgegeven als een terugval. Indeling: de IANA-tijdzonedatabase-id voor de relevante tijdzone.

Limit
limit integer

Een limiet voor het aantal resultaten dat op één pagina moet worden geretourneerd. De limiet is advies: de implementatie kan meer of minder resultaten opleveren. Als de opgegeven limiet negatief, nul of hoger is dan de maximumlimiet van 1000, wordt deze genegeerd.

Retouren

Name Pad Type Description
Verschuivingen
shifts array of object
ID-kaart
shifts.id string

De unieke, door square uitgegeven id.

Teamlid-id
shifts.team_member_id string

De id van het TeamMember-object voor het teamlid dat aan het object is gekoppeld.

Locatie-id
shifts.location_id string

De id voor de locatie.

Timezone
shifts.timezone string

De tijdzone die wordt gebruikt om kalenderdatums op de factuur te interpreteren, zoals due_date. Wanneer er een factuur wordt gemaakt, wordt dit veld ingesteld op de tijdzone die is opgegeven voor de verkoperlocatie. De waarde kan niet worden gewijzigd.

Beginnen bij
shifts.start_at string

De RFC 3339-tijdstempel die de begintijd van de beschikbare sleuf aangeeft.

Eindigen op
shifts.end_at string

RFC 3339; verschoven naar de tijdzone + offset. Precisie tot de minuut wordt gerespecteerd; seconden worden afgekapt.

Title
shifts.wage.title string

De naam van de taak die tijdens deze dienst is uitgevoerd. Vierkante arbeidsrapportage-URI's kunnen verschuivingen groeperen op titel.

Aantal
shifts.wage.hourly_rate.amount integer

Het bedrag.

Valuta
shifts.wage.hourly_rate.currency string

De valuta.

Pauzes
shifts.breaks array of object
ID-kaart
shifts.breaks.id string

Een id om naar dit object te verwijzen.

Beginnen bij
shifts.breaks.start_at string

Een datum/tijd-waarde in RFC 3339-indeling die aangeeft wanneer het tijdsbereik begint.

Eindigen op
shifts.breaks.end_at string

Een datum/tijd-waarde in RFC 3339-indeling die aangeeft wanneer het tijdsbereik eindigt.

Type-id einde
shifts.breaks.break_type_id string

Het BreakType waarop dit einde is geconfigureerd.

Naam
shifts.breaks.name string

Een door mensen leesbare naam.

Verwachte duur
shifts.breaks.expected_duration string

De verwachte lengte van de onderbreking. Indeling: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.

Wordt betaald
shifts.breaks.is_paid boolean

Of deze onderbreking telt voor tijd die voor compensatiedoeleinden wordt gewerkt.

Toestand
shifts.status string

De huidige verificatiestatus van dit object.

Versie
shifts.version integer

De huidige versie van het object.

Gemaakt op
shifts.created_at string

De gebeurtenistijd in ISO 8601-indeling.

Bijgewerkt op
shifts.updated_at string

Tijdstempel voor laatste wijziging in RFC 3339-indeling

Definities

Voorwerp

Dit is het type 'object'.