Adobe Commerce (versão prévia)

O Adobe Commerce, da Magento, fornece plataformas de comércio eletrônico e soluções de nuvem. Conecte-se ao Adobe Commerce para recuperar pedidos e enviar atualizações.

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

Service	Classe	Regions
Aplicativos Lógicos	Standard	Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:      – Azure Government regiões      - Azure regiões da China      - Departamento de Defesa dos EUA (DoD)

Contato
Nome	Microsoft Dynamics
URL	https://aka.ms/iomsupport
Email	iomdri@microsoft.com

Metadados do conector
Publicador	Microsoft
Site	https://business.adobe.com/products/magento/magento-commerce.html
Política de privacidade	https://www.adobe.com/privacy/policy.html
Categorias	Comércio; Site

O conector do Adobe Commerce foi desenvolvido especificamente para ser usado para a integração do Provedor do Dynamics 365 Intelligent Order Management.

Pré-requisitos

A conta do Adobe Commerce Cloud está registrada e o Site é implantado.

Como obter credenciais

Token de acesso (tipo de token de integração):

• Fazer logon no Administrador do Site do Adobe Commerce
• Clique em Integrações de Extensões > do Sistema > para exibir a página Integrações.
• Clique em "Adicionar Nova Integração" para exibir a página Nova Integração.
• Insira um nome exclusivo para a integração no campo Nome e, em seguida, insira sua senha de administrador no campo Sua Senha. Deixe todos os outros campos em branco.
• Clique na guia API. Selecione os recursos do Adobe Commerce que a integração pode acessar. Você pode selecionar todos os recursos ou selecionar uma lista personalizada.
• Clique em Salvar para salvar suas alterações e retornar à página Integrações.
• Clique no link Ativar na grade que corresponde à integração recém-criada.
• Clique em Permitir e uma caixa de diálogo é aberta.
• Localize o 'Token de Acesso' nessa caixa de diálogo.

Observação: a URL do host é o nome de host do Site do Adobe Commerce

Introdução ao conector

Siga https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider para habilitar o Adobe Commerce Provider.

Problemas e limitações conhecidos

Esse conector foi desenvolvido especificamente para ser usado para a integração do Adobe Commerce Provider do Dynamics 365 Intelligent Order Management. O suporte para casos de uso fora do Dynamics 365 Intelligent Order Management será limitado.

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	Descrição	Obrigatório
Chave de API	secureString	A chave de API para esta api	Verdade
URL do Host da Loja	cadeia	Adobe Commerce Store Host URL	Verdade

Limitações

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

Ações

Cancelar um pedido	Cancela um pedido especificado.
Criar ou atualizar um pedido	Cria ou atualiza uma ordem especificada.
Obter o cliente por ID do cliente	Obtenha o cliente pela ID do cliente.
Obter todos os pedidos	Lista os pedidos que correspondem aos critérios de pesquisa especificados.

Cancelar um pedido

ID da operação:

Cancel_An_Order

Cancela um pedido especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pedido Exclusivo	id	True	string	ID do Pedido Exclusivo.

Retornos

Resposta

boolean

Criar ou atualizar um pedido

ID da operação:

Create_Or_Update_An_Order

Cria ou atualiza uma ordem especificada.

Retornos

Corpo

itemsHeader

Obter o cliente por ID do cliente

ID da operação:

Get_Customer_By_Customer_ID

Obtenha o cliente pela ID do cliente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do cliente	customerId	True	string	Obtenha o cliente por ID.

Retornos

Corpo

CustomerCollectionResponse

Obter todos os pedidos

ID da operação:

Get_All_Orders

Lista os pedidos que correspondem aos critérios de pesquisa especificados.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Página atual	searchCriteria[currentPage]		integer	Retorna a página atual.
Condição de filtro	searchCriteria[filter_groups][0][filters][0][condition_type]		string	Condição para filtro em pedidos.
Filtrar no campo	searchCriteria[filter_groups][0][filters][0][field]		string	Campo para filtro em pedidos.
Valor do filtro	searchCriteria[filter_groups][0][filters][0][value]		string	Valor para filtro em pedidos.
Tamanho da página	searchCriteria[pageSize]		integer	Número total de registros por página.
Direção de classificação	searchCriteria[sortOrders][0][direction]		string	Classificar em asc ou desc.
Campo de classificação	searchCriteria[sortOrders][0][field]		string	Classificar ordens no campo.

Retornos

