Square Business (Editor Independente) (versão prévia)

A Square ajuda milhões de vendedores a administrar seus negócios - desde processamento seguro de cartão de crédito até soluções de ponto de venda. Esse conector contém ações para os seguintes pontos de extremidade: Fidelidade, Cartões-Presente, Reservas, Negócios, Equipe, Finanças, Online e Autenticação.

Esse conector está disponível nos seguintes produtos e regiões:

Service	Class	Regions
Copilot Studio	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Power Apps	Premium	Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Power Automate	Premium	Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Metadados do conector
Publicador	Troy Taylor
Site	https://squareup.com/
Política de privacidade	https://squareup.com/us/en/legal/general/privacy
Categorias	Comércio; Vendas e CRM

Limitações

Nome	Chamadas	Período de renovação
Chamadas à API por conexão	100	60 segundos

Ações

Acumular pontos de fidelidade	Adiciona pontos a uma conta de fidelidade.
Ajustar pontos de fidelidade	Adiciona pontos ou subtrai pontos da conta de um comprador. Use esse ponto de extremidade somente quando precisar ajustar pontos manualmente.
Atualizar a configuração salarial	Cria ou atualiza um objeto WageSetting.
Atualizar configuração da semana de trabalho	Atualiza um WorkweekConfig.
Atualizar membro da equipe	Atualiza um único objeto TeamMember.
Calcular pontos de fidelidade	Calcula os pontos que uma compra ganha. Um aplicativo pode chamar esse ponto de extremidade para mostrar os pontos que um comprador pode ganhar com a compra específica.
Criar atividade de cartão-presente (Beta)	Cria uma atividade de cartão presente.
Criar check-out	Vincula um checkoutId a um checkout_page_url para o qual os clientes são direcionados para fornecer suas informações de pagamento usando um fluxo de trabalho de processamento de pagamento.
Criar conta de fidelidade	Cria uma conta de fidelidade.
Criar código de autorização móvel	Gera código para autorizar um aplicativo móvel a se conectar a um leitor de cartão Square. Os códigos de autorização são de uso único e expiram 60 minutos após a emissão.
Criar código do dispositivo	Cria um DeviceCode que pode ser usado para fazer logon em um dispositivo do Terminal Quadrado para entrar no modo de terminal conectado.
Criar local (Beta)	Cria um local.
Criar membro da equipe	Cria um único objeto TeamMember.
Criar membros da equipe em massa	Cria vários objetos TeamMember.
Criar recompensa de fidelidade	Cria uma recompensa de lealdade. Depois que uma recompensa é criada, os pontos são bloqueados e não estão disponíveis para o comprador resgatar outra recompensa.
Criar reserva (Beta)	Cria uma reserva.
Criar tipo de interrupção	Cria um novo BreakType. Um BreakType é um modelo para criar objetos Break.
Criar turno	Cria um novo Shift. Um Shift representa um dia de trabalho completo para um único funcionário
Desvincular o cliente do cartão-presente (Beta)	Desvincula um cliente de um cartão-presente.
Disponibilidade de pesquisa (Beta)	Procura disponibilidades para reserva.
Excluir recompensa de fidelidade	Exclui uma recompensa de fidelidade. Retorna os pontos de fidelidade de volta para a conta de fidelidade. Você não pode excluir uma recompensa que atingiu o estado do terminal (REDEEMED).
Excluir snippet	Remove o snippet de código de um site do Square Online.
Excluir tipo de interrupção	Exclui um BreakType existente. Um BreakType pode ser excluído mesmo se for referenciado de um Shift.
Excluir turno	Exclui um turno
Listar atividades de cartão-presente (Beta)	Lista atividades de cartão-presente. Por padrão, você obtém atividades de cartão presente para todos os cartões-presente na conta do vendedor. Opcionalmente, você pode especificar parâmetros de consulta para filtrar a lista. Por exemplo, você pode obter uma lista de atividades de cartão presente para um cartão presente, para todos os cartões-presente em uma região específica ou para atividades em uma janela de tempo.
Listar comerciantes	Retorna informações do Comerciante para um determinado token de acesso.
Listar configurações da semana de trabalho	Retorna uma lista de instâncias WorkweekConfig para uma empresa.
Listar contas bancárias	Retorna uma lista de objetos BankAccount vinculados a uma conta Square.
Listar códigos do dispositivo	Lista todos os DeviceCodes associados ao comerciante.
Listar eventos de turno de gaveta de dinheiro	Fornece uma lista paginada de eventos para um único turno de gaveta de dinheiro.
Listar locais	Fornece informações de todos os locais de uma empresa.
Listar os salários dos membros da equipe	Retorna uma lista paginada de instâncias de TeamMemberWage para uma empresa.
Listar perfis de reserva de membros da equipe (Beta)	Lista perfis de reserva para membros da equipe.
Listar sites	Lista os sites do Square Online que pertencem a um vendedor.
Listar turnos de gaveta de dinheiro	Fornece os detalhes de todos os turnos de gaveta de dinheiro para um local em um intervalo de datas.
Local da atualização (Beta)	Atualiza um local.
Membros da equipe de atualização em massa	Atualiza vários objetos TeamMember.
Membros da equipe de pesquisa	Retorna uma lista paginada de objetos TeamMember para uma empresa.
Mudança de atualização	Atualiza um Shift existente.
Obter conta bancária	Retorna detalhes de um BankAccount vinculado a uma conta Square.
Obter conta bancária por ID da V1	Retorna detalhes de um BankAccount identificado pela ID da conta bancária V1.
Obter código do dispositivo	Recupera DeviceCode com a ID associada.
Obter salário de membro da equipe	Retorna um único TeamMemberWage especificado pela ID.
Obter tipo de interrupção	Retorna um único BreakType especificado pela ID.
Obter turno	Retorna um único Shift especificado pela ID.
Pesquisar contas de fidelidade	Pesquisa contas de fidelidade em um programa de fidelidade.
Pesquisar eventos de fidelidade	Pesquisa eventos de fidelidade. Um programa de fidelidade Square mantém um razão de eventos que ocorrem durante o tempo de vida da conta de fidelidade de um comprador. Cada alteração no saldo de pontos (por exemplo, pontos ganhos, pontos resgatados e pontos expirados) é registrada no razão. Usando esse ponto de extremidade, você pode pesquisar eventos no razão.
Pesquisar recompensas de fidelidade	Procura recompensas de fidelidade em uma conta de fidelidade.
Recuperar a configuração salarial	Recupera um objeto WageSetting para um membro da equipe especificado pela ID do TeamMember.
Recuperar cartão-presente (Beta)	Recupera um cartão presente usando sua ID.
Recuperar cartão-presente do GAN (Beta)	Recupera um cartão presente usando o número da conta do cartão presente (GAN).
Recuperar cartão-presente do nonce (Beta)	Recupera um cartão presente usando um nonce (um token seguro) que representa o cartão presente.
Recuperar comerciante	Recupere um objeto Merchant para o merchant_id fornecido.
Recuperar conta de fidelidade	Recupera uma conta de fidelidade.
Recuperar local	Recupera detalhes de um local. Você pode especificar "principal" como a ID do local para recuperar detalhes do local principal.
Recuperar membro da equipe	Recupera um objeto TeamMember para a ID do TeamMember fornecida.
Recuperar o turno da gaveta de dinheiro	Fornece os detalhes de resumo de um único turno de gaveta de dinheiro.
Recuperar perfil de reserva de negócios (Beta)	Recupera o perfil de reserva de um vendedor.
Recuperar programa de fidelidade	Recupera o programa de fidelidade na conta de um vendedor, especificado pela ID do programa ou pela palavra-chave principal. Os programas de fidelidade definem como os compradores podem ganhar pontos e resgatar pontos para recompensas.
Recuperar recompensa de fidelidade	Recupera uma recompensa de fidelidade.
Recuperar snippet	Recupera o snippet de código de um site do Square Online. Um site pode conter snippets de vários aplicativos de snippet, mas você pode recuperar apenas o snippet que foi adicionado pelo aplicativo.
Resgatar recompensa de lealdade	Resgata uma recompensa de lealdade. Depois que a recompensa atingir o estado terminal, ela não poderá ser excluída. Em outras palavras, os pontos usados para a recompensa não podem ser retornados para a conta.
Tipo de quebra de atualização	Atualiza um BreakType existente.
Tipos de quebra de lista	Retorna uma lista paginada de instâncias BreakType para uma empresa.
Trecho de código upsert	Adiciona um snippet a um site do Square Online ou atualiza o snippet existente no site. O código de snippet é acrescentado ao final do elemento principal em todas as páginas do site, exceto páginas de check-out. Um aplicativo de snippet de código pode adicionar um snippet a um determinado site.
Turnos de pesquisa	Retorna uma lista paginada de registros Shift para uma empresa.
Vincular o cliente ao cartão presente (Beta)	Vincula um cliente a um cartão-presente

Acumular pontos de fidelidade

ID da operação:: LoyaltyAccumulatePoints

Adiciona pontos a uma conta de fidelidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
AccountID	account_id	True	string	O identificador da conta.
ID do pedido	order_id		string	A ID da ordem.
ID do Local	location_id		string	O identificador de local.
Chave de Idempotency	idempotency_key		string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).

Retornos

Nome	Caminho	Tipo	Description
ID	event.id	string	O identificador exclusivo emitido por Quadrado.
Tipo	event.type	string	O tipo desse objeto.
Criado em	event.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
ID do programa de fidelidade	event.accumulate_points.loyalty_program_id	string	A ID do programa de fidelidade
Pontos	event.accumulate_points.points	integer	O número de pontos acumulados pelo evento.
ID do pedido	event.accumulate_points.order_id	string	A ID da ordem associada à atividade.
ID da conta de fidelidade	event.loyalty_account_id	string	A ID da conta de fidelidade na qual o evento ocorreu.
ID do Local	event.location_id	string	O identificador do local.
Source	event.source	string	A origem.

Ajustar pontos de fidelidade

ID da operação:: LoyaltyAdjustPoints

Adiciona pontos ou subtrai pontos da conta de um comprador. Use esse ponto de extremidade somente quando precisar ajustar pontos manualmente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
AccountID	account_id	True	string	O identificador da conta.
Pontos	points		integer	O número de pontos adicionados ou removidos.
Reason	reason		string	O motivo desse objeto.
Chave de Idempotency	idempotency_key		string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).

Retornos

Nome	Caminho	Tipo	Description
ID	event.id	string	O identificador exclusivo emitido por Quadrado.
Tipo	event.type	string	O tipo desse objeto.
Criado em	event.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
ID do programa de fidelidade	event.adjust_points.loyalty_program_id	string	A ID do programa de fidelidade
Pontos	event.adjust_points.points	integer	O número de pontos acumulados pelo evento.
Reason	event.adjust_points.reason	string	O motivo do ajuste de pontos.
ID da conta de fidelidade	event.loyalty_account_id	string	A ID da conta de fidelidade na qual o evento ocorreu.
Source	event.source	string	A origem.

Atualizar a configuração salarial

ID da operação:: TeamUpdateWage

Cria ou atualiza um objeto WageSetting.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do membro da equipe	team_member_id	True	string	O identificador do membro da equipe.
Isenção de horas extras	is_overtime_exempt		boolean	Se o membro da equipe está isento das regras de horas extras do país do vendedor.
Cargo	job_title		string	O título do trabalho.
Tipo de pagamento	pay_type		string	O tipo de pagamento atual da atribuição de trabalho usada para calcular o valor de pagamento em um período de pagamento.
Quantidade	amount		integer	O valor.
Moeda	currency		string	A moeda.
Horas Semanais	weekly_hours		integer	As horas planejadas por semana para o trabalho. Defina se o paytype do trabalho for SALARY.
Quantidade	amount		integer	O valor.
Moeda	currency		string	A moeda.

Retornos

Nome	Caminho	Tipo	Description
ID do membro da equipe	wage_setting.team_member_id	string	A ID do membro da equipe.
Atribuições de Trabalho	wage_setting.job_assignments	array of object
Cargo	wage_setting.job_assignments.job_title	string	O título do trabalho.
Tipo de pagamento	wage_setting.job_assignments.pay_type	string	O tipo de pagamento atual da atribuição de trabalho usada para calcular o valor de pagamento em um período de pagamento.
Quantidade	wage_setting.job_assignments.hourly_rate.amount	integer	O valor.
Moeda	wage_setting.job_assignments.hourly_rate.currency	string	A moeda.
Quantidade	wage_setting.job_assignments.annual_rate.amount	integer	O valor.
Moeda	wage_setting.job_assignments.annual_rate.currency	string	A moeda.
Horas Semanais	wage_setting.job_assignments.weekly_hours	integer	As horas planejadas por semana para o trabalho. Defina se o paytype do trabalho for SALARY.
Isenção de horas extras	wage_setting.is_overtime_exempt	boolean	Se o membro da equipe está isento das regras de horas extras do país do vendedor.
Versão	wage_setting.version	integer	A versão atual deste objeto.
Criado em	wage_setting.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	wage_setting.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Atualizar configuração da semana de trabalho

ID da operação:: LaborUpdateConfig

Atualiza um WorkweekConfig.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.
Início da Semana	start_of_week		string	O dia da semana em que uma semana comercial termina para fins de compensação.
Hora local do início do dia	start_of_day_local_time		string	A hora local em que uma semana comercial termina. Representado como uma cadeia de caracteres no formato HH:MM (HH:MM:SS também é aceito, mas segundos são truncados).
Versão	version		integer	A versão atual deste objeto.

Retornos

Nome	Caminho	Tipo	Description
ID	workweek_config.id	string	O identificador exclusivo emitido por Quadrado.
Início da Semana	workweek_config.start_of_week	string	O dia da semana em que uma semana comercial termina para fins de compensação.
Hora local do início do dia	workweek_config.start_of_day_local_time	string	A hora local em que uma semana comercial termina. Representado como uma cadeia de caracteres no formato HH:MM (HH:MM:SS também é aceito, mas segundos são truncados).
Versão	workweek_config.version	integer	A versão atual deste objeto.
Criado em	workweek_config.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	workweek_config.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Atualizar membro da equipe

ID da operação:: TeamUpdate

Atualiza um único objeto TeamMember.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do membro da equipe	team_member_id	True	string	O identificador do membro da equipe.
ID de Referência	reference_id		string	Uma ID de referência opcional definida pelo usuário.
Situação	status		string	O status de verificação atual desse objeto.
Nome	given_name		string	O nome fornecido (ou seja, primeiro) associado ao perfil do cliente.
Sobrenome	family_name		string	O nome da família (ou seja, sobrenome) associado ao perfil do cliente.
Endereço de Email	email_address		string	O endereço de email associado ao perfil do cliente.
Número de Telefone	phone_number		string	O número de telefone de 11 dígitos associado ao perfil do cliente.
IDs de localização	location_ids		array of string
Tipo de atribuição	assignment_type		string	O tipo de atribuição atual do membro da equipe.

