Square Business (Publicador independiente) (versión preliminar)

Square ayuda a millones de vendedores a ejecutar su negocio, desde el procesamiento seguro de tarjetas de crédito hasta soluciones de punto de venta. Este conector contiene acciones para los siguientes puntos de conexión: Lealtad, Tarjetas de regalo, Bookings, Business, Team, Financials, Online y Auth.

Este conector está disponible en los siguientes productos y regiones:

Service	Class	Regions
Copilot Studio	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas	Estándar	Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD)
Power Apps	Premium	Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)
Power Automate	Premium	Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD)

Contacto
Nombre	Troy Taylor
URL	https://www.hitachisolutions.com
Correo Electrónico	ttaylor@hitachisolutions.com

Metadatos del conector
Publicador	Troy Taylor
Sitio web	https://squareup.com/
Directiva de privacidad	https://squareup.com/us/en/legal/general/privacy
Categorías	Comercio; Ventas y CRM

Limitaciones

Nombre	Llamadas	Período de renovación
Llamadas API por conexión	100	60 segundos

Acciones

Actualización de la configuración de la semana laboral	Actualiza workweekConfig.
Actualización de la configuración de salarios	Crea o actualiza un objeto WageSetting.
Actualizar miembro del equipo	Actualiza un único objeto TeamMember.
Acumular puntos de fidelidad	Agrega puntos a una cuenta de fidelidad.
Ajustar puntos de fidelidad	Agrega puntos a o resta puntos de la cuenta de un comprador. Use este punto de conexión solo cuando necesite ajustar manualmente los puntos.
Buscar cuentas de fidelidad	Busca cuentas de fidelidad en un programa de fidelidad.
Buscar eventos de fidelidad	Busca eventos de fidelidad. Un programa de fidelidad square mantiene un libro de contabilidad de eventos que se producen durante la vigencia de la cuenta de fidelidad de un comprador. Cada cambio en el saldo de puntos (por ejemplo, puntos obtenidos, puntos canjeados y puntos expirados) se registra en el libro de contabilidad. Con este punto de conexión, puede buscar eventos en el libro de contabilidad.
Buscar miembros del equipo	Devuelve una lista paginada de objetos TeamMember para una empresa.
Buscar recompensas de fidelidad	Busca recompensas de fidelidad en una cuenta de fidelidad.
Cambio de actualización	Actualiza un shift existente.
Canjear recompensa de lealtad	Canjea una recompensa de lealtad. Una vez que la recompensa alcanza el estado terminal, no se puede eliminar. Es decir, los puntos usados para la recompensa no se pueden devolver a la cuenta.
Creación de código de autorización móvil	Genera código para autorizar a una aplicación móvil a conectarse a un lector de tarjetas Square. Los códigos de autorización son de uso único y expiran 60 minutos después de emitirse.
Creación de código de dispositivo	Crea un DeviceCode que se puede usar para iniciar sesión en un dispositivo de Terminal Square para entrar en el modo de terminal conectado.
Creación de reservas (beta)	Crea una reserva.
Creación de un miembro del equipo	Crea un único objeto TeamMember.
Creación de una cuenta de fidelidad	Crea una cuenta de fidelidad.
Creación masiva de miembros del equipo	Crea varios objetos TeamMember.
Crear actividad de tarjetas regalo (Beta)	Crea una actividad de tarjeta de regalo.
Crear desplazamiento	Crea un nuevo Mayús. Un turno representa un día laboral completo para un único empleado
Crear desprotección	Vincula un valor de checkoutId a un checkout_page_url al que se dirige a los clientes para proporcionar su información de pago mediante un flujo de trabajo de procesamiento de pagos.
Crear recompensa de fidelidad	Crea una recompensa de lealtad. Después de crear una recompensa, los puntos están bloqueados y no están disponibles para que el comprador canjee otra recompensa.
Crear tipo de interrupción	Crea un nuevo BreakType. BreakType es una plantilla para crear objetos Break.
Crear ubicación (Beta)	Crea una ubicación.
Cálculo de puntos de fidelidad	Calcula los puntos que obtiene una compra. Una aplicación podría llamar a este punto de conexión para mostrar los puntos que un comprador puede ganar con la compra específica.
Desvincular al cliente de la tarjeta de regalo (Beta)	Desvincula a un cliente de una tarjeta de regalo.
Disponibilidad de búsqueda (beta)	Busca disponibilidades para la reserva.
Eliminar desplazamiento	Elimina un turno.
Eliminar fragmento de código	Quita el fragmento de código de un sitio de Square Online.
Eliminar recompensa de fidelidad	Elimina una recompensa de fidelidad. Devuelve los puntos de fidelidad a la cuenta de fidelidad. No se puede eliminar una recompensa que haya alcanzado el estado terminal (REDEEMED).
Eliminar tipo de interrupción	Elimina un BreakType existente. Se puede eliminar un BreakType incluso si se hace referencia a él desde un Shift.
Enumerar actividades de tarjetas de regalo (Beta)	Enumera las actividades de tarjetas de regalo. De forma predeterminada, obtendrás actividades de tarjetas de regalo para todas las tarjetas de regalo de la cuenta del vendedor. Opcionalmente, puede especificar parámetros de consulta para filtrar la lista. Por ejemplo, puede obtener una lista de actividades de tarjetas de regalo para una tarjeta de regalo, para todas las tarjetas de regalo de una región específica o para actividades dentro de un período de tiempo.
Enumerar comerciantes	Devuelve información de comerciante para un token de acceso determinado.
Enumerar configuraciones de semana laboral	Devuelve una lista de instancias de WorkweekConfig para una empresa.
Enumerar cuentas bancarias	Devuelve una lista de objetos BankAccount vinculados a una cuenta square.
Enumerar códigos de dispositivo	Enumera todos los DeviceCodes asociados al comerciante.
Enumerar eventos de desplazamiento de cajón de efectivo	Proporciona una lista paginada de eventos para un único cambio de cajón de efectivo.
Enumerar los salarios de los miembros del equipo	Devuelve una lista paginada de instancias de TeamMemberWage para una empresa.
Enumerar perfiles de reserva de miembros del equipo (Beta)	Enumera los perfiles de reserva para los miembros del equipo.
Enumerar sitios	Enumera los sitios de Square Online que pertenecen a un vendedor.
Enumerar ubicaciones	Proporciona información de todas las ubicaciones de una empresa.
Fragmento de código upsert	Agrega un fragmento de código a un sitio de Square Online o actualiza el fragmento de código existente en el sitio. El código de fragmento de código se anexa al final del elemento head en todas las páginas del sitio, excepto las páginas de desprotección. Una aplicación de fragmento de código puede agregar un fragmento de código a un sitio determinado.
Miembros del equipo de actualización masiva	Actualiza varios objetos TeamMember.
Mostrar turnos de cajón de efectivo	Proporciona los detalles de todos los turnos de cajón de efectivo para una ubicación en un intervalo de fechas.
Obtención de una cuenta bancaria por identificador V1	Devuelve los detalles de una cuenta bancaria identificada por el identificador de cuenta bancaria V1.
Obtener cuenta bancaria	Devuelve los detalles de una cuenta de BankAccount vinculada a una cuenta de Square.
Obtener código de dispositivo	Recupera DeviceCode con el identificador asociado.
Obtener desplazamiento	Devuelve un único Mayús especificado por id.
Obtener salario de miembro del equipo	Devuelve un único TeamMemberWage especificado por id.
Obtener tipo de interrupción	Devuelve un único BreakType especificado por id.
Recuperación de la configuración de salarios	Recupera un objeto WageSetting para un miembro del equipo especificado por teamMember id.
Recuperación de la cuenta de fidelidad	Recupera una cuenta de fidelidad.
Recuperación del perfil de reserva empresarial (Beta)	Recupera el perfil de reserva de un vendedor.
Recuperación del programa de fidelidad	Recupera el programa de fidelidad en la cuenta de un vendedor, especificado por el identificador de programa o la palabra clave principal. Los programas de fidelidad definen cómo los compradores pueden ganar puntos y canjear puntos por recompensas.
Recuperar comerciante	Recupere un objeto Merchant para el merchant_id especificado.
Recuperar desplazamiento del cajón de efectivo	Proporciona los detalles de resumen de un único turno de cajón de efectivo.
Recuperar fragmento de código	Recupera el fragmento de código de un sitio de Square Online. Un sitio puede contener fragmentos de código de varias aplicaciones de fragmento de código, pero solo puede recuperar el fragmento de código que agregó la aplicación.
Recuperar miembro del equipo	Recupera un objeto TeamMember para el identificador TeamMember especificado.
Recuperar recompensa de fidelidad	Recupera una recompensa de fidelidad.
Recuperar tarjeta de regalo (Beta)	Recupera una tarjeta de regalo con su identificador.
Recuperar tarjeta de regalo de GAN (Beta)	Recupera una tarjeta de regalo con el número de cuenta de la tarjeta de regalo (GAN).
Recuperar tarjeta de regalo de nonce (Beta)	Recupera una tarjeta de regalo mediante un nonce (un token seguro) que representa la tarjeta de regalo.
Recuperar ubicación	Recupera los detalles de una ubicación. Puede especificar "main" como identificador de ubicación para recuperar los detalles de la ubicación principal.
Tipo de interrupción de actualización	Actualiza un BreakType existente.
Tipos de interrupción de lista	Devuelve una lista paginada de instancias breakType para una empresa.
Turnos de búsqueda	Devuelve una lista paginada de registros Shift para una empresa.
Ubicación de actualización (Beta)	Actualiza una ubicación.
Vincular al cliente a la tarjeta de regalo (Beta)	Vincula a un cliente a una tarjeta de regalo

Actualización de la configuración de la semana laboral

Id. de la operación:: LaborUpdateConfig

Actualiza workweekConfig.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.
Comienzo de la semana	start_of_week		string	El día de la semana en el que finaliza una semana comercial con fines de compensación.
Hora local de inicio del día	start_of_day_local_time		string	Hora local en la que finaliza una semana comercial. Se representa como una cadena en formato HH:MM (también se acepta HH:MM:SS, pero los segundos se truncan).
Versión	version		integer	La versión actual de este objeto.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	workweek_config.id	string	Identificador único emitido por Square.
Comienzo de la semana	workweek_config.start_of_week	string	El día de la semana en el que finaliza una semana comercial con fines de compensación.
Hora local de inicio del día	workweek_config.start_of_day_local_time	string	Hora local en la que finaliza una semana comercial. Se representa como una cadena en formato HH:MM (también se acepta HH:MM:SS, pero los segundos se truncan).
Versión	workweek_config.version	integer	La versión actual de este objeto.
Creado en	workweek_config.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	workweek_config.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Actualización de la configuración de salarios

Id. de la operación:: TeamUpdateWage

Crea o actualiza un objeto WageSetting.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de miembro del equipo	team_member_id	True	string	Identificador del miembro del equipo.
Está exento de horas extra	is_overtime_exempt		boolean	Si el miembro del equipo está exento de las reglas de horas extra del país del vendedor.
Título del Puesto	job_title		string	Título del trabajo.
Tipo de pago	pay_type		string	Tipo de pago actual para la asignación de trabajo utilizada para calcular el importe de pago en un período de pago.
Importe	amount		integer	Cantidad.
Moneda	currency		string	Moneda.
Horas semanales	weekly_hours		integer	Las horas planeadas por semana para el trabajo. Establezca si el trabajo PayType es SALARY.
Importe	amount		integer	Cantidad.
Moneda	currency		string	Moneda.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Id. de miembro del equipo	wage_setting.team_member_id	string	Identificador del miembro del equipo.
Asignaciones de trabajos	wage_setting.job_assignments	array of object
Título del Puesto	wage_setting.job_assignments.job_title	string	Título del trabajo.
Tipo de pago	wage_setting.job_assignments.pay_type	string	Tipo de pago actual para la asignación de trabajo utilizada para calcular el importe de pago en un período de pago.
Importe	wage_setting.job_assignments.hourly_rate.amount	integer	Cantidad.
Moneda	wage_setting.job_assignments.hourly_rate.currency	string	Moneda.
Importe	wage_setting.job_assignments.annual_rate.amount	integer	Cantidad.
Moneda	wage_setting.job_assignments.annual_rate.currency	string	Moneda.
Horas semanales	wage_setting.job_assignments.weekly_hours	integer	Las horas planeadas por semana para el trabajo. Establezca si el trabajo PayType es SALARY.
Está exento de horas extra	wage_setting.is_overtime_exempt	boolean	Si el miembro del equipo está exento de las reglas de horas extra del país del vendedor.
Versión	wage_setting.version	integer	La versión actual de este objeto.
Creado en	wage_setting.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	wage_setting.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Actualizar miembro del equipo

Id. de la operación:: TeamUpdate

Actualiza un único objeto TeamMember.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de miembro del equipo	team_member_id	True	string	Identificador del miembro del equipo.
Identificador de referencia	reference_id		string	Identificador de referencia definido por el usuario opcional.
Estado	status		string	Estado de comprobación actual de este objeto.
Nombre propio	given_name		string	Nombre especificado (es decir, primero) asociado al perfil de cliente.
Apellido	family_name		string	El nombre de la familia (es decir, apellido) asociado al perfil de cliente.
Dirección de correo electrónico	email_address		string	Dirección de correo electrónico asociada al perfil de cliente.
Número de teléfono	phone_number		string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Identificadores de ubicación	location_ids		array of string
Tipo de asignación	assignment_type		string	Tipo de asignación actual del miembro del equipo.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	team_member.id	string	Identificador único emitido por Square.
Identificador de referencia	team_member.reference_id	string	Identificador de referencia definido por el usuario opcional.
Es propietario	team_member.is_owner	boolean	Si el miembro del equipo es el propietario de la cuenta de Square.
Estado	team_member.status	string	Estado de comprobación actual de este objeto.
Nombre propio	team_member.given_name	string	Nombre especificado (es decir, primero) asociado al perfil de cliente.
Apellido	team_member.family_name	string	El nombre de la familia (es decir, apellido) asociado al perfil de cliente.
Dirección de correo electrónico	team_member.email_address	string	Dirección de correo electrónico asociada al perfil de cliente.
Número de teléfono	team_member.phone_number	string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Creado en	team_member.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Tipo de asignación	team_member.assigned_locations.assignment_type	string	Tipo de asignación actual del miembro del equipo.
Identificadores de ubicación	team_member.assigned_locations.location_ids	array of string

Acumular puntos de fidelidad

Id. de la operación:: LoyaltyAccumulatePoints

Agrega puntos a una cuenta de fidelidad.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de cuenta	account_id	True	string	Identificador de la cuenta.
Id. de pedido	order_id		string	Identificador del pedido.
Id. de ubicación	location_id		string	Identificador de ubicación.
Clave de iempoencia	idempotency_key		string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	event.id	string	Identificador único emitido por Square.
Tipo	event.type	string	El tipo de este objeto.
Creado en	event.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Id. del programa de fidelidad	event.accumulate_points.loyalty_program_id	string	El identificador del programa de fidelidad
Puntos	event.accumulate_points.points	integer	Número de puntos acumulados por el evento.
Id. de pedido	event.accumulate_points.order_id	string	Identificador del orden asociado a la actividad.
Id. de cuenta de fidelidad	event.loyalty_account_id	string	Identificador de la cuenta de fidelidad en la que se produjo el evento.
Id. de ubicación	event.location_id	string	Identificador de la ubicación.
Fuente	event.source	string	Origen.

