Compartilhar via


Shopranos (versão prévia)

Eleve sua empresa com o Shopranos, vinculando o ERP ao ECommerce B2B. Dispare notificações e simplifique as aprovações sem esforço, aumentando a eficiência e o controle. Libere as possibilidades de automação, gerando êxito por meio da integração perfeita.

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

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Shopranos
URL https://www.shopranos.eu
Email support@shopranos.eu
Metadados do conector
Publicador SoftOne Technologies S.A
Site https://www.shopranos.eu
Política de Privacidade https://www.shopranos.eu/privacy-policy
Categorias Commerce

Conector do Shopranos Power Automate

Bem-vindo ao Conector do Shopranos Power Automate! Esse conector integra perfeitamente o sistema ERP da sua empresa com operações de ECommerce B2B, capacitando você a automatizar tarefas críticas e simplificar fluxos de trabalho.

Publicador: Softone Technologies S.A.

Pré-requisitos

Uma assinatura válida do Shopranos.

Como obter credenciais

Para acessar os dados da sua empresa usando o conector shopranos, siga estas etapas:

  1. Visite a página de logon da Plataforma Shopranos em platform.shopranos.eu.
  2. Depois de fazer logon, navegue até o menu e selecione "Chaves de API do Usuário".
  3. Gere uma nova chave de API com base nas opções fornecidas.
  4. Utilize essa chave de API recém-gerada no conector shopranos para obter acesso aos dados da sua empresa.

Introdução ao conector

Para começar a usar o Conector do Shopranos Power Automate, siga estas etapas:

  1. Instalação: instale o conector em seu ambiente do Power Automate.

  2. Configuração: insira sua Chave de API para se conectar ao Shopranos.

  3. Uso: comece a automatizar tarefas e fluxos de trabalho perfeitamente.

Problemas e limitações conhecidos

Você pode encontrar uma lista abrangente de todos os problemas conhecidos visitando o seguinte link no GitHub:

Rastreador de Problemas do Shopranos

Erros e soluções comuns

Erro 1: Chave de API inválida

Sintoma: ao configurar o conector, você recebe um erro indicando que a chave de API é inválida. Remédio: verifique se você gerou uma chave de API válida em sua conta do Shopranos. Verifique se não há espaços à esquerda ou à direita na chave de API ao inseri-la na configuração do conector.

Erro 2: Não é possível se conectar

Sintoma: não é possível estabelecer uma conexão com a plataforma Shopranos ao configurar o conector. Remediar: verifique se você configurou corretamente o conector com a chave de API. Verifique se a plataforma Shopranos (platform.shopranos.eu) está acessível e não está enfrentando tempo de inatividade. Verifique as configurações de rede para confirmar se não há restrições que impeçam o conector de se conectar a serviços externos.

Erro 3: Permissões ausentes

Sintoma: você encontra erros relacionados à permissão ao tentar executar determinadas ações usando o conector. Remediar: verifique se a chave de API gerada tem as permissões necessárias para acessar os recursos específicos ou executar as ações que você está tentando automatizar. Examine a documentação do Shopranos para entender as permissões necessárias para várias operações.

Erro 4: Problemas de instalação do conector

Sintoma: você enfrenta dificuldades durante a instalação do conector em seu ambiente do Power Automate. Remediar: siga cuidadosamente as instruções de instalação fornecidas para o conector shopranos. Verifique se há restrições ou políticas no ambiente do Power Automate que possam estar afetando o processo de instalação. Se o problema persistir, entre em contato com o suporte do Power Automate para obter assistência.

Erro 5: Comportamento inesperado

Sintoma: o conector não está se comportando conforme o esperado ou você encontra erros inexplicáveis durante a execução do fluxo de trabalho. Remediar: examine a configuração do fluxo de trabalho e verifique se as entradas e saídas estão mapeadas corretamente. Verifique se há alterações ou atualizações na API do Shopranos ou na documentação do conector que possam afetar seu fluxo de trabalho. Se o problema persistir, consulte o Shopranos Issue Tracker no GitHub ou entre em contato com o suporte do Shopranos.

Erro 6: Funcionalidade limitada

Sintoma: você descobre que o conector tem funcionalidade limitada ou não dá suporte a determinadas ações. Remédio: consulte o Rastreador de Problemas do Shopranos no GitHub para verificar se as limitações que você está enfrentando são problemas conhecidos. Caso contrário, considere entrar em contato com o suporte do Shopranos para saber mais sobre atualizações planejadas ou soluções alternativas para as limitações.

Erro 7: Desempenho lento

Sintoma: o conector ou os fluxos de trabalho estão apresentando um desempenho lento. Remédio: verifique sua conexão de rede e verifique se sua conta do Shopranos não está enfrentando problemas de desempenho. Além disso, examine o design do fluxo de trabalho para otimize-o para obter eficiência. Se o problema persistir, considere entrar em contato com o suporte do Shopranos para obter assistência. Esses erros comuns e seus remédios correspondentes devem ajudar os usuários a solucionar problemas ao usar o Conector do Shopranos Power Automate. Se você encontrar outros erros ou problemas específicos, não hesite em entrar em contato com o suporte do Shopranos para obter assistência personalizada.

perguntas frequentes

Como posso obter suporte se encontro problemas ou tenho dúvidas?

R: Se você encontrar algum problema ou tiver dúvidas, entre em contato com nossa equipe de suporte em support@shopranos.eu. Estamos aqui para ajudá-lo a aproveitar ao máximo o Shopranos para simplificar seus processos de negócios e aumentar a eficiência.

Quais são os principais benefícios do uso do Shopranos?

O Shopranos oferece vários benefícios importantes, incluindo:

Integração sem esforço: conecte perfeitamente seu sistema ERP ao ECommerce B2B, aprimorando o fluxo de dados e a eficiência operacional. Event-Driven Automação: responda a eventos críticos, como a criação de pedidos, com precisão. Dispare notificações instantâneas e automatize os processos de aprovação com facilidade. Integração do Microsoft Power Automate: aproveite o poder do Microsoft Power Automate para desbloquear uma ampla gama de possibilidades de automação. Envie mensagens importantes, direcione fluxos de trabalho de aprovação e simplifique processos complexos.

Instruções de implantação

Como o Shopranos opera como uma PaaS (Plataforma como Serviço), não é necessário nenhum processo de implantação manual. A plataforma lida com todos os aspectos do gerenciamento de implantação e infraestrutura, permitindo que os usuários se concentrem diretamente na utilização de seus serviços e recursos para seus aplicativos.

Criando uma conexão

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

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

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

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

Nome Tipo Description Obrigatório
Chave de API secureString A chave de API para esta api Verdade

Limitações

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

Ações

Adicionar produto do carrinho

Adicionar produto ao carrinho

Alias Get By de Categoria

Obter categoria por alias

Atualização da Lista de Compras

Atualizar uma lista de compras por alias

Atualização de atributo

Atualizar atributo

Atualização de categoria

Categoria de atualização

Atualização de check-out

Atualizar um check-out por token

Atualização de coleção

Atualizar coleção

Atualização de disponibilidade de estoque

Atualizar a disponibilidade de estoque por ID

Atualização de localização

Atualizar um local por ID

Atualização de marca

Atualizar marca

Atualização de produtos relacionados

Atualizar produtos relacionados

Atualização de sortimento

Atualizar uma variedade por ID do cliente

Atualização de unidade

Atualizar unidade por id

Atualização do carrinho

Atualizar Carrinho por token

Atualização do cliente

Atualizar um cliente por ID

Atualização do conjunto de atributos

Atualizar conjunto de atributos

Atualização do Grupo de Clientes

Atualizar um grupo de clientes por ID

Atualização do Grupo de Privacidade

Atualizar grupo de privacidade por ID

Atualização do pedido

Atualizar um pedido por ID

Atualização do produto

Atualizar produto por id

Atualização do rótulo do produto

Atualizar o rótulo do produto por ID

Atualização no nível do inventário

Atualizar um nível de inventário por ID

Categoria obter conteúdo adicional por Id

Obter conteúdo adicional por ID de categoria

Categoria obter conteúdo adicional por ID (HTML)

Obter conteúdo adicional por ID de categoria

Check-out concluído

Concluir um check-out por token

Coleção Get Additional Content By Id

Obter conteúdo adicional por ID da coleção

Coleção Get Additional Content By Id (HTML)

Obter conteúdo adicional por ID da coleção

Coleção Get by Id

Obter coleção por id

Combinações de atualização de sortimento

Atualizar uma variedade de combinações por ID do cliente

Consulta ao cliente

Obter todos os clientes

Consulta de atributo

Obter atributos por critérios de pesquisa

Consulta de categoria

Obter categorias por critérios de pesquisa

Consulta de coleção

Obter coleções por critérios de pesquisa

Consulta de Conjunto de Atributos

Obter conjuntos de atributos por critérios de pesquisa

Consulta de disponibilidade de estoque

Disponibilidade de estoque de consulta

Consulta de Grupo de Clientes

Obter todos os grupos de clientes

Consulta de grupo de privacidade

Consultar grupos de privacidade

Consulta de marca

Obter marcas por critérios de pesquisa

Consulta de nível de inventário

Obter todos os níveis de inventário

Consulta de pedido

Obter todos os pedidos

Consulta de produto

Produtos de consulta

Consulta de rótulo de produto

Consultar rótulos de produtos

Consulta de sortimentos

Obter todos os sortimentos

Consulta de unidade

Unidades de consulta

Consulta Estendida da Coleção

Consultar coleções estendidas

Consulta Estendida do Produto

Consultar produtos estendidos

Conteúdo Adicional da Atualização de Coleção

Atualizar conteúdo adicional por ID da coleção

Conteúdo Adicional de Atualização de Categoria

Atualizar conteúdo adicional por ID de categoria

Conteúdo Adicional de Atualização de Marca

Atualizar conteúdo adicional por ID da marca

Conteúdo Adicional de Atualizações de Produtos

Atualizar conteúdo adicional por ID do produto

Criar carrinho

Criar Carrinho

Criar check-out

Criar um check-out por token

Criar conjunto de atributos

Criar conjunto de atributos

Criar lista de compras

Criar uma lista de compras

Criar sortimento

Criar uma classificação

Criação de atributo

Criar atributo

Criação de categoria

Criar categoria

Criação de coleção

Criar coleção

Criação de disponibilidade de estoque

Criar disponibilidade de estoque

Criação de grupo de clientes

Criar um grupo de clientes

Criação de grupo de privacidade

Criar grupo de privacidade

Criação de Local

Criar um local

Criação de marca

Criar marca

Criação de nível de inventário

Criar um nível de inventário

Criação de Pedidos

Criar um pedido

Criação de produto

Criar produto

Criação de produtos relacionados

Criar produtos relacionados

Criação de rótulo de produto

Criar rótulo de produto

Criação de unidade

Criar unidade

Criação do cliente

Criar um cliente

Disponibilidade de estoque de reserva de inventário

Reservar disponibilidade de estoque

Disponibilidade de estoque de verificação de inventário

Verificar a disponibilidade do estoque

Disponibilidade de estoques não reservados de inventário

Cancelar a reserva de disponibilidade de estoque

Excluir Conteúdo Adicional da Coleção

Excluir conteúdo adicional por ID da coleção

Excluir Conteúdo Adicional da Marca

Excluir conteúdo adicional por ID da marca

Excluir Conteúdo Adicional de Categoria

Excluir conteúdo adicional por ID de categoria

Excluir Conteúdo Adicional de Exclusão de Produto

Excluir conteúdo adicional por ID do produto

Exclusão da Lista de Compras

Excluir uma lista de compras por alias

Exclusão de atributo

Excluir atributo

Exclusão de categoria

Excluir categoria

Exclusão de coleção

Excluir coleção

Exclusão de disponibilidade de estoque

Excluir disponibilidade de estoque por ID

Exclusão de grupo de privacidade

Excluir grupo de privacidade por ID

Exclusão de localização

Excluir um local por ID

Exclusão de marca

Excluir marca

Exclusão de pedidos

Excluir um pedido por ID

Exclusão de produtos relacionados

Excluir produtos relacionados

Exclusão de sortimento

Excluir uma variedade por ID do cliente

Exclusão de unidade

Excluir unidade por id

Exclusão de valor de sortimento por ID do cliente e ID de sortimento

Excluir valores de sortimento por ID do cliente e ID de sortimento

Exclusão do carrinho

Excluir Carrinho por token

Exclusão do cliente

Excluir um cliente por ID

Exclusão do conjunto de atributos

Excluir conjunto de atributos

Exclusão do Grupo de Clientes

Excluir um grupo de clientes por ID

Exclusão do nível de inventário

Excluir um nível de inventário por ID

Exclusão do produto

Excluir produto por id

Exclusão do rótulo do produto

Excluir rótulo do produto por ID

ID de Obtenção de Atributo por

Obter atributo por id

ID de Obtenção de Categoria por

Obter categoria por id

ID de Obtenção de Cliente

Obter um cliente por ID

ID de Obtenção de Grupo de Privacidade

Obter grupo de privacidade por ID

ID de Obtenção de Localização

Obter um local por ID

ID de obtenção de nível de inventário

Obter um nível de inventário por ID

ID de Obtenção de Pedidos

Obter um pedido por ID

ID de Obtenção de Produto por

Obter o produto por id

ID de Obtenção de Rótulo do Produto

Obter o rótulo do produto por ID

ID de Obtenção de Unidade por

Obter unidade por id

ID de Obtenção por Grupo de Clientes

