Square Business (Editora Independente) (Pré-visualização)

A Square ajuda milhões de vendedores a gerir o seu negócio - desde o processamento seguro de cartões de crédito até soluções de ponto de venda. Este conector contém ações para os seguintes endpoints: Fidelidade, Gift Cards, Reservas, Negócios, Equipe, Finanças, Online e Auth.

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

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Premium	Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)
Automatize o poder	Premium	Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD)

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

Metadados do conector
Editora	Troia Taylor
Sítio Web	https://squareup.com/
Política de privacidade	https://squareup.com/us/en/legal/general/privacy
Categorias	Comércio; Vendas e CRM

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	100	60 segundos

Ações

Acumule 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 este ponto de extremidade somente quando precisar ajustar pontos manualmente.
Atualizar a definição de salários	Cria ou atualiza um objeto WageSetting.
Atualizar configuração da semana de trabalho	Atualiza um WorkweekConfig.
Atualizar membro da equipa	Atualiza um único objeto TeamMember.
Atualizar turno	Atualiza um turno existente.
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 serem emitidos.
Criar código de dispositivo	Cria um DeviceCode que pode ser usado para fazer login em um dispositivo Square Terminal para entrar no modo de terminal conectado.
Criar localização (Beta)	Cria um local.
Criar membro da equipa	Cria um único objeto TeamMember.
Criar membros da equipe em massa	Cria vários objetos TeamMember.
Criar reserva (Beta)	Cria uma reserva.
Criar tipo de quebra	Cria um novo BreakType. Um BreakType é um modelo para criar objetos Break.
Criar turno	Cria um novo Shift. Um turno representa uma jornada de trabalho completa para um único funcionário
Crie recompensas de fidelidade	Cria uma recompensa de fidelidade. Depois que uma recompensa é criada, os pontos são bloqueados e não estão disponíveis para o comprador resgatar outra recompensa.
Deslocamentos de pesquisa	Retorna uma lista paginada de registros Shift para uma empresa.
Desvincular o cliente do cartão-presente (Beta)	Desvincula um cliente de um vale-presente.
Disponibilidade da pesquisa (Beta)	Pesquisas de disponibilidades para reserva.
Excluir recompensa de fidelidade	Exclui uma recompensa de fidelidade. Devolve os pontos de fidelidade à conta de fidelidade. Não é possível excluir uma recompensa que tenha atingido o estado terminal (RESGATADO).
Excluir tipo de quebra	Exclui um BreakType existente. Um BreakType pode ser excluído mesmo se for referenciado a partir de um Shift.
Excluir trecho	Remove seu snippet de um site da Square Online.
Excluir turno	Exclui um turno
Listar atividades de vale-presente (Beta)	Lista as atividades do vale-presente. Por padrão, você recebe atividades de vale-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ões-presente para um cartão-presente, para todos os cartões-presente em uma região específica ou para atividades dentro de 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 de dispositivo	Lista todos os DeviceCodes associados ao comerciante.
Listar eventos de mudança 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 perfis de reserva de membros da equipe (Beta)	Lista perfis de reserva para membros da equipe.
Listar salários dos membros da equipe	Retorna uma lista paginada de instâncias TeamMemberWage para uma empresa.
Listar sites	Lista os sites da 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 de atualização (Beta)	Atualiza um local.
Membros da equipe de atualização em massa	Atualiza vários objetos TeamMember.
Obter conta bancária	Devolve os detalhes de uma Conta Bancária associada a uma conta Square.
Obter conta bancária por ID V1	Devolve os detalhes de uma Conta Bancária identificada pelo ID da conta bancária V1.
Obter código do dispositivo	Recupera DeviceCode com o ID associado.
Obter salário de membro da equipe	Retorna um único TeamMemberWage especificado por id.
Obter tipo de quebra	Retorna um único BreakType especificado por id.
Obter turno	Retorna um único Shift especificado por id.
Pesquisar contas de fidelidade	Procura contas de fidelidade em um programa de fidelidade.
Pesquisar eventos de fidelização	Pesquisas por eventos de fidelidade. Um programa de fidelidade da Square mantém um livro de eventos que ocorrem durante a vida útil 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 livro-razão. Usando esse ponto de extremidade, você pode pesquisar eventos no livro-razão.
Pesquisar membros da equipa	Retorna uma lista paginada de objetos TeamMember para uma empresa.
Pesquise recompensas de fidelidade	Procura recompensas de fidelidade em uma conta de fidelidade.
Recuperar cartão-presente (Beta)	Recupera um cartão-presente usando sua identificação.
Recuperar cartão-presente do GAN (Beta)	Recupera um cartão-presente usando o número de 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 determinado.
Recuperar conta de fidelidade	Recupera uma conta de fidelidade.
Recuperar definição salarial	Recupera um objeto WageSetting para um membro da equipe especificado pela ID TeamMember.
Recuperar localização	Recupera detalhes de um local. Você pode especificar "main" como o ID do local para recuperar detalhes do local principal.
Recuperar membro da equipe	Recupera um objeto TeamMember para a ID TeamMember fornecida.
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 pelo ID do programa ou pela palavra-chave principal. Os programas de fidelidade definem como os compradores podem ganhar pontos e trocar pontos por recompensas.
Recuperar recompensa de fidelidade	Recupera uma recompensa de fidelidade.
Recuperar trecho	Recupera seu trecho de um site da Square Online. Um site pode conter trechos de vários aplicativos de trechos, mas você pode recuperar apenas o trecho que foi adicionado pelo seu aplicativo.
Recuperar turno de gaveta de dinheiro	Fornece os detalhes resumidos para um único turno de gaveta de dinheiro.
Resgatar recompensa de fidelidade	Resgata uma recompensa de fidelidade. Depois que a recompensa atingir o estado terminal, ela não poderá ser excluída. Por outras palavras, os pontos utilizados para a recompensa não podem ser devolvidos à conta.
Tipo de interrupção 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 Upsert	Adiciona um snippet a um site do Square Online ou atualiza o snippet existente no site. O código do trecho é anexado ao final do elemento head em todas as páginas do site, exceto nas páginas de checkout. Um aplicativo de snippet pode adicionar um snippet a um determinado site.
Vincular o cliente ao cartão-presente (Beta)	Vincula um cliente a um vale-presente

Acumule pontos de fidelidade

ID da Operação:: LoyaltyAccumulatePoints

Adiciona pontos a uma conta de fidelidade.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da conta	account_id	True	string	O identificador da conta.
ID da encomenda	order_id		string	O ID do pedido.
ID da Localização	location_id		string	O identificador de localização.
Chave de idempotência	idempotency_key		string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).

Devoluções

Name	Caminho	Tipo	Description
ID	event.id	string	O identificador único, emitido pela Square.
Tipo	event.type	string	O tipo deste objeto.
Criado em	event.created_at	string	O carimbo de data/hora que especifica a hora de criação deste objeto, no formato RFC 3339.
ID do Programa de Fidelização	event.accumulate_points.loyalty_program_id	string	O ID do programa de fidelidade
Pontos	event.accumulate_points.points	integer	O número de pontos acumulados pelo evento.
ID da encomenda	event.accumulate_points.order_id	string	O ID do pedido associado à atividade.
ID da conta de fidelidade	event.loyalty_account_id	string	O ID da conta de fidelidade na qual o evento ocorreu.
ID da Localização	event.location_id	string	O identificador do local.
Fonte	event.source	string	A fonte.

Ajustar pontos de fidelidade

ID da Operação:: LoyaltyAdjustPoints

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da conta	account_id	True	string	O identificador da conta.
Pontos	points		integer	O número de pontos adicionados ou removidos.
Reason	reason		string	A razão para este objeto.
Chave de idempotência	idempotency_key		string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).

Devoluções

Name	Caminho	Tipo	Description
ID	event.id	string	O identificador único, emitido pela Square.
Tipo	event.type	string	O tipo deste objeto.
Criado em	event.created_at	string	O carimbo de data/hora que especifica a hora de criação deste objeto, no formato RFC 3339.
ID do Programa de Fidelização	event.adjust_points.loyalty_program_id	string	O 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	O ID da conta de fidelidade na qual o evento ocorreu.
Fonte	event.source	string	A fonte.

Atualizar a definição de salários

ID da Operação:: TeamUpdateWage

Cria ou atualiza um objeto WageSetting.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Membro da Equipa	team_member_id	True	string	O identificador do membro da equipe.
Está isenta de horas extraordinárias	is_overtime_exempt		boolean	Se o membro da equipa está isento das regras de horas extraordinárias 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 para a atribuição de trabalho usado para calcular o valor do pagamento em um período de pagamento.
Montante	amount		integer	O montante.
Moeda	currency		string	A moeda.
Horas Semanais	weekly_hours		integer	As horas semanais planeadas para o trabalho. Defina se o trabalho PayType é SALARY.
Montante	amount		integer	O montante.
Moeda	currency		string	A moeda.

Devoluções

Name	Caminho	Tipo	Description
ID do Membro da Equipa	wage_setting.team_member_id	string	O ID do membro da equipe.
Atribuições de Cargos	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 para a atribuição de trabalho usado para calcular o valor do pagamento em um período de pagamento.
Montante	wage_setting.job_assignments.hourly_rate.amount	integer	O montante.
Moeda	wage_setting.job_assignments.hourly_rate.currency	string	A moeda.
Montante	wage_setting.job_assignments.annual_rate.amount	integer	O montante.
Moeda	wage_setting.job_assignments.annual_rate.currency	string	A moeda.
Horas Semanais	wage_setting.job_assignments.weekly_hours	integer	As horas semanais planeadas para o trabalho. Defina se o trabalho PayType é SALARY.
Está isenta de horas extraordinárias	wage_setting.is_overtime_exempt	boolean	Se o membro da equipa está isento das regras de horas extraordinárias 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 deste 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 deste objeto, no formato RFC 3339.

Atualizar configuração da semana de trabalho

ID da Operação:: LaborUpdateConfig

Atualiza um WorkweekConfig.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.
Início da Semana	start_of_week		string	O dia da semana em que termina uma semana útil para efeitos de compensação.
Início do dia, hora local	start_of_day_local_time		string	A hora local em que uma semana de negócios termina. Representada como uma cadeia de caracteres no formato HH:MM (HH:MM:SS também é aceito, mas os segundos são truncados).
Versão	version		integer	A versão atual deste objeto.

Devoluções

