Shopify (Editor Independente) (versão prévia)

Interface REST para os comerciantes do Shopify receberem, processarem e gerenciarem seus pedidos.

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

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

Contato
Nome	Microsoft Dynamics
URL	https://dynamics.microsoft.com/en-us/support/
Email	bennettray@microsoft.com

Metadados do conector
Publicador	Ray Bennett (MSFT)
Site	https://www.shopify.com/
Política de privacidade	https://www.shopify.com/legal/privacy
Categorias	Produtividade

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:


Default	Parâmetros para criar conexão.	Todas as regiões	Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
Chave de API	secureString	O token de acesso para essa API.	Verdade
URL do Repositório	cadeia	URL do repositório shopify	Verdade

Limitações

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

Ações

Atualiza um pedido	Atualiza um pedido com as informações fornecidas.
Cancelar um pedido	Cancele um pedido por ID.
Recupera uma lista de clientes	Recupera uma lista de clientes que atendem aos critérios especificados
Recupera uma lista de pedidos	Recupera uma lista de pedidos que atendem aos critérios especificados

Atualiza um pedido

ID da operação:: UpdateAnOrder

Atualiza um pedido com as informações fornecidas.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do pedido	order_id	True	string	ID do pedido que será atualizado.
			object

Retornos

Pedido

Corpo: order

Cancelar um pedido

ID da operação:: CancelAnOrder

Cancele um pedido por ID.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do pedido	order_id	True	string	ID da ordem que será cancelada.
Reembolsar o valor real	amount		string	O valor a ser reembolsado. Se definido, o Shopify tentará anular ou reembolsar o pagamento, dependendo de seu status. O Shopify reembolsa por meio de um gateway manual nos casos em que a transação original não foi feita no Shopify. Os reembolsos por meio de um gateway manual são registrados como um reembolso no Shopify, mas o cliente não é reembolsado.
Moeda de reembolso	currency		string	A moeda do reembolso emitido quando o pedido é cancelado. Necessário para pedidos de várias moedas sempre que a propriedade amount for fornecida.
Reabastecimento de itens reembolsados	restock		string	Se os itens reembolsados serão reabastecidos de volta para o inventário da sua loja.
Motivo do cancelamento do pedido	reason		string	O motivo do cancelamento do pedido. Valores válidos: cliente, inventário, fraude, recusa e outros.
Email de cancelamento	email		string	Se você deve enviar um email para o cliente notificando-o sobre o cancelamento.
Reembolso	refund		string	As transações de reembolso a serem executadas.
			object

Retornos

Pedido

Corpo: order

Recupera uma lista de clientes

ID da operação:: RetrieveListOfCustomers

Recupera uma lista de clientes que atendem aos critérios especificados

Parâmetros

Nome	Chave	Tipo	Description
IDs do cliente	ids	string	Restrinja os resultados aos clientes especificados por uma lista separada por vírgulas de IDs.
Desde a ID	since_id	string	Restrinja os resultados após a ID especificada.
Criado em min	created_at_min	string	Mostrar clientes criados após uma data especificada (formato: 2014-04-25T16:15:47-04:00).
Criado no máximo	created_at_max	string	Mostrar clientes criados antes de uma data especificada (formato: 2014-04-25T16:15:47-04:00).
Atualizado em min	updated_at_min	string	Mostrar clientes atualizados pela última vez após uma data especificada (formato: 2014-04-25T16:15:47-04:00).
Atualizado no máximo	updated_at_max	string	Mostrar clientes atualizados pela última vez antes de uma data especificada (formato: 2014-04-25T16:15:47-04:00).
Limit	limit	string	O número máximo de resultados a serem mostrados. (padrão: 50)(máximo: 250).
Fields	fields	string	Mostrar apenas determinados campos, especificados por uma lista separada por vírgulas de campos.

Retornos

Nome	Caminho	Tipo	Description
customers	customers	array of customer

Recupera uma lista de pedidos

ID da operação:: RetrieveAllOrders

Recupera uma lista de pedidos que atendem aos critérios especificados

Parâmetros

