BigCommerce (Pré-visualização)

O BigCommerce é uma plataforma SaaS flexível e aberta. Conecte-se ao BigCommerce para recuperar pedidos, produtos e informações relacionadas.

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

Serviço	Class	Regiões
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)
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)
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)

Contato
Nome	Dinâmica da Microsoft
URL	https://aka.ms/iomsupport
Email	iomdri@microsoft.com

Metadados do conector
Editora	Microsoft
Sítio Web	https://www.bigcommerce.com/
Política de privacidade	https://www.bigcommerce.com/privacy/
Categorias	Produtividade

Esse conector foi desenvolvido especificamente para ser usado na integração do provedor Big Commerce do Dynamics 365 Intelligent Order Management.

Pré-requisitos

É necessária uma conta de desenvolvedor do BigCommerce e uma loja de teste. Se você não tiver um, você pode criá-lo em https://developer.bigcommerce.com/ Nota: Recomenda-se usar esse conector especificamente para configurar o provedor Dynamics 365 Intelligent Order Management BigCommerce.

Como obter credenciais

O BigCommerce requer um token de API para autenticação. Você pode gerar um token https://store-XYZ.mybigcommerce.com/manage/settings/auth/api-accounts de API e usá-lo para configurar o conector. Nota: O XYZ é o código hash da sua loja.

Introdução ao conector

Configure a conexão com o token da API. Para saber mais sobre as APIs do BigCommerce, leia a documentação pública: https://developer.bigcommerce.com/api-docs

Problemas conhecidos e limitações

Detalhes sobre os limites de taxa de API podem ser encontrados no seguinte tópico de documentação: https://developer.bigcommerce.com/api-docs/getting-started/best-practices#api-rate-limits Detalhes sobre os limites da plataforma podem ser encontrados no seguinte tópico de documentação: https://developer.bigcommerce.com/api-docs/getting-started/best-practices#platform-limits

Esse conector foi desenvolvido especificamente para ser usado na integração do provedor BigCommerce do Dynamics 365 Intelligent Order Management. O suporte para casos de uso fora do Dynamics 365 Intelligent Order Management será limitado.

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	A chave de API para esta api	Verdade

Limites de Limitação

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

Ações

Atualizar produto	Atualiza um produto. Read-Only Campos id date_created date_modified calculated_price base_variant_id
Atualizar uma encomenda	Atualiza um pedido. Para saber mais sobre como criar ou atualizar pedidos, consulte Visão geral de pedidos.
Listar Produtos de Encomenda	Lista todos os produtos do pedido em um pedido usando o ID do pedido.
Obter endereços de envio de pedidos	Obtém todos os endereços de envio em um pedido usando o ID do pedido.
Obter produto por ID	Devolve um único Produto. Parâmetros opcionais podem ser passados.
Obter produtos	Devolve uma lista de Produtos. Parâmetros de filtro opcionais podem ser passados.
Obter todas as encomendas	Obtém todos os pedidos usando a consulta de filtro.
Obter todos os clientes	Retorna uma lista de Clientes. Parâmetros de filtro opcionais podem ser passados.
Obter uma encomenda	Obtém um pedido usando o ID do pedido.

Atualizar produto

ID da Operação:

UpdateProduct

Atualiza um produto.

Read-Only Campos

• id
• date_created
• date_modified
• calculated_price
• base_variant_id

Parâmetros

Name	Chave	Necessário	Tipo	Description
Hash da loja	store_hash	True	string	O código hash da loja.
ID do Produto	product_id	True	integer	A ID do Product recurso ao qual o recurso pertence.
			object
Incluir campos	include_fields		string	Campos a incluir numa lista separada por vírgula. O ID e os campos especificados serão retornados.

Devoluções

ProductResponse

ProductResponse

Atualizar uma encomenda

ID da Operação:

UpdateAnOrder

Atualiza um pedido. Para saber mais sobre como criar ou atualizar pedidos, consulte Visão geral de pedidos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Hash da loja	store_hash	True	string	O código hash da loja.
order_id	order_id	True	integer	ID da encomenda
			object

Devoluções

Objeto de ordem retornado em respostas.

order_Resp

order_Resp

Listar Produtos de Encomenda

ID da Operação:

GetAllOrderProducts

Lista todos os produtos do pedido em um pedido usando o ID do pedido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Hash da loja	store_hash	True	string	O código hash da loja.
ID da encomenda	order_id	True	string	ID da encomenda.
Página	page		number	A página a ser retornada na resposta.
Limite	limit		number	Número de resultados a devolver.

Devoluções

Encomende produtos devolvidos em respostas.

Itens

orderProductsCollection_Resp

Obter endereços de envio de pedidos

ID da Operação:

GetAllOrderShippingAddresses

Obtém todos os endereços de envio em um pedido usando o ID do pedido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Hash da loja	store_hash	True	string	O código hash da loja.
ID da encomenda	order_id	True	string	ID da encomenda.
Página	page		number	A página a ser retornada na resposta.
Limite	limit		number	Número de resultados a devolver.

Devoluções

Endereços de envio de pedidos devolvidos em resposta.

Itens

orderShippingAddressCollection_Resp

Obter produto por ID

ID da Operação:

GetProductById

Devolve um único Produto. Parâmetros opcionais podem ser passados.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Hash da loja	store_hash	True	string	O código hash da loja.
ID do Produto	product_id	True	integer	A ID do Product recurso ao qual o recurso pertence.
include	include		string	Sub-recursos a incluir em um produto, em uma lista separada por vírgula. Se options for modifiers ou for usado, os resultados são limitados a 10 por página.
include_fields	include_fields		string	Campos a incluir numa lista separada por vírgula. O ID e os campos especificados serão retornados.
exclude_fields	exclude_fields		string	Campos a excluir, numa lista separada por vírgula. Os campos especificados serão excluídos de uma resposta. O ID não pode ser excluído.

Devoluções

Name	Caminho	Tipo	Description
product_Full	data	product_Full
Meta	meta	object	Meta objeto vazio; pode ser utilizado mais tarde.

Obter produtos

ID da Operação:

GetProducts

Devolve uma lista de Produtos. Parâmetros de filtro opcionais podem ser passados.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Hash da loja	store_hash	True	string	O código hash da loja.
Id	id		integer	Filtrar itens por id.
nome	name		string	Filtre itens por nome.
UPC	upc		string	Filtrar itens por upc.
Preço	price		double	Filtre os itens por preço.
weight	weight		double	Filtrar itens por peso.
condition	condition		string	Filtrar itens por condição.
brand_id	brand_id		integer	Filtrar itens por brand_id.
date_modified	date_modified		date-time	Filtrar itens por date_modified.
date_modified:max	date_modified:max		string	Filtrar itens por date_modified. Por exemplo, date_modified:max=2020-06-15.
date_modified:min	date_modified:min		string	Filtrar itens por date_modified. Por exemplo, date_modified:min=2018-06-15.
date_last_imported	date_last_imported		date-time	Filtrar itens por date_last_imported.
date_last_imported:max	date_last_imported:max		string	Filtrar itens por date_last_imported. Por exemplo, date_last_imported:max=2020-06-15.
date_last_imported:min	date_last_imported:min		string	Filtrar itens por date_last_imported. Por exemplo, date_last_imported:min=2018-06-15.
is_visible	is_visible		boolean	Filtre os itens com base no facto de o produto estar atualmente visível na montra.
is_featured	is_featured		string	Filtrar itens por is_featured. 0 para verdadeiro, 1 para falso.
is_free_shipping	is_free_shipping		integer	Filtrar itens por is_free_shipping.
inventory_level	inventory_level		integer	Filtrar itens por inventory_level.
inventory_level:em	inventory_level:in		integer	Nível de Inventário
inventory_level:not_in	inventory_level:not_in		integer	Nível de Inventário NÃO DENTRO
inventory_level:min	inventory_level:min		integer	MIN de Nível de Inventário
inventory_level:max	inventory_level:max		integer	Nível de Inventário MAX
inventory_level:maior	inventory_level:greater		integer	Nível de Inventário MAIOR
inventory_level:menos	inventory_level:less		integer	Nível de Inventário MENOS
inventory_low	inventory_low		integer	Filtre os itens por inventory_low. Valores: 1, 0.
out_of_stock	out_of_stock		integer	Filtrar itens por out_of_stock. Para ativar o filtro, passe out_of_stock=1.
total_sold	total_sold		integer	Filtrar itens por total_sold.
tipo	type		string	Filtrar itens por tipo.
categories	categories		integer	Filtre itens por categorias. Se um produto estiver em mais de uma categoria, usar essa consulta não retornará o produto. Em vez disso, use categories:in=12.
palavra-chave	keyword		string	Filtre itens por palavras-chave encontradas nos namecampos , descriptionou sku ou no nome da marca.
keyword_context	keyword_context		string	Defina o contexto usado pelo algoritmo de pesquisa para retornar resultados direcionados para o grupo especificado. Use merchant para ajudar os comerciantes a pesquisar seu próprio catálogo. Use shopper para retornar resultados de pesquisa voltados para o comprador.
estado	status		integer	Filtrar itens por status.
include	include		string	Sub-recursos a incluir em um produto, em uma lista separada por vírgula. Se options for modifiers ou for usado, os resultados são limitados a 10 por página.
include_fields	include_fields		string	Campos a incluir numa lista separada por vírgula. O ID e os campos especificados serão retornados.
exclude_fields	exclude_fields		string	Campos a excluir, numa lista separada por vírgula. Os campos especificados serão excluídos de uma resposta. O ID não pode ser excluído.
disponibilidade	availability		string	Filtre itens por disponibilidade. Os valores são: disponível, desativado, pré-encomenda.
página	page		integer	Especifica o número da página em uma lista limitada (paginada) de produtos.
limit	limit		integer	Controla o número de itens por página em uma lista limitada (paginada) de produtos.
direção	direction		string	Direção de classificação. Os valores aceitáveis são: asc, desc.
ordenar	sort		string	Nome do campo pelo qual classificar. Nota: Desde id incrementos quando novos produtos são adicionados, você pode usar esse campo para classificar por data de criação do produto.
categorias:em	categories:in		integer	Filtre itens por categorias. Use para produtos em várias categorias. Por exemplo, categories:in=12.