Ajustar puntos de fidelidad

Id. de la operación:: LoyaltyAdjustPoints

Agrega puntos a o resta puntos de la cuenta de un comprador. Use este punto de conexión solo cuando necesite ajustar manualmente los puntos.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de cuenta	account_id	True	string	Identificador de la cuenta.
Puntos	points		integer	Número de puntos agregados o eliminados.
Motivo	reason		string	Motivo de este objeto.
Clave de iempoencia	idempotency_key		string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	event.id	string	Identificador único emitido por Square.
Tipo	event.type	string	El tipo de este objeto.
Creado en	event.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Id. del programa de fidelidad	event.adjust_points.loyalty_program_id	string	El identificador del programa de fidelidad
Puntos	event.adjust_points.points	integer	Número de puntos acumulados por el evento.
Motivo	event.adjust_points.reason	string	Motivo del ajuste de puntos.
Id. de cuenta de fidelidad	event.loyalty_account_id	string	Identificador de la cuenta de fidelidad en la que se produjo el evento.
Fuente	event.source	string	Origen.

Buscar cuentas de fidelidad

Id. de la operación:: LoyaltySearchAccounts

Busca cuentas de fidelidad en un programa de fidelidad.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Limit	limit		integer	Límite en el número de resultados que se van a devolver en una sola página. El límite es aviso: la implementación puede devolver más o menos resultados. Si el límite proporcionado es negativo, cero o es mayor que el límite máximo de 1000, se omitirá.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Cuentas de fidelidad	loyalty_accounts	array of object
identificación	loyalty_accounts.id	string	Identificador único emitido por Square.
identificación	loyalty_accounts.mapping.id	string	Identificador del objeto
Número de teléfono	loyalty_accounts.mapping.phone_number	string	Número de teléfono del destinatario.
Creado en	loyalty_accounts.mapping.created_at	string	Marca de tiempo cuando se crea, en formato RFC 3339.
Id. de programa	loyalty_accounts.program_id	string	Identificador asignado a Square del programa de fidelidad al que pertenece la cuenta.
Saldo	loyalty_accounts.balance	integer	Saldo de punto disponible en la cuenta de fidelidad.
Puntos de duración	loyalty_accounts.lifetime_points	integer	Los puntos totales acumulados durante la vigencia de la cuenta.
Id. de cliente	loyalty_accounts.customer_id	string	Identificador asignado a Square del cliente asociado a la cuenta.
Creado en	loyalty_accounts.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	loyalty_accounts.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Cursor	cursor	string	Incluya el cursor de paginación en llamadas posteriores a este punto de conexión para recuperar el siguiente conjunto de resultados asociado a la consulta original.

Buscar eventos de fidelidad

Id. de la operación:: LoyaltySearchEvents

Busca eventos de fidelidad. Un programa de fidelidad square mantiene un libro de contabilidad de eventos que se producen durante la vigencia de la cuenta de fidelidad de un comprador. Cada cambio en el saldo de puntos (por ejemplo, puntos obtenidos, puntos canjeados y puntos expirados) se registra en el libro de contabilidad. Con este punto de conexión, puede buscar eventos en el libro de contabilidad.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de pedido	order_id		string	Identificador de pedido.
Limit	limit		integer	Límite en el número de resultados que se van a devolver en una sola página. El límite es aviso: la implementación puede devolver más o menos resultados. Si el límite proporcionado es negativo, cero o es mayor que el límite máximo de 1000, se omitirá.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Eventos	events	array of object
identificación	events.id	string	Identificador único emitido por Square.
Tipo	events.type	string	El tipo de este objeto.
Creado en	events.created_at	string	Hora del evento en formato ISO 8601.
Id. del programa de fidelidad	events.accumulate_points.loyalty_program_id	string	El identificador del programa de fidelidad
Puntos	events.accumulate_points.points	integer	Número de puntos acumulados por el evento.
Id. de pedido	events.accumulate_points.order_id	string	Identificador del orden asociado a la actividad.
Id. de cuenta de fidelidad	events.loyalty_account_id	string	Identificador de la cuenta de fidelidad en la que se produjo el evento.
Id. de ubicación	events.location_id	string	Identificador de la ubicación.
Fuente	events.source	string	Define si el evento lo generó el punto de venta cuadrado.
Id. del programa de fidelidad	events.redeem_reward.loyalty_program_id	string	El identificador del programa de fidelidad
Id. de recompensa	events.redeem_reward.reward_id	string	El identificador de la recompensa de lealtad canjeada.
Id. de pedido	events.redeem_reward.order_id	string	Identificador del orden asociado a la actividad.
Id. del programa de fidelidad	events.create_reward.loyalty_program_id	string	El identificador del programa de fidelidad
Id. de recompensa	events.create_reward.reward_id	string	El identificador de la recompensa de lealtad canjeada.
Puntos	events.create_reward.points	integer	Número de puntos acumulados por el evento.

Buscar miembros del equipo

Id. de la operación:: TeamSearch

Devuelve una lista paginada de objetos TeamMember para una empresa.

Parámetros

Nombre	Clave	Tipo	Description
Identificadores de ubicación	location_ids	array of string
Estado	status	string	Estado actual.
Limit	limit	integer	Límite en el número de resultados que se van a devolver en una sola página. El límite es aviso: la implementación puede devolver más o menos resultados. Si el límite proporcionado es negativo, cero o es mayor que el límite máximo de 1000, se omitirá.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Miembros del equipo	team_members	array of object
identificación	team_members.id	string	Identificador único emitido por Square.
Identificador de referencia	team_members.reference_id	string	Un segundo identificador opcional que se usa para asociar el perfil de cliente a una entidad en otro sistema.
Es propietario	team_members.is_owner	boolean	Si el miembro del equipo es el propietario de la cuenta de Square.
Estado	team_members.status	string	Estado de comprobación actual de este objeto.
Nombre propio	team_members.given_name	string	Nombre especificado (es decir, primero) asociado al perfil de cliente.
Apellido	team_members.family_name	string	El nombre de la familia (es decir, apellido) asociado al perfil de cliente.
Dirección de correo electrónico	team_members.email_address	string	Dirección de correo electrónico asociada al perfil de cliente.
Creado en	team_members.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	team_members.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Tipo de asignación	team_members.assigned_locations.assignment_type	string	Tipo de asignación actual del miembro del equipo.
Número de teléfono	team_members.phone_number	string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Cursor	cursor	string	Incluya el cursor de paginación en llamadas posteriores a este punto de conexión para recuperar el siguiente conjunto de resultados asociado a la consulta original.

Buscar recompensas de fidelidad

Id. de la operación:: LoyaltySearchRewards

Busca recompensas de fidelidad en una cuenta de fidelidad.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de cuenta de fidelidad	loyalty_account_id		string	Identificador de la cuenta de fidelidad en la que se produjo el evento.
Limit	limit		integer	Límite en el número de resultados que se van a devolver en una sola página. El límite es aviso: la implementación puede devolver más o menos resultados. Si el límite proporcionado es negativo, cero o es mayor que el límite máximo de 1000, se omitirá.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Recompensas	rewards	array of object
identificación	rewards.id	string	Identificador único emitido por Square.
Estado	rewards.status	string	Estado de comprobación actual de este objeto.
Id. de cuenta de fidelidad	rewards.loyalty_account_id	string	Identificador de la cuenta de fidelidad en la que se produjo el evento.
Id. de nivel de recompensa	rewards.reward_tier_id	string	El identificador asignado a Cuadrado del nivel de recompensa usado para crear la recompensa.
Puntos	rewards.points	integer	Número de puntos de fidelidad utilizados para la recompensa.
Id. de pedido	rewards.order_id	string	Identificador del pedido.
Creado en	rewards.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	rewards.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Canjeado en	rewards.redeemed_at	string	Marca de tiempo en la que se canjeó la recompensa, en formato RFC 3339.

Cambio de actualización

Id. de la operación:: LaborUpdateShift

Actualiza un shift existente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.
Id. de miembro del equipo	team_member_id		string	Identificador del miembro del equipo.
Id. de ubicación	location_id		string	Identificador de la ubicación.
Comenzar a	start_at		string	Marca de tiempo que especifica la hora de inicio de este objeto, en formato RFC 3339.
Finalizar al	end_at		string	RFC 3339; desplazado a la zona horaria + desplazamiento. Se respeta la precisión hasta el minuto; segundos se truncan.
Title	title		string	Nombre del trabajo realizado durante este turno. Las UIs de informes de mano de obra cuadrada pueden agrupar turnos por título.
Importe	amount		integer	Cantidad.
Moneda	currency		string	Moneda.
identificación	id		string	Identificador del objeto
Comenzar a	start_at		string	RFC 3339; sigue la misma información de zona horaria que Mayús. Se respeta la precisión hasta el minuto; segundos se truncan.
Finalizar al	end_at		string	RFC 3339; sigue la misma información de zona horaria que Mayús. Se respeta la precisión hasta el minuto; segundos se truncan.
Id. de tipo de interrupción	break_type_id		string	BreakType en el que se creó la plantilla BreakType.
Nombre	name		string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Duración esperada	expected_duration		string	Longitud esperada de la interrupción. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
Se paga	is_paid		boolean	Si esta interrupción cuenta para el tiempo trabajado con fines de compensación.
Versión	version		integer	La versión actual de este objeto.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	shift.id	string	Identificador único emitido por Square.
Id. de miembro del equipo	shift.team_member_id	string	Identificador del miembro del equipo.
Id. de empleado	shift.employee_id	string	Identificador generado por cuadrados del empleado.
Id. de ubicación	shift.location_id	string	Identificador de la ubicación.
Timezone	shift.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Comenzar a	shift.start_at	string	Marca de tiempo que especifica la hora de inicio de este objeto, en formato RFC 3339.
Finalizar al	shift.end_at	string	RFC 3339; desplazado a la zona horaria + desplazamiento. Se respeta la precisión hasta el minuto; segundos se truncan.
Title	shift.wage.title	string	Nombre del trabajo realizado durante este turno. Las UIs de informes de mano de obra cuadrada pueden agrupar turnos por título.
Importe	shift.wage.hourly_rate.amount	integer	Cantidad.
Moneda	shift.wage.hourly_rate.currency	string	Moneda.
Interrupciones	shift.breaks	array of object
identificación	shift.breaks.id	string	Identificador del objeto
Comenzar a	shift.breaks.start_at	string	RFC 3339; sigue la misma información de zona horaria que Mayús. Se respeta la precisión hasta el minuto; segundos se truncan.
Finalizar al	shift.breaks.end_at	string	RFC 3339; sigue la misma información de zona horaria que Mayús. Se respeta la precisión hasta el minuto; segundos se truncan.
Id. de tipo de interrupción	shift.breaks.break_type_id	string	BreakType en el que se creó la plantilla BreakType.
Nombre	shift.breaks.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Duración esperada	shift.breaks.expected_duration	string	Longitud esperada de la interrupción. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
Se paga	shift.breaks.is_paid	boolean	Si esta interrupción cuenta para el tiempo trabajado con fines de compensación.
Estado	shift.status	string	Estado de comprobación actual de este objeto.
Versión	shift.version	integer	La versión actual de este objeto.
Creado en	shift.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	shift.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Canjear recompensa de lealtad

Id. de la operación:: LoyaltyRedeemReward

Canjea una recompensa de lealtad. Una vez que la recompensa alcanza el estado terminal, no se puede eliminar. Es decir, los puntos usados para la recompensa no se pueden devolver a la cuenta.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de recompensa	reward_id	True	string	Identificador de la recompensa.
Clave de iempoencia	idempotency_key		string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Id. de ubicación	location_id		string	Identificador de ubicación.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	event.id	string	Identificador único emitido por Square.
Tipo	event.type	string	El tipo de este objeto.
Creado en	event.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Id. del programa de fidelidad	event.redeem_reward.loyalty_program_id	string	El identificador del programa de fidelidad
Id. de recompensa	event.redeem_reward.reward_id	string	El identificador asignado a Square de la recompensa de lealtad.
Id. de cuenta de fidelidad	event.loyalty_account_id	string	Identificador de la cuenta de fidelidad en la que se produjo el evento.
Id. de ubicación	event.location_id	string	Identificador de la ubicación.
Fuente	event.source	string	Origen.

Creación de código de autorización móvil

Id. de la operación:: MobileAuthorizationCreate

Genera código para autorizar a una aplicación móvil a conectarse a un lector de tarjetas Square. Los códigos de autorización son de uso único y expiran 60 minutos después de emitirse.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de ubicación	location_id		string	Identificador de ubicación.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Código de autorización	authorization_code	string	Código de autorización generado que conecta una instancia de aplicación móvil a una cuenta de Square.
Expira a las	expires_at	string	Marca de tiempo cuando authorization_code expira en formato RFC 3339.

Creación de código de dispositivo

Id. de la operación:: DeviceCreate

Crea un DeviceCode que se puede usar para iniciar sesión en un dispositivo de Terminal Square para entrar en el modo de terminal conectado.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Nombre	name	string	Nombre del objeto.
Id. de ubicación	location_id	string	Identificador de la ubicación.
Tipo de producto	product_type	string	Tipo de producto de destino del código de dispositivo.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	device_code.id	string	Identificador único emitido por Square.
Nombre	device_code.name	string	Nombre del objeto.
Código	device_code.code	string	Código único que se puede usar para iniciar sesión.
Tipo de producto	device_code.product_type	string	Tipo de producto de destino del código de dispositivo.
Id. de ubicación	device_code.location_id	string	Identificador de la ubicación.
Creado en	device_code.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Emparejar por	device_code.pair_by	string	Cuando este DeviceCode expire y ya no inicie sesión. Marca de tiempo en formato RFC 3339.
Estado	device_code.status	string	Estado de comprobación actual de este objeto.
Estado cambiado en	device_code.status_changed_at	string	Cuando el estado de DeviceCode se cambió por última vez. Marca de tiempo en formato RFC 3339.

Creación de reservas (beta)

Id. de la operación:: BookingCreate

Crea una reserva.

Parámetros

Nombre	Clave	Tipo	Description
Id. de cliente	customer_id	string	Identificador de este objeto que representa al cliente.
Comenzar a	start_at	string	Marca de tiempo que especifica la hora de inicio de este objeto, en formato RFC 3339.
Id. de ubicación	location_id	string	Identificador de la ubicación.
Minutos de duración	duration_minutes	integer	Intervalo de tiempo en minutos de un segmento de cita.
Id. de miembro del equipo	team_member_id	string	Identificador del objeto TeamMember que representa al miembro del equipo reservado en este segmento.
Id. de variación de servicio	service_variation_id	string	Identificador del objeto CatalogItemVariation que representa el servicio reservado en este segmento.
Versión de variación del servicio	service_variation_version	integer	Versión actual de la variación de elemento que representa el servicio reservado en este segmento.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	booking.id	string	Identificador único emitido por Square.
Versión	booking.version	integer	La versión actual de este objeto.
Estado	booking.status	string	Estado de comprobación actual de este objeto.
Creado en	booking.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	booking.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Id. de ubicación	booking.location_id	string	Identificador de la ubicación.
Id. de cliente	booking.customer_id	string	Identificador de este objeto que representa al cliente.
Nota del cliente	booking.customer_note	string	Campo de texto libre para que el cliente proporcione notas sobre la reserva.
Nota del vendedor	booking.seller_note	string	Campo de texto libre para que el vendedor proporcione notas sobre la reserva.
Comenzar a	booking.start_at	string	Marca de tiempo que especifica la hora de inicio de este objeto, en formato RFC 3339.
Segmento de cita	booking.appointment_segments	array of object
Minutos de duración	booking.appointment_segments.duration_minutes	integer	Intervalo de tiempo en minutos de un segmento de cita.
Id. de variación de servicio	booking.appointment_segments.service_variation_id	string	Identificador del objeto CatalogItemVariation que representa el servicio reservado en este segmento.
Id. de miembro del equipo	booking.appointment_segments.team_member_id	string	Identificador del objeto TeamMember que representa al miembro del equipo reservado en este segmento.
Versión de variación del servicio	booking.appointment_segments.service_variation_version	integer	Versión actual de la variación de elemento que representa el servicio reservado en este segmento.
Errors	errors	array of