Nome	Chave	Tipo	Description
IDs do pedido	ids	string	Recupere apenas os pedidos especificados por uma lista separada por vírgulas de IDs de pedido.
Limit	limit	string	O número máximo de resultados a serem mostrados em uma página.
Desde a ID	since_id	string	Mostrar pedidos após a ID especificada.
Criado em min	created_at_min	string	Mostrar pedidos criados na data ou após (formato: 2014-04-25T16:15:47-04:00).
Criado no máximo	created_at_max	string	Mostrar pedidos criados na data ou antes (formato: 2014-04-25T16:15:47-04:00).
Atualizado em min	updated_at_min	string	Mostrar pedidos atualizados pela última vez na data ou após (formato: 2014-04-25T16:15:47-04:00).
Atualizado no máximo	updated_at_max	string	Mostrar pedidos atualizados pela última vez na data ou antes (formato: 2014-04-25T16:15:47-04:00).
Processado em min	processed_at_min	string	Mostrar pedidos importados na data ou após (formato: 2014-04-25T16:15:47-04:00).
Processado no máximo	processed_at_max	string	Mostrar pedidos importados na data ou antes (formato: 2014-04-25T16:15:47-04:00).
ID do aplicativo de atribuição	attribution_app_id	string	Mostrar pedidos atribuídos a um determinado aplicativo, especificado pela ID do aplicativo.
Status do pedido	status	string	Filtrar pedidos por seu status.
Status financeiro	financial_status	string	Filtrar pedidos por seu status financeiro.
Status do cumprimento	fulfillment_status	string	Filtrar pedidos pelo status de cumprimento.
Fields	fields	string	Recupere apenas determinados campos, especificados por uma lista separada por vírgulas de campos.
Ordem de sequência de registros	order	string	Campo e direção para classificar ordens. Para especificar a direção, adicione 'asc' ou 'desc' ao final do parâmetro de consulta. Por exemplo, 'order=updated_at asc'.

Retornos

Nome	Caminho	Tipo	Description
orders	orders	array of order

Definições

ordem

Pedido

