Partager via


Square Business (Éditeur indépendant) (préversion)

Square aide des millions de vendeurs à gérer leur entreprise , du traitement sécurisé des cartes de crédit aux solutions de point de vente. Ce connecteur contient des actions pour les points de terminaison suivants : Fidélité, Cartes-cadeaux, Réservations, Entreprises, Équipe, Finances, Online et Auth.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom Troy Taylor
URL https://www.hitachisolutions.com
Messagerie électronique ttaylor@hitachisolutions.com
Métadonnées du connecteur
Éditeur Troy Taylor
Site internet https://squareup.com/
Politique de confidentialité https://squareup.com/us/en/legal/general/privacy
Catégories Commerce; Ventes et CRM

Limitations

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Accumuler des points de fidélité

Ajoute des points à un compte de fidélité.

Ajuster les points de fidélité

Ajoute ou soustrait des points du compte d’un acheteur. Utilisez ce point de terminaison uniquement lorsque vous devez ajuster manuellement les points.

Calculer les points de fidélité

Calcule les points qu’un achat gagne. Une application peut appeler ce point de terminaison pour afficher les points qu’un acheteur peut gagner avec l’achat spécifique.

Créer du code d’appareil

Crée un DeviceCode qui peut être utilisé pour se connecter à un appareil terminal carré pour entrer en mode terminal connecté.

Créer en bloc des membres d’équipe

Crée plusieurs objets TeamMember.

Créer un code d’autorisation mobile

Génère du code pour autoriser une application mobile à se connecter à un lecteur de carte carrée. Les codes d’autorisation sont à usage unique et expirent 60 minutes après l’émission.

Créer un compte de fidélité

Crée un compte de fidélité.

Créer un décalage

Crée un Shift. Un Shift représente un jour de travail complet pour un seul employé

Créer un emplacement (bêta)

Crée un emplacement.

Créer un extraction

Lie un checkoutId à un checkout_page_url vers lequel les clients sont dirigés pour fournir leurs informations de paiement à l’aide d’un flux de travail de traitement des paiements.

Créer un membre d’équipe

Crée un objet TeamMember unique.

Créer un type d’arrêt

Crée un breakType. Un BreakType est un modèle permettant de créer des objets Break.

Créer une activité de carte cadeau (bêta)

Crée une activité de carte cadeau.

Créer une récompense de fidélité

Crée une récompense de fidélité. Une fois qu’une récompense est créée, les points sont verrouillés et ne sont pas disponibles pour que l’acheteur échange une autre récompense.

Créer une réservation (bêta)

Crée une réservation.

Disponibilité de la recherche (bêta)

Recherche les disponibilités pour la réservation.

Dissocier le client de la carte cadeau (bêta)

Dissocie un client d’une carte cadeau.

Décalages de recherche

Retourne une liste paginé d’enregistrements Shift pour une entreprise.

Extrait de code Upsert

Ajoute un extrait de code à un site Square Online ou met à jour l’extrait de code existant sur le site. Le code d’extrait de code est ajouté à la fin de l’élément principal sur chaque page du site, à l’exception des pages d’extraction. Une application d’extrait de code peut ajouter un extrait de code à un site donné.

Lier le client à la carte cadeau (bêta)

Lie un client à une carte cadeau

Lister les décalages de tiroirs-caisses

Fournit les détails de tous les décalages du tiroir-caisse pour un emplacement dans une plage de dates.

Mettre à jour en bloc les membres de l’équipe

Met à jour plusieurs objets TeamMember.

Mettre à jour la configuration workweek

Met à jour un WorkweekConfig.

Mettre à jour le décalage

Met à jour un Shift existant.

Mettre à jour le membre de l’équipe

Met à jour un seul objet TeamMember.

Mettre à jour le paramètre de salaire

Crée ou met à jour un objet WageSetting.

Mettre à jour le type d’arrêt

Met à jour un BreakType existant.

Mettre à jour l’emplacement (bêta)

Met à jour un emplacement.

Obtenir le code de l’appareil

Récupère DeviceCode avec l’ID associé.

Obtenir le décalage

Retourne un shift unique spécifié par l’ID.

Obtenir le salaire des membres de l’équipe

Retourne un seul TeamMemberWage spécifié par id.

Obtenir le type d’arrêt

Retourne un seul BreakType spécifié par id.

Obtenir un compte bancaire

Retourne les détails d’un compte BankAccount lié à un compte Square.

Obtenir un compte bancaire par ID V1

Retourne les détails d’un BankAccount identifié par l’ID de compte bancaire V1.

Rechercher des comptes de fidélité

Recherche des comptes de fidélité dans un programme de fidélité.

Rechercher des membres de l’équipe

Retourne une liste paginé d’objets TeamMember pour une entreprise.

Rechercher des récompenses de fidélité

Recherche des récompenses de fidélité dans un compte de fidélité.

Rechercher des événements de fidélité

Recherche des événements de fidélité. Un programme de fidélité Square gère un registre d’événements qui se produisent pendant la durée de vie du compte de fidélité d’un acheteur. Chaque modification du solde de points (par exemple, les points gagnés, les points échangés et les points expirés) est enregistrée dans le registre. À l’aide de ce point de terminaison, vous pouvez rechercher dans le registre des événements.

Récupérer la récompense de fidélité

Récupère une récompense de fidélité.

Récupérer le compte de fidélité

Récupère un compte de fidélité.

Récupérer le décalage du tiroir-caisse

Fournit les détails récapitulatifs d’un seul décalage de tiroirs-caisses.

Récupérer le membre de l’équipe

Récupère un objet TeamMember pour l’ID TeamMember donné.

Récupérer le paramètre de salaire

Récupère un objet WageSetting pour un membre de l’équipe spécifié par l’ID TeamMember.

Récupérer le profil de réservation d’entreprise (bêta)

Récupère le profil de réservation d’un vendeur.

Récupérer le programme de fidélité

Récupère le programme de fidélité dans le compte d’un vendeur, spécifié par l’ID du programme ou le mot clé principal. Les programmes de fidélité définissent la façon dont les acheteurs peuvent gagner des points et échanger des points pour les récompenses.

Récupérer l’emplacement

Récupère les détails d’un emplacement. Vous pouvez spécifier « main » comme ID d’emplacement pour récupérer les détails de l’emplacement principal.

Récupérer un extrait de code

Récupère votre extrait de code à partir d’un site Square Online. Un site peut contenir des extraits de code provenant de plusieurs applications d’extraits de code, mais vous pouvez récupérer uniquement l’extrait de code ajouté par votre application.

Récupérer un marchand

Récupérez un objet Marchand pour la merchant_id donnée.

Récupérer une carte cadeau (bêta)

Récupère une carte cadeau à l’aide de son ID.

Récupérer une carte cadeau de nonce (bêta)

Récupère une carte cadeau à l’aide d’un nonce (jeton sécurisé) qui représente la carte cadeau.

Récupérer une carte cadeau à partir du GAN (bêta)

Récupère une carte cadeau à l’aide du numéro de compte de carte cadeau (GAN).

Répertorier les activités de carte cadeau (bêta)

Répertorie les activités de carte cadeau. Par défaut, vous obtenez des activités de carte cadeau pour toutes les cartes-cadeaux dans le compte du vendeur. Vous pouvez éventuellement spécifier des paramètres de requête pour filtrer la liste. Par exemple, vous pouvez obtenir une liste d’activités de carte cadeau pour une carte cadeau, pour toutes les cartes-cadeaux d’une région spécifique ou pour les activités dans une fenêtre de temps.

Répertorier les codes d’appareil

Répertorie tous les DeviceCodes associés au marchand.

Répertorier les comptes bancaires

Retourne une liste d’objets BankAccount liés à un compte Square.

Répertorier les configurations workweek

Retourne une liste d’instances WorkweekConfig pour une entreprise.

Répertorier les emplacements

Fournit des informations sur tous les emplacements d’une entreprise.

Répertorier les marchands

Retourne les informations du marchand pour un jeton d’accès donné.

Répertorier les profils de réservation des membres de l’équipe (bêta)

Répertorie les profils de réservation pour les membres de l’équipe.

Répertorier les salaires des membres de l’équipe

Retourne une liste paginé d’instances TeamMemberWage pour une entreprise.

Répertorier les sites

Répertorie les sites Square Online qui appartiennent à un vendeur.

Répertorier les événements de décalage du tiroir-caisse

Fournit une liste paginé d’événements pour un décalage de tiroir-caisse unique.

Supprimer la récompense de fidélité

Supprime une récompense de fidélité. Retourne les points de fidélité au compte de fidélité. Vous ne pouvez pas supprimer une récompense qui a atteint l’état du terminal (ÉCHANGEED).

Supprimer le décalage

Supprime un décalage

Supprimer le type d’arrêt

Supprime un BreakType existant. Un BreakType peut être supprimé même s’il est référencé à partir d’un Shift.

Supprimer un extrait de code

Supprime votre extrait de code d’un site Square Online.

Types d’arrêt de liste

Retourne une liste paginé d’instances BreakType pour une entreprise.

Échanger la récompense de fidélité

Échange une récompense de fidélité. Une fois la récompense atteinte à l’état terminal, elle ne peut pas être supprimée. En d’autres termes, les points utilisés pour la récompense ne peuvent pas être retournés au compte.

Accumuler des points de fidélité

Ajoute des points à un compte de fidélité.

Paramètres

Nom Clé Obligatoire Type Description
ID de compte
account_id True string

Identificateur du compte.

ID de commande
order_id string

ID de l’ordre.

ID d’emplacement
location_id string

Identificateur d’emplacement.

Clé d’Idempotency
idempotency_key string

Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

Retours

Nom Chemin d’accès Type Description
ID
event.id string

Identificateur unique émis par carré.

Type
event.type string

Type de cet objet.

Créé à
event.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

ID du programme de fidélité
event.accumulate_points.loyalty_program_id string

ID du programme de fidélité

Points
event.accumulate_points.points integer

Nombre de points cumulés par l’événement.

ID de commande
event.accumulate_points.order_id string

ID de l’ordre associé à l’activité.

ID du compte de fidélité
event.loyalty_account_id string

ID du compte de fidélité dans lequel l’événement s’est produit.

ID d’emplacement
event.location_id string

Identificateur de l’emplacement.

Origine
event.source string

Source.

Ajuster les points de fidélité

Ajoute ou soustrait des points du compte d’un acheteur. Utilisez ce point de terminaison uniquement lorsque vous devez ajuster manuellement les points.

Paramètres

Nom Clé Obligatoire Type Description
ID de compte
account_id True string

Identificateur du compte.

Points
points integer

Nombre de points ajoutés ou supprimés.

Reason
reason string

Raison de cet objet.

Clé d’Idempotency
idempotency_key string

Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

Retours

Nom Chemin d’accès Type Description
ID
event.id string

Identificateur unique émis par carré.

Type
event.type string

Type de cet objet.

Créé à
event.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

ID du programme de fidélité
event.adjust_points.loyalty_program_id string

ID du programme de fidélité

Points
event.adjust_points.points integer

Nombre de points cumulés par l’événement.

Reason
event.adjust_points.reason string

La raison de l’ajustement des points.

ID du compte de fidélité
event.loyalty_account_id string

ID du compte de fidélité dans lequel l’événement s’est produit.

Origine
event.source string

Source.

Calculer les points de fidélité

Calcule les points qu’un achat gagne. Une application peut appeler ce point de terminaison pour afficher les points qu’un acheteur peut gagner avec l’achat spécifique.

Paramètres

Nom Clé Obligatoire Type Description
ID du programme
program_id True string

Identificateur du programme.

ID de commande
order_id string

Identificateur de l’ordre.

Retours

Nom Chemin d’accès Type Description
Points
points integer

Points que l’acheteur peut gagner à partir d’un achat spécifié.

Créer du code d’appareil

Crée un DeviceCode qui peut être utilisé pour se connecter à un appareil terminal carré pour entrer en mode terminal connecté.

Paramètres

Nom Clé Obligatoire Type Description
Clé d’Idempotency
idempotency_key string

Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

Nom
name string

Nom de l’objet.

ID d’emplacement
location_id string

Identificateur de l’emplacement.

Type de produit
product_type string

Type de produit cible du code de l’appareil.

Retours

Nom Chemin d’accès Type Description
ID
device_code.id string

Identificateur unique émis par carré.

Nom
device_code.name string

Nom de l’objet.

Code
device_code.code string

Code unique qui peut être utilisé pour se connecter.

Type de produit
device_code.product_type string

Type de produit cible du code de l’appareil.

ID d’emplacement
device_code.location_id string

Identificateur de l’emplacement.

Créé à
device_code.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Appairer par
device_code.pair_by string

Lorsque deviceCode expire et ne se connecte plus. Horodatage au format RFC 3339.

Statut
device_code.status string

État de vérification actuel de cet objet.

État modifié à l’adresse
device_code.status_changed_at string

Lorsque l’état de ce DeviceCode a été modifié pour la dernière fois. Horodatage au format RFC 3339.

Créer en bloc des membres d’équipe

Crée plusieurs objets TeamMember.

Paramètres

Nom Clé Obligatoire Type Description
Prénom
given_name string

Nom donné (c’est-à-dire le prénom) associé au membre de l’équipe.

Nom de famille
family_name string

Nom de famille (c’est-à-dire le nom) associé au membre de l’équipe.

Adresse électronique
email_address string

Adresse e-mail associée au membre de l’équipe.

ID de référence
reference_id string

Deuxième ID utilisé pour associer le membre de l’équipe à une entité dans un autre système.

Numéro de téléphone
phone_number string

Numéro de téléphone du membre de l’équipe, au format E.164.

ID d’emplacement
location_ids array of string
Type d’affectation
assignment_type string

Type d’affectation actuel du membre de l’équipe.

Prénom
given_name string

Nom donné (c’est-à-dire le prénom) associé au membre de l’équipe.

Nom de famille
family_name string

Nom de famille (c’est-à-dire le nom) associé au membre de l’équipe.

Adresse électronique
email_address string

Adresse e-mail associée au membre de l’équipe.

ID de référence
reference_id string

Deuxième ID utilisé pour associer le membre de l’équipe à une entité dans un autre système.

Numéro de téléphone
phone_number string

Numéro de téléphone du membre de l’équipe, au format E.164.

Type d’affectation
assignment_type string

Type d’affectation actuel du membre de l’équipe.

Retours

Nom Chemin d’accès Type Description
ID
team_members.idempotency-key-1.team_member.id string

Identificateur pour référencer cet objet.

ID de référence
team_members.idempotency-key-1.team_member.reference_id string

Deuxième ID utilisé pour associer le membre de l’équipe à une entité dans un autre système.

Propriétaire
team_members.idempotency-key-1.team_member.is_owner boolean

Indique si le membre de l’équipe est le propriétaire du compte Square.

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

Décrit l’état du membre de l’équipe.

Prénom
team_members.idempotency-key-1.team_member.given_name string

Nom donné (c’est-à-dire le prénom) associé au membre de l’équipe.

Nom de famille
team_members.idempotency-key-1.team_member.family_name string

Nom de famille (c’est-à-dire le nom) associé au membre de l’équipe.

Adresse électronique
team_members.idempotency-key-1.team_member.email_address string