Retornos

Nome	Caminho	Tipo	Description
ID	team_member.id	string	O identificador exclusivo emitido por Quadrado.
ID de Referência	team_member.reference_id	string	Uma ID de referência opcional definida pelo usuário.
É Proprietário	team_member.is_owner	boolean	Se o membro da equipe é o proprietário da conta square.
Situação	team_member.status	string	O status de verificação atual desse objeto.
Nome	team_member.given_name	string	O nome fornecido (ou seja, primeiro) associado ao perfil do cliente.
Sobrenome	team_member.family_name	string	O nome da família (ou seja, sobrenome) associado ao perfil do cliente.
Endereço de Email	team_member.email_address	string	O endereço de email associado ao perfil do cliente.
Número de Telefone	team_member.phone_number	string	O número de telefone de 11 dígitos associado ao perfil do cliente.
Criado em	team_member.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Tipo de atribuição	team_member.assigned_locations.assignment_type	string	O tipo de atribuição atual do membro da equipe.
IDs de localização	team_member.assigned_locations.location_ids	array of string

Calcular pontos de fidelidade

ID da operação:: LoyaltyCalculatePoints

Calcula os pontos que uma compra ganha. Um aplicativo pode chamar esse ponto de extremidade para mostrar os pontos que um comprador pode ganhar com a compra específica.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do programa	program_id	True	string	O identificador do programa.
ID do pedido	order_id		string	O identificador da ordem.

Retornos

Nome	Caminho	Tipo	Description
Pontos	points	integer	Os pontos que o comprador pode ganhar com uma compra especificada.

Criar atividade de cartão-presente (Beta)

ID da operação:: GiftCardCreate

Cria uma atividade de cartão presente.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
ID do cartão presente	gift_card_id	string	A ID do cartão de presente. A ID não será necessária se uma GAN estiver presente.
Tipo	type	string	O tipo desse objeto.
ID do Local	location_id	string	O identificador do local.
ID do pedido	order_id	string	A ID da ordem associada à atividade.
UID do item de linha	line_item_uid	string	O line_item_uid do item de linha do cartão presente em uma ordem.

Retornos

Nome	Caminho	Tipo	Description
ID	gift_card_activity.id	string	O identificador exclusivo emitido por Quadrado.
ID do cartão presente	gift_card_activity.gift_card_id	string	A ID do cartão de presente. A ID não será necessária se uma GAN estiver presente.
GAN de cartão-presente	gift_card_activity.gift_card_gan	string	O cartão-presente GAN. A GAN não será necessária se gift_card_id estiver presente.
Tipo	gift_card_activity.type	string	O tipo desse objeto.
Quantidade	gift_card_activity.gift_card_balance_money.amount	integer	O valor.
Moeda	gift_card_activity.gift_card_balance_money.currency	string	A moeda.
ID do Local	gift_card_activity.location_id	string	O identificador do local.
Criado em	gift_card_activity.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Quantidade	gift_card_activity.activate_activity_details.amount_money.amount	integer	O valor.
Moeda	gift_card_activity.activate_activity_details.amount_money.currency	string	A moeda.
ID do pedido	gift_card_activity.activate_activity_details.order_id	string	A ID da ordem associada à atividade.
UID do item de linha	gift_card_activity.activate_activity_details.line_item_uid	string	O line_item_uid do item de linha do cartão presente em uma ordem.

Criar check-out

ID da operação:: CheckoutCreate

Vincula um checkoutId a um checkout_page_url para o qual os clientes são direcionados para fornecer suas informações de pagamento usando um fluxo de trabalho de processamento de pagamento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Local	location_id	True	string	O identificador do local.
Chave de Idempotency	idempotency_key		string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
URL de redirecionamento	redirect_url		string	Por exemplo, se a URL de redirecionamento fornecida for `http://www.example.com/order-complete`, uma transação bem-sucedida redirecionará o cliente para: `http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` Se você não fornecer uma URL de redirecionamento, o Square Checkout exibirá uma página de confirmação do pedido em seu nome; no entanto, é altamente recomendável que você forneça uma URL de redirecionamento para que você possa verificar os resultados da transação e finalizar o pedido por meio do fluxo de trabalho de confirmação existente/normal.
Chave de Idempotency	idempotency_key		string	Um valor que você especifica que identifica exclusivamente essa ordem entre os pedidos que você criou. Se você não tiver certeza se uma ordem específica foi criada com êxito, poderá tentar novamente com a mesma chave de idempobilidade sem se preocupar em criar pedidos duplicados.
ID do Local	location_id		string	A expressão de consulta a ser pesquisada por disponibilidades correspondentes às IDs de localização do vendedor especificadas.
ID do cliente	customer_id		string	A ID do cliente associado ao pedido.
ID de Referência	reference_id		string	Uma ID especificada pelo cliente para associar uma entidade em outro sistema a essa ordem.
Nome	name		string	O nome do item.
Quantidade	quantity		string	A quantidade adquirida, formatada como um número decimal. Os itens de linha com uma quantidade de 0 são removidos automaticamente ao pagar ou concluir o pedido.
Quantidade	amount		integer	O valor.
Moeda	currency		string	A moeda.
UID de desconto	discount_uid		string	A UID do desconto que o desconto aplicado representa. Ele deve fazer referência a um desconto presente no campo order.discounts. Esse campo é imutável. Para alterar quais descontos se aplicam a um item de linha, você deve excluir o desconto e adicioná-lo novamente como uma nova OrderLineItemAppliedDiscount.
UID fiscal	tax_uid		string	A UID do imposto para o qual esse imposto aplicado representa. Ele deve fazer referência a um imposto presente no campo order.tax. Esse campo é imutável. Para alterar quais impostos se aplicam a um item de linha, exclua e adicione um novo OrderLineItemAppliedTax.
UID	uid		string	Uma ID exclusiva.
Tipo	type		string	O tipo desse objeto.
Porcentagem	percentage		string	O percentual do imposto, como uma representação de cadeia de caracteres de um número decimal.
Scope	scope		string	Indica o nível no qual o objeto se aplica.
UID	uid		string	Uma ID exclusiva.
Tipo	type		string	O tipo desse objeto.
Scope	scope		string	Indica o nível no qual o objeto se aplica.
Quantidade	amount		integer	O valor.
Moeda	currency		string	A moeda.
ID do Local	location_id		string	O identificador do local.
Description	title		string	A descrição.
Quantidade	amount		integer	O valor.
Moeda	currency		string	A moeda.
Solicitar endereço de envio	ask_for_shipping_address		boolean	Se for true, o Square Checkout coletará informações de envio em seu nome e armazenará essas informações com as informações da transação no Painel do Square Seller.
Email de Suporte do Comerciante	merchant_support_email		string	O endereço de email a ser exibido na página de confirmação do Square Checkout e no email de confirmação que o comprador pode usar para entrar em contato com o vendedor. Se esse valor não estiver definido, a página de confirmação e o email exibirão o endereço de email primário associado à conta Quadrada do vendedor.
Pré-popular email do comprador	pre_populate_buyer_email		string	Se fornecido, o email do comprador será pré-preenchido na página de check-out como um campo de texto editável.
Linha de endereço 1	address_line_1		string	A primeira linha do endereço.
Linha de endereço 2	address_line_2		string	A segunda linha do endereço, se houver.
Localidade	locality		string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	administrative_district_level_1		string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	postal_code		string	O código postal do endereço.
País	country		string	O código de país ISO 3166 Alpha-2.
Primeiro Nome	first_name		string	Nome opcional ao representar o destinatário.
Apelido	last_name		string	Sobrenome opcional ao representar o destinatário.

Retornos

Nome	Caminho	Tipo	Description
ID	checkout.id	string	O identificador exclusivo emitido por Quadrado.
URL da Página de Check-out	checkout.checkout_page_url	string	A URL para a qual o navegador do comprador deve ser redirecionado após a conclusão do check-out.
Solicitar endereço de envio	checkout.ask_for_shipping_address	boolean	Se for true, o Square Checkout coletará informações de envio em seu nome e armazenará essas informações com as informações de transação em seu Painel Quadrado.
Email de Suporte do Comerciante	checkout.merchant_support_email	string	O endereço de email a ser exibido na página de confirmação do Square Checkout e no email de confirmação que o comprador pode usar para entrar em contato com o comerciante.
Pré-popular email do comprador	checkout.pre_populate_buyer_email	string	Se fornecido, o email do comprador será preenchido previamente na página de check-out como um campo de texto editável.
Linha de endereço 1	checkout.pre_populate_shipping_address.address_line_1	string	A primeira linha do endereço. Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Linha de endereço 2	checkout.pre_populate_shipping_address.address_line_2	string	A segunda linha do endereço, se houver.
Localidade	checkout.pre_populate_shipping_address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	checkout.pre_populate_shipping_address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	checkout.pre_populate_shipping_address.postal_code	string	O código postal do endereço.
País	checkout.pre_populate_shipping_address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Primeiro Nome	checkout.pre_populate_shipping_address.first_name	string	Nome opcional ao representar o destinatário.
Apelido	checkout.pre_populate_shipping_address.last_name	string	Nome lsat opcional quando ele está representando o destinatário.
URL de redirecionamento	checkout.redirect_url	string	A URL para a qual redirecionar após a conclusão do check-out com checkoutId, orderId, transactionId e referenceId da Square acrescentadas como parâmetros de URL. Por exemplo, se o redirect_url fornecido for `http://www.example.com/order-complete`, uma transação bem-sucedida redirecionará o cliente para: `http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx` Se você não fornecer uma URL de redirecionamento, o Square Checkout exibirá uma página de confirmação do pedido em seu nome; no entanto, o Square recomenda fortemente que você forneça uma URL de redirecionamento para que você possa verificar os resultados da transação e finalizar o pedido por meio do fluxo de trabalho de confirmação existente/normal.
ID do Local	checkout.order.location_id	string	A expressão de consulta a ser pesquisada por disponibilidades correspondentes às IDs de localização do vendedor especificadas.
ID do cliente	checkout.order.customer_id	string	A ID do cliente associado ao pedido.
ID de Referência	checkout.order.reference_id	string	Uma ID especificada pelo cliente para associar uma entidade em outro sistema a essa ordem.
Itens de Linha	checkout.order.line_items	array of object
Nome	checkout.order.line_items.name	string	O nome do item de linha.
Quantidade	checkout.order.line_items.quantity	string	A quantidade adquirida, formatada como um número decimal. Os itens de linha com uma quantidade de 0 são removidos automaticamente ao pagar ou concluir o pedido.
Impostos Aplicados	checkout.order.line_items.applied_taxes	array of object
UID fiscal	checkout.order.line_items.applied_taxes.tax_uid	string	A UID do imposto para o qual esse imposto aplicado representa. Ele deve fazer referência a um imposto presente no campo order.tax. Esse campo é imutável. Para alterar quais impostos se aplicam a um item de linha, exclua e adicione um novo OrderLineItemAppliedTax.
Quantidade	checkout.order.line_items.applied_taxes.applied_money.amount	integer	A quantidade de dinheiro, na menor denominação da moeda indicada pela moeda. Por exemplo, quando a moeda é USD, o valor está em centavos. Os valores monetários podem ser positivos ou negativos. Consulte a descrição de campo específica para determinar o significado do sinal em um caso específico.
Moeda	checkout.order.line_items.applied_taxes.applied_money.currency	string	O tipo de moeda, no formato ISO 4217. Por exemplo, o código de moeda para dólares americanos é USD.
Descontos aplicados	checkout.order.line_items.applied_discounts	array of object
UID de desconto	checkout.order.line_items.applied_discounts.discount_uid	string	A UID do desconto que o desconto aplicado representa. Ele deve fazer referência a um desconto presente no campo order.discounts. Esse campo é imutável. Para alterar quais descontos se aplicam a um item de linha, você deve excluir o desconto e adicioná-lo novamente como uma nova OrderLineItemAppliedDiscount.
Quantidade	checkout.order.line_items.applied_discounts.applied_money.amount	integer	A quantidade de dinheiro, na menor denominação da moeda indicada pela moeda. Por exemplo, quando a moeda é USD, o valor está em centavos. Os valores monetários podem ser positivos ou negativos. Consulte a descrição de campo específica para determinar o significado do sinal em um caso específico.
Moeda	checkout.order.line_items.applied_discounts.applied_money.currency	string	O tipo de moeda, no formato ISO 4217. Por exemplo, o código de moeda para dólares americanos é USD.
Quantidade	checkout.order.line_items.base_price_money.amount	integer	O valor.
Moeda	checkout.order.line_items.base_price_money.currency	string	A moeda.
Quantidade	checkout.order.line_items.total_tax_money.amount	integer	O valor.
Moeda	checkout.order.line_items.total_tax_money.currency	string	A moeda.
Quantidade	checkout.order.line_items.total_discount_money.amount	integer	O valor.
Moeda	checkout.order.line_items.total_discount_money.currency	string	A moeda.
Quantidade	checkout.order.line_items.total_money.amount	integer	O valor.
Moeda	checkout.order.line_items.total_money.currency	string	A moeda.
Impostos	checkout.order.taxes	array of object
UID	checkout.order.taxes.uid	string	Uma ID exclusiva.
Tipo	checkout.order.taxes.type	string	O tipo desse objeto.
Porcentagem	checkout.order.taxes.percentage	string	O percentual do imposto, como uma representação de cadeia de caracteres de um número decimal.
Scope	checkout.order.taxes.scope	string	Indica o nível no qual o objeto se aplica.
Descontos	checkout.order.discounts	array of object
UID	checkout.order.discounts.uid	string	Uma ID exclusiva.
Tipo	checkout.order.discounts.type	string	O tipo desse objeto.
Scope	checkout.order.discounts.scope	string	Indica o nível no qual o objeto se aplica.
Quantidade	checkout.order.discounts.amount_money.amount	integer	O valor.
Moeda	checkout.order.discounts.amount_money.currency	string	A moeda.
Quantidade	checkout.order.discounts.applied_money.amount	integer	O valor.
Moeda	checkout.order.discounts.applied_money.currency	string	A moeda.
Quantidade	checkout.order.total_money.amount	integer	O valor.
Moeda	checkout.order.total_money.currency	string	A moeda.
Quantidade	checkout.order.total_tax_money.amount	integer	O valor.
Moeda	checkout.order.total_tax_money.currency	string	A moeda.
Quantidade	checkout.order.total_discount_money.amount	integer	O valor.
Moeda	checkout.order.total_discount_money.currency	string	A moeda.
Criado em	checkout.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Versão	checkout.version	integer	A versão atual deste objeto.
Destinatários adicionais	checkout.additional_recipients	array of object
ID do Local	checkout.additional_recipients.location_id	string	A ID do local de um destinatário (diferente do comerciante) recebendo uma parte desta licitação.
Description	checkout.additional_recipients.title	string	A descrição do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu tamanho de valor é de pontos de código Unicode.
Quantidade	checkout.additional_recipients.amount_money.amount	integer	O valor.
Moeda	checkout.additional_recipients.amount_money.currency	string	A moeda.