Nome	Caminho	Tipo	Description
id	id	integer	A ID do aplicativo que criou o pedido.
email	email	string	O endereço de email do cliente.
closed_at	closed_at	string	A data e hora (formato ISO 8601) quando o pedido foi fechado. Retornará nulo se a ordem não estiver fechada.
criado_em	created_at	string	O código de três letras (formato ISO 4217) para a moeda da loja.
updated_at	updated_at	string	A data e hora (formato ISO 8601) quando a ordem foi modificada pela última vez.
número	number	integer	A posição do pedido na contagem de pedidos da loja. Os números são sequenciais e começam em 1.
nota	note	string	Uma observação opcional de que um proprietário da loja pode anexar ao pedido.
símbolo	token	string	Um valor exclusivo ao referenciar a ordem.
gateway	gateway	string	O gateway de pagamento usado.
testar	test	boolean	Se esta é uma ordem de teste.
total_price	total_price	string	A soma de todos os preços de item de linha, descontos, envio, impostos e gorjetas na moeda da loja. Deve ser positivo.
subtotal_price	subtotal_price	string	O preço do pedido na moeda da loja após descontos, mas antes do envio, impostos, impostos e gorjetas.
total_weight	total_weight	integer	A soma de todos os pesos de item de linha em gramas. A soma não é ajustada à medida que os itens são removidos da ordem.
total_tax	total_tax	string	A soma de todos os impostos aplicados à ordem na moeda da loja. Deve ser positivo.
taxes_included	taxes_included	boolean	Se os impostos são incluídos no subtotal da ordem.
moeda	currency	string	O código de três letras (formato ISO 4217) para a moeda da loja.
financial_status	financial_status	string	O status dos pagamentos associados ao pedido. Só pode ser definido quando a ordem é criada.
confirmado	confirmed	boolean	Ordem confirmada.
total_discounts	total_discounts	string	O total de descontos aplicados ao preço do pedido na moeda da loja.
total_line_items_price	total_line_items_price	string	A soma de todos os preços de item de linha na moeda da loja.
cart_token	cart_token	string	Um valor exclusivo ao referenciar o carrinho associado à ordem.
buyer_accepts_marketing	buyer_accepts_marketing	boolean	Se o cliente consentiu em receber atualizações de email da loja.
nome	name	string	O nome do pedido, gerado combinando a propriedade order_number com o prefixo de pedido e o sufixo definidos nas configurações gerais do comerciante.
referring_site	referring_site	string	O site em que o cliente clicou em um link para a loja.
landing_site	landing_site	string	A URL da página em que o comprador desembarcou quando entrou na loja.
cancelado_em	cancelled_at	string	A data e a hora em que o pedido foi cancelado. Retornará nulo se o pedido não for cancelado.
cancel_reason	cancel_reason	string	O motivo pelo qual o pedido foi cancelado.
total_price_usd	total_price_usd	string	Valor total de us$ 1.000.
checkout_token	checkout_token	string	Um valor exclusivo ao referenciar o check-out associado à ordem.
referência	reference	string	Referência de pedido.
user_id	user_id	integer	A ID do usuário fez logon no Shopify POS que processou o pedido, se aplicável.
location_id	location_id	integer	A ID do local físico em que o pedido foi processado. Se você precisar fazer referência ao local em relação a uma ordem, use o recurso FulfillmentOrder.
source_identifier	source_identifier	string	Identificador de origem.
source_url	source_url	string	URL de origem.
processed_at	processed_at	string	A data e hora (formato ISO 8601) quando um pedido foi processado.
device_id	device_id	string	A ID do dispositivo.
phone	phone	string	O número de telefone do cliente para receber notificações por SMS.
customer_locale	customer_locale	string	O código de idioma de duas ou três letras, opcionalmente seguido por um modificador de região.
app_id	app_id	integer	A ID do aplicativo que criou o pedido.
browser_ip	browser_ip	string	O endereço IP do navegador usado pelo cliente quando ele fez o pedido.
landing_site_ref	landing_site_ref	string	Ref do site de aterrissagem.
order_number	order_number	integer	A posição do pedido na contagem de pedidos da loja a partir de 1001.
discount_applications	discount_applications	discount_applications	A descrição do aplicativo de desconto, conforme definido pelo comerciante ou pelo Script do Shopify.
discount_codes	discount_codes	discount_codes	Uma lista de descontos aplicados ao pedido.
note_attributes	note_attributes	note_attributes	Informações extras adicionadas ao pedido.
payment_gateway_names	payment_gateway_names	payment_gateway_names	A lista de gateways de pagamento usados para o pedido.
processing_method	processing_method	string	Como o pagamento foi processado.
checkout_id	checkout_id	integer	ID do check-out.
source_name	source_name	string	Onde a ordem se originou.
fulfillment_status	fulfillment_status	string	O status da ordem em termos de itens de linha atendidos.
tax_lines	tax_lines	tax_lines	Uma lista de objetos de linha fiscal, cada um dos quais detalha um imposto aplicado ao item.
tags	tags	string	Marcas anexadas à ordem, formatadas como uma cadeia de caracteres de valores separados por vírgulas. As marcas são descritores curtos adicionais, geralmente usados para filtragem e pesquisa.
contact_email	contact_email	string	Entre em contato com o email.
order_status_url	order_status_url	string	A URL que aponta para a página da Web de status do pedido, se aplicável.
presentment_currency	presentment_currency	string	A moeda de apresentação usada para exibir preços para o cliente.
total_line_items_price_set	total_line_items_price_set	subtotal_tax_discount_price_set
total_discounts_set	total_discounts_set	subtotal_tax_discount_price_set
total_shipping_price_set	total_shipping_price_set	subtotal_tax_discount_price_set
subtotal_price_set	subtotal_price_set	subtotal_tax_discount_price_set
total_price_set	total_price_set	subtotal_tax_discount_price_set
total_tax_set	total_tax_set	subtotal_tax_discount_price_set
admin_graphql_api_id	admin_graphql_api_id	string	ID da API do graphql do administrador.
shipping_lines	shipping_lines	shipping_lines	Detalhes de qual método de envio foi usado.
billing_address	billing_address	billing_address	O endereço de endereçamento associado à forma de pagamento. Esse endereço é um campo opcional que não estará disponível em pedidos que não exigem uma forma de pagamento.
shipping_address	shipping_address	shipping_address	O endereço de endereçamento para onde o pedido será enviado. Esse endereço é opcional e não estará disponível em pedidos que não exigem envio.
client_details	client_details	client_detail	Informações sobre o navegador que o cliente usou quando fez o pedido.
payment_details	payment_details	payment_detail	Um objeto que contém informações sobre o pagamento.
cliente	customer	customer	Informações sobre o cliente.
line_items	line_items	line_items
cumprimentos	fulfillments	fulfillments	Uma matriz de cumprimentos associada à ordem.
Restituições	refunds	refunds	Restituições