Adresse e-mail associée au membre de l’équipe.

Numéro de téléphone
team_members.idempotency-key-1.team_member.phone_number string

Numéro de téléphone du membre de l’équipe, au format E.164.

Type d’affectation
team_members.idempotency-key-1.team_member.assigned_locations.assignment_type string

Type d’affectation actuel du membre de l’équipe.

ID d’emplacement
team_members.idempotency-key-1.team_member.assigned_locations.location_ids array of string
ID
team_members.idempotency-key-2.team_member.id string

Identificateur pour référencer cet objet.

ID de référence
team_members.idempotency-key-2.team_member.reference_id string

Deuxième ID utilisé pour associer le membre de l’équipe à une entité dans un autre système.

Propriétaire
team_members.idempotency-key-2.team_member.is_owner boolean

Indique si le membre de l’équipe est le propriétaire du compte Square.

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

Décrit l’état du membre de l’équipe.

Prénom
team_members.idempotency-key-2.team_member.given_name string

Nom donné (c’est-à-dire le prénom) associé au membre de l’équipe.

Nom de famille
team_members.idempotency-key-2.team_member.family_name string

Nom de famille (c’est-à-dire le nom) associé au membre de l’équipe.

Adresse électronique
team_members.idempotency-key-2.team_member.email_address string

Adresse e-mail associée au membre de l’équipe.

Numéro de téléphone
team_members.idempotency-key-2.team_member.phone_number string

Numéro de téléphone du membre de l’équipe, au format E.164.

Type d’affectation
team_members.idempotency-key-2.team_member.assigned_locations.assignment_type string

Type d’affectation actuel du membre de l’équipe.

Créer un code d’autorisation mobile

Génère du code pour autoriser une application mobile à se connecter à un lecteur de carte carrée. Les codes d’autorisation sont à usage unique et expirent 60 minutes après l’émission.

Paramètres

Nom Clé Obligatoire Type Description
ID d’emplacement
location_id string

Identificateur d’emplacement.

Retours

Nom Chemin d’accès Type Description
Code d’autorisation
authorization_code string

Code d’autorisation généré qui connecte une instance d’application mobile à un compte Square.

Expire à
expires_at string

Horodatage lorsque authorization_code expire au format RFC 3339.

Créer un compte de fidélité

Crée un compte de fidélité.

Paramètres

Nom Clé Obligatoire Type Description
Numéro de téléphone
phone_number string

Numéro de téléphone du destinataire.

ID du programme
program_id string

ID attribué au carré du programme.

Clé d’Idempotency
idempotency_key string

Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

Retours

Nom Chemin d’accès Type Description
ID
loyalty_account.id string

Identificateur unique émis par carré.

ID
loyalty_account.mapping.id string

ID attribué au carré.

Numéro de téléphone
loyalty_account.mapping.phone_number string

Numéro de téléphone du destinataire.

Créé à
loyalty_account.mapping.created_at string

Horodatage lors de la création, au format RFC 3339.

ID du programme
loyalty_account.program_id string

ID attribué au carré du programme.

Solde
loyalty_account.balance integer

Solde disponible.

Points de durée de vie
loyalty_account.lifetime_points integer

Nombre total de points cumulés pendant la durée de vie du compte.

Créé à
loyalty_account.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
loyalty_account.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Créer un décalage

Crée un Shift. Un Shift représente un jour de travail complet pour un seul employé

Paramètres

Nom Clé Obligatoire Type Description
Clé d’Idempotency
idempotency_key string

Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

ID de membre de l’équipe
team_member_id string

ID du membre de l’équipe.

ID d’emplacement
location_id string

Identificateur de l’emplacement.

Démarrer à
start_at string

Horodatage spécifiant l’heure de début de cet objet, au format RFC 3339.

Fin à
end_at string

RFC 3339 ; décalé vers le fuseau horaire + décalage. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

Titre
title string

Nom du travail effectué pendant ce décalage. Les URI de travail carrés peuvent regrouper les groupes par titre.

Montant
amount integer

Montant.

Monnaie
currency string

La devise.

Démarrer à
start_at string

RFC 3339 ; suit les mêmes informations de fuseau horaire que Shift. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

Fin à
end_at string

RFC 3339 ; suit les mêmes informations de fuseau horaire que Shift. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

ID de type d’arrêt
break_type_id string

BreakType sur lequel cette pause a été mise en modèle.

Nom
name string

Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.

Durée attendue
expected_duration string

Longueur attendue du saut. Format : RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]M[n]S.

Est payé
is_paid boolean

Indique si cette pause compte pour le temps travaillé à des fins de rémunération.

Retours

Nom Chemin d’accès Type Description
ID
shift.id string

Identificateur unique émis par carré.

ID de membre de l’équipe
shift.team_member_id string

ID du membre de l’équipe.

ID d’employé
shift.employee_id string

ID généré par carré de l’employé.

ID d’emplacement
shift.location_id string

Identificateur de l’emplacement.

Timezone
shift.timezone string

Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.

Démarrer à
shift.start_at string

Horodatage spécifiant l’heure de début de cet objet, au format RFC 3339.

Fin à
shift.end_at string

RFC 3339 ; décalé vers le fuseau horaire + décalage. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

Titre
shift.wage.title string

Nom du travail effectué pendant ce décalage. Les URI de travail carrés peuvent regrouper les groupes par titre.

Montant
shift.wage.hourly_rate.amount integer

Montant.

Monnaie
shift.wage.hourly_rate.currency string

La devise.

Interruptions
shift.breaks array of object
ID
shift.breaks.id string

Identificateur de l’objet

Démarrer à
shift.breaks.start_at string

RFC 3339 ; suit les mêmes informations de fuseau horaire que Shift. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

Fin à
shift.breaks.end_at string

RFC 3339 ; suit les mêmes informations de fuseau horaire que Shift. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

ID de type d’arrêt
shift.breaks.break_type_id string

BreakType sur lequel cette pause a été mise en modèle.

Nom
shift.breaks.name string

Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.

Durée attendue
shift.breaks.expected_duration string

Longueur attendue du saut. Format : RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]M[n]S.

Est payé
shift.breaks.is_paid boolean

Indique si cette pause compte pour le temps travaillé à des fins de rémunération.

Statut
shift.status string

État de vérification actuel de cet objet.

Version
shift.version integer

Version actuelle de cet objet.

Créé à
shift.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
shift.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Créer un emplacement (bêta)

Crée un emplacement.

Paramètres

Nom Clé Obligatoire Type Description
Nom
name string

Nom de l’objet.

Descriptif
description string

Description.

Facebook URL
facebook_url string

URL du profil Facebook de l’emplacement. L’URL doit commencer par « facebook.com/ ».

Ligne d’adresse 1
address_line_1 string

Première ligne de l’adresse. Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.

Niveau de district administratif 1
administrative_district_level_1 string

Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.

Localité
locality string

La ville ou la ville de l’adresse.

Code postal
postal_code string

Code postal de l’adresse.

Retours

Nom Chemin d’accès Type Description
ID
location.id string

Identificateur unique émis par carré.

Nom
location.name string

Nom de l’objet.

Ligne d’adresse 1
location.address.address_line_1 string

Première ligne de l’adresse. Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.

Localité
location.address.locality string

La ville ou la ville de l’adresse.

Niveau de district administratif 1
location.address.administrative_district_level_1 string

Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.

Code postal
location.address.postal_code string

Code postal de l’adresse.

Capacités
location.capabilities array of string
Statut
location.status string

État de vérification actuel de cet objet.

Créé à
location.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

ID de marchand
location.merchant_id string

ID du marchand.

Pays
location.country string

Code pays ISO 3166 Alpha-2.

Code de langue
location.language_code string

Code de langue, au format BCP 47.

Monnaie
location.currency string

Code monétaire ISO 4217 à 3 caractères.

Type
location.type string

Type de cet objet.

Descriptif
location.description string

Description.

URL du site web
location.website_url string

URL du site web de l’emplacement.

Nom d’utilisateur Twitter
location.twitter_username string

Nom d’utilisateur Twitter de l’emplacement sans le symbole « @ ».

Nom d’utilisateur Instagram
location.instagram_username string

Nom d’utilisateur Instagram de l’emplacement sans le symbole « @ ».

Latitude
location.coordinates.latitude float

Latitude de la coordonnée exprimée en degrés.

Longitude
location.coordinates.longitude float

Longitude de la coordonnée exprimée en degrés.

MCC
location.mcc string

Code de catégorie marchand (MCC) de l’emplacement, tel qu’normalisé par ISO 18245. Le MCC décrit le type de biens ou de services vendus à l’emplacement.

Créer un extraction

Lie un checkoutId à un checkout_page_url vers lequel les clients sont dirigés pour fournir leurs informations de paiement à l’aide d’un flux de travail de traitement des paiements.

Paramètres

Nom Clé Obligatoire Type Description
ID d’emplacement
location_id True string

Identificateur de l’emplacement.

Clé d’Idempotency
idempotency_key string

Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

URL de redirection
redirect_url string

Par exemple, si l’URL de redirection fournie est http://www.example.com/order-complete, une transaction réussie redirige le client vers :

http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx
Si vous ne fournissez pas d’URL de redirection, Square Checkout affiche une page de confirmation de commande en votre nom ; Toutefois, il est fortement recommandé de fournir une URL de redirection afin de pouvoir vérifier les résultats de la transaction et finaliser la commande via votre flux de travail de confirmation existant/normal.

Clé d’Idempotency
idempotency_key string

Valeur que vous spécifiez qui identifie de manière unique cet ordre parmi les commandes que vous avez créées. Si vous ne savez pas si une commande particulière a été créée avec succès, vous pouvez réessayer avec la même clé d’idempotency sans vous soucier de la création de commandes en double.

ID d’emplacement
location_id string

Expression de requête à rechercher les disponibilités correspondant aux ID d’emplacement du vendeur spécifiés.

ID de client
customer_id string

ID du client associé à la commande.

ID de référence
reference_id string

ID spécifié par le client pour associer une entité dans un autre système à cet ordre.

Nom
name string

Nom de l'élément.

Quantité
quantity string

Quantité achetée, mise en forme sous forme de nombre décimal. Les articles de ligne avec une quantité de 0 sont automatiquement supprimés lors du paiement ou de la fin de la commande.

Montant
amount integer

Montant.

Monnaie
currency string

La devise.

UID de remise
discount_uid string

UID de la remise que représente la remise appliquée. Il doit référencer une remise présente dans le champ order.discounts. Ce champ est immuable. Pour modifier les remises qui s’appliquent à un élément de ligne, vous devez supprimer la remise et la rajouter en tant que nouvelle OrderLineItemAppliedDiscount.

UID fiscal
tax_uid string

UID de la taxe pour laquelle cette taxe appliquée représente. Il doit référencer une taxe présente dans le champ order.taxes. Ce champ est immuable. Pour modifier les taxes qui s’appliquent à un élément de ligne, supprimez et ajoutez un nouvel objet OrderLineItemAppliedTax.

UID
uid string

ID unique.

Type
type string

Type de cet objet.

Pourcentage
percentage string

Pourcentage de la taxe, sous forme de représentation sous forme de chaîne d’un nombre décimal.

Scope
scope string

Indique le niveau auquel l’objet s’applique.

UID
uid string

ID unique.

Type
type string

Type de cet objet.

Scope
scope string

Indique le niveau auquel l’objet s’applique.

Montant
amount integer

Montant.

Monnaie
currency string

La devise.

ID d’emplacement
location_id string

Identificateur de l’emplacement.

Descriptif
title string

Description.

Montant
amount integer

Montant.

Monnaie
currency string

La devise.

Demander l’adresse de livraison
ask_for_shipping_address boolean

Si la valeur est true, Square Checkout collecte les informations d’expédition en votre nom et stocke ces informations avec les informations de transaction dans le tableau de bord Square Seller.

E-mail du support commercial
merchant_support_email string

Adresse e-mail à afficher sur la page de confirmation de la caisse carrée et e-mail de confirmation que l’acheteur peut utiliser pour contacter le vendeur. Si cette valeur n’est pas définie, la page de confirmation et l’e-mail affichent l’adresse e-mail principale associée au compte Square du vendeur.

Préremplir l’e-mail de l’acheteur
pre_populate_buyer_email string

S’il est fourni, l’e-mail de l’acheteur est prérempli sur la page d’extraction en tant que champ de texte modifiable.

Ligne d’adresse 1
address_line_1 string

Première ligne de l’adresse.

Ligne d’adresse 2
address_line_2 string

Deuxième ligne de l’adresse, le cas échéant.

Localité
locality string

La ville ou la ville de l’adresse.

Niveau de district administratif 1
administrative_district_level_1 string

Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.

Code postal
postal_code string

Code postal de l’adresse.

Pays
country string

Code pays ISO 3166 Alpha-2.

Prénom
first_name string

Prénom facultatif lorsqu’il représente le destinataire.

Nom de famille
last_name string

Nom facultatif lorsqu’il représente le destinataire.

Retours

Nom Chemin d’accès Type Description
ID
checkout.id string

Identificateur unique émis par carré.

URL de la page d’extraction
checkout.checkout_page_url string

URL vers laquelle le navigateur de l’acheteur doit être redirigé une fois l’extraction terminée.

Demander l’adresse de livraison
checkout.ask_for_shipping_address boolean

Si la valeur est true, Square Checkout collecte les informations d’expédition en votre nom et stocke ces informations avec les informations de transaction dans votre tableau de bord Square.

E-mail du support commercial
checkout.merchant_support_email string

Adresse e-mail à afficher sur la page de confirmation de la caisse carrée et e-mail de confirmation que l’acheteur peut utiliser pour contacter le commerçant.

Préremplir l’e-mail de l’acheteur
checkout.pre_populate_buyer_email string

S’il est fourni, l’e-mail de l’acheteur est prérempli sur la page d’extraction en tant que champ de texte modifiable.

Ligne d’adresse 1
checkout.pre_populate_shipping_address.address_line_1 string

Première ligne de l’adresse. Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.

Ligne d’adresse 2
checkout.pre_populate_shipping_address.address_line_2 string

Deuxième ligne de l’adresse, le cas échéant.

Localité
checkout.pre_populate_shipping_address.locality string

La ville ou la ville de l’adresse.

Niveau de district administratif 1
checkout.pre_populate_shipping_address.administrative_district_level_1 string

Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.

Code postal
checkout.pre_populate_shipping_address.postal_code string

Code postal de l’adresse.

Pays
checkout.pre_populate_shipping_address.country string

Pays de l’adresse, au format ISO 3166-1-alpha-2.

Prénom
checkout.pre_populate_shipping_address.first_name string

Prénom facultatif lorsqu’il représente le destinataire.

Nom de famille
checkout.pre_populate_shipping_address.last_name string

Nom lsat facultatif lorsqu’il représente le destinataire.

URL de redirection
checkout.redirect_url string

URL à rediriger vers une fois l’extraction terminée avec checkoutId, orderId, transactionId et referenceId ajoutés en tant que paramètres d’URL. Par exemple, si le redirect_url fourni est http://www.example.com/order-complete, une transaction réussie redirige le client vers :