Nome	Caminho	Tipo	Description
itens	items	array of itemsHeader
filter_groups	search_criteria.filter_groups	array of object
filters	search_criteria.filter_groups.filters	array of object
campo	search_criteria.filter_groups.filters.field	string
value	search_criteria.filter_groups.filters.value	string
condition_type	search_criteria.filter_groups.filters.condition_type	string
sort_orders	search_criteria.sort_orders	array of object
campo	search_criteria.sort_orders.field	string
direção	search_criteria.sort_orders.direction	string
page_size	search_criteria.page_size	integer
current_page	search_criteria.current_page	integer
total_count	total_count	integer

Definições

billing_address

Nome	Caminho	Tipo	Description
address_type	address_type	string
cidade	city	string
empresa	company	string
country_id	country_id	string
customer_address_id	customer_address_id	integer
customer_id	customer_id	integer	ID do cliente.
email	email	string
entity_id	entity_id	integer	ID da entidade.
fax	fax	string
primeiro nome	firstname	string
sobrenome	lastname	string
middlename	middlename	string
parent_id	parent_id	integer
Cp	postcode	string
prefix	prefix	string
região	region	string
region_code	region_code	string
region_id	region_id	integer
rua	street	array of string
sufixo	suffix	string
telefone	telephone	string
vat_id	vat_id	string
vat_is_valid	vat_is_valid	integer
vat_request_date	vat_request_date	string
vat_request_id	vat_request_id	string
vat_request_success	vat_request_success	integer
vertex_vat_country_code	extension_attributes.vertex_vat_country_code	string

pagamento

Nome	Caminho	Tipo	Description
account_status	account_status	string
additional_data	additional_data	string
additional_information	additional_information	array of string
address_status	address_status	string
amount_authorized	amount_authorized	float
amount_canceled	amount_canceled	float
amount_ordered	amount_ordered	float
amount_paid	amount_paid	float
amount_refunded	amount_refunded	float	Valor reembolsado.
anet_trans_method	anet_trans_method	string
base_amount_authorized	base_amount_authorized	float
base_amount_canceled	base_amount_canceled	float
base_amount_ordered	base_amount_ordered	float
base_amount_paid	base_amount_paid	float
base_amount_paid_online	base_amount_paid_online	float
base_amount_refunded	base_amount_refunded	float	Valor base reembolsado.
base_amount_refunded_online	base_amount_refunded_online	float
base_shipping_amount	base_shipping_amount	float	Valor de envio base.
base_shipping_captured	base_shipping_captured	float
base_shipping_refunded	base_shipping_refunded	float
cc_approval	cc_approval	string
cc_avs_status	cc_avs_status	string
cc_cid_status	cc_cid_status	string
cc_debug_request_body	cc_debug_request_body	string
cc_debug_response_body	cc_debug_response_body	string
cc_debug_response_serialized	cc_debug_response_serialized	string
cc_exp_month	cc_exp_month	string
cc_exp_year	cc_exp_year	string
cc_last4	cc_last4	string
cc_number_enc	cc_number_enc	string
cc_owner	cc_owner	string
cc_secure_verify	cc_secure_verify	string
cc_ss_issue	cc_ss_issue	string
cc_ss_start_month	cc_ss_start_month	string
cc_ss_start_year	cc_ss_start_year	string
cc_status	cc_status	string
cc_status_description	cc_status_description	string
cc_trans_id	cc_trans_id	string
cc_type	cc_type	string
echeck_account_name	echeck_account_name	string
echeck_account_type	echeck_account_type	string
echeck_bank_name	echeck_bank_name	string
echeck_routing_number	echeck_routing_number	string
echeck_type	echeck_type	string
entity_id	entity_id	integer	ID da entidade.
last_trans_id	last_trans_id	string
método	method	string
parent_id	parent_id	integer
po_number	po_number	string
protection_eligibility	protection_eligibility	string
quote_payment_id	quote_payment_id	integer
shipping_amount	shipping_amount	float	Valor do envio.
shipping_captured	shipping_captured	float
shipping_refunded	shipping_refunded	float	Remessa reembolsada.
notification_message	extension_attributes.notification_message	string
entity_id	extension_attributes.vault_payment_token.entity_id	integer	ID da entidade.
customer_id	extension_attributes.vault_payment_token.customer_id	integer	ID do cliente.
public_hash	extension_attributes.vault_payment_token.public_hash	string
payment_method_code	extension_attributes.vault_payment_token.payment_method_code	string
tipo	extension_attributes.vault_payment_token.type	string
criado_em	extension_attributes.vault_payment_token.created_at	string	Criado em.
expira_em	extension_attributes.vault_payment_token.expires_at	string
gateway_token	extension_attributes.vault_payment_token.gateway_token	string
token_details	extension_attributes.vault_payment_token.token_details	string
is_active	extension_attributes.vault_payment_token.is_active	boolean
is_visible	extension_attributes.vault_payment_token.is_visible	boolean