cliente

Informações sobre o cliente.

Nome	Caminho	Tipo	Description
id	id	integer	Um identificador exclusivo para o cliente.
email	email	string	O endereço de email exclusivo do cliente. A tentativa de atribuir o mesmo endereço de email a vários clientes retorna um erro.
accepts_marketing	accepts_marketing	boolean	Se o cliente consentiu em receber material de marketing por email.
criado_em	created_at	string	A data e hora (formato ISO 8601) quando o cliente foi criado.
updated_at	updated_at	string	A data e hora (formato ISO 8601) em que as informações do cliente foram atualizadas pela última vez.
first_name	first_name	string	O nome do cliente.
last_name	last_name	string	O sobrenome do cliente.
orders_count	orders_count	integer	O número de pedidos associados a esse cliente.
estado	state	string	O estado da conta do cliente com uma loja. Valor padrão: desabilitado.
total_spent	total_spent	string	A quantidade total de dinheiro que o cliente gastou em todo o histórico de pedidos.
last_order_id	last_order_id	integer	A ID do último pedido do cliente.
nota	note	string	Uma nota sobre o cliente.
verified_email	verified_email	boolean	Se o cliente verificou seu endereço de email.
multipass_identifier	multipass_identifier	string	Um identificador exclusivo para o cliente que é usado com logon do Multipass.
tax_exempt	tax_exempt	boolean	Se o cliente está isento de pagar impostos em seu pedido. Se for verdade, os impostos não serão aplicados a um pedido no check-out. Se for falso, os impostos serão aplicados no check-out.
phone	phone	string	O número de telefone exclusivo (formato E.164) para esse cliente. A tentativa de atribuir o mesmo número de telefone a vários clientes retorna um erro.
tags	tags	string	Marcas que o proprietário da loja anexou ao cliente, formatadas como uma cadeia de caracteres de valores separados por vírgulas. Um cliente pode ter até 250 marcas. Cada marca pode ter até 255 caracteres.
last_order_name	last_order_name	string	O nome do último pedido do cliente. Isso está diretamente relacionado ao campo de nome no recurso Pedido.
moeda	currency	string	O código de três letras (formato ISO 4217) para a moeda que o cliente usou quando pagou pelo último pedido.
endereços	addresses	addresses	Uma lista dos dez endereços atualizados mais recentemente para o cliente.
accepts_marketing_updated_at	accepts_marketing_updated_at	string	A data e hora (formato ISO 8601) em que o cliente consentiu ou se opôs ao recebimento de material de marketing por email.
marketing_opt_in_level	marketing_opt_in_level	string	O nível de aceitação da assinatura de marketing que o cliente deu quando consentiu em receber material de marketing por email.
tax_exemptions	tax_exemptions	array of	Se o cliente está isento de pagar impostos específicos em seu pedido.
admin_graphql_api_id	admin_graphql_api_id	string	ID da API do graphql do administrador.
default_address	default_address	default_address

default_address

Nome	Caminho	Tipo	Description
id	id	integer	Um identificador exclusivo para o endereço.
customer_id	customer_id	integer	Um identificador exclusivo para o cliente.
first_name	first_name	string	O nome do cliente.
last_name	last_name	string	O sobrenome do cliente.
empresa	company	string	A empresa do cliente.
endereço1	address1	string	A primeira linha do endereço de endereçamento do cliente.
endereço2	address2	string	Um campo adicional para o endereço de endereçamento do cliente.
city	city	string	A cidade, a cidade ou a vila do cliente.
província	province	string	O nome da região do cliente. Normalmente, uma província, um estado ou uma prefeitura.
country	country	string	O país do cliente.
zip	zip	string	O código postal do cliente, também conhecido como zip, postcode, Eircode etc.
phone	phone	string	O número de telefone do cliente neste endereço.
nome	name	string	Os primeiros e sobrenomes do cliente.
province_code	province_code	string	O código de duas letras para a região do cliente.
country_code	country_code	string	O código de país de duas letras correspondente ao país do cliente.
country_name	country_name	string	O nome do país normalizado do cliente.
padrão	default	boolean	Retorna true para cada endereço padrão.