http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx
Si vous ne fournissez pas d’URL de redirection, Square Checkout affiche une page de confirmation de commande en votre nom ; toutefois Square vous recommande vivement de fournir une URL de redirection afin de pouvoir vérifier les résultats de la transaction et finaliser la commande via votre flux de travail de confirmation existant/normal.

ID d’emplacement
checkout.order.location_id string

Expression de requête à rechercher les disponibilités correspondant aux ID d’emplacement du vendeur spécifiés.

ID de client
checkout.order.customer_id string

ID du client associé à la commande.

ID de référence
checkout.order.reference_id string

ID spécifié par le client pour associer une entité dans un autre système à cet ordre.

Éléments de ligne
checkout.order.line_items array of object
Nom
checkout.order.line_items.name string

Nom de l’élément de ligne.

Quantité
checkout.order.line_items.quantity string

Quantité achetée, mise en forme sous forme de nombre décimal. Les articles de ligne avec une quantité de 0 sont automatiquement supprimés lors du paiement ou de la fin de la commande.

Taxes appliquées
checkout.order.line_items.applied_taxes array of object
UID fiscal
checkout.order.line_items.applied_taxes.tax_uid string

UID de la taxe pour laquelle cette taxe appliquée représente. Il doit référencer une taxe présente dans le champ order.taxes. Ce champ est immuable. Pour modifier les taxes qui s’appliquent à un élément de ligne, supprimez et ajoutez un nouvel objet OrderLineItemAppliedTax.

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

Montant de l’argent, dans la plus petite dénomination de la devise indiquée par la devise. Par exemple, lorsque la devise est USD, le montant est en cents. Les montants monétaires peuvent être positifs ou négatifs. Consultez la description de champ spécifique pour déterminer la signification de la connexion dans un cas particulier.

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

Type de devise, au format ISO 4217. Par exemple, le code monétaire pour les dollars américains est USD.

Remises appliquées
checkout.order.line_items.applied_discounts array of object
UID de remise
checkout.order.line_items.applied_discounts.discount_uid string

UID de la remise que représente la remise appliquée. Il doit référencer une remise présente dans le champ order.discounts. Ce champ est immuable. Pour modifier les remises qui s’appliquent à un élément de ligne, vous devez supprimer la remise et la rajouter en tant que nouvelle OrderLineItemAppliedDiscount.

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

Montant de l’argent, dans la plus petite dénomination de la devise indiquée par la devise. Par exemple, lorsque la devise est USD, le montant est en cents. Les montants monétaires peuvent être positifs ou négatifs. Consultez la description de champ spécifique pour déterminer la signification de la connexion dans un cas particulier.

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

Type de devise, au format ISO 4217. Par exemple, le code monétaire pour les dollars américains est USD.

Montant
checkout.order.line_items.base_price_money.amount integer

Montant.

Monnaie
checkout.order.line_items.base_price_money.currency string

La devise.

Montant
checkout.order.line_items.total_tax_money.amount integer

Montant.

Monnaie
checkout.order.line_items.total_tax_money.currency string

La devise.

Montant
checkout.order.line_items.total_discount_money.amount integer

Montant.

Monnaie
checkout.order.line_items.total_discount_money.currency string

La devise.

Montant
checkout.order.line_items.total_money.amount integer

Montant.

Monnaie
checkout.order.line_items.total_money.currency string

La devise.

Impôts
checkout.order.taxes array of object
UID
checkout.order.taxes.uid string

ID unique.

Type
checkout.order.taxes.type string

Type de cet objet.

Pourcentage
checkout.order.taxes.percentage string

Pourcentage de la taxe, sous forme de représentation sous forme de chaîne d’un nombre décimal.

Scope
checkout.order.taxes.scope string

Indique le niveau auquel l’objet s’applique.

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

ID unique.

Type
checkout.order.discounts.type string

Type de cet objet.

Scope
checkout.order.discounts.scope string

Indique le niveau auquel l’objet s’applique.

Montant
checkout.order.discounts.amount_money.amount integer

Montant.

Monnaie
checkout.order.discounts.amount_money.currency string

La devise.

Montant
checkout.order.discounts.applied_money.amount integer

Montant.

Monnaie
checkout.order.discounts.applied_money.currency string

La devise.

Montant
checkout.order.total_money.amount integer

Montant.

Monnaie
checkout.order.total_money.currency string

La devise.

Montant
checkout.order.total_tax_money.amount integer

Montant.

Monnaie
checkout.order.total_tax_money.currency string

La devise.

Montant
checkout.order.total_discount_money.amount integer

Montant.

Monnaie
checkout.order.total_discount_money.currency string

La devise.

Créé à
checkout.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Version
checkout.version integer

Version actuelle de cet objet.

Destinataires supplémentaires
checkout.additional_recipients array of object
ID d’emplacement
checkout.additional_recipients.location_id string

ID d’emplacement d’un destinataire (autre que le marchand) recevant une partie de cet appel d’offres.

Descriptif
checkout.additional_recipients.title string

Description de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, et sa longueur de valeur est de points de code Unicode.

Montant
checkout.additional_recipients.amount_money.amount integer

Montant.

Monnaie
checkout.additional_recipients.amount_money.currency string

La devise.

Créer un membre d’équipe

Crée un objet TeamMember unique.

Paramètres

Nom Clé Obligatoire Type Description
Clé d’Idempotency
idempotency_key string

Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

ID de référence
reference_id string

ID de référence facultatif défini par l’utilisateur.

Statut
status string

État de vérification actuel de cet objet.

Prénom
given_name string

Nom donné (c.-à-d. prénom) associé au profil client.

Nom de famille
family_name string

Nom de la famille (c’est-à-dire le nom) associé au profil client.

Adresse électronique
email_address string

Adresse e-mail associée au profil client.

Numéro de téléphone
phone_number string

Numéro de téléphone à 11 chiffres associé au profil client.

ID d’emplacement
location_ids array of string
Type d’affectation
assignment_type string

Type d’affectation actuel du membre de l’équipe.

Retours

Nom Chemin d’accès Type Description
ID
team_member.id string

Identificateur unique émis par carré.

ID de référence
team_member.reference_id string

ID de référence facultatif défini par l’utilisateur.

Propriétaire
team_member.is_owner boolean

Indique si le membre de l’équipe est le propriétaire du compte Square.

Statut
team_member.status string

État de vérification actuel de cet objet.

Prénom
team_member.given_name string

Nom donné (c.-à-d. prénom) associé au profil client.

Nom de famille
team_member.family_name string

Nom de la famille (c’est-à-dire le nom) associé au profil client.

Adresse électronique
team_member.email_address string

Adresse e-mail associée au profil client.

Numéro de téléphone
team_member.phone_number string

Numéro de téléphone à 11 chiffres associé au profil client.

Type d’affectation
team_member.assigned_locations.assignment_type string

Type d’affectation actuel du membre de l’équipe.

ID d’emplacement
team_member.assigned_locations.location_ids array of string

Créer un type d’arrêt

Crée un breakType. Un BreakType est un modèle permettant de créer des objets Break.

Paramètres

Nom Clé Obligatoire Type Description
Clé d’Idempotency
idempotency_key string

Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

ID d’emplacement
location_id string

Identificateur de l’emplacement.

Nom d’arrêt
break_name string

Nom lisible par l’homme pour ce type de rupture. Le nom est affiché aux employés dans les produits Square.

Durée attendue
expected_duration string

Longueur attendue de ce saut. Format : RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]M[n]S. La précision inférieure à la minute est tronquée.

Est payé
is_paid boolean

Indique si cette pause compte pour le temps travaillé à des fins de rémunération.

Retours

Nom Chemin d’accès Type Description
ID
break_type.id string

Identificateur unique émis par carré.

ID d’emplacement
break_type.location_id string

Identificateur de l’emplacement.

Nom d’arrêt
break_type.break_name string

Nom lisible par l’homme pour ce type de rupture. Le nom est affiché aux employés dans les produits Square.

Durée attendue
break_type.expected_duration string

Longueur attendue de ce saut. Format : RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]M[n]S. La précision inférieure à la minute est tronquée.

Est payé
break_type.is_paid boolean

Indique si cette pause compte pour le temps travaillé à des fins de rémunération.

Version
break_type.version integer

Version actuelle de cet objet.

Créé à
break_type.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
break_type.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Créer une activité de carte cadeau (bêta)

Crée une activité de carte cadeau.

Paramètres

Nom Clé Obligatoire Type Description
Clé d’Idempotency
idempotency_key string

Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

ID de carte cadeau
gift_card_id string

ID de carte cadeau. L’ID n’est pas obligatoire si un GAN est présent.

Type
type string

Type de cet objet.

ID d’emplacement
location_id string

Identificateur de l’emplacement.

ID de commande
order_id string

ID de l’ordre associé à l’activité.

UID de l’élément de ligne
line_item_uid string

Le line_item_uid de l’élément de ligne de carte cadeau dans une commande.

Retours

Nom Chemin d’accès Type Description
ID
gift_card_activity.id string

Identificateur unique émis par carré.

ID de carte cadeau
gift_card_activity.gift_card_id string

ID de carte cadeau. L’ID n’est pas obligatoire si un GAN est présent.

Gan de carte cadeau
gift_card_activity.gift_card_gan string

La carte cadeau GAN. Le GAN n’est pas obligatoire si gift_card_id est présent.

Type
gift_card_activity.type string

Type de cet objet.

Montant
gift_card_activity.gift_card_balance_money.amount integer

Montant.

Monnaie
gift_card_activity.gift_card_balance_money.currency string

La devise.

ID d’emplacement
gift_card_activity.location_id string

Identificateur de l’emplacement.

Créé à
gift_card_activity.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Montant
gift_card_activity.activate_activity_details.amount_money.amount integer

Montant.

Monnaie
gift_card_activity.activate_activity_details.amount_money.currency string

La devise.

ID de commande
gift_card_activity.activate_activity_details.order_id string

ID de l’ordre associé à l’activité.

UID de l’élément de ligne
gift_card_activity.activate_activity_details.line_item_uid string

Le line_item_uid de l’élément de ligne de carte cadeau dans une commande.

Créer une récompense de fidélité

Crée une récompense de fidélité. Une fois qu’une récompense est créée, les points sont verrouillés et ne sont pas disponibles pour que l’acheteur échange une autre récompense.

Paramètres

Nom Clé Obligatoire Type Description
ID du compte de fidélité
loyalty_account_id string

ID du compte de fidélité dans lequel l’événement s’est produit.

ID du niveau récompense
reward_tier_id string

ID attribué au carré du niveau de récompense utilisé pour créer la récompense.

ID de commande
order_id string

ID de l’ordre.

Clé d’Idempotency
idempotency_key string

Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

Retours

Nom Chemin d’accès Type Description
ID
reward.id string

Identificateur unique émis par carré.

Statut
reward.status string

État de vérification actuel de cet objet.

ID du compte de fidélité
reward.loyalty_account_id string

ID du compte de fidélité dans lequel l’événement s’est produit.

ID du niveau récompense
reward.reward_tier_id string

ID attribué au carré du niveau de récompense utilisé pour créer la récompense.

Points
reward.points integer

Nombre de points ajoutés ou supprimés.

ID de commande
reward.order_id string

ID de l’ordre.

Créé à
reward.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
reward.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Créer une réservation (bêta)

Crée une réservation.

Paramètres

Nom Clé Obligatoire Type Description
ID de client
customer_id string

ID de cet objet représentant le client.

Démarrer à
start_at string

Horodatage spécifiant l’heure de début de cet objet, au format RFC 3339.

ID d’emplacement
location_id string

Identificateur de l’emplacement.

Minutes de durée
duration_minutes integer

Intervalle de temps en minutes d’un segment de rendez-vous.

ID de membre de l’équipe
team_member_id string

ID de l’objet TeamMember représentant le membre de l’équipe réservé dans ce segment.

ID de variante de service
service_variation_id string

ID de l’objet CatalogItemVariation représentant le service réservé dans ce segment.

Version de variante de service
service_variation_version integer

Version actuelle de la variante d’élément représentant le service réservé dans ce segment.

Retours

Nom Chemin d’accès Type Description
ID
booking.id string

Identificateur unique émis par carré.

Version
booking.version integer

Version actuelle de cet objet.

Statut
booking.status string

État de vérification actuel de cet objet.

Créé à
booking.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
booking.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

ID d’emplacement
booking.location_id string

Identificateur de l’emplacement.

ID de client
booking.customer_id string

ID de cet objet représentant le client.

Note du client
booking.customer_note string

Champ texte libre pour que le client fournisse des notes sur la réservation.

Note du vendeur
booking.seller_note string

Champ texte libre pour que le vendeur fournisse des notes sur la réservation.

Démarrer à
booking.start_at string

Horodatage spécifiant l’heure de début de cet objet, au format RFC 3339.

Segment de rendez-vous
booking.appointment_segments array of object
Minutes de durée
booking.appointment_segments.duration_minutes integer

Intervalle de temps en minutes d’un segment de rendez-vous.

ID de variante de service
booking.appointment_segments.service_variation_id string

ID de l’objet CatalogItemVariation représentant le service réservé dans ce segment.

ID de membre de l’équipe
booking.appointment_segments.team_member_id string

ID de l’objet TeamMember représentant le membre de l’équipe réservé dans ce segment.

Version de variante de service
booking.appointment_segments.service_variation_version integer

Version actuelle de la variante d’élément représentant le service réservé dans ce segment.

Errors
errors array of

Disponibilité de la recherche (bêta)

Recherche les disponibilités pour la réservation.

Paramètres

Nom Clé Obligatoire Type Description
Démarrer à
start_at string

Valeur datetime au format RFC 3339 indiquant quand l’intervalle de temps démarre.

Fin à
end_at string

Valeur datetime au format RFC 3339 indiquant quand l’intervalle de temps se termine.

ID d’emplacement
location_id string

Expression de requête à rechercher les disponibilités correspondant aux ID d’emplacement du vendeur spécifiés.

ID de variante de service
service_variation_id string

ID du CatalogItemVariation représentant le service réservé dans ce segment.

N'importe lequel
any array of string

Retours

Nom Chemin d’accès Type Description
Disponibilités
availabilities array of object
Démarrer à
availabilities.start_at string

Horodatage RFC 3339 spécifiant l’heure de début de l’emplacement disponible.

ID d’emplacement
availabilities.location_id string

Identificateur de l’emplacement.

Segments de rendez-vous
availabilities.appointment_segments array of object
Minutes de durée
availabilities.appointment_segments.duration_minutes integer

Intervalle de temps en minutes d’un segment de rendez-vous.

ID de membre de l’équipe
availabilities.appointment_segments.team_member_id string

ID de l’objet TeamMember représentant le membre de l’équipe réservé dans ce segment.

ID de variante de service
availabilities.appointment_segments.service_variation_id string

ID de l’objet CatalogItemVariation représentant le service réservé dans ce segment.

Version de variante de service
availabilities.appointment_segments.service_variation_version integer

Version actuelle de la variante d’élément représentant le service réservé dans ce segment.

Errors
errors array of

Dissocier le client de la carte cadeau (bêta)

Dissocie un client d’une carte cadeau.

Paramètres

Nom Clé Obligatoire Type Description
ID de carte cadeau
gift_card_id True string

Identificateur de la carte cadeau.

ID de client
customer_id string

ID du client à lier.

Retours