Obter um grupo de clientes por ID

ID do cliente do grupo de clientes Get by Customer

Obter um grupo de clientes por ID do cliente

ID get by do conjunto de atributos

Obter o atributo definido por id

ID get by variant do nível de inventário

Obter um nível de inventário por ID variante

Importação de atributos

Importar atributos

Importação de Categoria

Importar categorias

Importação de Marca

Importar marcas

Importação de marca por código

Importar marcas por códigos

Importação de nível de inventário

Importar níveis de inventário

Importação de Pedidos

Importar pedidos

Importação de produto de marca de origem

Importar produtos de marca de origem

Importação de produto por SKU

Importar produtos por SKU

Importação de produtos

Importar produtos

Importação de unidade

Importar unidades

Importação do cliente

Importar clientes

Importação do conjunto de atributos

Importar conjuntos de atributos

Limpeza de Filtros

Limpar filtros

Lista de Compras Obter Tudo

Obter todas as listas de compras

Obtenção de Disponibilidade de Estoque por ID

Obter disponibilidade de estoque por ID

Obtenção de marca por ID

Obter marca por id

Obtenção de produto por alias

Obter o produto por alias

Obtenção de sortimento por ID do cliente

Obter uma variedade por ID do cliente

Obtenção estendida da coleção por Alias

Obter coleção estendida por alias

Obtenção estendida da coleção por Id

Obter coleção estendida por id

Obtenção estendida do produto pelo Alias

Obter produto estendido por alias

Obter conteúdo adicional por ID (HTML) da marca

Obter conteúdo adicional por ID da marca

Obter conteúdo adicional por ID (HTML) do produto

Obter conteúdo adicional por ID do produto

Obter conteúdo adicional por ID da marca

Obter conteúdo adicional por ID da marca

Obter conteúdo adicional por ID do produto

Obter conteúdo adicional por ID do produto

Obter lista de compras por alias

Obter uma lista de compras por alias

Obter marca por Alias

Obter marca por alias

Obter por código de atributo

Obter atributo por código

Obter por token de check-out

Obter um check-out por token

Obter por token do carrinho

Obter Carrinho por token

Obter todas as variantes de produto simples

Obter todas as variantes de produto simples

Obter todos os locais

Obter todos os locais

Pagamento completo do check-out

Concluir um pagamento para um check-out por token

Pagamento de Início do Checkout

Iniciar um pagamento para um check-out por token

Recálculo de check-out

Recalcular um check-out por token

Remover produto do carrinho

Remover produto do carrinho

Valores de sortimento acrescentados por ID do cliente

Acrescentar valores de sortimento por ID do cliente

Valores de sortimento atualizados por ID do cliente e ID de sortimento

Atualizar valores de sortimento por ID do cliente e ID de sortimento

Valores de sortimento excluídos por ID de origem do cliente

Excluir valores de sortimento por ID do cliente e origem

Valores de sortimento excluídos por ID do cliente

Excluir valores de sortimento por ID do cliente

Valores de sortimento obtidos pela ID do cliente

Obter valores de sortimento por ID do cliente

Valores de variedade recriam por ID do cliente

Recompilar valores de sortimento por ID do cliente

Adicionar produto do carrinho

Adicionar produto ao carrinho

Parâmetros

Nome Chave Obrigatório Tipo Description
símbolo
token True string

Obter Carrinho por token

ID
id string
ID do Produto
productId string
ProductVariantId
productVariantId string
Quantidade
quantity double
Sku
sku string
Mode
mode string

Retornos

Corpo
CartDTO

Alias Get By de Categoria

Obter categoria por alias

Parâmetros

Nome Chave Obrigatório Tipo Description
Alias
alias True string

Definir o alias da categoria

Retornos

Corpo
CategoryDTO

Atualização da Lista de Compras

Atualizar uma lista de compras por alias

Parâmetros

Nome Chave Obrigatório Tipo Description
Alias
alias True string

Definir uma lista de compras por alias

ID
id string
Title
title string
CompanyId
companyId string
Id do Cliente
customerId string
UserId
userId string
Alias
alias string
InsertDate
insertDate date-time
UpdateDate
updateDate date-time
ID do Produto
productId string
ProductVariantId
productVariantId string

Atualização de atributo

Atualizar atributo

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do atributo

ID
id string
CompanyId
companyId string
Nome
name True string
Code
code True string
Description
description string
UsedAsFilter
usedAsFilter boolean
DisplayOnProduct
displayOnProduct boolean
DisplayOnList
displayOnList boolean
DisplayOnCompare
displayOnCompare boolean
Tipo
type string
Slug
slug string
Cargo
position integer
Situação
status string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
ID
id string
Code
code string
ColorCode
colorCode string
Value
value string
Cargo
position integer
Slug
slug string
Tradução
translation
Tradução
translation

Retornos

Corpo
AttributeDTO

Atualização de categoria

Categoria de atualização

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID da categoria

ID
id string
CompanyId
companyId string
Title
title True string
Code
code True string
Alias
alias string
Description
description string
Cargo
position integer
DisplayInMenu
displayInMenu boolean
DisplayAsList
displayAsList boolean
ParentId
parentId string
Caminho
path string
MediaItem
mediaItem
Tradução
translation
SeoTitle
seoTitle string
SeoDescription
seoDescription string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
TreeIds
treeIds array of string
Link
link string
Situação
status string

Retornos

Corpo
CategoryDTO

Atualização de check-out

Atualizar um check-out por token

Parâmetros

Nome Chave Obrigatório Tipo Description
Símbolo
token True string

Upate a checkout by token

Anotações
notes string
ReferenceCode
referenceCode string
ShippingAddress
shippingAddress
ShippingLine
shippingLine
Pagamento
payment
CustomerBranchId
customerBranchId string
Nome
name string
Value
value
ID
id string
Nome
name string
Endereço
address
DeliveryDate
deliveryDate date-time

Retornos

Corpo
CheckoutDTO

Atualização de coleção

Atualizar coleção

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da coleção
collectionId True string

Definir a ID da coleção

ID
id string
CompanyId
companyId string
Title
title string
Description
description string
DescriptionHtml
descriptionHtml string
Link
link string
Alias
alias string
MediaItem
mediaItem
Situação
status string
Mode
mode string
PublishedAt
publishedAt date-time
SortOrder
sortOrder string
ContagemDeProdutos
productCount integer
ProductIds
productIds array of string
ID
id string
CompanyId
companyId string
DescriptionPlain
descriptionPlain string
Link
link string
ID
id string
GalleryId
galleryId string
CompanyId
companyId string
Link
link string
Cargo
position integer
Alt
alt string
Tipo de Mídia
mediaType string
Largura
width integer
Altura
height integer
ID
id string
ID do Produto
productId string
MediaItem
mediaItem
Title
title string
Gtin
gtin string
Mpn
mpn string
PreçoUnitário
unitPrice double
Preço
price double
Msrp
msrp double
Quantidade
quantity double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
Peso de remessa
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Tradução
translation
CanOrder
canOrder boolean
AdditionalFeatures
additionalFeatures
Esperado
expected
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Tradução
translation
MaxPrice
maxPrice double
MinPrice
minPrice double
PathCategories
pathCategories array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
VariantCount
variantCount integer
AdditionalFeatures
additionalFeatures
Dimensão 1
dimension1
Dimensão 2
dimension2
Dimensão3
dimension3
SearchAttributes
searchAttributes array of string
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
Subtítulo
subTitle string
Description
description string
Alias
alias string
Situação
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
Disponibilidade
availability string
Tradução
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Nome
name string
Value
value
Tradução
translation
AttributeSetId
attributeSetId string
Data de classificação
sortDate date-time
Sortimentos
assortments array of string
Identificação mestre
masterId string
Tamanho1
size1 double
Tamanho2
size2 double
Tamanho3
size3 double
Tamanho4
size4 double
Tamanho5
size5 double
Tamanho6
size6 double
Priority
priority integer
Data1
date1 date-time
Data2
date2 date-time
Data3
date3 date-time
ID
id string
CompanyId
companyId string
Title
title string
Description
description string
DescriptionHtml
descriptionHtml string
Link
link string
Alias
alias string
MediaItem
mediaItem
Situação
status string
Mode
mode string
PublishedAt
publishedAt date-time
SortOrder
sortOrder string
ContagemDeProdutos
productCount integer
ProductIds
productIds array of string
ID
id string
CompanyId
companyId string
DescriptionPlain
descriptionPlain string
Link
link string
ID
id string
GalleryId
galleryId string
CompanyId
companyId string
Link
link string
Cargo
position integer
Alt
alt string
Tipo de Mídia
mediaType string
Largura
width integer
Altura
height integer
ID
id string
ID do Produto
productId string
MediaItem
mediaItem
Title
title string
Gtin
gtin string
Mpn
mpn string
PreçoUnitário
unitPrice double
Preço
price double
Msrp
msrp double
Quantidade
quantity double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
Peso de remessa
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Tradução
translation
CanOrder
canOrder boolean
AdditionalFeatures
additionalFeatures
Esperado
expected
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Tradução
translation
MaxPrice
maxPrice double
MinPrice
minPrice double
PathCategories
pathCategories array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
VariantCount
variantCount integer
AdditionalFeatures
additionalFeatures
Dimensão 1
dimension1
Dimensão 2
dimension2
Dimensão3
dimension3
SearchAttributes
searchAttributes array of string
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
Subtítulo
subTitle string
Description
description string
Alias
alias string
Situação
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
Disponibilidade
availability string
Tradução
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Nome
name string
Value
value
Tradução
translation
AttributeSetId
attributeSetId string
Data de classificação
sortDate date-time
Sortimentos
assortments array of string
Identificação mestre
masterId string
Tamanho1
size1 double
Tamanho2
size2 double
Tamanho3
size3 double
Tamanho4
size4 double
Tamanho5
size5 double
Tamanho6
size6 double
Priority
priority integer
Data1
date1 date-time
Data2
date2 date-time
Data3
date3 date-time
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Etiquetas
tags array of string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
Tradução
translation
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Etiquetas
tags array of string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
Tradução
translation
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string

Atualização de disponibilidade de estoque

Atualizar a disponibilidade de estoque por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID da disponibilidade do estoque

Code
code string
Title
title string
Tradução
translation
MediaItem
mediaItem
Message
message string
Quantidade
quantity integer
Cor
color string
Tradução
translation

Atualização de localização

Atualizar um local por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da localização
locationId True string

Atualizar um local por ID

ID
id string
CompanyId
companyId string
Nome
name string
IsActive
isActive boolean
Endereço
address
Telefone
phone string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Atualização de marca

Atualizar marca

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da marca
brandId True string

Definir a ID da marca

ID
id string
CompanyId
companyId string
Code
code True string
Nome
name True string
Alias
alias string
Description
description string
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
Situação
status string
MetaKeywords
metaKeywords array of string
MediaItem
mediaItem
Tradução
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SeoTitle
seoTitle string
SeoDescription
seoDescription string

Atualização de produtos relacionados

Atualizar produtos relacionados

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do produto
productId True string

Definir a ID do produto

ID da variante
variantId True string

Definir a ID da variante

ID
id string
ID do Produto
productId string
CompanyId
companyId string
Dimension1ItemIds
dimension1ItemIds array of string
Dimension2ItemIds
dimension2ItemIds array of string
Dimension3ItemIds
dimension3ItemIds array of string

Atualização de sortimento

Atualizar uma variedade por ID do cliente

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerId True string

Atualizar uma variedade por ID do cliente

ID
id string
Nome
name string
ID
id string
Nome
name string

Retornos

Atualização de unidade

Atualizar unidade por id

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID da unidade

ID
id string
CompanyId
companyId string
Code
code True string
Nome
name True string
Tradução
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Atualização do carrinho

Atualizar Carrinho por token

Parâmetros

Nome Chave Obrigatório Tipo Description
símbolo
token True string

Atualizar Carrinho por token

Moeda
currency string
ID
id string
ID do Produto
productId string
ProductVariantId
productVariantId string
Quantidade
quantity double
Sku
sku string
Mode
mode string

Retornos

Corpo
CartDTO

Atualização do cliente

Atualizar um cliente por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerId True string

Atualizar um cliente por ID

ID
id string
CompanyId
companyId string
Code
code string
Nome
name string
Estanho
tin string
Email
email string
Contato
contact string
ContactPhone
contactPhone string
Telefone
phone string
PriceCategoryId
priceCategoryId string
SourceId
sourceId string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
Endereço
address
Anotações
notes string
Situação
status string
ID
id string
SourceId
sourceId string
Code
code string
Nome
name string
Contato
contact string
ContactPhone
contactPhone string
Telefone
phone string
Endereço
address
Situação
status string
AdditionalFeatures
additionalFeatures
Nome
name string
Value
value
Tradução
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SalesmanId
salesmanId string
TaxOffice
taxOffice string
ContactLanguage
contactLanguage string
VatType
vatType string
ShopType
shopType string
Nome
name string
Endereço
address

Atualização do conjunto de atributos

Atualizar conjunto de atributos

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do conjunto de atributos

Title
title string
Description
description string
Title
title string
ID
id string
Cargo
position integer
ID
id string
Cargo
position integer

Retornos

Atualização do Grupo de Clientes

Atualizar um grupo de clientes por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
Id True string

Atualizar um grupo de clientes por ID

ID
id string
CompanyId
companyId string
Title
title True string
Situação
status string
Regra
rule
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Atualização do Grupo de Privacidade