shipping_address

O endereço de endereçamento para onde o pedido será enviado. Esse endereço é opcional e não estará disponível em pedidos que não exigem envio.

Nome	Caminho	Tipo	Description
first_name	first_name	string	O nome da pessoa associada ao endereço de envio.
endereço1	address1	string	O endereço da rua do endereço de envio.
phone	phone	string	O número de telefone no endereço de envio.
city	city	string	A cidade, a cidade ou a vila do endereço de transporte.
zip	zip	string	O código postal (por exemplo, zip, código postal ou Eircode) do endereço de envio.
província	province	string	O nome da região (por exemplo, província, estado ou prefeitura) do endereço de envio.
country	country	string	O nome do país do endereço de envio.
last_name	last_name	string	O sobrenome da pessoa associada ao endereço de envio.
endereço2	address2	string	Um campo adicional opcional para o endereço de rua do endereço de envio.
empresa	company	string	A empresa da pessoa associada ao endereço de envio.
latitude	latitude	float	A latitude do endereço de envio.
longitude	longitude	float	A longitude do endereço de envio.
nome	name	string	O nome completo da pessoa associada à forma de pagamento.
country_code	country_code	string	O código de duas letras (formato ISO 3166-1) para o país do endereço de envio.
province_code	province_code	string	A abreviação de duas letras da região do endereço de envio.

billing_address

O endereço de endereçamento associado à forma de pagamento. Esse endereço é um campo opcional que não estará disponível em pedidos que não exigem uma forma de pagamento.

Nome	Caminho	Tipo	Description
first_name	first_name	string	O nome da pessoa associada à forma de pagamento.
endereço1	address1	string	O endereço da rua do endereço de cobrança.
phone	phone	string	O número de telefone no endereço de cobrança.
city	city	string	A cidade, a cidade ou a vila do endereço de cobrança.
zip	zip	string	O código postal (por exemplo, zip, código postal ou Eircode) do endereço de cobrança.
província	province	string	O nome da região (por exemplo, província, estado ou prefeitura) do endereço de cobrança.
country	country	string	O nome do país do endereço de cobrança.
last_name	last_name	string	O sobrenome da pessoa associada à forma de pagamento.
endereço2	address2	string	Um campo adicional opcional para o endereço de rua do endereço de cobrança.
empresa	company	string	A empresa da pessoa associada ao endereço de cobrança.
latitude	latitude	float	A latitude do endereço de cobrança.
longitude	longitude	float	A longitude do endereço de cobrança.
nome	name	string	O nome completo da pessoa associada à forma de pagamento.
country_code	country_code	string	O código de duas letras (formato ISO 3166-1) para o país do endereço de cobrança.
province_code	province_code	string	A abreviação de duas letras da região do endereço de cobrança.

endereços

Uma lista dos dez endereços atualizados mais recentemente para o cliente.

Nome	Caminho	Tipo	Description
Itens		default_address

shipping_line

Nome	Caminho	Tipo	Description
id	id	integer	Um identificador global exclusivo.
title	title	string	O título do método de envio.
price	price	string	O preço desse método de envio na moeda da loja.
codificar	code	string	Uma referência ao método de envio.
fonte	source	string	A origem do método de envio.
phone	phone	string	O número de telefone no endereço de envio.
requested_fulfillment_service_id	requested_fulfillment_service_id	string	Uma referência ao serviço de atendimento que está sendo solicitado para o método de envio. Apresentar se o método de envio requer processamento por um serviço de atendimento de terceiros; nulo caso contrário.
delivery_category	delivery_category	string	Categoria de entrega.
carrier_identifier	carrier_identifier	string	Uma referência ao serviço de operadora que forneceu a taxa. Presente quando a taxa foi computada por um serviço de operadora de terceiros.
discounted_price	discounted_price	string	O preço do método de envio após os descontos no nível da linha terem sido aplicados. Não reflete descontos no nível do carrinho ou no nível do pedido.
price_set	price_set	subtotal_tax_discount_price_set
discounted_price_set	discounted_price_set	subtotal_tax_discount_price_set
discount_allocations	discount_allocations	array of	Uma lista ordenada de valores alocados por aplicativos de desconto.
tax_lines	tax_lines	tax_lines	Uma lista de objetos de linha fiscal, cada um dos quais detalha um imposto aplicado ao item.