Nom Chemin d’accès Type Description
ID
gift_card.id string

Identificateur unique émis par carré.

Type
gift_card.type string

Type de cet objet.

GAN Source
gift_card.gan_source string

Indique si le numéro de compte de carte cadeau (GAN) est généré par Square ou importé à partir d’un système non carré.

État
gift_card.state string

État actuel.

Montant
gift_card.balance_money.amount integer

Montant.

Monnaie
gift_card.balance_money.currency string

La devise.

Gan
gift_card.gan string

Numéro de compte de carte cadeau.

Créé à
gift_card.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Décalages de recherche

Retourne une liste paginé d’enregistrements Shift pour une entreprise.

Paramètres

Nom Clé Obligatoire Type Description
Date de début
start_date string

Chaîne au format AAAA -MM-DD, telle que 2017-10-31, conformément au format étendu ISO 8601 pour les dates de calendrier. Début d’une plage de dates (inclusive).

Date de fin
end_date string

Chaîne au format AAAA -MM-DD, telle que 2017-10-31, conformément au format étendu ISO 8601 pour les dates de calendrier. Fin d’une plage de dates (inclusive).

Mettre en correspondance les décalages par
match_shifts_by string

Stratégie sur laquelle les dates sont appliquées.

Fuseau horaire par défaut
default_timezone string

Les fuseaux horaires spécifiques à l’emplacement convertissent les jours de travail en filtres datetime. Chaque emplacement inclus dans la requête doit avoir un fuseau horaire ou ce champ doit être fourni en tant que secours. Format : identificateur de base de données de fuseau horaire IANA pour le fuseau horaire approprié.

Limit
limit integer

Limite du nombre de résultats à retourner dans une seule page. La limite est consultatif : l’implémentation peut retourner plus ou moins de résultats. Si la limite fournie est négative, nulle ou supérieure à la limite maximale de 1 000, elle est ignorée.

Retours

Nom Chemin d’accès Type Description
Shifts
shifts array of object
ID
shifts.id string

Identificateur unique émis par carré.

ID de membre de l’équipe
shifts.team_member_id string

ID de l’objet TeamMember pour le membre de l’équipe associé à l’objet.

ID d’emplacement
shifts.location_id string

Identificateur de l’emplacement.

Timezone
shifts.timezone string

Fuseau horaire utilisé pour interpréter les dates de calendrier sur la facture, telles que due_date. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.

Démarrer à
shifts.start_at string

Horodatage RFC 3339 spécifiant l’heure de début de l’emplacement disponible.

Fin à
shifts.end_at string

RFC 3339 ; décalé vers le fuseau horaire + décalage. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

Titre
shifts.wage.title string

Nom du travail effectué pendant ce décalage. Les URI de travail carrés peuvent regrouper les groupes par titre.

Montant
shifts.wage.hourly_rate.amount integer

Montant.

Monnaie
shifts.wage.hourly_rate.currency string

La devise.

Interruptions
shifts.breaks array of object
ID
shifts.breaks.id string

Identificateur pour référencer cet objet.

Démarrer à
shifts.breaks.start_at string

Valeur datetime au format RFC 3339 indiquant quand l’intervalle de temps démarre.

Fin à
shifts.breaks.end_at string

Valeur datetime au format RFC 3339 indiquant quand l’intervalle de temps se termine.

ID de type d’arrêt
shifts.breaks.break_type_id string

BreakType sur lequel cette pause a été mise en modèle.

Nom
shifts.breaks.name string

Nom lisible par l’homme.

Durée attendue
shifts.breaks.expected_duration string

Longueur attendue du saut. Format : RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]M[n]S.

Est payé
shifts.breaks.is_paid boolean

Indique si cette pause compte pour le temps travaillé à des fins de rémunération.

Statut
shifts.status string

État de vérification actuel de cet objet.

Version
shifts.version integer

Version actuelle de l’objet.

Créé à
shifts.created_at string

Heure de l’événement au format ISO 8601.

Mise à jour à
shifts.updated_at string

Horodatage de dernière modification au format RFC 3339

Extrait de code Upsert

Ajoute un extrait de code à un site Square Online ou met à jour l’extrait de code existant sur le site. Le code d’extrait de code est ajouté à la fin de l’élément principal sur chaque page du site, à l’exception des pages d’extraction. Une application d’extrait de code peut ajouter un extrait de code à un site donné.

Paramètres

Nom Clé Obligatoire Type Description
ID de site
site_id True string

Identificateur du site.

Content
content string

Code d’extrait de code, qui peut contenir du code HTML, JavaScript ou les deux valides.

Retours

Nom Chemin d’accès Type Description
ID
snippet.id string

Identificateur unique émis par carré.

ID de site
snippet.site_id string

ID du site qui contient l’extrait de code.

Content
snippet.content string

Code d’extrait de code, qui peut contenir du code HTML, JavaScript ou les deux valides.

Créé à
snippet.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
snippet.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Lier le client à la carte cadeau (bêta)

Lie un client à une carte cadeau

Paramètres

Nom Clé Obligatoire Type Description
ID de carte cadeau
gift_card_id True string

Identificateur de la carte cadeau.

ID de client
customer_id string

ID du client à lier.

Retours

Nom Chemin d’accès Type Description
ID
gift_card.id string

Identificateur unique émis par carré.

Type
gift_card.type string

Type de cet objet.

GAN Source
gift_card.gan_source string

Indique si le numéro de compte de carte cadeau (GAN) est généré par Square ou importé à partir d’un système non carré.

État
gift_card.state string

État actuel.

Montant
gift_card.balance_money.amount integer

Montant.

Monnaie
gift_card.balance_money.currency string

La devise.

Gan
gift_card.gan string

Numéro de compte de carte cadeau.

Créé à
gift_card.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

ID client
gift_card.customer_ids array of string

Lister les décalages de tiroirs-caisses

Fournit les détails de tous les décalages du tiroir-caisse pour un emplacement dans une plage de dates.

Paramètres

Nom Clé Obligatoire Type Description
ID d’emplacement
location_id string

Vous pouvez spécifier ce filtre facultatif pour récupérer uniquement les enregistrements appartenant à un emplacement spécifique.

Ordre de tri
sort_order string

Trie la liste retournée lorsque la carte a été créée avec l’ordre spécifié.

Heure de début
begin_time string

Heure de début inclusive de la requête sur opened_at, au format ISO 8601.

Heure de fin
end_time string

Date de fin exclusive de la requête sur opened_at, au format ISO 8601.

Limit
limit integer

Limite supérieure du nombre à retourner dans la réponse.

Cursor
cursor string

Curseur de pagination retourné par un appel précédent à ce point de terminaison.

Retours

Nom Chemin d’accès Type Description
Objets
items array of object
ID
items.id string

Identificateur unique émis par carré.

État
items.state string

État actuel.

Ouvert à
items.opened_at string

Heure de début du décalage au format ISO 8601.

Terminé à
items.ended_at string

Heure de fin du décalage au format ISO 8601.

Fermé à
items.closed_at string

Heure de fermeture du décalage au format ISO 8601.

Descriptif
items.title string

Description.

Montant
items.opened_cash_money.amount integer

Montant.

Monnaie
items.opened_cash_money.currency string

La devise.

Montant
items.expected_cash_money.amount integer

Montant.

Monnaie
items.expected_cash_money.currency string

La devise.

Montant
items.closed_cash_money.amount integer

Montant.

Monnaie
items.closed_cash_money.currency string

La devise.

Mettre à jour en bloc les membres de l’équipe

Met à jour plusieurs objets TeamMember.

Paramètres

Nom Clé Obligatoire Type Description
ID de référence
reference_id string

Deuxième ID utilisé pour associer le membre de l’équipe à une entité dans un autre système.

Propriétaire
is_owner boolean

Indique si le membre de l’équipe est le propriétaire du compte Square.

Statut
status string

Décrit l’état du membre de l’équipe.

Prénom
given_name string

Nom donné (c’est-à-dire le prénom) associé au membre de l’équipe.

Nom de famille
family_name string

Nom de famille (c’est-à-dire le nom) associé au membre de l’équipe.

Adresse électronique
email_address string

Adresse e-mail associée au membre de l’équipe.

Numéro de téléphone
phone_number string

Numéro de téléphone du membre de l’équipe, au format E.164.

ID d’emplacement
location_ids array of string
Type d’affectation
assignment_type string

Type d’affectation actuel du membre de l’équipe.

ID de référence
reference_id string

Deuxième ID utilisé pour associer le membre de l’équipe à une entité dans un autre système.

Propriétaire
is_owner boolean

Indique si le membre de l’équipe est le propriétaire du compte Square.

Statut
status string

Décrit l’état du membre de l’équipe.

Prénom
given_name string

Nom donné (c’est-à-dire le prénom) associé au membre de l’équipe.

Nom de famille
family_name string

Nom de famille (c’est-à-dire le nom) associé au membre de l’équipe.

Adresse électronique
email_address string

Adresse e-mail associée au membre de l’équipe.

Numéro de téléphone
phone_number string

Numéro de téléphone du membre de l’équipe, au format E.164.

Type d’affectation
assignment_type string

Type d’affectation actuel du membre de l’équipe.

Retours

Nom Chemin d’accès Type Description
ID
team_members.team_member_id.team_member.id string

Identificateur pour référencer cet objet.

ID de référence
team_members.team_member_id.team_member.reference_id string

Deuxième ID utilisé pour associer le membre de l’équipe à une entité dans un autre système.

Propriétaire
team_members.team_member_id.team_member.is_owner boolean

Indique si le membre de l’équipe est le propriétaire du compte Square.

Statut
team_members.team_member_id.team_member.status string

Décrit l’état du membre de l’équipe.

Prénom
team_members.team_member_id.team_member.given_name string

Nom donné (c’est-à-dire le prénom) associé au membre de l’équipe.

Nom de famille
team_members.team_member_id.team_member.family_name string

Nom de famille (c’est-à-dire le nom) associé au membre de l’équipe.

Adresse électronique
team_members.team_member_id.team_member.email_address string

Adresse e-mail associée au membre de l’équipe.

Numéro de téléphone
team_members.team_member_id.team_member.phone_number string

Numéro de téléphone du membre de l’équipe, au format E.164.

Créé à
team_members.team_member_id.team_member.created_at string

Horodatage, au format RFC 3339, décrivant quand le membre de l’équipe a été créé

Type d’affectation
team_members.team_member_id.team_member.assigned_locations.assignment_type string

Type d’affectation actuel du membre de l’équipe.

ID d’emplacement
team_members.team_member_id.team_member.assigned_locations.location_ids array of string

Mettre à jour la configuration workweek

Met à jour un WorkweekConfig.

Paramètres

Nom Clé Obligatoire Type Description
ID
id True string

Identificateur.

Début de la semaine
start_of_week string

Jour de la semaine sur lequel une semaine d’affaires se termine à des fins de compensation.

Heure locale de début de la journée
start_of_day_local_time string

Heure locale à laquelle se termine une semaine d’affaires. Représenté sous forme de chaîne au format HH :MM (HH :MM :SS est également accepté, mais les secondes sont tronquées).

Version
version integer

Version actuelle de cet objet.

Retours

Nom Chemin d’accès Type Description
ID
workweek_config.id string

Identificateur unique émis par carré.

Début de la semaine
workweek_config.start_of_week string

Jour de la semaine sur lequel une semaine d’affaires se termine à des fins de compensation.

Heure locale de début de la journée
workweek_config.start_of_day_local_time string

Heure locale à laquelle se termine une semaine d’affaires. Représenté sous forme de chaîne au format HH :MM (HH :MM :SS est également accepté, mais les secondes sont tronquées).

Version
workweek_config.version integer

Version actuelle de cet objet.

Créé à
workweek_config.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
workweek_config.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Mettre à jour le décalage

Met à jour un Shift existant.

Paramètres

Nom Clé Obligatoire Type Description
ID
id True string

Identificateur.

ID de membre de l’équipe
team_member_id string

ID du membre de l’équipe.

ID d’emplacement
location_id string

Identificateur de l’emplacement.

Démarrer à
start_at string

Horodatage spécifiant l’heure de début de cet objet, au format RFC 3339.

Fin à
end_at string

RFC 3339 ; décalé vers le fuseau horaire + décalage. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

Titre
title string

Nom du travail effectué pendant ce décalage. Les URI de travail carrés peuvent regrouper les groupes par titre.

Montant
amount integer

Montant.

Monnaie
currency string

La devise.

ID
id string

Identificateur de l’objet

Démarrer à
start_at string

RFC 3339 ; suit les mêmes informations de fuseau horaire que Shift. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

Fin à
end_at string

RFC 3339 ; suit les mêmes informations de fuseau horaire que Shift. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

ID de type d’arrêt
break_type_id string

BreakType sur lequel cette pause a été mise en modèle.

Nom
name string

Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.

Durée attendue
expected_duration string

Longueur attendue du saut. Format : RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]M[n]S.

Est payé
is_paid boolean

Indique si cette pause compte pour le temps travaillé à des fins de rémunération.

Version
version integer

Version actuelle de cet objet.

Retours

Nom Chemin d’accès Type Description
ID
shift.id string

Identificateur unique émis par carré.

ID de membre de l’équipe
shift.team_member_id string

ID du membre de l’équipe.

ID d’employé
shift.employee_id string

ID généré par carré de l’employé.

ID d’emplacement
shift.location_id string

Identificateur de l’emplacement.

Timezone
shift.timezone string

Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.

Démarrer à
shift.start_at string

Horodatage spécifiant l’heure de début de cet objet, au format RFC 3339.

Fin à
shift.end_at string

RFC 3339 ; décalé vers le fuseau horaire + décalage. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

Titre
shift.wage.title string

Nom du travail effectué pendant ce décalage. Les URI de travail carrés peuvent regrouper les groupes par titre.

Montant
shift.wage.hourly_rate.amount integer

Montant.

Monnaie
shift.wage.hourly_rate.currency string

La devise.

Interruptions
shift.breaks array of object
ID
shift.breaks.id string

Identificateur de l’objet

Démarrer à
shift.breaks.start_at string

RFC 3339 ; suit les mêmes informations de fuseau horaire que Shift. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

Fin à
shift.breaks.end_at string

RFC 3339 ; suit les mêmes informations de fuseau horaire que Shift. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

ID de type d’arrêt
shift.breaks.break_type_id string

BreakType sur lequel cette pause a été mise en modèle.

Nom
shift.breaks.name string

Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.

Durée attendue
shift.breaks.expected_duration string

Longueur attendue du saut. Format : RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]M[n]S.

Est payé
shift.breaks.is_paid boolean

Indique si cette pause compte pour le temps travaillé à des fins de rémunération.

Statut
shift.status string

État de vérification actuel de cet objet.

Version
shift.version integer

Version actuelle de cet objet.

Créé à
shift.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
shift.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Mettre à jour le membre de l’équipe

Met à jour un seul objet TeamMember.

Paramètres

Nom Clé Obligatoire Type Description
ID de membre de l’équipe
team_member_id True string

Identificateur du membre de l’équipe.

ID de référence
reference_id string

ID de référence facultatif défini par l’utilisateur.

Statut
status string

État de vérification actuel de cet objet.

Prénom
given_name string

Nom donné (c.-à-d. prénom) associé au profil client.