Creación de un miembro del equipo

Id. de la operación:: TeamCreateMember

Crea un único objeto TeamMember.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Identificador de referencia	reference_id	string	Identificador de referencia definido por el usuario opcional.
Estado	status	string	Estado de comprobación actual de este objeto.
Nombre propio	given_name	string	Nombre especificado (es decir, primero) asociado al perfil de cliente.
Apellido	family_name	string	El nombre de la familia (es decir, apellido) asociado al perfil de cliente.
Dirección de correo electrónico	email_address	string	Dirección de correo electrónico asociada al perfil de cliente.
Número de teléfono	phone_number	string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Identificadores de ubicación	location_ids	array of string
Tipo de asignación	assignment_type	string	Tipo de asignación actual del miembro del equipo.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	team_member.id	string	Identificador único emitido por Square.
Identificador de referencia	team_member.reference_id	string	Identificador de referencia definido por el usuario opcional.
Es propietario	team_member.is_owner	boolean	Si el miembro del equipo es el propietario de la cuenta de Square.
Estado	team_member.status	string	Estado de comprobación actual de este objeto.
Nombre propio	team_member.given_name	string	Nombre especificado (es decir, primero) asociado al perfil de cliente.
Apellido	team_member.family_name	string	El nombre de la familia (es decir, apellido) asociado al perfil de cliente.
Dirección de correo electrónico	team_member.email_address	string	Dirección de correo electrónico asociada al perfil de cliente.
Número de teléfono	team_member.phone_number	string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Tipo de asignación	team_member.assigned_locations.assignment_type	string	Tipo de asignación actual del miembro del equipo.
Identificadores de ubicación	team_member.assigned_locations.location_ids	array of string

Creación de una cuenta de fidelidad

Id. de la operación:: LoyaltyCreateAccount

Crea una cuenta de fidelidad.

Parámetros

Nombre	Clave	Tipo	Description
Número de teléfono	phone_number	string	Número de teléfono del destinatario.
Id. de programa	program_id	string	El identificador asignado a Square del programa.
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	loyalty_account.id	string	Identificador único emitido por Square.
identificación	loyalty_account.mapping.id	string	Identificador asignado a Square.
Número de teléfono	loyalty_account.mapping.phone_number	string	Número de teléfono del destinatario.
Creado en	loyalty_account.mapping.created_at	string	Marca de tiempo cuando se crea, en formato RFC 3339.
Id. de programa	loyalty_account.program_id	string	El identificador asignado a Square del programa.
Saldo	loyalty_account.balance	integer	Saldo disponible.
Puntos de duración	loyalty_account.lifetime_points	integer	Los puntos totales acumulados durante la vigencia de la cuenta.
Creado en	loyalty_account.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	loyalty_account.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Creación masiva de miembros del equipo

Id. de la operación:: TeamCreateBulkMembers

Crea varios objetos TeamMember.

Parámetros

Nombre	Clave	Tipo	Description
Nombre propio	given_name	string	Nombre dado (es decir, el nombre) asociado al miembro del equipo.
Apellido	family_name	string	Nombre de familia (es decir, el apellido) asociado al miembro del equipo.
Dirección de correo electrónico	email_address	string	Dirección de correo electrónico asociada al miembro del equipo.
Identificador de referencia	reference_id	string	Segundo identificador usado para asociar el miembro del equipo a una entidad en otro sistema.
Número de teléfono	phone_number	string	Número de teléfono del miembro del equipo, en formato E.164.
Identificadores de ubicación	location_ids	array of string
Tipo de asignación	assignment_type	string	Tipo de asignación actual del miembro del equipo.
Nombre propio	given_name	string	Nombre dado (es decir, el nombre) asociado al miembro del equipo.
Apellido	family_name	string	Nombre de familia (es decir, el apellido) asociado al miembro del equipo.
Dirección de correo electrónico	email_address	string	Dirección de correo electrónico asociada al miembro del equipo.
Identificador de referencia	reference_id	string	Segundo identificador usado para asociar el miembro del equipo a una entidad en otro sistema.
Número de teléfono	phone_number	string	Número de teléfono del miembro del equipo, en formato E.164.
Tipo de asignación	assignment_type	string	Tipo de asignación actual del miembro del equipo.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	team_members.idempotency-key-1.team_member.id	string	Identificador para hacer referencia a este objeto.
Identificador de referencia	team_members.idempotency-key-1.team_member.reference_id	string	Segundo identificador usado para asociar el miembro del equipo a una entidad en otro sistema.
Es propietario	team_members.idempotency-key-1.team_member.is_owner	boolean	Si el miembro del equipo es el propietario de la cuenta de Square.
Estado	team_members.idempotency-key-1.team_member.status	string	Describe el estado del miembro del equipo.
Nombre propio	team_members.idempotency-key-1.team_member.given_name	string	Nombre dado (es decir, el nombre) asociado al miembro del equipo.
Apellido	team_members.idempotency-key-1.team_member.family_name	string	Nombre de familia (es decir, el apellido) asociado al miembro del equipo.
Dirección de correo electrónico	team_members.idempotency-key-1.team_member.email_address	string	Dirección de correo electrónico asociada al miembro del equipo.
Número de teléfono	team_members.idempotency-key-1.team_member.phone_number	string	Número de teléfono del miembro del equipo, en formato E.164.
Tipo de asignación	team_members.idempotency-key-1.team_member.assigned_locations.assignment_type	string	Tipo de asignación actual del miembro del equipo.
Identificadores de ubicación	team_members.idempotency-key-1.team_member.assigned_locations.location_ids	array of string
identificación	team_members.idempotency-key-2.team_member.id	string	Identificador para hacer referencia a este objeto.
Identificador de referencia	team_members.idempotency-key-2.team_member.reference_id	string	Segundo identificador usado para asociar el miembro del equipo a una entidad en otro sistema.
Es propietario	team_members.idempotency-key-2.team_member.is_owner	boolean	Si el miembro del equipo es el propietario de la cuenta de Square.
Estado	team_members.idempotency-key-2.team_member.status	string	Describe el estado del miembro del equipo.
Nombre propio	team_members.idempotency-key-2.team_member.given_name	string	Nombre dado (es decir, el nombre) asociado al miembro del equipo.
Apellido	team_members.idempotency-key-2.team_member.family_name	string	Nombre de familia (es decir, el apellido) asociado al miembro del equipo.
Dirección de correo electrónico	team_members.idempotency-key-2.team_member.email_address	string	Dirección de correo electrónico asociada al miembro del equipo.
Número de teléfono	team_members.idempotency-key-2.team_member.phone_number	string	Número de teléfono del miembro del equipo, en formato E.164.
Tipo de asignación	team_members.idempotency-key-2.team_member.assigned_locations.assignment_type	string	Tipo de asignación actual del miembro del equipo.

Crear actividad de tarjetas regalo (Beta)

Id. de la operación:: GiftCardCreate

Crea una actividad de tarjeta de regalo.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Id. de tarjeta de regalo	gift_card_id	string	El identificador de la tarjeta de regalo. El identificador no es necesario si hay un GAN presente.
Tipo	type	string	El tipo de este objeto.
Id. de ubicación	location_id	string	Identificador de la ubicación.
Id. de pedido	order_id	string	Identificador del orden asociado a la actividad.
UID de elemento de línea	line_item_uid	string	El line_item_uid del artículo de línea de tarjeta regalo en un pedido.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	gift_card_activity.id	string	Identificador único emitido por Square.
Id. de tarjeta de regalo	gift_card_activity.gift_card_id	string	El identificador de la tarjeta de regalo. El identificador no es necesario si hay un GAN presente.
GAN de tarjeta de regalo	gift_card_activity.gift_card_gan	string	La tarjeta de regalo GAN. El GAN no es necesario si gift_card_id está presente.
Tipo	gift_card_activity.type	string	El tipo de este objeto.
Importe	gift_card_activity.gift_card_balance_money.amount	integer	Cantidad.
Moneda	gift_card_activity.gift_card_balance_money.currency	string	Moneda.
Id. de ubicación	gift_card_activity.location_id	string	Identificador de la ubicación.
Creado en	gift_card_activity.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Importe	gift_card_activity.activate_activity_details.amount_money.amount	integer	Cantidad.
Moneda	gift_card_activity.activate_activity_details.amount_money.currency	string	Moneda.
Id. de pedido	gift_card_activity.activate_activity_details.order_id	string	Identificador del orden asociado a la actividad.
UID de elemento de línea	gift_card_activity.activate_activity_details.line_item_uid	string	El line_item_uid del artículo de línea de tarjeta regalo en un pedido.

Crear desplazamiento

Id. de la operación:: LaborCreateShift

Crea un nuevo Mayús. Un turno representa un día laboral completo para un único empleado

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Id. de miembro del equipo	team_member_id	string	Identificador del miembro del equipo.
Id. de ubicación	location_id	string	Identificador de la ubicación.
Comenzar a	start_at	string	Marca de tiempo que especifica la hora de inicio de este objeto, en formato RFC 3339.
Finalizar al	end_at	string	RFC 3339; desplazado a la zona horaria + desplazamiento. Se respeta la precisión hasta el minuto; segundos se truncan.
Title	title	string	Nombre del trabajo realizado durante este turno. Las UIs de informes de mano de obra cuadrada pueden agrupar turnos por título.
Importe	amount	integer	Cantidad.
Moneda	currency	string	Moneda.
Comenzar a	start_at	string	RFC 3339; sigue la misma información de zona horaria que Mayús. Se respeta la precisión hasta el minuto; segundos se truncan.
Finalizar al	end_at	string	RFC 3339; sigue la misma información de zona horaria que Mayús. Se respeta la precisión hasta el minuto; segundos se truncan.
Id. de tipo de interrupción	break_type_id	string	BreakType en el que se creó la plantilla BreakType.
Nombre	name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Duración esperada	expected_duration	string	Longitud esperada de la interrupción. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
Se paga	is_paid	boolean	Si esta interrupción cuenta para el tiempo trabajado con fines de compensación.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	shift.id	string	Identificador único emitido por Square.
Id. de miembro del equipo	shift.team_member_id	string	Identificador del miembro del equipo.
Id. de empleado	shift.employee_id	string	Identificador generado por cuadrados del empleado.
Id. de ubicación	shift.location_id	string	Identificador de la ubicación.
Timezone	shift.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Comenzar a	shift.start_at	string	Marca de tiempo que especifica la hora de inicio de este objeto, en formato RFC 3339.
Finalizar al	shift.end_at	string	RFC 3339; desplazado a la zona horaria + desplazamiento. Se respeta la precisión hasta el minuto; segundos se truncan.
Title	shift.wage.title	string	Nombre del trabajo realizado durante este turno. Las UIs de informes de mano de obra cuadrada pueden agrupar turnos por título.
Importe	shift.wage.hourly_rate.amount	integer	Cantidad.
Moneda	shift.wage.hourly_rate.currency	string	Moneda.
Interrupciones	shift.breaks	array of object
identificación	shift.breaks.id	string	Identificador del objeto
Comenzar a	shift.breaks.start_at	string	RFC 3339; sigue la misma información de zona horaria que Mayús. Se respeta la precisión hasta el minuto; segundos se truncan.
Finalizar al	shift.breaks.end_at	string	RFC 3339; sigue la misma información de zona horaria que Mayús. Se respeta la precisión hasta el minuto; segundos se truncan.
Id. de tipo de interrupción	shift.breaks.break_type_id	string	BreakType en el que se creó la plantilla BreakType.
Nombre	shift.breaks.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Duración esperada	shift.breaks.expected_duration	string	Longitud esperada de la interrupción. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
Se paga	shift.breaks.is_paid	boolean	Si esta interrupción cuenta para el tiempo trabajado con fines de compensación.
Estado	shift.status	string	Estado de comprobación actual de este objeto.
Versión	shift.version	integer	La versión actual de este objeto.
Creado en	shift.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	shift.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Crear desprotección

Id. de la operación:: CheckoutCreate