Criar conta de fidelidade

ID da operação:: LoyaltyCreateAccount

Cria uma conta de fidelidade.

Parâmetros

Nome	Chave	Tipo	Description
Número de Telefone	phone_number	string	O número de telefone do destinatário.
ID do programa	program_id	string	A ID atribuída por quadrado do programa.
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).

Retornos

Nome	Caminho	Tipo	Description
ID	loyalty_account.id	string	O identificador exclusivo emitido por Quadrado.
ID	loyalty_account.mapping.id	string	A ID atribuída ao Quadrado.
Número de Telefone	loyalty_account.mapping.phone_number	string	O número de telefone do destinatário.
Criado em	loyalty_account.mapping.created_at	string	O carimbo de data/hora quando criado, no formato RFC 3339.
ID do programa	loyalty_account.program_id	string	A ID atribuída por quadrado do programa.
Saldo	loyalty_account.balance	integer	O saldo disponível.
Pontos de tempo de vida	loyalty_account.lifetime_points	integer	O total de pontos acumulados durante o tempo de vida da conta.
Criado em	loyalty_account.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	loyalty_account.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Criar código de autorização móvel

ID da operação:: MobileAuthorizationCreate

Gera código para autorizar um aplicativo móvel a se conectar a um leitor de cartão Square. Os códigos de autorização são de uso único e expiram 60 minutos após a emissão.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Local	location_id		string	O identificador de local.

Retornos

Nome	Caminho	Tipo	Description
Código de autorização	authorization_code	string	Código de autorização gerado que conecta uma instância de aplicativo móvel a uma conta do Square.
Expira em	expires_at	string	O carimbo de data/hora quando authorization_code expira no formato RFC 3339.

Criar código do dispositivo

ID da operação:: DeviceCreate

Cria um DeviceCode que pode ser usado para fazer logon em um dispositivo do Terminal Quadrado para entrar no modo de terminal conectado.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
Nome	name	string	O nome do objeto.
ID do Local	location_id	string	O identificador do local.
Tipo de Produto	product_type	string	O tipo de produto de destino do código do dispositivo.

Retornos

Nome	Caminho	Tipo	Description
ID	device_code.id	string	O identificador exclusivo emitido por Quadrado.
Nome	device_code.name	string	O nome do objeto.
Code	device_code.code	string	O código exclusivo que pode ser usado para fazer logon.
Tipo de Produto	device_code.product_type	string	O tipo de produto de destino do código do dispositivo.
ID do Local	device_code.location_id	string	O identificador do local.
Criado em	device_code.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Emparelhar por	device_code.pair_by	string	Quando este DeviceCode expirar e não for mais logon. Carimbo de data/hora no formato RFC 3339.
Situação	device_code.status	string	O status de verificação atual desse objeto.
Status alterado em	device_code.status_changed_at	string	Quando o status deste DeviceCode foi alterado pela última vez. Carimbo de data/hora no formato RFC 3339.

Criar local (Beta)

ID da operação:: LocationCreate

Cria um local.

Parâmetros

Nome	Chave	Tipo	Description
Nome	name	string	O nome do objeto.
Description	description	string	A descrição.
Facebook URL	facebook_url	string	A URL do perfil do Facebook do local. A URL deve começar com 'facebook.com/'.
Linha de endereço 1	address_line_1	string	A primeira linha do endereço. Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Nível 1 do Distrito Administrativo	administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Localidade	locality	string	A cidade ou a cidade do endereço.
Código postal	postal_code	string	O código postal do endereço.

Retornos

Nome	Caminho	Tipo	Description
ID	location.id	string	O identificador exclusivo emitido por Quadrado.
Nome	location.name	string	O nome do objeto.
Linha de endereço 1	location.address.address_line_1	string	A primeira linha do endereço. Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Localidade	location.address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	location.address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	location.address.postal_code	string	O código postal do endereço.
Capabilities	location.capabilities	array of string
Situação	location.status	string	O status de verificação atual desse objeto.
Criado em	location.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
ID do Comerciante	location.merchant_id	string	A ID do comerciante.
País	location.country	string	O código de país ISO 3166 Alpha-2.
Código de idioma	location.language_code	string	O código de idioma, no formato BCP 47.
Moeda	location.currency	string	O código de moeda ISO 4217 de 3 caracteres.
Tipo	location.type	string	O tipo desse objeto.
Description	location.description	string	A descrição.
URL do site	location.website_url	string	A URL do site do local.
Nome de usuário do Twitter	location.twitter_username	string	O nome de usuário do Twitter do local sem o símbolo '@'.
Nome de usuário do Instagram	location.instagram_username	string	O nome de usuário do Instagram do local sem o símbolo '@'.
Latitude	location.coordinates.latitude	float	A latitude da coordenada expressa em graus.
Longitude	location.coordinates.longitude	float	A longitude da coordenada expressa em graus.
MCC	location.mcc	string	O MCC (código de categoria do comerciante) do local, conforme padronizado pela ISO 18245. O MCC descreve o tipo de bens ou serviços vendidos no local.

Criar membro da equipe

ID da operação:: TeamCreateMember

Cria um único objeto TeamMember.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
ID de Referência	reference_id	string	Uma ID de referência opcional definida pelo usuário.
Situação	status	string	O status de verificação atual desse objeto.
Nome	given_name	string	O nome fornecido (ou seja, primeiro) associado ao perfil do cliente.
Sobrenome	family_name	string	O nome da família (ou seja, sobrenome) associado ao perfil do cliente.
Endereço de Email	email_address	string	O endereço de email associado ao perfil do cliente.
Número de Telefone	phone_number	string	O número de telefone de 11 dígitos associado ao perfil do cliente.
IDs de localização	location_ids	array of string
Tipo de atribuição	assignment_type	string	O tipo de atribuição atual do membro da equipe.

Retornos

Nome	Caminho	Tipo	Description
ID	team_member.id	string	O identificador exclusivo emitido por Quadrado.
ID de Referência	team_member.reference_id	string	Uma ID de referência opcional definida pelo usuário.
É Proprietário	team_member.is_owner	boolean	Se o membro da equipe é o proprietário da conta square.
Situação	team_member.status	string	O status de verificação atual desse objeto.
Nome	team_member.given_name	string	O nome fornecido (ou seja, primeiro) associado ao perfil do cliente.
Sobrenome	team_member.family_name	string	O nome da família (ou seja, sobrenome) associado ao perfil do cliente.
Endereço de Email	team_member.email_address	string	O endereço de email associado ao perfil do cliente.
Número de Telefone	team_member.phone_number	string	O número de telefone de 11 dígitos associado ao perfil do cliente.
Tipo de atribuição	team_member.assigned_locations.assignment_type	string	O tipo de atribuição atual do membro da equipe.
IDs de localização	team_member.assigned_locations.location_ids	array of string

Criar membros da equipe em massa

ID da operação:: TeamCreateBulkMembers

Cria vários objetos TeamMember.

Parâmetros

Nome	Chave	Tipo	Description
Nome	given_name	string	O nome fornecido (ou seja, o nome) associado ao membro da equipe.
Sobrenome	family_name	string	O nome da família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de Email	email_address	string	O endereço de email associado ao membro da equipe.
ID de Referência	reference_id	string	Uma segunda ID usada para associar o membro da equipe a uma entidade em outro sistema.
Número de Telefone	phone_number	string	O número de telefone do membro da equipe, no formato E.164.
IDs de localização	location_ids	array of string
Tipo de atribuição	assignment_type	string	O tipo de atribuição atual do membro da equipe.
Nome	given_name	string	O nome fornecido (ou seja, o nome) associado ao membro da equipe.
Sobrenome	family_name	string	O nome da família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de Email	email_address	string	O endereço de email associado ao membro da equipe.
ID de Referência	reference_id	string	Uma segunda ID usada para associar o membro da equipe a uma entidade em outro sistema.
Número de Telefone	phone_number	string	O número de telefone do membro da equipe, no formato E.164.
Tipo de atribuição	assignment_type	string	O tipo de atribuição atual do membro da equipe.

Retornos

Nome	Caminho	Tipo	Description
ID	team_members.idempotency-key-1.team_member.id	string	Um identificador para fazer referência a esse objeto.
ID de Referência	team_members.idempotency-key-1.team_member.reference_id	string	Uma segunda ID usada para associar o membro da equipe a uma entidade em outro sistema.
É Proprietário	team_members.idempotency-key-1.team_member.is_owner	boolean	Se o membro da equipe é o proprietário da conta square.
Situação	team_members.idempotency-key-1.team_member.status	string	Descreve o status do membro da equipe.
Nome	team_members.idempotency-key-1.team_member.given_name	string	O nome fornecido (ou seja, o nome) associado ao membro da equipe.
Sobrenome	team_members.idempotency-key-1.team_member.family_name	string	O nome da família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de Email	team_members.idempotency-key-1.team_member.email_address	string	O endereço de email associado ao membro da equipe.
Número de Telefone	team_members.idempotency-key-1.team_member.phone_number	string	O número de telefone do membro da equipe, no formato E.164.
Tipo de atribuição	team_members.idempotency-key-1.team_member.assigned_locations.assignment_type	string	O tipo de atribuição atual do membro da equipe.
IDs de localização	team_members.idempotency-key-1.team_member.assigned_locations.location_ids	array of string
ID	team_members.idempotency-key-2.team_member.id	string	Um identificador para fazer referência a esse objeto.
ID de Referência	team_members.idempotency-key-2.team_member.reference_id	string	Uma segunda ID usada para associar o membro da equipe a uma entidade em outro sistema.
É Proprietário	team_members.idempotency-key-2.team_member.is_owner	boolean	Se o membro da equipe é o proprietário da conta square.
Situação	team_members.idempotency-key-2.team_member.status	string	Descreve o status do membro da equipe.
Nome	team_members.idempotency-key-2.team_member.given_name	string	O nome fornecido (ou seja, o nome) associado ao membro da equipe.
Sobrenome	team_members.idempotency-key-2.team_member.family_name	string	O nome da família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de Email	team_members.idempotency-key-2.team_member.email_address	string	O endereço de email associado ao membro da equipe.
Número de Telefone	team_members.idempotency-key-2.team_member.phone_number	string	O número de telefone do membro da equipe, no formato E.164.
Tipo de atribuição	team_members.idempotency-key-2.team_member.assigned_locations.assignment_type	string	O tipo de atribuição atual do membro da equipe.

Criar recompensa de fidelidade

ID da operação:: LoyaltyCreateReward

Cria uma recompensa de lealdade. Depois que uma recompensa é criada, os pontos são bloqueados e não estão disponíveis para o comprador resgatar outra recompensa.

Parâmetros

Nome	Chave	Tipo	Description
ID da conta de fidelidade	loyalty_account_id	string	A ID da conta de fidelidade na qual o evento ocorreu.
ID da Camada de Recompensa	reward_tier_id	string	A ID atribuída por quadrado da camada de recompensa usada para criar a recompensa.
ID do pedido	order_id	string	A ID da ordem.
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).

Retornos

Nome	Caminho	Tipo	Description
ID	reward.id	string	O identificador exclusivo emitido por Quadrado.
Situação	reward.status	string	O status de verificação atual desse objeto.
ID da conta de fidelidade	reward.loyalty_account_id	string	A ID da conta de fidelidade na qual o evento ocorreu.
ID da Camada de Recompensa	reward.reward_tier_id	string	A ID atribuída por quadrado da camada de recompensa usada para criar a recompensa.
Pontos	reward.points	integer	O número de pontos adicionados ou removidos.
ID do pedido	reward.order_id	string	A ID da ordem.
Criado em	reward.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	reward.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Criar reserva (Beta)

ID da operação:: BookingCreate

Cria uma reserva.

Parâmetros

Nome	Chave	Tipo	Description
ID do cliente	customer_id	string	A ID desse objeto que representa o cliente.
Iniciar em	start_at	string	O carimbo de data/hora que especifica a hora de início deste objeto, no formato RFC 3339.
ID do Local	location_id	string	O identificador do local.
Minutos de Duração	duration_minutes	integer	O intervalo de tempo em minutos de um segmento de compromisso.
ID do membro da equipe	team_member_id	string	A ID do objeto TeamMember que representa o membro da equipe reservado neste segmento.
ID da Variação de Serviço	service_variation_id	string	A ID do objeto CatalogItemVariation que representa o serviço reservado neste segmento.
Versão da Variação de Serviço	service_variation_version	integer	A versão atual da variação do item que representa o serviço reservado neste segmento.

Retornos

Nome	Caminho	Tipo	Description
ID	booking.id	string	O identificador exclusivo emitido por Quadrado.
Versão	booking.version	integer	A versão atual deste objeto.
Situação	booking.status	string	O status de verificação atual desse objeto.
Criado em	booking.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	booking.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
ID do Local	booking.location_id	string	O identificador do local.
ID do cliente	booking.customer_id	string	A ID desse objeto que representa o cliente.
Observação do cliente	booking.customer_note	string	O campo de texto livre para o cliente fornecer anotações sobre a reserva.
Nota do Vendedor	booking.seller_note	string	O campo de texto livre para o vendedor fornecer anotações sobre a reserva.
Iniciar em	booking.start_at	string	O carimbo de data/hora que especifica a hora de início deste objeto, no formato RFC 3339.
Segmento de compromisso	booking.appointment_segments	array of object
Minutos de Duração	booking.appointment_segments.duration_minutes	integer	O intervalo de tempo em minutos de um segmento de compromisso.
ID da Variação de Serviço	booking.appointment_segments.service_variation_id	string	A ID do objeto CatalogItemVariation que representa o serviço reservado neste segmento.
ID do membro da equipe	booking.appointment_segments.team_member_id	string	A ID do objeto TeamMember que representa o membro da equipe reservado neste segmento.
Versão da Variação de Serviço	booking.appointment_segments.service_variation_version	integer	A versão atual da variação do item que representa o serviço reservado neste segmento.
Errors	errors	array of

Criar tipo de interrupção

ID da operação:: LaborCreateBreak

Cria um novo BreakType. Um BreakType é um modelo para criar objetos Break.

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
ID do Local	location_id	string	O identificador do local.
Nome da Interrupção	break_name	string	Um nome legível para esse tipo de interrupção. O nome é exibido para funcionários em produtos Square.
Duração esperada	expected_duration	string	O comprimento esperado desta quebra. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precisão inferior a minutos é truncada.
É Pago	is_paid	boolean	Se essa quebra conta para o tempo trabalhado para fins de compensação.

Retornos