Nom de famille
family_name string

Nom de la famille (c’est-à-dire le nom) associé au profil client.

Adresse électronique
email_address string

Adresse e-mail associée au profil client.

Numéro de téléphone
phone_number string

Numéro de téléphone à 11 chiffres associé au profil client.

ID d’emplacement
location_ids array of string
Type d’affectation
assignment_type string

Type d’affectation actuel du membre de l’équipe.

Retours

Nom Chemin d’accès Type Description
ID
team_member.id string

Identificateur unique émis par carré.

ID de référence
team_member.reference_id string

ID de référence facultatif défini par l’utilisateur.

Propriétaire
team_member.is_owner boolean

Indique si le membre de l’équipe est le propriétaire du compte Square.

Statut
team_member.status string

État de vérification actuel de cet objet.

Prénom
team_member.given_name string

Nom donné (c.-à-d. prénom) associé au profil client.

Nom de famille
team_member.family_name string

Nom de la famille (c’est-à-dire le nom) associé au profil client.

Adresse électronique
team_member.email_address string

Adresse e-mail associée au profil client.

Numéro de téléphone
team_member.phone_number string

Numéro de téléphone à 11 chiffres associé au profil client.

Créé à
team_member.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Type d’affectation
team_member.assigned_locations.assignment_type string

Type d’affectation actuel du membre de l’équipe.

ID d’emplacement
team_member.assigned_locations.location_ids array of string

Mettre à jour le paramètre de salaire

Crée ou met à jour un objet WageSetting.

Paramètres

Nom Clé Obligatoire Type Description
ID de membre de l’équipe
team_member_id True string

Identificateur du membre de l’équipe.

Heures supplémentaires exemptées
is_overtime_exempt boolean

Indique si le membre de l’équipe est exempté des règles d’heures supplémentaires du pays du vendeur.

Poste
job_title string

Titre du travail.

Type de paiement
pay_type string

Type de paiement actuel pour l’affectation de travail utilisée pour calculer le montant du paiement dans une période de paiement.

Montant
amount integer

Montant.

Monnaie
currency string

La devise.

Heures hebdomadaires
weekly_hours integer

Heures planifiées par semaine pour le travail. Définissez si le salaire du travail est SALARY.

Montant
amount integer

Montant.

Monnaie
currency string

La devise.

Retours

Nom Chemin d’accès Type Description
ID de membre de l’équipe
wage_setting.team_member_id string

ID du membre de l’équipe.

Affectations de travaux
wage_setting.job_assignments array of object
Poste
wage_setting.job_assignments.job_title string

Titre du travail.

Type de paiement
wage_setting.job_assignments.pay_type string

Type de paiement actuel pour l’affectation de travail utilisée pour calculer le montant du paiement dans une période de paiement.

Montant
wage_setting.job_assignments.hourly_rate.amount integer

Montant.

Monnaie
wage_setting.job_assignments.hourly_rate.currency string

La devise.

Montant
wage_setting.job_assignments.annual_rate.amount integer

Montant.

Monnaie
wage_setting.job_assignments.annual_rate.currency string

La devise.

Heures hebdomadaires
wage_setting.job_assignments.weekly_hours integer

Heures planifiées par semaine pour le travail. Définissez si le salaire du travail est SALARY.

Heures supplémentaires exemptées
wage_setting.is_overtime_exempt boolean

Indique si le membre de l’équipe est exempté des règles d’heures supplémentaires du pays du vendeur.

Version
wage_setting.version integer

Version actuelle de cet objet.

Créé à
wage_setting.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
wage_setting.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Mettre à jour le type d’arrêt

Met à jour un BreakType existant.

Paramètres

Nom Clé Obligatoire Type Description
ID
id True string

Identificateur.

ID d’emplacement
location_id string

Identificateur de l’emplacement.

Nom d’arrêt
break_name string

Nom lisible par l’homme pour ce type de rupture. Le nom est affiché aux employés dans les produits Square.

Durée attendue
expected_duration string

Longueur attendue de ce saut. Format : RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]M[n]S. La précision inférieure à la minute est tronquée.

Est payé
is_paid boolean

Indique si cette pause compte pour le temps travaillé à des fins de rémunération.

Version
version integer

Version actuelle de cet objet.

Retours

Nom Chemin d’accès Type Description
ID
break_type.id string

Identificateur unique émis par carré.

ID d’emplacement
break_type.location_id string

Identificateur de l’emplacement.

Nom d’arrêt
break_type.break_name string

Nom lisible par l’homme pour ce type de rupture. Le nom est affiché aux employés dans les produits Square.

Durée attendue
break_type.expected_duration string

Longueur attendue de ce saut. Format : RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]M[n]S. La précision inférieure à la minute est tronquée.

Est payé
break_type.is_paid boolean

Indique si cette pause compte pour le temps travaillé à des fins de rémunération.

Version
break_type.version integer

Version actuelle de cet objet.

Créé à
break_type.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
break_type.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Mettre à jour l’emplacement (bêta)

Met à jour un emplacement.

Paramètres

Nom Clé Obligatoire Type Description
ID d’emplacement
location_id True string

Identificateur de l’emplacement.

Nom
name string

Nom de l’objet.

Descriptif
description string

Description.

Facebook URL
facebook_url string

URL du profil Facebook de l’emplacement. L’URL doit commencer par « facebook.com/ ».

Nom d’utilisateur Twitter
twitter_username string

Nom d’utilisateur Twitter de l’emplacement sans le symbole « @ ».

Nom d’utilisateur Instagram
instagram_username string

Nom d’utilisateur Instagram de l’emplacement sans le symbole « @ ».

Ligne d’adresse 1
address_line_1 string

Première ligne de l’adresse. Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.

Niveau de district administratif 1
administrative_district_level_1 string

Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.

Localité
locality string

La ville ou la ville de l’adresse.

Code postal
postal_code string

Code postal de l’adresse.

Jour de la semaine
day_of_week string

Jour de la semaine pour cette période.

Démarrer l’heure locale
start_local_time string

Heure de début d’une période d’heures ouvrées, spécifiée dans l’heure locale à l’aide du format RFC 3339 à temps partiel.

Heure locale de fin
end_local_time string

Heure de fin d’une période d’heures ouvrées, spécifiée dans l’heure locale à l’aide du format RFC 3339 à temps partiel.

Retours

Nom Chemin d’accès Type Description
ID
location.id string

Identificateur unique émis par carré.

Nom
location.name string

Nom de l’objet.

Ligne d’adresse 1
location.address.address_line_1 string

Première ligne de l’adresse. Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.

Localité
location.address.locality string

La ville ou la ville de l’adresse.

Niveau de district administratif 1
location.address.administrative_district_level_1 string

Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.

Code postal
location.address.postal_code string

Code postal de l’adresse.

Timezone
location.timezone string

Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.

Capacités
location.capabilities array of string
Statut
location.status string

État de vérification actuel de cet objet.

Créé à
location.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

ID de marchand
location.merchant_id string

ID du marchand.

Pays
location.country string

Code pays ISO 3166 Alpha-2.

Code de langue
location.language_code string

Code de langue, au format BCP 47.

Monnaie
location.currency string

Code monétaire ISO 4217 à 3 caractères.

Numéro de téléphone
location.phone_number string

Numéro de téléphone à 11 chiffres associé au profil client.

Nom de l’entreprise
location.business_name string

Nom commercial de l’emplacement : il s’agit du nom visible par les clients de l’emplacement. Par exemple, ce nom apparaît sur les reçus des clients.

Type
location.type string

Type de cet objet.

URL du site web
location.website_url string

URL du site web de l’emplacement.

Periods
location.business_hours.periods array of object
Jour de la semaine
location.business_hours.periods.day_of_week string

Jour de la semaine pour cette période.

Démarrer l’heure locale
location.business_hours.periods.start_local_time string

Heure de début d’une période d’heures ouvrées, spécifiée dans l’heure locale à l’aide du format RFC 3339 à temps partiel.

Heure locale de fin
location.business_hours.periods.end_local_time string

Heure de fin d’une période d’heures ouvrées, spécifiée dans l’heure locale à l’aide du format RFC 3339 à temps partiel.

Adresse e-mail professionnelle
location.business_email string

E-mail de l’emplacement. Cet e-mail est visible par les clients de l’emplacement. Par exemple, l’e-mail s’affiche sur les reçus des clients.

Descriptif
location.description string

Description.

Nom d’utilisateur Twitter
location.twitter_username string

Nom d’utilisateur Twitter de l’emplacement sans le symbole « @ ».

Nom d’utilisateur Instagram
location.instagram_username string

Nom d’utilisateur Instagram de l’emplacement sans le symbole « @ ».

Latitude
location.coordinates.latitude float

Latitude de la coordonnée exprimée en degrés.

Longitude
location.coordinates.longitude float

Longitude de la coordonnée exprimée en degrés.

MCC
location.mcc string

Code de catégorie marchand (MCC) de l’emplacement, tel qu’normalisé par ISO 18245. Le MCC décrit le type de biens ou de services vendus à l’emplacement.

Obtenir le code de l’appareil

Récupère DeviceCode avec l’ID associé.

Paramètres

Nom Clé Obligatoire Type Description
ID
id True string

Identificateur.

Retours

Nom Chemin d’accès Type Description
ID
device_code.id string

Identificateur unique émis par carré.

Nom
device_code.name string

Nom de l’objet.

Code
device_code.code string

Code unique qui peut être utilisé pour se connecter.

Type de produit
device_code.product_type string

Type de produit cible du code de l’appareil.

ID d’emplacement
device_code.location_id string

Identificateur de l’emplacement.

Créé à
device_code.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Appairer par
device_code.pair_by string

Lorsque deviceCode expire et ne se connecte plus. Horodatage au format RFC 3339.

Statut
device_code.status string

État de vérification actuel de cet objet.

ID d’appareil
device_code.device_id string

ID de l’appareil.

État modifié à l’adresse
device_code.status_changed_at string

Lorsque l’état de ce DeviceCode a été modifié pour la dernière fois. Horodatage au format RFC 3339.

Obtenir le décalage

Retourne un shift unique spécifié par l’ID.

Paramètres

Nom Clé Obligatoire Type Description
ID
id True string

Identificateur.

Retours

Nom Chemin d’accès Type Description
ID
shift.id string

Identificateur unique émis par carré.

ID de membre de l’équipe
shift.team_member_id string

ID du membre de l’équipe.

ID d’employé
shift.employee_id string

ID généré par carré de l’employé.

ID d’emplacement
shift.location_id string

Identificateur de l’emplacement.

Timezone
shift.timezone string

Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.

Démarrer à
shift.start_at string

Horodatage spécifiant l’heure de début de cet objet, au format RFC 3339.

Fin à
shift.end_at string

RFC 3339 ; décalé vers le fuseau horaire + décalage. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

Titre
shift.wage.title string

Nom du travail effectué pendant ce décalage. Les URI de travail carrés peuvent regrouper les groupes par titre.

Montant
shift.wage.hourly_rate.amount integer

Montant.

Monnaie
shift.wage.hourly_rate.currency string

La devise.

Interruptions
shift.breaks array of object
ID
shift.breaks.id string

Identificateur de l’objet

Démarrer à
shift.breaks.start_at string

RFC 3339 ; suit les mêmes informations de fuseau horaire que Shift. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

Fin à
shift.breaks.end_at string

RFC 3339 ; suit les mêmes informations de fuseau horaire que Shift. La précision jusqu’à la minute est respectée ; secondes sont tronquées.

ID de type d’arrêt
shift.breaks.break_type_id string

BreakType sur lequel cette pause a été mise en modèle.

Nom
shift.breaks.name string

Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.

Durée attendue
shift.breaks.expected_duration string

Longueur attendue du saut. Format : RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]M[n]S.

Est payé
shift.breaks.is_paid boolean

Indique si cette pause compte pour le temps travaillé à des fins de rémunération.

Statut
shift.status string

État de vérification actuel de cet objet.

Version
shift.version integer

Version actuelle de cet objet.

Créé à
shift.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
shift.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Obtenir le salaire des membres de l’équipe

Retourne un seul TeamMemberWage spécifié par id.

Paramètres

Nom Clé Obligatoire Type Description
ID
id True string

Identificateur.

Retours

Nom Chemin d’accès Type Description
ID
team_member_wage.id string

Identificateur unique émis par carré.

ID de membre de l’équipe
team_member_wage.team_member_id string

ID du membre de l’équipe.

Titre
team_member_wage.title string

Titre.

Montant
team_member_wage.hourly_rate.amount integer

Montant.

Monnaie
team_member_wage.hourly_rate.currency string

La devise.

Obtenir le type d’arrêt

Retourne un seul BreakType spécifié par id.

Paramètres

Nom Clé Obligatoire Type Description
ID
id True string

Identificateur.

Retours

Nom Chemin d’accès Type Description
ID
break_type.id string

Identificateur unique émis par carré.

ID d’emplacement
break_type.location_id string

Identificateur de l’emplacement.

Nom d’arrêt
break_type.break_name string

Nom lisible par l’homme pour ce type de rupture. Le nom est affiché aux employés dans les produits Square.

Durée attendue
break_type.expected_duration string

Longueur attendue de ce saut. Format : RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]M[n]S. La précision inférieure à la minute est tronquée.

Est payé
break_type.is_paid boolean

Indique si cette pause compte pour le temps travaillé à des fins de rémunération.

Version
break_type.version integer

Version actuelle de cet objet.

Créé à
break_type.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
break_type.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Obtenir un compte bancaire

Retourne les détails d’un compte BankAccount lié à un compte Square.

Paramètres

Nom Clé Obligatoire Type Description
ID de compte bancaire
bank_account_id True string

ID émis par carré du compte BankAccount souhaité.

Retours

Nom Chemin d’accès Type Description
ID
bank_account.id string

Identificateur unique émis par carré.

Suffixe numéro de compte
bank_account.account_number_suffix string

Derniers chiffres du numéro de compte.

Pays
bank_account.country string

Code pays ISO 3166 Alpha-2.

Monnaie
bank_account.currency string

Code monétaire ISO 4217 à 3 caractères.

Type de compte
bank_account.account_type string

Type du compte.

Nom du titulaire
bank_account.holder_name string

Nom du titulaire du compte.

Numéro d’identification de la banque principale
bank_account.primary_bank_identification_number string

Identificateur principal de la banque.

ID d’emplacement
bank_account.location_id string

Identificateur de l’emplacement.

Statut
bank_account.status string

État de vérification actuel de cet objet.

Estimable
bank_account.creditable boolean

Indique s’il est possible que Square envoie de l’argent à ce compte.

Débitable
bank_account.debitable boolean

Indique s’il est possible que Square prenne de l’argent à partir de ce compte.

Version
bank_account.version integer

Version actuelle de cet objet.

Nom de la banque
bank_account.bank_name string

Nom de l’institution financière réelle.

Obtenir un compte bancaire par ID V1

Retourne les détails d’un BankAccount identifié par l’ID de compte bancaire V1.

Paramètres

Nom Clé Obligatoire Type Description
ID de compte bancaire V1
v1_bank_account_id True string

Connectez l’ID V1 du compte BankAccount souhaité.

Retours

Nom Chemin d’accès Type Description
ID
bank_account.id string