client_detail

Informações sobre o navegador que o cliente usou quando fez o pedido.

Nome	Caminho	Tipo	Description
browser_ip	browser_ip	string	O endereço IP do navegador.
accept_language	accept_language	string	Os idiomas e as localidades que o navegador entende.
user_agent	user_agent	string	Detalhes do cliente de navegação, incluindo software e versões operacionais.
session_hash	session_hash	string	Um hash da sessão.
browser_width	browser_width	integer	A largura da tela do navegador em pixels, se disponível.
browser_height	browser_height	integer	A altura da tela do navegador em pixels, se disponível.

payment_detail

Um objeto que contém informações sobre o pagamento.

Nome	Caminho	Tipo	Description
credit_card_bin	credit_card_bin	string	O número de identificação do emissor (IIN), anteriormente conhecido como BIN (número de identificação bancária), do cartão de crédito do cliente.
avs_result_code	avs_result_code	string	O código de resposta do sistema de verificação de endereço (AVS). O código é uma única letra.
cvv_result_code	cvv_result_code	string	O código de resposta da empresa de cartão de crédito indicando se o cliente inseriu o código de segurança do cartão (valor de verificação de cartão) corretamente. O código é uma única letra ou uma cadeia de caracteres vazia.
credit_card_number	credit_card_number	string	O número do cartão de crédito do cliente, com a maioria dos dígitos principais redigidos.
credit_card_company	credit_card_company	string	O nome da empresa que emitiu o cartão de crédito do cliente.

subtotal_tax_discount_price_set

Nome	Caminho	Tipo	Description
quantidade	shop_money.amount	string	A quantidade real.
currency_code	shop_money.currency_code	string	No formato ISO 4217.
quantidade	presentment_money.amount	string	A quantidade real.
currency_code	presentment_money.currency_code	string	No formato ISO 4217.

line_item_property

Nome	Caminho	Tipo	Description
nome	name	string	O nome do produto.
value	value	string	O valor do produto.

line_item_properties

Propriedades.

Nome	Caminho	Tipo	Description
Itens		line_item_property

cumprimento

Nome	Caminho	Tipo	Description
id	id	integer	A ID do cumprimento.
order_id	order_id	integer	O identificador numérico exclusivo para a ordem.
status	status	string	O status do cumprimento.
criado_em	created_at	string	A data e a hora em que o cumprimento foi criado.
serviço	service	string	O tipo de serviço usado.
updated_at	updated_at	string	A data e hora (formato ISO 8601) em que o cumprimento foi modificado pela última vez.
tracking_company	tracking_company	string	O nome da empresa de acompanhamento.
shipment_status	shipment_status	string	O status de remessa atual do cumprimento.
location_id	location_id	integer	O identificador exclusivo do local para o qual o cumprimento deve ser processado.
tracking_number	tracking_number	string	Um número de acompanhamento, fornecido pela empresa de navegação.
tracking_numbers	tracking_numbers	array of string	Uma lista de números de acompanhamento, fornecida pela empresa de navegação.
tracking_url	tracking_url	string	A URL da página de acompanhamento para o cumprimento.
tracking_urls	tracking_urls	array of string	As URLs das páginas de acompanhamento para o cumprimento.
recibo	receipt	receipt	Um campo de texto que fornece informações sobre o recibo.
nome	name	string	O nome de atendimento de identificação exclusiva.
admin_graphql_api_id	admin_graphql_api_id	string	ID da API do graphql do administrador.
line_items	line_items	line_items

cumprimentos

Uma matriz de cumprimentos associada à ordem.

Nome	Caminho	Tipo	Description
Itens		fulfillment

transação