Nome	Caminho	Tipo	Description
ID	break_type.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	break_type.location_id	string	O identificador do local.
Nome da Interrupção	break_type.break_name	string	Um nome legível para esse tipo de interrupção. O nome é exibido para funcionários em produtos Square.
Duração esperada	break_type.expected_duration	string	O comprimento esperado desta quebra. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precisão inferior a minutos é truncada.
É Pago	break_type.is_paid	boolean	Se essa quebra conta para o tempo trabalhado para fins de compensação.
Versão	break_type.version	integer	A versão atual deste objeto.
Criado em	break_type.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	break_type.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Criar turno

ID da operação:: LaborCreateShift

Cria um novo Shift. Um Shift representa um dia de trabalho completo para um único funcionário

Parâmetros

Nome	Chave	Tipo	Description
Chave de Idempotency	idempotency_key	string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
ID do membro da equipe	team_member_id	string	A ID do membro da equipe.
ID do Local	location_id	string	O identificador do local.
Iniciar em	start_at	string	O carimbo de data/hora que especifica a hora de início deste objeto, no formato RFC 3339.
Terminar em	end_at	string	RFC 3339; mudou para o fuso horário + deslocamento. A precisão até o minuto é respeitada; segundos são truncados.
Title	title	string	O nome do trabalho executado durante esse turno. UIs de relatório de mão-de-obra quadradas podem agrupar turnos por título.
Quantidade	amount	integer	O valor.
Moeda	currency	string	A moeda.
Iniciar em	start_at	string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até o minuto é respeitada; segundos são truncados.
Terminar em	end_at	string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até o minuto é respeitada; segundos são truncados.
ID do tipo de interrupção	break_type_id	string	O BreakType no qual esta quebra foi modelo.
Nome	name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Duração esperada	expected_duration	string	O comprimento esperado da quebra. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
É Pago	is_paid	boolean	Se essa quebra conta para o tempo trabalhado para fins de compensação.

Retornos

Nome	Caminho	Tipo	Description
ID	shift.id	string	O identificador exclusivo emitido por Quadrado.
ID do membro da equipe	shift.team_member_id	string	A ID do membro da equipe.
ID do Funcionário	shift.employee_id	string	A ID gerada por quadrado do Funcionário.
ID do Local	shift.location_id	string	O identificador do local.
Timezone	shift.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Iniciar em	shift.start_at	string	O carimbo de data/hora que especifica a hora de início deste objeto, no formato RFC 3339.
Terminar em	shift.end_at	string	RFC 3339; mudou para o fuso horário + deslocamento. A precisão até o minuto é respeitada; segundos são truncados.
Title	shift.wage.title	string	O nome do trabalho executado durante esse turno. UIs de relatório de mão-de-obra quadradas podem agrupar turnos por título.
Quantidade	shift.wage.hourly_rate.amount	integer	O valor.
Moeda	shift.wage.hourly_rate.currency	string	A moeda.
Quebra	shift.breaks	array of object
ID	shift.breaks.id	string	O identificador do objeto
Iniciar em	shift.breaks.start_at	string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até o minuto é respeitada; segundos são truncados.
Terminar em	shift.breaks.end_at	string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até o minuto é respeitada; segundos são truncados.
ID do tipo de interrupção	shift.breaks.break_type_id	string	O BreakType no qual esta quebra foi modelo.
Nome	shift.breaks.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Duração esperada	shift.breaks.expected_duration	string	O comprimento esperado da quebra. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
É Pago	shift.breaks.is_paid	boolean	Se essa quebra conta para o tempo trabalhado para fins de compensação.
Situação	shift.status	string	O status de verificação atual desse objeto.
Versão	shift.version	integer	A versão atual deste objeto.
Criado em	shift.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	shift.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Desvincular o cliente do cartão-presente (Beta)

ID da operação:: GiftCardUnlink

Desvincula um cliente de um cartão-presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do cartão presente	gift_card_id	True	string	O identificador do cartão presente.
ID do cliente	customer_id		string	A ID do cliente a ser vinculado.

Retornos

Nome	Caminho	Tipo	Description
ID	gift_card.id	string	O identificador exclusivo emitido por Quadrado.
Tipo	gift_card.type	string	O tipo desse objeto.
Origem DE GAN	gift_card.gan_source	string	Indica se o GAN (número da conta do cartão-presente) é gerado pelo Square ou importado de um sistema não Quadrado.
Estado	gift_card.state	string	O estado atual.
Quantidade	gift_card.balance_money.amount	integer	O valor.
Moeda	gift_card.balance_money.currency	string	A moeda.
Gan	gift_card.gan	string	O número da conta do cartão presente.
Criado em	gift_card.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.

Disponibilidade de pesquisa (Beta)

ID da operação:: BookingAvailability

Procura disponibilidades para reserva.

Parâmetros

Nome	Chave	Tipo	Description
Iniciar em	start_at	string	Um valor de datetime no formato RFC 3339 que indica quando o intervalo de tempo é iniciado.
Terminar em	end_at	string	Um valor de datetime no formato RFC 3339 que indica quando o intervalo de tempo termina.
ID do Local	location_id	string	A expressão de consulta a ser pesquisada por disponibilidades correspondentes às IDs de localização do vendedor especificadas.
ID da Variação de Serviço	service_variation_id	string	A ID do CatalogItemVariation que representa o serviço reservado neste segmento.
Qualquer	any	array of string

Retornos

Nome	Caminho	Tipo	Description
Disponibilidades	availabilities	array of object
Iniciar em	availabilities.start_at	string	O carimbo de data/hora RFC 3339 especificando a hora inicial do slot disponível.
ID do Local	availabilities.location_id	string	O identificador do local.
Segmentos de compromisso	availabilities.appointment_segments	array of object
Minutos de Duração	availabilities.appointment_segments.duration_minutes	integer	O intervalo de tempo em minutos de um segmento de compromisso.
ID do membro da equipe	availabilities.appointment_segments.team_member_id	string	A ID do objeto TeamMember que representa o membro da equipe reservado neste segmento.
ID da Variação de Serviço	availabilities.appointment_segments.service_variation_id	string	A ID do objeto CatalogItemVariation que representa o serviço reservado neste segmento.
Versão da Variação de Serviço	availabilities.appointment_segments.service_variation_version	integer	A versão atual da variação do item que representa o serviço reservado neste segmento.
Errors	errors	array of

Excluir recompensa de fidelidade

ID da operação:: LoyaltyDeleteReward

Exclui uma recompensa de fidelidade. Retorna os pontos de fidelidade de volta para a conta de fidelidade. Você não pode excluir uma recompensa que atingiu o estado do terminal (REDEEMED).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de recompensa	reward_id	True	string	O identificador da recompensa.

Retornos

response: object

Excluir snippet

ID da operação:: SnippetDelete

Remove o snippet de código de um site do Square Online.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Site	site_id	True	string	O identificador do site.

Retornos

response: object

Excluir tipo de interrupção

ID da operação:: LaborDeleteBreak

Exclui um BreakType existente. Um BreakType pode ser excluído mesmo se for referenciado de um Shift.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.

Retornos

response: object

Excluir turno

ID da operação:: LaborDeleteShift

Exclui um turno

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.

Retornos

response: object

Listar atividades de cartão-presente (Beta)

ID da operação:: GiftCardList

Lista atividades de cartão-presente. Por padrão, você obtém atividades de cartão presente para todos os cartões-presente na conta do vendedor. Opcionalmente, você pode especificar parâmetros de consulta para filtrar a lista. Por exemplo, você pode obter uma lista de atividades de cartão presente para um cartão presente, para todos os cartões-presente em uma região específica ou para atividades em uma janela de tempo.

Parâmetros

Nome	Chave	Tipo	Description
ID do cartão presente	gift_card_id	string	Se você fornecer uma ID de cartão presente, o ponto de extremidade retornará atividades que pertencem ao cartão presente especificado. Caso contrário, o ponto de extremidade retornará todas as atividades de cartão-presente para o vendedor.
Tipo	type	string	Se você fornecer um tipo, o ponto de extremidade retornará atividades de cartão presente desse tipo. Caso contrário, o ponto de extremidade retornará todos os tipos de atividades de cartão presente.
ID do Local	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.
Hora de Início	begin_time	string	A hora de início inclusiva da consulta em opened_at, no formato ISO 8601.
Hora de Término	end_time	string	A data de término exclusiva da consulta em opened_at, no formato ISO 8601.
Limit	limit	integer	Limite superior no número a ser retornado na resposta.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.
Ordem de Classificação	sort_order	string	Classifica a lista retornada quando o cartão foi criado com a ordem especificada.

Retornos

Nome	Caminho	Tipo	Description
Atividades de cartão-presente	gift_card_activities	array of object
ID	gift_card_activities.id	string	O identificador exclusivo emitido por Quadrado.
Tipo	gift_card_activities.type	string	O tipo desse objeto.
ID do Local	gift_card_activities.location_id	string	O identificador do local.
Criado em	gift_card_activities.created_at	string	A hora do evento no formato ISO 8601.
ID do cartão presente	gift_card_activities.gift_card_id	string	A ID do cartão de presente. A ID não será necessária se uma GAN estiver presente.
GAN de cartão-presente	gift_card_activities.gift_card_gan	string	O cartão-presente GAN. A GAN não será necessária se gift_card_id estiver presente.
Quantidade	gift_card_activities.gift_card_balance_money.amount	integer	O valor.
Moeda	gift_card_activities.gift_card_balance_money.currency	string	A moeda.
Quantidade	gift_card_activities.redeem_activity_details.amount_money.amount	integer	O valor.
Moeda	gift_card_activities.redeem_activity_details.amount_money.currency	string	A moeda.
Quantidade	gift_card_activities.activate_activity_details.amount_money.amount	integer	O valor.
Moeda	gift_card_activities.activate_activity_details.amount_money.currency	string	A moeda.
ID do pedido	gift_card_activities.activate_activity_details.order_id	string	A ID da ordem associada à atividade.
UID do item de linha	gift_card_activities.activate_activity_details.line_item_uid	string	O line_item_uid do item de linha do cartão presente em uma ordem.

Listar comerciantes

ID da operação:: MerchantList

Retorna informações do Comerciante para um determinado token de acesso.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Cursor	cursor		integer	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.

Retornos

Nome	Caminho	Tipo	Description
Comerciante	merchant	array of object
ID	merchant.id	string	O identificador exclusivo emitido por Quadrado.
Nome comercial	merchant.business_name	string	O nome comercial do local Esse é o nome visível para os clientes do local. Por exemplo, esse nome aparece nos recibos do cliente.
País	merchant.country	string	O código de país ISO 3166 Alpha-2.
Código de idioma	merchant.language_code	string	O idioma associado ao local, no formato BCP 47.
Moeda	merchant.currency	string	O código de moeda ISO 4217 de 3 caracteres.
Situação	merchant.status	string	O status de verificação atual desse objeto.
ID da localização principal	merchant.main_location_id	string	A ID da localização principal deste comerciante.

Listar configurações da semana de trabalho

ID da operação:: LaborListConfigs

Retorna uma lista de instâncias WorkweekConfig para uma empresa.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Limit	limit		integer	Limite superior no número a ser retornado na resposta.
Cursor	cursor		string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.

Retornos

Nome	Caminho	Tipo	Description
Configurações da semana de trabalho	workweek_configs	array of object
ID	workweek_configs.id	string	O identificador exclusivo emitido por Quadrado.
Início da Semana	workweek_configs.start_of_week	string	O dia da semana em que uma semana comercial termina para fins de compensação.
Hora local do início do dia	workweek_configs.start_of_day_local_time	string	A hora local em que uma semana comercial termina. Representado como uma cadeia de caracteres no formato HH:MM (HH:MM:SS também é aceito, mas segundos são truncados).
Versão	workweek_configs.version	integer	A versão atual do objeto.
Criado em	workweek_configs.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	workweek_configs.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para esse ponto de extremidade para recuperar o próximo conjunto de resultados associados à consulta original.

Listar contas bancárias

ID da operação:: BankAccountList

Retorna uma lista de objetos BankAccount vinculados a uma conta Square.

Parâmetros

Nome	Chave	Tipo	Description
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.
Limit	limit	integer	Limite superior no número a ser retornado na resposta.
ID do Local	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.

Retornos

Nome	Caminho	Tipo	Description
Conta bancária	bank_accounts	array of object
ID	bank_accounts.id	string	O identificador exclusivo emitido por Quadrado.
Sufixo número da conta	bank_accounts.account_number_suffix	string	Os últimos dígitos do número da conta.
País	bank_accounts.country	string	O código de país ISO 3166 Alpha-2.
Moeda	bank_accounts.currency	string	O código de moeda ISO 4217 de 3 caracteres.
Tipo de conta	bank_accounts.account_type	string	A finalidade financeira da conta bancária associada.
Nome do Titular	bank_accounts.holder_name	string	Nome do titular da conta. Esse nome deve corresponder ao nome no registro de conta bancária de destino.
Número de identificação do banco primário	bank_accounts.primary_bank_identification_number	string	Identificador primário do banco.
ID do Local	bank_accounts.location_id	string	O identificador do local.
Situação	bank_accounts.status	string	O status de verificação atual desse objeto.
Meritório	bank_accounts.creditable	boolean	Indica se é possível para a Square enviar dinheiro para essa conta bancária.
Debitável	bank_accounts.debitable	boolean	Indica se é possível para a Square enviar dinheiro para essa conta bancária.
Versão	bank_accounts.version	integer	A versão atual do objeto.
Nome do banco	bank_accounts.bank_name	string	Nome da instituição financeira real.

Listar códigos do dispositivo

ID da operação:: DeviceList

Lista todos os DeviceCodes associados ao comerciante.

Parâmetros

Nome	Chave	Tipo	Description
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.
ID do Local	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.
Tipo de Produto	product_type	string	Se especificado, retorna apenas DeviceCodes direcionados ao tipo de produto especificado. Retorna DeviceCodes de todos os tipos de produto se estiver vazio.
Situação	status	string	Se especificado, retorna apenas objetos que correspondem aos status especificados.

Retornos

Nome	Caminho	Tipo	Description
Códigos do dispositivo	device_codes	array of object
ID	device_codes.id	string	O identificador exclusivo emitido por Quadrado.
Nome	device_codes.name	string	O nome do objeto.
Code	device_codes.code	string	O código exclusivo que pode ser usado para fazer logon.
Tipo de Produto	device_codes.product_type	string	O tipo de produto de destino do código do dispositivo.
ID do Local	device_codes.location_id	string	O identificador do local.
Criado em	device_codes.created_at	string	A hora do evento no formato ISO 8601.
Emparelhar por	device_codes.pair_by	string	Quando este DeviceCode expirar e não for mais logon. Carimbo de data/hora no formato RFC 3339.
Situação	device_codes.status	string	O status de verificação atual desse objeto.
ID do dispositivo	device_codes.device_id	string	A ID exclusiva do dispositivo que usou esse código. Populado quando o dispositivo é emparelhado.
Status alterado em	device_codes.status_changed_at	string	Quando o status deste DeviceCode foi alterado pela última vez. Carimbo de data/hora no formato RFC 3339.