Identificateur unique émis par carré.

Suffixe numéro de compte
bank_account.account_number_suffix string

Derniers chiffres du numéro de compte.

Pays
bank_account.country string

Code pays ISO 3166 Alpha-2.

Monnaie
bank_account.currency string

Code monétaire ISO 4217 à 3 caractères.

Type de compte
bank_account.account_type string

Type du compte.

Nom du titulaire
bank_account.holder_name string

Nom du titulaire du compte.

Numéro d’identification de la banque principale
bank_account.primary_bank_identification_number string

Identificateur principal de la banque.

ID d’emplacement
bank_account.location_id string

Identificateur de l’emplacement.

Statut
bank_account.status string

État de vérification actuel de cet objet.

Estimable
bank_account.creditable boolean

Indique s’il est possible que Square envoie de l’argent à ce compte.

Débitable
bank_account.debitable boolean

Indique s’il est possible que Square prenne de l’argent à partir de ce compte.

Version
bank_account.version integer

Version actuelle de cet objet.

Nom de la banque
bank_account.bank_name string

Nom de l’institution financière réelle.

Rechercher des comptes de fidélité

Recherche des comptes de fidélité dans un programme de fidélité.

Paramètres

Nom Clé Obligatoire Type Description
Limit
limit integer

Limite du nombre de résultats à retourner dans une seule page. La limite est consultatif : l’implémentation peut retourner plus ou moins de résultats. Si la limite fournie est négative, nulle ou supérieure à la limite maximale de 1 000, elle est ignorée.

Retours

Nom Chemin d’accès Type Description
Comptes de fidélité
loyalty_accounts array of object
ID
loyalty_accounts.id string

Identificateur unique émis par carré.

ID
loyalty_accounts.mapping.id string

Identificateur de l’objet

Numéro de téléphone
loyalty_accounts.mapping.phone_number string

Numéro de téléphone du destinataire.

Créé à
loyalty_accounts.mapping.created_at string

Horodatage lors de la création, au format RFC 3339.

ID du programme
loyalty_accounts.program_id string

ID attribué par carré du programme de fidélité auquel appartient le compte.

Solde
loyalty_accounts.balance integer

Solde de point disponible dans le compte de fidélité.

Points de durée de vie
loyalty_accounts.lifetime_points integer

Nombre total de points cumulés pendant la durée de vie du compte.

ID de client
loyalty_accounts.customer_id string

ID attribué au carré du client associé au compte.

Créé à
loyalty_accounts.created_at string

Heure de l’événement au format ISO 8601.

Mise à jour à
loyalty_accounts.updated_at string

Horodatage de dernière modification au format RFC 3339

Cursor
cursor string

Incluez le curseur de pagination dans les appels suivants à ce point de terminaison pour récupérer le jeu de résultats suivant associé à la requête d’origine.

Rechercher des membres de l’équipe

Retourne une liste paginé d’objets TeamMember pour une entreprise.

Paramètres

Nom Clé Obligatoire Type Description
ID d’emplacement
location_ids array of string
Statut
status string

État actuel.

Limit
limit integer

Limite du nombre de résultats à retourner dans une seule page. La limite est consultatif : l’implémentation peut retourner plus ou moins de résultats. Si la limite fournie est négative, nulle ou supérieure à la limite maximale de 1 000, elle est ignorée.

Retours

Nom Chemin d’accès Type Description
Membres de l’équipe
team_members array of object
ID
team_members.id string

Identificateur unique émis par carré.

ID de référence
team_members.reference_id string

Deuxième ID facultatif utilisé pour associer le profil client à une entité dans un autre système.

Propriétaire
team_members.is_owner boolean

Indique si le membre de l’équipe est le propriétaire du compte Square.

Statut
team_members.status string

État de vérification actuel de cet objet.

Prénom
team_members.given_name string

Nom donné (c.-à-d. prénom) associé au profil client.

Nom de famille
team_members.family_name string

Nom de la famille (c’est-à-dire le nom) associé au profil client.

Adresse électronique
team_members.email_address string

Adresse e-mail associée au profil client.

Créé à
team_members.created_at string

Heure de l’événement au format ISO 8601.

Mise à jour à
team_members.updated_at string

Horodatage de dernière modification au format RFC 3339

Type d’affectation
team_members.assigned_locations.assignment_type string

Type d’affectation actuel du membre de l’équipe.

Numéro de téléphone
team_members.phone_number string

Numéro de téléphone à 11 chiffres associé au profil client.

Cursor
cursor string

Incluez le curseur de pagination dans les appels suivants à ce point de terminaison pour récupérer le jeu de résultats suivant associé à la requête d’origine.

Rechercher des récompenses de fidélité

Recherche des récompenses de fidélité dans un compte de fidélité.

Paramètres

Nom Clé Obligatoire Type Description
ID du compte de fidélité
loyalty_account_id string

ID du compte de fidélité dans lequel l’événement s’est produit.

Limit
limit integer

Limite du nombre de résultats à retourner dans une seule page. La limite est consultatif : l’implémentation peut retourner plus ou moins de résultats. Si la limite fournie est négative, nulle ou supérieure à la limite maximale de 1 000, elle est ignorée.

Retours

Nom Chemin d’accès Type Description
Récompenses
rewards array of object
ID
rewards.id string

Identificateur unique émis par carré.

Statut
rewards.status string

État de vérification actuel de cet objet.

ID du compte de fidélité
rewards.loyalty_account_id string

ID du compte de fidélité dans lequel l’événement s’est produit.

ID du niveau récompense
rewards.reward_tier_id string

ID attribué au carré du niveau de récompense utilisé pour créer la récompense.

Points
rewards.points integer

Nombre de points de fidélité utilisés pour la récompense.

ID de commande
rewards.order_id string

ID de l’ordre.

Créé à
rewards.created_at string

Heure de l’événement au format ISO 8601.

Mise à jour à
rewards.updated_at string

Horodatage de dernière modification au format RFC 3339

Échangé à
rewards.redeemed_at string

Horodatage lorsque la récompense a été utilisée, au format RFC 3339.

Rechercher des événements de fidélité

Recherche des événements de fidélité. Un programme de fidélité Square gère un registre d’événements qui se produisent pendant la durée de vie du compte de fidélité d’un acheteur. Chaque modification du solde de points (par exemple, les points gagnés, les points échangés et les points expirés) est enregistrée dans le registre. À l’aide de ce point de terminaison, vous pouvez rechercher dans le registre des événements.

Paramètres

Nom Clé Obligatoire Type Description
ID de commande
order_id string

Identificateur de l’ordre.

Limit
limit integer

Limite du nombre de résultats à retourner dans une seule page. La limite est consultatif : l’implémentation peut retourner plus ou moins de résultats. Si la limite fournie est négative, nulle ou supérieure à la limite maximale de 1 000, elle est ignorée.

Retours

Nom Chemin d’accès Type Description
Événements
events array of object
ID
events.id string

Identificateur unique émis par carré.

Type
events.type string

Type de cet objet.

Créé à
events.created_at string

Heure de l’événement au format ISO 8601.

ID du programme de fidélité
events.accumulate_points.loyalty_program_id string

ID du programme de fidélité

Points
events.accumulate_points.points integer

Nombre de points cumulés par l’événement.

ID de commande
events.accumulate_points.order_id string

ID de l’ordre associé à l’activité.

ID du compte de fidélité
events.loyalty_account_id string

ID du compte de fidélité dans lequel l’événement s’est produit.

ID d’emplacement
events.location_id string

Identificateur de l’emplacement.

Origine
events.source string

Définit si l’événement a été généré par le point de vente carré.

ID du programme de fidélité
events.redeem_reward.loyalty_program_id string

ID du programme de fidélité

ID de récompense
events.redeem_reward.reward_id string

ID de la récompense de fidélité échangée.

ID de commande
events.redeem_reward.order_id string

ID de l’ordre associé à l’activité.

ID du programme de fidélité
events.create_reward.loyalty_program_id string

ID du programme de fidélité

ID de récompense
events.create_reward.reward_id string

ID de la récompense de fidélité échangée.

Points
events.create_reward.points integer

Nombre de points cumulés par l’événement.

Récupérer la récompense de fidélité

Récupère une récompense de fidélité.

Paramètres

Nom Clé Obligatoire Type Description
ID de récompense
reward_id True string

Identificateur de la récompense.

Retours

Nom Chemin d’accès Type Description
ID
reward.id string

Identificateur unique émis par carré.

Statut
reward.status string

État de vérification actuel de cet objet.

ID du compte de fidélité
reward.loyalty_account_id string

ID du compte de fidélité dans lequel l’événement s’est produit.

ID du niveau récompense
reward.reward_tier_id string

ID attribué au carré du niveau de récompense utilisé pour créer la récompense.

Points
reward.points integer

Nombre de points ajoutés ou supprimés.

Créé à
reward.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
reward.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Échangé à
reward.redeemed_at string

Horodatage lorsque la récompense a été utilisée, au format RFC 3339.

Récupérer le compte de fidélité

Récupère un compte de fidélité.

Paramètres

Nom Clé Obligatoire Type Description
ID de compte
account_id True string

Identificateur du compte.

Retours

Nom Chemin d’accès Type Description
ID
loyalty_account.id string

Identificateur unique émis par carré.

ID
loyalty_account.mapping.id string

ID attribué au carré.

Numéro de téléphone
loyalty_account.mapping.phone_number string

Numéro de téléphone du destinataire.

Créé à
loyalty_account.mapping.created_at string

Horodatage lors de la création, au format RFC 3339.

ID du programme
loyalty_account.program_id string

ID attribué au carré du programme.

Solde
loyalty_account.balance integer

Solde disponible.

Points de durée de vie
loyalty_account.lifetime_points integer

Nombre total de points cumulés pendant la durée de vie du compte.

ID de client
loyalty_account.customer_id string

ID de cet objet représentant le client.

Créé à
loyalty_account.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
loyalty_account.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Récupérer le décalage du tiroir-caisse

Fournit les détails récapitulatifs d’un seul décalage de tiroirs-caisses.

Paramètres

Nom Clé Obligatoire Type Description
ID de décalage
shift_id True string

Identificateur du décalage.

ID d’emplacement
location_id True string

Vous pouvez spécifier ce filtre facultatif pour récupérer uniquement les enregistrements appartenant à un emplacement spécifique.

Retours

Nom Chemin d’accès Type Description
ID
cash_drawer_shift.id string

Identificateur unique émis par carré.

État
cash_drawer_shift.state string

État actuel.

Ouvert à
cash_drawer_shift.opened_at string

Heure à laquelle le décalage a commencé, au format ISO 8601.

Terminé à
cash_drawer_shift.ended_at string

Heure de fin du décalage, au format ISO 8601.

Fermé à
cash_drawer_shift.closed_at string

Heure de fermeture, au format ISO 8601.

Ouverture de l’ID d’employé
cash_drawer_shift.opening_employee_id string

ID de l’employé qui a démarré le décalage du tiroir-caisse.

Fin de l’ID de l’employé
cash_drawer_shift.ending_employee_id string

ID de l’employé qui a terminé le décalage du tiroir-caisse.

ID de l’employé fermant
cash_drawer_shift.closing_employee_id string

ID de l’employé qui a fermé le décalage du tiroir-caisse en auditant le contenu du tiroir-caisse.

Descriptif
cash_drawer_shift.description string

Description.

Montant
cash_drawer_shift.opened_cash_money.amount integer

Montant.

Monnaie
cash_drawer_shift.opened_cash_money.currency string

La devise.

Montant
cash_drawer_shift.cash_payment_money.amount integer

Montant.

Monnaie
cash_drawer_shift.cash_payment_money.currency string

La devise.

Montant
cash_drawer_shift.cash_refunds_money.amount integer

Montant.

Monnaie
cash_drawer_shift.cash_refunds_money.currency string

La devise.

Montant
cash_drawer_shift.cash_paid_in_money.amount integer

Montant.

Monnaie
cash_drawer_shift.cash_paid_in_money.currency string

La devise.

Montant
cash_drawer_shift.cash_paid_out_money.amount integer

Montant.

Monnaie
cash_drawer_shift.cash_paid_out_money.currency string

La devise.

Montant
cash_drawer_shift.expected_cash_money.amount integer

Montant.

Monnaie
cash_drawer_shift.expected_cash_money.currency string

La devise.

Montant
cash_drawer_shift.closed_cash_money.amount integer

Montant.

Monnaie
cash_drawer_shift.closed_cash_money.currency string

La devise.

Nom
cash_drawer_shift.device.name string

Nom.

Récupérer le membre de l’équipe

Récupère un objet TeamMember pour l’ID TeamMember donné.

Paramètres

Nom Clé Obligatoire Type Description
ID de membre de l’équipe
team_member_id True string

Identificateur du membre de l’équipe.

Retours

Nom Chemin d’accès Type Description
ID
team_member.id string

Identificateur unique émis par carré.

ID de référence
team_member.reference_id string

ID de référence facultatif défini par l’utilisateur.

Propriétaire
team_member.is_owner boolean

Indique si le membre de l’équipe est le propriétaire du compte Square.

Statut
team_member.status string

État de vérification actuel de cet objet.

Prénom
team_member.given_name string

Nom donné (c.-à-d. prénom) associé au profil client.

Nom de famille
team_member.family_name string

Nom de la famille (c’est-à-dire le nom) associé au profil client.

Adresse électronique
team_member.email_address string

Adresse e-mail associée au profil client.

Numéro de téléphone
team_member.phone_number string

Numéro de téléphone à 11 chiffres associé au profil client.

Créé à
team_member.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
team_member.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Type d’affectation
team_member.assigned_locations.assignment_type string

Type d’affectation actuel du membre de l’équipe.

ID d’emplacement
team_member.assigned_locations.location_ids array of string

Récupérer le paramètre de salaire

Récupère un objet WageSetting pour un membre de l’équipe spécifié par l’ID TeamMember.

Paramètres

Nom Clé Obligatoire Type Description
ID de membre de l’équipe
team_member_id True string

Identificateur du membre de l’équipe.

Retours

Nom Chemin d’accès Type Description
ID de membre de l’équipe
wage_setting.team_member_id string

ID du membre de l’équipe.

Affectations de travaux
wage_setting.job_assignments array of object
Poste
wage_setting.job_assignments.job_title string

Titre du travail.

Type de paiement
wage_setting.job_assignments.pay_type string

Type de paiement actuel pour l’affectation de travail utilisée pour calculer le montant du paiement dans une période de paiement.

Montant
wage_setting.job_assignments.hourly_rate.amount integer

Montant.

Monnaie
wage_setting.job_assignments.hourly_rate.currency string

La devise.

Montant
wage_setting.job_assignments.annual_rate.amount integer

Montant.

Monnaie
wage_setting.job_assignments.annual_rate.currency string

La devise.

Heures hebdomadaires
wage_setting.job_assignments.weekly_hours integer

Heures planifiées par semaine pour le travail. Définissez si le salaire du travail est SALARY.

Heures supplémentaires exemptées
wage_setting.is_overtime_exempt boolean

Indique si le membre de l’équipe est exempté des règles d’heures supplémentaires du pays du vendeur.

Version
wage_setting.version integer

Version actuelle de cet objet.