Atualizar grupo de privacidade por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do grupo de privacidade

ID
id string
CompanyId
companyId string
Title
title string
Situação
status string
Mode
mode string
ProductIds
productIds array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Regra
rule
CustomerGroupIds
customerGroupIds array of string
CustomerIds
customerIds array of string

Atualização do pedido

Atualizar um pedido por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Atualizar um pedido por ID

ID
id string
Code
code string
CompanyId
companyId string
CheckoutToken
checkoutToken string
CartToken
cartToken string
Situação
status string
Id do Cliente
customerId string
CustomerBranchId
customerBranchId string
CustomerBranchSourceId
customerBranchSourceId string
CustomerTin
customerTin string
Nome do Cliente
customerName string
CustomerCode
customerCode string
CustomerSourceId
customerSourceId string
CustomerBranchName
customerBranchName string
Moeda
currency string
CancelledAt
cancelledAt date-time
DeliveryDate
deliveryDate date-time
CancellationReason
cancellationReason string
ClosedAt
closedAt date-time
ReferenceCode
referenceCode string
Taxa de Descontos
discountRate double
DiscountValue
discountValue double
TotalAmount
totalAmount double
NetAmount
netAmount double
VatAmount
vatAmount double
ExpenseAmount
expenseAmount double
FinancialStatus
financialStatus string
FulfillmentStatus
fulfillmentStatus string
BillingAddress
billingAddress
ShippingAddress
shippingAddress
RequiresCalculation
requiresCalculation boolean
ID
id string
ID do Produto
productId string
ProductVariantId
productVariantId string
Título do Produto
productTitle string
UnitId
unitId string
SalesUnitId
salesUnitId string
Quantidade
quantity double
UnitQuantity
unitQuantity double
NetValue
netValue double
Preço
price double
ExpenseValue
expenseValue double
PriceValue1
priceValue1 double
PriceValue2
priceValue2 double
PriceValue3
priceValue3 double
PreçoUnitário
unitPrice double
LineValue
lineValue double
DiscountValue
discountValue double
Taxa de Descontos
discountRate double
VatValue
vatValue double
VatRate
vatRate double
VatCode
vatCode string
Sku
sku string
Dimension1Caption
dimension1Caption string
Dimension2Caption
dimension2Caption string
Dimension3Caption
dimension3Caption string
Dimension1Value
dimension1Value string
Dimension2Value
dimension2Value string
Dimension3Value
dimension3Value string
VatRate
vatRate double
VatAmount
vatAmount double
VatCode
vatCode string
NetAmount
netAmount double
Etiquetas
tags array of string
SourceId
sourceId string
SourceTags
sourceTags array of string
Anotações
notes string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Favorite
favorite boolean
UserId
userId string
InvoiceUrl
invoiceUrl string
Notificar
notify string
Notificado
notified array of string
Nome
name string
Value
value
ShippingLine
shippingLine
ID do Produto
productId string
ProductVariantId
productVariantId string
Título do Produto
productTitle string
Quantidade
quantity double
VatCode
vatCode string
ImageLink
imageLink string
ProductAlias
productAlias string
ID
id string
NetValue
netValue double
VatValue
vatValue double
Pagamento
payment
Identificação da série
seriesId string

Atualização do produto

Atualizar produto por id

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do produto

ID
id string
Link
link string
Cargo
position integer
Alt
alt string
Tipo de Mídia
mediaType string
GalleryId
galleryId string
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Tradução
translation
ID
id string
Title
title string
Gtin
gtin string
Mpn
mpn string
PreçoUnitário
unitPrice double
Preço
price double
Msrp
msrp double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
Peso de remessa
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Tradução
translation
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
MediaItem
mediaItem
Dimensão 1
dimension1
Dimensão 2
dimension2
Dimensão3
dimension3
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
Subtítulo
subTitle string
Description
description string
Alias
alias string
Situação
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
PathCategories
pathCategories array of string
Disponibilidade
availability string
Tradução
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Nome
name string
Value
value
Tradução
translation
AttributeSetId
attributeSetId string
Data de classificação
sortDate date-time
Sortimentos
assortments array of string
Identificação mestre
masterId string
Tamanho1
size1 double
Tamanho2
size2 double
Tamanho3
size3 double
Tamanho4
size4 double
Tamanho5
size5 double
Tamanho6
size6 double
Priority
priority integer
Data1
date1 date-time
Data2
date2 date-time
Data3
date3 date-time

Atualização do rótulo do produto

Atualizar o rótulo do produto por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do rótulo do produto

ID
id string
CompanyId
companyId string
Nome
name string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Ícone
icon string
BackgroundColor
backgroundColor string
TextColor
textColor string
ProductIds
productIds array of string
RuleEnabled
ruleEnabled boolean
DateFrom
dateFrom date-time
DateTo
dateTo date-time
Mode
mode string
Situação
status string
Regra
rule
Tradução
translation

Atualização no nível do inventário

Atualizar um nível de inventário por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Atualizar um nível de inventário por ID

ID
id string
ProductVariantId
productVariantId string
ID do Produto
productId string
CompanyId
companyId string
LocationId
locationId string
Quantidade
quantity double
DeliveryDate
deliveryDate date-time
ExpectedQuantity
expectedQuantity double
UpdateDate
updateDate date-time

Categoria obter conteúdo adicional por Id

Obter conteúdo adicional por ID de categoria

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da categoria
categoryId True string

Definir a ID da categoria

Retornos

Categoria obter conteúdo adicional por ID (HTML)

Obter conteúdo adicional por ID de categoria

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da categoria
categoryId True string

Definir a ID da categoria

Retornos

Check-out concluído

Concluir um check-out por token

Parâmetros

Nome Chave Obrigatório Tipo Description
Símbolo
token True string

Concluir um check-out por token

Anotações
notes string
ReferenceCode
referenceCode string
ShippingAddress
shippingAddress
ShippingLine
shippingLine
Pagamento
payment
CustomerBranchId
customerBranchId string
Nome
name string
Value
value
ID
id string
Nome
name string
Endereço
address
DeliveryDate
deliveryDate date-time

Retornos

Corpo
CheckoutDTO

Coleção Get Additional Content By Id

Obter conteúdo adicional por ID da coleção

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da coleção
collectionId True string

Definir a ID da coleção

Retornos

Coleção Get Additional Content By Id (HTML)

Obter conteúdo adicional por ID da coleção

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da coleção
collectionId True string

Definir a ID da coleção

Retornos

Coleção Get by Id

Obter coleção por id

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da coleção
collectionId True string

Definir a ID da coleção

Retornos

Combinações de atualização de sortimento

Atualizar uma variedade de combinações por ID do cliente

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerId True string

Atualizar uma variedade de combinações por ID do cliente

BranchId
branchId string
CategoryId
categoryId string
TypeId
typeId string

Retornos

Consulta ao cliente

Obter todos os clientes

Parâmetros

Nome Chave Obrigatório Tipo Description
Situação
Status string

Obter todos os clientes por status

Pesquisa
Search string

Obter todos os clientes por texto de pesquisa

Nome
Name string

Obter todos os clientes pelo nome

ID do vendedor
SalesmanId string

Obter todos os clientes por ID do vendedor

ID
Id string

Obter todos os clientes por ID

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Consulta de atributo

Obter atributos por critérios de pesquisa

Parâmetros

Nome Chave Obrigatório Tipo Description
Situação
Status string

Definir o status do atributo

Tipo
Type string

Definir o tipo do atributo

É filtreável
IsFilterable boolean

Definir a filtragem do atributo

Exibir no produto
DisplayOnProduct boolean

Definir a exibição no produto do atributo

Exibir na lista
DisplayInList boolean

Definir a exibição na lista do atributo

Pesquisa
Search string

Definir a pesquisa do atributo

ID
Id string

Definir a ID do atributo

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Corpo
AttributeDTO

Consulta de categoria

Obter categorias por critérios de pesquisa

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title string

Definir o título da categoria

ID
Id string

Definir a ID da categoria

Pesquisa
Search string

Definir a palavra-chave de pesquisa para a categoria

Code
Code string

Definir o código da categoria

ID pai
ParentId string

Definir a ID pai da categoria

Caminho
Path string

Definir o caminho da categoria

IDs pai
ParentIds string

Definir as IDs pai da categoria

Situação
Status string

Definir o status da categoria

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Consulta de coleção

Obter coleções por critérios de pesquisa

Parâmetros

Nome Chave Obrigatório Tipo Description
Situação
Status string

Definir o status da coleção

Title
Title string

Definir o título da coleção

ID
Id string

Definir a ID da coleção

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Consulta de Conjunto de Atributos

Obter conjuntos de atributos por critérios de pesquisa

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title string

Consulta por título

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Consulta de disponibilidade de estoque

Disponibilidade de estoque de consulta

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title string

Definir o título

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Consulta de Grupo de Clientes

Obter todos os grupos de clientes

Parâmetros

Nome Chave Obrigatório Tipo Description
Situação
Status string

Obter todos os grupos de clientes por status

Title
Title string

Obter todos os grupos de clientes por título

ID
Id string

Obter todos os grupos de clientes por ID

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Consulta de grupo de privacidade

Consultar grupos de privacidade

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title string

Definir o título

Situação
Status string

Definir o status

IDs do cliente
CustomerIds string

Definir as IDs do cliente

IDs do Grupo de Clientes
CustomerGroupIds string

Definir as IDs do grupo de clientes

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Consulta de marca

Obter marcas por critérios de pesquisa

Parâmetros

Nome Chave Obrigatório Tipo Description
Situação
Status string

Definir o status da marca

Pesquisa
Search string

Definir a pesquisa da marca

Code
Code string

Definir o código da marca

ID
Id string

Definir a ID da marca

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Consulta de nível de inventário

Obter todos os níveis de inventário

Parâmetros

Nome Chave Obrigatório Tipo Description
Localização
Location string

Obter todos os níveis de inventário por local

IDs variantes
VariantIds string

Obter todos os níveis de inventário por IDs variantes

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Consulta de pedido

Obter todos os pedidos

Parâmetros

Nome Chave Obrigatório Tipo Description
Pesquisa
Search string

Pesquisar texto

Code
Code string

Obter todos os pedidos por código

ID do cliente
CustomerId string

Obter todos os pedidos por ID do cliente

Status do pedido
OrderStatus string

Obter todos os pedidos por status do pedido

Situação
Status string

Obter todos os pedidos por status

Etiqueta
Tag string

Obter todos os pedidos por marca

Código do cliente
CustomerCode string

Obter todos os pedidos pelo código do cliente

Lata de Cliente
CustomerTin string

Obter todos os pedidos por lata do cliente

Inserir Data
InsertDate string

Obter todos os pedidos por data de inserção

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Consulta de produto

Produtos de consulta

Parâmetros

Nome Chave Obrigatório Tipo Description
Preço
Price string

Definir o preço

Preço Máximo
MaxPrice double

Definir o preço máximo

Tamanho 1
Size1 string

Definir o tamanho 1

Tamanho 2
Size2 string

Definir o tamanho 2

Tamanho 3
Size3 string

Definir o tamanho 3

Inserir Data
InsertDate string

Definir a data de inserção

Data 1
Date1 string

Definir a data 1

Data 2
Date2 string

Definir a data 2

Data 3
Date3 string

Definir a data 3

Intervalo de datas da data 1
Date1DateRange string

Definir o intervalo de datas 1

Intervalo de datas da data 2
Date2DateRange string

Definir o intervalo de datas 2

Intervalo de datas da data 3
Date3DateRange string

Definir o intervalo de datas 3

Inserir Intervalo de Datas
InsertDateRange string

Definir o intervalo de datas de inserção

Pesquisa
Search string

Definir o texto da pesquisa

Preço Mínimo
MinPrice double

Definir o preço mínimo

Situação
Status string

Definir o status

Disponibilidade
Availability string

Definir a disponibilidade

Etiqueta
Tag string

Definir a marca

Marca de origem
SourceTag string

Definir a marca de origem

Regra de privacidade
PrivacyRule string

Definir a regra de privacidade

Regra
Rule string

Definir a regra

Condição
Condition string

Definir a condição

Ids
Ids string

Definir as IDs

ID
Id string

Definir a ID

Preço
PriceRange string

Definir a faixa de preço

Código de marca
BrandCode string

Definir o código da marca

ID da marca
BrandId string

Definir a ID da marca

Attribute
Attribute string

Definir o atributo

Categoria de caminho
PathCategory string

Definir a categoria de caminho

ID da categoria
CategoryId string

Definir a ID da categoria

ID de categoria adicional
AdditionalCategoryId string

Definir a ID de categoria adicional

ID de Disponibilidade de Estoque
StockAvailabilityId string

Definir a ID de disponibilidade de estoque

ID do conjunto de atributos
AttributeSetId string

Definir a ID do conjunto de atributos

ID da categoria de preço
PriceCategoryId string

Definir a ID da categoria de preço

Tem mídia
HasMedia boolean

Definir a mídia has

ID mestra
MasterId string

Definir a ID mestra

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Consulta de rótulo de produto

Consultar rótulos de produtos

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome
Name string

Definir o nome

Situação
Status string

Definir o status

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Consulta de sortimentos

Obter todos os sortimentos

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
CustomerId string

Obter todas as variedades por ID do cliente

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Consulta de unidade

Unidades de consulta

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome
Name string

Definir o nome

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

response
array of UnitDTO

Consulta Estendida da Coleção

Consultar coleções estendidas

Parâmetros