status_histories

Nome	Caminho	Tipo	Description
comentário	comment	string
criado_em	created_at	string	Criado em.
entity_id	entity_id	integer	ID da entidade.
entity_name	entity_name	string
is_customer_notified	is_customer_notified	integer
is_visible_on_front	is_visible_on_front	integer
parent_id	parent_id	integer
status	status	string	Status do pedido.
extension_attributes	extension_attributes	object

extension_attributes

Nome	Caminho	Tipo	Description
payment_additional_info	payment_additional_info	array of object
chave	payment_additional_info.key	string
value	payment_additional_info.value	string
order_id	company_order_attributes.order_id	float	ID do pedido.
company_id	company_order_attributes.company_id	float
company_name	company_order_attributes.company_name	string
extension_attributes	company_order_attributes.extension_attributes	object
applied_taxes	applied_taxes	array of object
codificar	applied_taxes.code	string
title	applied_taxes.title	string
percent	applied_taxes.percent	float
amount	applied_taxes.amount	float
base_amount	applied_taxes.base_amount	float
Taxas	applied_taxes.extension_attributes.rates	array of object
itens	applied_taxes.extension_attributes.rates	object
item_applied_taxes	item_applied_taxes	array of object
tipo	item_applied_taxes.type	string
item_id	item_applied_taxes.item_id	float	ID do item.
associated_item_id	item_applied_taxes.associated_item_id	float
applied_taxes	item_applied_taxes.applied_taxes	array of object
itens	item_applied_taxes.applied_taxes	object
extension_attributes	item_applied_taxes.extension_attributes	object
converting_from_quote	converting_from_quote	boolean
base_customer_balance_amount	base_customer_balance_amount	float
customer_balance_amount	customer_balance_amount	float
base_customer_balance_invoiced	base_customer_balance_invoiced	float
customer_balance_invoiced	customer_balance_invoiced	float
base_customer_balance_refunded	base_customer_balance_refunded	float
customer_balance_refunded	customer_balance_refunded	float
base_customer_balance_total_refunded	base_customer_balance_total_refunded	float
customer_balance_total_refunded	customer_balance_total_refunded	float
gift_cards	gift_cards	array of object
id	gift_cards.id	float
codificar	gift_cards.code	string
amount	gift_cards.amount	float
base_amount	gift_cards.base_amount	float
base_gift_cards_amount	base_gift_cards_amount	float
gift_cards_amount	gift_cards_amount	float
base_gift_cards_invoiced	base_gift_cards_invoiced	float
gift_cards_invoiced	gift_cards_invoiced	float
base_gift_cards_refunded	base_gift_cards_refunded	float
gift_cards_refunded	gift_cards_refunded	float
gift_message_id	gift_message.gift_message_id	float
customer_id	gift_message.customer_id	float	ID do cliente.
remetente	gift_message.sender	string
destinatário	gift_message.recipient	string
mensagem	gift_message.message	string
entity_id	gift_message.extension_attributes.entity_id	string	ID da entidade.
entity_type	gift_message.extension_attributes.entity_type	string
wrapping_id	gift_message.extension_attributes.wrapping_id	float
wrapping_allow_gift_receipt	gift_message.extension_attributes.wrapping_allow_gift_receipt	boolean
wrapping_add_printed_card	gift_message.extension_attributes.wrapping_add_printed_card	boolean
gw_id	gw_id	string	ID gw.
gw_allow_gift_receipt	gw_allow_gift_receipt	string
gw_add_card	gw_add_card	string
gw_base_price	gw_base_price	string	Preço base gw.
gw_price	gw_price	string	Preço gw.
gw_items_base_price	gw_items_base_price	string
gw_items_price	gw_items_price	string
gw_card_base_price	gw_card_base_price	string
gw_card_price	gw_card_price	string
gw_base_tax_amount	gw_base_tax_amount	string	Valor do imposto base gw.
gw_tax_amount	gw_tax_amount	string	Valor do imposto base gw.
gw_items_base_tax_amount	gw_items_base_tax_amount	string
gw_items_tax_amount	gw_items_tax_amount	string
gw_card_base_tax_amount	gw_card_base_tax_amount	string
gw_card_tax_amount	gw_card_tax_amount	string
gw_base_price_incl_tax	gw_base_price_incl_tax	string
gw_price_incl_tax	gw_price_incl_tax	string
gw_items_base_price_incl_tax	gw_items_base_price_incl_tax	string
gw_items_price_incl_tax	gw_items_price_incl_tax	string
gw_card_base_price_incl_tax	gw_card_base_price_incl_tax	string
gw_card_price_incl_tax	gw_card_price_incl_tax	string
gw_base_price_invoiced	gw_base_price_invoiced	string	Preço base gw faturado.
gw_price_invoiced	gw_price_invoiced	string	Preço gw faturado.
gw_items_base_price_invoiced	gw_items_base_price_invoiced	string	Preço base dos itens gw faturados.
gw_items_price_invoiced	gw_items_price_invoiced	string	Preço base dos itens gw faturados.
gw_card_base_price_invoiced	gw_card_base_price_invoiced	string	Preço base dos itens gw faturados.
gw_card_price_invoiced	gw_card_price_invoiced	string	Preço base dos itens gw faturados.
gw_base_tax_amount_invoiced	gw_base_tax_amount_invoiced	string	Preço base dos itens gw faturados.
gw_tax_amount_invoiced	gw_tax_amount_invoiced	string	Preço base dos itens gw faturados.
gw_items_base_tax_invoiced	gw_items_base_tax_invoiced	string	Preço base dos itens gw faturados.
gw_items_tax_invoiced	gw_items_tax_invoiced	string	Preço base dos itens gw faturados.
gw_card_base_tax_invoiced	gw_card_base_tax_invoiced	string	Preço base dos itens gw faturados.
gw_card_tax_invoiced	gw_card_tax_invoiced	string	Preço base dos itens gw faturados.
gw_base_price_refunded	gw_base_price_refunded	string	Preço base de itens gw reembolsado.
gw_price_refunded	gw_price_refunded	string	Preço base de itens gw reembolsado.
gw_items_base_price_refunded	gw_items_base_price_refunded	string	Preço base de itens gw reembolsado.
gw_items_price_refunded	gw_items_price_refunded	string	Preço base de itens gw reembolsado.
gw_card_base_price_refunded	gw_card_base_price_refunded	string	Preço base de itens gw reembolsado.
gw_card_price_refunded	gw_card_price_refunded	string	Preço base de itens gw reembolsado.
gw_base_tax_amount_refunded	gw_base_tax_amount_refunded	string	Preço base de itens gw reembolsado.
gw_tax_amount_refunded	gw_tax_amount_refunded	string	Preço base de itens gw reembolsado.
gw_items_base_tax_refunded	gw_items_base_tax_refunded	string	Preço base de itens gw reembolsado.
gw_items_tax_refunded	gw_items_tax_refunded	string	Preço base de itens gw reembolsado.
gw_card_base_tax_refunded	gw_card_base_tax_refunded	string	Imposto sobre cartão gw reembolsado.
gw_card_tax_refunded	gw_card_tax_refunded	string	Imposto sobre cartão gw reembolsado.
reward_points_balance	reward_points_balance	float	Imposto sobre cartão gw reembolsado.
reward_currency_amount	reward_currency_amount	float	Valor da moeda de recompensa.
base_reward_currency_amount	base_reward_currency_amount	float	Valor da moeda de recompensa.
amazon_order_reference_id	amazon_order_reference_id.amazon_order_reference_id	string
order_id	amazon_order_reference_id.order_id	float	ID do pedido.