Créé à
wage_setting.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
wage_setting.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Récupérer le profil de réservation d’entreprise (bêta)

Récupère le profil de réservation d’un vendeur.

Retours

Nom Chemin d’accès Type Description
ID du vendeur
business_booking_profile.seller_id string

ID du vendeur, pouvant être obtenu à l’aide de l’API Marchands.

Créé à
business_booking_profile.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Réservation activée
business_booking_profile.booking_enabled boolean

Indique si le vendeur est ouvert pour la réservation.

Choix du fuseau horaire client
business_booking_profile.customer_timezone_choice string

Choix des informations de fuseau horaire du client d’une réservation. Le site de réservation en ligne Square et toutes les notifications aux clients utilisent le fuseau horaire de l’emplacement du vendeur ou le fuseau horaire choisi par le client lors de la réservation.

Stratégie de réservation
business_booking_profile.booking_policy string

Stratégie pour que le vendeur accepte automatiquement les demandes de réservation (ACCEPT_ALL) ou non (REQUIRES_ACCEPTANCE).

Autoriser l’annulation de l’utilisateur
business_booking_profile.allow_user_cancel boolean

Indique si les clients peuvent annuler ou replanifier leurs propres réservations (true) ou non (false).

Types d’emplacement
business_booking_profile.business_appointment_settings.location_types array of string
Temps d’alignement
business_booking_profile.business_appointment_settings.alignment_time string

Unité de temps de la durée du service pour les réservations.

Min Booking Tead Time Seconds
business_booking_profile.business_appointment_settings.min_booking_lead_time_seconds integer

Délai minimal en secondes avant qu’un service ne puisse être réservé. Les réservations doivent être créées au moins jusqu’à l’heure de début de la réservation.

Nombre maximal de secondes de délai de réservation
business_booking_profile.business_appointment_settings.max_booking_lead_time_seconds integer

Délai maximal en secondes avant qu’un service ne puisse être réservé. Les réservations doivent être créées au maximum jusqu’à l’heure de début de la réservation.

Toute réservation de membre de l’équipe activée
business_booking_profile.business_appointment_settings.any_team_member_booking_enabled boolean

Indique si un client peut choisir parmi tous les créneaux horaires disponibles et qu’un membre du personnel soit affecté automatiquement (true) ou non (false).

Plusieurs réservations de service activées
business_booking_profile.business_appointment_settings.multiple_service_booking_enabled boolean

Indique si un client peut réserver plusieurs services dans une réservation en ligne unique.

Montant
business_booking_profile.business_appointment_settings.cancellation_fee_money.amount string

Montant de l’argent, dans la plus petite dénomination de la devise indiquée par la devise

Monnaie
business_booking_profile.business_appointment_settings.cancellation_fee_money.currency string

Type de devise, au format ISO 4217.

Stratégie d’annulation
business_booking_profile.business_appointment_settings.cancellation_policy string

Stratégie d’annulation adoptée par le vendeur.

Ignorer la sélection du personnel du flux de réservation
business_booking_profile.business_appointment_settings.skip_booking_flow_staff_selection boolean

Indique si les clients ont un membre du personnel affecté (true) ou peuvent sélectionner le membre du personnel de leur choix (false).

Errors
errors array of

Récupérer le programme de fidélité

Récupère le programme de fidélité dans le compte d’un vendeur, spécifié par l’ID du programme ou le mot clé principal. Les programmes de fidélité définissent la façon dont les acheteurs peuvent gagner des points et échanger des points pour les récompenses.

Paramètres

Nom Clé Obligatoire Type Description
ID du programme
program_id True string

Identificateur du programme.

Retours

Nom Chemin d’accès Type Description
ID
program.id string

Identificateur unique émis par carré.

Statut
program.status string

État de vérification actuel de cet objet.

Niveaux de récompense
program.reward_tiers array of object
ID
program.reward_tiers.id string

Identificateur de l’objet

Points
program.reward_tiers.points integer

Nombre de points cumulés par l’événement.

Nom
program.reward_tiers.name string

Nom de l’élément. Il s’agit d’un attribut pouvant faire l’objet d’une recherche dans les filtres de requête applicables, sa valeur ne doit pas être vide et la longueur est de points de code Unicode.

Scope
program.reward_tiers.definition.scope string

Indique le niveau auquel l’objet s’applique.

Type de remise
program.reward_tiers.definition.discount_type string

Type de remise des offres de niveau récompense.

Pourcentage de remise
program.reward_tiers.definition.percentage_discount string

Pourcentage fixe de la remise.

Créé à
program.reward_tiers.created_at string

Horodatage lors de la création, au format RFC 3339.

ID d’objet
program.reward_tiers.pricing_rule_reference.object_id string

ID de l’objet référencé.

Version du catalogue
program.reward_tiers.pricing_rule_reference.catalog_version string

Version de l’objet.

One
program.terminology.one string

Une unité singulière pour un point (par exemple, 1 point est appelé 1 étoile).

Other
program.terminology.other string

Une unité plurielle pour point (par exemple, 10 points est appelée 10 étoiles).

ID d’emplacement
program.location_ids array of string
Créé à
program.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
program.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Règles d’accumulation
program.accrual_rules array of object
Type d’accumulation
program.accrual_rules.accrual_type string

Type de règle d’accumulation qui définit la façon dont les acheteurs peuvent gagner des points.

Points
program.accrual_rules.points integer

Nombre de points cumulés par l’événement.

Montant
program.accrual_rules.spend_amount_money.amount integer

Montant.

ID de catégorie exclus
program.accrual_rules.excluded_category_ids array of string
ID de variantes d’élément exclus
program.accrual_rules.excluded_item_variation_ids array of string

Récupérer l’emplacement

Récupère les détails d’un emplacement. Vous pouvez spécifier « main » comme ID d’emplacement pour récupérer les détails de l’emplacement principal.

Paramètres

Nom Clé Obligatoire Type Description
ID d’emplacement
location_id True string

Identificateur de l’emplacement.

Retours

Nom Chemin d’accès Type Description
ID
location.id string

Identificateur unique émis par carré.

Nom
location.name string

Nom de l’objet.

Ligne d’adresse 1
location.address.address_line_1 string

Première ligne de l’adresse. Les champs qui commencent par address_line fournissent les détails les plus spécifiques de l’adresse, tels que le numéro de rue, le nom de la rue et le nom du bâtiment.

Localité
location.address.locality string

La ville ou la ville de l’adresse.

Niveau de district administratif 1
location.address.administrative_district_level_1 string

Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.

Code postal
location.address.postal_code string

Code postal de l’adresse.

Pays
location.address.country string

Pays de l’adresse, au format ISO 3166-1-alpha-2.

Timezone
location.timezone string

Fuseau horaire utilisé pour interpréter les dates de calendrier. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.

Capacités
location.capabilities array of string
Statut
location.status string

État de vérification actuel de cet objet.

Créé à
location.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

ID de marchand
location.merchant_id string

ID du marchand.

Pays
location.country string

Code pays ISO 3166 Alpha-2.

Code de langue
location.language_code string

Code de langue, au format BCP 47.

Monnaie
location.currency string

Code monétaire ISO 4217 à 3 caractères.

Numéro de téléphone
location.phone_number string

Numéro de téléphone à 11 chiffres associé au profil client.

Nom de l’entreprise
location.business_name string

Nom commercial de l’emplacement : il s’agit du nom visible par les clients de l’emplacement. Par exemple, ce nom apparaît sur les reçus des clients.

Récupérer un extrait de code

Récupère votre extrait de code à partir d’un site Square Online. Un site peut contenir des extraits de code provenant de plusieurs applications d’extraits de code, mais vous pouvez récupérer uniquement l’extrait de code ajouté par votre application.

Paramètres

Nom Clé Obligatoire Type Description
ID de site
site_id True string

Identificateur du site.

Retours

Nom Chemin d’accès Type Description
ID
snippet.id string

Identificateur unique émis par carré.

ID de site
snippet.site_id string

ID du site qui contient l’extrait de code.

Content
snippet.content string

Code d’extrait de code, qui peut contenir du code HTML, JavaScript ou les deux valides.

Créé à
snippet.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Mise à jour à
snippet.updated_at string

Horodatage spécifiant l’heure de mise à jour la plus récente de cet objet, au format RFC 3339.

Récupérer un marchand

Récupérez un objet Marchand pour la merchant_id donnée.

Paramètres

Nom Clé Obligatoire Type Description
ID de marchand
merchant_id True string

Identificateur du marchand.

Retours

Nom Chemin d’accès Type Description
ID
merchant.id string

Identificateur unique émis par carré.

Nom de l’entreprise
merchant.business_name string

Nom commercial de l’emplacement : il s’agit du nom visible par les clients de l’emplacement. Par exemple, ce nom apparaît sur les reçus des clients.

Pays
merchant.country string

Code pays ISO 3166 Alpha-2.

Code de langue
merchant.language_code string

Code de langue, au format BCP 47.

Monnaie
merchant.currency string

Code monétaire ISO 4217 à 3 caractères.

Statut
merchant.status string

État de vérification actuel de cet objet.

ID d’emplacement principal
merchant.main_location_id string

ID de l’emplacement principal de ce commerçant.

Récupérer une carte cadeau (bêta)

Récupère une carte cadeau à l’aide de son ID.

Paramètres

Nom Clé Obligatoire Type Description
ID
id True string

Identificateur.

Retours

Nom Chemin d’accès Type Description
ID
gift_card.id string

Identificateur unique émis par carré.

Type
gift_card.type string

Type de cet objet.

GAN Source
gift_card.gan_source string

Indique si le numéro de compte de carte cadeau (GAN) est généré par Square ou importé à partir d’un système non carré.

État
gift_card.state string

État actuel.

Montant
gift_card.balance_money.amount integer

Montant.

Monnaie
gift_card.balance_money.currency string

La devise.

Gan
gift_card.gan string

Numéro de compte de carte cadeau.

Créé à
gift_card.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Récupérer une carte cadeau de nonce (bêta)

Récupère une carte cadeau à l’aide d’un nonce (jeton sécurisé) qui représente la carte cadeau.

Paramètres

Nom Clé Obligatoire Type Description
Valeur à usage unique
nonce string

Nonce de la carte cadeau à récupérer.

Retours

Nom Chemin d’accès Type Description
ID
gift_card.id string

Identificateur unique émis par carré.

Type
gift_card.type string

Type de cet objet.

GAN Source
gift_card.gan_source string

Indique si le numéro de compte de carte cadeau (GAN) est généré par Square ou importé à partir d’un système non carré.

État
gift_card.state string

État actuel.

Montant
gift_card.balance_money.amount integer

Montant.

Monnaie
gift_card.balance_money.currency string

La devise.

Gan
gift_card.gan string

Numéro de compte de carte cadeau.

Créé à
gift_card.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Récupérer une carte cadeau à partir du GAN (bêta)

Récupère une carte cadeau à l’aide du numéro de compte de carte cadeau (GAN).

Paramètres

Nom Clé Obligatoire Type Description
Gan
gan string

Numéro de compte de carte cadeau.

Retours

Nom Chemin d’accès Type Description
ID
gift_card.id string

Identificateur unique émis par carré.

Type
gift_card.type string

Type de cet objet.

GAN Source
gift_card.gan_source string

Indique si le numéro de compte de carte cadeau (GAN) est généré par Square ou importé à partir d’un système non carré.

État
gift_card.state string

État actuel.

Montant
gift_card.balance_money.amount integer

Montant.

Monnaie
gift_card.balance_money.currency string

La devise.

Gan
gift_card.gan string

Numéro de compte de carte cadeau.

Créé à
gift_card.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

Répertorier les activités de carte cadeau (bêta)

Répertorie les activités de carte cadeau. Par défaut, vous obtenez des activités de carte cadeau pour toutes les cartes-cadeaux dans le compte du vendeur. Vous pouvez éventuellement spécifier des paramètres de requête pour filtrer la liste. Par exemple, vous pouvez obtenir une liste d’activités de carte cadeau pour une carte cadeau, pour toutes les cartes-cadeaux d’une région spécifique ou pour les activités dans une fenêtre de temps.

Paramètres

Nom Clé Obligatoire Type Description
ID de carte cadeau
gift_card_id string

Si vous fournissez un ID de carte cadeau, le point de terminaison retourne les activités qui appartiennent à la carte cadeau spécifiée. Sinon, le point de terminaison retourne toutes les activités de carte cadeau pour le vendeur.

Type
type string

Si vous fournissez un type, le point de terminaison retourne les activités de carte cadeau de ce type. Sinon, le point de terminaison retourne tous les types d’activités de carte cadeau.

ID d’emplacement
location_id string

Vous pouvez spécifier ce filtre facultatif pour récupérer uniquement les enregistrements appartenant à un emplacement spécifique.

Heure de début
begin_time string

Heure de début inclusive de la requête sur opened_at, au format ISO 8601.

Heure de fin
end_time string

Date de fin exclusive de la requête sur opened_at, au format ISO 8601.

Limit
limit integer

Limite supérieure du nombre à retourner dans la réponse.

Cursor
cursor string

Curseur de pagination retourné par un appel précédent à ce point de terminaison.

Ordre de tri
sort_order string

Trie la liste retournée lorsque la carte a été créée avec l’ordre spécifié.

Retours

Nom Chemin d’accès Type Description
Activités de carte cadeau
gift_card_activities array of object
ID
gift_card_activities.id string

Identificateur unique émis par carré.

Type
gift_card_activities.type string

Type de cet objet.

ID d’emplacement
gift_card_activities.location_id string

Identificateur de l’emplacement.

Créé à
gift_card_activities.created_at string

Heure de l’événement au format ISO 8601.

ID de carte cadeau
gift_card_activities.gift_card_id string

ID de carte cadeau. L’ID n’est pas obligatoire si un GAN est présent.

Gan de carte cadeau
gift_card_activities.gift_card_gan string

La carte cadeau GAN. Le GAN n’est pas obligatoire si gift_card_id est présent.

Montant
gift_card_activities.gift_card_balance_money.amount integer

Montant.

Monnaie
gift_card_activities.gift_card_balance_money.currency string

La devise.

Montant
gift_card_activities.redeem_activity_details.amount_money.amount integer

Montant.

Monnaie
gift_card_activities.redeem_activity_details.amount_money.currency string

La devise.

Montant
gift_card_activities.activate_activity_details.amount_money.amount integer

Montant.

Monnaie
gift_card_activities.activate_activity_details.amount_money.currency string

La devise.

ID de commande
gift_card_activities.activate_activity_details.order_id string

ID de l’ordre associé à l’activité.

UID de l’élément de ligne
gift_card_activities.activate_activity_details.line_item_uid string

Le line_item_uid de l’élément de ligne de carte cadeau dans une commande.

Répertorier les codes d’appareil

Répertorie tous les DeviceCodes associés au marchand.

Paramètres

Nom Clé Obligatoire Type Description
Cursor
cursor string

Curseur de pagination retourné par un appel précédent à ce point de terminaison.

ID d’emplacement
location_id string

Vous pouvez spécifier ce filtre facultatif pour récupérer uniquement les enregistrements appartenant à un emplacement spécifique.

Type de produit
product_type string