Devoluções

ProductCollectionResponse

ProductCollectionResponse

Obter todas as encomendas

ID da Operação:

GetAllOrders

Obtém todos os pedidos usando a consulta de filtro.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Hash da loja	store_hash	True	string	O código hash da loja.
ID mínima	min_id		integer	O ID de pedido mínimo.
ID máximo da encomenda	max_id		integer	O ID de ordem máximo.
Total mínimo	min_total		number	O total mínimo de pedidos em formato float.
Total máximo	max_total		number	O total máximo da ordem em formato float.
ID do Cliente	customer_id		integer	ID de cliente da encomenda.
Email	email		string	O e-mail do cliente.
Status ID	status_id		integer	O staus ID da ordem.
ID do carrinho	cart_id		string	O ID do carrinho do pedido.
Método de Pagamento	payment_method		string	O método de pagamento utilizado na encomenda.
Data mínima criada	min_date_created		string	Data mínima em que o pedido foi criado em RFC-2822 ou ISO-8601. RFC-2822: 'Qui, 20 abr 2017 11:32:00 -0400' ISO-8601: «2017-04-20T11:32:00.000-04:00».
Data máxima de criação	max_date_created		string	Data máxima em que o pedido foi criado em RFC-2822 ou ISO-8601. RFC-2822: 'Qui, 20 abr 2017 11:32:00 -0400' ISO-8601: «2017-04-20T11:32:00.000-04:00».
Data mínima de modificação	min_date_modified		string	Data mínima em que o pedido foi modificado em RFC-2822 ou ISO-8601. RFC-2822: 'Qui, 20 abr 2017 11:32:00 -0400' ISO-8601: «2017-04-20T11:32:00.000-04:00».
Data máxima de modificação	max_date_modified		string	Data máxima em que o pedido foi modificado em RFC-2822 ou ISO-8601. RFC-2822: 'Qui, 20 abr 2017 11:32:00 -0400' ISO-8601: «2017-04-20T11:32:00.000-04:00».
Página	page		number	A página a ser retornada na resposta.
Limite	limit		number	Número de resultados a devolver.
Ordenar	sort		string	Campo e direção para ordenar ordens. Para especificar a direção, adicione ':asc' ou ':d esc' ao final do parâmetro de consulta. Por exemplo, 'sort=date_created:desc'.
É suprimido	is_deleted		boolean	Se a encomenda foi eliminada ou arquivada.
ID do canal	channel_id		boolean	O ID do canal do pedido.

Devoluções

Lista de pedidos retornados em respostas.

Itens

orderCollection_Resp

Obter todos os clientes

ID da Operação:

GetCustomers

Retorna uma lista de Clientes. Parâmetros de filtro opcionais podem ser passados.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Hash da loja	store_hash	True	string	O código hash da loja.
Itens por página.	limit		number	Os itens contam por página. limit=50.
Filtrar itens por ID.	id:in		array	Filtrar itens por ID. id:in=4,5,6.
Filtrar itens por customer_group_id.	customer_group_id:in		array	Filtrar itens por customer_group_id. customer_group_id:in=5,6.
Filtrar itens por date_modified.	date_modified		date-time	Filtrar itens por date_modified. date_modified=2018-09-05T13:45:03.
Filtrar itens por date_modified mínimo.	date_modified:min		string	Filtre itens por date_modified mínimo. date_modified:min=2019-09-04T:00:00:00 ou date_modified:min=2019-09-04.
Filtrar itens por date_modified máximo.	date_modified:max		date-time	Filtrar itens por date_modified date_modified:max=2018-09-05T13:45:03 máximo ou date_modified:max=2019-09-04.
Indica se os subrecursos do cliente devem ser incluídos.	include		string	Indica se os subrecursos do cliente devem ser incluídos: addresses - endereços de clientes storecredit - crédito da loja attributes - atributos do cliente e atributos de endereço formfields - campos de formulário de cliente e endereço include=addresses,storecredit,attributes,formfields.
Ordenar itens.	sort		string	Ordenar os itens por date_created, date_modified ou last_name:* date_created:asc - data de criação, ascendente* date_created:desc - data de criação, descendente* last_name:asc - apelido, ascendente* last_name:desc - apelido, descendente * date_modified:asc - data de modificação, ascendente* date_modified:desc- data de modificação, descendente Exemplo: sort=last_name:asc.

Devoluções

Resposta da Recolha de Clientes

CustomerCollectionResponse

Obter uma encomenda

ID da Operação:

GetAnOrder

Obtém um pedido usando o ID do pedido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Hash da loja	store_hash	True	string	O código hash da loja.
ID da encomenda	order_id	True	string	ID da encomenda.

Devoluções

Objeto de ordem retornado em respostas.

order_Resp

order_Resp

Definições

address_Full

Name	Caminho	Tipo	Description
first_name	first_name	string	O primeiro nome do endereço do cliente.
last_name	last_name	string	O sobrenome do endereço do cliente.
Companhia	company	string	A empresa do endereço do cliente.
Endereço1	address1	string	O endereço 1 linha.
Endereço2	address2	string	O endereço 2 linha.
city	city	string	A cidade do endereço do cliente.
state_or_province	state_or_province	string	O nome do estado ou província
código postal	postal_code	string	O código postal do endereço do cliente.
country_code	country_code	string	O código do país do endereço do cliente.
phone	phone	string	O número de telefone do endereço do cliente.
Tipo de endereço	address_type	string	O tipo de endereço. Residencial ou Comercial
customer_id	customer_id	integer	O ID do cliente.
id	id	integer	O ID numérico exclusivo do endereço.
country	country	string	O nome do país do endereço do cliente.

Ajustador

O tipo de ajustador para o preço ou o peso da variante, quando o valor do modificador é selecionado na vitrine.

O tipo de ajustador para o preço ou o peso da variante, quando o valor do modificador é selecionado na vitrine.

Ajustador

string

adjuster_Full

Ajustador para Regras Complexas.

Name	Caminho	Tipo	Description
Ajustador	adjuster	Adjuster	O tipo de ajustador para o preço ou o peso da variante, quando o valor do modificador é selecionado na vitrine.
adjuster_value	adjuster_value	double	A quantidade numérica pela qual o ajustador alterará o preço ou o peso da variante, quando o valor do modificador for selecionado na vitrine.

adjusters_Full

Name	Caminho	Tipo	Description
adjuster_Full	price	adjuster_Full	Ajustador para Regras Complexas.
adjuster_Full	weight	adjuster_Full	Ajustador para Regras Complexas.
image_url	image_url	string	A URL de uma imagem exibida na vitrine quando o valor do modificador é selecionado. Limite de 8MB por ficheiro.
ComprandoDesabilitado	purchasing_disabled	PurchasingDisabled

attribute_Full

Name	Caminho	Tipo	Description
attribute_id	attribute_id	integer	ID do atributo
attribute_value	attribute_value	string	Valor do atributo
customer_id	customer_id	integer	ID do Cliente
date_created	date_created	date-time	A data em que o atributo do cliente foi criado
date_modified	date_modified	date-time	A data em que o atributo do cliente foi modificado
id	id	integer	ID do valor do atributo

billingAddress_Base

Propriedades do Endereço de Faturação comuns a todos os pedidos e respostas.

Name	Caminho	Tipo	Description
first_name	first_name	string
last_name	last_name	string
Companhia	company	string
street_1	street_1	string	Endereço (primeira linha).
street_2	street_2	string	Endereço (segunda linha).
city	city	string
state	state	string
ZIP	zip	string	O endereço de faturação deve incluir o código postal. O CEP deve ter dois ou mais caracteres.
country	country	string
country_iso2	country_iso2	string	Código ISO Alpha-2 de 2 letras para o país.
phone	phone	string	Número de telefone do destinatário.
e-mail	email	string	Endereço de e-mail do destinatário.

billingAddress_Full

Necessário para criar um pedido.

Name	Caminho	Tipo	Description
billingAddress_Base	billingAddress	billingAddress_Base	Propriedades do Endereço de Faturação comuns a todos os pedidos e respostas.
form_fields	form_fields	array of formFields

bulkPricingRule_Full

Propriedades comuns da regra de preços em massa

Name	Caminho	Tipo	Description
id	id	integer	ID exclusivo da regra de preços em massa. Somente leitura.
quantity_min	quantity_min	integer	A quantidade mínima global de um produto para satisfazer esta regra. Deve ser maior ou igual a zero. Obrigatório em /POST.
quantity_max	quantity_max	integer	A quantidade máxima global de um produto para satisfazer esta regra. Deve ser maior que o quantity_min valor – a menos que este campo tenha um valor de 0 (zero), caso em que não haverá limite máximo para esta regra. Obrigatório em /POST.
tipo	type	string	O tipo de ajuste que é feito. Valores: price - o valor do ajustamento por produto; percent - o ajustamento em percentagem do preço original; fixed - o preço absoluto ajustado do produto. Obrigatório em /POST.
Montante	amount	integer	O desconto pode ser um valor fixo em dólar ou uma porcentagem. Para um valor fixo em dólares, insira-o como um inteiro e a resposta retornará como um inteiro. Para porcentagem, insira o valor como a porcentagem dividida por 100 usando o formato de cadeia de caracteres. Por exemplo, 10% por cento seria ".10". A resposta retornará como um inteiro. Obrigatório em /POST.

config_Full

Os valores para configuração de opção podem variar com base no modificador criado.