Listar eventos de turno de gaveta de dinheiro

ID da operação:: CashDrawerListEvents

Fornece uma lista paginada de eventos para um único turno de gaveta de dinheiro.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do turno	shift_id	True	string	O identificador da mudança.
ID do Local	location_id	True	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.
Limit	limit		integer	Limite superior no número a ser retornado na resposta.
Cursor	cursor		string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.

Retornos

Nome	Caminho	Tipo	Description
Eventos	events	array of object
ID	events.id	string	O identificador exclusivo emitido por Quadrado.
Tipo de evento	events.event_type	string	O tipo de evento de turno de gaveta de dinheiro.
Quantidade	events.event_money.amount	integer	O valor.
Moeda	events.event_money.currency	string	A moeda.
Criado em	events.created_at	string	A hora do evento no formato ISO 8601.
Description	events.title	string	A descrição.

Listar locais

ID da operação:: LocationList

Fornece informações de todos os locais de uma empresa.

Retornos

Nome	Caminho	Tipo	Description
Localizações	locations	array of object
ID	locations.id	string	O identificador exclusivo emitido por Quadrado.
Nome	locations.name	string	O nome do objeto.
Linha de endereço 1	locations.address.address_line_1	string	A primeira linha do endereço.
Localidade	locations.address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	locations.address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	locations.address.postal_code	string	O código postal do endereço.
País	locations.address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Timezone	locations.timezone	string	O fuso horário usado para interpretar datas de calendário na fatura, como due_date. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Capabilities	locations.capabilities	array of string
Situação	locations.status	string	O status de verificação atual desse objeto.
Criado em	locations.created_at	string	A hora do evento no formato ISO 8601.
ID do Comerciante	locations.merchant_id	string	A ID do comerciante que possui a localização.
País	locations.country	string	O código de país ISO 3166 Alpha-2.
Código de idioma	locations.language_code	string	O idioma associado ao local, no formato BCP 47.
Moeda	locations.currency	string	O código de moeda ISO 4217 de 3 caracteres.
Número de Telefone	locations.phone_number	string	O número de telefone de 11 dígitos associado ao perfil do cliente.
Nome comercial	locations.business_name	string	O nome comercial do local Esse é o nome visível para os clientes do local. Por exemplo, esse nome aparece nos recibos do cliente.

Listar os salários dos membros da equipe

ID da operação:: LaborListWages

Retorna uma lista paginada de instâncias de TeamMemberWage para uma empresa.

Parâmetros

Nome	Chave	Tipo	Description
ID do membro da equipe	team_member_id	string	Filtre os salários retornados somente para aqueles associados ao membro da equipe especificado.
Limit	limit	integer	Limite superior no número a ser retornado na resposta.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.

Retornos

Nome	Caminho	Tipo	Description
Salários dos membros da equipe	team_member_wages	array of object
ID	team_member_wages.id	string	O identificador exclusivo emitido por Quadrado.
ID do membro da equipe	team_member_wages.team_member_id	string	A ID do objeto TeamMember para o membro da equipe associado ao objeto.
Title	team_member_wages.title	string	O título da fatura.
Quantidade	team_member_wages.hourly_rate.amount	integer	O valor.
Moeda	team_member_wages.hourly_rate.currency	string	A moeda.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para esse ponto de extremidade para recuperar o próximo conjunto de resultados associados à consulta original.

Listar perfis de reserva de membros da equipe (Beta)

ID da operação:: BookingListTeamProfiles

Lista perfis de reserva para membros da equipe.

Parâmetros

Nome	Chave	Tipo	Description
Somente bookable	bookable_only	boolean	Indica se deve incluir apenas os membros da equipe bookable no resultado retornado (true) ou não (false).
Limit	limit	integer	Limite superior no número a ser retornado na resposta.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.
ID do Local	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.

Retornos

Nome	Caminho	Tipo	Description
Perfis de reserva de membro da equipe	team_member_booking_profiles	array of object
ID do membro da equipe	team_member_booking_profiles.team_member_id	string	A ID do objeto TeamMember para o membro da equipe associado ao objeto.
Nome de Exibição	team_member_booking_profiles.display_name	string	O nome de exibição do membro da equipe.
É bookable	team_member_booking_profiles.is_bookable	boolean	Indica se o membro da equipe pode ser reservado por meio da API do Bookings ou do canal ou site de reserva online do vendedor (true) ou não (falso).
Errors	errors	array of

Listar sites

ID da operação:: SiteList

Lista os sites do Square Online que pertencem a um vendedor.

Retornos

Nome	Caminho	Tipo	Description
Sites	sites	array of object
ID	sites.id	string	O identificador exclusivo emitido por Quadrado.
Título do Site	sites.site_title	string	O título do site.
Domínio	sites.domain	string	O domínio do site (sem o protocolo).
É Publicado	sites.is_published	boolean	Indica se o site foi publicado.
Criado em	sites.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	sites.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339

Listar turnos de gaveta de dinheiro

ID da operação:: CashDrawerListShifts

Fornece os detalhes de todos os turnos de gaveta de dinheiro para um local em um intervalo de datas.

Parâmetros

Nome	Chave	Tipo	Description
ID do Local	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.
Ordem de Classificação	sort_order	string	Classifica a lista retornada quando o cartão foi criado com a ordem especificada.
Hora de Início	begin_time	string	A hora de início inclusiva da consulta em opened_at, no formato ISO 8601.
Hora de Término	end_time	string	A data de término exclusiva da consulta em opened_at, no formato ISO 8601.
Limit	limit	integer	Limite superior no número a ser retornado na resposta.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.

Retornos

Nome	Caminho	Tipo	Description
Itens	items	array of object
ID	items.id	string	O identificador exclusivo emitido por Quadrado.
Estado	items.state	string	O estado atual.
Aberto em	items.opened_at	string	A hora de início do turno no formato ISO 8601.
Terminou em	items.ended_at	string	A hora de término do turno no formato ISO 8601.
Fechado em	items.closed_at	string	A hora de fechamento da mudança no formato ISO 8601.
Description	items.title	string	A descrição.
Quantidade	items.opened_cash_money.amount	integer	O valor.
Moeda	items.opened_cash_money.currency	string	A moeda.
Quantidade	items.expected_cash_money.amount	integer	O valor.
Moeda	items.expected_cash_money.currency	string	A moeda.
Quantidade	items.closed_cash_money.amount	integer	O valor.
Moeda	items.closed_cash_money.currency	string	A moeda.

Local da atualização (Beta)

ID da operação:: LocationUpdate

Atualiza um local.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Local	location_id	True	string	O identificador do local.
Nome	name		string	O nome do objeto.
Description	description		string	A descrição.
Facebook URL	facebook_url		string	A URL do perfil do Facebook do local. A URL deve começar com 'facebook.com/'.
Nome de usuário do Twitter	twitter_username		string	O nome de usuário do Twitter do local sem o símbolo '@'.
Nome de usuário do Instagram	instagram_username		string	O nome de usuário do Instagram do local sem o símbolo '@'.
Linha de endereço 1	address_line_1		string	A primeira linha do endereço. Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Nível 1 do Distrito Administrativo	administrative_district_level_1		string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Localidade	locality		string	A cidade ou a cidade do endereço.
Código postal	postal_code		string	O código postal do endereço.
Dia da Semana	day_of_week		string	O dia da semana para esse período de tempo.
Iniciar hora local	start_local_time		string	A hora de início de um período de horário comercial, especificado no horário local usando o formato RFC 3339 em tempo parcial.
Hora de Término local	end_local_time		string	A hora de término de um período de horário comercial, especificado no horário local usando o formato RFC 3339 em tempo parcial.

Retornos

Nome	Caminho	Tipo	Description
ID	location.id	string	O identificador exclusivo emitido por Quadrado.
Nome	location.name	string	O nome do objeto.
Linha de endereço 1	location.address.address_line_1	string	A primeira linha do endereço. Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Localidade	location.address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	location.address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	location.address.postal_code	string	O código postal do endereço.
Timezone	location.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Capabilities	location.capabilities	array of string
Situação	location.status	string	O status de verificação atual desse objeto.
Criado em	location.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
ID do Comerciante	location.merchant_id	string	A ID do comerciante.
País	location.country	string	O código de país ISO 3166 Alpha-2.
Código de idioma	location.language_code	string	O código de idioma, no formato BCP 47.
Moeda	location.currency	string	O código de moeda ISO 4217 de 3 caracteres.
Número de Telefone	location.phone_number	string	O número de telefone de 11 dígitos associado ao perfil do cliente.
Nome comercial	location.business_name	string	O nome comercial do local Esse é o nome visível para os clientes do local. Por exemplo, esse nome aparece nos recibos do cliente.
Tipo	location.type	string	O tipo desse objeto.
URL do site	location.website_url	string	A URL do site do local.
Períodos	location.business_hours.periods	array of object
Dia da Semana	location.business_hours.periods.day_of_week	string	O dia da semana para esse período de tempo.
Iniciar hora local	location.business_hours.periods.start_local_time	string	A hora de início de um período de horário comercial, especificado no horário local usando o formato RFC 3339 em tempo parcial.
Hora de Término local	location.business_hours.periods.end_local_time	string	A hora de término de um período de horário comercial, especificado no horário local usando o formato RFC 3339 em tempo parcial.
Email comercial	location.business_email	string	O email do local. Esse email é visível para os clientes do local. Por exemplo, o email é exibido nos recibos dos clientes.
Description	location.description	string	A descrição.
Nome de usuário do Twitter	location.twitter_username	string	O nome de usuário do Twitter do local sem o símbolo '@'.
Nome de usuário do Instagram	location.instagram_username	string	O nome de usuário do Instagram do local sem o símbolo '@'.
Latitude	location.coordinates.latitude	float	A latitude da coordenada expressa em graus.
Longitude	location.coordinates.longitude	float	A longitude da coordenada expressa em graus.
MCC	location.mcc	string	O MCC (código de categoria do comerciante) do local, conforme padronizado pela ISO 18245. O MCC descreve o tipo de bens ou serviços vendidos no local.

Membros da equipe de atualização em massa

ID da operação:: TeamUpdateBulkMembers

Atualiza vários objetos TeamMember.

Parâmetros

Nome	Chave	Tipo	Description
ID de Referência	reference_id	string	Uma segunda ID usada para associar o membro da equipe a uma entidade em outro sistema.
É Proprietário	is_owner	boolean	Se o membro da equipe é o proprietário da conta square.
Situação	status	string	Descreve o status do membro da equipe.
Nome	given_name	string	O nome fornecido (ou seja, o nome) associado ao membro da equipe.
Sobrenome	family_name	string	O nome da família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de Email	email_address	string	O endereço de email associado ao membro da equipe.
Número de Telefone	phone_number	string	O número de telefone do membro da equipe, no formato E.164.
IDs de localização	location_ids	array of string
Tipo de atribuição	assignment_type	string	O tipo de atribuição atual do membro da equipe.
ID de Referência	reference_id	string	Uma segunda ID usada para associar o membro da equipe a uma entidade em outro sistema.
É Proprietário	is_owner	boolean	Se o membro da equipe é o proprietário da conta square.
Situação	status	string	Descreve o status do membro da equipe.
Nome	given_name	string	O nome fornecido (ou seja, o nome) associado ao membro da equipe.
Sobrenome	family_name	string	O nome da família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de Email	email_address	string	O endereço de email associado ao membro da equipe.
Número de Telefone	phone_number	string	O número de telefone do membro da equipe, no formato E.164.
Tipo de atribuição	assignment_type	string	O tipo de atribuição atual do membro da equipe.

Retornos

Nome	Caminho	Tipo	Description
ID	team_members.team_member_id.team_member.id	string	Um identificador para fazer referência a esse objeto.
ID de Referência	team_members.team_member_id.team_member.reference_id	string	Uma segunda ID usada para associar o membro da equipe a uma entidade em outro sistema.
É Proprietário	team_members.team_member_id.team_member.is_owner	boolean	Se o membro da equipe é o proprietário da conta square.
Situação	team_members.team_member_id.team_member.status	string	Descreve o status do membro da equipe.
Nome	team_members.team_member_id.team_member.given_name	string	O nome fornecido (ou seja, o nome) associado ao membro da equipe.
Sobrenome	team_members.team_member_id.team_member.family_name	string	O nome da família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de Email	team_members.team_member_id.team_member.email_address	string	O endereço de email associado ao membro da equipe.
Número de Telefone	team_members.team_member_id.team_member.phone_number	string	O número de telefone do membro da equipe, no formato E.164.
Criado em	team_members.team_member_id.team_member.created_at	string	O carimbo de data/hora, no formato RFC 3339, descrevendo quando o membro da equipe foi criado
Tipo de atribuição	team_members.team_member_id.team_member.assigned_locations.assignment_type	string	O tipo de atribuição atual do membro da equipe.
IDs de localização	team_members.team_member_id.team_member.assigned_locations.location_ids	array of string

Membros da equipe de pesquisa

ID da operação:: TeamSearch

Retorna uma lista paginada de objetos TeamMember para uma empresa.

Parâmetros

Nome	Chave	Tipo	Description
IDs de localização	location_ids	array of string
Situação	status	string	O status atual.
Limit	limit	integer	Um limite no número de resultados a serem retornados em uma única página. O limite é consultivo – a implementação pode retornar mais ou menos resultados. Se o limite fornecido for negativo, zero ou for maior que o limite máximo de 1.000, ele será ignorado.

Retornos

Nome	Caminho	Tipo	Description
Membros da Equipe	team_members	array of object
ID	team_members.id	string	O identificador exclusivo emitido por Quadrado.
ID de Referência	team_members.reference_id	string	Uma segunda ID opcional usada para associar o perfil do cliente a uma entidade em outro sistema.
É Proprietário	team_members.is_owner	boolean	Se o membro da equipe é o proprietário da conta square.
Situação	team_members.status	string	O status de verificação atual desse objeto.
Nome	team_members.given_name	string	O nome fornecido (ou seja, primeiro) associado ao perfil do cliente.
Sobrenome	team_members.family_name	string	O nome da família (ou seja, sobrenome) associado ao perfil do cliente.
Endereço de Email	team_members.email_address	string	O endereço de email associado ao perfil do cliente.
Criado em	team_members.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	team_members.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Tipo de atribuição	team_members.assigned_locations.assignment_type	string	O tipo de atribuição atual do membro da equipe.
Número de Telefone	team_members.phone_number	string	O número de telefone de 11 dígitos associado ao perfil do cliente.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para esse ponto de extremidade para recuperar o próximo conjunto de resultados associados à consulta original.