Si elle est spécifiée, retourne uniquement deviceCodes ciblant le type de produit spécifié. Retourne deviceCodes de tous les types de produits s’ils sont vides.

Statut
status string

S’il est spécifié, retourne uniquement les objets qui correspondent aux états spécifiés.

Retours

Nom Chemin d’accès Type Description
Codes d’appareil
device_codes array of object
ID
device_codes.id string

Identificateur unique émis par carré.

Nom
device_codes.name string

Nom de l’objet.

Code
device_codes.code string

Code unique qui peut être utilisé pour se connecter.

Type de produit
device_codes.product_type string

Type de produit cible du code de l’appareil.

ID d’emplacement
device_codes.location_id string

Identificateur de l’emplacement.

Créé à
device_codes.created_at string

Heure de l’événement au format ISO 8601.

Appairer par
device_codes.pair_by string

Lorsque deviceCode expire et ne se connecte plus. Horodatage au format RFC 3339.

Statut
device_codes.status string

État de vérification actuel de cet objet.

ID d’appareil
device_codes.device_id string

ID unique de l’appareil qui a utilisé ce code. Renseigné lorsque l’appareil est associé.

État modifié à l’adresse
device_codes.status_changed_at string

Lorsque l’état de ce DeviceCode a été modifié pour la dernière fois. Horodatage au format RFC 3339.

Répertorier les comptes bancaires

Retourne une liste d’objets BankAccount liés à un compte Square.

Paramètres

Nom Clé Obligatoire Type Description
Cursor
cursor string

Curseur de pagination retourné par un appel précédent à ce point de terminaison.

Limit
limit integer

Limite supérieure du nombre à retourner dans la réponse.

ID d’emplacement
location_id string

Vous pouvez spécifier ce filtre facultatif pour récupérer uniquement les enregistrements appartenant à un emplacement spécifique.

Retours

Nom Chemin d’accès Type Description
Compte en banque
bank_accounts array of object
ID
bank_accounts.id string

Identificateur unique émis par carré.

Suffixe numéro de compte
bank_accounts.account_number_suffix string

Derniers chiffres du numéro de compte.

Pays
bank_accounts.country string

Code pays ISO 3166 Alpha-2.

Monnaie
bank_accounts.currency string

Code monétaire ISO 4217 à 3 caractères.

Type de compte
bank_accounts.account_type string

Objectif financier du compte bancaire associé.

Nom du titulaire
bank_accounts.holder_name string

Nom du titulaire du compte. Ce nom doit correspondre au nom de l’enregistrement de compte bancaire ciblé.

Numéro d’identification de la banque principale
bank_accounts.primary_bank_identification_number string

Identificateur principal de la banque.

ID d’emplacement
bank_accounts.location_id string

Identificateur de l’emplacement.

Statut
bank_accounts.status string

État de vérification actuel de cet objet.

Estimable
bank_accounts.creditable boolean

Indique s’il est possible que Square envoie de l’argent à ce compte bancaire.

Débitable
bank_accounts.debitable boolean

Indique s’il est possible que Square envoie de l’argent à ce compte bancaire.

Version
bank_accounts.version integer

Version actuelle de l’objet.

Nom de la banque
bank_accounts.bank_name string

Nom de l’institution financière réelle.

Répertorier les configurations workweek

Retourne une liste d’instances WorkweekConfig pour une entreprise.

Paramètres

Nom Clé Obligatoire Type Description
Limit
limit integer

Limite supérieure du nombre à retourner dans la réponse.

Cursor
cursor string

Curseur de pagination retourné par un appel précédent à ce point de terminaison.

Retours

Nom Chemin d’accès Type Description
Workweek Configs
workweek_configs array of object
ID
workweek_configs.id string

Identificateur unique émis par carré.

Début de la semaine
workweek_configs.start_of_week string

Jour de la semaine sur lequel une semaine d’affaires se termine à des fins de compensation.

Heure locale de début de la journée
workweek_configs.start_of_day_local_time string

Heure locale à laquelle se termine une semaine d’affaires. Représenté sous forme de chaîne au format HH :MM (HH :MM :SS est également accepté, mais les secondes sont tronquées).

Version
workweek_configs.version integer

Version actuelle de l’objet.

Créé à
workweek_configs.created_at string

Heure de l’événement au format ISO 8601.

Mise à jour à
workweek_configs.updated_at string

Horodatage de dernière modification au format RFC 3339

Cursor
cursor string

Incluez le curseur de pagination dans les appels suivants à ce point de terminaison pour récupérer le jeu de résultats suivant associé à la requête d’origine.

Répertorier les emplacements

Fournit des informations sur tous les emplacements d’une entreprise.

Retours

Nom Chemin d’accès Type Description
Lieux
locations array of object
ID
locations.id string

Identificateur unique émis par carré.

Nom
locations.name string

Nom de l’objet.

Ligne d’adresse 1
locations.address.address_line_1 string

Première ligne de l’adresse.

Localité
locations.address.locality string

La ville ou la ville de l’adresse.

Niveau de district administratif 1
locations.address.administrative_district_level_1 string

Entité civile dans le pays de l’adresse. Aux États-Unis, c’est l’État.

Code postal
locations.address.postal_code string

Code postal de l’adresse.

Pays
locations.address.country string

Pays de l’adresse, au format ISO 3166-1-alpha-2.

Timezone
locations.timezone string

Fuseau horaire utilisé pour interpréter les dates de calendrier sur la facture, telles que due_date. Lorsqu’une facture est créée, ce champ est défini sur le fuseau horaire spécifié pour l’emplacement du vendeur. Impossible de modifier la valeur.

Capacités
locations.capabilities array of string
Statut
locations.status string

État de vérification actuel de cet objet.

Créé à
locations.created_at string

Heure de l’événement au format ISO 8601.

ID de marchand
locations.merchant_id string

ID du marchand propriétaire de l’emplacement.

Pays
locations.country string

Code pays ISO 3166 Alpha-2.

Code de langue
locations.language_code string

Langue associée à l’emplacement, au format BCP 47.

Monnaie
locations.currency string

Code monétaire ISO 4217 à 3 caractères.

Numéro de téléphone
locations.phone_number string

Numéro de téléphone à 11 chiffres associé au profil client.

Nom de l’entreprise
locations.business_name string

Nom commercial de l’emplacement : il s’agit du nom visible par les clients de l’emplacement. Par exemple, ce nom apparaît sur les reçus des clients.

Répertorier les marchands

Retourne les informations du marchand pour un jeton d’accès donné.

Paramètres

Nom Clé Obligatoire Type Description
Cursor
cursor integer

Curseur de pagination retourné par un appel précédent à ce point de terminaison.

Retours

Nom Chemin d’accès Type Description
Commerçant
merchant array of object
ID
merchant.id string

Identificateur unique émis par carré.

Nom de l’entreprise
merchant.business_name string

Nom commercial de l’emplacement : il s’agit du nom visible par les clients de l’emplacement. Par exemple, ce nom apparaît sur les reçus des clients.

Pays
merchant.country string

Code pays ISO 3166 Alpha-2.

Code de langue
merchant.language_code string

Langue associée à l’emplacement, au format BCP 47.

Monnaie
merchant.currency string

Code monétaire ISO 4217 à 3 caractères.

Statut
merchant.status string

État de vérification actuel de cet objet.

ID d’emplacement principal
merchant.main_location_id string

ID de l’emplacement principal de ce commerçant.

Répertorier les profils de réservation des membres de l’équipe (bêta)

Répertorie les profils de réservation pour les membres de l’équipe.

Paramètres

Nom Clé Obligatoire Type Description
Bookable uniquement
bookable_only boolean

Indique s’il faut inclure uniquement les membres de l’équipe bookable dans le résultat retourné (true) ou non (false).

Limit
limit integer

Limite supérieure du nombre à retourner dans la réponse.

Cursor
cursor string

Curseur de pagination retourné par un appel précédent à ce point de terminaison.

ID d’emplacement
location_id string

Vous pouvez spécifier ce filtre facultatif pour récupérer uniquement les enregistrements appartenant à un emplacement spécifique.

Retours

Nom Chemin d’accès Type Description
Profils de réservation des membres de l’équipe
team_member_booking_profiles array of object
ID de membre de l’équipe
team_member_booking_profiles.team_member_id string

ID de l’objet TeamMember pour le membre de l’équipe associé à l’objet.

Nom d’affichage
team_member_booking_profiles.display_name string

Nom complet du membre de l’équipe.

Est bookable
team_member_booking_profiles.is_bookable boolean

Indique si le membre de l’équipe peut être réservé via l’API Bookings ou le canal de réservation en ligne du vendeur (true) ou non (false').

Errors
errors array of

Répertorier les salaires des membres de l’équipe

Retourne une liste paginé d’instances TeamMemberWage pour une entreprise.

Paramètres

Nom Clé Obligatoire Type Description
ID de membre de l’équipe
team_member_id string

Filtrez les salaires retournés uniquement sur ceux associés au membre de l’équipe spécifié.

Limit
limit integer

Limite supérieure du nombre à retourner dans la réponse.

Cursor
cursor string

Curseur de pagination retourné par un appel précédent à ce point de terminaison.

Retours

Nom Chemin d’accès Type Description
Salaires des membres de l’équipe
team_member_wages array of object
ID
team_member_wages.id string

Identificateur unique émis par carré.

ID de membre de l’équipe
team_member_wages.team_member_id string

ID de l’objet TeamMember pour le membre de l’équipe associé à l’objet.

Titre
team_member_wages.title string

Titre de la facture.

Montant
team_member_wages.hourly_rate.amount integer

Montant.

Monnaie
team_member_wages.hourly_rate.currency string

La devise.

Cursor
cursor string

Incluez le curseur de pagination dans les appels suivants à ce point de terminaison pour récupérer le jeu de résultats suivant associé à la requête d’origine.

Répertorier les sites

Répertorie les sites Square Online qui appartiennent à un vendeur.

Retours

Nom Chemin d’accès Type Description
Sites
sites array of object
ID
sites.id string

Identificateur unique émis par carré.

Titre du site
sites.site_title string

Titre du site.

Domain
sites.domain string

Domaine du site (sans le protocole).

Est publié
sites.is_published boolean

Indique si le site est publié.

Créé à
sites.created_at string

Heure de l’événement au format ISO 8601.

Mise à jour à
sites.updated_at string

Horodatage de dernière modification au format RFC 3339

Répertorier les événements de décalage du tiroir-caisse

Fournit une liste paginé d’événements pour un décalage de tiroir-caisse unique.

Paramètres

Nom Clé Obligatoire Type Description
ID de décalage
shift_id True string

Identificateur du décalage.

ID d’emplacement
location_id True string

Vous pouvez spécifier ce filtre facultatif pour récupérer uniquement les enregistrements appartenant à un emplacement spécifique.

Limit
limit integer

Limite supérieure du nombre à retourner dans la réponse.

Cursor
cursor string

Curseur de pagination retourné par un appel précédent à ce point de terminaison.

Retours

Nom Chemin d’accès Type Description
Événements
events array of object
ID
events.id string

Identificateur unique émis par carré.

Type d'événement
events.event_type string

Type d’événement de décalage du tiroir-caisse.

Montant
events.event_money.amount integer

Montant.

Monnaie
events.event_money.currency string

La devise.

Créé à
events.created_at string

Heure de l’événement au format ISO 8601.

Descriptif
events.title string

Description.

Supprimer la récompense de fidélité

Supprime une récompense de fidélité. Retourne les points de fidélité au compte de fidélité. Vous ne pouvez pas supprimer une récompense qui a atteint l’état du terminal (ÉCHANGEED).

Paramètres

Nom Clé Obligatoire Type Description
ID de récompense
reward_id True string

Identificateur de la récompense.

Retours

response
object

Supprimer le décalage

Supprime un décalage

Paramètres

Nom Clé Obligatoire Type Description
ID
id True string

Identificateur.

Retours

response
object

Supprimer le type d’arrêt

Supprime un BreakType existant. Un BreakType peut être supprimé même s’il est référencé à partir d’un Shift.

Paramètres

Nom Clé Obligatoire Type Description
ID
id True string

Identificateur.

Retours

response
object

Supprimer un extrait de code

Supprime votre extrait de code d’un site Square Online.

Paramètres

Nom Clé Obligatoire Type Description
ID de site
site_id True string

Identificateur du site.

Retours

response
object

Types d’arrêt de liste

Retourne une liste paginé d’instances BreakType pour une entreprise.

Paramètres

Nom Clé Obligatoire Type Description
ID d’emplacement
location_id string

Vous pouvez spécifier ce filtre facultatif pour récupérer uniquement les enregistrements appartenant à un emplacement spécifique.

Limit
limit integer

Limite supérieure du nombre à retourner dans la réponse.

Cursor
cursor string

Curseur de pagination retourné par un appel précédent à ce point de terminaison.

Retours

Nom Chemin d’accès Type Description
Types d’arrêt
break_types array of object
ID
break_types.id string

Identificateur unique émis par carré.

ID d’emplacement
break_types.location_id string

Identificateur de l’emplacement.

Nom d’arrêt
break_types.break_name string

Nom lisible par l’homme pour ce type de rupture. Le nom est affiché aux employés dans les produits Square.

Durée attendue
break_types.expected_duration string

Longueur attendue de ce saut. Format : RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]M[n]S. La précision inférieure à la minute est tronquée.

Est payé
break_types.is_paid boolean

Indique si cette pause compte pour le temps travaillé à des fins de rémunération.

Version
break_types.version integer

Version actuelle de l’objet.

Créé à
break_types.created_at string

Heure de l’événement au format ISO 8601.

Mise à jour à
break_types.updated_at string

Horodatage de dernière modification au format RFC 3339

Cursor
cursor string

Incluez le curseur de pagination dans les appels suivants à ce point de terminaison pour récupérer le jeu de résultats suivant associé à la requête d’origine.

Échanger la récompense de fidélité

Échange une récompense de fidélité. Une fois la récompense atteinte à l’état terminal, elle ne peut pas être supprimée. En d’autres termes, les points utilisés pour la récompense ne peuvent pas être retournés au compte.

Paramètres

Nom Clé Obligatoire Type Description
ID de récompense
reward_id True string

Identificateur de la récompense.

Clé d’Idempotency
idempotency_key string

Valeur que vous spécifiez qui identifie de manière unique cette demande parmi toutes vos demandes. Une façon courante de créer une clé d’idempotency valide consiste à utiliser un identificateur UUID (Universally Unique Identifier).

ID d’emplacement
location_id string

Identificateur d’emplacement.

Retours

Nom Chemin d’accès Type Description
ID
event.id string

Identificateur unique émis par carré.

Type
event.type string

Type de cet objet.

Créé à
event.created_at string

Horodatage spécifiant l’heure de création de cet objet, au format RFC 3339.

ID du programme de fidélité
event.redeem_reward.loyalty_program_id string

ID du programme de fidélité

ID de récompense
event.redeem_reward.reward_id string

ID attribué au carré de la récompense de fidélité.

ID du compte de fidélité
event.loyalty_account_id string

ID du compte de fidélité dans lequel l’événement s’est produit.

ID d’emplacement
event.location_id string

Identificateur de l’emplacement.

Origine
event.source string

Source.

Définitions

objet

Il s’agit du type 'object'.