Shopify (Editora independente) (Visualização)

Interface REST para os comerciantes da Shopify receberem, processarem e gerirem as suas encomendas.

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	Dinâmica da Microsoft
URL	https://dynamics.microsoft.com/en-us/support/
Email	bennettray@microsoft.com

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

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:


Predefinição	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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 esta API.	Verdade
URL da loja	cadeia (de caracteres)	URL da loja do Shopify	Verdade

Limites de Limitação

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

Ações

Atualiza uma encomenda	Atualiza um pedido com as informações fornecidas.
Cancelar uma encomenda	Cancelar uma encomenda 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 uma encomenda

ID da Operação:: UpdateAnOrder

Atualiza um pedido com as informações fornecidas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da encomenda	order_id	True	string	ID da encomenda que será atualizada.
			object

Devoluções

Encomenda

Body: order

Cancelar uma encomenda

ID da Operação:: CancelAnOrder

Cancelar uma encomenda por ID.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da encomenda	order_id	True	string	ID da encomenda que será cancelada.
Reembolso O montante real	amount		string	O montante a reembolsar. Se definido, a Shopify tenta anular ou reembolsar o pagamento, dependendo do seu estado. Reembolsos da Shopify por meio de um gateway manual nos casos em que a transação original não foi feita na Shopify. Os reembolsos através de um gateway manual são registados como um reembolso na Shopify, mas o cliente não é reembolsado.
Moeda de reembolso	currency		string	A moeda do reembolso que é emitido quando o pedido é cancelado. Necessário para ordens de várias moedas sempre que a propriedade do valor é fornecida.
Reabastecer itens reembolsados	restock		string	Se deseja reabastecer os itens reembolsados de volta ao estoque da sua loja.
Motivo do cancelamento da encomenda	reason		string	O motivo do cancelamento da encomenda. Valores válidos: cliente, inventário, fraude, recusado e outros.
E-mail de cancelamento	email		string	Se deve enviar um e-mail ao cliente notificando-o do cancelamento.
Reembolso	refund		string	As transações de reembolso a realizar.
			object

Devoluções

Encomenda

Body: order

Recupera uma lista de clientes

ID da Operação:: RetrieveListOfCustomers

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

Parâmetros

Name	Chave	Tipo	Description
IDs do cliente	ids	string	Restrinja os resultados aos clientes especificados por uma lista de IDs separada por vírgula.
Desde 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 aos clientes a última atualização após uma data especificada (formato: 2014-04-25T16:15:47-04:00).
Atualizado no máximo	updated_at_max	string	Mostrar aos clientes a última atualização antes de uma data especificada (formato: 2014-04-25T16:15:47-04:00).
Limite	limit	string	O número máximo de resultados a mostrar. (padrão: 50)(máximo: 250).
Campos	fields	string	Mostrar apenas determinados campos, especificados por uma lista de campos separados por vírgula.

Devoluções

Name	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