Mudança de atualização

ID da operação:: LaborUpdateShift

Atualiza um Shift existente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.
ID do membro da equipe	team_member_id		string	A ID do membro da equipe.
ID do Local	location_id		string	O identificador do local.
Iniciar em	start_at		string	O carimbo de data/hora que especifica a hora de início deste objeto, no formato RFC 3339.
Terminar em	end_at		string	RFC 3339; mudou para o fuso horário + deslocamento. A precisão até o minuto é respeitada; segundos são truncados.
Title	title		string	O nome do trabalho executado durante esse turno. UIs de relatório de mão-de-obra quadradas podem agrupar turnos por título.
Quantidade	amount		integer	O valor.
Moeda	currency		string	A moeda.
ID	id		string	O identificador do objeto
Iniciar em	start_at		string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até o minuto é respeitada; segundos são truncados.
Terminar em	end_at		string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até o minuto é respeitada; segundos são truncados.
ID do tipo de interrupção	break_type_id		string	O BreakType no qual esta quebra foi modelo.
Nome	name		string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Duração esperada	expected_duration		string	O comprimento esperado da quebra. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
É Pago	is_paid		boolean	Se essa quebra conta para o tempo trabalhado para fins de compensação.
Versão	version		integer	A versão atual deste objeto.

Retornos

Nome	Caminho	Tipo	Description
ID	shift.id	string	O identificador exclusivo emitido por Quadrado.
ID do membro da equipe	shift.team_member_id	string	A ID do membro da equipe.
ID do Funcionário	shift.employee_id	string	A ID gerada por quadrado do Funcionário.
ID do Local	shift.location_id	string	O identificador do local.
Timezone	shift.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Iniciar em	shift.start_at	string	O carimbo de data/hora que especifica a hora de início deste objeto, no formato RFC 3339.
Terminar em	shift.end_at	string	RFC 3339; mudou para o fuso horário + deslocamento. A precisão até o minuto é respeitada; segundos são truncados.
Title	shift.wage.title	string	O nome do trabalho executado durante esse turno. UIs de relatório de mão-de-obra quadradas podem agrupar turnos por título.
Quantidade	shift.wage.hourly_rate.amount	integer	O valor.
Moeda	shift.wage.hourly_rate.currency	string	A moeda.
Quebra	shift.breaks	array of object
ID	shift.breaks.id	string	O identificador do objeto
Iniciar em	shift.breaks.start_at	string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até o minuto é respeitada; segundos são truncados.
Terminar em	shift.breaks.end_at	string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até o minuto é respeitada; segundos são truncados.
ID do tipo de interrupção	shift.breaks.break_type_id	string	O BreakType no qual esta quebra foi modelo.
Nome	shift.breaks.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Duração esperada	shift.breaks.expected_duration	string	O comprimento esperado da quebra. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
É Pago	shift.breaks.is_paid	boolean	Se essa quebra conta para o tempo trabalhado para fins de compensação.
Situação	shift.status	string	O status de verificação atual desse objeto.
Versão	shift.version	integer	A versão atual deste objeto.
Criado em	shift.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	shift.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Obter conta bancária

ID da operação:: BankAccountGet

Retorna detalhes de um BankAccount vinculado a uma conta Square.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da conta bancária	bank_account_id	True	string	ID emitida por quadrado do BankAccount desejado.

Retornos

Nome	Caminho	Tipo	Description
ID	bank_account.id	string	O identificador exclusivo emitido por Quadrado.
Sufixo número da conta	bank_account.account_number_suffix	string	Os últimos dígitos do número da conta.
País	bank_account.country	string	O código de país ISO 3166 Alpha-2.
Moeda	bank_account.currency	string	O código de moeda ISO 4217 de 3 caracteres.
Tipo de conta	bank_account.account_type	string	O tipo da conta.
Nome do Titular	bank_account.holder_name	string	Nome do titular da conta.
Número de identificação do banco primário	bank_account.primary_bank_identification_number	string	Identificador primário do banco.
ID do Local	bank_account.location_id	string	O identificador do local.
Situação	bank_account.status	string	O status de verificação atual desse objeto.
Meritório	bank_account.creditable	boolean	Indica se é possível que a Square envie dinheiro para essa conta.
Debitável	bank_account.debitable	boolean	Indica se é possível para a Square tirar dinheiro dessa conta.
Versão	bank_account.version	integer	A versão atual deste objeto.
Nome do banco	bank_account.bank_name	string	Nome da instituição financeira real.

Obter conta bancária por ID da V1

ID da operação:: BankAccountGetV1

Retorna detalhes de um BankAccount identificado pela ID da conta bancária V1.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da conta bancária V1	v1_bank_account_id	True	string	Conecte a ID V1 do BankAccount desejado.

Retornos

Nome	Caminho	Tipo	Description
ID	bank_account.id	string	O identificador exclusivo emitido por Quadrado.
Sufixo número da conta	bank_account.account_number_suffix	string	Os últimos dígitos do número da conta.
País	bank_account.country	string	O código de país ISO 3166 Alpha-2.
Moeda	bank_account.currency	string	O código de moeda ISO 4217 de 3 caracteres.
Tipo de conta	bank_account.account_type	string	O tipo da conta.
Nome do Titular	bank_account.holder_name	string	Nome do titular da conta.
Número de identificação do banco primário	bank_account.primary_bank_identification_number	string	Identificador primário do banco.
ID do Local	bank_account.location_id	string	O identificador do local.
Situação	bank_account.status	string	O status de verificação atual desse objeto.
Meritório	bank_account.creditable	boolean	Indica se é possível que a Square envie dinheiro para essa conta.
Debitável	bank_account.debitable	boolean	Indica se é possível para a Square tirar dinheiro dessa conta.
Versão	bank_account.version	integer	A versão atual deste objeto.
Nome do banco	bank_account.bank_name	string	Nome da instituição financeira real.

Obter código do dispositivo

ID da operação:: DeviceGet

Recupera DeviceCode com a ID associada.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.

Retornos

Nome	Caminho	Tipo	Description
ID	device_code.id	string	O identificador exclusivo emitido por Quadrado.
Nome	device_code.name	string	O nome do objeto.
Code	device_code.code	string	O código exclusivo que pode ser usado para fazer logon.
Tipo de Produto	device_code.product_type	string	O tipo de produto de destino do código do dispositivo.
ID do Local	device_code.location_id	string	O identificador do local.
Criado em	device_code.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Emparelhar por	device_code.pair_by	string	Quando este DeviceCode expirar e não for mais logon. Carimbo de data/hora no formato RFC 3339.
Situação	device_code.status	string	O status de verificação atual desse objeto.
ID do dispositivo	device_code.device_id	string	A ID do dispositivo.
Status alterado em	device_code.status_changed_at	string	Quando o status deste DeviceCode foi alterado pela última vez. Carimbo de data/hora no formato RFC 3339.

Obter salário de membro da equipe

ID da operação:: LaborGetWage

Retorna um único TeamMemberWage especificado pela ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.

Retornos

Nome	Caminho	Tipo	Description
ID	team_member_wage.id	string	O identificador exclusivo emitido por Quadrado.
ID do membro da equipe	team_member_wage.team_member_id	string	A ID do membro da equipe.
Title	team_member_wage.title	string	O título.
Quantidade	team_member_wage.hourly_rate.amount	integer	O valor.
Moeda	team_member_wage.hourly_rate.currency	string	A moeda.

Obter tipo de interrupção

ID da operação:: LaborGetBreak

Retorna um único BreakType especificado pela ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.

Retornos

Nome	Caminho	Tipo	Description
ID	break_type.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	break_type.location_id	string	O identificador do local.
Nome da Interrupção	break_type.break_name	string	Um nome legível para esse tipo de interrupção. O nome é exibido para funcionários em produtos Square.
Duração esperada	break_type.expected_duration	string	O comprimento esperado desta quebra. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precisão inferior a minutos é truncada.
É Pago	break_type.is_paid	boolean	Se essa quebra conta para o tempo trabalhado para fins de compensação.
Versão	break_type.version	integer	A versão atual deste objeto.
Criado em	break_type.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	break_type.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Obter turno

ID da operação:: LaborGetShift

Retorna um único Shift especificado pela ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.

Retornos

Nome	Caminho	Tipo	Description
ID	shift.id	string	O identificador exclusivo emitido por Quadrado.
ID do membro da equipe	shift.team_member_id	string	A ID do membro da equipe.
ID do Funcionário	shift.employee_id	string	A ID gerada por quadrado do Funcionário.
ID do Local	shift.location_id	string	O identificador do local.
Timezone	shift.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Iniciar em	shift.start_at	string	O carimbo de data/hora que especifica a hora de início deste objeto, no formato RFC 3339.
Terminar em	shift.end_at	string	RFC 3339; mudou para o fuso horário + deslocamento. A precisão até o minuto é respeitada; segundos são truncados.
Title	shift.wage.title	string	O nome do trabalho executado durante esse turno. UIs de relatório de mão-de-obra quadradas podem agrupar turnos por título.
Quantidade	shift.wage.hourly_rate.amount	integer	O valor.
Moeda	shift.wage.hourly_rate.currency	string	A moeda.
Quebra	shift.breaks	array of object
ID	shift.breaks.id	string	O identificador do objeto
Iniciar em	shift.breaks.start_at	string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até o minuto é respeitada; segundos são truncados.
Terminar em	shift.breaks.end_at	string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até o minuto é respeitada; segundos são truncados.
ID do tipo de interrupção	shift.breaks.break_type_id	string	O BreakType no qual esta quebra foi modelo.
Nome	shift.breaks.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Duração esperada	shift.breaks.expected_duration	string	O comprimento esperado da quebra. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
É Pago	shift.breaks.is_paid	boolean	Se essa quebra conta para o tempo trabalhado para fins de compensação.
Situação	shift.status	string	O status de verificação atual desse objeto.
Versão	shift.version	integer	A versão atual deste objeto.
Criado em	shift.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	shift.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Pesquisar contas de fidelidade

ID da operação:: LoyaltySearchAccounts

Pesquisa contas de fidelidade em um programa de fidelidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Limit	limit		integer	Um limite no número de resultados a serem retornados em uma única página. O limite é consultivo – a implementação pode retornar mais ou menos resultados. Se o limite fornecido for negativo, zero ou for maior que o limite máximo de 1.000, ele será ignorado.

Retornos

Nome	Caminho	Tipo	Description
Contas de fidelidade	loyalty_accounts	array of object
ID	loyalty_accounts.id	string	O identificador exclusivo emitido por Quadrado.
ID	loyalty_accounts.mapping.id	string	O identificador do objeto
Número de Telefone	loyalty_accounts.mapping.phone_number	string	O número de telefone do destinatário.
Criado em	loyalty_accounts.mapping.created_at	string	O carimbo de data/hora quando criado, no formato RFC 3339.
ID do programa	loyalty_accounts.program_id	string	A ID atribuída por Quadrado do programa de fidelidade ao qual a conta pertence.
Saldo	loyalty_accounts.balance	integer	O saldo de pontos disponível na conta de fidelidade.
Pontos de tempo de vida	loyalty_accounts.lifetime_points	integer	O total de pontos acumulados durante o tempo de vida da conta.
ID do cliente	loyalty_accounts.customer_id	string	A ID atribuída por Quadrado do cliente associado à conta.
Criado em	loyalty_accounts.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	loyalty_accounts.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para esse ponto de extremidade para recuperar o próximo conjunto de resultados associados à consulta original.

Pesquisar eventos de fidelidade

ID da operação:: LoyaltySearchEvents

Pesquisa eventos de fidelidade. Um programa de fidelidade Square mantém um razão de eventos que ocorrem durante o tempo de vida da conta de fidelidade de um comprador. Cada alteração no saldo de pontos (por exemplo, pontos ganhos, pontos resgatados e pontos expirados) é registrada no razão. Usando esse ponto de extremidade, você pode pesquisar eventos no razão.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do pedido	order_id		string	O identificador da ordem.
Limit	limit		integer	Um limite no número de resultados a serem retornados em uma única página. O limite é consultivo – a implementação pode retornar mais ou menos resultados. Se o limite fornecido for negativo, zero ou for maior que o limite máximo de 1.000, ele será ignorado.

Retornos

Nome	Caminho	Tipo	Description
Eventos	events	array of object
ID	events.id	string	O identificador exclusivo emitido por Quadrado.
Tipo	events.type	string	O tipo desse objeto.
Criado em	events.created_at	string	A hora do evento no formato ISO 8601.
ID do programa de fidelidade	events.accumulate_points.loyalty_program_id	string	A ID do programa de fidelidade
Pontos	events.accumulate_points.points	integer	O número de pontos acumulados pelo evento.
ID do pedido	events.accumulate_points.order_id	string	A ID da ordem associada à atividade.
ID da conta de fidelidade	events.loyalty_account_id	string	A ID da conta de fidelidade na qual o evento ocorreu.
ID do Local	events.location_id	string	O identificador do local.
Source	events.source	string	Define se o evento foi gerado pelo Ponto de Venda Quadrado.
ID do programa de fidelidade	events.redeem_reward.loyalty_program_id	string	A ID do programa de fidelidade
ID de recompensa	events.redeem_reward.reward_id	string	A ID da recompensa de lealdade redimida.
ID do pedido	events.redeem_reward.order_id	string	A ID da ordem associada à atividade.
ID do programa de fidelidade	events.create_reward.loyalty_program_id	string	A ID do programa de fidelidade
ID de recompensa	events.create_reward.reward_id	string	A ID da recompensa de lealdade redimida.
Pontos	events.create_reward.points	integer	O número de pontos acumulados pelo evento.

Pesquisar recompensas de fidelidade

ID da operação:: LoyaltySearchRewards

Procura recompensas de fidelidade em uma conta de fidelidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da conta de fidelidade	loyalty_account_id		string	A ID da conta de fidelidade na qual o evento ocorreu.
Limit	limit		integer	Um limite no número de resultados a serem retornados em uma única página. O limite é consultivo – a implementação pode retornar mais ou menos resultados. Se o limite fornecido for negativo, zero ou for maior que o limite máximo de 1.000, ele será ignorado.

Retornos

Nome	Caminho	Tipo	Description
Recompensas	rewards	array of object
ID	rewards.id	string	O identificador exclusivo emitido por Quadrado.
Situação	rewards.status	string	O status de verificação atual desse objeto.
ID da conta de fidelidade	rewards.loyalty_account_id	string	A ID da conta de fidelidade na qual o evento ocorreu.
ID da Camada de Recompensa	rewards.reward_tier_id	string	A ID atribuída por quadrado da camada de recompensa usada para criar a recompensa.
Pontos	rewards.points	integer	O número de pontos de fidelidade usados para a recompensa.
ID do pedido	rewards.order_id	string	A ID da ordem.
Criado em	rewards.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	rewards.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Resgatado em	rewards.redeemed_at	string	O carimbo de data/hora quando a recompensa foi resgatada, no formato RFC 3339.