Nome	Caminho	Tipo	Description
id	id	integer	A ID da transação.
order_id	order_id	integer	A ID da ordem à qual a transação está associada.
variante	kind	string	O tipo da transação.
gateway	gateway	string	O nome do gateway pelo qual a transação foi emitida.
status	status	string	O status da transação.
mensagem	message	string	Uma cadeia de caracteres gerada pelo provedor de pagamento com informações adicionais sobre por que a transação foi bem-sucedida ou falhou.
criado_em	created_at	string	A data e hora (formato ISO 8601) quando a transação foi criada.
testar	test	boolean	Se a transação é uma transação de teste.
autorização	authorization	string	O código de autorização associado à transação.
location_id	location_id	string	A ID do local físico em que a transação foi processada.
user_id	user_id	string	A ID do usuário que foi conectado ao dispositivo pos do Shopify quando o pedido foi processado, se aplicável.
parent_id	parent_id	integer	A ID de uma transação associada.
processed_at	processed_at	string	A data e hora (formato ISO 8601) em que uma transação foi processada.
device_id	device_id	string	A ID do dispositivo.
error_code	error_code	string	Um código de erro padronizado, independentemente do provedor de pagamento.
source_name	source_name	string	A origem da transação. Isso é definido pelo Shopify e não pode ser substituído.
quantidade	amount	string	A quantidade de dinheiro incluída na transação.
moeda	currency	string	O código de três letras (formato ISO 4217) para a moeda usada para o pagamento.
admin_graphql_api_id	admin_graphql_api_id	string	ID da API do graphql do administrador.

transações

Uma lista de transações envolvidas no reembolso.

Nome	Caminho	Tipo	Description
Itens		transaction

tax_line

Nome	Caminho	Tipo	Description
price	price	string	O valor do imposto a ser cobrado na moeda da loja.
taxa	rate	float	A taxa de imposto a ser aplicada.
title	title	string	O nome do imposto.
price_set	price_set	subtotal_tax_discount_price_set

tax_lines

Uma lista de objetos de linha fiscal, cada um dos quais detalha um imposto aplicado ao item.

Nome	Caminho	Tipo	Description
Itens		tax_line

Restituições

Nome	Caminho	Tipo	Description
Itens		refund

reembolso

Nome	Caminho	Tipo	Description
id	id	integer	O identificador exclusivo do reembolso.
order_id	order_id	integer	A ID da ordem, usada para fins de API.
criado_em	created_at	string	A data e hora (formato ISO 8601) quando o reembolso foi criado.
nota	note	string	Uma nota opcional anexada a um reembolso.
user_id	user_id	integer	O identificador exclusivo do usuário que realizou o reembolso.
processed_at	processed_at	string	A data e hora (formato ISO 8601) quando o reembolso foi importado.
Reabastecer	restock	boolean	Se os itens de linha devem ser adicionados novamente ao inventário do repositório.
admin_graphql_api_id	admin_graphql_api_id	string	ID da API do graphql do administrador.
transações	transactions	transactions	Uma lista de transações envolvidas no reembolso.
order_adjustments	order_adjustments	array of	Uma lista de ajustes de pedido anexados ao reembolso.

line_item

Uma lista de objetos de item de linha, cada um contendo informações sobre um item na ordem.