Vincula un valor de checkoutId a un checkout_page_url al que se dirige a los clientes para proporcionar su información de pago mediante un flujo de trabajo de procesamiento de pagos.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de ubicación	location_id	True	string	Identificador de la ubicación.
Clave de iempoencia	idempotency_key		string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Dirección URL de redireccionamiento	redirect_url		string	Por ejemplo, si la dirección URL de redireccionamiento proporcionada es `http://www.example.com/order-complete`, una transacción correcta redirige al cliente a: `http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` Si no proporciona una dirección URL de redireccionamiento, Square Checkout muestra una página de confirmación del pedido en su nombre; sin embargo, se recomienda encarecidamente proporcionar una dirección URL de redireccionamiento para que pueda comprobar los resultados de la transacción y finalizar el pedido a través del flujo de trabajo de confirmación existente o normal.
Clave de iempoencia	idempotency_key		string	Valor que especifique que identifica de forma única este orden entre los pedidos que ha creado. Si no está seguro de si un pedido determinado se creó correctamente, puede intentarlo de nuevo con la misma clave de idempoencia sin preocuparse por crear pedidos duplicados.
Id. de ubicación	location_id		string	Expresión de consulta para buscar disponibilidades que coincidan con los identificadores de ubicación del vendedor especificados.
Id. de cliente	customer_id		string	Identificador del cliente asociado al pedido.
Identificador de referencia	reference_id		string	Identificador especificado por el cliente para asociar una entidad en otro sistema con este orden.
Nombre	name		string	El nombre del elemento.
Cantidad	quantity		string	Cantidad comprada, con formato de número decimal. Los artículos de línea con una cantidad de 0 se quitan automáticamente al pagar o completar el pedido de otro modo.
Importe	amount		integer	Cantidad.
Moneda	currency		string	Moneda.
UID de descuento	discount_uid		string	UID del descuento que representa el descuento aplicado. Debe hacer referencia a un descuento presente en el campo order.discounts. Este campo es inmutable. Para cambiar los descuentos que se aplican a un elemento de línea, debe eliminar el descuento y volver a agregarlo como un nuevo OrderLineItemAppliedDiscount.
UID fiscal	tax_uid		string	El UID del impuesto para el que representa este impuesto aplicado. Debe hacer referencia a un impuesto presente en el campo order.tax. Este campo es inmutable. Para cambiar los impuestos que se aplican a un elemento de línea, elimine y agregue un nuevo OrderLineItemAppliedTax.
UID	uid		string	Un identificador único.
Tipo	type		string	El tipo de este objeto.
Porcentaje	percentage		string	Porcentaje del impuesto, como una representación de cadena de un número decimal.
Ámbito	scope		string	Indica el nivel en el que se aplica el objeto.
UID	uid		string	Un identificador único.
Tipo	type		string	El tipo de este objeto.
Ámbito	scope		string	Indica el nivel en el que se aplica el objeto.
Importe	amount		integer	Cantidad.
Moneda	currency		string	Moneda.
Id. de ubicación	location_id		string	Identificador de la ubicación.
Description	title		string	Descripción.
Importe	amount		integer	Cantidad.
Moneda	currency		string	Moneda.
Solicitar dirección de envío	ask_for_shipping_address		boolean	Si es true, Square Checkout recopila información de envío en su nombre y almacena esa información con la información de transacción en el Panel de vendedores cuadrados.
Correo electrónico de soporte técnico para comerciantes	merchant_support_email		string	La dirección de correo electrónico que se va a mostrar en la página de confirmación de Square Checkout y el correo electrónico de confirmación que el comprador puede usar para ponerse en contacto con el vendedor. Si no se establece este valor, la página de confirmación y el correo electrónico muestran la dirección de correo electrónico principal asociada a la cuenta de Square del vendedor.
Rellenar previamente el correo electrónico del comprador	pre_populate_buyer_email		string	Si se proporciona, el correo electrónico del comprador se rellena previamente en la página de desprotección como un campo de texto editable.
Línea de dirección 1	address_line_1		string	Primera línea de la dirección.
Línea de dirección 2	address_line_2		string	Segunda línea de la dirección, si existe.
Localidad	locality		string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	administrative_district_level_1		string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	postal_code		string	El código postal de la dirección.
País	country		string	Código de país ISO 3166 Alpha-2.
Nombre	first_name		string	Nombre opcional cuando representa al destinatario.
Apellido	last_name		string	Apellidos opcionales cuando representa al destinatario.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	checkout.id	string	Identificador único emitido por Square.
Dirección URL de la página Desprotección	checkout.checkout_page_url	string	La dirección URL a la que se debe redirigir el explorador del comprador una vez completada la finalización de la compra.
Solicitar dirección de envío	checkout.ask_for_shipping_address	boolean	Si es true, Square Checkout recopilará información de envío en su nombre y almacenará esa información con la información de transacción en el Panel cuadrado.
Correo electrónico de soporte técnico para comerciantes	checkout.merchant_support_email	string	La dirección de correo electrónico que se va a mostrar en la página de confirmación de Square Checkout y el correo electrónico de confirmación que el comprador puede usar para ponerse en contacto con el comerciante.
Rellenar previamente el correo electrónico del comprador	checkout.pre_populate_buyer_email	string	Si se proporciona, el correo electrónico del comprador se rellena previamente en la página de finalización de la compra como un campo de texto editable.
Línea de dirección 1	checkout.pre_populate_shipping_address.address_line_1	string	Primera línea de la dirección. Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Línea de dirección 2	checkout.pre_populate_shipping_address.address_line_2	string	Segunda línea de la dirección, si existe.
Localidad	checkout.pre_populate_shipping_address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	checkout.pre_populate_shipping_address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	checkout.pre_populate_shipping_address.postal_code	string	El código postal de la dirección.
País	checkout.pre_populate_shipping_address.country	string	País de la dirección, en formato ISO 3166-1-alpha-2.
Nombre	checkout.pre_populate_shipping_address.first_name	string	Nombre opcional cuando representa al destinatario.
Apellido	checkout.pre_populate_shipping_address.last_name	string	Nombre lsat opcional cuando representa al destinatario.
Dirección URL de redireccionamiento	checkout.redirect_url	string	La dirección URL a la que se redirigirá una vez completada la finalización de la compra con checkoutId, orderId de Square, transactionId y referenceId anexados como parámetros de dirección URL. Por ejemplo, si el redirect_url proporcionado es `http://www.example.com/order-complete`, una transacción correcta redirige al cliente a: `http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` Si no proporciona una dirección URL de redireccionamiento, Square Checkout mostrará una página de confirmación del pedido en su nombre; sin embargo, Square recomienda encarecidamente que proporcione una dirección URL de redireccionamiento para que pueda comprobar los resultados de la transacción y finalizar el pedido a través del flujo de trabajo de confirmación existente o normal.
Id. de ubicación	checkout.order.location_id	string	Expresión de consulta para buscar disponibilidades que coincidan con los identificadores de ubicación del vendedor especificados.
Id. de cliente	checkout.order.customer_id	string	Identificador del cliente asociado al pedido.
Identificador de referencia	checkout.order.reference_id	string	Identificador especificado por el cliente para asociar una entidad en otro sistema con este orden.
Elementos de línea	checkout.order.line_items	array of object
Nombre	checkout.order.line_items.name	string	Nombre del elemento de línea.
Cantidad	checkout.order.line_items.quantity	string	Cantidad comprada, con formato de número decimal. Los artículos de línea con una cantidad de 0 se quitan automáticamente al pagar o completar el pedido de otro modo.
Impuestos aplicados	checkout.order.line_items.applied_taxes	array of object
UID fiscal	checkout.order.line_items.applied_taxes.tax_uid	string	El UID del impuesto para el que representa este impuesto aplicado. Debe hacer referencia a un impuesto presente en el campo order.tax. Este campo es inmutable. Para cambiar los impuestos que se aplican a un elemento de línea, elimine y agregue un nuevo OrderLineItemAppliedTax.
Importe	checkout.order.line_items.applied_taxes.applied_money.amount	integer	Cantidad de dinero, en la denominación más pequeña de la moneda indicada por moneda. Por ejemplo, cuando la moneda es USD, la cantidad está en centavos. Las cantidades monetarias pueden ser positivas o negativas. Vea la descripción de campo específica para determinar el significado del inicio de sesión en un caso determinado.
Moneda	checkout.order.line_items.applied_taxes.applied_money.currency	string	Tipo de moneda, en formato ISO 4217. Por ejemplo, el código de moneda para dólares estadounidenses es USD.
Descuentos aplicados	checkout.order.line_items.applied_discounts	array of object
UID de descuento	checkout.order.line_items.applied_discounts.discount_uid	string	UID del descuento que representa el descuento aplicado. Debe hacer referencia a un descuento presente en el campo order.discounts. Este campo es inmutable. Para cambiar los descuentos que se aplican a un elemento de línea, debe eliminar el descuento y volver a agregarlo como un nuevo OrderLineItemAppliedDiscount.
Importe	checkout.order.line_items.applied_discounts.applied_money.amount	integer	Cantidad de dinero, en la denominación más pequeña de la moneda indicada por moneda. Por ejemplo, cuando la moneda es USD, la cantidad está en centavos. Las cantidades monetarias pueden ser positivas o negativas. Vea la descripción de campo específica para determinar el significado del inicio de sesión en un caso determinado.
Moneda	checkout.order.line_items.applied_discounts.applied_money.currency	string	Tipo de moneda, en formato ISO 4217. Por ejemplo, el código de moneda para dólares estadounidenses es USD.
Importe	checkout.order.line_items.base_price_money.amount	integer	Cantidad.
Moneda	checkout.order.line_items.base_price_money.currency	string	Moneda.
Importe	checkout.order.line_items.total_tax_money.amount	integer	Cantidad.
Moneda	checkout.order.line_items.total_tax_money.currency	string	Moneda.
Importe	checkout.order.line_items.total_discount_money.amount	integer	Cantidad.
Moneda	checkout.order.line_items.total_discount_money.currency	string	Moneda.
Importe	checkout.order.line_items.total_money.amount	integer	Cantidad.
Moneda	checkout.order.line_items.total_money.currency	string	Moneda.
Impuestos	checkout.order.taxes	array of object
UID	checkout.order.taxes.uid	string	Un identificador único.
Tipo	checkout.order.taxes.type	string	El tipo de este objeto.
Porcentaje	checkout.order.taxes.percentage	string	Porcentaje del impuesto, como una representación de cadena de un número decimal.
Ámbito	checkout.order.taxes.scope	string	Indica el nivel en el que se aplica el objeto.
Descuentos	checkout.order.discounts	array of object
UID	checkout.order.discounts.uid	string	Un identificador único.
Tipo	checkout.order.discounts.type	string	El tipo de este objeto.
Ámbito	checkout.order.discounts.scope	string	Indica el nivel en el que se aplica el objeto.
Importe	checkout.order.discounts.amount_money.amount	integer	Cantidad.
Moneda	checkout.order.discounts.amount_money.currency	string	Moneda.
Importe	checkout.order.discounts.applied_money.amount	integer	Cantidad.
Moneda	checkout.order.discounts.applied_money.currency	string	Moneda.
Importe	checkout.order.total_money.amount	integer	Cantidad.
Moneda	checkout.order.total_money.currency	string	Moneda.
Importe	checkout.order.total_tax_money.amount	integer	Cantidad.
Moneda	checkout.order.total_tax_money.currency	string	Moneda.
Importe	checkout.order.total_discount_money.amount	integer	Cantidad.
Moneda	checkout.order.total_discount_money.currency	string	Moneda.
Creado en	checkout.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Versión	checkout.version	integer	La versión actual de este objeto.
Destinatarios adicionales	checkout.additional_recipients	array of object
Id. de ubicación	checkout.additional_recipients.location_id	string	Identificador de ubicación de un destinatario (distinto del comerciante) que recibe una parte de esta licitación.
Description	checkout.additional_recipients.title	string	Descripción del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables y su longitud de valor es de puntos de código Unicode.
Importe	checkout.additional_recipients.amount_money.amount	integer	Cantidad.
Moneda	checkout.additional_recipients.amount_money.currency	string	Moneda.

Crear recompensa de fidelidad

Id. de la operación:: LoyaltyCreateReward

Crea una recompensa de lealtad. Después de crear una recompensa, los puntos están bloqueados y no están disponibles para que el comprador canjee otra recompensa.

Parámetros

Nombre	Clave	Tipo	Description
Id. de cuenta de fidelidad	loyalty_account_id	string	Identificador de la cuenta de fidelidad en la que se produjo el evento.
Id. de nivel de recompensa	reward_tier_id	string	El identificador asignado a Cuadrado del nivel de recompensa usado para crear la recompensa.
Id. de pedido	order_id	string	Identificador del pedido.
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	reward.id	string	Identificador único emitido por Square.
Estado	reward.status	string	Estado de comprobación actual de este objeto.
Id. de cuenta de fidelidad	reward.loyalty_account_id	string	Identificador de la cuenta de fidelidad en la que se produjo el evento.
Id. de nivel de recompensa	reward.reward_tier_id	string	El identificador asignado a Cuadrado del nivel de recompensa usado para crear la recompensa.
Puntos	reward.points	integer	Número de puntos agregados o eliminados.
Id. de pedido	reward.order_id	string	Identificador del pedido.
Creado en	reward.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	reward.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Crear tipo de interrupción

Id. de la operación:: LaborCreateBreak

Crea un nuevo BreakType. BreakType es una plantilla para crear objetos Break.

Parámetros

Nombre	Clave	Tipo	Description
Clave de iempoencia	idempotency_key	string	Valor que especifica que identifica de forma única esta solicitud entre todas las solicitudes. Una manera común de crear una clave de idempoencia válida es usar un identificador único universal (UUID).
Id. de ubicación	location_id	string	Identificador de la ubicación.
Nombre de interrupción	break_name	string	Nombre legible para este tipo de interrupción. El nombre se muestra a los empleados de productos square.
Duración esperada	expected_duration	string	Longitud esperada de este salto. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. La precisión menor que los minutos se trunca.
Se paga	is_paid	boolean	Si esta interrupción cuenta para el tiempo trabajado con fines de compensación.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	break_type.id	string	Identificador único emitido por Square.
Id. de ubicación	break_type.location_id	string	Identificador de la ubicación.
Nombre de interrupción	break_type.break_name	string	Nombre legible para este tipo de interrupción. El nombre se muestra a los empleados de productos square.
Duración esperada	break_type.expected_duration	string	Longitud esperada de este salto. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. La precisión menor que los minutos se trunca.
Se paga	break_type.is_paid	boolean	Si esta interrupción cuenta para el tiempo trabajado con fines de compensación.
Versión	break_type.version	integer	La versión actual de este objeto.
Creado en	break_type.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	break_type.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Crear ubicación (Beta)

Id. de la operación:: LocationCreate

Crea una ubicación.

Parámetros

Nombre	Clave	Tipo	Description
Nombre	name	string	Nombre del objeto.
Description	description	string	Descripción.
Facebook URL	facebook_url	string	Dirección URL del perfil de Facebook de la ubicación. La dirección URL debe comenzar por "facebook.com/".
Línea de dirección 1	address_line_1	string	Primera línea de la dirección. Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Nivel 1 del distrito administrativo	administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Localidad	locality	string	La ciudad o la ciudad de la dirección.
Código postal	postal_code	string	El código postal de la dirección.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	location.id	string	Identificador único emitido por Square.
Nombre	location.name	string	Nombre del objeto.
Línea de dirección 1	location.address.address_line_1	string	Primera línea de la dirección. Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Localidad	location.address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	location.address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	location.address.postal_code	string	El código postal de la dirección.
Capabilities	location.capabilities	array of string
Estado	location.status	string	Estado de comprobación actual de este objeto.
Creado en	location.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Id. de comerciante	location.merchant_id	string	Identificador del comerciante.
País	location.country	string	Código de país ISO 3166 Alpha-2.
Código de lenguaje	location.language_code	string	El código de idioma, en formato BCP 47.
Moneda	location.currency	string	Código de moneda ISO 4217 de 3 caracteres.
Tipo	location.type	string	El tipo de este objeto.
Description	location.description	string	Descripción.
URL del sitio web	location.website_url	string	Dirección URL del sitio web de la ubicación.
Nombre de usuario de Twitter	location.twitter_username	string	Nombre de usuario de Twitter de la ubicación sin el símbolo '@'.
Nombre de usuario de Instagram	location.instagram_username	string	Nombre de usuario de Instagram de la ubicación sin el símbolo '@'.
Latitude	location.coordinates.latitude	float	Latitud de la coordenada expresada en grados.
Longitude	location.coordinates.longitude	float	Longitud de la coordenada expresada en grados.
MCC	location.mcc	string	El código de categoría de comerciante (MCC) de la ubicación, tal como lo normaliza iso 18245. El MCC describe el tipo de bienes o servicios vendidos en la ubicación.

Cálculo de puntos de fidelidad

Id. de la operación:: LoyaltyCalculatePoints

Calcula los puntos que obtiene una compra. Una aplicación podría llamar a este punto de conexión para mostrar los puntos que un comprador puede ganar con la compra específica.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de programa	program_id	True	string	Identificador del programa.
Id. de pedido	order_id		string	Identificador de pedido.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Puntos	points	integer	Los puntos que el comprador puede obtener de una compra especificada.

Desvincular al cliente de la tarjeta de regalo (Beta)

Id. de la operación:: GiftCardUnlink