Recuperar a configuração salarial

ID da operação:: TeamRetrieveWage

Recupera um objeto WageSetting para um membro da equipe especificado pela ID do TeamMember.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do membro da equipe	team_member_id	True	string	O identificador do membro da equipe.

Retornos

Nome	Caminho	Tipo	Description
ID do membro da equipe	wage_setting.team_member_id	string	A ID do membro da equipe.
Atribuições de Trabalho	wage_setting.job_assignments	array of object
Cargo	wage_setting.job_assignments.job_title	string	O título do trabalho.
Tipo de pagamento	wage_setting.job_assignments.pay_type	string	O tipo de pagamento atual da atribuição de trabalho usada para calcular o valor de pagamento em um período de pagamento.
Quantidade	wage_setting.job_assignments.hourly_rate.amount	integer	O valor.
Moeda	wage_setting.job_assignments.hourly_rate.currency	string	A moeda.
Quantidade	wage_setting.job_assignments.annual_rate.amount	integer	O valor.
Moeda	wage_setting.job_assignments.annual_rate.currency	string	A moeda.
Horas Semanais	wage_setting.job_assignments.weekly_hours	integer	As horas planejadas por semana para o trabalho. Defina se o paytype do trabalho for SALARY.
Isenção de horas extras	wage_setting.is_overtime_exempt	boolean	Se o membro da equipe está isento das regras de horas extras do país do vendedor.
Versão	wage_setting.version	integer	A versão atual deste objeto.
Criado em	wage_setting.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	wage_setting.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Recuperar cartão-presente (Beta)

ID da operação:: GiftCardRetrieve

Recupera um cartão presente usando sua ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.

Retornos

Nome	Caminho	Tipo	Description
ID	gift_card.id	string	O identificador exclusivo emitido por Quadrado.
Tipo	gift_card.type	string	O tipo desse objeto.
Origem DE GAN	gift_card.gan_source	string	Indica se o GAN (número da conta do cartão-presente) é gerado pelo Square ou importado de um sistema não Quadrado.
Estado	gift_card.state	string	O estado atual.
Quantidade	gift_card.balance_money.amount	integer	O valor.
Moeda	gift_card.balance_money.currency	string	A moeda.
Gan	gift_card.gan	string	O número da conta do cartão presente.
Criado em	gift_card.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.

Recuperar cartão-presente do GAN (Beta)

ID da operação:: GiftCardRetrieveGAN

Recupera um cartão presente usando o número da conta do cartão presente (GAN).

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Gan	gan		string	O número da conta do cartão presente.

Retornos

Nome	Caminho	Tipo	Description
ID	gift_card.id	string	O identificador exclusivo emitido por Quadrado.
Tipo	gift_card.type	string	O tipo desse objeto.
Origem DE GAN	gift_card.gan_source	string	Indica se o GAN (número da conta do cartão-presente) é gerado pelo Square ou importado de um sistema não Quadrado.
Estado	gift_card.state	string	O estado atual.
Quantidade	gift_card.balance_money.amount	integer	O valor.
Moeda	gift_card.balance_money.currency	string	A moeda.
Gan	gift_card.gan	string	O número da conta do cartão presente.
Criado em	gift_card.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.

Recuperar cartão-presente do nonce (Beta)

ID da operação:: GiftCardRetrieveNonce

Recupera um cartão presente usando um nonce (um token seguro) que representa o cartão presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nonce	nonce		string	O nonce do cartão presente a ser recuperado.

Retornos

Nome	Caminho	Tipo	Description
ID	gift_card.id	string	O identificador exclusivo emitido por Quadrado.
Tipo	gift_card.type	string	O tipo desse objeto.
Origem DE GAN	gift_card.gan_source	string	Indica se o GAN (número da conta do cartão-presente) é gerado pelo Square ou importado de um sistema não Quadrado.
Estado	gift_card.state	string	O estado atual.
Quantidade	gift_card.balance_money.amount	integer	O valor.
Moeda	gift_card.balance_money.currency	string	A moeda.
Gan	gift_card.gan	string	O número da conta do cartão presente.
Criado em	gift_card.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.

Recuperar comerciante

ID da operação:: MerchantRetrieve

Recupere um objeto Merchant para o merchant_id fornecido.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Comerciante	merchant_id	True	string	O identificador do comerciante.

Retornos

Nome	Caminho	Tipo	Description
ID	merchant.id	string	O identificador exclusivo emitido por Quadrado.
Nome comercial	merchant.business_name	string	O nome comercial do local Esse é o nome visível para os clientes do local. Por exemplo, esse nome aparece nos recibos do cliente.
País	merchant.country	string	O código de país ISO 3166 Alpha-2.
Código de idioma	merchant.language_code	string	O código de idioma, no formato BCP 47.
Moeda	merchant.currency	string	O código de moeda ISO 4217 de 3 caracteres.
Situação	merchant.status	string	O status de verificação atual desse objeto.
ID da localização principal	merchant.main_location_id	string	A ID da localização principal deste comerciante.

Recuperar conta de fidelidade

ID da operação:: LoyaltyRetrieveAccount

Recupera uma conta de fidelidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
AccountID	account_id	True	string	O identificador da conta.

Retornos

Nome	Caminho	Tipo	Description
ID	loyalty_account.id	string	O identificador exclusivo emitido por Quadrado.
ID	loyalty_account.mapping.id	string	A ID atribuída ao Quadrado.
Número de Telefone	loyalty_account.mapping.phone_number	string	O número de telefone do destinatário.
Criado em	loyalty_account.mapping.created_at	string	O carimbo de data/hora quando criado, no formato RFC 3339.
ID do programa	loyalty_account.program_id	string	A ID atribuída por quadrado do programa.
Saldo	loyalty_account.balance	integer	O saldo disponível.
Pontos de tempo de vida	loyalty_account.lifetime_points	integer	O total de pontos acumulados durante o tempo de vida da conta.
ID do cliente	loyalty_account.customer_id	string	A ID desse objeto que representa o cliente.
Criado em	loyalty_account.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	loyalty_account.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Recuperar local

ID da operação:: LocationRetrieve

Recupera detalhes de um local. Você pode especificar "principal" como a ID do local para recuperar detalhes do local principal.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Local	location_id	True	string	O identificador do local.

Retornos

Nome	Caminho	Tipo	Description
ID	location.id	string	O identificador exclusivo emitido por Quadrado.
Nome	location.name	string	O nome do objeto.
Linha de endereço 1	location.address.address_line_1	string	A primeira linha do endereço. Os campos que começam com address_line fornecem os detalhes mais específicos do endereço, como número de rua, nome da rua e nome do prédio.
Localidade	location.address.locality	string	A cidade ou a cidade do endereço.
Nível 1 do Distrito Administrativo	location.address.administrative_district_level_1	string	Uma entidade civil dentro do país do endereço. Nos EUA, este é o estado.
Código postal	location.address.postal_code	string	O código postal do endereço.
País	location.address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Timezone	location.timezone	string	O fuso horário usado para interpretar as datas do calendário. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Capabilities	location.capabilities	array of string
Situação	location.status	string	O status de verificação atual desse objeto.
Criado em	location.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
ID do Comerciante	location.merchant_id	string	A ID do comerciante.
País	location.country	string	O código de país ISO 3166 Alpha-2.
Código de idioma	location.language_code	string	O código de idioma, no formato BCP 47.
Moeda	location.currency	string	O código de moeda ISO 4217 de 3 caracteres.
Número de Telefone	location.phone_number	string	O número de telefone de 11 dígitos associado ao perfil do cliente.
Nome comercial	location.business_name	string	O nome comercial do local Esse é o nome visível para os clientes do local. Por exemplo, esse nome aparece nos recibos do cliente.

Recuperar membro da equipe

ID da operação:: TeamRetrieveMember

Recupera um objeto TeamMember para a ID do TeamMember fornecida.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do membro da equipe	team_member_id	True	string	O identificador do membro da equipe.

Retornos

Nome	Caminho	Tipo	Description
ID	team_member.id	string	O identificador exclusivo emitido por Quadrado.
ID de Referência	team_member.reference_id	string	Uma ID de referência opcional definida pelo usuário.
É Proprietário	team_member.is_owner	boolean	Se o membro da equipe é o proprietário da conta square.
Situação	team_member.status	string	O status de verificação atual desse objeto.
Nome	team_member.given_name	string	O nome fornecido (ou seja, primeiro) associado ao perfil do cliente.
Sobrenome	team_member.family_name	string	O nome da família (ou seja, sobrenome) associado ao perfil do cliente.
Endereço de Email	team_member.email_address	string	O endereço de email associado ao perfil do cliente.
Número de Telefone	team_member.phone_number	string	O número de telefone de 11 dígitos associado ao perfil do cliente.
Criado em	team_member.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	team_member.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Tipo de atribuição	team_member.assigned_locations.assignment_type	string	O tipo de atribuição atual do membro da equipe.
IDs de localização	team_member.assigned_locations.location_ids	array of string

Recuperar o turno da gaveta de dinheiro

ID da operação:: CashDrawerRetrieveShift

Fornece os detalhes de resumo de um único turno de gaveta de dinheiro.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do turno	shift_id	True	string	O identificador da mudança.
ID do Local	location_id	True	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.

Retornos

Nome	Caminho	Tipo	Description
ID	cash_drawer_shift.id	string	O identificador exclusivo emitido por Quadrado.
Estado	cash_drawer_shift.state	string	O estado atual.
Aberto em	cash_drawer_shift.opened_at	string	A hora em que a mudança começou, no formato ISO 8601.
Terminou em	cash_drawer_shift.ended_at	string	A hora em que a mudança terminou, no formato ISO 8601.
Fechado em	cash_drawer_shift.closed_at	string	A hora quando fechada, no formato ISO 8601.
Abrindo a ID do Funcionário	cash_drawer_shift.opening_employee_id	string	A ID do empregado que iniciou o turno da gaveta de dinheiro.
Fim da ID do Funcionário	cash_drawer_shift.ending_employee_id	string	A ID do empregado que acabou com o turno da gaveta de dinheiro.
Fechando a ID do Funcionário	cash_drawer_shift.closing_employee_id	string	A ID do funcionário que fechou o turno da gaveta de dinheiro auditando o conteúdo da gaveta de dinheiro.
Description	cash_drawer_shift.description	string	A descrição.
Quantidade	cash_drawer_shift.opened_cash_money.amount	integer	O valor.
Moeda	cash_drawer_shift.opened_cash_money.currency	string	A moeda.
Quantidade	cash_drawer_shift.cash_payment_money.amount	integer	O valor.
Moeda	cash_drawer_shift.cash_payment_money.currency	string	A moeda.
Quantidade	cash_drawer_shift.cash_refunds_money.amount	integer	O valor.
Moeda	cash_drawer_shift.cash_refunds_money.currency	string	A moeda.
Quantidade	cash_drawer_shift.cash_paid_in_money.amount	integer	O valor.
Moeda	cash_drawer_shift.cash_paid_in_money.currency	string	A moeda.
Quantidade	cash_drawer_shift.cash_paid_out_money.amount	integer	O valor.
Moeda	cash_drawer_shift.cash_paid_out_money.currency	string	A moeda.
Quantidade	cash_drawer_shift.expected_cash_money.amount	integer	O valor.
Moeda	cash_drawer_shift.expected_cash_money.currency	string	A moeda.
Quantidade	cash_drawer_shift.closed_cash_money.amount	integer	O valor.
Moeda	cash_drawer_shift.closed_cash_money.currency	string	A moeda.
Nome	cash_drawer_shift.device.name	string	O nome.

Recuperar perfil de reserva de negócios (Beta)

ID da operação:: BookingRetrieveProfile

Recupera o perfil de reserva de um vendedor.

Retornos

Nome	Caminho	Tipo	Description
ID do Vendedor	business_booking_profile.seller_id	string	A ID do vendedor, que pode ser obtida usando a API dos Comerciantes.
Criado em	business_booking_profile.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Reserva habilitada	business_booking_profile.booking_enabled	boolean	Indica se o vendedor está aberto para reserva.
Escolha de fuso horário do cliente	business_booking_profile.customer_timezone_choice	string	A escolha das informações de fuso horário do cliente de uma reserva. O site de reserva online square e todas as notificações para os clientes usam o fuso horário do local do vendedor ou o fuso horário que o cliente escolhe na reserva.
Política de Reserva	business_booking_profile.booking_policy	string	A política para o vendedor aceitar automaticamente solicitações de reserva (ACCEPT_ALL) ou não (REQUIRES_ACCEPTANCE).
Permitir cancelamento do usuário	business_booking_profile.allow_user_cancel	boolean	Indica se os clientes podem cancelar ou reagendar suas próprias reservas (true) ou não (false).
Tipos de localização	business_booking_profile.business_appointment_settings.location_types	array of string
Tempo de Alinhamento	business_booking_profile.business_appointment_settings.alignment_time	string	A unidade de tempo da duração do serviço para reservas.
Min Booking Tead Time Seconds	business_booking_profile.business_appointment_settings.min_booking_lead_time_seconds	integer	O tempo mínimo de entrega em segundos antes que um serviço possa ser reservado. As reservas devem ser criadas pelo menos tão antes do horário de início da reserva.
Máximo de segundos de tempo de entrega da reserva	business_booking_profile.business_appointment_settings.max_booking_lead_time_seconds	integer	O tempo máximo de entrega em segundos antes que um serviço possa ser reservado. As reservas devem ser criadas no máximo tão antes do horário de início da reserva.
Qualquer reserva de membro da equipe habilitada	business_booking_profile.business_appointment_settings.any_team_member_booking_enabled	boolean	Indica se um cliente pode escolher entre todos os intervalos de tempo disponíveis e ter um membro da equipe atribuído automaticamente (true) ou não (false).
Reserva de vários serviços habilitada	business_booking_profile.business_appointment_settings.multiple_service_booking_enabled	boolean	Indica se um cliente pode reservar vários serviços em uma única reserva online.
Quantidade	business_booking_profile.business_appointment_settings.cancellation_fee_money.amount	string	A quantidade de dinheiro, na menor denominação da moeda indicada pela moeda
Moeda	business_booking_profile.business_appointment_settings.cancellation_fee_money.currency	string	O tipo de moeda, no formato ISO 4217.
Política de Cancelamento	business_booking_profile.business_appointment_settings.cancellation_policy	string	A política de cancelamento adotada pelo vendedor.
Ignorar a seleção da equipe de fluxo de reserva	business_booking_profile.business_appointment_settings.skip_booking_flow_staff_selection	boolean	Indica se os clientes têm um membro da equipe atribuído (true) ou se podem selecionar o membro da equipe de sua escolha (false).
Errors	errors	array of