Name	Caminho	Tipo	Description
default_value	default_value	string	(data, texto, multi_line_text numbers_only_text) O valor padrão. Mostrado em uma opção de data como uma cadeia de caracteres formatada em ISO-8601 ou em uma opção de texto como uma cadeia de caracteres.
checked_by_default	checked_by_default	boolean	(caixa de verificação) Sinalizador para definir a caixa de seleção a ser marcada por padrão.
checkbox_label	checkbox_label	string	(caixa de verificação) Rótulo exibido para a opção de caixa de seleção.
date_limited	date_limited	boolean	(data) Sinalizador para limitar as datas permitidas para serem inseridas em uma opção de data.
date_limit_mode	date_limit_mode	string	(data) O tipo de limite que pode ser inserido em uma opção de data.
date_earliest_value	date_earliest_value	date	(data) A data mais antiga permitida pode ser inserida na opção de data, como uma cadeia de caracteres formatada ISO-8601.
date_latest_value	date_latest_value	date	(data) A última data permitida pode ser inserida na opção de data, como uma cadeia de caracteres formatada ISO-8601.
file_types_mode	file_types_mode	string	(ficheiro) O tipo de restrição sobre os tipos de arquivo que podem ser carregados com uma opção de upload de arquivo. Valores: specific - restringe uploads a tipos de arquivos específicos; all - permite todos os tipos de arquivos.
file_types_supported	file_types_supported	array of string	(ficheiro) O tipo de arquivos que podem ser carregados se o file_type_option estiver definido como specific. Valores: images - Permite o upload de tipos MIME de imagem (bmp, gif, jpg, jpeg, jpe, jif, jfif, jfi, pngwbmpxbmtiff). documents- Permite o upload de tipos MIME de documentos (txt, pdf, rtf, doc, docx, xls, accdbppsodgodsodfodpodtpubpptonepptxxlsxmdbppsx). other - Permite tipos de arquivos definidos na file_types_other matriz.
file_types_other	file_types_other	array of string	(ficheiro) Uma lista de outros tipos de arquivo permitidos com a opção de upload de arquivo.
file_max_size	file_max_size	integer	(ficheiro) O tamanho máximo de um arquivo que pode ser usado com a opção de upload de arquivo. Isso ainda será limitado pelo servidor.
text_characters_limited	text_characters_limited	boolean	(texto, multi_line_text) Sinalizador para validar o comprimento de um texto ou entrada de texto com várias linhas.
text_min_length	text_min_length	integer	(texto, multi_line_text) O comprimento mínimo permitido para uma opção de texto ou texto com várias linhas.
text_max_length	text_max_length	integer	(texto, multi_line_text) O comprimento máximo permitido para uma opção de texto ou texto de várias linhas.
text_lines_limited	text_lines_limited	boolean	(multi_line_text) Sinalizador para validar o número máximo de linhas permitido em uma entrada de texto com várias linhas.
text_max_lines	text_max_lines	integer	(multi_line_text) O número máximo de linhas permitido em uma entrada de texto com várias linhas.
number_limited	number_limited	boolean	(numbers_only_text) Sinalizador para limitar o valor de uma opção de número.
number_limit_mode	number_limit_mode	string	(numbers_only_text) O tipo de limite de valores inseridos para uma opção de número.
number_lowest_value	number_lowest_value	double	(numbers_only_text) O menor valor permitido para uma opção de número se number_limited for true.
number_highest_value	number_highest_value	double	(numbers_only_text) O valor mais alto permitido para uma opção de número, se number_limited for true.
number_integers_only	number_integers_only	boolean	(numbers_only_text) Sinalizador para limitar a entrada em uma opção de número apenas a números inteiros.
product_list_adjusts_inventory	product_list_adjusts_inventory	boolean	(product_list, product_list_with_images) Sinalizador para ajustar automaticamente o inventário de um produto incluído na lista.
product_list_adjusts_pricing	product_list_adjusts_pricing	boolean	(product_list, product_list_with_images) Sinalizar para adicionar o preço do produto opcional ao preço do produto principal.
product_list_shipping_calc	product_list_shipping_calc	string	(product_list, product_list_with_images) Como considerar o peso do produto opcional e as dimensões da embalagem na cotação de envio. Valores: none - não ajustar; weight - usar apenas peso de envio; package - usar peso e dimensões.

coupons_Resource

Name	Caminho	Tipo	Description
URL	url	string	URL dos cupons para solicitações de api
recurso	resource	string	recurso dos cupões

customer_Full

Name	Caminho	Tipo	Description
e-mail	email	string	O e-mail do cliente. Deve ser único.
first_name	first_name	string	O nome próprio do cliente.
last_name	last_name	string	O apelido do cliente.
Companhia	company	string	A empresa do cliente.
phone	phone	string	O número de telefone do cliente.
registration_ip_address	registration_ip_address	string	O endereço IP a partir do qual este cliente foi registado.
Observações	notes	string	O cliente observa.
tax_exempt_category	tax_exempt_category	string	O código da categoria isenta de impostos para o cliente.
customer_group_id	customer_group_id	integer	ID do grupo ao qual este cliente pertence.
id	id	integer	O ID numérico exclusivo do cliente.
date_modified	date_modified	date-time	A data em que o cliente foi modificado.
date_created	date_created	date-time	A data em que o cliente foi criado.
address_count	address_count	integer	Número total de endereços de clientes.
attribute_count	attribute_count	integer	Número total de atributos do cliente.
force_password_reset	authentication.force_password_reset	boolean	Se true, este cliente será forçado a alterar a senha no próximo login.
addresses	addresses	array of address_Full	Matriz de endereços de clientes. Limitado a 10.
attributes	attributes	array of attribute_Full	Matriz de atributos do cliente. Limitado a 10.
store_credit_amounts	store_credit_amounts	CustomerStoredCreditAmounts	Crédito da loja.
accepts_product_review_abandoned_cart_emails	accepts_product_review_abandoned_cart_emails	boolean	Ele determina se o cliente está inscrito para receber e-mails de revisão de produto ou carrinho abandonado ou receber ambos os e-mails.
customerChannelIds	channel_ids	customerChannelIds	Matriz de ids de canal aos quais o Cliente tem acesso.

CustomerCollectionResponse

Name	Caminho	Tipo	Description
dados	data	array of customer_Full

customerChannelIds

Matriz de ids de canal aos quais o Cliente tem acesso.

Name	Caminho	Tipo	Description
Itens		integer

CustomerStoredCreditAmounts

Crédito da loja.

Name	Caminho	Tipo	Description
Montante	amount	float

customUrl_Full

O URL personalizado para o produto na vitrine.

Name	Caminho	Tipo	Description
URL	url	string	URL do produto na montra.
is_customized	is_customized	boolean	Retorna true se a URL foi alterada de seu estado padrão (a URL atribuída automaticamente que o BigCommerce fornece).

formFields

Somente leitura. Se você tiver campos de formulário de endereço obrigatórios, eles precisarão ser definidos como opcionais antes de criar um pedido via API.

Name	Caminho	Tipo	Description
nome	name	string	Somente leitura. Se você tiver campos de formulário de endereço obrigatórios, eles precisarão ser definidos como opcionais antes de criar um pedido via API.
valor	value	string	Somente leitura. Se você tiver campos de formulário de endereço obrigatórios, eles precisarão ser definidos como opcionais antes de criar um pedido via API.

Links

Links de paginação para as partes anterior e seguinte de toda a coleção.

Name	Caminho	Tipo	Description
anterior	previous	string	Link para a página anterior retornado na resposta.
atual	current	string	Link para a página atual retornada na resposta.
next	next	string	Link para a próxima página retornada na resposta.

metaCollection_Full

Dados sobre a resposta, incluindo paginação e totais de coleta.

Name	Caminho	Tipo	Description
pagination_Full	pagination	pagination_Full	Dados sobre a resposta, incluindo paginação e totais de coleta.

order_Resp

Objeto de ordem retornado em respostas.