Name	Chave	Tipo	Description
IDs de encomenda	ids	string	Recupere apenas ordens especificadas por uma lista separada por vírgulas de IDs de ordem.
Limite	limit	string	O número máximo de resultados a serem exibidos em uma página.
Desde ID	since_id	string	Mostrar pedidos após o ID especificado.
Criado em min	created_at_min	string	Mostrar pedidos criados na data ou após a data (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 a data (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 a data (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 ordens atribuídas a um determinado aplicativo, especificadas pelo ID do aplicativo.
Estado da encomenda	status	string	Filtre as encomendas pelo seu estado.
Situação financeira	financial_status	string	Filtre as encomendas pela sua situação financeira.
Estado de cumprimento	fulfillment_status	string	Filtre os pedidos por seu status de atendimento.
Campos	fields	string	Recupere apenas determinados campos, especificados por uma lista de campos separados por vírgula.
Ordem sequencial dos registos	order	string	Campo e direção para ordenar ordens. Para especificar a direção, adicione ' asc' ou ' desc' ao final do parâmetro de consulta. Por exemplo, 'order=updated_at asc'.

Devoluções

Name	Caminho	Tipo	Description
orders	orders	array of order

Definições

order

Encomenda

Name	Caminho	Tipo	Description
id	id	integer	A ID do aplicativo que criou o pedido.
e-mail	email	string	O endereço de e-mail do cliente.
closed_at	closed_at	string	A data e hora (formato ISO 8601) em que o pedido foi fechado. Retorna null se a ordem não for 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 a hora (formato ISO 8601) em que 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.
Observação	note	string	Uma nota opcional que o proprietário de uma loja pode anexar à encomenda.
token	token	string	Um valor exclusivo ao fazer referência à ordem.
gateway	gateway	string	O gateway de pagamento utilizado.
testar	test	boolean	Se esta é uma ordem de teste.
total_price	total_price	string	A soma de todos os preços de itens de linha, descontos, frete, 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, taxas, impostos e gorjetas.
total_weight	total_weight	integer	A soma de todos os pesos de itens 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 à encomenda na moeda da loja. Deve ser positivo.
taxes_included	taxes_included	boolean	Se os impostos estã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	Encomenda confirmada.
total_discounts	total_discounts	string	Os descontos totais aplicados ao preço da encomenda na moeda da loja.
total_line_items_price	total_line_items_price	string	A soma de todos os preços de itens de linha na moeda da loja.
cart_token	cart_token	string	Um valor exclusivo ao fazer referência ao carrinho associado ao pedido.
buyer_accepts_marketing	buyer_accepts_marketing	boolean	Se o cliente consentiu em receber atualizações por e-mail da loja.
nome	name	string	O nome da ordem, gerado pela combinação da propriedade order_number com o prefixo e o sufixo da ordem definidos nas configurações gerais do comerciante.
referring_site	referring_site	string	O site onde o cliente clicou em um link para a loja.
landing_site	landing_site	string	O URL da página onde o comprador aterrou quando entrou na loja.
cancelado_em	cancelled_at	string	A data e hora em que a encomenda foi cancelada. Retorna null se o pedido não for cancelado.
cancel_reason	cancel_reason	string	O motivo pelo qual a encomenda foi cancelada.
total_price_usd	total_price_usd	string	Preço total usd.
checkout_token	checkout_token	string	Um valor exclusivo ao fazer referência ao checkout associado ao pedido.
referenciar	reference	string	Referência da encomenda.
user_id	user_id	integer	O ID do usuário conectado ao Shopify PDV que processou o pedido, se aplicável.
location_id	location_id	integer	O ID do local físico onde o pedido foi processado. Se você precisar fazer referência ao local em relação a um pedido, 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) em que um pedido foi processado.
device_id	device_id	string	O 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 utilizado pelo cliente quando efetuou a encomenda.
landing_site_ref	landing_site_ref	string	Local de desembarque ref.
order_number	order_number	integer	A posição da ordem 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 da Shopify.
discount_codes	discount_codes	discount_codes	Uma lista de descontos aplicados ao pedido.
note_attributes	note_attributes	note_attributes	Informações adicionais que são 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 de checkout.
source_name	source_name	string	Origem da encomenda.
fulfillment_status	fulfillment_status	string	O status do pedido em termos de itens de linha atendidos.
tax_lines	tax_lines	tax_lines	Uma lista de objetos de linha de imposto, cada um dos quais detalha um imposto aplicado ao item.
tags	tags	string	Tags anexadas à ordem, formatadas como uma cadeia de valores separados por vírgula. As tags são descritores curtos adicionais, comumente usados para filtragem e pesquisa.
contact_email	contact_email	string	E-mail de contato.
order_status_url	order_status_url	string	O URL que aponta para a página Web de estado da encomenda, se aplicável.
presentment_currency	presentment_currency	string	A moeda de apresentação que foi usada para exibir os 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	Admin graphql api id.
shipping_lines	shipping_lines	shipping_lines	Detalhes do método de envio utilizado.
billing_address	billing_address	billing_address	O endereço postal associado ao método de pagamento. Este endereço é um campo opcional que não estará disponível em encomendas que não exijam um método de pagamento.
shipping_address	shipping_address	shipping_address	O endereço postal para onde a encomenda será enviada. Esta morada é opcional e não estará disponível em encomendas que não necessitem de envio.
client_details	client_details	client_detail	Informações sobre o navegador que o cliente utilizou quando efetuou a sua encomenda.
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 associados ao pedido.
Reembolsos	refunds	refunds	Reembolsos

cliente

Informações sobre o cliente.

Name	Caminho	Tipo	Description
id	id	integer	Um identificador exclusivo para o cliente.
e-mail	email	string	O endereço de e-mail exclusivo do cliente. A tentativa de atribuir o mesmo endereço de e-mail a vários clientes retorna um erro.
accepts_marketing	accepts_marketing	boolean	Se o cliente consentiu em receber material de marketing por e-mail.
criado_em	created_at	string	A data e hora (formato ISO 8601) em que o cliente foi criado.
updated_at	updated_at	string	A data e a hora (formato ISO 8601) em que as informações do cliente foram atualizadas pela última vez.
first_name	first_name	string	O primeiro nome do cliente.
last_name	last_name	string	O sobrenome do cliente.
orders_count	orders_count	integer	O número de encomendas associadas a este cliente.
state	state	string	O estado da conta do cliente numa loja. Valor padrão: desativado.
total_spent	total_spent	string	A quantidade total de dinheiro que o cliente gastou em todo o seu histórico de pedidos.
last_order_id	last_order_id	integer	O ID do último pedido do cliente.
Observação	note	string	Uma nota sobre o cliente.
verified_email	verified_email	boolean	Se o cliente verificou o seu endereço de e-mail.
multipass_identifier	multipass_identifier	string	Um identificador exclusivo para o cliente que é usado com o login do Multipass.
tax_exempt	tax_exempt	boolean	Se o cliente está isento de pagar impostos sobre a sua encomenda. Se for verdade, os impostos não serão aplicados a um pedido no checkout. Se falso, os impostos serão aplicados no checkout.
phone	phone	string	O número de telefone exclusivo (formato E.164) para este cliente. A tentativa de atribuir o mesmo número de telefone a vários clientes retorna um erro.
tags	tags	string	Tags que o proprietário da loja anexou ao cliente, formatadas como uma cadeia de valores separados por vírgula. Um cliente pode ter até 250 tags. Cada tag 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 utilizou quando pagou a sua última encomenda.
addresses	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 a receber material de marketing por e-mail.
marketing_opt_in_level	marketing_opt_in_level	string	O nível de aceitação da subscrição de marketing que o cliente deu quando consentiu em receber material de marketing por e-mail.
tax_exemptions	tax_exemptions	array of	Se o cliente está isento de pagar impostos específicos sobre a sua encomenda.
admin_graphql_api_id	admin_graphql_api_id	string	Admin graphql api id.
default_address	default_address	default_address

default_address

Name	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 primeiro nome do cliente.
last_name	last_name	string	O sobrenome do cliente.
Companhia	company	string	A empresa do cliente.
Endereço1	address1	string	A primeira linha do endereço postal do cliente.
Endereço2	address2	string	Um campo adicional para o endereço postal do cliente.
city	city	string	A cidade, vila ou aldeia 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 CEP, código postal, Eircode, etc.
phone	phone	string	O número de telefone do cliente neste endereço.
nome	name	string	Nome e sobrenome 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.
predefinição	default	boolean	Retorna true para cada endereço padrão.

shipping_address

O endereço postal para onde a encomenda será enviada. Esta morada é opcional e não estará disponível em encomendas que não necessitem de envio.

Name	Caminho	Tipo	Description
first_name	first_name	string	O primeiro nome da pessoa associada ao endereço de envio.
Endereço1	address1	string	O endereço do endereço de envio.
phone	phone	string	O número de telefone no endereço de entrega.
city	city	string	A cidade, vila ou aldeia do endereço de envio.
ZIP	zip	string	O código postal (por exemplo, CEP, 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 entrega.
Endereço2	address2	string	Um campo adicional opcional para o endereço da morada de envio.
Companhia	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 ao método 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 abreviatura de duas letras da região do endereço de envio.

billing_address

O endereço postal associado ao método de pagamento. Este endereço é um campo opcional que não estará disponível em encomendas que não exijam um método de pagamento.

Name	Caminho	Tipo	Description
first_name	first_name	string	O primeiro nome da pessoa associada ao método de pagamento.
Endereço1	address1	string	O endereço 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, vila ou vila do endereço de cobrança.
ZIP	zip	string	O código postal (por exemplo, CEP, 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 apelido da pessoa associada ao método de pagamento.
Endereço2	address2	string	Um campo adicional opcional para o endereço do endereço de cobrança.
Companhia	company	string	A empresa da pessoa associada ao endereço de faturação.
latitude	latitude	float	A latitude do endereço de faturação.
longitude	longitude	float	A longitude do endereço de cobrança.
nome	name	string	O nome completo da pessoa associada ao método 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 faturação.
province_code	province_code	string	A abreviatura de duas letras da região do endereço de cobrança.

addresses

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

Name	Caminho	Tipo	Description
Itens		default_address

shipping_line

Name	Caminho	Tipo	Description
id	id	integer	Um identificador global exclusivo.
title	title	string	O título do método de envio.
Preço	price	string	O preço deste método de envio na moeda da loja.
código	code	string	Uma referência ao método de envio.
origem	source	string	A origem do método de envio.
phone	phone	string	O número de telefone no endereço de entrega.
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 exigir 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 da transportadora que forneceu a tarifa. Presente quando a tarifa foi calculada por um serviço de transportadora de terceiros.
discounted_price	discounted_price	string	O preço do método de envio após descontos ao 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 pedidos de desconto.
tax_lines	tax_lines	tax_lines	Uma lista de objetos de linha de imposto, cada um dos quais detalha um imposto aplicado ao item.

client_detail

Informações sobre o navegador que o cliente utilizou quando efetuou a sua encomenda.

Name	Caminho	Tipo	Description
browser_ip	browser_ip	string	O endereço IP do navegador.
accept_language	accept_language	string	Os idiomas e 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.

Name	Caminho	Tipo	Description
credit_card_bin	credit_card_bin	string	O número de identificação do emissor (IIN), anteriormente conhecido como número de identificação bancária (BIN), 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 operadora do cartão de crédito indicando se o cliente inseriu o código de segurança do cartão (valor de verificação do cartão) corretamente. O código é uma única letra ou 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 apagados.
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

Name	Caminho	Tipo	Description
Montante	shop_money.amount	string	O montante real.
currency_code	shop_money.currency_code	string	No formato ISO 4217.
Montante	presentment_money.amount	string	O montante real.
currency_code	presentment_money.currency_code	string	No formato ISO 4217.

line_item_property

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

line_item_properties

Propriedades.

Name	Caminho	Tipo	Description
Itens		line_item_property

cumprimento

Name	Caminho	Tipo	Description
id	id	integer	O ID para o cumprimento.
order_id	order_id	integer	O identificador numérico exclusivo para a ordem.
estado	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 utilizado.
updated_at	updated_at	string	A data e a hora (formato ISO 8601) em que o cumprimento foi modificado pela última vez.
tracking_company	tracking_company	string	O nome da empresa de rastreamento.
shipment_status	shipment_status	string	O status atual da remessa do cumprimento.
location_id	location_id	integer	O identificador exclusivo do local para o qual o preenchimento deve ser processado.
tracking_number	tracking_number	string	Um número de rastreamento, fornecido pela empresa de transporte.
tracking_numbers	tracking_numbers	array of string	Uma lista de números de rastreamento, fornecida pela empresa de transporte.
tracking_url	tracking_url	string	O URL da página de acompanhamento para o cumprimento.
tracking_urls	tracking_urls	array of string	Os 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 preenchimento de identificação exclusiva.
admin_graphql_api_id	admin_graphql_api_id	string	Admin graphql api id.
line_items	line_items	line_items

Cumprimentos

Uma matriz de cumprimentos associados ao pedido.

Name	Caminho	Tipo	Description
Itens		fulfillment

transação

Name	Caminho	Tipo	Description
id	id	integer	O ID da transação.
order_id	order_id	integer	O ID da ordem à qual a transação está associada.
tipo	kind	string	O tipo de transação.
gateway	gateway	string	O nome do gateway através do qual a transação foi emitida.
estado	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 a hora (formato ISO 8601) em que 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 onde a transação foi processada.
user_id	user_id	string	O ID do usuário que estava conectado ao dispositivo Shopify PDV 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	O ID do dispositivo.
error_code	error_code	string	Um código de erro padronizado, independente do provedor de pagamento.
source_name	source_name	string	A origem da transação. Isso é definido pela Shopify e não pode ser substituído.
Montante	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 utilizada para o pagamento.
admin_graphql_api_id	admin_graphql_api_id	string	Admin graphql api id.

transações

Uma lista das transações envolvidas no reembolso.

Name	Caminho	Tipo	Description
Itens		transaction

tax_line

Name	Caminho	Tipo	Description
Preço	price	string	O valor do imposto a ser cobrado na moeda da loja.
taxa	rate	float	A taxa de imposto a aplicar.
title	title	string	O nome do imposto.
price_set	price_set	subtotal_tax_discount_price_set

tax_lines

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

Name	Caminho	Tipo	Description
Itens		tax_line

Reembolsos

Name	Caminho	Tipo	Description
Itens		refund

reembolso

Name	Caminho	Tipo	Description
id	id	integer	O identificador único do reembolso.
order_id	order_id	integer	O ID do pedido, usado para fins de API.
criado_em	created_at	string	A data e a hora (formato ISO 8601) em que o reembolso foi criado.
Observação	note	string	Uma nota facultativa anexada a um reembolso.
user_id	user_id	integer	O identificador exclusivo do usuário que realizou o reembolso.
processed_at	processed_at	string	Data e hora (formato ISO 8601) em que a restituição foi importada.
repovoamento	restock	boolean	Se os itens de linha devem ser adicionados de volta ao estoque da loja.
admin_graphql_api_id	admin_graphql_api_id	string	Admin graphql api id.
transações	transactions	transactions	Uma lista das transações envolvidas no reembolso.
order_adjustments	order_adjustments	array of	Uma lista de ajustes de ordem anexada ao reembolso.

line_item

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

Name	Caminho	Tipo	Description
id	id	integer	A ID do item de linha.
variant_id	variant_id	integer	A ID da variante do produto.
title	title	string	O título do produto.
quantidade	quantity	integer	O número de itens que foram comprados.
sku	sku	string	O SKU (unidade de manutenção de estoque) do item.
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 bem é 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 montante disponível para cumprir.
gramas	grams	integer	O peso do item em gramas.
Preço	price	string	O preço do item antes dos descontos foram aplicados na moeda da loja.
total_discount	total_discount	string	O valor total do desconto atribuído ao item de linha na moeda da loja.
fulfillment_status	fulfillment_status	string	O status de um pedido 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 pedidos de desconto.
admin_graphql_api_id	admin_graphql_api_id	string	Admin graphql api id.
tax_lines	tax_lines	tax_lines	Uma lista de objetos de linha de imposto, cada um dos quais detalha um imposto aplicado ao item.

line_items

Name	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 do método de envio utilizado.

Name	Caminho	Tipo	Description
Itens		shipping_line

payment_gateway_names

A lista de gateways de pagamento usados para o pedido.

Name	Caminho	Tipo	Description
Itens		string

note_attribute

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

note_attributes

Informações adicionais que são adicionadas ao pedido.

Name	Caminho	Tipo	Description
Itens		note_attribute

discount_code

Name	Caminho	Tipo	Description
código	code	string	Quando o aplicativo de desconto associado é do tipo código, essa propriedade retorna o código de desconto que foi inserido no checkout.
Montante	amount	string	O valor que é deduzido do total do pedido. Quando você cria um pedido, esse valor é a porcentagem ou o valor monetário a ser deduzido.
tipo	type	string	O tipo de desconto.

discount_codes

Uma lista de descontos aplicados ao pedido.

Name	Caminho	Tipo	Description
Itens		discount_code

discount_application

Name	Caminho	Tipo	Description
tipo	type	string	O tipo de aplicação de desconto.
valor	value	string	O valor do aplicativo de desconto como decimal. Isso representa a intenção do pedido de desconto.
value_type	value_type	string	O tipo do valor.
allocation_method	allocation_method	string	O método pelo qual o valor do pedido de desconto foi atribuído às linhas autorizadas.
target_selection	target_selection	string	As linhas na ordem, do tipo definido por target_type, sobre as quais o desconto é atribuído.
target_type	target_type	string	O tipo de linha na ordem em que o desconto é aplicável.
código	code	string	O código de desconto que foi usado para aplicar o desconto. Disponível apenas para aplicações de código de desconto.

discount_applications

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

Name	Caminho	Tipo	Description
Itens		discount_application

recibo

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

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

Partilhar via

Shopify (Editora independente) (Visualização)

A criar uma ligação

Padrão

Limites de Limitação

Ações

Atualiza uma encomenda

Parâmetros

Devoluções

Cancelar uma encomenda

Parâmetros

Devoluções

Recupera uma lista de clientes

Parâmetros

Devoluções

Recupera uma lista de pedidos

Parâmetros

Devoluções

Definições

order

cliente

default_address

shipping_address

billing_address

addresses

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

Reembolsos

reembolso

line_item

line_items

shipping_lines

payment_gateway_names

note_attribute

note_attributes

discount_code

discount_codes

discount_application

discount_applications

recibo