itens

Nome	Caminho	Tipo	Description
base_amount_refunded	base_amount_refunded	float	Valor base reembolsado.
base_cost	base_cost	float	Custo base.
base_discount_amount	base_discount_amount	float	Valor de desconto base.
base_discount_invoiced	base_discount_invoiced	float	Desconto base faturado.
base_discount_refunded	base_discount_refunded	float	Desconto base reembolsado.
base_original_price	base_original_price	float	Preço base.
base_price	base_price	float	Preço base.
base_price_incl_tax	base_price_incl_tax	float	Imposto sobre preços base.
base_row_invoiced	base_row_invoiced	float	Linha base faturada.
base_row_total	base_row_total	float	Total da linha base.
base_row_total_incl_tax	base_row_total_incl_tax	float	Imposto total da linha base.
base_tax_amount	base_tax_amount	float	Valor do imposto base.
base_tax_before_discount	base_tax_before_discount	float	Imposto base antes do desconto.
base_tax_invoiced	base_tax_invoiced	float	Imposto base faturado.
base_tax_refunded	base_tax_refunded	float	Imposto base reembolsado.
criado_em	created_at	string	Criado em.
descrição	description	string
discount_amount	discount_amount	float	Valor do desconto.
discount_invoiced	discount_invoiced	float	Desconto faturado.
discount_percent	discount_percent	float	Desconto faturado.
discount_refunded	discount_refunded	float	Desconto reembolsado.
event_id	event_id	integer	Desconto faturado.
ext_order_item_id	ext_order_item_id	string	Desconto faturado.
free_shipping	free_shipping	integer	Frete grátis.
is_qty_decimal	is_qty_decimal	integer	É qty decimal.
is_virtual	is_virtual	integer	É virtual.
item_id	item_id	integer	ID do item.
locked_do_invoice	locked_do_invoice	integer	Fatura de tarefas bloqueadas.
locked_do_ship	locked_do_ship	integer	Fatura de tarefas bloqueadas.
nome	name	string	Nome de.
no_discount	no_discount	integer	Sem desconto.
order_id	order_id	integer	ID do pedido.
original_price	original_price	float	Preço original.
parent_item_id	parent_item_id	integer	ID do item pai.
price	price	float	Item de preço.
price_incl_tax	price_incl_tax	float	Imposto sobre preços incl.
product_id	product_id	float	ID do produto.
product_type	product_type	string	Tipo de produto.
qty_backordered	qty_backordered	float	Qty backordered.
qty_canceled	qty_canceled	float	Qty cancelada.
qty_invoiced	qty_invoiced	float	Qty faturado.
qty_ordered	qty_ordered	float	Qty ordenado.
qty_refunded	qty_refunded	float	Qty reembolsado.
qty_returned	qty_returned	float	Qty voltou.
qty_shipped	qty_shipped	float	Qty enviado.
quote_item_id	quote_item_id	integer	ID do item de aspas.
row_invoiced	row_invoiced	float	Linha faturada.
row_total	row_total	float	Total de linhas.
row_total_incl_tax	row_total_incl_tax	float	Total de linhas, incluindo impostos.
row_weight	row_weight	float	Peso da linha.
sku	sku	string	SKU do item.
store_id	store_id	integer	ID da loja.
tax_amount	tax_amount	float	Valor do imposto.
tax_before_discount	tax_before_discount	float
tax_canceled	tax_canceled	float	Imposto cancelado.
tax_invoiced	tax_invoiced	float	Imposto faturado.
tax_percent	tax_percent	float
tax_refunded	tax_refunded	float	Imposto reembolsado.
updated_at	updated_at	string
weee_tax_applied	weee_tax_applied	string	Imposto de wee aplicado.
weee_tax_applied_amount	weee_tax_applied_amount	float	Valor aplicado ao imposto do wee.
weee_tax_applied_row_amount	weee_tax_applied_row_amount	float	Valor aplicado ao imposto do wee.
weee_tax_disposition	weee_tax_disposition	float	Disposição fiscal do wee.
weee_tax_row_disposition	weee_tax_row_disposition	float	Disposição fiscal do wee.
weight	weight	float	Peso do item.
parent_item	parent_item	object	Item pai.
custom_options	product_option.extension_attributes.custom_options	array of object
itens	product_option.extension_attributes.custom_options	object
bundle_options	product_option.extension_attributes.bundle_options	array of object
itens	product_option.extension_attributes.bundle_options	object
downloadable_links	product_option.extension_attributes.downloadable_option.downloadable_links	array of object
itens	product_option.extension_attributes.downloadable_option.downloadable_links	object
giftcard_amount	product_option.extension_attributes.giftcard_item_option.giftcard_amount	string
custom_giftcard_amount	product_option.extension_attributes.giftcard_item_option.custom_giftcard_amount	float
giftcard_sender_name	product_option.extension_attributes.giftcard_item_option.giftcard_sender_name	string
giftcard_recipient_name	product_option.extension_attributes.giftcard_item_option.giftcard_recipient_name	string
giftcard_sender_email	product_option.extension_attributes.giftcard_item_option.giftcard_sender_email	string
giftcard_recipient_email	product_option.extension_attributes.giftcard_item_option.giftcard_recipient_email	string
giftcard_message	product_option.extension_attributes.giftcard_item_option.giftcard_message	string
giftcard_created_codes	product_option.extension_attributes.giftcard_item_option.extension_attributes.giftcard_created_codes	array of
configurable_item_options	product_option.extension_attributes.configurable_item_options	array of object
itens	product_option.extension_attributes.configurable_item_options	object
gift_message_id	extension_attributes.gift_message.gift_message_id	integer
customer_id	extension_attributes.gift_message.customer_id	integer	ID do cliente.
remetente	extension_attributes.gift_message.sender	string	Nome do remetente.
destinatário	extension_attributes.gift_message.recipient	string	Nome do destinatário.
mensagem	extension_attributes.gift_message.message	string	Texto da mensagem.
entity_id	extension_attributes.gift_message.extension_attributes.entity_id	string	ID da entidade.
entity_type	extension_attributes.gift_message.extension_attributes.entity_type	string
wrapping_id	extension_attributes.gift_message.extension_attributes.wrapping_id	integer
wrapping_allow_gift_receipt	extension_attributes.gift_message.extension_attributes.wrapping_allow_gift_receipt	boolean
wrapping_add_printed_card	extension_attributes.gift_message.extension_attributes.wrapping_add_printed_card	boolean
gw_id	extension_attributes.gw_id	string	ID gw.
gw_base_price	extension_attributes.gw_base_price	string	Preço base gw.
gw_price	extension_attributes.gw_price	string	Preço gw.
gw_base_tax_amount	extension_attributes.gw_base_tax_amount	string	Valor do imposto base gw.
gw_tax_amount	extension_attributes.gw_tax_amount	string	Valor do imposto base gw.
gw_base_price_invoiced	extension_attributes.gw_base_price_invoiced	string	Preço base gw faturado.
gw_price_invoiced	extension_attributes.gw_price_invoiced	string	Preço gw faturado.
gw_base_tax_amount_invoiced	extension_attributes.gw_base_tax_amount_invoiced	string
gw_tax_amount_invoiced	extension_attributes.gw_tax_amount_invoiced	string
gw_base_price_refunded	extension_attributes.gw_base_price_refunded	string
gw_price_refunded	extension_attributes.gw_price_refunded	string
gw_base_tax_amount_refunded	extension_attributes.gw_base_tax_amount_refunded	string
gw_tax_amount_refunded	extension_attributes.gw_tax_amount_refunded	string
vertex_tax_codes	extension_attributes.vertex_tax_codes	array of string
invoice_text_codes	extension_attributes.invoice_text_codes	array of string
tax_codes	extension_attributes.tax_codes	array of string
codificar	extension_attributes.vertex_commodity_code.code	string
tipo	extension_attributes.vertex_commodity_code.type	string