Name	Caminho	Tipo	Description
id	id	integer	Somente leitura. O ID do pedido.
date_modified	date_modified	string	Um valor somente leitura que representa a última modificação da ordem. Não tente modificar ou definir esse valor em uma operação POST ou PUT. RFC-2822
date_shipped	date_shipped	string	Um valor somente leitura que representa a data de envio. Não tente modificar ou definir esse valor em uma operação POST ou PUT. RFC-2822
cart_id	cart_id	string	O ID do carrinho do qual esta encomenda teve origem, se aplicável. Correlaciona-se com a API do carrinho. Este é um campo READ-ONLY; não defina ou modifique seu valor em uma solicitação POST ou PUT.
estado	status	string	O status incluirá um dos (string, optiona) - valores definidos em Status do pedido. Esse valor é somente leitura. Não tente modificar ou definir esse valor em uma operação POST ou PUT.
subtotal_tax	subtotal_tax	string	Um valor somente leitura. Não tente definir ou modificar esse valor em uma operação POST ou PUT. (Float, Float-As-String, Inteiro)
shipping_cost_tax	shipping_cost_tax	string	Um valor somente leitura. Não tente modificar ou definir esse valor em uma operação POST ou PUT. (Float, Float-As-String, Inteiro)
shipping_cost_tax_class_id	shipping_cost_tax_class_id	integer	Classe de imposto de custo de envio. Um valor somente leitura. Não tente modificar ou definir esse valor em uma operação POST ou PUT. (NOTA: Valor ignorado se o imposto automático estiver habilitado na loja.)
handling_cost_tax	handling_cost_tax	string	Um valor somente leitura. Não tente modificar ou definir esse valor em uma operação POST ou PUT. (Float, Float-As-String, Inteiro)
handling_cost_tax_class_id	handling_cost_tax_class_id	integer	Um valor somente leitura. Não tente definir ou modificar esse valor em uma operação POST ou PUT. (NOTA: Valor ignorado se o imposto automático estiver habilitado na loja.)
wrapping_cost_tax	wrapping_cost_tax	string	Um valor somente leitura. Não tente modificar ou definir esse valor em uma operação POST ou PUT. (Float, Float-As-String, Inteiro)
wrapping_cost_tax_class_id	wrapping_cost_tax_class_id	integer	Um valor somente leitura. Não tente definir ou modificar esse valor em uma operação POST ou PUT. (NOTA: Valor ignorado se o imposto automático estiver habilitado na loja.)
PagamentoStatus	payment_status	PaymentStatus	Um valor somente leitura. Não tente definir ou modificar esse valor em uma operação POST ou PUT.
store_credit_amount	store_credit_amount	string	Representa o crédito da loja que o comprador resgatou neste pedido individual. Este é um valor somente leitura. Não passe em um POST ou PUT. (Float, Float-As-String, Inteiro)
gift_certificate_amount	gift_certificate_amount	string	Um valor somente leitura. Não passe em um POST ou PUT. (Float, Float-As-String, Inteiro)
currency_id	currency_id	integer	O ID da moeda de exibição. Pode ser diferente da moeda transacional. Um valor somente leitura. Não passe em um POST ou PUT.
currency_code	currency_code	string	O código de moeda da moeda de exibição usada para apresentar os preços na vitrine. Um valor somente leitura. Não passe em um POST ou PUT.
currency_exchange_rate	currency_exchange_rate	string	A taxa de câmbio entre a moeda padrão da loja e a moeda de exibição. Um valor somente leitura. Não passe em um POST ou PUT. (Float, Float-As-String, Inteiro)
default_currency_id	default_currency_id	integer	O ID da moeda transacional. Um valor somente leitura. Não passe em um POST ou PUT.
coupon_discount	coupon_discount	string	Um valor somente leitura. Não passe em um POST ou PUT. (Float, Float-As-String, Inteiro)
shipping_address_count	shipping_address_count	double	O número de endereços de envio associados a esta transação. Um valor somente leitura. Não passe em um POST ou PUT.
is_email_opt_in	is_email_opt_in	boolean	Indica se o comprador selecionou uma caixa de seleção de aceitação (na página de checkout) para receber e-mails. Um valor somente leitura. Não passe em um POST ou PUT.
order_source	order_source	string	As encomendas submetidas através do site da loja incluirão um www valor. As encomendas submetidas através da API serão definidas como external. Um valor somente leitura. Não passe em um POST ou PUT.
products_Resource	products	products_Resource
shippingAddress_Resource	shipping_addresses	shippingAddress_Resource
coupons_Resource	coupons	coupons_Resource
status_id	status_id	integer	O staus ID da ordem.
base_handling_cost	base_handling_cost	string	O valor do custo de manuseamento de base. (Float, Float-As-String, Inteiro)
base_shipping_cost	base_shipping_cost	string	O valor do custo de envio base. (Float, Float-As-String, Inteiro)
base_wrapping_cost	base_wrapping_cost	string	O valor do custo de embrulho de base. (Float, Float-As-String, Inteiro)
billingAddress_Full	billing_address	billingAddress_Full	Necessário para criar um pedido.
channel_id	channel_id	integer	Mostra a origem do pedido. O padrão channel_id será 1.
customer_id	customer_id	double
customer_message	customer_message	string	Mensagem que o cliente inseriu (número, opcional) -o caixa durante o Order Comments checkout.
date_created	date_created	string	A data em que esta ordem foi criada. Se não for especificado, o padrão será a hora atual. A data deve estar no formato RFC 2822.
default_currency_code	default_currency_code	string	O código da moeda transacional que o comprador paga; gravável quando a multimoeda está ativada.
discount_amount	discount_amount	string	Valor do desconto para esta transação. (Float, Float-As-String, Inteiro)
ebay_order_id	ebay_order_id	string	Se a encomenda tiver sido feita através do eBay, o número da encomenda do eBay será incluído. Caso contrário, o valor será 0.
external_id	external_id	string	ID do pedido em outro sistema. Por exemplo, o ID do pedido da Amazon se este for um pedido da Amazon. Este campo pode ser atualizado em um /POST, mas usar um /PUT para atualizar o pedido retornará um erro 400. O campo «external_id» não pode ser escrito. Por favor, remova-o do seu pedido antes de tentar novamente. Ele não pode ser substituído uma vez definido.
external_source	external_source	string	Para pedidos enviados ou modificados através da API, usando uma operação PUT ou POST, você pode, opcionalmente, passar um valor que identifique o sistema usado para gerar o pedido. Por exemplo: POS. Caso contrário, o valor será nulo.
geoip_country	geoip_country	string	O nome completo do país onde o cliente fez a compra, com base no IP.
geoip_country_iso2	geoip_country_iso2	string	O país onde o cliente fez a compra, em formato ISO2, com base no IP.
handling_cost_ex_tax	handling_cost_ex_tax	string	O valor do custo de manuseamento, excluindo impostos. (Float, Float-As-String, Inteiro)
handling_cost_inc_tax	handling_cost_inc_tax	string	O valor do custo de manuseamento, incluindo impostos. (Float, Float-As-String, Inteiro)
ip_address	ip_address	string	Endereço IP do cliente, se conhecido.
is_deleted	is_deleted	boolean	Indica se o pedido foi excluído (arquivado). Defina como true, para arquivar uma ordem.
items_shipped	items_shipped	double	O número de itens que foram enviados.
items_total	items_total	double	O número total de itens na ordem.
order_is_digital	order_is_digital	boolean	Se este é um pedido de produtos digitais.
Método de Pagamento	payment_method	PaymentMethod	O método de pagamento para esta encomenda. Pode ser um dos seguintes: Manual, Credit Card, , cash, Test Payment Gatewayetc.
payment_provider_id	payment_provider_id	string	O ID de transação/ID de pagamento externo dentro do provedor de pagamento desta ordem (se um provedor de pagamento foi usado).
refunded_amount	refunded_amount	string	O valor reembolsado desta transação. (Float, Float-As-String, Inteiro)
shipping_cost_ex_tax	shipping_cost_ex_tax	string	O valor do custo de envio, excluindo impostos. (Float, Float-As-String, Inteiro)
shipping_cost_inc_tax	shipping_cost_inc_tax	string	O valor do custo de envio, incluindo impostos. (Float, Float-As-String, Inteiro)
staff_notes	staff_notes	string	Quaisquer notas adicionais para o pessoal.
subtotal_ex_tax	subtotal_ex_tax	string	Valor de substituição para o subtotal excluindo impostos. Se especificado, o campo subtotal_inc_tax também é obrigatório. (Float, Float-As-String, Inteiro)
subtotal_inc_tax	subtotal_inc_tax	string	Valor de substituição para o subtotal, incluindo impostos. Se especificado, o campo subtotal_ex_tax também é obrigatório. (Float, Float-As-String, Inteiro)
TaxProviderId	tax_provider_id	TaxProviderId	BasicTaxProvider - O imposto é definido como manual. AvaTaxProvider - Isso é para quando o provedor de impostos foi definido como automático e o pedido NÃO foi criado pela API. Usado para Avalara. "" (em branco) - Quando o provedor fiscal é desconhecido. Isso inclui pedidos legados e pedidos criados anteriormente via API. Isso pode ser definido ao criar um pedido usando um POST.
customer_locale	customer_locale	string	A localidade do cliente
total_ex_tax	total_ex_tax	string	Valor de substituição para o total, excluindo impostos. Se especificado, o campo total_inc_tax também é obrigatório. (Float, Float-As-String, Inteiro)
total_inc_tax	total_inc_tax	string	Valor de substituição para o total, incluindo impostos. Se especificado, o campo total_ex_tax também é obrigatório. (Float, Float-As-String, Inteiro)
wrapping_cost_ex_tax	wrapping_cost_ex_tax	string	O valor do custo de acondicionamento, excluindo impostos. (Float, Float-As-String, Inteiro)
wrapping_cost_inc_tax	wrapping_cost_inc_tax	string	O valor do custo de embrulho, incluindo impostos. (Float, Float-As-String, Inteiro)

orderCollection_Resp

Lista de pedidos retornados em respostas.

Name	Caminho	Tipo	Description
order_Resp		order_Resp	Objeto de ordem retornado em respostas.

orderProduct_Resp

Encomende o produto devolvido em respostas.