Nome Chave Obrigatório Tipo Description
Situação
Status string

Definir o status

Title
Title string

Definir o título

ID
Id string

Definir a ID

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Linguagem
lang string

Definir o idioma

Retornos

Consulta Estendida do Produto

Consultar produtos estendidos

Parâmetros

Nome Chave Obrigatório Tipo Description
Linguagem
lang string

Definir o idioma

Extend
extend string

Definir os campos a serem estendidos

Preço
Price string

Definir o preço

Preço Máximo
MaxPrice double

Definir o preço máximo

Tamanho 1
Size1 string

Definir o tamanho 1

Tamanho 2
Size2 string

Definir o tamanho 2

Tamanho 3
Size3 string

Definir o tamanho 3

Inserir Data
InsertDate string

Definir a data de inserção

Data 1
Date1 string

Definir a data 1

Data 2
Date2 string

Definir a data 2

Data 3
Date3 string

Definir a data 3

Intervalo de datas da data 1
Date1DateRange string

Definir o intervalo de datas 1

Intervalo de datas da data 2
Date2DateRange string

Definir o intervalo de datas 2

Intervalo de datas da data 3
Date3DateRange string

Definir o intervalo de datas 3

Inserir Intervalo de Datas
InsertDateRange string

Definir o intervalo de datas de inserção

Pesquisa
Search string

Definir o texto da pesquisa

Preço Mínimo
MinPrice double

Definir o preço mínimo

Situação
Status string

Definir o status

Disponibilidade
Availability string

Definir a disponibilidade

Etiqueta
Tag string

Definir a marca

Marca de origem
SourceTag string

Definir a marca de origem

Regra de privacidade
PrivacyRule string

Definir a regra de privacidade

Regra
Rule string

Definir a regra

Condição
Condition string

Definir a condição

Ids
Ids string

Definir as IDs

ID
Id string

Definir a ID

Preço
PriceRange string

Definir a faixa de preço

Código de marca
BrandCode string

Definir o código da marca

ID da marca
BrandId string

Definir a ID da marca

Attribute
Attribute string

Definir o atributo

Categoria de caminho
PathCategory string

Definir a categoria de caminho

ID da categoria
CategoryId string

Definir a ID da categoria

ID de categoria adicional
AdditionalCategoryId string

Definir a ID de categoria adicional

ID de Disponibilidade de Estoque
StockAvailabilityId string

Definir a ID de disponibilidade de estoque

ID do conjunto de atributos
AttributeSetId string

Definir a ID do conjunto de atributos

ID da categoria de preço
PriceCategoryId string

Definir a ID da categoria de preço

Tem mídia
HasMedia boolean

Definir a mídia has

ID mestra
MasterId string

Definir a ID mestra

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Conteúdo Adicional da Atualização de Coleção

Atualizar conteúdo adicional por ID da coleção

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da coleção
collectionId True string

Definir a ID da coleção

ID
id string
CompanyId
companyId string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
ID
id string
Title
title string
Description
description string
Cargo
position integer
MediaItem
mediaItem
Tradução
translation

Conteúdo Adicional de Atualização de Categoria

Atualizar conteúdo adicional por ID de categoria

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da categoria
categoryId True string

Definir a ID da categoria

ID
id string
CompanyId
companyId string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
ID
id string
Title
title string
Description
description string
Cargo
position integer
MediaItem
mediaItem
Tradução
translation

Conteúdo Adicional de Atualização de Marca

Atualizar conteúdo adicional por ID da marca

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da marca
brandId True string

Definir a ID da marca

ID
id string
CompanyId
companyId string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
ID
id string
Title
title string
Description
description string
Cargo
position integer
MediaItem
mediaItem
Tradução
translation

Conteúdo Adicional de Atualizações de Produtos

Atualizar conteúdo adicional por ID do produto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do produto
productId True string

Definir a ID do produto

ID
id string
CompanyId
companyId string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
ID
id string
Title
title string
Description
description string
Cargo
position integer
MediaItem
mediaItem
Tradução
translation

Criar carrinho

Criar Carrinho

Parâmetros

Nome Chave Obrigatório Tipo Description
Moeda
currency string
ID
id string
ID do Produto
productId string
ProductVariantId
productVariantId string
Quantidade
quantity double
Sku
sku string
Mode
mode string

Retornos

Corpo
CartDTO

Criar check-out

Criar um check-out por token

Parâmetros

Nome Chave Obrigatório Tipo Description
Símbolo
token True string

Criar um check-out por token

Linguagem
lang string

Linguagem

Retornos

Corpo
CheckoutDTO

Criar conjunto de atributos

Criar conjunto de atributos

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
title string
Description
description string
Title
title string
ID
id string
Cargo
position integer
ID
id string
Cargo
position integer

Retornos

Criar lista de compras

Criar uma lista de compras

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
Title
title string
CompanyId
companyId string
Id do Cliente
customerId string
UserId
userId string
Alias
alias string
InsertDate
insertDate date-time
UpdateDate
updateDate date-time
ID do Produto
productId string
ProductVariantId
productVariantId string

Retornos

Criar sortimento

Criar uma classificação

Parâmetros

Nome Chave Obrigatório Tipo Description
Id do Cliente
customerId string
Nome
name string
Nome
name string

Retornos

Criação de atributo

Criar atributo

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Nome
name True string
Code
code True string
Description
description string
UsedAsFilter
usedAsFilter boolean
DisplayOnProduct
displayOnProduct boolean
DisplayOnList
displayOnList boolean
DisplayOnCompare
displayOnCompare boolean
Tipo
type string
Slug
slug string
Cargo
position integer
Situação
status string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
ID
id string
Code
code string
ColorCode
colorCode string
Value
value string
Cargo
position integer
Slug
slug string
Tradução
translation
Tradução
translation

Retornos

Corpo
AttributeDTO

Criação de categoria

Criar categoria

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Title
title True string
Code
code True string
Alias
alias string
Description
description string
Cargo
position integer
DisplayInMenu
displayInMenu boolean
DisplayAsList
displayAsList boolean
ParentId
parentId string
Caminho
path string
MediaItem
mediaItem
Tradução
translation
SeoTitle
seoTitle string
SeoDescription
seoDescription string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
TreeIds
treeIds array of string
Link
link string
Situação
status string

Retornos

Corpo
CategoryDTO

Criação de coleção

Criar coleção

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Title
title string
Description
description string
DescriptionHtml
descriptionHtml string
Link
link string
Alias
alias string
MediaItem
mediaItem
Situação
status string
Mode
mode string
PublishedAt
publishedAt date-time
SortOrder
sortOrder string
ContagemDeProdutos
productCount integer
ProductIds
productIds array of string
ID
id string
CompanyId
companyId string
DescriptionPlain
descriptionPlain string
Link
link string
ID
id string
GalleryId
galleryId string
CompanyId
companyId string
Link
link string
Cargo
position integer
Alt
alt string
Tipo de Mídia
mediaType string
Largura
width integer
Altura
height integer
ID
id string
ID do Produto
productId string
MediaItem
mediaItem
Title
title string
Gtin
gtin string
Mpn
mpn string
PreçoUnitário
unitPrice double
Preço
price double
Msrp
msrp double
Quantidade
quantity double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
Peso de remessa
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Tradução
translation
CanOrder
canOrder boolean
AdditionalFeatures
additionalFeatures
Esperado
expected
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Tradução
translation
MaxPrice
maxPrice double
MinPrice
minPrice double
PathCategories
pathCategories array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
VariantCount
variantCount integer
AdditionalFeatures
additionalFeatures
Dimensão 1
dimension1
Dimensão 2
dimension2
Dimensão3
dimension3
SearchAttributes
searchAttributes array of string
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
Subtítulo
subTitle string
Description
description string
Alias
alias string
Situação
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
Disponibilidade
availability string
Tradução
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Nome
name string
Value
value
Tradução
translation
AttributeSetId
attributeSetId string
Data de classificação
sortDate date-time
Sortimentos
assortments array of string
Identificação mestre
masterId string
Tamanho1
size1 double
Tamanho2
size2 double
Tamanho3
size3 double
Tamanho4
size4 double
Tamanho5
size5 double
Tamanho6
size6 double
Priority
priority integer
Data1
date1 date-time
Data2
date2 date-time
Data3
date3 date-time
ID
id string
CompanyId
companyId string
Title
title string
Description
description string
DescriptionHtml
descriptionHtml string
Link
link string
Alias
alias string
MediaItem
mediaItem
Situação
status string
Mode
mode string
PublishedAt
publishedAt date-time
SortOrder
sortOrder string
ContagemDeProdutos
productCount integer
ProductIds
productIds array of string
ID
id string
CompanyId
companyId string
DescriptionPlain
descriptionPlain string
Link
link string
ID
id string
GalleryId
galleryId string
CompanyId
companyId string
Link
link string
Cargo
position integer
Alt
alt string
Tipo de Mídia
mediaType string
Largura
width integer
Altura
height integer
ID
id string
ID do Produto
productId string
MediaItem
mediaItem
Title
title string
Gtin
gtin string
Mpn
mpn string
PreçoUnitário
unitPrice double
Preço
price double
Msrp
msrp double
Quantidade
quantity double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
Peso de remessa
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Tradução
translation
CanOrder
canOrder boolean
AdditionalFeatures
additionalFeatures
Esperado
expected
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Tradução
translation
MaxPrice
maxPrice double
MinPrice
minPrice double
PathCategories
pathCategories array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
VariantCount
variantCount integer
AdditionalFeatures
additionalFeatures
Dimensão 1
dimension1
Dimensão 2
dimension2
Dimensão3
dimension3
SearchAttributes
searchAttributes array of string
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
Subtítulo
subTitle string
Description
description string
Alias
alias string
Situação
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
Disponibilidade
availability string
Tradução
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Nome
name string
Value
value
Tradução
translation
AttributeSetId
attributeSetId string
Data de classificação
sortDate date-time
Sortimentos
assortments array of string
Identificação mestre
masterId string
Tamanho1
size1 double
Tamanho2
size2 double
Tamanho3
size3 double
Tamanho4
size4 double
Tamanho5
size5 double
Tamanho6
size6 double
Priority
priority integer
Data1
date1 date-time
Data2
date2 date-time
Data3
date3 date-time
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Etiquetas
tags array of string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
Tradução
translation
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Etiquetas
tags array of string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
Tradução
translation
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string

Criação de disponibilidade de estoque

Criar disponibilidade de estoque

Parâmetros

Nome Chave Obrigatório Tipo Description
Code
code string
Title
title string
Tradução
translation
MediaItem
mediaItem
Message
message string
Quantidade
quantity integer
Cor
color string
Tradução
translation

Retornos

Criação de grupo de clientes

Criar um grupo de clientes

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Title
title True string
Situação
status string
Regra
rule
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Retornos

Criação de grupo de privacidade

Criar grupo de privacidade

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Title
title string
Situação
status string
Mode
mode string
ProductIds
productIds array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Regra
rule
CustomerGroupIds
customerGroupIds array of string
CustomerIds
customerIds array of string

Retornos

Criação de Local

Criar um local

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Nome
name string
IsActive
isActive boolean
Endereço
address
Telefone
phone string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Retornos

Corpo
LocationDTO

Criação de marca

Criar marca

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Code
code True string
Nome
name True string
Alias
alias string
Description
description string
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
Situação
status string
MetaKeywords
metaKeywords array of string
MediaItem
mediaItem
Tradução
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SeoTitle
seoTitle string
SeoDescription
seoDescription string

Retornos

Corpo
BrandDTO

Criação de nível de inventário

Criar um nível de inventário

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
ProductVariantId
productVariantId string
ID do Produto
productId string
CompanyId
companyId string
LocationId
locationId string
Quantidade
quantity double
DeliveryDate
deliveryDate date-time
ExpectedQuantity
expectedQuantity double
UpdateDate
updateDate date-time

Retornos

Criação de Pedidos

Criar um pedido

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
Code
code string
CompanyId
companyId string
CheckoutToken
checkoutToken string
CartToken
cartToken string
Situação
status string
Id do Cliente
customerId string
CustomerBranchId
customerBranchId string
CustomerBranchSourceId
customerBranchSourceId string
CustomerTin
customerTin string
Nome do Cliente
customerName string
CustomerCode
customerCode string
CustomerSourceId
customerSourceId string
CustomerBranchName
customerBranchName string
Moeda
currency string
CancelledAt
cancelledAt date-time
DeliveryDate
deliveryDate date-time
CancellationReason
cancellationReason string
ClosedAt
closedAt date-time
ReferenceCode
referenceCode string
Taxa de Descontos
discountRate double
DiscountValue
discountValue double
TotalAmount
totalAmount double
NetAmount
netAmount double
VatAmount
vatAmount double
ExpenseAmount
expenseAmount double
FinancialStatus
financialStatus string
FulfillmentStatus
fulfillmentStatus string
BillingAddress
billingAddress
ShippingAddress
shippingAddress
RequiresCalculation
requiresCalculation boolean
ID
id string
ID do Produto
productId string
ProductVariantId
productVariantId string
Título do Produto
productTitle string
UnitId
unitId string
SalesUnitId
salesUnitId string
Quantidade
quantity double
UnitQuantity
unitQuantity double
NetValue
netValue double
Preço
price double
ExpenseValue
expenseValue double
PriceValue1
priceValue1 double
PriceValue2
priceValue2 double
PriceValue3
priceValue3 double
PreçoUnitário
unitPrice double
LineValue
lineValue double
DiscountValue
discountValue double
Taxa de Descontos
discountRate double
VatValue
vatValue double
VatRate
vatRate double
VatCode
vatCode string
Sku
sku string
Dimension1Caption
dimension1Caption string
Dimension2Caption
dimension2Caption string
Dimension3Caption
dimension3Caption string
Dimension1Value
dimension1Value string
Dimension2Value
dimension2Value string
Dimension3Value
dimension3Value string
VatRate
vatRate double
VatAmount
vatAmount double
VatCode
vatCode string
NetAmount
netAmount double
Etiquetas
tags array of string
SourceId
sourceId string
SourceTags
sourceTags array of string
Anotações
notes string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Favorite
favorite boolean
UserId
userId string
InvoiceUrl
invoiceUrl string
Notificar
notify string
Notificado
notified array of string
Nome
name string
Value
value
ShippingLine
shippingLine
ID do Produto
productId string
ProductVariantId
productVariantId string
Título do Produto
productTitle string
Quantidade
quantity double
VatCode
vatCode string
ImageLink
imageLink string
ProductAlias
productAlias string
ID
id string
NetValue
netValue double
VatValue
vatValue double
Pagamento
payment
Identificação da série
seriesId string