itemsHeader

Nome	Caminho	Tipo	Description
base_discount_amount	base_discount_amount	float	Valor de desconto base.
base_discount_canceled	base_discount_canceled	float	Desconto base cancelado.
base_discount_invoiced	base_discount_invoiced	float	Desconto base faturado.
base_discount_refunded	base_discount_refunded	float	Desconto base reembolsado.
base_grand_total	base_grand_total	float	Total geral base.
base_subtotal	base_subtotal	float	Subtotal base.
base_subtotal_canceled	base_subtotal_canceled	float	Subtotal base cancelado.
base_subtotal_incl_tax	base_subtotal_incl_tax	float	Subtotal base incluído imposto.
base_subtotal_invoiced	base_subtotal_invoiced	float	Base subtotal innvoiced.
base_subtotal_refunded	base_subtotal_refunded	float	Subtotal base reembolsado.
base_tax_amount	base_tax_amount	float	Valor do imposto base.
base_tax_canceled	base_tax_canceled	float	Imposto base cancelado.
base_tax_invoiced	base_tax_invoiced	float	Imposto base faturado.
base_tax_refunded	base_tax_refunded	float	Imposto base reembolsado.
base_total_canceled	base_total_canceled	float	Total base cancelado.
base_total_due	base_total_due	float	Total base devido.
base_total_invoiced	base_total_invoiced	float	Total base faturado.
base_total_invoiced_cost	base_total_invoiced_cost	float	Custo total base faturado.
base_total_offline_refunded	base_total_offline_refunded	float	Total base offline reembolsado.
base_total_online_refunded	base_total_online_refunded	float	Total base online reembolsado.
base_total_paid	base_total_paid	float	Total base pago.
base_total_qty_ordered	base_total_qty_ordered	float	Quantidade total base ordenada.
base_total_refunded	base_total_refunded	float	Total base reembolsado.
base_to_global_rate	base_to_global_rate	float	Base para taxa global.
base_to_order_rate	base_to_order_rate	float	Taxa de pedidos base a base.
billing_address_id	billing_address_id	float	ID do endereço de cobrança.
can_ship_partially	can_ship_partially	float	Pode enviar parcialmente.
can_ship_partially_item	can_ship_partially_item	float	Pode enviar parcialmente o item.
coupon_code	coupon_code	string	Código de cupom.
criado_em	created_at	string	Criado em.
customer_dob	customer_dob	string	Banco de dados do cliente.
customer_email	customer_email	string	Email do cliente.
customer_firstname	customer_firstname	string	Nome do cliente.
customer_gender	customer_gender	float	Gênero do cliente.
customer_group_id	customer_group_id	float	ID do grupo de clientes.
customer_id	customer_id	float	ID do cliente.
customer_is_guest	customer_is_guest	float	O cliente é convidado.
customer_lastname	customer_lastname	string	Sobrenome do cliente.
customer_middlename	customer_middlename	string	Nome do meio do cliente.
customer_note	customer_note	string	Anotação do cliente.
customer_note_notify	customer_note_notify	float	Notificação de anotação do cliente.
customer_prefix	customer_prefix	string	Prefixo do cliente.
customer_suffix	customer_suffix	string	Sufixo do cliente.
customer_taxvat	customer_taxvat	string	Taxvat do cliente.
discount_amount	discount_amount	float	Valor do desconto.
discount_canceled	discount_canceled	float	Desconto cancelado.
discount_description	discount_description	string	Descrição do desconto.
discount_invoiced	discount_invoiced	float	Desconto faturado.
discount_refunded	discount_refunded	float	Desconto reembolsado.
edit_increment	edit_increment	float	Editar incremento.
email_sent	email_sent	float	Email enviado.
entity_id	entity_id	float	ID da entidade.
ext_customer_id	ext_customer_id	string	Ext customer id.
ext_order_id	ext_order_id	string	Ext order id.
forced_shipment_with_invoice	forced_shipment_with_invoice	float	Envio forçado com fatura.
global_currency_code	global_currency_code	string	Código de moeda global.
grand_total	grand_total	float	Total geral.
discount_tax_compensation_amount	discount_tax_compensation_amount	float	Valor da compensação de imposto de desconto.
discount_tax_compensation_invoiced	discount_tax_compensation_invoiced	float	Compensação de imposto de desconto faturada.
discount_tax_compensation_refunded	discount_tax_compensation_refunded	float	Compensação de imposto de desconto reembolsada.
hold_before_state	hold_before_state	string	Segure antes do estado.
hold_before_status	hold_before_status	string	Mantenha o status antes.
increment_id	increment_id	string	Incrementar id.
is_virtual	is_virtual	float	É virtual.
order_currency_code	order_currency_code	string	Ordenar código de moeda.
original_increment_id	original_increment_id	string	ID de incremento original.
payment_authorization_amount	payment_authorization_amount	float	Valor de autorização de pagamento.
payment_auth_expiration	payment_auth_expiration	float	Expiração da autorização de pagamento.
protect_code	protect_code	string	Proteger código.
quote_address_id	quote_address_id	float	ID do endereço de aspas.
quote_id	quote_id	float	ID da cotação.
relation_child_id	relation_child_id	string	ID filho da relação.
relation_child_real_id	relation_child_real_id	string	ID real do filho da relação.
relation_parent_id	relation_parent_id	string	ID pai da relação.
relation_parent_real_id	relation_parent_real_id	string	ID real do pai da relação.
remote_ip	remote_ip	string	Ip remoto.
shipping_amount	shipping_amount	float	Valor do envio.
shipping_canceled	shipping_canceled	float	Envio cancelado.
shipping_description	shipping_description	string	Envio de descritor.
shipping_discount_amount	shipping_discount_amount	float	Valor do desconto de envio.
shipping_discount_tax_compensation_amount	shipping_discount_tax_compensation_amount	float	Valor de compensação de imposto de desconto de envio.
shipping_incl_tax	shipping_incl_tax	float	Imposto sobre remessa de incl.
shipping_invoiced	shipping_invoiced	float	Envio faturado.
shipping_refunded	shipping_refunded	float	Remessa reembolsada.
shipping_tax_amount	shipping_tax_amount	float	Valor do imposto de remessa.
shipping_tax_refunded	shipping_tax_refunded	float	Imposto de remessa reembolsado.
estado	state	string	Estado da ordem.
status	status	string	Status do pedido.
store_currency_code	store_currency_code	string	Armazenar código de moeda.
store_id	store_id	float	ID da loja.
store_name	store_name	string	Nome da loja.
store_to_base_rate	store_to_base_rate	float	Armazene para a taxa base.
store_to_order_rate	store_to_order_rate	float	Armazene para taxa de pedidos.
Subtotal	subtotal	float	Subtotal de pedido.
subtotal_canceled	subtotal_canceled	float	Subtotal cancelado.
subtotal_incl_tax	subtotal_incl_tax	float	Imposto de incl subtotal.
subtotal_invoiced	subtotal_invoiced	float	Subtotal faturado.
subtotal_refunded	subtotal_refunded	float	Subtotal reembolsado.
tax_amount	tax_amount	float	Valor do imposto.
tax_canceled	tax_canceled	float	Imposto cancelado.
tax_invoiced	tax_invoiced	float	Imposto faturado.
tax_refunded	tax_refunded	float	Imposto reembolsado.
total_canceled	total_canceled	float	Imposto cancelado.
total_due	total_due	float	Total devido.
total_invoiced	total_invoiced	float	Total faturado.
total_item_count	total_item_count	float	Contagem total de itens.
total_offline_refunded	total_offline_refunded	float	Total offline reembolsado.
total_online_refunded	total_online_refunded	float	Total de reembolso online.
total_paid	total_paid	float	Total pago.
total_qty_ordered	total_qty_ordered	float	Quantidade total ordenada.
total_refunded	total_refunded	float	Total reembolsado.
updated_at	updated_at	string	Atualizado em.
weight	weight	float	Peso do item.
x_forwarded_for	x_forwarded_for	string	Encaminhado para.
itens	items	items
billing_address	billing_address	billing_address
pagamento	payment	payment
status_histories	status_histories	status_histories
extension_attributes	extension_attributes	extension_attributes