Name	Caminho	Tipo	Description
id	id	integer	ID numérico deste produto dentro desta ordem.
order_id	order_id	integer	ID numérico da ordem associada.
product_id	product_id	integer	ID numérico do produto.
order_address_id	order_address_id	integer	ID numérico do endereço de ordem associado.
nome	name	string	Alias for name_customer - O nome do produto que é mostrado ao cliente na vitrine.
sku	sku	string	Código do produto/unidade de manutenção de estoque (SKU) definido pelo usuário.
tipo	type	string	Tipo de produto.
base_price	base_price	string	O preço base do produto. (Float, Float-As-String, Inteiro).
price_ex_tax	price_ex_tax	string	O preço do produto sem impostos. (Float, Float-As-String, Inteiro).
price_inc_tax	price_inc_tax	string	O preço do produto, incluindo impostos. (Float, Float-As-String, Inteiro).
price_tax	price_tax	string	Valor do imposto aplicado a um único produto. O imposto sobre o preço é calculado como: 'price_tax = price_inc_tax - price_ex_tax' (Float, Float-As-String, Integer).
base_total	base_total	string	Preço base total. (Float, Float-As-String, Inteiro).
total_ex_tax	total_ex_tax	string	Preço base total sem impostos. (Float, Float-As-String, Inteiro).
total_inc_tax	total_inc_tax	string	Preço base total incluindo impostos. (Float, Float-As-String, Inteiro).
total_tax	total_tax	string	Total do imposto aplicado aos produtos. Por exemplo, se a quantidade for 2, o preço base for 5 e a taxa de imposto for 10%. price_tax será de $.50 e total_tax será de $1.00. Se houver um desconto manual aplicado, total_tax é dimensionado da seguinte forma: '(price_ex_tax - desconto)*tax_rate=total_tax' (Float, Float-As-String, Integer).
quantidade	quantity	number	Quantidade do produto encomendado.
base_cost_price	base_cost_price	string	O preço de custo do produto. Isso pode ser definido usando a API de catálogo. (Float, Float-As-String, Inteiro) Somente leitura.
cost_price_inc_tax	cost_price_inc_tax	string	O preço de custo do produto, incluindo impostos. (Float, Float-As-String, Inteiro) O custo dos seus produtos para si; Isso nunca é mostrado aos clientes, mas pode ser usado para fins contábeis. Somente leitura.
cost_price_ex_tax	cost_price_ex_tax	string	Os produtos custam preço sem impostos. (Float, Float-As-String, Inteiro) O custo dos seus produtos para si; Isso nunca é mostrado aos clientes, mas pode ser usado para fins contábeis. Somente leitura.
weight	weight	string	Peso do produto. (Float, Float-As-String, Inteiro).
cost_price_tax	cost_price_tax	string	Imposto aplicado ao preço de custo do produto. (Float, Float-As-String, Inteiro) O custo dos seus produtos para si; Isso nunca é mostrado aos clientes, mas pode ser usado para fins contábeis. Somente leitura.
is_refunded	is_refunded	boolean	Se o produto foi reembolsado.
refunded_amount	refunded_amount	string	O valor reembolsado desta transação. (Float, Float-As-String, Inteiro).
return_id	return_id	number	ID numérico para o reembolso.
wrapping_name	wrapping_name	string	Nome da opção de embrulho de presente.
base_wrapping_cost	base_wrapping_cost	string	O valor do custo de embrulho de base. (Float, Float-As-String, Inteiro).
wrapping_cost_ex_tax	wrapping_cost_ex_tax	string	O valor do custo de acondicionamento, excluindo impostos. (Float, Float-As-String, Inteiro).
wrapping_cost_inc_tax	wrapping_cost_inc_tax	string	O valor do custo de embrulho, incluindo impostos. (Float, Float-As-String, Inteiro).
wrapping_cost_tax	wrapping_cost_tax	string	Imposto aplicado à opção de embrulho de presentes. (Float, Float-As-String, Inteiro).
wrapping_message	wrapping_message	string	Mensagem para acompanhar a opção de embrulho de presente.
quantity_shipped	quantity_shipped	number	Quantidade deste item enviado.
event_name	event_name	string	Nome do evento promocional/data de entrega.
event_date	event_date	date	Data do evento promocional/entrega programada.
fixed_shipping_cost	fixed_shipping_cost	string	Custo de envio fixo para este produto. (Float, Float-As-String, Inteiro).
ebay_item_id	ebay_item_id	string	ID do item para este produto no eBay.
ebay_transaction_id	ebay_transaction_id	string	ID de transação para este produto no eBay.
option_set_id	option_set_id	integer	ID numérico do conjunto de opções aplicado ao produto.
parent_order_product_id	parent_order_product_id	integer	ID de um produto pai.
is_bundled_product	is_bundled_product	boolean	Se este produto está incluído em conjunto com outros produtos.
bin_picking_number	bin_picking_number	string	Número de coleta de lixo para o produto físico.
applied_discounts	applied_discounts	array of object	Matriz de objetos contendo descontos aplicados ao produto.
id	applied_discounts.id	string	Nome do cupão aplicado à encomenda.
Montante	applied_discounts.amount	string	Valor do desconto. (Float, Float-As-String, Inteiro).
nome	applied_discounts.name	string	Nome do cupão. Manual Discount ao criar um desconto manual.
código	applied_discounts.code	string	Código do cupom. Não há código ao criar um desconto manual.
destino	applied_discounts.target	string	Determina se o desconto se o desconto foi aplicado no nível do pedido ou do produto. Somente leitura.
product_options	product_options	array of object	Matriz de objetos de opção de produto.
id	product_options.id	integer	O ID numérico único da opção; incrementos sequenciais.
option_id	product_options.option_id	integer	ID numérico da opção associada.
order_product_id	product_options.order_product_id	integer	Id do produto para encomenda.
product_option_id	product_options.product_option_id	integer	Id da opção do produto.
display_name	product_options.display_name	string	Alias para display_name_customer. O nome da opção de produto que é mostrado ao cliente na vitrine.
display_value	product_options.display_value	string	Alias para display_value_customer. O valor da opção do produto que é mostrado ao cliente na vitrine.
valor	product_options.value	string	Esse valor é usado para acessar o Carregamento de Arquivo do Cliente.
tipo	product_options.type	string	Tipo de opção.
nome	product_options.name	string	O nome da opção, conforme usado internamente. Deve ser único.
display_style	product_options.display_style	string	Como é exibido na vitrine. Os exemplos incluem lista suspensa, botões de opção ou retângulos.
display_name_customer	product_options.display_name_customer	string	O nome da opção do produto que é mostrado ao cliente na vitrine.
display_name_merchant	product_options.display_name_merchant	string	O nome da opção do produto que é mostrado ao comerciante no Painel de Controlo.
display_value_customer	product_options.display_value_customer	string	O valor da opção do produto que é mostrado ao cliente na vitrine.
display_value_merchant	product_options.display_value_merchant	string	O valor da opção do produto que é mostrado ao comerciante no Painel de Controlo.
external_id	external_id	string	ID do pedido em outro sistema. Por exemplo, o ID do pedido da Amazon se este for um pedido da Amazon. Este campo pode ser atualizado em um /POST, mas usar um /PUT para atualizar o pedido retornará um erro 400. O campo «external_id» não pode ser escrito. Por favor, remova-o do seu pedido antes de tentar novamente. Ele não pode ser substituído uma vez definido.
UPC	upc	string	Código Universal do Produto. Pode ser escrito para produtos personalizados e produtos de catálogo.
variant_id	variant_id	integer	Produtos variant_id. COLOCAR ou POSTAR. Este campo não está disponível para produtos personalizados.
name_customer	name_customer	string	O nome do produto que é mostrado ao cliente na vitrine.
name_merchant	name_merchant	string	O nome do produto que é mostrado ao comerciante no Painel de Controlo.

orderProductsCollection_Resp

Encomende produtos devolvidos em respostas.

Name	Caminho	Tipo	Description
orderProduct_Resp		orderProduct_Resp	Encomende o produto devolvido em respostas.

orderShippingAddress_Resp

Endereço de envio da encomenda devolvido em resposta.

Name	Caminho	Tipo	Description
id	id	integer	ID deste endereço de envio.
order_id	order_id	integer	ID da encomenda.
items_total	items_total	number	O número total de itens na ordem.
items_shipped	items_shipped	number	O número de itens que foram enviados.
base_cost	base_cost	string	O valor base dos itens do pedido. (Float, Float-As-String, Inteiro).
cost_ex_tax	cost_ex_tax	string	O valor dos itens do pedido, excluindo impostos. (Float, Float-As-String, Inteiro).
cost_inc_tax	cost_inc_tax	string	O valor dos itens do pedido, incluindo impostos. (Float, Float-As-String, Inteiro).
cost_tax	cost_tax	string	O valor do imposto sobre a ordem. (Float, Float-As-String, Inteiro).
cost_tax_class_id	cost_tax_class_id	integer	A ID da classe de imposto aplicada ao produto. (NOTA: Valor ignorado se o imposto automático estiver ativado).
handling_cost_ex_tax	handling_cost_ex_tax	string	A taxa de manuseamento, excluindo impostos. (Float, Float-As-String, Inteiro).
handling_cost_inc_tax	handling_cost_inc_tax	string	A taxa de manuseamento, incluindo impostos. (Float, Float-As-String, Inteiro).
handling_cost_tax	handling_cost_tax	string
handling_cost_tax_class_id	handling_cost_tax_class_id	integer	Um valor somente leitura. Não tente definir ou modificar esse valor em uma operação POST ou PUT. (NOTA: Valor ignorado se o imposto automático estiver ativado na loja).
shipping_zone_id	shipping_zone_id	number	ID numérico da zona de envio.
shipping_zone_name	shipping_zone_name	string	Nome da zona de expedição.
form_fields	form_fields	array of formFields
shippingQuotes_Resource	shipping_quotes	shippingQuotes_Resource
shippingAddress_Base	shipping_addresses	shippingAddress_Base	Propriedades do endereço de envio comuns a todas as solicitações e respostas.

orderShippingAddressCollection_Resp

Endereços de envio de pedidos devolvidos em resposta.

Name	Caminho	Tipo	Description
orderShippingAddress_Resp		orderShippingAddress_Resp	Endereço de envio da encomenda devolvido em resposta.

pagination_Full

Dados sobre a resposta, incluindo paginação e totais de coleta.

Name	Caminho	Tipo	Description
total	total	integer	Número total de itens no conjunto de resultados.
count	count	integer	Número total de itens na resposta da coleção.
per_page	per_page	integer	A quantidade de itens retornados na coleção por página, controlada pelo parâmetro limit.
current_page	current_page	integer	A página em que você está atualmente dentro da coleção.
total_pages	total_pages	integer	O número total de páginas na coleção.
Links	links	Links	Links de paginação para as partes anterior e seguinte de toda a coleção.

product_Base