Criação de produto

Criar produto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
Link
link string
Cargo
position integer
Alt
alt string
Tipo de Mídia
mediaType string
GalleryId
galleryId string
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Tradução
translation
ID
id string
Title
title string
Gtin
gtin string
Mpn
mpn string
PreçoUnitário
unitPrice double
Preço
price double
Msrp
msrp double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
Peso de remessa
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Tradução
translation
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
MediaItem
mediaItem
Dimensão 1
dimension1
Dimensão 2
dimension2
Dimensão3
dimension3
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
Subtítulo
subTitle string
Description
description string
Alias
alias string
Situação
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
PathCategories
pathCategories array of string
Disponibilidade
availability string
Tradução
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Nome
name string
Value
value
Tradução
translation
AttributeSetId
attributeSetId string
Data de classificação
sortDate date-time
Sortimentos
assortments array of string
Identificação mestre
masterId string
Tamanho1
size1 double
Tamanho2
size2 double
Tamanho3
size3 double
Tamanho4
size4 double
Tamanho5
size5 double
Tamanho6
size6 double
Priority
priority integer
Data1
date1 date-time
Data2
date2 date-time
Data3
date3 date-time

Retornos

Corpo
ProductDTO

Criação de produtos relacionados

Criar produtos relacionados

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do produto
productId True string

Definir a ID do produto

ID da variante
variantId True string

Definir a ID da variante

Retornos

Criação de rótulo de produto

Criar rótulo de produto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Nome
name string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Ícone
icon string
BackgroundColor
backgroundColor string
TextColor
textColor string
ProductIds
productIds array of string
RuleEnabled
ruleEnabled boolean
DateFrom
dateFrom date-time
DateTo
dateTo date-time
Mode
mode string
Situação
status string
Regra
rule
Tradução
translation

Retornos

Corpo
IcoTagDTO

Criação de unidade

Criar unidade

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Code
code True string
Nome
name True string
Tradução
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Retornos

Corpo
UnitDTO

Criação do cliente

Criar um cliente

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Code
code string
Nome
name string
Estanho
tin string
Email
email string
Contato
contact string
ContactPhone
contactPhone string
Telefone
phone string
PriceCategoryId
priceCategoryId string
SourceId
sourceId string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
Endereço
address
Anotações
notes string
Situação
status string
ID
id string
SourceId
sourceId string
Code
code string
Nome
name string
Contato
contact string
ContactPhone
contactPhone string
Telefone
phone string
Endereço
address
Situação
status string
AdditionalFeatures
additionalFeatures
Nome
name string
Value
value
Tradução
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SalesmanId
salesmanId string
TaxOffice
taxOffice string
ContactLanguage
contactLanguage string
VatType
vatType string
ShopType
shopType string
Nome
name string
Endereço
address

Retornos

Corpo
CustomerDTO

Disponibilidade de estoque de reserva de inventário

Reservar disponibilidade de estoque

Parâmetros

Nome Chave Obrigatório Tipo Description
Símbolo
token string
ID do Produto
productId string
ProductVariantId
productVariantId string
Quantidade
quantity double

Retornos

Disponibilidade de estoque de verificação de inventário

Verificar a disponibilidade do estoque

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Produto
productId string
ProductVariantId
productVariantId string
Quantidade
quantity double

Retornos

Disponibilidade de estoques não reservados de inventário

Cancelar a reserva de disponibilidade de estoque

Parâmetros

Nome Chave Obrigatório Tipo Description
Símbolo
token True string

Cancelar a reserva de disponibilidade de estoque por token

Retornos

Excluir Conteúdo Adicional da Coleção

Excluir conteúdo adicional por ID da coleção

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da coleção
collectionId True string

Definir a ID da coleção

Excluir Conteúdo Adicional da Marca

Excluir conteúdo adicional por ID da marca

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da marca
brandId True string

Definir a ID da marca

Excluir Conteúdo Adicional de Categoria

Excluir conteúdo adicional por ID de categoria

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da categoria
categoryId True string

Definir a ID da categoria

Excluir Conteúdo Adicional de Exclusão de Produto

Excluir conteúdo adicional por ID do produto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do produto
productId True string

Definir a ID do produto

Exclusão da Lista de Compras

Excluir uma lista de compras por alias

Parâmetros

Nome Chave Obrigatório Tipo Description
Alias
alias True string

Obter uma lista de compras por alias

Exclusão de atributo

Excluir atributo

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do atributo

Exclusão de categoria

Excluir categoria

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID da categoria

Exclusão de coleção

Excluir coleção

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da coleção
collectionId True string

Definir a ID da coleção

Exclusão de disponibilidade de estoque

Excluir disponibilidade de estoque por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID da disponibilidade do estoque

Exclusão de grupo de privacidade

Excluir grupo de privacidade por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do grupo de privacidade

Exclusão de localização

Excluir um local por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da localização
locationId True string

Excluir um local por ID

Exclusão de marca

Excluir marca

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da marca
brandId True string

Definir a ID da marca

Exclusão de pedidos

Excluir um pedido por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Excluir um pedido por ID

Exclusão de produtos relacionados

Excluir produtos relacionados

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do produto
productId True string

Definir a ID do produto

ID da variante
variantId True string

Definir a ID da variante

Exclusão de sortimento

Excluir uma variedade por ID do cliente

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerId True string

Excluir uma variedade por ID do cliente

Exclusão de unidade

Excluir unidade por id

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID da unidade

Exclusão de valor de sortimento por ID do cliente e ID de sortimento

Excluir valores de sortimento por ID do cliente e ID de sortimento

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerid True string

Excluir valores de sortimento por ID do cliente e ID de sortimento

ID
id string

Excluir valores de sortimento por id

Exclusão do carrinho

Excluir Carrinho por token

Parâmetros

Nome Chave Obrigatório Tipo Description
símbolo
token True string

Excluir Carrinho por token

Exclusão do cliente

Excluir um cliente por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerId True string

Excluir um cliente por ID

Exclusão do conjunto de atributos

Excluir conjunto de atributos

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do conjunto de atributos

Exclusão do Grupo de Clientes

Excluir um grupo de clientes por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
Id True string

Excluir um grupo de clientes por ID

Exclusão do nível de inventário

Excluir um nível de inventário por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Excluir um nível de inventário por ID

Exclusão do produto

Excluir produto por id

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do produto

Exclusão do rótulo do produto

Excluir rótulo do produto por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do rótulo do produto

ID de Obtenção de Atributo por

Obter atributo por id

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do atributo

Retornos

Corpo
AttributeDTO

ID de Obtenção de Categoria por

Obter categoria por id

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID da categoria

Retornos

Corpo
CategoryDTO

ID de Obtenção de Cliente

Obter um cliente por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerId True string

Obter um cliente por ID

Retornos

Corpo
CustomerDTO

ID de Obtenção de Grupo de Privacidade

Obter grupo de privacidade por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do grupo de privacidade

Retornos

ID de Obtenção de Localização

Obter um local por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da localização
locationId True string

Obter um local por ID

Retornos

Corpo
LocationDTO

ID de obtenção de nível de inventário

Obter um nível de inventário por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Obter um nível de inventário por ID

Retornos

ID de Obtenção de Pedidos

Obter um pedido por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Obter um pedido por ID

Retornos

Corpo
OrderDTO

ID de Obtenção de Produto por

Obter o produto por id

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do produto

Retornos

Corpo
ProductDTO

ID de Obtenção de Rótulo do Produto

Obter o rótulo do produto por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do rótulo do produto

Retornos

Corpo
IcoTagDTO

ID de Obtenção de Unidade por

Obter unidade por id

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID da unidade

Retornos

Corpo
UnitDTO

ID de Obtenção por Grupo de Clientes

Obter um grupo de clientes por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
Id True string

Obter um grupo de clientes por ID

Retornos

ID do cliente do grupo de clientes Get by Customer

Obter um grupo de clientes por ID do cliente

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerId string

Obter um grupo de clientes por ID do cliente

Retornos

ID get by do conjunto de atributos

Obter o atributo definido por id

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID do conjunto de atributos

Retornos

ID get by variant do nível de inventário

Obter um nível de inventário por ID variante

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da variante
variantId True string

Obter um nível de inventário por ID variante

Retornos

Importação de atributos

Importar atributos

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Nome
name True string
Code
code True string
Description
description string
UsedAsFilter
usedAsFilter boolean
DisplayOnProduct
displayOnProduct boolean
DisplayOnList
displayOnList boolean
DisplayOnCompare
displayOnCompare boolean
Tipo
type string
Slug
slug string
Cargo
position integer
Situação
status string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
ID
id string
Code
code string
ColorCode
colorCode string
Value
value string
Cargo
position integer
Slug
slug string
Tradução
translation
Tradução
translation

Importação de Categoria

Importar categorias

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Title
title True string
Code
code True string
Alias
alias string
Description
description string
Cargo
position integer
DisplayInMenu
displayInMenu boolean
DisplayAsList
displayAsList boolean
ParentId
parentId string
Caminho
path string
MediaItem
mediaItem
Tradução
translation
SeoTitle
seoTitle string
SeoDescription
seoDescription string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
TreeIds
treeIds array of string
Link
link string
Situação
status string

Importação de Marca

Importar marcas

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Code
code True string
Nome
name True string
Alias
alias string
Description
description string
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
Situação
status string
MetaKeywords
metaKeywords array of string
MediaItem
mediaItem
Tradução
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SeoTitle
seoTitle string
SeoDescription
seoDescription string

Importação de marca por código

Importar marcas por códigos

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Code
code True string
Nome
name True string
Alias
alias string
Description
description string
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
Situação
status string
MetaKeywords
metaKeywords array of string
MediaItem
mediaItem
Tradução
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SeoTitle
seoTitle string
SeoDescription
seoDescription string

Importação de nível de inventário

Importar níveis de inventário

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
ProductVariantId
productVariantId string
ID do Produto
productId string
CompanyId
companyId string
LocationId
locationId string
Quantidade
quantity double
DeliveryDate
deliveryDate date-time
ExpectedQuantity
expectedQuantity double
UpdateDate
updateDate date-time

Importação de Pedidos

Importar pedidos

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
Code
code string
CompanyId
companyId string
CheckoutToken
checkoutToken string
CartToken
cartToken string
Situação
status string
Id do Cliente
customerId string
CustomerBranchId
customerBranchId string
CustomerBranchSourceId
customerBranchSourceId string
CustomerTin
customerTin string
Nome do Cliente
customerName string
CustomerCode
customerCode string
CustomerSourceId
customerSourceId string
CustomerBranchName
customerBranchName string
Moeda
currency string
CancelledAt
cancelledAt date-time
DeliveryDate
deliveryDate date-time
CancellationReason
cancellationReason string
ClosedAt
closedAt date-time
ReferenceCode
referenceCode string
Taxa de Descontos
discountRate double
DiscountValue
discountValue double
TotalAmount
totalAmount double
NetAmount
netAmount double
VatAmount
vatAmount double
ExpenseAmount
expenseAmount double
FinancialStatus
financialStatus string
FulfillmentStatus
fulfillmentStatus string
BillingAddress
billingAddress
ShippingAddress
shippingAddress
RequiresCalculation
requiresCalculation boolean
ID
id string
ID do Produto
productId string
ProductVariantId
productVariantId string
Título do Produto
productTitle string
UnitId
unitId string
SalesUnitId
salesUnitId string
Quantidade
quantity double
UnitQuantity
unitQuantity double
NetValue
netValue double
Preço
price double
ExpenseValue
expenseValue double
PriceValue1
priceValue1 double
PriceValue2
priceValue2 double
PriceValue3
priceValue3 double
PreçoUnitário
unitPrice double
LineValue
lineValue double
DiscountValue
discountValue double
Taxa de Descontos
discountRate double
VatValue
vatValue double
VatRate
vatRate double
VatCode
vatCode string
Sku
sku string
Dimension1Caption
dimension1Caption string
Dimension2Caption
dimension2Caption string
Dimension3Caption
dimension3Caption string
Dimension1Value
dimension1Value string
Dimension2Value
dimension2Value string
Dimension3Value
dimension3Value string
VatRate
vatRate double
VatAmount
vatAmount double
VatCode
vatCode string
NetAmount
netAmount double
Etiquetas
tags array of string
SourceId
sourceId string
SourceTags
sourceTags array of string
Anotações
notes string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Favorite
favorite boolean
UserId
userId string
InvoiceUrl
invoiceUrl string
Notificar
notify string
Notificado
notified array of string
Nome
name string
Value
value
ShippingLine
shippingLine
ID do Produto
productId string
ProductVariantId
productVariantId string
Título do Produto
productTitle string
Quantidade
quantity double
VatCode
vatCode string
ImageLink
imageLink string
ProductAlias
productAlias string
ID
id string
NetValue
netValue double
VatValue
vatValue double
Pagamento
payment
Identificação da série
seriesId string