CustomerCollectionResponse

Nome	Caminho	Tipo	Description
id	id	integer	ID do cliente.
group_id	group_id	integer	ID do grupo de clientes.
default_billing	default_billing	string	Cobrança padrão do cliente.
default_shipping	default_shipping	string	Envio padrão do cliente.
confirmação	confirmation	string	Confirmação do cliente.
criado_em	created_at	string	Criado na data.
updated_at	updated_at	string	Atualizado na data.
created_in	created_in	string	Criado em.
dob	dob	string	Data de nascimento.
email	email	string	Email do cliente.
primeiro nome	firstname	string	Nome do cliente.
sobrenome	lastname	string	Sobrenome do cliente.
middlename	middlename	string	Nome do meio do cliente.
prefix	prefix	string	Prefixo usado.
sufixo	suffix	string	Sufixo usado.
Gênero	gender	integer	Gênero do cliente.
store_id	store_id	integer	ID da loja.
taxvat	taxvat	string	Imposto.
website_id	website_id	integer	ID do site.
addresses	addresses	CustomerAddresses	Endereços do cliente.
disable_auto_group_change	disable_auto_group_change	integer	Desabilitar alteração de grupo automático.
extension_attributes	extension_attributes	CustomerExtensionAttributes	Atributos de extensão.
custom_attributes	custom_attributes	array of CustomerCustomAttributes	Atributos personalizados