Name	Caminho	Tipo	Description
nome	name	string	O nome do produto.
tipo	type	string	O tipo de produto. Um dos: physical - uma unidade de estoque físico, digital - um download digital.
sku	sku	string	Código do produto/unidade de manutenção de estoque (SKU) definido pelo usuário.
descrição	description	string	A descrição do produto, que pode incluir formatação HTML.
weight	weight	double	Peso do produto, que pode ser usado no cálculo dos custos de envio. Isto é baseado na unidade definida na loja
Largura	width	double	Largura do produto, que pode ser usada para calcular os custos de envio.
profundidade	depth	double	Profundidade do produto, que pode ser usada no cálculo dos custos de envio.
altura	height	double	Altura do produto, que pode ser usada no cálculo dos custos de envio.
Preço	price	double	O preço do produto. O preço deve incluir ou excluir impostos, com base nas configurações da loja.
cost_price	cost_price	double	O preço de custo do produto. Armazenado apenas para referência; Ele não é usado ou exibido em qualquer lugar da loja.
retail_price	retail_price	double	O custo de varejo do produto. Se inserido, o preço de custo de varejo será mostrado na página do produto.
sale_price	sale_price	double	Se inserido, o preço de venda será usado em vez do valor no campo preço ao calcular o custo do produto.
map_price	map_price	double	Preço Mínimo Anunciado
tax_class_id	tax_class_id	integer	A ID da classe de imposto aplicada ao produto. (NOTA: Valor ignorado se o imposto automático estiver habilitado.)
product_tax_code	product_tax_code	string	Aceita os Códigos Fiscais do Sistema AvaTax, que identificam produtos e serviços que se enquadram em categorias especiais de imposto sobre vendas. Ao usar esses códigos, os comerciantes que assinam a integração Avalara Premium do BigCommerce podem calcular os impostos sobre vendas com mais precisão. As lojas sem Avalara Premium ignorarão o código ao calcular o imposto sobre vendas. Não passe mais do que um código. Os códigos diferenciam maiúsculas de minúsculas. Para mais detalhes, consulte a documentação de Avalara.
categories	categories	array of integer	Uma matriz de IDs para as categorias às quais este produto pertence. Ao atualizar um produto, se uma matriz de categorias for fornecida, todas as categorias de produtos serão substituídas. Não aceita mais de 1.000 valores de ID.
brand_id	brand_id	integer	Um produto pode ser adicionado a uma marca existente durante um produto /PUT ou /POST.
inventory_level	inventory_level	integer	Nível de estoque atual do produto. O rastreamento de inventário simples deve ser ativado (Consulte o inventory_tracking campo) para que isso tenha algum efeito.
inventory_warning_level	inventory_warning_level	integer	Nível de aviso de inventário para o produto. Quando o nível de estoque do produto cair abaixo do nível de alerta, o proprietário da loja será informado. O rastreamento de inventário simples deve ser ativado (consulte o inventory_tracking campo) para que isso tenha algum efeito.
inventory_tracking	inventory_tracking	string	O tipo de rastreamento de estoque para o produto. Os valores são: none - os níveis de estoque não serão rastreados; product - os níveis de estoque serão rastreados usando os inventory_level campos variant e inventory_warning_level ;- os níveis de estoque serão rastreados com base em variantes, que mantêm seus próprios níveis de alerta e níveis de estoque.
fixed_cost_shipping_price	fixed_cost_shipping_price	double	Um custo de envio fixo para o produto. Se definido, este valor será usado durante o checkout em vez do cálculo normal do custo de envio.
is_free_shipping	is_free_shipping	boolean	Bandeira usada para indicar se o produto tem frete grátis. Se true, o custo de envio para o produto será zero.
is_visible	is_visible	boolean	Sinalizar para determinar se o produto deve ser exibido para os clientes que navegam na loja. Se true, o produto será exibido. Se false, o produto ficará oculto da vista.
is_featured	is_featured	boolean	Sinalizar para determinar se o produto deve ser incluído no featured products painel ao visualizar a loja.
related_products	related_products	array of integer	Uma matriz de IDs para os produtos relacionados.
garantia	warranty	string	Informações de garantia exibidas na página do produto. Pode incluir formatação HTML.
bin_picking_number	bin_picking_number	string	O número de separação BIN para o produto.
layout_file	layout_file	string	O arquivo de modelo de layout usado para renderizar esta categoria de produto. Este campo é gravável apenas para lojas com um tema Blueprint aplicado.
UPC	upc	string	O código UPC do produto, que é usado em feeds para sites de comparação de compras e integrações de canais externos.
search_keywords	search_keywords	string	Uma lista separada por vírgulas de palavras-chave que podem ser usadas para localizar o produto ao pesquisar na loja.
disponibilidade	availability	string	Disponibilidade do produto. As opções de disponibilidade são: available - o produto pode ser comprado na vitrine disabled ;- o produto está listado na vitrine, mas não pode ser comprado; preorder - o produto está listado para pré-encomendas.
availability_description	availability_description	string	Texto de disponibilidade exibido na página de checkout, sob o título do produto. Informa o cliente quanto tempo normalmente levará para enviar este produto, como: "Normalmente envia em 24 horas."
gift_wrapping_options_type	gift_wrapping_options_type	string	Tipo de opções de embrulho para presentes. Valores: any - permitir quaisquer opções de embrulho de presente na loja; none - não permitir embrulho de presente no produto; list - fornecer uma lista de IDs no gift_wrapping_options_list campo.
gift_wrapping_options_list	gift_wrapping_options_list	array of integer	Uma lista de IDs de opção de embrulho de presente.
sort_order	sort_order	integer	Prioridade para dar este produto quando incluído em listas de produtos em páginas de categorias e nos resultados de pesquisa. Números inteiros mais baixos colocarão o produto mais perto do topo dos resultados.
condition	condition	string	A condição do produto. Será mostrado na página do produto se o valor do is_condition_shown campo for true. Valores possíveis: New, Used, Refurbished.
is_condition_shown	is_condition_shown	boolean	Sinalizador usado para determinar se a condição do produto é mostrada ao cliente na página do produto.
order_quantity_minimum	order_quantity_minimum	integer	A quantidade mínima que uma encomenda deve conter, para ser elegível para comprar este produto.
order_quantity_maximum	order_quantity_maximum	integer	A quantidade máxima que um pedido pode conter ao comprar o produto.
page_title	page_title	string	Título personalizado para a página do produto. Se não estiver definido, o nome do produto será usado como metatítulo.
meta_keywords	meta_keywords	array of string	Meta-palavras-chave personalizadas para a página do produto. Se não forem definidas, as palavras-chave padrão da loja serão usadas.
meta_description	meta_description	string	Meta descrição personalizada para a página do produto. Se não for definida, a meta descrição padrão da loja será usada.
view_count	view_count	integer	O número de vezes que o produto foi visualizado.
preorder_release_date	preorder_release_date	date-time	Data de lançamento da pré-encomenda. Consulte o availability campo para obter detalhes sobre como definir a disponibilidade de um produto para aceitar pré-encomendas.
preorder_message	preorder_message	string	Mensagem personalizada de data esperada para exibição na página do produto. Se indefinido, o padrão da mensagem é a configuração storewide. Pode conter o %%DATE%% espaço reservado, que será substituído pela data de lançamento.
is_preorder_only	is_preorder_only	boolean	Se definido como true, na data de lançamento da pré-encomenda, o status da pré-encomenda será removido automaticamente. Se definido como false, na data de lançamento o status da pré-encomenda não será removido. Ele precisará ser alterado manualmente no painel de controle ou usando a API. Usando a API definida availability como available.
is_price_hidden	is_price_hidden	boolean	False por padrão, indicando que o preço deste produto deve ser mostrado na página do produto. Se definido como true, o preço fica oculto. (NOTA: Para definir is_price_hidden com êxito como true, o availability valor deve ser disabled.)
price_hidden_label	price_hidden_label	string	Por padrão, uma cadeia de caracteres vazia. Se is_price_hidden for true, o valor de price_hidden_label é exibido em vez do preço. (NOTA: Para definir com êxito um valor de cadeia de caracteres não vazio com is_price_hidden definido como true, o availability valor deve ser disabled.)
customUrl_Full	custom_url	customUrl_Full	O URL personalizado para o produto na vitrine.
open_graph_type	open_graph_type	string	Tipo de produto, o padrão é product.
open_graph_title	open_graph_title	string	Título do produto, se não especificado o nome do produto será usado em vez disso.
open_graph_description	open_graph_description	string	Descrição a utilizar para o produto, se não for especificada, a meta_description será utilizada em vez disso.
open_graph_use_meta_description	open_graph_use_meta_description	boolean	Sinalizador para determinar se a descrição do produto ou a descrição do gráfico aberto é usada.
open_graph_use_product_name	open_graph_use_product_name	boolean	Sinalizador para determinar se o nome do produto ou o nome do gráfico aberto é usado.
open_graph_use_image	open_graph_use_image	boolean	Sinalizador para determinar se a imagem do produto ou a imagem do gráfico aberto é usada.
brand_name ou brand_id	brand_name or brand_id	string	A marca pode ser criada durante um pedido de produto PUT ou POST. Se a marca já existir, o produto será adicionado. Caso contrário, a marca será criada e o produto adicionado. Se usar brand_name , realiza uma combinação difusa e adiciona a marca. eg. "Bem comum" e "Bem comum" são a mesma coisa. O nome da marca não retorna como parte de uma resposta do produto. Apenas o brand_id.
GTIN	gtin	string	Número de item do comércio global
NMP	mpn	string	Número de peça do fabricante
reviews_rating_sum	reviews_rating_sum	integer	A classificação total do produto.
reviews_count	reviews_count	integer	O número de vezes que o produto foi classificado.
total_sold	total_sold	integer	A quantidade total deste produto vendido.
custom_fields	custom_fields	array of productCustomField_Put
bulk_pricing_rules	bulk_pricing_rules	array of bulkPricingRule_Full
images	images	array of productImage_Full
videos	videos	array of productVideo_Full

product_Full

Name	Caminho	Tipo	Description
product_Base	schema	product_Base
date_created	date_created	date-time	A data em que o produto foi criado.
date_modified	date_modified	date-time	A data em que o produto foi modificado.
id	id	integer	ID do produto. Somente leitura.
base_variant_id	base_variant_id	integer	O identificador único da variante de base associada a um produto simples. Este valor é null para produtos complexos.
calculated_price	calculated_price	double	O preço do produto como visto na vitrine. Será igual ao sale_price, se definido, e ao price se não houver um sale_price.
options	options	array of productOption_Base
modificadores	modifiers	array of productModifier_Full
option_set_id	option_set_id	integer	Indica que o produto está em um conjunto de opções (conceito V2 herdado).
option_set_display	option_set_display	string	Configuração de modelo herdado que controla se o conjunto de opções aparece ao lado ou abaixo da imagem e descrição do produto.
productVariant_Full	variants	productVariant_Full