Importação de produto de marca de origem

Importar produtos de marca de origem

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
Nome
name string

Importação de produto por SKU

Importar produtos por SKU

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CategoryCode
categoryCode string
ID
id string
Link
link string
Cargo
position integer
Alt
alt string
Tipo de Mídia
mediaType string
GalleryId
galleryId string
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Tradução
translation
ID
id string
Title
title string
Gtin
gtin string
Mpn
mpn string
PreçoUnitário
unitPrice double
Preço
price double
Msrp
msrp double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
Peso de remessa
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Tradução
translation
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
MediaItem
mediaItem
Dimensão 1
dimension1
Dimensão 2
dimension2
Dimensão3
dimension3
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
Subtítulo
subTitle string
Description
description string
Alias
alias string
Situação
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
PathCategories
pathCategories array of string
Disponibilidade
availability string
Tradução
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Nome
name string
Value
value
Tradução
translation
AttributeSetId
attributeSetId string
Data de classificação
sortDate date-time
Sortimentos
assortments array of string
Identificação mestre
masterId string
Tamanho1
size1 double
Tamanho2
size2 double
Tamanho3
size3 double
Tamanho4
size4 double
Tamanho5
size5 double
Tamanho6
size6 double
Priority
priority integer
Data1
date1 date-time
Data2
date2 date-time
Data3
date3 date-time

Importação de produtos

Importar produtos

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CategoryCode
categoryCode string
ID
id string
Link
link string
Cargo
position integer
Alt
alt string
Tipo de Mídia
mediaType string
GalleryId
galleryId string
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Tradução
translation
ID
id string
Title
title string
Gtin
gtin string
Mpn
mpn string
PreçoUnitário
unitPrice double
Preço
price double
Msrp
msrp double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
Peso de remessa
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Tradução
translation
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double
MediaItem
mediaItem
Dimensão 1
dimension1
Dimensão 2
dimension2
Dimensão3
dimension3
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
Subtítulo
subTitle string
Description
description string
Alias
alias string
Situação
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
PathCategories
pathCategories array of string
Disponibilidade
availability string
Tradução
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Nome
name string
Value
value
Tradução
translation
AttributeSetId
attributeSetId string
Data de classificação
sortDate date-time
Sortimentos
assortments array of string
Identificação mestre
masterId string
Tamanho1
size1 double
Tamanho2
size2 double
Tamanho3
size3 double
Tamanho4
size4 double
Tamanho5
size5 double
Tamanho6
size6 double
Priority
priority integer
Data1
date1 date-time
Data2
date2 date-time
Data3
date3 date-time

Importação de unidade

Importar unidades

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Code
code True string
Nome
name True string
Tradução
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Importação do cliente

Importar clientes

Parâmetros

Nome Chave Obrigatório Tipo Description
Address1
address1 string
Address2
address2 string
City
city string
Estado
state string
País
country string
Código do País
countryCode string
Código Postal
postalCode string
ID
id string
SourceId
sourceId string
Code
code string
Nome
name string
Contato
contact string
ContactPhone
contactPhone string
Telefone
phone string
Endereço
address
VatType
vatType string
Situação
status string
ContactLanguage
contactLanguage string
Address1
address1 string
Address2
address2 string
City
city string
Estado
state string
País
country string
Código do País
countryCode string
Código Postal
postalCode string
ID
id string
CompanyId
companyId string
Code
code string
Nome
name string
Estanho
tin string
Email
email string
Contato
contact string
ContactPhone
contactPhone string
Telefone
phone string
PriceCategoryId
priceCategoryId string
SourceId
sourceId string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
Endereço
address
Anotações
notes string
Situação
status string
AdditionalFeatures
additionalFeatures
Nome
name string
Value
value
Tradução
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SalesmanId
salesmanId string
TaxOffice
taxOffice string
ContactLanguage
contactLanguage string
VatType
vatType string
ShopType
shopType string
Nome
name string
Endereço
address

Importação do conjunto de atributos

Importar conjuntos de atributos

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string
CompanyId
companyId string
Title
title string
Description
description string
Title
title string
ID
id string
Cargo
position integer
ID
id string
Cargo
position integer
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

Limpeza de Filtros

Limpar filtros

Lista de Compras Obter Tudo

Obter todas as listas de compras

Retornos

Obtenção de Disponibilidade de Estoque por ID

Obter disponibilidade de estoque por ID

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Definir a ID da disponibilidade do estoque

Retornos

Obtenção de marca por ID

Obter marca por id

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da marca
brandId True string

Definir a ID da marca

Retornos

Corpo
BrandDTO

Obtenção de produto por alias

Obter o produto por alias

Parâmetros

Nome Chave Obrigatório Tipo Description
Alias
alias True string

Definir o alias do produto

Retornos

Corpo
ProductDTO

Obtenção de sortimento por ID do cliente

Obter uma variedade por ID do cliente

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerId True string

Obter uma variedade por ID do cliente

Retornos

Obtenção estendida da coleção por Alias

Obter coleção estendida por alias

Parâmetros

Nome Chave Obrigatório Tipo Description
Linguagem
lang string

Definir o idioma

Alias
alias True string

Definir o alias da coleção

Retornos

Obtenção estendida da coleção por Id

Obter coleção estendida por id

Parâmetros

Nome Chave Obrigatório Tipo Description
Linguagem
lang string

Definir o idioma

ID
id True string

Definir a ID da coleção

Retornos

Obtenção estendida do produto pelo Alias

Obter produto estendido por alias

Parâmetros

Nome Chave Obrigatório Tipo Description
Linguagem
lang string

Definir o idioma

Extend
extend string

Definir os campos a serem estendidos

Alias
alias True string

Definir o alias do produto

Retornos

Obter conteúdo adicional por ID (HTML) da marca

Obter conteúdo adicional por ID da marca

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da marca
brandId True string

Definir a ID da marca

Retornos

Obter conteúdo adicional por ID (HTML) do produto

Obter conteúdo adicional por ID do produto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do produto
productId True string

Definir a ID do produto

Retornos

Obter conteúdo adicional por ID da marca

Obter conteúdo adicional por ID da marca

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da marca
brandId True string

Definir a ID da marca

Retornos

Obter conteúdo adicional por ID do produto

Obter conteúdo adicional por ID do produto

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do produto
productId True string

Definir a ID do produto

Retornos

Obter lista de compras por alias

Obter uma lista de compras por alias

Parâmetros

Nome Chave Obrigatório Tipo Description
Alias
alias True string

Alias

Retornos

Obter marca por Alias

Obter marca por alias

Parâmetros

Nome Chave Obrigatório Tipo Description
Alias de marca
brandAlias True string

Definir o alias da marca

Retornos

Corpo
BrandDTO

Obter por código de atributo

Obter atributo por código

Parâmetros

Nome Chave Obrigatório Tipo Description
Code
code True string

Definir o código do atributo

Retornos

Corpo
AttributeDTO

Obter por token de check-out

Obter um check-out por token

Parâmetros

Nome Chave Obrigatório Tipo Description
Símbolo
token True string

Obter um check-out por token

Retornos

Corpo
CheckoutDTO

Obter por token do carrinho

Obter Carrinho por token

Parâmetros

Nome Chave Obrigatório Tipo Description
símbolo
token True string

Obter Carrinho por token

Retornos

Corpo
CartDTO

Obter todas as variantes de produto simples

Obter todas as variantes de produto simples

Parâmetros

Nome Chave Obrigatório Tipo Description
Preço
Price string

Definir o preço

Preço Máximo
MaxPrice double

Definir o preço máximo

Tamanho 1
Size1 string

Definir o tamanho 1

Tamanho 2
Size2 string

Definir o tamanho 2

Tamanho 3
Size3 string

Definir o tamanho 3

Inserir Data
InsertDate string

Definir a data de inserção

Data 1
Date1 string

Definir a data 1

Data 2
Date2 string

Definir a data 2

Data 3
Date3 string

Definir a data 3

Intervalo de datas da data 1
Date1DateRange string

Definir o intervalo de datas 1

Intervalo de datas da data 2
Date2DateRange string

Definir o intervalo de datas 2

Intervalo de datas da data 3
Date3DateRange string

Definir o intervalo de datas 3

Inserir Intervalo de Datas
InsertDateRange string

Definir o intervalo de datas de inserção

Pesquisa
Search string

Definir a pesquisa

Preço Mínimo
MinPrice double

Definir o preço mínimo

Situação
Status string

Definir o status

Disponibilidade
Availability string

Definir a disponibilidade

Etiqueta
Tag string

Definir a marca

Marca de origem
SourceTag string

Definir a marca de origem

Regra de privacidade
PrivacyRule string

Definir a regra de privacidade

Regra
Rule string

Definir a regra

Condição
Condition string

Definir a condição

Ids
Ids string

Definir as IDs

ID
Id string

Definir a ID

Preço
PriceRange string

Definir a faixa de preço

Código de marca
BrandCode string

Definir o código da marca

ID da marca
BrandId string

Definir a ID da marca

Attribute
Attribute string

Definir o atributo

Categoria de caminho
PathCategory string

Definir a categoria de caminho

ID da categoria
CategoryId string

Definir a ID da categoria

ID de categoria adicional
AdditionalCategoryId string

Definir a ID de categoria adicional

ID de Disponibilidade de Estoque
StockAvailabilityId string

Definir a ID de disponibilidade de estoque

ID do conjunto de atributos
AttributeSetId string

Definir a ID do conjunto de atributos

ID da categoria de preço
PriceCategoryId string

Definir a ID da categoria de preço

Tem mídia
HasMedia boolean

Definir a mídia has

ID mestra
MasterId string

Definir a ID mestra

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Obter todos os locais

Obter todos os locais

Retornos

Pagamento completo do check-out

Concluir um pagamento para um check-out por token

Parâmetros

Nome Chave Obrigatório Tipo Description
Símbolo
token True string

Concluir um pagamento para um check-out por token

ID
id string
CompanyId
companyId string
Id do Cliente
customerId string
CheckoutToken
checkoutToken string
Quantidade
amount double
CommissionAmount
commissionAmount double
RemittanceInformation
remittanceInformation string
Fornecedor
provider string
Situação
status string
PaymentDate
paymentDate date-time
CreationDate
creationDate date-time
ApprovalCode
approvalCode string
CardType
cardType string
CardNumber
cardNumber string
PostDating
postDating integer
Parcelas
installments integer
BankId
bankId string
TransactionId
transactionId string

Retornos

Corpo
CheckoutDTO

Pagamento de Início do Checkout

Iniciar um pagamento para um check-out por token

Parâmetros

Nome Chave Obrigatório Tipo Description
Símbolo
token True string

Iniciar um pagamento para um check-out por token

ProviderId
providerId True string

Definir um provedor de pagamento para um check-out por token

Retornos

Corpo
CheckoutDTO

Recálculo de check-out

Recalcular um check-out por token

Parâmetros

Nome Chave Obrigatório Tipo Description
Símbolo
token True string

Recalcular um check-out por token

Linguagem
lang string

Linguagem

Retornos

Corpo
CheckoutDTO

Remover produto do carrinho

Remover produto do carrinho

Parâmetros

Nome Chave Obrigatório Tipo Description
símbolo
token True string

Obter Carrinho por token

productVariantId
productVariantId True string

Obter Carrinho por token

Valores de sortimento acrescentados por ID do cliente

Acrescentar valores de sortimento por ID do cliente

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerid True string

Acrescentar valores de sortimento por ID do cliente

ID do Produto
productId string
CategoryId
categoryId string
TypeId
typeId string
Situação
status string
Source
source string

Retornos

Valores de sortimento atualizados por ID do cliente e ID de sortimento

Atualizar valores de sortimento por ID do cliente e ID de sortimento

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id True string

Atualizar valores de sortimento por id

ID do cliente
customerId True string

Atualizar valores de sortimento por ID do cliente e ID de sortimento

Situação
status string

Valores de sortimento excluídos por ID de origem do cliente

Excluir valores de sortimento por ID do cliente e origem

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerid True string

Excluir valores de sortimento por ID do cliente e origem

Source
source True string

Excluir valores de sortimento por origem

Valores de sortimento excluídos por ID do cliente

Excluir valores de sortimento por ID do cliente

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerid True string

Excluir valores de sortimento por ID do cliente

Valores de sortimento obtidos pela ID do cliente

Obter valores de sortimento por ID do cliente

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerid True string

Obter valores de sortimento por ID do cliente

Situação
Status string

Obter valores de sortimento por status

Source
Source string

Obter valores de sortimento por origem

Tipo
Type string

Obter valores de sortimento por tipo

Categoria
Category string

Obter valores de sortimento por categoria

ID
Id string

Obter valores de sortimento por id

ID do produto
ProductId string

Obter valores de sortimento por ID do produto

Página
Page integer

Definir o número da página

Tamanho da Página
PageSize integer

Definir o tamanho da página

Classificar
Sort string