Desvincula a un cliente de una tarjeta de regalo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de tarjeta de regalo	gift_card_id	True	string	Identificador de la tarjeta de regalo.
Id. de cliente	customer_id		string	Identificador del cliente que se va a vincular.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	gift_card.id	string	Identificador único emitido por Square.
Tipo	gift_card.type	string	El tipo de este objeto.
Origen de GAN	gift_card.gan_source	string	Indica si square genera o importa el número de cuenta de la tarjeta de regalo (GAN) desde un sistema que no es cuadrado.
Estado	gift_card.state	string	Estado actual.
Importe	gift_card.balance_money.amount	integer	Cantidad.
Moneda	gift_card.balance_money.currency	string	Moneda.
Gan	gift_card.gan	string	Número de cuenta de tarjeta de regalo.
Creado en	gift_card.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.

Disponibilidad de búsqueda (beta)

Id. de la operación:: BookingAvailability

Busca disponibilidades para la reserva.

Parámetros

Nombre	Clave	Tipo	Description
Comenzar a	start_at	string	Valor datetime en formato RFC 3339 que indica cuándo se inicia el intervalo de tiempo.
Finalizar al	end_at	string	Valor datetime en formato RFC 3339 que indica cuándo finaliza el intervalo de tiempo.
Id. de ubicación	location_id	string	Expresión de consulta para buscar disponibilidades que coincidan con los identificadores de ubicación del vendedor especificados.
Id. de variación de servicio	service_variation_id	string	Identificador de CatalogItemVariation que representa el servicio reservado en este segmento.
Cualquiera	any	array of string

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Disponibilidades	availabilities	array of object
Comenzar a	availabilities.start_at	string	Marca de tiempo RFC 3339 que especifica la hora inicial de la ranura disponible.
Id. de ubicación	availabilities.location_id	string	Identificador de la ubicación.
Segmentos de cita	availabilities.appointment_segments	array of object
Minutos de duración	availabilities.appointment_segments.duration_minutes	integer	Intervalo de tiempo en minutos de un segmento de cita.
Id. de miembro del equipo	availabilities.appointment_segments.team_member_id	string	Identificador del objeto TeamMember que representa al miembro del equipo reservado en este segmento.
Id. de variación de servicio	availabilities.appointment_segments.service_variation_id	string	Identificador del objeto CatalogItemVariation que representa el servicio reservado en este segmento.
Versión de variación del servicio	availabilities.appointment_segments.service_variation_version	integer	Versión actual de la variación de elemento que representa el servicio reservado en este segmento.
Errors	errors	array of

Eliminar desplazamiento

Id. de la operación:: LaborDeleteShift

Elimina un turno.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.

Devoluciones

response: object

Eliminar fragmento de código

Id. de la operación:: SnippetDelete

Quita el fragmento de código de un sitio de Square Online.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sitio de	site_id	True	string	Identificador del sitio.

Devoluciones

response: object

Eliminar recompensa de fidelidad

Id. de la operación:: LoyaltyDeleteReward

Elimina una recompensa de fidelidad. Devuelve los puntos de fidelidad a la cuenta de fidelidad. No se puede eliminar una recompensa que haya alcanzado el estado terminal (REDEEMED).

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de recompensa	reward_id	True	string	Identificador de la recompensa.

Devoluciones

response: object

Eliminar tipo de interrupción

Id. de la operación:: LaborDeleteBreak

Elimina un BreakType existente. Se puede eliminar un BreakType incluso si se hace referencia a él desde un Shift.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.

Devoluciones

response: object

Enumerar actividades de tarjetas de regalo (Beta)

Id. de la operación:: GiftCardList

Enumera las actividades de tarjetas de regalo. De forma predeterminada, obtendrás actividades de tarjetas de regalo para todas las tarjetas de regalo de la cuenta del vendedor. Opcionalmente, puede especificar parámetros de consulta para filtrar la lista. Por ejemplo, puede obtener una lista de actividades de tarjetas de regalo para una tarjeta de regalo, para todas las tarjetas de regalo de una región específica o para actividades dentro de un período de tiempo.

Parámetros

Nombre	Clave	Tipo	Description
Id. de tarjeta de regalo	gift_card_id	string	Si proporciona un identificador de tarjeta de regalo, el punto de conexión devuelve actividades que pertenecen a la tarjeta de regalo especificada. De lo contrario, el punto de conexión devuelve todas las actividades de tarjetas de regalo para el vendedor.
Tipo	type	string	Si proporciona un tipo, el punto de conexión devuelve actividades de tarjetas de regalo de este tipo. De lo contrario, el punto de conexión devuelve todos los tipos de actividades de tarjetas de regalo.
Id. de ubicación	location_id	string	Puede especificar este filtro opcional para recuperar solo los registros que pertenecen a una ubicación específica.
Hora de inicio	begin_time	string	Hora de inicio inclusiva de la consulta en opened_at, en formato ISO 8601.
Hora de finalización	end_time	string	Fecha de finalización exclusiva de la consulta en opened_at, en formato ISO 8601.
Limit	limit	integer	Límite superior del número que se va a devolver en la respuesta.
Cursor	cursor	string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.
Criterio de ordenación	sort_order	string	Ordena la lista devuelta por cuando se creó la tarjeta con el pedido especificado.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Actividades de tarjetas de regalo	gift_card_activities	array of object
identificación	gift_card_activities.id	string	Identificador único emitido por Square.
Tipo	gift_card_activities.type	string	El tipo de este objeto.
Id. de ubicación	gift_card_activities.location_id	string	Identificador de la ubicación.
Creado en	gift_card_activities.created_at	string	Hora del evento en formato ISO 8601.
Id. de tarjeta de regalo	gift_card_activities.gift_card_id	string	El identificador de la tarjeta de regalo. El identificador no es necesario si hay un GAN presente.
GAN de tarjeta de regalo	gift_card_activities.gift_card_gan	string	La tarjeta de regalo GAN. El GAN no es necesario si gift_card_id está presente.
Importe	gift_card_activities.gift_card_balance_money.amount	integer	Cantidad.
Moneda	gift_card_activities.gift_card_balance_money.currency	string	Moneda.
Importe	gift_card_activities.redeem_activity_details.amount_money.amount	integer	Cantidad.
Moneda	gift_card_activities.redeem_activity_details.amount_money.currency	string	Moneda.
Importe	gift_card_activities.activate_activity_details.amount_money.amount	integer	Cantidad.
Moneda	gift_card_activities.activate_activity_details.amount_money.currency	string	Moneda.
Id. de pedido	gift_card_activities.activate_activity_details.order_id	string	Identificador del orden asociado a la actividad.
UID de elemento de línea	gift_card_activities.activate_activity_details.line_item_uid	string	El line_item_uid del artículo de línea de tarjeta regalo en un pedido.

Enumerar comerciantes

Id. de la operación:: MerchantList

Devuelve información de comerciante para un token de acceso determinado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Cursor	cursor		integer	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Comerciante	merchant	array of object
identificación	merchant.id	string	Identificador único emitido por Square.
Nombre de la empresa	merchant.business_name	string	Nombre comercial de la ubicación Este es el nombre visible para los clientes de la ubicación. Por ejemplo, este nombre aparece en los recibos del cliente.
País	merchant.country	string	Código de país ISO 3166 Alpha-2.
Código de lenguaje	merchant.language_code	string	Idioma asociado a la ubicación, en formato BCP 47.
Moneda	merchant.currency	string	Código de moneda ISO 4217 de 3 caracteres.
Estado	merchant.status	string	Estado de comprobación actual de este objeto.
Id. de ubicación principal	merchant.main_location_id	string	Identificador de la ubicación principal de este comerciante.

Enumerar configuraciones de semana laboral

Id. de la operación:: LaborListConfigs

Devuelve una lista de instancias de WorkweekConfig para una empresa.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Limit	limit		integer	Límite superior del número que se va a devolver en la respuesta.
Cursor	cursor		string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Configuraciones de workweek	workweek_configs	array of object
identificación	workweek_configs.id	string	Identificador único emitido por Square.
Comienzo de la semana	workweek_configs.start_of_week	string	El día de la semana en el que finaliza una semana comercial con fines de compensación.
Hora local de inicio del día	workweek_configs.start_of_day_local_time	string	Hora local en la que finaliza una semana comercial. Se representa como una cadena en formato HH:MM (también se acepta HH:MM:SS, pero los segundos se truncan).
Versión	workweek_configs.version	integer	Versión actual del objeto.
Creado en	workweek_configs.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	workweek_configs.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Cursor	cursor	string	Incluya el cursor de paginación en llamadas posteriores a este punto de conexión para recuperar el siguiente conjunto de resultados asociado a la consulta original.

Enumerar cuentas bancarias

Id. de la operación:: BankAccountList

Devuelve una lista de objetos BankAccount vinculados a una cuenta square.

Parámetros

Nombre	Clave	Tipo	Description
Cursor	cursor	string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.
Limit	limit	integer	Límite superior del número que se va a devolver en la respuesta.
Id. de ubicación	location_id	string	Puede especificar este filtro opcional para recuperar solo los registros que pertenecen a una ubicación específica.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Cuenta bancaria	bank_accounts	array of object
identificación	bank_accounts.id	string	Identificador único emitido por Square.
Sufijo de número de cuenta	bank_accounts.account_number_suffix	string	Los últimos dígitos del número de cuenta.
País	bank_accounts.country	string	Código de país ISO 3166 Alpha-2.
Moneda	bank_accounts.currency	string	Código de moneda ISO 4217 de 3 caracteres.
Tipo de cuenta	bank_accounts.account_type	string	El propósito financiero de la cuenta bancaria asociada.
Nombre del titular	bank_accounts.holder_name	string	Nombre del titular de la cuenta. Este nombre debe coincidir con el nombre en el registro de cuenta bancaria de destino.
Número de identificación del banco principal	bank_accounts.primary_bank_identification_number	string	Identificador principal del banco.
Id. de ubicación	bank_accounts.location_id	string	Identificador de la ubicación.
Estado	bank_accounts.status	string	Estado de comprobación actual de este objeto.
Loable	bank_accounts.creditable	boolean	Indica si es posible que Square envíe dinero a esta cuenta bancaria.
Débito	bank_accounts.debitable	boolean	Indica si es posible que Square envíe dinero a esta cuenta bancaria.
Versión	bank_accounts.version	integer	Versión actual del objeto.
Nombre del banco	bank_accounts.bank_name	string	Nombre de la institución financiera real.

Enumerar códigos de dispositivo

Id. de la operación:: DeviceList

Enumera todos los DeviceCodes asociados al comerciante.

Parámetros

Nombre	Clave	Tipo	Description
Cursor	cursor	string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.
Id. de ubicación	location_id	string	Puede especificar este filtro opcional para recuperar solo los registros que pertenecen a una ubicación específica.
Tipo de producto	product_type	string	Si se especifica, solo devuelve DeviceCodes que tienen como destino el tipo de producto especificado. Devuelve DeviceCodes de todos los tipos de producto si están vacíos.
Estado	status	string	Si se especifica, solo devuelve objetos que coinciden con los estados especificados.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Códigos de dispositivo	device_codes	array of object
identificación	device_codes.id	string	Identificador único emitido por Square.
Nombre	device_codes.name	string	Nombre del objeto.
Código	device_codes.code	string	Código único que se puede usar para iniciar sesión.
Tipo de producto	device_codes.product_type	string	Tipo de producto de destino del código de dispositivo.
Id. de ubicación	device_codes.location_id	string	Identificador de la ubicación.
Creado en	device_codes.created_at	string	Hora del evento en formato ISO 8601.
Emparejar por	device_codes.pair_by	string	Cuando este DeviceCode expire y ya no inicie sesión. Marca de tiempo en formato RFC 3339.
Estado	device_codes.status	string	Estado de comprobación actual de este objeto.
Id. de dispositivo	device_codes.device_id	string	Identificador único del dispositivo que usó este código. Rellenado cuando el dispositivo está emparejado.
Estado cambiado en	device_codes.status_changed_at	string	Cuando el estado de DeviceCode se cambió por última vez. Marca de tiempo en formato RFC 3339.

Enumerar eventos de desplazamiento de cajón de efectivo

Id. de la operación:: CashDrawerListEvents

Proporciona una lista paginada de eventos para un único cambio de cajón de efectivo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de mayús	shift_id	True	string	Identificador del turno.
Id. de ubicación	location_id	True	string	Puede especificar este filtro opcional para recuperar solo los registros que pertenecen a una ubicación específica.
Limit	limit		integer	Límite superior del número que se va a devolver en la respuesta.
Cursor	cursor		string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Eventos	events	array of object
identificación	events.id	string	Identificador único emitido por Square.
Tipo de evento	events.event_type	string	Tipo de evento de desplazamiento del cajón de efectivo.
Importe	events.event_money.amount	integer	Cantidad.
Moneda	events.event_money.currency	string	Moneda.
Creado en	events.created_at	string	Hora del evento en formato ISO 8601.
Description	events.title	string	Descripción.

Enumerar los salarios de los miembros del equipo

Id. de la operación:: LaborListWages

Devuelve una lista paginada de instancias de TeamMemberWage para una empresa.

Parámetros

Nombre	Clave	Tipo	Description
Id. de miembro del equipo	team_member_id	string	Filtre los salarios devueltos solo a los asociados al miembro del equipo especificado.
Limit	limit	integer	Límite superior del número que se va a devolver en la respuesta.
Cursor	cursor	string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Salarios de los miembros del equipo	team_member_wages	array of object
identificación	team_member_wages.id	string	Identificador único emitido por Square.
Id. de miembro del equipo	team_member_wages.team_member_id	string	Identificador del objeto TeamMember del miembro del equipo asociado al objeto .
Title	team_member_wages.title	string	Título de la factura.
Importe	team_member_wages.hourly_rate.amount	integer	Cantidad.
Moneda	team_member_wages.hourly_rate.currency	string	Moneda.
Cursor	cursor	string	Incluya el cursor de paginación en llamadas posteriores a este punto de conexión para recuperar el siguiente conjunto de resultados asociado a la consulta original.

Enumerar perfiles de reserva de miembros del equipo (Beta)

Id. de la operación:: BookingListTeamProfiles

Enumera los perfiles de reserva para los miembros del equipo.

Parámetros