ProductCollectionResponse

Name	Caminho	Tipo	Description
dados	data	array of product_Full
metaCollection_Full	meta	metaCollection_Full	Dados sobre a resposta, incluindo paginação e totais de coleta.

productCustomField_Put

Obtém campos personalizados associados a um produto. Eles permitem que você especifique informações adicionais que aparecerão na página do produto, como o ISBN de um livro ou a data de lançamento de um DVD.

Name	Caminho	Tipo	Description
id	id	integer	A ID numérica exclusiva do campo personalizado; incrementos sequenciais. Necessário para atualizar o campo personalizado existente na solicitação /PUT. Read-Only
nome	name	string	O nome do campo, mostrado na vitrine, pedidos, etc. Necessário para /POST
valor	value	string	O nome do campo, mostrado na vitrine, pedidos, etc. Necessário para /POST

productImage_Full

Propriedades comuns de ProductImage.

Name	Caminho	Tipo	Description
image_file	image_file	string	O caminho local para o arquivo de imagem original carregado no BigCommerce.
is_thumbnail	is_thumbnail	boolean	Sinalizador para identificar se a imagem é usada como miniatura do produto.
sort_order	sort_order	integer	A ordem em que a imagem será exibida na página do produto. Números inteiros mais altos dão à imagem uma prioridade menor. Ao atualizar, se for dada uma prioridade menor à imagem, todas as imagens com um sort_order valor igual ou superior ao novo sort_order valor da imagem terão o seu sort_orders reordenado.
descrição	description	string	A descrição da imagem.
image_url	image_url	string	Deve ser um caminho de URL totalmente qualificado, incluindo protocolo. Limite de 8MB por ficheiro.
id	id	integer	O ID numérico exclusivo da imagem; incrementos sequenciais.
product_id	product_id	integer	O identificador numérico exclusivo do produto ao qual a imagem está associada.
url_zoom	url_zoom	string	O URL de zoom para esta imagem. Por padrão, isso é usado como a imagem de zoom em páginas de produtos quando as imagens de zoom estão habilitadas.
url_standard	url_standard	string	O URL padrão para esta imagem. Por padrão, isso é usado para imagens de página de produto.
url_thumbnail	url_thumbnail	string	O URL da miniatura desta imagem. Por padrão, esse é o tamanho da imagem usado na página de categoria e nos painéis laterais.
url_tiny	url_tiny	string	O pequeno URL para esta imagem. Por padrão, esse é o tamanho da imagem usado para miniaturas abaixo da imagem do produto em uma página do produto.
date_modified	date_modified	date-time	A data em que a imagem do produto foi modificada.

productModifier_Base

Propriedades comuns do modificador.

Name	Caminho	Tipo	Description
tipo	type	string	API do BigCommerce, que determina como ele será exibido na vitrine. Valores aceitáveis: date, checkbox, file, text, multi_line_text, numbers_only_text, radio_buttons, rectangles, dropdownproduct_list_with_imagesproduct_listswatch. Obrigatório em um /POST.
required	required	boolean	Se este modificador é ou não necessário no checkout. Obrigatório em um /POST.
sort_order	sort_order	integer	A ordem que os modificadores exibem na página de detalhes do produto.
config_Full	config	config_Full	Os valores para configuração de opção podem variar com base no modificador criado.
display_name	display_name	string	O nome da opção mostrada na vitrine.

productModifier_Full

Modificador de produto

Name	Caminho	Tipo	Description
productModifier_Base	schema	productModifier_Base	Propriedades comuns do modificador.
id	id	integer	A ID numérica exclusiva do modificador; incrementos sequenciais.
product_id	product_id	integer	O ID numérico exclusivo do produto ao qual a opção pertence.
nome	name	string	O nome exclusivo da opção. Gerado automaticamente a partir do nome para exibição, um carimbo de data/hora e o ID do produto.
option_values	option_values	array of productModifierOptionValue_Full

productModifierOptionValue_Full

Produto Modifer option_value.

Name	Caminho	Tipo	Description
is_default	is_default	boolean	O sinalizador para pré-selecionar um valor como padrão na vitrine. Este campo não é suportado para opções/modificadores de amostras.
etiqueta	label	string	O texto é exibido identificando o valor na vitrine. Obrigatório em um /POST.
sort_order	sort_order	integer	A ordem em que o valor será exibido na página do produto. Obrigatório em um /POST.
value_data	value_data	object	Dados adicionais que descrevem o valor, com base no tipo de opção ou modificador ao qual o valor está associado. A swatch opção type pode aceitar uma matriz de , com até três chaves de cor hexidecimais, ou um image_url, que é um caminho de URL de colorsimagem completa, incluindo protocolo. A product list opção de tipo requer um product_idarquivo . A checkbox opção type requer um sinalizador booleano, chamado checked_value, para determinar qual valor é considerado o estado verificado. Se não houver dados disponíveis, retorna null.
adjusters_Full	adjusters	adjusters_Full
id	id	integer	A ID numérica exclusiva do valor; incrementos sequenciais.
option_id	option_id	integer

productOption_Base

Propriedades de opção comum.

Name	Caminho	Tipo	Description
id	id	integer	O ID numérico exclusivo da opção, incrementa sequencialmente.
product_id	product_id	integer	O ID numérico exclusivo do produto ao qual a opção pertence.
display_name	display_name	string	O nome da opção mostrada na vitrine.
tipo	type	string	O tipo de opção, que determina como ela será exibida na vitrine. Valores aceitáveis: radio_buttons, rectangles, dropdown, , product_listproduct_list_with_images, swatch. Para referência, os valores anteriores da API v2 são: RB = radio_buttons, RT = retângulos, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.
productOptionConfig_Full	config	productOptionConfig_Full	Os valores para configuração de opção podem variar com base no modificador criado.
sort_order	sort_order	integer	Ordem em que a opção é exibida na vitrine.
productOptionOptionValue_Full	option_values	productOptionOptionValue_Full	Opção do option_valueproduto .

productOptionConfig_Full

Os valores para configuração de opção podem variar com base no modificador criado.

Name	Caminho	Tipo	Description
default_value	default_value	string	(data, texto, multi_line_text numbers_only_text) O valor padrão. Mostrado em uma opção de data como uma cadeia de caracteres formatada em ISO-8601 ou em uma opção de texto como uma cadeia de caracteres.
checked_by_default	checked_by_default	boolean	(caixa de verificação) Sinalizador para definir a caixa de seleção a ser marcada por padrão.
checkbox_label	checkbox_label	string	(caixa de verificação) Rótulo exibido para a opção de caixa de seleção.
date_limited	date_limited	boolean	(data) Sinalizador para limitar as datas permitidas para serem inseridas em uma opção de data.
date_limit_mode	date_limit_mode	string	(data) O tipo de limite que pode ser inserido em uma opção de data.
date_earliest_value	date_earliest_value	date	(data) A data mais antiga permitida pode ser inserida na opção de data, como uma cadeia de caracteres formatada ISO-8601.
date_latest_value	date_latest_value	date	(data) A última data permitida pode ser inserida na opção de data, como uma cadeia de caracteres formatada ISO-8601.
file_types_mode	file_types_mode	string	(ficheiro) O tipo de restrição sobre os tipos de arquivo que podem ser carregados com uma opção de upload de arquivo. Valores: specific - restringe uploads a tipos de arquivos específicos; all - permite todos os tipos de arquivos.
file_types_supported	file_types_supported	array of string	(ficheiro) O tipo de arquivos que podem ser carregados se o file_type_option estiver definido como specific. Valores: images - Permite o upload de tipos MIME de imagem (bmp, gif, jpg, jpeg, jpe, jif, jfif, jfi, pngwbmpxbmtiff). documents- Permite o upload de tipos MIME de documentos (txt, pdf, rtf, doc, docx, xls, accdbppsodgodsodfodpodtpubpptonepptxxlsxmdbppsx). other - Permite tipos de arquivos definidos na file_types_other matriz.
file_types_other	file_types_other	array of string	(ficheiro) Uma lista de outros tipos de arquivo permitidos com a opção de upload de arquivo.
file_max_size	file_max_size	integer	(ficheiro) O tamanho máximo de um arquivo que pode ser usado com a opção de upload de arquivo. Isso ainda será limitado pelo servidor.
text_characters_limited	text_characters_limited	boolean	(texto, multi_line_text) Sinalizador para validar o comprimento de um texto ou entrada de texto com várias linhas.
text_min_length	text_min_length	integer	(texto, multi_line_text) O comprimento mínimo permitido para uma opção de texto ou texto com várias linhas.
text_max_length	text_max_length	integer	(texto, multi_line_text) O comprimento máximo permitido para uma opção de texto ou texto de várias linhas.
text_lines_limited	text_lines_limited	boolean	(multi_line_text) Sinalizador para validar o número máximo de linhas permitido em uma entrada de texto com várias linhas.
text_max_lines	text_max_lines	integer	(multi_line_text) O número máximo de linhas permitido em uma entrada de texto com várias linhas.
number_limited	number_limited	boolean	(numbers_only_text) Sinalizador para limitar o valor de uma opção de número.
number_limit_mode	number_limit_mode	string	(numbers_only_text) O tipo de limite de valores inseridos para uma opção de número.
number_lowest_value	number_lowest_value	double	(numbers_only_text) O menor valor permitido para uma opção de número se number_limited for true.
number_highest_value	number_highest_value	double	(numbers_only_text) O valor mais alto permitido para uma opção de número, se number_limited for true.
number_integers_only	number_integers_only	boolean	(numbers_only_text) Sinalizador para limitar a entrada em uma opção de número apenas a números inteiros.
product_list_adjusts_inventory	product_list_adjusts_inventory	boolean	(product_list, product_list_with_images) Sinalizador para ajustar automaticamente o inventário de um produto incluído na lista.
product_list_adjusts_pricing	product_list_adjusts_pricing	boolean	(product_list, product_list_with_images) Sinalizar para adicionar o preço do produto opcional ao preço do produto principal.
product_list_shipping_calc	product_list_shipping_calc	string	(product_list, product_list_with_images) Como considerar o peso do produto opcional e as dimensões da embalagem na cotação de envio. Valores: none - não ajustar; weight - usar apenas peso de envio; package - usar peso e dimensões.