Definir o campo de classificação e a direção

Retornos

Valores de variedade recriam por ID do cliente

Recompilar valores de sortimento por ID do cliente

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do cliente
customerId True string

Recompilar valores de sortimento por ID do cliente

Gatilhos

Quando um atributo é atualizado

Essa operação é disparada quando um atributo é atualizado

Quando um atributo é criado

Essa operação é disparada quando um novo atributo é criado

Quando um Attibute é excluído

Essa operação é disparada quando um atributo é excluído

Quando um AttibuteSet é excluído

Essa operação é disparada quando um attributeSet é excluído

Quando um AttributeSet é atualizado

Essa operação é disparada quando um attributeSet é atualizado

Quando um AttributeSet é criado

Essa operação é disparada quando um novo attributeSet é criado

Quando um check-out é concluído

Essa operação é disparada quando um produto é atualizado

Quando um check-out é criado

Essa operação é disparada quando um novo check-out é criado

Quando um cliente é atualizado

Essa operação é disparada quando um cliente é atualizado

Quando um cliente é criado

Essa operação é disparada quando um novo Cliente é criado

Quando um cliente é excluído

Essa operação é disparada quando um Cliente é excluído

Quando um nível de inventário é atualizado

Essa operação é disparada quando um nível de inventário é atualizado

Quando um nível de inventário é criado

Essa operação é disparada quando um novo nível de inventário é criado

Quando um nível de inventário é excluído

Essa operação é disparada quando um nível de inventário é excluído

Quando um pagamento é concluído

Essa operação é disparada quando um pagamento é excluído

Quando um pagamento é iniciado

Essa operação é disparada quando um pagamento é iniciado

Quando um pedido é atualizado

Essa operação é disparada quando um pedido é atualizado

Quando um produto é atualizado

Essa operação é disparada quando um produto é atualizado

Quando um produto é criado

Essa operação é disparada quando um novo produto é criado

Quando um produto é excluído

Essa operação é disparada quando um produto é excluído

Quando uma categoria é atualizada

Essa operação é disparada quando uma categoria é atualizada

Quando uma categoria é criada

Essa operação é disparada quando uma nova categoria é criada

Quando uma categoria é excluída

Essa operação é disparada quando um produto é excluído

Quando uma marca é atualizada

Essa operação é disparada quando uma marca é atualizada

Quando uma marca é criada

Essa operação é disparada quando uma nova marca é criada

Quando uma marca é excluída

Essa operação é disparada quando uma marca é excluída

Quando uma ordem é criada

Essa operação é disparada quando uma nova ordem é criada

Quando uma ordem é excluída

Essa operação é disparada quando um pedido é excluído

Quando uma unidade é atualizada

Essa operação é disparada quando uma unidade é atualizada

Quando uma unidade é criada

Essa operação é disparada quando uma nova unidade é criada

Quando uma unidade é excluída

Essa operação é disparada quando uma unidade é excluída

Quando um atributo é atualizado

Essa operação é disparada quando um atributo é atualizado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
AttributeDTO

Quando um atributo é criado

Essa operação é disparada quando um novo atributo é criado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
AttributeDTO

Quando um Attibute é excluído

Essa operação é disparada quando um atributo é excluído

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
AttributeDTO

Quando um AttibuteSet é excluído

Essa operação é disparada quando um attributeSet é excluído

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Quando um AttributeSet é atualizado

Essa operação é disparada quando um attributeSet é atualizado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Quando um AttributeSet é criado

Essa operação é disparada quando um novo attributeSet é criado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Quando um check-out é concluído

Essa operação é disparada quando um produto é atualizado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
CheckoutDTO

Quando um check-out é criado

Essa operação é disparada quando um novo check-out é criado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
CheckoutDTO

Quando um cliente é atualizado

Essa operação é disparada quando um cliente é atualizado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
CustomerDTO

Quando um cliente é criado

Essa operação é disparada quando um novo Cliente é criado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
CustomerDTO

Quando um cliente é excluído

Essa operação é disparada quando um Cliente é excluído

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
CustomerDTO

Quando um nível de inventário é atualizado

Essa operação é disparada quando um nível de inventário é atualizado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Quando um nível de inventário é criado

Essa operação é disparada quando um novo nível de inventário é criado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Quando um nível de inventário é excluído

Essa operação é disparada quando um nível de inventário é excluído

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Quando um pagamento é concluído

Essa operação é disparada quando um pagamento é excluído

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
PaymentDTO

Quando um pagamento é iniciado

Essa operação é disparada quando um pagamento é iniciado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
PaymentDTO

Quando um pedido é atualizado

Essa operação é disparada quando um pedido é atualizado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
OrderDTO

Quando um produto é atualizado

Essa operação é disparada quando um produto é atualizado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
ProductDTO

Quando um produto é criado

Essa operação é disparada quando um novo produto é criado

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
ProductDTO

Quando um produto é excluído

Essa operação é disparada quando um produto é excluído

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
ProductDTO

Quando uma categoria é atualizada

Essa operação é disparada quando uma categoria é atualizada

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
CategoryDTO

Quando uma categoria é criada

Essa operação é disparada quando uma nova categoria é criada

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
CategoryDTO

Quando uma categoria é excluída

Essa operação é disparada quando um produto é excluído

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
CategoryDTO

Quando uma marca é atualizada

Essa operação é disparada quando uma marca é atualizada

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
BrandDTO

Quando uma marca é criada

Essa operação é disparada quando uma nova marca é criada

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
BrandDTO

Quando uma marca é excluída

Essa operação é disparada quando uma marca é excluída

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
BrandDTO

Quando uma ordem é criada

Essa operação é disparada quando uma nova ordem é criada

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
OrderDTO

Quando uma ordem é excluída

Essa operação é disparada quando um pedido é excluído

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
OrderDTO

Quando uma unidade é atualizada

Essa operação é disparada quando uma unidade é atualizada

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
UnitDTO

Quando uma unidade é criada

Essa operação é disparada quando uma nova unidade é criada

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
UnitDTO

Quando uma unidade é excluída

Essa operação é disparada quando uma unidade é excluída

Parâmetros

Nome Chave Obrigatório Tipo Description
Title
Title True string

Title

Retornos

Corpo
UnitDTO

Definições

AttributeDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Nome
name string
Code
code string
Description
description string
UsedAsFilter
usedAsFilter boolean
DisplayOnProduct
displayOnProduct boolean
DisplayOnList
displayOnList boolean
DisplayOnCompare
displayOnCompare boolean
Tipo
type string
Slug
slug string
Cargo
position integer
Situação
status string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Itens
items array of AttributeItemDTO
Tradução
translation

AttributeItemDTO

Nome Caminho Tipo Description
ID
id string
Code
code string
ColorCode
colorCode string
Value
value string
Cargo
position integer
Slug
slug string
Tradução
translation

AttributeSetDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Title
title string
Description
description string
Groups
groups array of AttributeSetGroupDTO
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

AttributeSetGroupDTO

Nome Caminho Tipo Description
Title
title string
ID
id string
Cargo
position integer
Itens
items array of AttributeSetItemDTO

AttributeSetItemDTO

Nome Caminho Tipo Description
ID
id string
Cargo
position integer

BrandDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Code
code string
Nome
name string
Alias
alias string
Description
description string
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
Situação
status string
MetaKeywords
metaKeywords array of string
MediaItem
mediaItem
Tradução
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SeoTitle
seoTitle string
SeoDescription
seoDescription string

CategoryDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Title
title string
Code
code string
Alias
alias string
Description
description string
Cargo
position integer
DisplayInMenu
displayInMenu boolean
DisplayAsList
displayAsList boolean
ParentId
parentId string
Caminho
path string
MediaItem
mediaItem
Tradução
translation
SeoTitle
seoTitle string
SeoDescription
seoDescription string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
TreeIds
treeIds array of string
Link
link string
Situação
status string

CollectionDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Title
title string
Description
description string
DescriptionHtml
descriptionHtml string
Link
link string
Alias
alias string
MediaItem
mediaItem
Situação
status string
Mode
mode string
PublishedAt
publishedAt date-time
SortOrder
sortOrder string
ContagemDeProdutos
productCount integer
ProductIds
productIds array of string
Products
products array of ProductDTO
SubColleções
subCollections array of CollectionDTO
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Etiquetas
tags array of string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
Tradução
translation
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string

DocumentationDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Linhas
lines array of DocumentationLineDTO

DocumentationLineDTO

Nome Caminho Tipo Description
ID
id string
Title
title string
Description
description string
Cargo
position integer
MediaItem
mediaItem
Tradução
translation

ExtendedProductDTO

Nome Caminho Tipo Description
ProductVariants
productVariants array of ProductVariantExtendedDTO
Attributes
attributes array of ProductAttributeExtendedDTO
AttributeSet
attributeSet
IcoTags
icoTags array of ProductIcoTagExtendedDTO
ExtraFields
extraFields
Dimensão 1
dimension1
Dimensão 2
dimension2
Dimensão3
dimension3
ID
id string
CompanyId
companyId string
DescriptionPlain
descriptionPlain string
Link
link string
MediaItems
mediaItems array of MediaItemDTO
MaxPrice
maxPrice double
MinPrice
minPrice double
PathCategories
pathCategories array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
VariantCount
variantCount integer
AdditionalFeatures
additionalFeatures
SearchAttributes
searchAttributes array of string
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
Subtítulo
subTitle string
Description
description string
Alias
alias string
Situação
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
Disponibilidade
availability string
Tradução
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Campos Personalizados
customFields array of ProductCustomFieldDTO
AttributeSetId
attributeSetId string
Data de classificação
sortDate date-time
Sortimentos
assortments array of string
Identificação mestre
masterId string
Tamanho1
size1 double
Tamanho2
size2 double
Tamanho3
size3 double
Tamanho4
size4 double
Tamanho5
size5 double
Tamanho6
size6 double
Priority
priority integer
Data1
date1 date-time
Data2
date2 date-time
Data3
date3 date-time

IcoTagDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Nome
name string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Ícone
icon string
BackgroundColor
backgroundColor string
TextColor
textColor string
ProductIds
productIds array of string
RuleEnabled
ruleEnabled boolean
DateFrom
dateFrom date-time
DateTo
dateTo date-time
Mode
mode string
Situação
status string
Regra
rule
Tradução
translation

MediaItemDTO

Nome Caminho Tipo Description
ID
id string
GalleryId
galleryId string
CompanyId
companyId string
Link
link string
Cargo
position integer
Alt
alt string
Tipo de Mídia
mediaType string
Largura
width integer
Altura
height integer

PrivacyGroupDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Title
title string
Situação
status string
Mode
mode string
ProductIds
productIds array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Regra
rule
CustomerGroupIds
customerGroupIds array of string
CustomerIds
customerIds array of string

ProductAttributeDTO

Nome Caminho Tipo Description
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Tradução
translation

ProductAttributeExtendedDTO

Nome Caminho Tipo Description
Nome
name string
Slug
slug string
Code
code string
UsedAsFilter
usedAsFilter boolean
DisplayOnProduct
displayOnProduct boolean
DisplayOnList
displayOnList boolean
DisplayOnCompare
displayOnCompare boolean
AttributeId
attributeId string
AttributeItemId
attributeItemId string
AttributeItemValue
attributeItemValue string
Tradução
translation

ProductCustomFieldDTO

Nome Caminho Tipo Description
Nome
name string
Value
value
Tradução
translation

ProductDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
DescriptionPlain
descriptionPlain string
Link
link string
MediaItems
mediaItems array of MediaItemDTO
ProductVariants
productVariants array of ProductVariantDTO
Attributes
attributes array of ProductAttributeDTO
MaxPrice
maxPrice double
MinPrice
minPrice double
PathCategories
pathCategories array of string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
VariantCount
variantCount integer
AdditionalFeatures
additionalFeatures
Dimensão 1
dimension1
Dimensão 2
dimension2
Dimensão3
dimension3
SearchAttributes
searchAttributes array of string
VatCode
vatCode string
ReducedVatCode
reducedVatCode string
VatRate
vatRate double
ReducedVatRate
reducedVatRate double
Title
title string
Subtítulo
subTitle string
Description
description string
Alias
alias string
Situação
status string
BrandId
brandId string
SeoTitle
seoTitle string
SeoDescription
seoDescription string
CategoryId
categoryId string
PriceCategoryId
priceCategoryId string
AdditionalCategoryIds
additionalCategoryIds array of string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
AdditionalSearchTags
additionalSearchTags array of string
Disponibilidade
availability string
Tradução
translation
StopOrder
stopOrder boolean
MetaTitle
metaTitle string
MetaDescrição
metaDescription string
MetaKeywords
metaKeywords array of string
StockAvailabilityModelId
stockAvailabilityModelId string
Campos Personalizados
customFields array of ProductCustomFieldDTO
AttributeSetId
attributeSetId string
Data de classificação
sortDate date-time
Sortimentos
assortments array of string
Identificação mestre
masterId string
Tamanho1
size1 double
Tamanho2
size2 double
Tamanho3
size3 double
Tamanho4
size4 double
Tamanho5
size5 double
Tamanho6
size6 double
Priority
priority integer
Data1
date1 date-time
Data2
date2 date-time
Data3
date3 date-time

ProductIcoTagExtendedDTO

Nome Caminho Tipo Description
ID
id string
Nome
name string
Ícone
icon string
BackgroundColor
backgroundColor string
TextColor
textColor string

ProductVariantDTO