Nombre	Clave	Tipo	Description
Solo reservable	bookable_only	boolean	Indica si se deben incluir solo los miembros del equipo que se pueden reservar en el resultado devuelto (true) o no (false).
Limit	limit	integer	Límite superior del número que se va a devolver en la respuesta.
Cursor	cursor	string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.
Id. de ubicación	location_id	string	Puede especificar este filtro opcional para recuperar solo los registros que pertenecen a una ubicación específica.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Perfiles de reserva de miembros del equipo	team_member_booking_profiles	array of object
Id. de miembro del equipo	team_member_booking_profiles.team_member_id	string	Identificador del objeto TeamMember del miembro del equipo asociado al objeto .
Nombre de pantalla	team_member_booking_profiles.display_name	string	Nombre para mostrar del miembro del equipo.
Es reservable	team_member_booking_profiles.is_bookable	boolean	Indica si el miembro del equipo se puede reservar a través de la API de Bookings o el canal de reserva en línea del vendedor o el sitio (true) o no (false' ).
Errors	errors	array of

Enumerar sitios

Id. de la operación:: SiteList

Enumera los sitios de Square Online que pertenecen a un vendedor.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Sites	sites	array of object
identificación	sites.id	string	Identificador único emitido por Square.
Título del sitio	sites.site_title	string	Título del sitio.
Dominio	sites.domain	string	Dominio del sitio (sin el protocolo).
Se publica	sites.is_published	boolean	Indica si el sitio está publicado.
Creado en	sites.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	sites.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339

Enumerar ubicaciones

Id. de la operación:: LocationList

Proporciona información de todas las ubicaciones de una empresa.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Ubicaciones	locations	array of object
identificación	locations.id	string	Identificador único emitido por Square.
Nombre	locations.name	string	Nombre del objeto.
Línea de dirección 1	locations.address.address_line_1	string	Primera línea de la dirección.
Localidad	locations.address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	locations.address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	locations.address.postal_code	string	El código postal de la dirección.
País	locations.address.country	string	País de la dirección, en formato ISO 3166-1-alpha-2.
Timezone	locations.timezone	string	Zona horaria usada para interpretar las fechas del calendario en la factura, como due_date. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Capabilities	locations.capabilities	array of string
Estado	locations.status	string	Estado de comprobación actual de este objeto.
Creado en	locations.created_at	string	Hora del evento en formato ISO 8601.
Id. de comerciante	locations.merchant_id	string	Identificador del comerciante que posee la ubicación.
País	locations.country	string	Código de país ISO 3166 Alpha-2.
Código de lenguaje	locations.language_code	string	Idioma asociado a la ubicación, en formato BCP 47.
Moneda	locations.currency	string	Código de moneda ISO 4217 de 3 caracteres.
Número de teléfono	locations.phone_number	string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Nombre de la empresa	locations.business_name	string	Nombre comercial de la ubicación Este es el nombre visible para los clientes de la ubicación. Por ejemplo, este nombre aparece en los recibos del cliente.

Fragmento de código upsert

Id. de la operación:: SnippetUpsert

Agrega un fragmento de código a un sitio de Square Online o actualiza el fragmento de código existente en el sitio. El código de fragmento de código se anexa al final del elemento head en todas las páginas del sitio, excepto las páginas de desprotección. Una aplicación de fragmento de código puede agregar un fragmento de código a un sitio determinado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sitio de	site_id	True	string	Identificador del sitio.
Content	content		string	El código de fragmento de código, que puede contener HTML, JavaScript o ambos válidos.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	snippet.id	string	Identificador único emitido por Square.
Id. de sitio de	snippet.site_id	string	Identificador del sitio que contiene el fragmento de código.
Content	snippet.content	string	El código de fragmento de código, que puede contener HTML, JavaScript o ambos válidos.
Creado en	snippet.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	snippet.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Miembros del equipo de actualización masiva

Id. de la operación:: TeamUpdateBulkMembers

Actualiza varios objetos TeamMember.

Parámetros

Nombre	Clave	Tipo	Description
Identificador de referencia	reference_id	string	Segundo identificador usado para asociar el miembro del equipo a una entidad en otro sistema.
Es propietario	is_owner	boolean	Si el miembro del equipo es el propietario de la cuenta de Square.
Estado	status	string	Describe el estado del miembro del equipo.
Nombre propio	given_name	string	Nombre dado (es decir, el nombre) asociado al miembro del equipo.
Apellido	family_name	string	Nombre de familia (es decir, el apellido) asociado al miembro del equipo.
Dirección de correo electrónico	email_address	string	Dirección de correo electrónico asociada al miembro del equipo.
Número de teléfono	phone_number	string	Número de teléfono del miembro del equipo, en formato E.164.
Identificadores de ubicación	location_ids	array of string
Tipo de asignación	assignment_type	string	Tipo de asignación actual del miembro del equipo.
Identificador de referencia	reference_id	string	Segundo identificador usado para asociar el miembro del equipo a una entidad en otro sistema.
Es propietario	is_owner	boolean	Si el miembro del equipo es el propietario de la cuenta de Square.
Estado	status	string	Describe el estado del miembro del equipo.
Nombre propio	given_name	string	Nombre dado (es decir, el nombre) asociado al miembro del equipo.
Apellido	family_name	string	Nombre de familia (es decir, el apellido) asociado al miembro del equipo.
Dirección de correo electrónico	email_address	string	Dirección de correo electrónico asociada al miembro del equipo.
Número de teléfono	phone_number	string	Número de teléfono del miembro del equipo, en formato E.164.
Tipo de asignación	assignment_type	string	Tipo de asignación actual del miembro del equipo.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	team_members.team_member_id.team_member.id	string	Identificador para hacer referencia a este objeto.
Identificador de referencia	team_members.team_member_id.team_member.reference_id	string	Segundo identificador usado para asociar el miembro del equipo a una entidad en otro sistema.
Es propietario	team_members.team_member_id.team_member.is_owner	boolean	Si el miembro del equipo es el propietario de la cuenta de Square.
Estado	team_members.team_member_id.team_member.status	string	Describe el estado del miembro del equipo.
Nombre propio	team_members.team_member_id.team_member.given_name	string	Nombre dado (es decir, el nombre) asociado al miembro del equipo.
Apellido	team_members.team_member_id.team_member.family_name	string	Nombre de familia (es decir, el apellido) asociado al miembro del equipo.
Dirección de correo electrónico	team_members.team_member_id.team_member.email_address	string	Dirección de correo electrónico asociada al miembro del equipo.
Número de teléfono	team_members.team_member_id.team_member.phone_number	string	Número de teléfono del miembro del equipo, en formato E.164.
Creado en	team_members.team_member_id.team_member.created_at	string	Marca de tiempo, en formato RFC 3339, que describe cuándo se creó el miembro del equipo.
Tipo de asignación	team_members.team_member_id.team_member.assigned_locations.assignment_type	string	Tipo de asignación actual del miembro del equipo.
Identificadores de ubicación	team_members.team_member_id.team_member.assigned_locations.location_ids	array of string

Mostrar turnos de cajón de efectivo

Id. de la operación:: CashDrawerListShifts

Proporciona los detalles de todos los turnos de cajón de efectivo para una ubicación en un intervalo de fechas.

Parámetros

Nombre	Clave	Tipo	Description
Id. de ubicación	location_id	string	Puede especificar este filtro opcional para recuperar solo los registros que pertenecen a una ubicación específica.
Criterio de ordenación	sort_order	string	Ordena la lista devuelta por cuando se creó la tarjeta con el pedido especificado.
Hora de inicio	begin_time	string	Hora de inicio inclusiva de la consulta en opened_at, en formato ISO 8601.
Hora de finalización	end_time	string	Fecha de finalización exclusiva de la consulta en opened_at, en formato ISO 8601.
Limit	limit	integer	Límite superior del número que se va a devolver en la respuesta.
Cursor	cursor	string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Productos	items	array of object
identificación	items.id	string	Identificador único emitido por Square.
Estado	items.state	string	Estado actual.
Abierto en	items.opened_at	string	Hora de inicio del turno en formato ISO 8601.
Finalizado en	items.ended_at	string	Hora de finalización del turno en formato ISO 8601.
Cerrado en	items.closed_at	string	Tiempo de cierre de desplazamiento en formato ISO 8601.
Description	items.title	string	Descripción.
Importe	items.opened_cash_money.amount	integer	Cantidad.
Moneda	items.opened_cash_money.currency	string	Moneda.
Importe	items.expected_cash_money.amount	integer	Cantidad.
Moneda	items.expected_cash_money.currency	string	Moneda.
Importe	items.closed_cash_money.amount	integer	Cantidad.
Moneda	items.closed_cash_money.currency	string	Moneda.

Obtención de una cuenta bancaria por identificador V1

Id. de la operación:: BankAccountGetV1

Devuelve los detalles de una cuenta bancaria identificada por el identificador de cuenta bancaria V1.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de cuenta bancaria V1	v1_bank_account_id	True	string	Conecte el identificador V1 de la cuenta bancaria deseada.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	bank_account.id	string	Identificador único emitido por Square.
Sufijo de número de cuenta	bank_account.account_number_suffix	string	Los últimos dígitos del número de cuenta.
País	bank_account.country	string	Código de país ISO 3166 Alpha-2.
Moneda	bank_account.currency	string	Código de moneda ISO 4217 de 3 caracteres.
Tipo de cuenta	bank_account.account_type	string	Tipo de la cuenta.
Nombre del titular	bank_account.holder_name	string	Nombre del titular de la cuenta.
Número de identificación del banco principal	bank_account.primary_bank_identification_number	string	Identificador principal del banco.
Id. de ubicación	bank_account.location_id	string	Identificador de la ubicación.
Estado	bank_account.status	string	Estado de comprobación actual de este objeto.
Loable	bank_account.creditable	boolean	Indica si es posible que Square envíe dinero a esta cuenta.
Débito	bank_account.debitable	boolean	Indica si es posible que Square tome dinero de esta cuenta.
Versión	bank_account.version	integer	La versión actual de este objeto.
Nombre del banco	bank_account.bank_name	string	Nombre de la institución financiera real.

Obtener cuenta bancaria

Id. de la operación:: BankAccountGet

Devuelve los detalles de una cuenta de BankAccount vinculada a una cuenta de Square.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de cuenta bancaria	bank_account_id	True	string	Id. emitido por cuadrados de la cuenta bancaria deseada.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	bank_account.id	string	Identificador único emitido por Square.
Sufijo de número de cuenta	bank_account.account_number_suffix	string	Los últimos dígitos del número de cuenta.
País	bank_account.country	string	Código de país ISO 3166 Alpha-2.
Moneda	bank_account.currency	string	Código de moneda ISO 4217 de 3 caracteres.
Tipo de cuenta	bank_account.account_type	string	Tipo de la cuenta.
Nombre del titular	bank_account.holder_name	string	Nombre del titular de la cuenta.
Número de identificación del banco principal	bank_account.primary_bank_identification_number	string	Identificador principal del banco.
Id. de ubicación	bank_account.location_id	string	Identificador de la ubicación.
Estado	bank_account.status	string	Estado de comprobación actual de este objeto.
Loable	bank_account.creditable	boolean	Indica si es posible que Square envíe dinero a esta cuenta.
Débito	bank_account.debitable	boolean	Indica si es posible que Square tome dinero de esta cuenta.
Versión	bank_account.version	integer	La versión actual de este objeto.
Nombre del banco	bank_account.bank_name	string	Nombre de la institución financiera real.

Obtener código de dispositivo

Id. de la operación:: DeviceGet

Recupera DeviceCode con el identificador asociado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	device_code.id	string	Identificador único emitido por Square.
Nombre	device_code.name	string	Nombre del objeto.
Código	device_code.code	string	Código único que se puede usar para iniciar sesión.
Tipo de producto	device_code.product_type	string	Tipo de producto de destino del código de dispositivo.
Id. de ubicación	device_code.location_id	string	Identificador de la ubicación.
Creado en	device_code.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Emparejar por	device_code.pair_by	string	Cuando este DeviceCode expire y ya no inicie sesión. Marca de tiempo en formato RFC 3339.
Estado	device_code.status	string	Estado de comprobación actual de este objeto.
Id. de dispositivo	device_code.device_id	string	Identificador del dispositivo.
Estado cambiado en	device_code.status_changed_at	string	Cuando el estado de DeviceCode se cambió por última vez. Marca de tiempo en formato RFC 3339.

Obtener desplazamiento

Id. de la operación:: LaborGetShift

Devuelve un único Mayús especificado por id.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	shift.id	string	Identificador único emitido por Square.
Id. de miembro del equipo	shift.team_member_id	string	Identificador del miembro del equipo.
Id. de empleado	shift.employee_id	string	Identificador generado por cuadrados del empleado.
Id. de ubicación	shift.location_id	string	Identificador de la ubicación.
Timezone	shift.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Comenzar a	shift.start_at	string	Marca de tiempo que especifica la hora de inicio de este objeto, en formato RFC 3339.
Finalizar al	shift.end_at	string	RFC 3339; desplazado a la zona horaria + desplazamiento. Se respeta la precisión hasta el minuto; segundos se truncan.
Title	shift.wage.title	string	Nombre del trabajo realizado durante este turno. Las UIs de informes de mano de obra cuadrada pueden agrupar turnos por título.
Importe	shift.wage.hourly_rate.amount	integer	Cantidad.
Moneda	shift.wage.hourly_rate.currency	string	Moneda.
Interrupciones	shift.breaks	array of object
identificación	shift.breaks.id	string	Identificador del objeto
Comenzar a	shift.breaks.start_at	string	RFC 3339; sigue la misma información de zona horaria que Mayús. Se respeta la precisión hasta el minuto; segundos se truncan.
Finalizar al	shift.breaks.end_at	string	RFC 3339; sigue la misma información de zona horaria que Mayús. Se respeta la precisión hasta el minuto; segundos se truncan.
Id. de tipo de interrupción	shift.breaks.break_type_id	string	BreakType en el que se creó la plantilla BreakType.
Nombre	shift.breaks.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Duración esperada	shift.breaks.expected_duration	string	Longitud esperada de la interrupción. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
Se paga	shift.breaks.is_paid	boolean	Si esta interrupción cuenta para el tiempo trabajado con fines de compensación.
Estado	shift.status	string	Estado de comprobación actual de este objeto.
Versión	shift.version	integer	La versión actual de este objeto.
Creado en	shift.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	shift.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Obtener salario de miembro del equipo

Id. de la operación:: LaborGetWage

Devuelve un único TeamMemberWage especificado por id.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	team_member_wage.id	string	Identificador único emitido por Square.
Id. de miembro del equipo	team_member_wage.team_member_id	string	Identificador del miembro del equipo.
Title	team_member_wage.title	string	Título.
Importe	team_member_wage.hourly_rate.amount	integer	Cantidad.
Moneda	team_member_wage.hourly_rate.currency	string	Moneda.

Obtener tipo de interrupción

Id. de la operación:: LaborGetBreak

Devuelve un único BreakType especificado por id.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	break_type.id	string	Identificador único emitido por Square.
Id. de ubicación	break_type.location_id	string	Identificador de la ubicación.
Nombre de interrupción	break_type.break_name	string	Nombre legible para este tipo de interrupción. El nombre se muestra a los empleados de productos square.
Duración esperada	break_type.expected_duration	string	Longitud esperada de este salto. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. La precisión menor que los minutos se trunca.
Se paga	break_type.is_paid	boolean	Si esta interrupción cuenta para el tiempo trabajado con fines de compensación.
Versión	break_type.version	integer	La versión actual de este objeto.
Creado en	break_type.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	break_type.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Recuperación de la configuración de salarios

Id. de la operación:: TeamRetrieveWage

Recupera un objeto WageSetting para un miembro del equipo especificado por teamMember id.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de miembro del equipo	team_member_id	True	string	Identificador del miembro del equipo.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Id. de miembro del equipo	wage_setting.team_member_id	string	Identificador del miembro del equipo.
Asignaciones de trabajos	wage_setting.job_assignments	array of object
Título del Puesto	wage_setting.job_assignments.job_title	string	Título del trabajo.
Tipo de pago	wage_setting.job_assignments.pay_type	string	Tipo de pago actual para la asignación de trabajo utilizada para calcular el importe de pago en un período de pago.
Importe	wage_setting.job_assignments.hourly_rate.amount	integer	Cantidad.
Moneda	wage_setting.job_assignments.hourly_rate.currency	string	Moneda.
Importe	wage_setting.job_assignments.annual_rate.amount	integer	Cantidad.
Moneda	wage_setting.job_assignments.annual_rate.currency	string	Moneda.
Horas semanales	wage_setting.job_assignments.weekly_hours	integer	Las horas planeadas por semana para el trabajo. Establezca si el trabajo PayType es SALARY.
Está exento de horas extra	wage_setting.is_overtime_exempt	boolean	Si el miembro del equipo está exento de las reglas de horas extra del país del vendedor.
Versión	wage_setting.version	integer	La versión actual de este objeto.
Creado en	wage_setting.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	wage_setting.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Recuperación de la cuenta de fidelidad

Id. de la operación:: LoyaltyRetrieveAccount

Recupera una cuenta de fidelidad.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de cuenta	account_id	True	string	Identificador de la cuenta.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	loyalty_account.id	string	Identificador único emitido por Square.
identificación	loyalty_account.mapping.id	string	Identificador asignado a Square.
Número de teléfono	loyalty_account.mapping.phone_number	string	Número de teléfono del destinatario.
Creado en	loyalty_account.mapping.created_at	string	Marca de tiempo cuando se crea, en formato RFC 3339.
Id. de programa	loyalty_account.program_id	string	El identificador asignado a Square del programa.
Saldo	loyalty_account.balance	integer	Saldo disponible.
Puntos de duración	loyalty_account.lifetime_points	integer	Los puntos totales acumulados durante la vigencia de la cuenta.
Id. de cliente	loyalty_account.customer_id	string	Identificador de este objeto que representa al cliente.
Creado en	loyalty_account.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	loyalty_account.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Recuperación del perfil de reserva empresarial (Beta)

Id. de la operación:: BookingRetrieveProfile

Recupera el perfil de reserva de un vendedor.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Id. de vendedor	business_booking_profile.seller_id	string	El identificador del vendedor, que se puede obtener mediante la API De comerciantes.
Creado en	business_booking_profile.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Reserva habilitada	business_booking_profile.booking_enabled	boolean	Indica si el vendedor está abierto para la reserva.
Elección de zona horaria del cliente	business_booking_profile.customer_timezone_choice	string	La elección de la información de zona horaria del cliente de una reserva. El sitio de reserva en línea de Square y todas las notificaciones a los clientes usan la zona horaria de la ubicación del vendedor o la zona horaria que el cliente elige en la reserva.
Directiva de reserva	business_booking_profile.booking_policy	string	La política para que el vendedor acepte automáticamente solicitudes de reserva (ACCEPT_ALL) o no (REQUIRES_ACCEPTANCE).
Permitir cancelación de usuario	business_booking_profile.allow_user_cancel	boolean	Indica si los clientes pueden cancelar o reprogramar sus propias reservas (true) o no (false).
Tipos de ubicación	business_booking_profile.business_appointment_settings.location_types	array of string
Hora de alineación	business_booking_profile.business_appointment_settings.alignment_time	string	Unidad de tiempo de la duración del servicio para las reservas.
Min Booking Tead Time Seconds	business_booking_profile.business_appointment_settings.min_booking_lead_time_seconds	integer	Tiempo mínimo de tiempo de ejecución en segundos antes de que se pueda reservar un servicio. Las reservas deben crearse al menos antes de la hora de inicio de la reserva.
Número máximo de segundos de tiempo de cliente potencial de reserva	business_booking_profile.business_appointment_settings.max_booking_lead_time_seconds	integer	Tiempo máximo de tiempo de ejecución en segundos antes de que se pueda reservar un servicio. Las reservas deben crearse como máximo antes de la hora de inicio de la reserva.
Cualquier reserva de miembro del equipo habilitada	business_booking_profile.business_appointment_settings.any_team_member_booking_enabled	boolean	Indica si un cliente puede elegir entre todas las ranuras de tiempo disponibles y tener asignado automáticamente (true) a un miembro del personal (true) o no (false).
Varias reservas de servicio habilitadas	business_booking_profile.business_appointment_settings.multiple_service_booking_enabled	boolean	Indica si un cliente puede reservar varios servicios en una sola reserva en línea.
Importe	business_booking_profile.business_appointment_settings.cancellation_fee_money.amount	string	Cantidad de dinero, en la denominación más pequeña de la moneda indicada por moneda
Moneda	business_booking_profile.business_appointment_settings.cancellation_fee_money.currency	string	Tipo de moneda, en formato ISO 4217.
Directiva de cancelación	business_booking_profile.business_appointment_settings.cancellation_policy	string	La política de cancelación adoptada por el vendedor.
Omitir selección del personal de Booking Flow	business_booking_profile.business_appointment_settings.skip_booking_flow_staff_selection	boolean	Indica si los clientes tienen un miembro del personal asignado (true) o pueden seleccionar el miembro del personal de su elección (false).
Errors	errors	array of

Recuperación del programa de fidelidad

Id. de la operación:: LoyaltyRetrieveProgram

Recupera el programa de fidelidad en la cuenta de un vendedor, especificado por el identificador de programa o la palabra clave principal. Los programas de fidelidad definen cómo los compradores pueden ganar puntos y canjear puntos por recompensas.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de programa	program_id	True	string	Identificador del programa.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	program.id	string	Identificador único emitido por Square.
Estado	program.status	string	Estado de comprobación actual de este objeto.
Niveles de recompensa	program.reward_tiers	array of object
identificación	program.reward_tiers.id	string	Identificador del objeto
Puntos	program.reward_tiers.points	integer	Número de puntos acumulados por el evento.
Nombre	program.reward_tiers.name	string	Nombre del elemento. Se trata de un atributo que se puede buscar para su uso en los filtros de consulta aplicables, su valor no debe estar vacío y la longitud es de puntos de código Unicode.
Ámbito	program.reward_tiers.definition.scope	string	Indica el nivel en el que se aplica el objeto.
Tipo de descuento	program.reward_tiers.definition.discount_type	string	Tipo de descuento que ofrece el nivel de recompensa.
Porcentaje de descuento	program.reward_tiers.definition.percentage_discount	string	Porcentaje fijo del descuento.
Creado en	program.reward_tiers.created_at	string	Marca de tiempo cuando se crea, en formato RFC 3339.
Id. de objeto	program.reward_tiers.pricing_rule_reference.object_id	string	Identificador del objeto al que se hace referencia.
Versión del catálogo	program.reward_tiers.pricing_rule_reference.catalog_version	string	Versión del objeto .
One	program.terminology.one	string	Una unidad singular para un punto (por ejemplo, 1 punto se denomina 1 estrella).
Other	program.terminology.other	string	Una unidad plural para el punto (por ejemplo, 10 puntos se denomina 10 estrellas).
Identificadores de ubicación	program.location_ids	array of string
Creado en	program.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	program.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Reglas de acumulación	program.accrual_rules	array of object
Tipo de acumulación	program.accrual_rules.accrual_type	string	Tipo de regla de acumulación que define cómo los compradores pueden ganar puntos.
Puntos	program.accrual_rules.points	integer	Número de puntos acumulados por el evento.
Importe	program.accrual_rules.spend_amount_money.amount	integer	Cantidad.
Identificadores de categoría excluidos	program.accrual_rules.excluded_category_ids	array of string
Identificadores de variación de elementos excluidos	program.accrual_rules.excluded_item_variation_ids	array of string

Recuperar comerciante

Id. de la operación:: MerchantRetrieve

Recupere un objeto Merchant para el merchant_id especificado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de comerciante	merchant_id	True	string	Identificador del comerciante.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	merchant.id	string	Identificador único emitido por Square.
Nombre de la empresa	merchant.business_name	string	Nombre comercial de la ubicación Este es el nombre visible para los clientes de la ubicación. Por ejemplo, este nombre aparece en los recibos del cliente.
País	merchant.country	string	Código de país ISO 3166 Alpha-2.
Código de lenguaje	merchant.language_code	string	El código de idioma, en formato BCP 47.
Moneda	merchant.currency	string	Código de moneda ISO 4217 de 3 caracteres.
Estado	merchant.status	string	Estado de comprobación actual de este objeto.
Id. de ubicación principal	merchant.main_location_id	string	Identificador de la ubicación principal de este comerciante.

Recuperar desplazamiento del cajón de efectivo

Id. de la operación:: CashDrawerRetrieveShift

Proporciona los detalles de resumen de un único turno de cajón de efectivo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de mayús	shift_id	True	string	Identificador del turno.
Id. de ubicación	location_id	True	string	Puede especificar este filtro opcional para recuperar solo los registros que pertenecen a una ubicación específica.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	cash_drawer_shift.id	string	Identificador único emitido por Square.
Estado	cash_drawer_shift.state	string	Estado actual.
Abierto en	cash_drawer_shift.opened_at	string	La hora en que comenzó el cambio, en formato ISO 8601.
Finalizado en	cash_drawer_shift.ended_at	string	Hora a la que finalizó el turno, en formato ISO 8601.
Cerrado en	cash_drawer_shift.closed_at	string	Hora en que se cierra, en formato ISO 8601.
Apertura del identificador de empleado	cash_drawer_shift.opening_employee_id	string	El identificador del empleado que inició el turno de cajón de efectivo.
Id. de empleado final	cash_drawer_shift.ending_employee_id	string	El identificador del empleado que finalizó el turno de cajón de efectivo.
Cerrar el identificador de empleado	cash_drawer_shift.closing_employee_id	string	El identificador del empleado que cerró el turno de cajón de efectivo mediante la auditoría del contenido del cajón de efectivo.
Description	cash_drawer_shift.description	string	Descripción.
Importe	cash_drawer_shift.opened_cash_money.amount	integer	Cantidad.
Moneda	cash_drawer_shift.opened_cash_money.currency	string	Moneda.
Importe	cash_drawer_shift.cash_payment_money.amount	integer	Cantidad.
Moneda	cash_drawer_shift.cash_payment_money.currency	string	Moneda.
Importe	cash_drawer_shift.cash_refunds_money.amount	integer	Cantidad.
Moneda	cash_drawer_shift.cash_refunds_money.currency	string	Moneda.
Importe	cash_drawer_shift.cash_paid_in_money.amount	integer	Cantidad.
Moneda	cash_drawer_shift.cash_paid_in_money.currency	string	Moneda.
Importe	cash_drawer_shift.cash_paid_out_money.amount	integer	Cantidad.
Moneda	cash_drawer_shift.cash_paid_out_money.currency	string	Moneda.
Importe	cash_drawer_shift.expected_cash_money.amount	integer	Cantidad.
Moneda	cash_drawer_shift.expected_cash_money.currency	string	Moneda.
Importe	cash_drawer_shift.closed_cash_money.amount	integer	Cantidad.
Moneda	cash_drawer_shift.closed_cash_money.currency	string	Moneda.
Nombre	cash_drawer_shift.device.name	string	Nombre.

Recuperar fragmento de código

Id. de la operación:: SnippetRetrieve

Recupera el fragmento de código de un sitio de Square Online. Un sitio puede contener fragmentos de código de varias aplicaciones de fragmento de código, pero solo puede recuperar el fragmento de código que agregó la aplicación.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de sitio de	site_id	True	string	Identificador del sitio.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	snippet.id	string	Identificador único emitido por Square.
Id. de sitio de	snippet.site_id	string	Identificador del sitio que contiene el fragmento de código.
Content	snippet.content	string	El código de fragmento de código, que puede contener HTML, JavaScript o ambos válidos.
Creado en	snippet.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	snippet.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Recuperar miembro del equipo

Id. de la operación:: TeamRetrieveMember

Recupera un objeto TeamMember para el identificador TeamMember especificado.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de miembro del equipo	team_member_id	True	string	Identificador del miembro del equipo.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	team_member.id	string	Identificador único emitido por Square.
Identificador de referencia	team_member.reference_id	string	Identificador de referencia definido por el usuario opcional.
Es propietario	team_member.is_owner	boolean	Si el miembro del equipo es el propietario de la cuenta de Square.
Estado	team_member.status	string	Estado de comprobación actual de este objeto.
Nombre propio	team_member.given_name	string	Nombre especificado (es decir, primero) asociado al perfil de cliente.
Apellido	team_member.family_name	string	El nombre de la familia (es decir, apellido) asociado al perfil de cliente.
Dirección de correo electrónico	team_member.email_address	string	Dirección de correo electrónico asociada al perfil de cliente.
Número de teléfono	team_member.phone_number	string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Creado en	team_member.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	team_member.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Tipo de asignación	team_member.assigned_locations.assignment_type	string	Tipo de asignación actual del miembro del equipo.
Identificadores de ubicación	team_member.assigned_locations.location_ids	array of string

Recuperar recompensa de fidelidad

Id. de la operación:: LoyaltyRetrieveReward

Recupera una recompensa de fidelidad.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de recompensa	reward_id	True	string	Identificador de la recompensa.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	reward.id	string	Identificador único emitido por Square.
Estado	reward.status	string	Estado de comprobación actual de este objeto.
Id. de cuenta de fidelidad	reward.loyalty_account_id	string	Identificador de la cuenta de fidelidad en la que se produjo el evento.
Id. de nivel de recompensa	reward.reward_tier_id	string	El identificador asignado a Cuadrado del nivel de recompensa usado para crear la recompensa.
Puntos	reward.points	integer	Número de puntos agregados o eliminados.
Creado en	reward.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	reward.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.
Canjeado en	reward.redeemed_at	string	Marca de tiempo en la que se canjeó la recompensa, en formato RFC 3339.

Recuperar tarjeta de regalo (Beta)

Id. de la operación:: GiftCardRetrieve

Recupera una tarjeta de regalo con su identificador.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	gift_card.id	string	Identificador único emitido por Square.
Tipo	gift_card.type	string	El tipo de este objeto.
Origen de GAN	gift_card.gan_source	string	Indica si square genera o importa el número de cuenta de la tarjeta de regalo (GAN) desde un sistema que no es cuadrado.
Estado	gift_card.state	string	Estado actual.
Importe	gift_card.balance_money.amount	integer	Cantidad.
Moneda	gift_card.balance_money.currency	string	Moneda.
Gan	gift_card.gan	string	Número de cuenta de tarjeta de regalo.
Creado en	gift_card.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.

Recuperar tarjeta de regalo de GAN (Beta)

Id. de la operación:: GiftCardRetrieveGAN

Recupera una tarjeta de regalo con el número de cuenta de la tarjeta de regalo (GAN).

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Gan	gan		string	Número de cuenta de tarjeta de regalo.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	gift_card.id	string	Identificador único emitido por Square.
Tipo	gift_card.type	string	El tipo de este objeto.
Origen de GAN	gift_card.gan_source	string	Indica si square genera o importa el número de cuenta de la tarjeta de regalo (GAN) desde un sistema que no es cuadrado.
Estado	gift_card.state	string	Estado actual.
Importe	gift_card.balance_money.amount	integer	Cantidad.
Moneda	gift_card.balance_money.currency	string	Moneda.
Gan	gift_card.gan	string	Número de cuenta de tarjeta de regalo.
Creado en	gift_card.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.

Recuperar tarjeta de regalo de nonce (Beta)

Id. de la operación:: GiftCardRetrieveNonce

Recupera una tarjeta de regalo mediante un nonce (un token seguro) que representa la tarjeta de regalo.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Valor de seguridad	nonce		string	El nonce de la tarjeta de regalo que se va a recuperar.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	gift_card.id	string	Identificador único emitido por Square.
Tipo	gift_card.type	string	El tipo de este objeto.
Origen de GAN	gift_card.gan_source	string	Indica si square genera o importa el número de cuenta de la tarjeta de regalo (GAN) desde un sistema que no es cuadrado.
Estado	gift_card.state	string	Estado actual.
Importe	gift_card.balance_money.amount	integer	Cantidad.
Moneda	gift_card.balance_money.currency	string	Moneda.
Gan	gift_card.gan	string	Número de cuenta de tarjeta de regalo.
Creado en	gift_card.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.

Recuperar ubicación

Id. de la operación:: LocationRetrieve

Recupera los detalles de una ubicación. Puede especificar "main" como identificador de ubicación para recuperar los detalles de la ubicación principal.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de ubicación	location_id	True	string	Identificador de la ubicación.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	location.id	string	Identificador único emitido por Square.
Nombre	location.name	string	Nombre del objeto.
Línea de dirección 1	location.address.address_line_1	string	Primera línea de la dirección. Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Localidad	location.address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	location.address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	location.address.postal_code	string	El código postal de la dirección.
País	location.address.country	string	País de la dirección, en formato ISO 3166-1-alpha-2.
Timezone	location.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Capabilities	location.capabilities	array of string
Estado	location.status	string	Estado de comprobación actual de este objeto.
Creado en	location.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Id. de comerciante	location.merchant_id	string	Identificador del comerciante.
País	location.country	string	Código de país ISO 3166 Alpha-2.
Código de lenguaje	location.language_code	string	El código de idioma, en formato BCP 47.
Moneda	location.currency	string	Código de moneda ISO 4217 de 3 caracteres.
Número de teléfono	location.phone_number	string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Nombre de la empresa	location.business_name	string	Nombre comercial de la ubicación Este es el nombre visible para los clientes de la ubicación. Por ejemplo, este nombre aparece en los recibos del cliente.

Tipo de interrupción de actualización

Id. de la operación:: LaborUpdateBreak

Actualiza un BreakType existente.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
identificación	id	True	string	Identificador.
Id. de ubicación	location_id		string	Identificador de la ubicación.
Nombre de interrupción	break_name		string	Nombre legible para este tipo de interrupción. El nombre se muestra a los empleados de productos square.
Duración esperada	expected_duration		string	Longitud esperada de este salto. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. La precisión menor que los minutos se trunca.
Se paga	is_paid		boolean	Si esta interrupción cuenta para el tiempo trabajado con fines de compensación.
Versión	version		integer	La versión actual de este objeto.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	break_type.id	string	Identificador único emitido por Square.
Id. de ubicación	break_type.location_id	string	Identificador de la ubicación.
Nombre de interrupción	break_type.break_name	string	Nombre legible para este tipo de interrupción. El nombre se muestra a los empleados de productos square.
Duración esperada	break_type.expected_duration	string	Longitud esperada de este salto. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. La precisión menor que los minutos se trunca.
Se paga	break_type.is_paid	boolean	Si esta interrupción cuenta para el tiempo trabajado con fines de compensación.
Versión	break_type.version	integer	La versión actual de este objeto.
Creado en	break_type.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Actualizado en	break_type.updated_at	string	Marca de tiempo que especifica la hora de actualización más reciente de este objeto, en formato RFC 3339.

Tipos de interrupción de lista

Id. de la operación:: LaborListBreak

Devuelve una lista paginada de instancias breakType para una empresa.

Parámetros

Nombre	Clave	Tipo	Description
Id. de ubicación	location_id	string	Puede especificar este filtro opcional para recuperar solo los registros que pertenecen a una ubicación específica.
Limit	limit	integer	Límite superior del número que se va a devolver en la respuesta.
Cursor	cursor	string	Cursor de paginación devuelto por una llamada anterior a este punto de conexión.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Tipos de interrupción	break_types	array of object
identificación	break_types.id	string	Identificador único emitido por Square.
Id. de ubicación	break_types.location_id	string	Identificador de la ubicación.
Nombre de interrupción	break_types.break_name	string	Nombre legible para este tipo de interrupción. El nombre se muestra a los empleados de productos square.
Duración esperada	break_types.expected_duration	string	Longitud esperada de este salto. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. La precisión menor que los minutos se trunca.
Se paga	break_types.is_paid	boolean	Si esta interrupción cuenta para el tiempo trabajado con fines de compensación.
Versión	break_types.version	integer	Versión actual del objeto.
Creado en	break_types.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	break_types.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339
Cursor	cursor	string	Incluya el cursor de paginación en llamadas posteriores a este punto de conexión para recuperar el siguiente conjunto de resultados asociado a la consulta original.

Turnos de búsqueda

Id. de la operación:: LaborSearchShifts

Devuelve una lista paginada de registros Shift para una empresa.

Parámetros

Nombre	Clave	Tipo	Description
Fecha de inicio	start_date	string	Cadena en formato AAAA-MM-DD, como 2017-10-31, según el formato extendido ISO 8601 para las fechas del calendario. Principio de un intervalo de fechas (incluido).
Fecha de finalización	end_date	string	Cadena en formato AAAA-MM-DD, como 2017-10-31, según el formato extendido ISO 8601 para las fechas del calendario. Final de un intervalo de fechas (incluido).
Turnos de coincidencia por	match_shifts_by	string	Estrategia en la que se aplican las fechas.
Zona horaria predeterminada	default_timezone	string	Las zonas horarias específicas de la ubicación convierten los días laborables en filtros datetime. Cada ubicación incluida en la consulta debe tener una zona horaria o este campo debe proporcionarse como reserva. Formato: identificador de base de datos de zona horaria de IANA para la zona horaria correspondiente.
Limit	limit	integer	Límite en el número de resultados que se van a devolver en una sola página. El límite es aviso: la implementación puede devolver más o menos resultados. Si el límite proporcionado es negativo, cero o es mayor que el límite máximo de 1000, se omitirá.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
Turnos	shifts	array of object
identificación	shifts.id	string	Identificador único emitido por Square.
Id. de miembro del equipo	shifts.team_member_id	string	Identificador del objeto TeamMember del miembro del equipo asociado al objeto .
Id. de ubicación	shifts.location_id	string	Identificador de la ubicación.
Timezone	shifts.timezone	string	Zona horaria usada para interpretar las fechas del calendario en la factura, como due_date. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Comenzar a	shifts.start_at	string	Marca de tiempo RFC 3339 que especifica la hora inicial de la ranura disponible.
Finalizar al	shifts.end_at	string	RFC 3339; desplazado a la zona horaria + desplazamiento. Se respeta la precisión hasta el minuto; segundos se truncan.
Title	shifts.wage.title	string	Nombre del trabajo realizado durante este turno. Las UIs de informes de mano de obra cuadrada pueden agrupar turnos por título.
Importe	shifts.wage.hourly_rate.amount	integer	Cantidad.
Moneda	shifts.wage.hourly_rate.currency	string	Moneda.
Interrupciones	shifts.breaks	array of object
identificación	shifts.breaks.id	string	Identificador para hacer referencia a este objeto.
Comenzar a	shifts.breaks.start_at	string	Valor datetime en formato RFC 3339 que indica cuándo se inicia el intervalo de tiempo.
Finalizar al	shifts.breaks.end_at	string	Valor datetime en formato RFC 3339 que indica cuándo finaliza el intervalo de tiempo.
Id. de tipo de interrupción	shifts.breaks.break_type_id	string	BreakType en el que se creó la plantilla BreakType.
Nombre	shifts.breaks.name	string	Un nombre legible.
Duración esperada	shifts.breaks.expected_duration	string	Longitud esperada de la interrupción. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
Se paga	shifts.breaks.is_paid	boolean	Si esta interrupción cuenta para el tiempo trabajado con fines de compensación.
Estado	shifts.status	string	Estado de comprobación actual de este objeto.
Versión	shifts.version	integer	Versión actual del objeto.
Creado en	shifts.created_at	string	Hora del evento en formato ISO 8601.
Actualizado en	shifts.updated_at	string	Marca de tiempo de última modificación en formato RFC 3339

Ubicación de actualización (Beta)

Id. de la operación:: LocationUpdate

Actualiza una ubicación.

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de ubicación	location_id	True	string	Identificador de la ubicación.
Nombre	name		string	Nombre del objeto.
Description	description		string	Descripción.
Facebook URL	facebook_url		string	Dirección URL del perfil de Facebook de la ubicación. La dirección URL debe comenzar por "facebook.com/".
Nombre de usuario de Twitter	twitter_username		string	Nombre de usuario de Twitter de la ubicación sin el símbolo '@'.
Nombre de usuario de Instagram	instagram_username		string	Nombre de usuario de Instagram de la ubicación sin el símbolo '@'.
Línea de dirección 1	address_line_1		string	Primera línea de la dirección. Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Nivel 1 del distrito administrativo	administrative_district_level_1		string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Localidad	locality		string	La ciudad o la ciudad de la dirección.
Código postal	postal_code		string	El código postal de la dirección.
Día de la semana	day_of_week		string	El día de la semana para este período de tiempo.
Hora local de inicio	start_local_time		string	La hora de inicio de un período de horas laborables, especificada en la hora local mediante el formato RFC 3339 de tiempo parcial.
Hora local de finalización	end_local_time		string	La hora de finalización de un período de horas laborables, especificada en la hora local mediante el formato RFC 3339 de tiempo parcial.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	location.id	string	Identificador único emitido por Square.
Nombre	location.name	string	Nombre del objeto.
Línea de dirección 1	location.address.address_line_1	string	Primera línea de la dirección. Los campos que comienzan por address_line proporcionan los detalles más específicos de la dirección, como el número de calle, el nombre de la calle y el nombre de la compilación.
Localidad	location.address.locality	string	La ciudad o la ciudad de la dirección.
Nivel 1 del distrito administrativo	location.address.administrative_district_level_1	string	Una entidad civil dentro del país de la dirección. En estados Unidos, este es el estado.
Código postal	location.address.postal_code	string	El código postal de la dirección.
Timezone	location.timezone	string	Zona horaria que se usa para interpretar las fechas del calendario. Cuando se crea una factura, este campo se establece en la zona horaria especificada para la ubicación del vendedor. No se puede cambiar el valor.
Capabilities	location.capabilities	array of string
Estado	location.status	string	Estado de comprobación actual de este objeto.
Creado en	location.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Id. de comerciante	location.merchant_id	string	Identificador del comerciante.
País	location.country	string	Código de país ISO 3166 Alpha-2.
Código de lenguaje	location.language_code	string	El código de idioma, en formato BCP 47.
Moneda	location.currency	string	Código de moneda ISO 4217 de 3 caracteres.
Número de teléfono	location.phone_number	string	Número de teléfono de 11 dígitos asociado al perfil de cliente.
Nombre de la empresa	location.business_name	string	Nombre comercial de la ubicación Este es el nombre visible para los clientes de la ubicación. Por ejemplo, este nombre aparece en los recibos del cliente.
Tipo	location.type	string	El tipo de este objeto.
URL del sitio web	location.website_url	string	Dirección URL del sitio web de la ubicación.
Períodos	location.business_hours.periods	array of object
Día de la semana	location.business_hours.periods.day_of_week	string	El día de la semana para este período de tiempo.
Hora local de inicio	location.business_hours.periods.start_local_time	string	La hora de inicio de un período de horas laborables, especificada en la hora local mediante el formato RFC 3339 de tiempo parcial.
Hora local de finalización	location.business_hours.periods.end_local_time	string	La hora de finalización de un período de horas laborables, especificada en la hora local mediante el formato RFC 3339 de tiempo parcial.
Correo electrónico empresarial	location.business_email	string	El correo electrónico de la ubicación. Este correo electrónico es visible para los clientes de la ubicación. Por ejemplo, el correo electrónico aparece en los recibos del cliente.
Description	location.description	string	Descripción.
Nombre de usuario de Twitter	location.twitter_username	string	Nombre de usuario de Twitter de la ubicación sin el símbolo '@'.
Nombre de usuario de Instagram	location.instagram_username	string	Nombre de usuario de Instagram de la ubicación sin el símbolo '@'.
Latitude	location.coordinates.latitude	float	Latitud de la coordenada expresada en grados.
Longitude	location.coordinates.longitude	float	Longitud de la coordenada expresada en grados.
MCC	location.mcc	string	El código de categoría de comerciante (MCC) de la ubicación, tal como lo normaliza iso 18245. El MCC describe el tipo de bienes o servicios vendidos en la ubicación.

Vincular al cliente a la tarjeta de regalo (Beta)

Id. de la operación:: GiftCardLink

Vincula a un cliente a una tarjeta de regalo

Parámetros

Nombre	Clave	Requerido	Tipo	Description
Id. de tarjeta de regalo	gift_card_id	True	string	Identificador de la tarjeta de regalo.
Id. de cliente	customer_id		string	Identificador del cliente que se va a vincular.

Devoluciones

Nombre	Ruta de acceso	Tipo	Description
identificación	gift_card.id	string	Identificador único emitido por Square.
Tipo	gift_card.type	string	El tipo de este objeto.
Origen de GAN	gift_card.gan_source	string	Indica si square genera o importa el número de cuenta de la tarjeta de regalo (GAN) desde un sistema que no es cuadrado.
Estado	gift_card.state	string	Estado actual.
Importe	gift_card.balance_money.amount	integer	Cantidad.
Moneda	gift_card.balance_money.currency	string	Moneda.
Gan	gift_card.gan	string	Número de cuenta de tarjeta de regalo.
Creado en	gift_card.created_at	string	Marca de tiempo que especifica la hora de creación de este objeto, en formato RFC 3339.
Identificadores de cliente	gift_card.customer_ids	array of string

Definiciones

objeto

Este es el tipo 'objeto'.

Compartir a través de

Square Business (Publicador independiente) (versión preliminar)

Limitaciones

Acciones

Actualización de la configuración de la semana laboral

Parámetros

Devoluciones

Actualización de la configuración de salarios

Parámetros

Devoluciones

Actualizar miembro del equipo

Parámetros

Devoluciones

Acumular puntos de fidelidad

Parámetros

Devoluciones

Ajustar puntos de fidelidad

Parámetros

Devoluciones

Buscar cuentas de fidelidad

Parámetros

Devoluciones

Buscar eventos de fidelidad

Parámetros

Devoluciones

Buscar miembros del equipo

Parámetros

Devoluciones

Buscar recompensas de fidelidad

Parámetros

Devoluciones

Cambio de actualización

Parámetros

Devoluciones

Canjear recompensa de lealtad

Parámetros

Devoluciones

Creación de código de autorización móvil

Parámetros

Devoluciones

Creación de código de dispositivo

Parámetros

Devoluciones

Creación de reservas (beta)

Parámetros

Devoluciones

Creación de un miembro del equipo

Parámetros

Devoluciones

Creación de una cuenta de fidelidad

Parámetros

Devoluciones

Creación masiva de miembros del equipo

Parámetros

Devoluciones

Crear actividad de tarjetas regalo (Beta)

Parámetros

Devoluciones

Crear desplazamiento

Parámetros

Devoluciones

Crear desprotección

Parámetros

Devoluciones

Crear recompensa de fidelidad

Parámetros

Devoluciones

Crear tipo de interrupción

Parámetros

Devoluciones

Crear ubicación (Beta)

Parámetros

Devoluciones

Cálculo de puntos de fidelidad

Parámetros

Devoluciones

Desvincular al cliente de la tarjeta de regalo (Beta)

Parámetros

Devoluciones

Disponibilidad de búsqueda (beta)