CustomerAddresses

Endereços do cliente.

Nome	Caminho	Tipo	Description
id	id	integer	ID do endereço.
customer_id	customer_id	integer	ID do cliente.
region_code	region.region_code	string	Código da região.
região	region.region	string
region_id	region.region_id	integer	ID da região.
region_id	region_id	integer	ID da região.
country_id	country_id	string	ID do país.
rua	street	array of string	Endereço.
empresa	company	string	Empresa de clientes.
telefone	telephone	string	Telefone do cliente.
fax	fax	string	Fax do cliente.
Cp	postcode	string	Código postal do cliente.
cidade	city	string	Cidade do cliente.
primeiro nome	firstname	string	Nome do cliente.
sobrenome	lastname	string	Sobrenome do cliente.
middlename	middlename	string	Nome do meio do cliente.
prefix	prefix	string	Prefixo do cliente.
sufixo	suffix	string	Sufixo do cliente.
vat_id	vat_id	string	ID do IVA.
default_shipping	default_shipping	boolean	Envio padrão.
default_billing	default_billing	boolean	Cobrança padrão.
custom_attributes	custom_attributes	array of object	Atributos personalizados.
attribute_code	custom_attributes.attribute_code	string	Código de atributo.
value	custom_attributes.value	string	Valor do atributo.

CustomerExtensionAttributes

Atributos de extensão.

Nome	Caminho	Tipo	Description
customer_id	company_attributes.customer_id	integer	ID do cliente.
company_id	company_attributes.company_id	integer	ID da empresa.
título do cargo	company_attributes.job_title	string	Cargo.
status	company_attributes.status	integer	Código de status.
telefone	company_attributes.telephone	string	Telefone do cliente.
is_subscribed	is_subscribed	boolean	Está inscrito.
amazon_id	amazon_id	string	ID da Amazon.
vertex_customer_code	vertex_customer_code	string	Código do cliente do Vértice.
vertex_customer_country	vertex_customer_country	string	País do cliente do Vértice.

CustomerCustomAttributes

Nome	Caminho	Tipo	Description
attribute_code	attribute_code	string	Código de atributo.
value	value	string	Valor do atributo.

boolean

Esse é o tipo de dados básico 'booleano'.