Recuperar programa de fidelidade

ID da operação:: LoyaltyRetrieveProgram

Recupera o programa de fidelidade na conta de um vendedor, especificado pela ID do programa ou pela palavra-chave principal. Os programas de fidelidade definem como os compradores podem ganhar pontos e resgatar pontos para recompensas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do programa	program_id	True	string	O identificador do programa.

Retornos

Nome	Caminho	Tipo	Description
ID	program.id	string	O identificador exclusivo emitido por Quadrado.
Situação	program.status	string	O status de verificação atual desse objeto.
Camadas de recompensa	program.reward_tiers	array of object
ID	program.reward_tiers.id	string	O identificador do objeto
Pontos	program.reward_tiers.points	integer	O número de pontos acumulados pelo evento.
Nome	program.reward_tiers.name	string	O nome do item. Esse é um atributo pesquisável para uso em filtros de consulta aplicáveis, seu valor não deve estar vazio e o comprimento é de pontos de código Unicode.
Scope	program.reward_tiers.definition.scope	string	Indica o nível no qual o objeto se aplica.
Tipo de desconto	program.reward_tiers.definition.discount_type	string	O tipo de desconto que a camada de recompensa oferece.
Desconto percentual	program.reward_tiers.definition.percentage_discount	string	O percentual fixo do desconto.
Criado em	program.reward_tiers.created_at	string	O carimbo de data/hora quando criado, no formato RFC 3339.
ID do objeto	program.reward_tiers.pricing_rule_reference.object_id	string	A ID do objeto referenciado.
Versão do catálogo	program.reward_tiers.pricing_rule_reference.catalog_version	string	A versão do objeto.
One	program.terminology.one	string	Uma unidade singular para um ponto (por exemplo, 1 ponto é chamado de 1 estrela).
Other	program.terminology.other	string	Uma unidade plural para ponto (por exemplo, 10 pontos é chamada de 10 estrelas).
IDs de localização	program.location_ids	array of string
Criado em	program.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	program.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Regras de acréscimo	program.accrual_rules	array of object
Tipo de acréscimo	program.accrual_rules.accrual_type	string	O tipo da regra de acréscimo que define como os compradores podem ganhar pontos.
Pontos	program.accrual_rules.points	integer	O número de pontos acumulados pelo evento.
Quantidade	program.accrual_rules.spend_amount_money.amount	integer	O valor.
IDs de categoria excluídas	program.accrual_rules.excluded_category_ids	array of string
IDs de variação de item excluídas	program.accrual_rules.excluded_item_variation_ids	array of string

Recuperar recompensa de fidelidade

ID da operação:: LoyaltyRetrieveReward

Recupera uma recompensa de fidelidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de recompensa	reward_id	True	string	O identificador da recompensa.

Retornos

Nome	Caminho	Tipo	Description
ID	reward.id	string	O identificador exclusivo emitido por Quadrado.
Situação	reward.status	string	O status de verificação atual desse objeto.
ID da conta de fidelidade	reward.loyalty_account_id	string	A ID da conta de fidelidade na qual o evento ocorreu.
ID da Camada de Recompensa	reward.reward_tier_id	string	A ID atribuída por quadrado da camada de recompensa usada para criar a recompensa.
Pontos	reward.points	integer	O número de pontos adicionados ou removidos.
Criado em	reward.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	reward.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.
Resgatado em	reward.redeemed_at	string	O carimbo de data/hora quando a recompensa foi resgatada, no formato RFC 3339.

Recuperar snippet

ID da operação:: SnippetRetrieve

Recupera o snippet de código de um site do Square Online. Um site pode conter snippets de vários aplicativos de snippet, mas você pode recuperar apenas o snippet que foi adicionado pelo aplicativo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Site	site_id	True	string	O identificador do site.

Retornos

Nome	Caminho	Tipo	Description
ID	snippet.id	string	O identificador exclusivo emitido por Quadrado.
ID do Site	snippet.site_id	string	A ID do site que contém o snippet.
Content	snippet.content	string	O código de snippet, que pode conter HTML válido, JavaScript ou ambos.
Criado em	snippet.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	snippet.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Resgatar recompensa de lealdade

ID da operação:: LoyaltyRedeemReward

Resgata uma recompensa de lealdade. Depois que a recompensa atingir o estado terminal, ela não poderá ser excluída. Em outras palavras, os pontos usados para a recompensa não podem ser retornados para a conta.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de recompensa	reward_id	True	string	O identificador da recompensa.
Chave de Idempotency	idempotency_key		string	Um valor que você especifica que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotency válida é usar um UUID (identificador universal exclusivo).
ID do Local	location_id		string	O identificador de local.

Retornos

Nome	Caminho	Tipo	Description
ID	event.id	string	O identificador exclusivo emitido por Quadrado.
Tipo	event.type	string	O tipo desse objeto.
Criado em	event.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
ID do programa de fidelidade	event.redeem_reward.loyalty_program_id	string	A ID do programa de fidelidade
ID de recompensa	event.redeem_reward.reward_id	string	A ID atribuída à Praça da recompensa de lealdade.
ID da conta de fidelidade	event.loyalty_account_id	string	A ID da conta de fidelidade na qual o evento ocorreu.
ID do Local	event.location_id	string	O identificador do local.
Source	event.source	string	A origem.

Tipo de quebra de atualização

ID da operação:: LaborUpdateBreak

Atualiza um BreakType existente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID	id	True	string	O identificador.
ID do Local	location_id		string	O identificador do local.
Nome da Interrupção	break_name		string	Um nome legível para esse tipo de interrupção. O nome é exibido para funcionários em produtos Square.
Duração esperada	expected_duration		string	O comprimento esperado desta quebra. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precisão inferior a minutos é truncada.
É Pago	is_paid		boolean	Se essa quebra conta para o tempo trabalhado para fins de compensação.
Versão	version		integer	A versão atual deste objeto.

Retornos

Nome	Caminho	Tipo	Description
ID	break_type.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	break_type.location_id	string	O identificador do local.
Nome da Interrupção	break_type.break_name	string	Um nome legível para esse tipo de interrupção. O nome é exibido para funcionários em produtos Square.
Duração esperada	break_type.expected_duration	string	O comprimento esperado desta quebra. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precisão inferior a minutos é truncada.
É Pago	break_type.is_paid	boolean	Se essa quebra conta para o tempo trabalhado para fins de compensação.
Versão	break_type.version	integer	A versão atual deste objeto.
Criado em	break_type.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	break_type.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Tipos de quebra de lista

ID da operação:: LaborListBreak

Retorna uma lista paginada de instâncias BreakType para uma empresa.

Parâmetros

Nome	Chave	Tipo	Description
ID do Local	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.
Limit	limit	integer	Limite superior no número a ser retornado na resposta.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para esse ponto de extremidade.

Retornos

Nome	Caminho	Tipo	Description
Tipos de interrupção	break_types	array of object
ID	break_types.id	string	O identificador exclusivo emitido por Quadrado.
ID do Local	break_types.location_id	string	O identificador do local.
Nome da Interrupção	break_types.break_name	string	Um nome legível para esse tipo de interrupção. O nome é exibido para funcionários em produtos Square.
Duração esperada	break_types.expected_duration	string	O comprimento esperado desta quebra. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. Precisão inferior a minutos é truncada.
É Pago	break_types.is_paid	boolean	Se essa quebra conta para o tempo trabalhado para fins de compensação.
Versão	break_types.version	integer	A versão atual do objeto.
Criado em	break_types.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	break_types.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para esse ponto de extremidade para recuperar o próximo conjunto de resultados associados à consulta original.

Trecho de código upsert

ID da operação:: SnippetUpsert

Adiciona um snippet a um site do Square Online ou atualiza o snippet existente no site. O código de snippet é acrescentado ao final do elemento principal em todas as páginas do site, exceto páginas de check-out. Um aplicativo de snippet de código pode adicionar um snippet a um determinado site.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Site	site_id	True	string	O identificador do site.
Content	content		string	O código de snippet, que pode conter HTML válido, JavaScript ou ambos.

Retornos

Nome	Caminho	Tipo	Description
ID	snippet.id	string	O identificador exclusivo emitido por Quadrado.
ID do Site	snippet.site_id	string	A ID do site que contém o snippet.
Content	snippet.content	string	O código de snippet, que pode conter HTML válido, JavaScript ou ambos.
Criado em	snippet.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
Atualizado em	snippet.updated_at	string	O carimbo de data/hora que especifica a hora de atualização mais recente desse objeto, no formato RFC 3339.

Turnos de pesquisa

ID da operação:: LaborSearchShifts

Retorna uma lista paginada de registros Shift para uma empresa.

Parâmetros

Nome	Chave	Tipo	Description
Data de Início	start_date	string	Uma cadeia de caracteres no formato YYYY-MM-DD, como 2017-10-31, de acordo com o formato estendido ISO 8601 para datas de calendário. O início de um intervalo de datas (inclusive).
Data de Término	end_date	string	Uma cadeia de caracteres no formato YYYY-MM-DD, como 2017-10-31, de acordo com o formato estendido ISO 8601 para datas de calendário. O fim de um intervalo de datas (inclusive).
Corresponder turnos por	match_shifts_by	string	A estratégia na qual as datas são aplicadas.
Fuso horário padrão	default_timezone	string	Fusos horários específicos do local convertem os dias úteis em filtros datetime. Cada local incluído na consulta deve ter um fuso horário ou esse campo deve ser fornecido como um fallback. Formato: o identificador de banco de dados de fuso horário IANA para o fuso horário relevante.
Limit	limit	integer	Um limite no número de resultados a serem retornados em uma única página. O limite é consultivo – a implementação pode retornar mais ou menos resultados. Se o limite fornecido for negativo, zero ou for maior que o limite máximo de 1.000, ele será ignorado.

Retornos

Nome	Caminho	Tipo	Description
Shifts	shifts	array of object
ID	shifts.id	string	O identificador exclusivo emitido por Quadrado.
ID do membro da equipe	shifts.team_member_id	string	A ID do objeto TeamMember para o membro da equipe associado ao objeto.
ID do Local	shifts.location_id	string	O identificador do local.
Timezone	shifts.timezone	string	O fuso horário usado para interpretar datas de calendário na fatura, como due_date. Quando uma fatura é criada, esse campo é definido como o fuso horário especificado para o local do vendedor. O valor não pode ser alterado.
Iniciar em	shifts.start_at	string	O carimbo de data/hora RFC 3339 especificando a hora inicial do slot disponível.
Terminar em	shifts.end_at	string	RFC 3339; mudou para o fuso horário + deslocamento. A precisão até o minuto é respeitada; segundos são truncados.
Title	shifts.wage.title	string	O nome do trabalho executado durante esse turno. UIs de relatório de mão-de-obra quadradas podem agrupar turnos por título.
Quantidade	shifts.wage.hourly_rate.amount	integer	O valor.
Moeda	shifts.wage.hourly_rate.currency	string	A moeda.
Quebra	shifts.breaks	array of object
ID	shifts.breaks.id	string	Um identificador para fazer referência a esse objeto.
Iniciar em	shifts.breaks.start_at	string	Um valor de datetime no formato RFC 3339 que indica quando o intervalo de tempo é iniciado.
Terminar em	shifts.breaks.end_at	string	Um valor de datetime no formato RFC 3339 que indica quando o intervalo de tempo termina.
ID do tipo de interrupção	shifts.breaks.break_type_id	string	O BreakType no qual esta quebra foi modelo.
Nome	shifts.breaks.name	string	Um nome legível por humanos.
Duração esperada	shifts.breaks.expected_duration	string	O comprimento esperado da quebra. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
É Pago	shifts.breaks.is_paid	boolean	Se essa quebra conta para o tempo trabalhado para fins de compensação.
Situação	shifts.status	string	O status de verificação atual desse objeto.
Versão	shifts.version	integer	A versão atual do objeto.
Criado em	shifts.created_at	string	A hora do evento no formato ISO 8601.
Atualizado em	shifts.updated_at	string	Carimbo de data/hora da última modificação no formato RFC 3339

Vincular o cliente ao cartão presente (Beta)

ID da operação:: GiftCardLink

Vincula um cliente a um cartão-presente

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do cartão presente	gift_card_id	True	string	O identificador do cartão presente.
ID do cliente	customer_id		string	A ID do cliente a ser vinculado.

Retornos

Nome	Caminho	Tipo	Description
ID	gift_card.id	string	O identificador exclusivo emitido por Quadrado.
Tipo	gift_card.type	string	O tipo desse objeto.
Origem DE GAN	gift_card.gan_source	string	Indica se o GAN (número da conta do cartão-presente) é gerado pelo Square ou importado de um sistema não Quadrado.
Estado	gift_card.state	string	O estado atual.
Quantidade	gift_card.balance_money.amount	integer	O valor.
Moeda	gift_card.balance_money.currency	string	A moeda.
Gan	gift_card.gan	string	O número da conta do cartão presente.
Criado em	gift_card.created_at	string	O carimbo de data/hora que especifica a hora de criação desse objeto, no formato RFC 3339.
IDs do cliente	gift_card.customer_ids	array of string

Definições

objeto

Esse é o tipo 'object'.

Compartilhar via

Square Business (Editor Independente) (versão prévia)

Limitações

Ações

Acumular pontos de fidelidade

Parâmetros

Retornos

Ajustar pontos de fidelidade

Parâmetros

Retornos

Atualizar a configuração salarial

Parâmetros

Retornos

Atualizar configuração da semana de trabalho

Parâmetros

Retornos

Atualizar membro da equipe

Parâmetros

Retornos

Calcular pontos de fidelidade

Parâmetros

Retornos

Criar atividade de cartão-presente (Beta)

Parâmetros

Retornos

Criar check-out

Parâmetros

Retornos

Criar conta de fidelidade

Parâmetros

Retornos

Criar código de autorização móvel

Parâmetros

Retornos

Criar código do dispositivo

Parâmetros

Retornos

Criar local (Beta)

Parâmetros

Retornos

Criar membro da equipe

Parâmetros

Retornos

Criar membros da equipe em massa

Parâmetros

Retornos

Criar recompensa de fidelidade

Parâmetros

Retornos

Criar reserva (Beta)

Parâmetros

Retornos

Criar tipo de interrupção

Parâmetros

Retornos

Criar turno

Parâmetros

Retornos

Desvincular o cliente do cartão-presente (Beta)

Parâmetros

Retornos

Disponibilidade de pesquisa (Beta)

Parâmetros

Retornos

Excluir recompensa de fidelidade

Parâmetros

Retornos

Excluir snippet

Parâmetros

Retornos

Excluir tipo de interrupção

Parâmetros

Retornos

Excluir turno

Parâmetros

Retornos

Listar atividades de cartão-presente (Beta)

Parâmetros

Retornos

Listar comerciantes