Nome	Caminho	Tipo	Description
id	id	integer	A ID do item de linha.
variant_id	variant_id	integer	A ID da grade de produto.
title	title	string	O título do produto.
quantidade	quantity	integer	O número de itens que foram comprados.
sku	sku	string	SKU do item (unidade de manutenção de estoque).
variant_title	variant_title	string	O título da variante do produto.
fornecedor	vendor	string	O nome do fornecedor do item.
fulfillment_service	fulfillment_service	string	O provedor de serviços que está cumprindo o item.
product_id	product_id	integer	A ID do produto ao qual o item de linha pertence.
requires_shipping	requires_shipping	boolean	Se o item requer envio.
Tributável	taxable	boolean	Se o item é tributável.
gift_card	gift_card	boolean	Se o item de linha é um cartão presente.
nome	name	string	O nome da variante do produto.
variant_inventory_management	variant_inventory_management	string	O nome do serviço de gerenciamento de inventário.
propriedades	properties	line_item_properties	Propriedades.
product_exists	product_exists	boolean	Se o produto existe.
fulfillable_quantity	fulfillable_quantity	integer	O valor disponível para atender.
Gramas	grams	integer	O peso do item em gramas.
price	price	string	O preço do item antes dos descontos terem sido aplicados na moeda da loja.
total_discount	total_discount	string	O valor total do desconto alocado para o item de linha na moeda da loja.
fulfillment_status	fulfillment_status	string	O status de uma ordem em termos dos itens de linha que estão sendo atendidos.
price_set	price_set	subtotal_tax_discount_price_set
total_discount_set	total_discount_set	subtotal_tax_discount_price_set
discount_allocations	discount_allocations	array of	Uma lista ordenada de valores alocados por aplicativos de desconto.
admin_graphql_api_id	admin_graphql_api_id	string	ID da API do graphql do administrador.
tax_lines	tax_lines	tax_lines	Uma lista de objetos de linha fiscal, cada um dos quais detalha um imposto aplicado ao item.

line_items

Nome	Caminho	Tipo	Description
Itens		line_item	Uma lista de objetos de item de linha, cada um contendo informações sobre um item na ordem.

shipping_lines

Detalhes de qual método de envio foi usado.

Nome	Caminho	Tipo	Description
Itens		shipping_line

payment_gateway_names

A lista de gateways de pagamento usados para o pedido.

Nome	Caminho	Tipo	Description
Itens		string

note_attribute

Nome	Caminho	Tipo	Description
nome	name	string	Anote o nome do atributo.
value	value	string	Observe o valor do atributo.

note_attributes

Informações extras adicionadas ao pedido.

Nome	Caminho	Tipo	Description
Itens		note_attribute

discount_code

Nome	Caminho	Tipo	Description
codificar	code	string	Quando o aplicativo de desconto associado é de código de tipo, essa propriedade retorna o código de desconto que foi inserido no check-out.
quantidade	amount	string	O valor que é deduzido do total de pedidos. Quando você cria uma ordem, esse valor é o percentual ou valor monetário a ser deduzida.
tipo	type	string	O tipo de desconto.

discount_codes

Uma lista de descontos aplicados ao pedido.

Nome	Caminho	Tipo	Description
Itens		discount_code

discount_application

Nome	Caminho	Tipo	Description
tipo	type	string	O tipo de aplicativo de desconto.
value	value	string	O valor do aplicativo de desconto como uma decimal. Isso representa a intenção do aplicativo de desconto.
value_type	value_type	string	O tipo do valor.
allocation_method	allocation_method	string	O método pelo qual o valor do aplicativo de desconto foi alocado para linhas com direito.
target_selection	target_selection	string	As linhas na ordem, do tipo definido por target_type, que o desconto é alocado.
target_type	target_type	string	O tipo de linha na ordem em que o desconto é aplicável.
codificar	code	string	O código de desconto usado para aplicar o desconto. Disponível apenas para aplicativos de código de desconto.

discount_applications

A descrição do aplicativo de desconto, conforme definido pelo comerciante ou pelo Script do Shopify.

Nome	Caminho	Tipo	Description
Itens		discount_application

recibo

Um campo de texto que fornece informações sobre o recibo.

Nome	Caminho	Tipo	Description
testcase	testcase	boolean	Se o cumprimento foi um testcase.
autorização	authorization	string	O código de autorização.

Compartilhar via

Shopify (Editor Independente) (versão prévia)

Criando uma conexão

Padrão

Limitações

Ações

Atualiza um pedido

Parâmetros

Retornos

Cancelar um pedido

Parâmetros

Retornos

Recupera uma lista de clientes

Parâmetros

Retornos

Recupera uma lista de pedidos

Parâmetros

Retornos

Definições

ordem

cliente

default_address

shipping_address

billing_address

endereços

shipping_line

client_detail

payment_detail

subtotal_tax_discount_price_set

line_item_property

line_item_properties

cumprimento

cumprimentos

transação

transações

tax_line

tax_lines

Restituições

reembolso

line_item

line_items

shipping_lines

payment_gateway_names

note_attribute

note_attributes

discount_code

discount_codes

discount_application

discount_applications

recibo