Nome Caminho Tipo Description
ID
id string
ID do Produto
productId string
MediaItem
mediaItem
Title
title string
Gtin
gtin string
Mpn
mpn string
PreçoUnitário
unitPrice double
Preço
price double
Msrp
msrp double
Quantidade
quantity double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
Peso de remessa
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Tradução
translation
CanOrder
canOrder boolean
AdditionalFeatures
additionalFeatures
Esperado
expected
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double

ProductVariantExtendedDTO

Nome Caminho Tipo Description
StockAvailability
stockAvailability
ID
id string
ID do Produto
productId string
MediaItem
mediaItem
Title
title string
Gtin
gtin string
Mpn
mpn string
PreçoUnitário
unitPrice double
Preço
price double
Msrp
msrp double
Quantidade
quantity double
InitialPrice
initialPrice double
Dimension1ItemId
dimension1ItemId string
Dimension2ItemId
dimension2ItemId string
Dimension3ItemId
dimension3ItemId string
Peso de remessa
shippingWeight double
ShippingLength
shippingLength double
ShippingWidth
shippingWidth double
ShippingHeight
shippingHeight double
SellOutOfStock
sellOutOfStock boolean
MinimunStockLevel
minimunStockLevel double
UnitId
unitId string
SalesUnitId
salesUnitId string
SalesUnitCondition
salesUnitCondition double
RequiresShipping
requiresShipping boolean
Sku
sku string
Tradução
translation
CanOrder
canOrder boolean
AdditionalFeatures
additionalFeatures
Esperado
expected
MinOrderQuantity
minOrderQuantity double
OrderQuantityStep
orderQuantityStep double

RelatedProductVariantDTO

Nome Caminho Tipo Description
ID
id string
ID do Produto
productId string
CompanyId
companyId string
Dimension1ItemIds
dimension1ItemIds array of string
Dimension2ItemIds
dimension2ItemIds array of string
Dimension3ItemIds
dimension3ItemIds array of string

StockAvailabilityDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Code
code string
Title
title string
Tradução
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Linhas
lines array of StockAvailabilityLineDTO

StockAvailabilityLineDTO

Nome Caminho Tipo Description
MediaItem
mediaItem
Message
message string
Quantidade
quantity integer
Cor
color string
Tradução
translation

UnitDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Code
code string
Nome
name string
Tradução
translation
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

CartDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Símbolo
token string
Moeda
currency string
TotalAmount
totalAmount double
NetAmount
netAmount double
VatAmount
vatAmount double
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
CartItems
cartItems array of CartItemDTO

CartItemDTO

Nome Caminho Tipo Description
ID
id string
ID do Produto
productId string
Título do Produto
productTitle string
ProductVariantId
productVariantId string
Quantidade
quantity double
ImageLink
imageLink string
NetValue
netValue double
InitialUnitPrice
initialUnitPrice double
PreçoUnitário
unitPrice double
InitialPrice
initialPrice double
Preço
price double
LineValue
lineValue double
VatValue
vatValue double
VatRate
vatRate double
VatCode
vatCode string
Link
link string
Sku
sku string
OrderQuantityStep
orderQuantityStep double
SalesUnitId
salesUnitId string

ShoppingListDTO

Nome Caminho Tipo Description
ID
id string
Title
title string
CompanyId
companyId string
Id do Cliente
customerId string
UserId
userId string
Alias
alias string
InsertDate
insertDate date-time
UpdateDate
updateDate date-time
Itens
items array of ShoppingListItemDTO

ShoppingListItemDTO

Nome Caminho Tipo Description
ID do Produto
productId string
ProductVariantId
productVariantId string

CheckoutAddressDTO

Nome Caminho Tipo Description
ID
id string
Nome
name string
Endereço
address

OrderCustomFieldDTO

Nome Caminho Tipo Description
Nome
name string
Value
value

PaymentDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Id do Cliente
customerId string
CheckoutToken
checkoutToken string
Quantidade
amount double
CommissionAmount
commissionAmount double
RemittanceInformation
remittanceInformation string
Fornecedor
provider string
Situação
status string
PaymentDate
paymentDate date-time
CreationDate
creationDate date-time
ApprovalCode
approvalCode string
CardType
cardType string
CardNumber
cardNumber string
PostDating
postDating integer
Parcelas
installments integer
BankId
bankId string
TransactionId
transactionId string

CalculatedShippingDTO

Nome Caminho Tipo Description
Portador
carrier
ShippingLine
shippingLine

CheckoutDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Id do Cliente
customerId string
Nome do Cliente
customerName string
UserEmail
userEmail string
UserFirstName
userFirstName string
UserLastName
userLastName string
UserId
userId string
CustomerBranchId
customerBranchId string
CartToken
cartToken string
Símbolo
token string
ReferenceCode
referenceCode string
Anotações
notes string
Situação
status string
BillingAddress
billingAddress
ShippingAddress
shippingAddress
BuyerAcceptsMarketing
buyerAcceptsMarketing boolean
Email
email string
Telefone
phone string
Moeda
currency string
TotalAmount
totalAmount double
NetAmount
netAmount double
VatAmount
vatAmount double
ExpenseAmount
expenseAmount double
Taxa de Descontos
discountRate double
DiscountValue
discountValue double
CompletedDate
completedDate date-time
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
CartItems
cartItems array of CheckoutItemDTO
GiftLines
giftLines array of CheckoutGiftLineDTO
VatAnalysis
vatAnalysis array of VatAnalysisDTO
ExpenseLines
expenseLines array of ExpenseLineDTO
ShippingLine
shippingLine
Identificação do Pedido
orderId string
OrderCode
orderCode string
Pagamento
payment
Customer
customer
ShippingOptions
shippingOptions array of CalculatedShippingDTO
PaymentMethods
paymentMethods
Configurações
settings
Campos Personalizados
customFields array of OrderCustomFieldDTO
Addresses
addresses array of CheckoutAddressDTO
DeliveryDate
deliveryDate date-time

CheckoutGiftLineDTO

Nome Caminho Tipo Description
VatCode
vatCode string
ImageLink
imageLink string
Título do Produto
productTitle string
ProductAlias
productAlias string
ID do Produto
productId string
ProductVariantId
productVariantId string
Quantidade
quantity double

CheckoutItemDTO

Nome Caminho Tipo Description
ID
id string
ID do Produto
productId string
Título do Produto
productTitle string
ProductVariantId
productVariantId string
Quantidade
quantity double
Unidade
unit string
ImageLink
imageLink string
Cor
color string
Material
material string
Padrão
pattern string
Tamanho
size string
NetValue
netValue double
ExpenseValue
expenseValue double
InitialUnitPrice
initialUnitPrice double
PreçoUnitário
unitPrice double
InitialPrice
initialPrice double
Preço
price double
PriceValue1
priceValue1 double
PriceValue2
priceValue2 double
PriceValue3
priceValue3 double
LineValue
lineValue double
DiscountValue
discountValue double
Taxa de Descontos
discountRate double
VatValue
vatValue double
VatRate
vatRate double
VatCode
vatCode string
CustomDim1Value
customDim1Value string
CustomDim2Value
customDim2Value string
CustomDim3Value
customDim3Value string
Link
link string
Sku
sku string
SalesUnitId
salesUnitId string

CustomerBranchDTO

Nome Caminho Tipo Description
ID
id string
SourceId
sourceId string
Code
code string
Nome
name string
Contato
contact string
ContactPhone
contactPhone string
Telefone
phone string
Endereço
address
Situação
status string

CustomerShippingAddressDTO

Nome Caminho Tipo Description
Nome
name string
Endereço
address

ExpenseLineDTO

Nome Caminho Tipo Description
ID
id string
NetValue
netValue double
VatValue
vatValue double

VatAnalysisDTO

Nome Caminho Tipo Description
VatRate
vatRate double
VatAmount
vatAmount double
VatCode
vatCode string
NetAmount
netAmount double

AssortmentCombinationDTO

Nome Caminho Tipo Description
BranchId
branchId string
CategoryId
categoryId string
TypeId
typeId string

AssortmentDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Id do Cliente
customerId string
Categorias
categories array of CustomerCategoryDTO
Tipos
types array of CustomerTypeDTO
Combinações
combinations array of AssortmentCombinationDTO
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

AssortmentValueDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Id do Cliente
customerId string
ID do Produto
productId string
CategoryId
categoryId string
TypeId
typeId string
Situação
status string
Source
source string
InsertDate
insertDate date-time
UpdateDate
updateDate date-time

CustomerCategoryDTO

Nome Caminho Tipo Description
ID
id string
Nome
name string

CustomerCustomFieldDTO

Nome Caminho Tipo Description
Nome
name string
Value
value
Tradução
translation

CustomerDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Code
code string
Nome
name string
Estanho
tin string
Email
email string
Contato
contact string
ContactPhone
contactPhone string
Telefone
phone string
PriceCategoryId
priceCategoryId string
SourceId
sourceId string
Etiquetas
tags array of string
SourceTags
sourceTags array of string
Endereço
address
Anotações
notes string
Situação
status string
Ramificações
branches array of CustomerBranchDTO
AdditionalFeatures
additionalFeatures
Campos Personalizados
customFields array of CustomerCustomFieldDTO
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
SalesmanId
salesmanId string
TaxOffice
taxOffice string
ContactLanguage
contactLanguage string
VatType
vatType string
ShopType
shopType string
ShippingAddresses
shippingAddresses array of CustomerShippingAddressDTO

CustomerGroupDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Title
title string
Situação
status string
Regra
rule
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

CustomerTypeDTO

Nome Caminho Tipo Description
ID
id string
Nome
name string

ExpectedInventoryLineDTO

Nome Caminho Tipo Description
DeliveryDate
deliveryDate date-time
ExpectedQuantity
expectedQuantity double

InventoryLevelDTO

Nome Caminho Tipo Description
ID
id string
ProductVariantId
productVariantId string
ID do Produto
productId string
CompanyId
companyId string
LocationId
locationId string
Quantidade
quantity double
ExpectedInventoryLines
expectedInventoryLines array of ExpectedInventoryLineDTO
UpdateDate
updateDate date-time

LocationDTO

Nome Caminho Tipo Description
ID
id string
CompanyId
companyId string
Nome
name string
IsActive
isActive boolean
Endereço
address
Telefone
phone string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time

InventoryAvailabilityDTO

Nome Caminho Tipo Description
Símbolo
token string
Disponível
available boolean
Linhas
lines array of StockAvailabilityLineDTO

GiftLineDTO

Nome Caminho Tipo Description
ID do Produto
productId string
ProductVariantId
productVariantId string
Título do Produto
productTitle string
Quantidade
quantity double
VatCode
vatCode string
ImageLink
imageLink string
ProductAlias
productAlias string

OrderDTO

Nome Caminho Tipo Description
ID
id string
Code
code string
CompanyId
companyId string
CheckoutToken
checkoutToken string
CartToken
cartToken string
Situação
status string
Id do Cliente
customerId string
CustomerBranchId
customerBranchId string
CustomerBranchSourceId
customerBranchSourceId string
CustomerTin
customerTin string
Nome do Cliente
customerName string
CustomerCode
customerCode string
CustomerSourceId
customerSourceId string
CustomerBranchName
customerBranchName string
Moeda
currency string
CancelledAt
cancelledAt date-time
DeliveryDate
deliveryDate date-time
CancellationReason
cancellationReason string
ClosedAt
closedAt date-time
ReferenceCode
referenceCode string
Taxa de Descontos
discountRate double
DiscountValue
discountValue double
TotalAmount
totalAmount double
NetAmount
netAmount double
VatAmount
vatAmount double
ExpenseAmount
expenseAmount double
FinancialStatus
financialStatus string
FulfillmentStatus
fulfillmentStatus string
BillingAddress
billingAddress
ShippingAddress
shippingAddress
RequiresCalculation
requiresCalculation boolean
Linhas
lines array of OrderLineDTO
VatAnalysis
vatAnalysis array of VatAnalysisDTO
Etiquetas
tags array of string
SourceId
sourceId string
SourceTags
sourceTags array of string
Anotações
notes string
UpdateDate
updateDate date-time
InsertDate
insertDate date-time
Favorite
favorite boolean
UserId
userId string
InvoiceUrl
invoiceUrl string
Notificar
notify string
Notificado
notified array of string
Campos Personalizados
customFields array of OrderCustomFieldDTO
ShippingLine
shippingLine
GiftLines
giftLines array of GiftLineDTO
ExpenseLines
expenseLines array of ExpenseLineDTO
Pagamento
payment
Identificação da série
seriesId string

OrderLineDTO

Nome Caminho Tipo Description
ID
id string
ID do Produto
productId string
ProductVariantId
productVariantId string
Título do Produto
productTitle string
UnitId
unitId string
SalesUnitId
salesUnitId string
Quantidade
quantity double
UnitQuantity
unitQuantity double
NetValue
netValue double
Preço
price double
ExpenseValue
expenseValue double
PriceValue1
priceValue1 double
PriceValue2
priceValue2 double
PriceValue3
priceValue3 double
PreçoUnitário
unitPrice double
LineValue
lineValue double
DiscountValue
discountValue double
Taxa de Descontos
discountRate double
VatValue
vatValue double
VatRate
vatRate double
VatCode
vatCode string
Sku
sku string
Dimension1Caption
dimension1Caption string
Dimension2Caption
dimension2Caption string
Dimension3Caption
dimension3Caption string
Dimension1Value
dimension1Value string
Dimension2Value
dimension2Value string
Dimension3Value
dimension3Value string