Name	Caminho	Tipo	Description
ID	workweek_config.id	string	O identificador único, emitido pela Square.
Início da Semana	workweek_config.start_of_week	string	O dia da semana em que termina uma semana útil para efeitos de compensação.
Início do dia, hora local	workweek_config.start_of_day_local_time	string	A hora local em que uma semana de negócios termina. Representada como uma cadeia de caracteres no formato HH:MM (HH:MM:SS também é aceito, mas os 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 deste 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 deste objeto, no formato RFC 3339.

Atualizar membro da equipa

ID da Operação:: TeamUpdate

Atualiza um único objeto TeamMember.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Membro da Equipa	team_member_id	True	string	O identificador do membro da equipe.
ID de Referência	reference_id		string	Um ID de referência opcional definido pelo usuário.
Situação	status		string	O status de verificação atual deste objeto.
Nome Próprio	given_name		string	O nome dado (ou seja, o primeiro) associado ao perfil do cliente.
Nome de família	family_name		string	O nome da família (ou seja, o último) associado ao perfil do cliente.
Endereço de E-mail	email_address		string	O endereço de e-mail 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.

Devoluções

Name	Caminho	Tipo	Description
ID	team_member.id	string	O identificador único, emitido pela Square.
ID de Referência	team_member.reference_id	string	Um ID de referência opcional definido pelo usuário.
É Proprietário	team_member.is_owner	boolean	Se o membro da equipa é o proprietário da conta Square.
Situação	team_member.status	string	O status de verificação atual deste objeto.
Nome Próprio	team_member.given_name	string	O nome dado (ou seja, o primeiro) associado ao perfil do cliente.
Nome de família	team_member.family_name	string	O nome da família (ou seja, o último) associado ao perfil do cliente.
Endereço de E-mail	team_member.email_address	string	O endereço de e-mail 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 deste 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

Atualizar turno

ID da Operação:: LaborUpdateShift

Atualiza um turno existente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.
ID do Membro da Equipa	team_member_id		string	O ID do membro da equipe.
ID da Localização	location_id		string	O identificador do local.
Comece em	start_at		string	O carimbo de data/hora especificando a hora de início deste objeto, no formato RFC 3339.
Terminar em	end_at		string	RFC 3339; deslocado para o fuso horário + deslocamento. A precisão até ao minuto é respeitada; segundos são truncados.
Title	title		string	O nome do trabalho realizado durante este turno. As UIs quadradas de relatórios de trabalho podem agrupar turnos por título.
Montante	amount		integer	O montante.
Moeda	currency		string	A moeda.
ID	id		string	O identificador do objeto
Comece em	start_at		string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até ao 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é ao minuto é respeitada; segundos são truncados.
ID do tipo de quebra	break_type_id		string	O BreakType no qual esta quebra foi modelada.
Nome	name		string	O nome do item. Este é 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 prevista	expected_duration		string	A duração esperada do intervalo. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
É pago	is_paid		boolean	Se esta pausa conta para o tempo trabalhado para efeitos de compensação.
Versão	version		integer	A versão atual deste objeto.

Devoluções

Name	Caminho	Tipo	Description
ID	shift.id	string	O identificador único, emitido pela Square.
ID do Membro da Equipa	shift.team_member_id	string	O ID do membro da equipe.
ID do funcionário	shift.employee_id	string	O ID gerado pelo quadrado do funcionário.
ID da Localização	shift.location_id	string	O identificador do local.
Timezone	shift.timezone	string	O fuso horário usado para interpretar 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.
Comece em	shift.start_at	string	O carimbo de data/hora especificando a hora de início deste objeto, no formato RFC 3339.
Terminar em	shift.end_at	string	RFC 3339; deslocado para o fuso horário + deslocamento. A precisão até ao minuto é respeitada; segundos são truncados.
Title	shift.wage.title	string	O nome do trabalho realizado durante este turno. As UIs quadradas de relatórios de trabalho podem agrupar turnos por título.
Montante	shift.wage.hourly_rate.amount	integer	O montante.
Moeda	shift.wage.hourly_rate.currency	string	A moeda.
Pausas	shift.breaks	array of object
ID	shift.breaks.id	string	O identificador do objeto
Comece em	shift.breaks.start_at	string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até ao 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é ao minuto é respeitada; segundos são truncados.
ID do tipo de quebra	shift.breaks.break_type_id	string	O BreakType no qual esta quebra foi modelada.
Nome	shift.breaks.name	string	O nome do item. Este é 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 prevista	shift.breaks.expected_duration	string	A duração esperada do intervalo. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
É pago	shift.breaks.is_paid	boolean	Se esta pausa conta para o tempo trabalhado para efeitos de compensação.
Situação	shift.status	string	O status de verificação atual deste 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 deste 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 deste objeto, no formato RFC 3339.

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

Name	Chave	Necessário	Tipo	Description
ID do programa	program_id	True	string	O identificador do programa.
ID da encomenda	order_id		string	O identificador de ordem.

Devoluções

Name	Caminho	Tipo	Description
Pontos	points	integer	Os pontos que o comprador pode ganhar com uma compra específica.

Criar atividade de cartão-presente (Beta)

ID da Operação:: GiftCardCreate

Cria uma atividade de cartão-presente.

Parâmetros

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
ID do Cartão Presente	gift_card_id	string	O ID do cartão-presente. O ID não é necessário se um GAN estiver presente.
Tipo	type	string	O tipo deste objeto.
ID da Localização	location_id	string	O identificador do local.
ID da encomenda	order_id	string	O ID do pedido associado à atividade.
UID do item de linha	line_item_uid	string	A line_item_uid do item da linha do cartão-presente em um pedido.

Devoluções

Name	Caminho	Tipo	Description
ID	gift_card_activity.id	string	O identificador único, emitido pela Square.
ID do Cartão Presente	gift_card_activity.gift_card_id	string	O ID do cartão-presente. O ID não é necessário se um GAN estiver presente.
Cartão Presente GAN	gift_card_activity.gift_card_gan	string	O cartão presente GAN. O GAN não é necessário se gift_card_id estiver presente.
Tipo	gift_card_activity.type	string	O tipo deste objeto.
Montante	gift_card_activity.gift_card_balance_money.amount	integer	O montante.
Moeda	gift_card_activity.gift_card_balance_money.currency	string	A moeda.
ID da Localização	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 deste objeto, no formato RFC 3339.
Montante	gift_card_activity.activate_activity_details.amount_money.amount	integer	O montante.
Moeda	gift_card_activity.activate_activity_details.amount_money.currency	string	A moeda.
ID da encomenda	gift_card_activity.activate_activity_details.order_id	string	O ID do pedido associado à atividade.
UID do item de linha	gift_card_activity.activate_activity_details.line_item_uid	string	A line_item_uid do item da linha do cartão-presente em um pedido.

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

Name	Chave	Necessário	Tipo	Description
ID da Localização	location_id	True	string	O identificador do local.
Chave de idempotência	idempotency_key		string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
URL de redirecionamento	redirect_url		string	Por exemplo, se o URL de redirecionamento 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&referenceId=xxxxxx&transactionId=xxxxxx` Se você não fornecer um 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 possa verificar os resultados da transação e finalizar o pedido por meio de seu fluxo de trabalho de confirmação existente/normal.
Chave de idempotência	idempotency_key		string	Um valor especificado que identifica exclusivamente essa ordem entre as ordens que você criou. Se não tiver a certeza se uma determinada encomenda foi criada com sucesso, pode tentar novamente com a mesma chave de idempotência sem se preocupar em criar encomendas duplicadas.
ID da Localização	location_id		string	A expressão de consulta para procurar disponibilidades correspondentes aos IDs de local do vendedor especificados.
ID do Cliente	customer_id		string	O ID do cliente associado ao pedido.
ID de Referência	reference_id		string	Um ID especificado pelo cliente para associar uma entidade em outro sistema a essa ordem.
Nome	name		string	O nome do item.
Quantidade	quantity		string	A quantidade comprada, formatada como um número decimal. Os itens de linha com uma quantidade de 0 são automaticamente removidos ao pagar ou concluir o pedido.
Montante	amount		integer	O montante.
Moeda	currency		string	A moeda.
Desconto UID	discount_uid		string	O UID do desconto que o desconto aplicado representa. Deve fazer referência a um desconto presente no campo order.discounts. Este campo é imutável. Para alterar quais descontos se aplicam a um item de linha, você deve excluir o desconto e adicioná-lo novamente como um novo OrderLineItemAppliedDiscount.
UID fiscal	tax_uid		string	O UID do imposto para o qual este imposto aplicado representa. Deve fazer referência a um imposto presente no campo order.taxes. Este campo é imutável. Para alterar quais impostos se aplicam a um item de linha, exclua e adicione um novo OrderLineItemAppliedTax.
UID	uid		string	Um ID único.
Tipo	type		string	O tipo deste objeto.
Percentagem	percentage		string	A porcentagem 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	Um ID único.
Tipo	type		string	O tipo deste objeto.
Scope	scope		string	Indica o nível no qual o objeto se aplica.
Montante	amount		integer	O montante.
Moeda	currency		string	A moeda.
ID da Localização	location_id		string	O identificador do local.
Description	title		string	A descrição.
Montante	amount		integer	O montante.
Moeda	currency		string	A moeda.
Pedir morada de envio	ask_for_shipping_address		boolean	Se verdadeiro, o Square Checkout coleta informações de envio em seu nome e armazena essas informações com as informações da transação no Painel do Vendedor Square.
E-mail de suporte ao comerciante	merchant_support_email		string	O endereço de e-mail a ser exibido na página de confirmação do Square Checkout e o e-mail 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 e-mail exibirão o endereço de e-mail principal associado à conta Square do vendedor.
Pré-preencher o e-mail do comprador	pre_populate_buyer_email		string	Se fornecido, o e-mail do comprador é pré-preenchido na página de checkout como um campo de texto editável.
Linha de Endereço 1	address_line_1		string	A primeira linha do endereço.
Endereço Linha 2	address_line_2		string	A segunda linha do endereço, se houver.
Localidade	locality		string	A cidade ou localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	country		string	O código de país ISO 3166 Alpha-2.
Nome Próprio	first_name		string	Nome opcional quando representa o destinatário.
Apelido	last_name		string	Sobrenome opcional quando representa o destinatário.

Devoluções

Name	Caminho	Tipo	Description
ID	checkout.id	string	O identificador único, emitido pela Square.
URL da página de check-out	checkout.checkout_page_url	string	O URL para o qual o navegador do comprador deve ser redirecionado após a conclusão do checkout.
Pedir morada de envio	checkout.ask_for_shipping_address	boolean	Se verdadeiro, o Square Checkout coletará informações de envio em seu nome e armazenará essas informações com as informações da transação no seu Painel Square.
E-mail de suporte ao comerciante	checkout.merchant_support_email	string	O endereço de e-mail a ser exibido na página de confirmação do Square Checkout e o e-mail de confirmação que o comprador pode usar para entrar em contato com o comerciante.
Pré-preencher o e-mail do comprador	checkout.pre_populate_buyer_email	string	Se fornecido, o e-mail do comprador é pré-preenchido na página de checkout 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 da rua, nome da rua e nome do edifício.
Endereço Linha 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 localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	checkout.pre_populate_shipping_address.country	string	O país do endereço, no formato ISO 3166-1-alpha-2.
Nome Próprio	checkout.pre_populate_shipping_address.first_name	string	Nome opcional quando representa o destinatário.
Apelido	checkout.pre_populate_shipping_address.last_name	string	Nome lsat opcional quando representa o destinatário.
URL de redirecionamento	checkout.redirect_url	string	A URL para a qual redirecionar após o checkout é concluída com checkoutId, orderId da Square, transactionId e referenceId anexados 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 um URL de redirecionamento, o Square Checkout exibirá uma página de confirmação do pedido em seu nome; no entanto, a Square recomenda vivamente que forneça um URL de redirecionamento para que possa verificar os resultados da transação e finalizar a encomenda através do seu fluxo de trabalho de confirmação existente/normal.
ID da Localização	checkout.order.location_id	string	A expressão de consulta para procurar disponibilidades correspondentes aos IDs de local do vendedor especificados.
ID do Cliente	checkout.order.customer_id	string	O ID do cliente associado ao pedido.
ID de Referência	checkout.order.reference_id	string	Um ID especificado 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 comprada, formatada como um número decimal. Os itens de linha com uma quantidade de 0 são automaticamente removidos 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	O UID do imposto para o qual este imposto aplicado representa. Deve fazer referência a um imposto presente no campo order.taxes. Este campo é imutável. Para alterar quais impostos se aplicam a um item de linha, exclua e adicione um novo OrderLineItemAppliedTax.
Montante	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 é em centavos. Os montantes monetários podem ser positivos ou negativos. Veja a descrição do campo específico 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
Desconto UID	checkout.order.line_items.applied_discounts.discount_uid	string	O UID do desconto que o desconto aplicado representa. Deve fazer referência a um desconto presente no campo order.discounts. Este campo é imutável. Para alterar quais descontos se aplicam a um item de linha, você deve excluir o desconto e adicioná-lo novamente como um novo OrderLineItemAppliedDiscount.
Montante	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 é em centavos. Os montantes monetários podem ser positivos ou negativos. Veja a descrição do campo específico 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.
Montante	checkout.order.line_items.base_price_money.amount	integer	O montante.
Moeda	checkout.order.line_items.base_price_money.currency	string	A moeda.
Montante	checkout.order.line_items.total_tax_money.amount	integer	O montante.
Moeda	checkout.order.line_items.total_tax_money.currency	string	A moeda.
Montante	checkout.order.line_items.total_discount_money.amount	integer	O montante.
Moeda	checkout.order.line_items.total_discount_money.currency	string	A moeda.
Montante	checkout.order.line_items.total_money.amount	integer	O montante.
Moeda	checkout.order.line_items.total_money.currency	string	A moeda.
Impostos	checkout.order.taxes	array of object
UID	checkout.order.taxes.uid	string	Um ID único.
Tipo	checkout.order.taxes.type	string	O tipo deste objeto.
Percentagem	checkout.order.taxes.percentage	string	A porcentagem 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	Um ID único.
Tipo	checkout.order.discounts.type	string	O tipo deste objeto.
Scope	checkout.order.discounts.scope	string	Indica o nível no qual o objeto se aplica.
Montante	checkout.order.discounts.amount_money.amount	integer	O montante.
Moeda	checkout.order.discounts.amount_money.currency	string	A moeda.
Montante	checkout.order.discounts.applied_money.amount	integer	O montante.
Moeda	checkout.order.discounts.applied_money.currency	string	A moeda.
Montante	checkout.order.total_money.amount	integer	O montante.
Moeda	checkout.order.total_money.currency	string	A moeda.
Montante	checkout.order.total_tax_money.amount	integer	O montante.
Moeda	checkout.order.total_tax_money.currency	string	A moeda.
Montante	checkout.order.total_discount_money.amount	integer	O montante.
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 deste 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 da Localização	checkout.additional_recipients.location_id	string	O ID de localização de um destinatário (que não o comerciante) que recebe uma parte desta proposta.
Description	checkout.additional_recipients.title	string	A descrição do item. Este é um atributo pesquisável para uso em filtros de consulta aplicáveis e seu comprimento de valor é de pontos de código Unicode.
Montante	checkout.additional_recipients.amount_money.amount	integer	O montante.
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

Name	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 ao quadrado do programa.
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).

Devoluções

Name	Caminho	Tipo	Description
ID	loyalty_account.id	string	O identificador único, emitido pela Square.
ID	loyalty_account.mapping.id	string	O ID atribuído 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 ao quadrado do programa.
Equilíbrio	loyalty_account.balance	integer	O saldo disponível.
Pontos vitalícios	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 deste 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 deste 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 serem emitidos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Localização	location_id		string	O identificador de localização.

Devoluções

Name	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 Square.
Expira em	expires_at	string	O carimbo de data/hora quando authorization_code expira no formato RFC 3339.

Criar código de dispositivo

ID da Operação:: DeviceCreate

Cria um DeviceCode que pode ser usado para fazer login em um dispositivo Square Terminal para entrar no modo de terminal conectado.

Parâmetros

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
Nome	name	string	O nome do objeto.
ID da Localização	location_id	string	O identificador do local.
Tipo de Produto	product_type	string	O tipo de produto de segmentação do código do dispositivo.

Devoluções

Name	Caminho	Tipo	Description
ID	device_code.id	string	O identificador único, emitido pela Square.
Nome	device_code.name	string	O nome do objeto.
Código	device_code.code	string	O código exclusivo que pode ser usado para fazer login.
Tipo de Produto	device_code.product_type	string	O tipo de produto de segmentação do código do dispositivo.
ID da Localização	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 deste objeto, no formato RFC 3339.
Par Por	device_code.pair_by	string	Quando este DeviceCode expirar e não fizer mais login. Carimbo de data/hora no formato RFC 3339.
Situação	device_code.status	string	O status de verificação atual deste 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 localização (Beta)

ID da Operação:: LocationCreate

Cria um local.

Parâmetros

Name	Chave	Tipo	Description
Nome	name	string	O nome do objeto.
Description	description	string	A descrição.
Facebook URL	facebook_url	string	O URL do perfil do Facebook do local. O 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 da rua, nome da rua e nome do edifício.
Distrito Administrativo Nível 1	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 localidade do endereço.
Código Postal	postal_code	string	Código postal do endereço.

Devoluções

Name	Caminho	Tipo	Description
ID	location.id	string	O identificador único, emitido pela Square.
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 da rua, nome da rua e nome do edifício.
Localidade	location.address.locality	string	A cidade ou localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Capabilities	location.capabilities	array of string
Situação	location.status	string	O status de verificação atual deste objeto.
Criado em	location.created_at	string	O carimbo de data/hora que especifica a hora de criação deste objeto, no formato RFC 3339.
ID do comerciante	location.merchant_id	string	O ID do comerciante.
Country	location.country	string	O código de país ISO 3166 Alpha-2.
Código do Idioma	location.language_code	string	O código da língua, no formato BCP 47.
Moeda	location.currency	string	O código de moeda ISO 4217 de 3 caracteres.
Tipo	location.type	string	O tipo deste objeto.
Description	location.description	string	A descrição.
URL do site	location.website_url	string	O 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.
CCM	location.mcc	string	O código de categoria do comerciante (MCC) do local, conforme padronizado pela ISO 18245. O MCC descreve o tipo de bens ou serviços vendidos no local.

Criar membro da equipa

ID da Operação:: TeamCreateMember

Cria um único objeto TeamMember.

Parâmetros

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
ID de Referência	reference_id	string	Um ID de referência opcional definido pelo usuário.
Situação	status	string	O status de verificação atual deste objeto.
Nome Próprio	given_name	string	O nome dado (ou seja, o primeiro) associado ao perfil do cliente.
Nome de família	family_name	string	O nome da família (ou seja, o último) associado ao perfil do cliente.
Endereço de E-mail	email_address	string	O endereço de e-mail 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.

Devoluções

Name	Caminho	Tipo	Description
ID	team_member.id	string	O identificador único, emitido pela Square.
ID de Referência	team_member.reference_id	string	Um ID de referência opcional definido pelo usuário.
É Proprietário	team_member.is_owner	boolean	Se o membro da equipa é o proprietário da conta Square.
Situação	team_member.status	string	O status de verificação atual deste objeto.
Nome Próprio	team_member.given_name	string	O nome dado (ou seja, o primeiro) associado ao perfil do cliente.
Nome de família	team_member.family_name	string	O nome da família (ou seja, o último) associado ao perfil do cliente.
Endereço de E-mail	team_member.email_address	string	O endereço de e-mail 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

Name	Chave	Tipo	Description
Nome Próprio	given_name	string	O nome próprio (ou seja, o primeiro nome) associado ao membro da equipa.
Nome de família	family_name	string	O nome de família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de E-mail	email_address	string	O endereço de e-mail associado ao membro da equipe.
ID de Referência	reference_id	string	Um segundo ID usado 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 equipa, em 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 Próprio	given_name	string	O nome próprio (ou seja, o primeiro nome) associado ao membro da equipa.
Nome de família	family_name	string	O nome de família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de E-mail	email_address	string	O endereço de e-mail associado ao membro da equipe.
ID de Referência	reference_id	string	Um segundo ID usado 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 equipa, em formato E.164.
Tipo de Atribuição	assignment_type	string	O tipo de atribuição atual do membro da equipe.

Devoluções

Name	Caminho	Tipo	Description
ID	team_members.idempotency-key-1.team_member.id	string	Um identificador para fazer referência a este objeto.
ID de Referência	team_members.idempotency-key-1.team_member.reference_id	string	Um segundo ID usado 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 equipa é 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 Próprio	team_members.idempotency-key-1.team_member.given_name	string	O nome próprio (ou seja, o primeiro nome) associado ao membro da equipa.
Nome de família	team_members.idempotency-key-1.team_member.family_name	string	O nome de família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de E-mail	team_members.idempotency-key-1.team_member.email_address	string	O endereço de e-mail 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 equipa, em 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 este objeto.
ID de Referência	team_members.idempotency-key-2.team_member.reference_id	string	Um segundo ID usado 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 equipa é 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 Próprio	team_members.idempotency-key-2.team_member.given_name	string	O nome próprio (ou seja, o primeiro nome) associado ao membro da equipa.
Nome de família	team_members.idempotency-key-2.team_member.family_name	string	O nome de família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de E-mail	team_members.idempotency-key-2.team_member.email_address	string	O endereço de e-mail 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 equipa, em 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 reserva (Beta)

ID da Operação:: BookingCreate

Cria uma reserva.

Parâmetros

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

Devoluções

Name	Caminho	Tipo	Description
ID	booking.id	string	O identificador único, emitido pela Square.
Versão	booking.version	integer	A versão atual deste objeto.
Situação	booking.status	string	O status de verificação atual deste objeto.
Criado em	booking.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.
ID da Localização	booking.location_id	string	O identificador do local.
ID do Cliente	booking.customer_id	string	A ID deste objeto que representa o cliente.
Nota do Cliente	booking.customer_note	string	O campo de texto livre para o cliente fornecer notas sobre a reserva.
Nota do vendedor	booking.seller_note	string	O campo de texto livre para o vendedor fornecer notas sobre a reserva.
Comece em	booking.start_at	string	O carimbo de data/hora especificando a hora de início deste objeto, no formato RFC 3339.
Segmento de Nomeação	booking.appointment_segments	array of object
Duração Minutos	booking.appointment_segments.duration_minutes	integer	O intervalo de tempo em minutos de um segmento de compromisso.
ID de 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 Equipa	booking.appointment_segments.team_member_id	string	A ID do objeto TeamMember que representa o membro da equipe reservado neste segmento.
Versão de variação do 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 quebra

ID da Operação:: LaborCreateBreak

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

Parâmetros

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
ID da Localização	location_id	string	O identificador do local.
Nome da quebra	break_name	string	Um nome legível por humanos para este tipo de pausa. O nome é exibido aos funcionários em produtos Square.
Duração prevista	expected_duration	string	A duração esperada desta pausa. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. A precisão inferior a minutos é truncada.
É pago	is_paid	boolean	Se esta pausa conta para o tempo trabalhado para efeitos de compensação.

Devoluções

Name	Caminho	Tipo	Description
ID	break_type.id	string	O identificador único, emitido pela Square.
ID da Localização	break_type.location_id	string	O identificador do local.
Nome da quebra	break_type.break_name	string	Um nome legível por humanos para este tipo de pausa. O nome é exibido aos funcionários em produtos Square.
Duração prevista	break_type.expected_duration	string	A duração esperada desta pausa. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. A precisão inferior a minutos é truncada.
É pago	break_type.is_paid	boolean	Se esta pausa conta para o tempo trabalhado para efeitos 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 deste 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 deste objeto, no formato RFC 3339.

Criar turno

ID da Operação:: LaborCreateShift

Cria um novo Shift. Um turno representa uma jornada de trabalho completa para um único funcionário

Parâmetros

Name	Chave	Tipo	Description
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
ID do Membro da Equipa	team_member_id	string	O ID do membro da equipe.
ID da Localização	location_id	string	O identificador do local.
Comece em	start_at	string	O carimbo de data/hora especificando a hora de início deste objeto, no formato RFC 3339.
Terminar em	end_at	string	RFC 3339; deslocado para o fuso horário + deslocamento. A precisão até ao minuto é respeitada; segundos são truncados.
Title	title	string	O nome do trabalho realizado durante este turno. As UIs quadradas de relatórios de trabalho podem agrupar turnos por título.
Montante	amount	integer	O montante.
Moeda	currency	string	A moeda.
Comece em	start_at	string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até ao 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é ao minuto é respeitada; segundos são truncados.
ID do tipo de quebra	break_type_id	string	O BreakType no qual esta quebra foi modelada.
Nome	name	string	O nome do item. Este é 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 prevista	expected_duration	string	A duração esperada do intervalo. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
É pago	is_paid	boolean	Se esta pausa conta para o tempo trabalhado para efeitos de compensação.

Devoluções

Name	Caminho	Tipo	Description
ID	shift.id	string	O identificador único, emitido pela Square.
ID do Membro da Equipa	shift.team_member_id	string	O ID do membro da equipe.
ID do funcionário	shift.employee_id	string	O ID gerado pelo quadrado do funcionário.
ID da Localização	shift.location_id	string	O identificador do local.
Timezone	shift.timezone	string	O fuso horário usado para interpretar 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.
Comece em	shift.start_at	string	O carimbo de data/hora especificando a hora de início deste objeto, no formato RFC 3339.
Terminar em	shift.end_at	string	RFC 3339; deslocado para o fuso horário + deslocamento. A precisão até ao minuto é respeitada; segundos são truncados.
Title	shift.wage.title	string	O nome do trabalho realizado durante este turno. As UIs quadradas de relatórios de trabalho podem agrupar turnos por título.
Montante	shift.wage.hourly_rate.amount	integer	O montante.
Moeda	shift.wage.hourly_rate.currency	string	A moeda.
Pausas	shift.breaks	array of object
ID	shift.breaks.id	string	O identificador do objeto
Comece em	shift.breaks.start_at	string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até ao 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é ao minuto é respeitada; segundos são truncados.
ID do tipo de quebra	shift.breaks.break_type_id	string	O BreakType no qual esta quebra foi modelada.
Nome	shift.breaks.name	string	O nome do item. Este é 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 prevista	shift.breaks.expected_duration	string	A duração esperada do intervalo. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
É pago	shift.breaks.is_paid	boolean	Se esta pausa conta para o tempo trabalhado para efeitos de compensação.
Situação	shift.status	string	O status de verificação atual deste 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 deste 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 deste objeto, no formato RFC 3339.

Crie recompensas de fidelidade

ID da Operação:: LoyaltyCreateReward

Cria uma recompensa de fidelidade. 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

Name	Chave	Tipo	Description
ID da conta de fidelidade	loyalty_account_id	string	O ID da conta de fidelidade na qual o evento ocorreu.
ID do Nível de Recompensa	reward_tier_id	string	O ID atribuído ao quadrado do nível de recompensa usado para criar a recompensa.
ID da encomenda	order_id	string	O ID do pedido.
Chave de idempotência	idempotency_key	string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).

Devoluções

Name	Caminho	Tipo	Description
ID	reward.id	string	O identificador único, emitido pela Square.
Situação	reward.status	string	O status de verificação atual deste objeto.
ID da conta de fidelidade	reward.loyalty_account_id	string	O ID da conta de fidelidade na qual o evento ocorreu.
ID do Nível de Recompensa	reward.reward_tier_id	string	O ID atribuído ao quadrado do nível de recompensa usado para criar a recompensa.
Pontos	reward.points	integer	O número de pontos adicionados ou removidos.
ID da encomenda	reward.order_id	string	O ID do pedido.
Criado em	reward.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.

Deslocamentos de pesquisa

ID da Operação:: LaborSearchShifts

Retorna uma lista paginada de registros Shift para uma empresa.

Parâmetros

Name	Chave	Tipo	Description
Data de início	start_date	string	Uma cadeia de caracteres no formato AAAA-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 fim	end_date	string	Uma cadeia de caracteres no formato AAAA-MM-DD, como 2017-10-31, de acordo com o formato estendido ISO 8601 para datas de calendário. O final de um intervalo de datas (inclusive).
Match Shifts por	match_shifts_by	string	A estratégia em que as datas são aplicadas.
Fuso horário padrão	default_timezone	string	Os fusos horários específicos do local convertem dias úteis em filtros datetime. Cada local incluído na consulta deve ter um fuso horário ou este campo deve ser fornecido como um fallback. Formato: o identificador do banco de dados de fuso horário IANA para o fuso horário relevante.
Limite	limit	integer	Um limite para o 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 superior ao limite máximo de 1.000, ele será ignorado.

Devoluções

Name	Caminho	Tipo	Description
Shifts	shifts	array of object
ID	shifts.id	string	O identificador único, emitido pela Square.
ID do Membro da Equipa	shifts.team_member_id	string	A ID do objeto TeamMember para o membro da equipe associado ao objeto.
ID da Localização	shifts.location_id	string	O identificador do local.
Timezone	shifts.timezone	string	O fuso horário usado para interpretar as datas do 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.
Comece em	shifts.start_at	string	O carimbo de data/hora RFC 3339 especificando a hora de início do slot disponível.
Terminar em	shifts.end_at	string	RFC 3339; deslocado para o fuso horário + deslocamento. A precisão até ao minuto é respeitada; segundos são truncados.
Title	shifts.wage.title	string	O nome do trabalho realizado durante este turno. As UIs quadradas de relatórios de trabalho podem agrupar turnos por título.
Montante	shifts.wage.hourly_rate.amount	integer	O montante.
Moeda	shifts.wage.hourly_rate.currency	string	A moeda.
Pausas	shifts.breaks	array of object
ID	shifts.breaks.id	string	Um identificador para fazer referência a este objeto.
Comece em	shifts.breaks.start_at	string	Um valor datetime no formato RFC 3339 que indica quando o intervalo de tempo começa.
Terminar em	shifts.breaks.end_at	string	Um valor datetime no formato RFC 3339 que indica quando o intervalo de tempo termina.
ID do tipo de quebra	shifts.breaks.break_type_id	string	O BreakType no qual esta quebra foi modelada.
Nome	shifts.breaks.name	string	Um nome legível por humanos.
Duração prevista	shifts.breaks.expected_duration	string	A duração esperada do intervalo. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
É pago	shifts.breaks.is_paid	boolean	Se esta pausa conta para o tempo trabalhado para efeitos de compensação.
Situação	shifts.status	string	O status de verificação atual deste 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

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

ID da Operação:: GiftCardUnlink

Desvincula um cliente de um vale-presente.

Parâmetros

Name	Chave	Necessá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	O ID do cliente a ser vinculado.

Devoluções

Name	Caminho	Tipo	Description
ID	gift_card.id	string	O identificador único, emitido pela Square.
Tipo	gift_card.type	string	O tipo deste objeto.
Fonte GAN	gift_card.gan_source	string	Indica se o número de conta do cartão-presente (GAN) é gerado pela Square ou importado de um sistema que não seja Square.
Estado	gift_card.state	string	O estado atual.
Montante	gift_card.balance_money.amount	integer	O montante.
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 deste objeto, no formato RFC 3339.

Disponibilidade da pesquisa (Beta)

ID da Operação:: BookingAvailability

Pesquisas de disponibilidades para reserva.

Parâmetros

Name	Chave	Tipo	Description
Comece em	start_at	string	Um valor datetime no formato RFC 3339 que indica quando o intervalo de tempo começa.
Terminar em	end_at	string	Um valor datetime no formato RFC 3339 que indica quando o intervalo de tempo termina.
ID da Localização	location_id	string	A expressão de consulta para procurar disponibilidades correspondentes aos IDs de local do vendedor especificados.
ID de 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

Devoluções

Name	Caminho	Tipo	Description
Disponibilidades	availabilities	array of object
Comece em	availabilities.start_at	string	O carimbo de data/hora RFC 3339 especificando a hora de início do slot disponível.
ID da Localização	availabilities.location_id	string	O identificador do local.
Segmentos de Nomeação	availabilities.appointment_segments	array of object
Duração Minutos	availabilities.appointment_segments.duration_minutes	integer	O intervalo de tempo em minutos de um segmento de compromisso.
ID do Membro da Equipa	availabilities.appointment_segments.team_member_id	string	A ID do objeto TeamMember que representa o membro da equipe reservado neste segmento.
ID de 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 de variação do 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. Devolve os pontos de fidelidade à conta de fidelidade. Não é possível excluir uma recompensa que tenha atingido o estado terminal (RESGATADO).

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de recompensa	reward_id	True	string	O identificador da recompensa.

Devoluções

response: object

Excluir tipo de quebra

ID da Operação:: LaborDeleteBreak

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.

Devoluções

response: object

Excluir trecho

ID da Operação:: SnippetDelete

Remove seu snippet de um site da Square Online.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Site	site_id	True	string	O identificador do site.

Devoluções

response: object

Excluir turno

ID da Operação:: LaborDeleteShift

Exclui um turno

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.

Devoluções

response: object

Listar atividades de vale-presente (Beta)

ID da Operação:: GiftCardList

Lista as atividades do vale-presente. Por padrão, você recebe atividades de vale-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ões-presente para um cartão-presente, para todos os cartões-presente em uma região específica ou para atividades dentro de uma janela de tempo.

Parâmetros

Name	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 retorna todas as atividades do cartão-presente para o vendedor.
Tipo	type	string	Se você fornecer um tipo, o ponto de extremidade retornará atividades de cartão de presente desse tipo. Caso contrário, o ponto de extremidade retorna todos os tipos de atividades de cartão-presente.
ID da Localização	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.
Limite	limit	integer	Limite máximo do número a devolver na resposta.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.
Ordem de classificação	sort_order	string	Classifica a lista retornada por quando o cartão foi criado com a ordem especificada.

Devoluções

Name	Caminho	Tipo	Description
Atividades do Gift Card	gift_card_activities	array of object
ID	gift_card_activities.id	string	O identificador único, emitido pela Square.
Tipo	gift_card_activities.type	string	O tipo deste objeto.
ID da Localização	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	O ID do cartão-presente. O ID não é necessário se um GAN estiver presente.
Cartão Presente GAN	gift_card_activities.gift_card_gan	string	O cartão presente GAN. O GAN não é necessário se gift_card_id estiver presente.
Montante	gift_card_activities.gift_card_balance_money.amount	integer	O montante.
Moeda	gift_card_activities.gift_card_balance_money.currency	string	A moeda.
Montante	gift_card_activities.redeem_activity_details.amount_money.amount	integer	O montante.
Moeda	gift_card_activities.redeem_activity_details.amount_money.currency	string	A moeda.
Montante	gift_card_activities.activate_activity_details.amount_money.amount	integer	O montante.
Moeda	gift_card_activities.activate_activity_details.amount_money.currency	string	A moeda.
ID da encomenda	gift_card_activities.activate_activity_details.order_id	string	O ID do pedido associado à atividade.
UID do item de linha	gift_card_activities.activate_activity_details.line_item_uid	string	A line_item_uid do item da linha do cartão-presente em um pedido.

Listar comerciantes

ID da Operação:: MerchantList

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
Cursor	cursor		integer	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.

Devoluções

Name	Caminho	Tipo	Description
Comerciante	merchant	array of object
ID	merchant.id	string	O identificador único, emitido pela Square.
Nome da Empresa	merchant.business_name	string	O nome comercial do local Este é o nome visível para os clientes do local. Por exemplo, esse nome aparece nos recibos dos clientes.
Country	merchant.country	string	O código de país ISO 3166 Alpha-2.
Código do Idioma	merchant.language_code	string	A língua associada à localização, 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 deste objeto.
ID do local principal	merchant.main_location_id	string	O 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

Name	Chave	Necessário	Tipo	Description
Limite	limit		integer	Limite máximo do número a devolver na resposta.
Cursor	cursor		string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.

Devoluções

Name	Caminho	Tipo	Description
Configurações da semana de trabalho	workweek_configs	array of object
ID	workweek_configs.id	string	O identificador único, emitido pela Square.
Início da Semana	workweek_configs.start_of_week	string	O dia da semana em que termina uma semana útil para efeitos de compensação.
Início do dia, hora local	workweek_configs.start_of_day_local_time	string	A hora local em que uma semana de negócios termina. Representada como uma cadeia de caracteres no formato HH:MM (HH:MM:SS também é aceito, mas os 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 este ponto de extremidade para recuperar o próximo conjunto de resultados associado à consulta original.

Listar contas bancárias

ID da Operação:: BankAccountList

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

Parâmetros

Name	Chave	Tipo	Description
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.
Limite	limit	integer	Limite máximo do número a devolver na resposta.
ID da Localização	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.

Devoluções

Name	Caminho	Tipo	Description
Conta bancária	bank_accounts	array of object
ID	bank_accounts.id	string	O identificador único, emitido pela Square.
Sufixo do número da conta	bank_accounts.account_number_suffix	string	Os últimos dígitos do número da conta.
Country	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 da conta bancária de destino.
Número de identificação bancária principal	bank_accounts.primary_bank_identification_number	string	Identificador primário do banco.
ID da Localização	bank_accounts.location_id	string	O identificador do local.
Situação	bank_accounts.status	string	O status de verificação atual deste objeto.
Creditável	bank_accounts.creditable	boolean	Indica se é possível para a Square enviar dinheiro para esta conta bancária.
Debitável	bank_accounts.debitable	boolean	Indica se é possível para a Square enviar dinheiro para esta 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 de dispositivo

ID da Operação:: DeviceList

Lista todos os DeviceCodes associados ao comerciante.

Parâmetros

Name	Chave	Tipo	Description
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.
ID da Localização	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 visando o 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.

Devoluções

Name	Caminho	Tipo	Description
Códigos do dispositivo	device_codes	array of object
ID	device_codes.id	string	O identificador único, emitido pela Square.
Nome	device_codes.name	string	O nome do objeto.
Código	device_codes.code	string	O código exclusivo que pode ser usado para fazer login.
Tipo de Produto	device_codes.product_type	string	O tipo de produto de segmentação do código do dispositivo.
ID da Localização	device_codes.location_id	string	O identificador do local.
Criado em	device_codes.created_at	string	A hora do evento no formato ISO 8601.
Par Por	device_codes.pair_by	string	Quando este DeviceCode expirar e não fizer mais login. Carimbo de data/hora no formato RFC 3339.
Situação	device_codes.status	string	O status de verificação atual deste objeto.
ID do dispositivo	device_codes.device_id	string	A ID exclusiva do dispositivo que usou esse código. Preenchido quando o dispositivo está 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 mudança 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

Name	Chave	Necessário	Tipo	Description
ID do turno	shift_id	True	string	O identificador do turno.
ID da Localização	location_id	True	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.
Limite	limit		integer	Limite máximo do número a devolver na resposta.
Cursor	cursor		string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.

Devoluções

Name	Caminho	Tipo	Description
Events	events	array of object
ID	events.id	string	O identificador único, emitido pela Square.
Tipo de Evento	events.event_type	string	O tipo de evento de mudança de gaveta de dinheiro.
Montante	events.event_money.amount	integer	O montante.
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.

Devoluções

Name	Caminho	Tipo	Description
Localizações	locations	array of object
ID	locations.id	string	O identificador único, emitido pela Square.
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 localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	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 as datas do 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 deste objeto.
Criado em	locations.created_at	string	A hora do evento no formato ISO 8601.
ID do comerciante	locations.merchant_id	string	O ID do comerciante proprietário da localização.
Country	locations.country	string	O código de país ISO 3166 Alpha-2.
Código do Idioma	locations.language_code	string	A língua associada à localização, 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 da Empresa	locations.business_name	string	O nome comercial do local Este é o nome visível para os clientes do local. Por exemplo, esse nome aparece nos recibos dos clientes.

Listar perfis de reserva de membros da equipe (Beta)

ID da Operação:: BookingListTeamProfiles

Lista perfis de reserva para membros da equipe.

Parâmetros

Name	Chave	Tipo	Description
Apenas reservável	bookable_only	boolean	Indica se apenas os membros da equipe que podem ser reservados no resultado retornado (true) ou não (false) deve ser incluído.
Limite	limit	integer	Limite máximo do número a devolver na resposta.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.
ID da Localização	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.

Devoluções

Name	Caminho	Tipo	Description
Perfis de Reserva de Membros da Equipa	team_member_booking_profiles	array of object
ID do Membro da Equipa	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 para exibição do membro da equipe.
É reservável	team_member_booking_profiles.is_bookable	boolean	Indica se o membro da equipa pode ser reservado através da API de reservas ou do canal ou site de reservas online do vendedor (true) ou não (false').
Errors	errors	array of

Listar salários dos membros da equipe

ID da Operação:: LaborListWages

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

Parâmetros

Name	Chave	Tipo	Description
ID do Membro da Equipa	team_member_id	string	Filtre os salários devolvidos apenas para aqueles que estão associados ao membro da equipe especificado.
Limite	limit	integer	Limite máximo do número a devolver na resposta.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.

Devoluções

Name	Caminho	Tipo	Description
Salários dos Membros da Equipa	team_member_wages	array of object
ID	team_member_wages.id	string	O identificador único, emitido pela Square.
ID do Membro da Equipa	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.
Montante	team_member_wages.hourly_rate.amount	integer	O montante.
Moeda	team_member_wages.hourly_rate.currency	string	A moeda.
Cursor	cursor	string	Inclua o cursor de paginação em chamadas subsequentes para este ponto de extremidade para recuperar o próximo conjunto de resultados associado à consulta original.

Listar sites

ID da Operação:: SiteList

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

Devoluções

Name	Caminho	Tipo	Description
Sites	sites	array of object
ID	sites.id	string	O identificador único, emitido pela Square.
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 está 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

Name	Chave	Tipo	Description
ID da Localização	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 por 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.
Limite	limit	integer	Limite máximo do número a devolver na resposta.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.

Devoluções

Name	Caminho	Tipo	Description
Itens	items	array of object
ID	items.id	string	O identificador único, emitido pela Square.
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	O tempo de fechamento do turno no formato ISO 8601.
Description	items.title	string	A descrição.
Montante	items.opened_cash_money.amount	integer	O montante.
Moeda	items.opened_cash_money.currency	string	A moeda.
Montante	items.expected_cash_money.amount	integer	O montante.
Moeda	items.expected_cash_money.currency	string	A moeda.
Montante	items.closed_cash_money.amount	integer	O montante.
Moeda	items.closed_cash_money.currency	string	A moeda.

Local de atualização (Beta)

ID da Operação:: LocationUpdate

Atualiza um local.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Localização	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	O URL do perfil do Facebook do local. O 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 da rua, nome da rua e nome do edifício.
Distrito Administrativo Nível 1	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 localidade do endereço.
Código Postal	postal_code		string	Código postal do endereço.
Dia Da Semana	day_of_week		string	O dia da semana para este período de tempo.
Iniciar hora local	start_local_time		string	A hora de início de um período de horário comercial, especificada na hora local usando o formato RFC 3339 de tempo parcial.
Hora local final	end_local_time		string	A hora de término de um período de horário comercial, especificada na hora local usando o formato RFC 3339 de tempo parcial.

Devoluções

Name	Caminho	Tipo	Description
ID	location.id	string	O identificador único, emitido pela Square.
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 da rua, nome da rua e nome do edifício.
Localidade	location.address.locality	string	A cidade ou localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Timezone	location.timezone	string	O fuso horário usado para interpretar 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 deste objeto.
Criado em	location.created_at	string	O carimbo de data/hora que especifica a hora de criação deste objeto, no formato RFC 3339.
ID do comerciante	location.merchant_id	string	O ID do comerciante.
Country	location.country	string	O código de país ISO 3166 Alpha-2.
Código do Idioma	location.language_code	string	O código da língua, 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 da Empresa	location.business_name	string	O nome comercial do local Este é o nome visível para os clientes do local. Por exemplo, esse nome aparece nos recibos dos clientes.
Tipo	location.type	string	O tipo deste objeto.
URL do site	location.website_url	string	O 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 este 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, especificada na hora local usando o formato RFC 3339 de tempo parcial.
Hora local final	location.business_hours.periods.end_local_time	string	A hora de término de um período de horário comercial, especificada na hora local usando o formato RFC 3339 de tempo parcial.
E-mail comercial	location.business_email	string	O e-mail do local. Este e-mail é visível para os clientes do local. Por exemplo, o e-mail aparece 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.
CCM	location.mcc	string	O código de categoria do comerciante (MCC) 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

Name	Chave	Tipo	Description
ID de Referência	reference_id	string	Um segundo ID usado para associar o membro da equipe a uma entidade em outro sistema.
É Proprietário	is_owner	boolean	Se o membro da equipa é o proprietário da conta Square.
Situação	status	string	Descreve o status do membro da equipe.
Nome Próprio	given_name	string	O nome próprio (ou seja, o primeiro nome) associado ao membro da equipa.
Nome de família	family_name	string	O nome de família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de E-mail	email_address	string	O endereço de e-mail associado ao membro da equipe.
Número de Telefone	phone_number	string	O número de telefone do membro da equipa, em 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	Um segundo ID usado para associar o membro da equipe a uma entidade em outro sistema.
É Proprietário	is_owner	boolean	Se o membro da equipa é o proprietário da conta Square.
Situação	status	string	Descreve o status do membro da equipe.
Nome Próprio	given_name	string	O nome próprio (ou seja, o primeiro nome) associado ao membro da equipa.
Nome de família	family_name	string	O nome de família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de E-mail	email_address	string	O endereço de e-mail associado ao membro da equipe.
Número de Telefone	phone_number	string	O número de telefone do membro da equipa, em formato E.164.
Tipo de Atribuição	assignment_type	string	O tipo de atribuição atual do membro da equipe.

Devoluções

Name	Caminho	Tipo	Description
ID	team_members.team_member_id.team_member.id	string	Um identificador para fazer referência a este objeto.
ID de Referência	team_members.team_member_id.team_member.reference_id	string	Um segundo ID usado 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 equipa é 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 Próprio	team_members.team_member_id.team_member.given_name	string	O nome próprio (ou seja, o primeiro nome) associado ao membro da equipa.
Nome de família	team_members.team_member_id.team_member.family_name	string	O nome de família (ou seja, o sobrenome) associado ao membro da equipe.
Endereço de E-mail	team_members.team_member_id.team_member.email_address	string	O endereço de e-mail 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 equipa, em 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

Obter conta bancária

ID da Operação:: BankAccountGet

Devolve os detalhes de uma Conta Bancária associada a uma conta Square.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da conta bancária	bank_account_id	True	string	ID de emissão quadrada da Conta Bancária pretendida.

Devoluções

Name	Caminho	Tipo	Description
ID	bank_account.id	string	O identificador único, emitido pela Square.
Sufixo do número da conta	bank_account.account_number_suffix	string	Os últimos dígitos do número da conta.
Country	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 bancária principal	bank_account.primary_bank_identification_number	string	Identificador primário do banco.
ID da Localização	bank_account.location_id	string	O identificador do local.
Situação	bank_account.status	string	O status de verificação atual deste objeto.
Creditável	bank_account.creditable	boolean	Indica se é possível para a Square enviar dinheiro para esta conta.
Debitável	bank_account.debitable	boolean	Indica se é possível a Square retirar dinheiro desta 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 V1

ID da Operação:: BankAccountGetV1

Devolve os detalhes de uma Conta Bancária identificada pelo ID da conta bancária V1.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da conta bancária V1	v1_bank_account_id	True	string	Conecte o ID V1 da conta bancária desejada.

Devoluções

Name	Caminho	Tipo	Description
ID	bank_account.id	string	O identificador único, emitido pela Square.
Sufixo do número da conta	bank_account.account_number_suffix	string	Os últimos dígitos do número da conta.
Country	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 bancária principal	bank_account.primary_bank_identification_number	string	Identificador primário do banco.
ID da Localização	bank_account.location_id	string	O identificador do local.
Situação	bank_account.status	string	O status de verificação atual deste objeto.
Creditável	bank_account.creditable	boolean	Indica se é possível para a Square enviar dinheiro para esta conta.
Debitável	bank_account.debitable	boolean	Indica se é possível a Square retirar dinheiro desta 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 o ID associado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.

Devoluções

Name	Caminho	Tipo	Description
ID	device_code.id	string	O identificador único, emitido pela Square.
Nome	device_code.name	string	O nome do objeto.
Código	device_code.code	string	O código exclusivo que pode ser usado para fazer login.
Tipo de Produto	device_code.product_type	string	O tipo de produto de segmentação do código do dispositivo.
ID da Localização	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 deste objeto, no formato RFC 3339.
Par Por	device_code.pair_by	string	Quando este DeviceCode expirar e não fizer mais login. Carimbo de data/hora no formato RFC 3339.
Situação	device_code.status	string	O status de verificação atual deste objeto.
ID do dispositivo	device_code.device_id	string	O 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 por id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.

Devoluções

Name	Caminho	Tipo	Description
ID	team_member_wage.id	string	O identificador único, emitido pela Square.
ID do Membro da Equipa	team_member_wage.team_member_id	string	O ID do membro da equipe.
Title	team_member_wage.title	string	O título.
Montante	team_member_wage.hourly_rate.amount	integer	O montante.
Moeda	team_member_wage.hourly_rate.currency	string	A moeda.

Obter tipo de quebra

ID da Operação:: LaborGetBreak

Retorna um único BreakType especificado por id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.

Devoluções

Name	Caminho	Tipo	Description
ID	break_type.id	string	O identificador único, emitido pela Square.
ID da Localização	break_type.location_id	string	O identificador do local.
Nome da quebra	break_type.break_name	string	Um nome legível por humanos para este tipo de pausa. O nome é exibido aos funcionários em produtos Square.
Duração prevista	break_type.expected_duration	string	A duração esperada desta pausa. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. A precisão inferior a minutos é truncada.
É pago	break_type.is_paid	boolean	Se esta pausa conta para o tempo trabalhado para efeitos 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 deste 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 deste objeto, no formato RFC 3339.

Obter turno

ID da Operação:: LaborGetShift

Retorna um único Shift especificado por id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.

Devoluções

Name	Caminho	Tipo	Description
ID	shift.id	string	O identificador único, emitido pela Square.
ID do Membro da Equipa	shift.team_member_id	string	O ID do membro da equipe.
ID do funcionário	shift.employee_id	string	O ID gerado pelo quadrado do funcionário.
ID da Localização	shift.location_id	string	O identificador do local.
Timezone	shift.timezone	string	O fuso horário usado para interpretar 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.
Comece em	shift.start_at	string	O carimbo de data/hora especificando a hora de início deste objeto, no formato RFC 3339.
Terminar em	shift.end_at	string	RFC 3339; deslocado para o fuso horário + deslocamento. A precisão até ao minuto é respeitada; segundos são truncados.
Title	shift.wage.title	string	O nome do trabalho realizado durante este turno. As UIs quadradas de relatórios de trabalho podem agrupar turnos por título.
Montante	shift.wage.hourly_rate.amount	integer	O montante.
Moeda	shift.wage.hourly_rate.currency	string	A moeda.
Pausas	shift.breaks	array of object
ID	shift.breaks.id	string	O identificador do objeto
Comece em	shift.breaks.start_at	string	RFC 3339; segue as mesmas informações de fuso horário que Shift. A precisão até ao 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é ao minuto é respeitada; segundos são truncados.
ID do tipo de quebra	shift.breaks.break_type_id	string	O BreakType no qual esta quebra foi modelada.
Nome	shift.breaks.name	string	O nome do item. Este é 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 prevista	shift.breaks.expected_duration	string	A duração esperada do intervalo. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
É pago	shift.breaks.is_paid	boolean	Se esta pausa conta para o tempo trabalhado para efeitos de compensação.
Situação	shift.status	string	O status de verificação atual deste 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 deste 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 deste objeto, no formato RFC 3339.

Pesquisar contas de fidelidade

ID da Operação:: LoyaltySearchAccounts

Procura contas de fidelidade em um programa de fidelidade.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Limite	limit		integer	Um limite para o 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 superior ao limite máximo de 1.000, ele será ignorado.

Devoluções

Name	Caminho	Tipo	Description
Contas de fidelização	loyalty_accounts	array of object
ID	loyalty_accounts.id	string	O identificador único, emitido pela Square.
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	O ID atribuído ao quadrado do programa de fidelidade ao qual a conta pertence.
Equilíbrio	loyalty_accounts.balance	integer	O saldo de pontos disponível na conta de fidelidade.
Pontos vitalícios	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	O ID atribuído ao 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 este ponto de extremidade para recuperar o próximo conjunto de resultados associado à consulta original.

Pesquisar eventos de fidelização

ID da Operação:: LoyaltySearchEvents

Pesquisas por eventos de fidelidade. Um programa de fidelidade da Square mantém um livro de eventos que ocorrem durante a vida útil 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 livro-razão. Usando esse ponto de extremidade, você pode pesquisar eventos no livro-razão.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da encomenda	order_id		string	O identificador de ordem.
Limite	limit		integer	Um limite para o 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 superior ao limite máximo de 1.000, ele será ignorado.

Devoluções

Name	Caminho	Tipo	Description
Events	events	array of object
ID	events.id	string	O identificador único, emitido pela Square.
Tipo	events.type	string	O tipo deste objeto.
Criado em	events.created_at	string	A hora do evento no formato ISO 8601.
ID do Programa de Fidelização	events.accumulate_points.loyalty_program_id	string	O ID do programa de fidelidade
Pontos	events.accumulate_points.points	integer	O número de pontos acumulados pelo evento.
ID da encomenda	events.accumulate_points.order_id	string	O ID do pedido associado à atividade.
ID da conta de fidelidade	events.loyalty_account_id	string	O ID da conta de fidelidade na qual o evento ocorreu.
ID da Localização	events.location_id	string	O identificador do local.
Fonte	events.source	string	Define se o evento foi gerado pelo Ponto de Venda Quadrado.
ID do Programa de Fidelização	events.redeem_reward.loyalty_program_id	string	O ID do programa de fidelidade
ID de recompensa	events.redeem_reward.reward_id	string	O ID da recompensa de fidelidade resgatada.
ID da encomenda	events.redeem_reward.order_id	string	O ID do pedido associado à atividade.
ID do Programa de Fidelização	events.create_reward.loyalty_program_id	string	O ID do programa de fidelidade
ID de recompensa	events.create_reward.reward_id	string	O ID da recompensa de fidelidade resgatada.
Pontos	events.create_reward.points	integer	O número de pontos acumulados pelo evento.

Pesquisar membros da equipa

ID da Operação:: TeamSearch

Retorna uma lista paginada de objetos TeamMember para uma empresa.

Parâmetros

Name	Chave	Tipo	Description
IDs de localização	location_ids	array of string
Situação	status	string	O status atual.
Limite	limit	integer	Um limite para o 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 superior ao limite máximo de 1.000, ele será ignorado.

Devoluções

Name	Caminho	Tipo	Description
Membros da Equipa	team_members	array of object
ID	team_members.id	string	O identificador único, emitido pela Square.
ID de Referência	team_members.reference_id	string	Um segundo ID opcional usado para associar o perfil do cliente a uma entidade em outro sistema.
É Proprietário	team_members.is_owner	boolean	Se o membro da equipa é o proprietário da conta Square.
Situação	team_members.status	string	O status de verificação atual deste objeto.
Nome Próprio	team_members.given_name	string	O nome dado (ou seja, o primeiro) associado ao perfil do cliente.
Nome de família	team_members.family_name	string	O nome da família (ou seja, o último) associado ao perfil do cliente.
Endereço de E-mail	team_members.email_address	string	O endereço de e-mail 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 este ponto de extremidade para recuperar o próximo conjunto de resultados associado à consulta original.

Pesquise recompensas de fidelidade

ID da Operação:: LoyaltySearchRewards

Procura recompensas de fidelidade em uma conta de fidelidade.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da conta de fidelidade	loyalty_account_id		string	O ID da conta de fidelidade na qual o evento ocorreu.
Limite	limit		integer	Um limite para o 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 superior ao limite máximo de 1.000, ele será ignorado.

Devoluções

Name	Caminho	Tipo	Description
Recompensas	rewards	array of object
ID	rewards.id	string	O identificador único, emitido pela Square.
Situação	rewards.status	string	O status de verificação atual deste objeto.
ID da conta de fidelidade	rewards.loyalty_account_id	string	O ID da conta de fidelidade na qual o evento ocorreu.
ID do Nível de Recompensa	rewards.reward_tier_id	string	O ID atribuído ao quadrado do nível de recompensa usado para criar a recompensa.
Pontos	rewards.points	integer	O número de pontos de fidelidade usados para a recompensa.
ID da encomenda	rewards.order_id	string	O ID do pedido.
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 cartão-presente (Beta)

ID da Operação:: GiftCardRetrieve

Recupera um cartão-presente usando sua identificação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.

Devoluções

Name	Caminho	Tipo	Description
ID	gift_card.id	string	O identificador único, emitido pela Square.
Tipo	gift_card.type	string	O tipo deste objeto.
Fonte GAN	gift_card.gan_source	string	Indica se o número de conta do cartão-presente (GAN) é gerado pela Square ou importado de um sistema que não seja Square.
Estado	gift_card.state	string	O estado atual.
Montante	gift_card.balance_money.amount	integer	O montante.
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 deste 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 de conta do cartão-presente (GAN).

Parâmetros

Name	Chave	Necessário	Tipo	Description
GaN	gan		string	O número da conta do cartão-presente.

Devoluções

Name	Caminho	Tipo	Description
ID	gift_card.id	string	O identificador único, emitido pela Square.
Tipo	gift_card.type	string	O tipo deste objeto.
Fonte GAN	gift_card.gan_source	string	Indica se o número de conta do cartão-presente (GAN) é gerado pela Square ou importado de um sistema que não seja Square.
Estado	gift_card.state	string	O estado atual.
Montante	gift_card.balance_money.amount	integer	O montante.
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 deste 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

Name	Chave	Necessário	Tipo	Description
Nonce	nonce		string	O nonce do vale-presente para recuperar.

Devoluções

Name	Caminho	Tipo	Description
ID	gift_card.id	string	O identificador único, emitido pela Square.
Tipo	gift_card.type	string	O tipo deste objeto.
Fonte GAN	gift_card.gan_source	string	Indica se o número de conta do cartão-presente (GAN) é gerado pela Square ou importado de um sistema que não seja Square.
Estado	gift_card.state	string	O estado atual.
Montante	gift_card.balance_money.amount	integer	O montante.
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 deste objeto, no formato RFC 3339.

Recuperar comerciante

ID da Operação:: MerchantRetrieve

Recupere um objeto Merchant para o merchant_id determinado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do comerciante	merchant_id	True	string	O identificador do comerciante.

Devoluções

Name	Caminho	Tipo	Description
ID	merchant.id	string	O identificador único, emitido pela Square.
Nome da Empresa	merchant.business_name	string	O nome comercial do local Este é o nome visível para os clientes do local. Por exemplo, esse nome aparece nos recibos dos clientes.
Country	merchant.country	string	O código de país ISO 3166 Alpha-2.
Código do Idioma	merchant.language_code	string	O código da língua, 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 deste objeto.
ID do local principal	merchant.main_location_id	string	O ID da Localização principal deste comerciante.

Recuperar conta de fidelidade

ID da Operação:: LoyaltyRetrieveAccount

Recupera uma conta de fidelidade.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da conta	account_id	True	string	O identificador da conta.

Devoluções

Name	Caminho	Tipo	Description
ID	loyalty_account.id	string	O identificador único, emitido pela Square.
ID	loyalty_account.mapping.id	string	O ID atribuído 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 ao quadrado do programa.
Equilíbrio	loyalty_account.balance	integer	O saldo disponível.
Pontos vitalícios	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 deste objeto que representa o cliente.
Criado em	loyalty_account.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.

Recuperar definição salarial

ID da Operação:: TeamRetrieveWage

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Membro da Equipa	team_member_id	True	string	O identificador do membro da equipe.

Devoluções

Name	Caminho	Tipo	Description
ID do Membro da Equipa	wage_setting.team_member_id	string	O ID do membro da equipe.
Atribuições de Cargos	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 para a atribuição de trabalho usado para calcular o valor do pagamento em um período de pagamento.
Montante	wage_setting.job_assignments.hourly_rate.amount	integer	O montante.
Moeda	wage_setting.job_assignments.hourly_rate.currency	string	A moeda.
Montante	wage_setting.job_assignments.annual_rate.amount	integer	O montante.
Moeda	wage_setting.job_assignments.annual_rate.currency	string	A moeda.
Horas Semanais	wage_setting.job_assignments.weekly_hours	integer	As horas semanais planeadas para o trabalho. Defina se o trabalho PayType é SALARY.
Está isenta de horas extraordinárias	wage_setting.is_overtime_exempt	boolean	Se o membro da equipa está isento das regras de horas extraordinárias 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 deste 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 deste objeto, no formato RFC 3339.

Recuperar localização

ID da Operação:: LocationRetrieve

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Localização	location_id	True	string	O identificador do local.

Devoluções

Name	Caminho	Tipo	Description
ID	location.id	string	O identificador único, emitido pela Square.
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 da rua, nome da rua e nome do edifício.
Localidade	location.address.locality	string	A cidade ou localidade do endereço.
Distrito Administrativo Nível 1	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	Código postal do endereço.
Country	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 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 deste objeto.
Criado em	location.created_at	string	O carimbo de data/hora que especifica a hora de criação deste objeto, no formato RFC 3339.
ID do comerciante	location.merchant_id	string	O ID do comerciante.
Country	location.country	string	O código de país ISO 3166 Alpha-2.
Código do Idioma	location.language_code	string	O código da língua, 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 da Empresa	location.business_name	string	O nome comercial do local Este é o nome visível para os clientes do local. Por exemplo, esse nome aparece nos recibos dos clientes.

Recuperar membro da equipe

ID da Operação:: TeamRetrieveMember

Recupera um objeto TeamMember para a ID TeamMember fornecida.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Membro da Equipa	team_member_id	True	string	O identificador do membro da equipe.

Devoluções

Name	Caminho	Tipo	Description
ID	team_member.id	string	O identificador único, emitido pela Square.
ID de Referência	team_member.reference_id	string	Um ID de referência opcional definido pelo usuário.
É Proprietário	team_member.is_owner	boolean	Se o membro da equipa é o proprietário da conta Square.
Situação	team_member.status	string	O status de verificação atual deste objeto.
Nome Próprio	team_member.given_name	string	O nome dado (ou seja, o primeiro) associado ao perfil do cliente.
Nome de família	team_member.family_name	string	O nome da família (ou seja, o último) associado ao perfil do cliente.
Endereço de E-mail	team_member.email_address	string	O endereço de e-mail 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 deste 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 deste 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 perfil de reserva de negócios (Beta)

ID da Operação:: BookingRetrieveProfile

Recupera o perfil de reserva de um vendedor.

Devoluções

Name	Caminho	Tipo	Description
ID do vendedor	business_booking_profile.seller_id	string	O ID do vendedor, que pode ser obtido usando a API de comerciantes.
Criado em	business_booking_profile.created_at	string	O carimbo de data/hora que especifica a hora de criação deste objeto, no formato RFC 3339.
Reserva ativada	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 reservas online da Square e todas as notificações aos clientes usa o fuso horário da localização do vendedor ou o fuso horário que o cliente escolhe na reserva.
Política de Reservas	business_booking_profile.booking_policy	string	A política para o vendedor aceitar automaticamente pedidos 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 Tempo Segundos	business_booking_profile.business_appointment_settings.min_booking_lead_time_seconds	integer	O tempo de entrega mínimo em segundos antes de um serviço poder ser reservado. As reservas devem ser criadas pelo menos muito antes da hora de início da reserva.
Max Booking Lead Time Segundos	business_booking_profile.business_appointment_settings.max_booking_lead_time_seconds	integer	O tempo máximo de entrega em segundos antes de um serviço poder ser reservado. As reservas devem ser criadas, no máximo, muito antes da hora de início da reserva.
Qualquer reserva de membro da equipa ativada	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 ativada	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.
Montante	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.
Pular Seleção de Pessoal do Fluxo de Reservas	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 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 pelo ID do programa ou pela palavra-chave principal. Os programas de fidelidade definem como os compradores podem ganhar pontos e trocar pontos por recompensas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do programa	program_id	True	string	O identificador do programa.

Devoluções

Name	Caminho	Tipo	Description
ID	program.id	string	O identificador único, emitido pela Square.
Situação	program.status	string	O status de verificação atual deste objeto.
Níveis 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. Este é 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 o nível de recompensa oferece.
Desconto Percentual	program.reward_tiers.definition.percentage_discount	string	A percentagem fixa 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 é chamado 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 deste 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 deste objeto, no formato RFC 3339.
Regras de especialização económica	program.accrual_rules	array of object
Tipo de especialização económica	program.accrual_rules.accrual_type	string	O tipo de regra de acumulação que define como os compradores podem ganhar pontos.
Pontos	program.accrual_rules.points	integer	O número de pontos acumulados pelo evento.
Montante	program.accrual_rules.spend_amount_money.amount	integer	O montante.
IDs de categoria excluídos	program.accrual_rules.excluded_category_ids	array of string
IDs de variação de item excluídos	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

Name	Chave	Necessário	Tipo	Description
ID de recompensa	reward_id	True	string	O identificador da recompensa.

Devoluções

Name	Caminho	Tipo	Description
ID	reward.id	string	O identificador único, emitido pela Square.
Situação	reward.status	string	O status de verificação atual deste objeto.
ID da conta de fidelidade	reward.loyalty_account_id	string	O ID da conta de fidelidade na qual o evento ocorreu.
ID do Nível de Recompensa	reward.reward_tier_id	string	O ID atribuído ao quadrado do nível de recompensa usado 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 deste 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 deste 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 trecho

ID da Operação:: SnippetRetrieve

Recupera seu trecho de um site da Square Online. Um site pode conter trechos de vários aplicativos de trechos, mas você pode recuperar apenas o trecho que foi adicionado pelo seu aplicativo.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Site	site_id	True	string	O identificador do site.

Devoluções

Name	Caminho	Tipo	Description
ID	snippet.id	string	O identificador único, emitido pela Square.
ID do Site	snippet.site_id	string	A ID do site que contém o trecho.
Content	snippet.content	string	O código do trecho, que pode conter HTML, JavaScript ou ambos válidos.
Criado em	snippet.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.

Recuperar turno de gaveta de dinheiro

ID da Operação:: CashDrawerRetrieveShift

Fornece os detalhes resumidos para um único turno de gaveta de dinheiro.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do turno	shift_id	True	string	O identificador do turno.
ID da Localização	location_id	True	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.

Devoluções

Name	Caminho	Tipo	Description
ID	cash_drawer_shift.id	string	O identificador único, emitido pela Square.
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 o turno terminou, no formato ISO 8601.
Fechado em	cash_drawer_shift.closed_at	string	O tempo quando fechado, no formato ISO 8601.
Abrindo ID de funcionário	cash_drawer_shift.opening_employee_id	string	O ID do funcionário que iniciou o turno da gaveta de dinheiro.
Fim da ID do funcionário	cash_drawer_shift.ending_employee_id	string	O ID do funcionário que encerrou o turno da gaveta de dinheiro.
Fechando a ID do funcionário	cash_drawer_shift.closing_employee_id	string	O 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.
Montante	cash_drawer_shift.opened_cash_money.amount	integer	O montante.
Moeda	cash_drawer_shift.opened_cash_money.currency	string	A moeda.
Montante	cash_drawer_shift.cash_payment_money.amount	integer	O montante.
Moeda	cash_drawer_shift.cash_payment_money.currency	string	A moeda.
Montante	cash_drawer_shift.cash_refunds_money.amount	integer	O montante.
Moeda	cash_drawer_shift.cash_refunds_money.currency	string	A moeda.
Montante	cash_drawer_shift.cash_paid_in_money.amount	integer	O montante.
Moeda	cash_drawer_shift.cash_paid_in_money.currency	string	A moeda.
Montante	cash_drawer_shift.cash_paid_out_money.amount	integer	O montante.
Moeda	cash_drawer_shift.cash_paid_out_money.currency	string	A moeda.
Montante	cash_drawer_shift.expected_cash_money.amount	integer	O montante.
Moeda	cash_drawer_shift.expected_cash_money.currency	string	A moeda.
Montante	cash_drawer_shift.closed_cash_money.amount	integer	O montante.
Moeda	cash_drawer_shift.closed_cash_money.currency	string	A moeda.
Nome	cash_drawer_shift.device.name	string	O nome.

Resgatar recompensa de fidelidade

ID da Operação:: LoyaltyRedeemReward

Resgata uma recompensa de fidelidade. Depois que a recompensa atingir o estado terminal, ela não poderá ser excluída. Por outras palavras, os pontos utilizados para a recompensa não podem ser devolvidos à conta.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID de recompensa	reward_id	True	string	O identificador da recompensa.
Chave de idempotência	idempotency_key		string	Um valor especificado que identifica exclusivamente essa solicitação entre todas as suas solicitações. Uma maneira comum de criar uma chave de idempotência válida é usar um identificador universalmente exclusivo (UUID).
ID da Localização	location_id		string	O identificador de localização.

Devoluções

Name	Caminho	Tipo	Description
ID	event.id	string	O identificador único, emitido pela Square.
Tipo	event.type	string	O tipo deste objeto.
Criado em	event.created_at	string	O carimbo de data/hora que especifica a hora de criação deste objeto, no formato RFC 3339.
ID do Programa de Fidelização	event.redeem_reward.loyalty_program_id	string	O ID do programa de fidelidade
ID de recompensa	event.redeem_reward.reward_id	string	O ID atribuído ao quadrado da recompensa de fidelidade.
ID da conta de fidelidade	event.loyalty_account_id	string	O ID da conta de fidelidade na qual o evento ocorreu.
ID da Localização	event.location_id	string	O identificador do local.
Fonte	event.source	string	A fonte.

Tipo de interrupção de atualização

ID da Operação:: LaborUpdateBreak

Atualiza um BreakType existente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID	id	True	string	O identificador.
ID da Localização	location_id		string	O identificador do local.
Nome da quebra	break_name		string	Um nome legível por humanos para este tipo de pausa. O nome é exibido aos funcionários em produtos Square.
Duração prevista	expected_duration		string	A duração esperada desta pausa. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. A precisão inferior a minutos é truncada.
É pago	is_paid		boolean	Se esta pausa conta para o tempo trabalhado para efeitos de compensação.
Versão	version		integer	A versão atual deste objeto.

Devoluções

Name	Caminho	Tipo	Description
ID	break_type.id	string	O identificador único, emitido pela Square.
ID da Localização	break_type.location_id	string	O identificador do local.
Nome da quebra	break_type.break_name	string	Um nome legível por humanos para este tipo de pausa. O nome é exibido aos funcionários em produtos Square.
Duração prevista	break_type.expected_duration	string	A duração esperada desta pausa. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. A precisão inferior a minutos é truncada.
É pago	break_type.is_paid	boolean	Se esta pausa conta para o tempo trabalhado para efeitos 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 deste 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 deste 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

Name	Chave	Tipo	Description
ID da Localização	location_id	string	Você pode especificar esse filtro opcional para recuperar apenas os registros pertencentes a um local específico.
Limite	limit	integer	Limite máximo do número a devolver na resposta.
Cursor	cursor	string	O cursor de paginação retornado por uma chamada anterior para este ponto de extremidade.

Devoluções

Name	Caminho	Tipo	Description
Tipos de quebra	break_types	array of object
ID	break_types.id	string	O identificador único, emitido pela Square.
ID da Localização	break_types.location_id	string	O identificador do local.
Nome da quebra	break_types.break_name	string	Um nome legível por humanos para este tipo de pausa. O nome é exibido aos funcionários em produtos Square.
Duração prevista	break_types.expected_duration	string	A duração esperada desta pausa. Formato: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. A precisão inferior a minutos é truncada.
É pago	break_types.is_paid	boolean	Se esta pausa conta para o tempo trabalhado para efeitos 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 este ponto de extremidade para recuperar o próximo conjunto de resultados associado à consulta original.

Trecho de 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 do trecho é anexado ao final do elemento head em todas as páginas do site, exceto nas páginas de checkout. Um aplicativo de snippet pode adicionar um snippet a um determinado site.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do Site	site_id	True	string	O identificador do site.
Content	content		string	O código do trecho, que pode conter HTML, JavaScript ou ambos válidos.

Devoluções

Name	Caminho	Tipo	Description
ID	snippet.id	string	O identificador único, emitido pela Square.
ID do Site	snippet.site_id	string	A ID do site que contém o trecho.
Content	snippet.content	string	O código do trecho, que pode conter HTML, JavaScript ou ambos válidos.
Criado em	snippet.created_at	string	O carimbo de data/hora que especifica a hora de criação deste 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 deste objeto, no formato RFC 3339.

Vincular o cliente ao cartão-presente (Beta)

ID da Operação:: GiftCardLink

Vincula um cliente a um vale-presente

Parâmetros

Name	Chave	Necessá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	O ID do cliente a ser vinculado.

Devoluções

Name	Caminho	Tipo	Description
ID	gift_card.id	string	O identificador único, emitido pela Square.
Tipo	gift_card.type	string	O tipo deste objeto.
Fonte GAN	gift_card.gan_source	string	Indica se o número de conta do cartão-presente (GAN) é gerado pela Square ou importado de um sistema que não seja Square.
Estado	gift_card.state	string	O estado atual.
Montante	gift_card.balance_money.amount	integer	O montante.
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 deste objeto, no formato RFC 3339.
IDs do cliente	gift_card.customer_ids	array of string

Definições

objecto

Este é o tipo 'objeto'.

Partilhar via

Square Business (Editora Independente) (Pré-visualização)

Limites de Limitação

Ações

Acumule pontos de fidelidade

Parâmetros

Devoluções

Ajustar pontos de fidelidade

Parâmetros

Devoluções

Atualizar a definição de salários

Parâmetros

Devoluções

Atualizar configuração da semana de trabalho

Parâmetros

Devoluções

Atualizar membro da equipa

Parâmetros

Devoluções

Atualizar turno

Parâmetros

Devoluções

Calcular pontos de fidelidade

Parâmetros

Devoluções

Criar atividade de cartão-presente (Beta)

Parâmetros

Devoluções

Criar check-out

Parâmetros

Devoluções

Criar conta de fidelidade

Parâmetros

Devoluções

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

Parâmetros

Devoluções

Criar código de dispositivo

Parâmetros

Devoluções

Criar localização (Beta)

Parâmetros

Devoluções

Criar membro da equipa

Parâmetros

Devoluções

Criar membros da equipe em massa

Parâmetros

Devoluções

Criar reserva (Beta)

Parâmetros

Devoluções

Criar tipo de quebra

Parâmetros

Devoluções

Criar turno

Parâmetros

Devoluções

Crie recompensas de fidelidade

Parâmetros

Devoluções

Deslocamentos de pesquisa

Parâmetros

Devoluções

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

Parâmetros

Devoluções

Disponibilidade da pesquisa (Beta)

Parâmetros

Devoluções

Excluir recompensa de fidelidade

Parâmetros

Devoluções

Excluir tipo de quebra

Parâmetros

Devoluções

Excluir trecho

Parâmetros

Devoluções

Excluir turno