productOptionOptionValue_Full

Opção do option_valueproduto .

Name	Caminho	Tipo	Description
is_default	is_default	boolean	O sinalizador para pré-selecionar um valor como padrão na vitrine. Este campo não é suportado para opções/modificadores de amostras.
etiqueta	label	string	O texto é exibido identificando o valor na vitrine. Obrigatório em um /POST.
sort_order	sort_order	integer	A ordem em que o valor será exibido na página do produto. Obrigatório em um /POST.
value_data	value_data	object	Dados adicionais que descrevem o valor, com base no tipo de opção ou modificador ao qual o valor está associado. A swatch opção type pode aceitar uma matriz de , com até três chaves de cor hexidecimais, ou um image_url, que é um caminho de URL de colorsimagem completa, incluindo protocolo. A product list opção de tipo requer um product_idarquivo . A checkbox opção type requer um sinalizador booleano, chamado checked_value, para determinar qual valor é considerado o estado verificado. Se não houver dados disponíveis, retorna null.
id	id	integer	A ID numérica exclusiva do valor; incrementos sequenciais.

ProductResponse

Name	Caminho	Tipo	Description
product_Full	data	product_Full
meta	meta	object	Meta objeto vazio; pode ser utilizado mais tarde.

products_Resource

Name	Caminho	Tipo	Description
URL	url	string
recurso	resource	string

productVariant_Full

Name	Caminho	Tipo	Description
cost_price	cost_price	double	O preço de custo da variante. Não afetado pelos preços de tabela de preços.
Preço	price	double	O preço base desta variante na montra. Se for utilizado um ID da Lista de Preços, será utilizado o valor da Lista de Preços. Se um ID da Lista de Preços não for usado, e esse valor for null, o preço padrão do produto (definido no campo do recurso do price Produto) será usado como o preço base.
sale_price	sale_price	double	O preço de venda desta variante na montra. Se for utilizado um ID da Lista de Preços, será utilizado o valor da Lista de Preços. Se um ID da Lista de Preços não for usado e esse valor for nulo, o preço de venda do produto (definido no campo do recurso do price Produto) será usado como preço de venda.
retail_price	retail_price	double	O preço de retalho desta variante na montra. Se for utilizado um ID da Lista de Preços, será utilizado o valor da Lista de Preços. Se um ID da Lista de Preços não for usado e esse valor for nulo, o preço de varejo do produto (definido no campo do recurso do price Produto) será usado como o preço de varejo.
weight	weight	double	O peso base desta variante na montra. Se esse valor for nulo, o peso padrão do produto (definido no campo de peso do recurso do produto) será usado como o peso base.
Largura	width	double	Largura da variante, que pode ser usada para calcular os custos de envio. Se esse valor for null, a largura padrão do produto (definida no campo do recurso do width produto) será usada como a largura de base.
altura	height	double	Altura da variante, que pode ser usada para calcular os custos de envio. Se esse valor for null, a altura padrão do produto (definida no campo do recurso do height produto) será usada como a altura da base.
profundidade	depth	double	Profundidade da variante, que pode ser usada para calcular os custos de envio. Se esse valor for null, a profundidade padrão do produto (definida no campo do recurso do depth produto) será usada como profundidade de base.
is_free_shipping	is_free_shipping	boolean	Bandeira usada para indicar se a variante tem frete grátis. Se true, o custo de envio para a variante será zero.
fixed_cost_shipping_price	fixed_cost_shipping_price	double	Um custo de envio fixo para a variante. Se definido, este valor será usado durante o checkout em vez do cálculo normal do custo de envio.
purchasing_disabled	purchasing_disabled	boolean	Se true, esta variante não será comprável na vitrine.
purchasing_disabled_message	purchasing_disabled_message	string	Se purchasing_disabled for true, essa mensagem deve ser exibida na vitrine quando a variante for selecionada.
UPC	upc	string	O código UPC usado em feeds para sites de comparação de compras e integrações de canais externos.
inventory_level	inventory_level	integer	Nível de estoque para a variante, que é usado quando a inventory_tracking do produto é definida como variant.
inventory_warning_level	inventory_warning_level	integer	Quando a variante atinge esse nível de estoque, é considerado estoque baixo.
bin_picking_number	bin_picking_number	string	Identifica onde em um armazém a variante está localizada.
NMP	mpn	string	O número de peça do fabricante (MPN) para a variante.
id	id	integer
product_id	product_id	integer
sku	sku	string
sku_id	sku_id	integer	Referência somente leitura à ID de SKU da API v2. Nulo se for uma variante base.
option_values	option_values	array of productVariantOptionValue_Full	Matriz de IDs de valores de opção e opção que compõem essa variante. Estará vazio se a variante for a variante base do produto.
calculated_price	calculated_price	double	O preço da variante como visto na vitrine. Este preço tem em conta sale_price e quaisquer regras de ajustamento de preços que sejam aplicáveis a esta variante.
calculated_weight	calculated_weight	double

productVariantOptionValue_Full

Name	Caminho	Tipo	Description
option_display_name	option_display_name	string	O nome da opção.
etiqueta	label	string	O rótulo do valor da opção.
id	id	integer	option_value ID.
option_id	option_id	integer	option ID.

productVideo_Base

O modelo de um POST para criar um vídeo sobre um produto.

Name	Caminho	Tipo	Description
title	title	string	O título do vídeo. Se deixado em branco, será preenchido de acordo com os dados de um site anfitrião.
descrição	description	string	A descrição do vídeo. Se deixado em branco, será preenchido de acordo com os dados de um site anfitrião.
sort_order	sort_order	integer	A ordem em que o vídeo será exibido na página do produto. Números inteiros mais altos dão ao vídeo uma prioridade menor. Ao atualizar, se for dada uma prioridade menor ao vídeo, todos os vídeos com um sort_order valor igual ou superior ao novo sort_order do vídeo terão seus sort_orders reordenados.
tipo	type	string	O tipo de vídeo (um nome curto de um site host).
video_id	video_id	string	O ID do vídeo em um site host.

productVideo_Full

Um modelo de vídeo de produto.

Name	Caminho	Tipo	Description
productVideo_Base	schema	productVideo_Base	O modelo de um POST para criar um vídeo sobre um produto.
id	id	integer	O ID numérico exclusivo do vídeo do produto; incrementos sequenciais.
product_id	product_id	integer	O identificador numérico exclusivo do produto ao qual a imagem está associada.
length	length	string	Duração do vídeo. Este será preenchido de acordo com os dados de um site anfitrião.

ComprandoDesabilitado

Name	Caminho	Tipo	Description
estado	status	boolean	Sinalize se o valor do modificador desabilita a compra quando selecionado na vitrine. Isso pode ser usado para desativar temporariamente um determinado valor modificador.
mensagem	message	string	A mensagem exibida na vitrine quando o status de compra desativado é true.

shippingAddress_Base

Propriedades do endereço de envio comuns a todas as solicitações e respostas.

Name	Caminho	Tipo	Description
first_name	first_name	string
last_name	last_name	string
Companhia	company	string
street_1	street_1	string	Endereço (primeira linha).
street_2	street_2	string	Endereço (segunda linha).
city	city	string
state	state	string
ZIP	zip	string	CEP ou código postal, como uma string.
country	country	string
country_iso2	country_iso2	string	Código ISO Alpha-2 de 2 letras para o país.
phone	phone	string	Número de telefone do destinatário.
e-mail	email	string	Endereço de e-mail do destinatário.
shipping_method	shipping_method	string	Código de texto que identifica o módulo de envio do BigCommerce selecionado pelo cliente.

shippingAddress_Resource

Name	Caminho	Tipo	Description
URL	url	string	URL do endereço de entrega para solicitações de api
recurso	resource	string

shippingQuotes_Resource

Name	Caminho	Tipo	Description
URL	url	string	Este URL retornará um 204 para cotações de envio. Para devolver cotações de envio:'/shipping_addresses/shipping_address_id/shipping_quotes'.
recurso	resource	string	Este URL retornará um 204 para cotações de envio. Para devolver cotações de envio:'/shipping_addresses/shipping_address_id/shipping_quotes'.

PagamentoStatus

Um valor somente leitura. Não tente definir ou modificar esse valor em uma operação POST ou PUT.

Um valor somente leitura. Não tente definir ou modificar esse valor em uma operação POST ou PUT.

PagamentoStatus

string

Método de Pagamento

O método de pagamento para esta encomenda. Pode ser um dos seguintes: Manual, Credit Card, , cash, Test Payment Gatewayetc.

O método de pagamento para esta encomenda. Pode ser um dos seguintes: Manual, Credit Card, , cash, Test Payment Gatewayetc.

Método de Pagamento

string

TaxProviderId

BasicTaxProvider - O imposto é definido como manual.

AvaTaxProvider - Isso é para quando o provedor de impostos foi definido como automático e o pedido NÃO foi criado pela API. Usado para Avalara.

"" (em branco) - Quando o provedor fiscal é desconhecido. Isso inclui pedidos legados e pedidos criados anteriormente via API. Isso pode ser definido ao criar um pedido usando um POST.

BasicTaxProvider - O imposto é definido como manual.

AvaTaxProvider - Isso é para quando o provedor de impostos foi definido como automático e o pedido NÃO foi criado pela API. Usado para Avalara.

"" (em branco) - Quando o provedor fiscal é desconhecido. Isso inclui pedidos legados e pedidos criados anteriormente via API. Isso pode ser definido ao criar um pedido usando um POST.

TaxProviderId

string