Shopranos (Pré-visualização)
Eleve o seu negócio com a Shopranos, ligando o ERP ao eCommerce B2B. Acione notificações e simplifique aprovações sem esforço, aumentando a eficiência e o controle. Liberte as possibilidades de automação, impulsionando o sucesso através de uma integração perfeita.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Shopranos |
| URL | https://www.shopranos.eu |
| support@shopranos.eu |
| Metadados do conector | |
|---|---|
| Editora | SoftOne Tecnologias S.A |
| Sítio Web | https://www.shopranos.eu |
| Política de Privacidade | https://www.shopranos.eu/privacy-policy |
| Categorias | Commerce |
Shopranos Power Automate Conector
Bem-vindo ao Shopranos Power Automate Connector! Este conector integra perfeitamente o sistema ERP da sua empresa com as operações de comércio eletrónico B2B, capacitando-o para automatizar tarefas críticas e agilizar fluxos de trabalho.
Editora: Softone Technologies S.A.
Pré-requisitos
Uma subscrição Shopranos válida.
Como obter credenciais
Para aceder aos dados da sua empresa utilizando o conector Shopranos, siga estes passos:
- Visite a página de login da Plataforma Shopranos em platform.shopranos.eu.
- Depois de fazer login, navegue até o menu e selecione "Chaves de API do usuário".
- Gere uma nova chave de API a partir das opções fornecidas.
- Utilize essa chave de API recém-gerada dentro do conector Shopranos para obter acesso aos dados da sua empresa.
Introdução ao conector
Para começar a usar o Shopranos Power Automate Connector, siga estas etapas:
Instalação: instale o conector no seu ambiente Power Automatic.
Configuração: Digite sua chave de api para se conectar ao Shopranos.
Uso: comece a automatizar tarefas e fluxos de trabalho sem problemas.
Problemas conhecidos e limitações
Você pode encontrar uma lista abrangente de todos os problemas conhecidos visitando o seguinte link no GitHub:
Shopranos Rastreador de Problemas
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 da API é inválida. Remédio: verifique se você gerou uma chave de API válida em sua conta Shopranos. Certifique-se de que não há espaços à esquerda ou à direita na chave da API ao inseri-la na configuração do conector.
Erro 2: Não é possível conectar
Sintoma: Você não consegue estabelecer uma conexão com a plataforma Shopranos ao configurar o conector. Solução: verifique se você configurou corretamente o conector com a chave da API. Verifique se a plataforma Shopranos (platform.shopranos.eu) está acessível e não está com 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. Solução: 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. Consulte 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 Power Automatic. Solução: Certifique-se de seguir cuidadosamente as instruções de instalação fornecidas para o conector Shopranos. Verifique o seu ambiente Power Automate para quaisquer restrições ou políticas que possam estar a afetar 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ê está encontrando erros inexplicáveis durante a execução do fluxo de trabalho. Solução: revise 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ê achar que o conector tem funcionalidade limitada ou não suporta determinadas ações. Solução: Consulte o Shopranos Issue Tracker 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 obter informações sobre atualizações planejadas ou soluções alternativas para as limitações.
Erro 7: Desempenho lento
Sintoma: O conector ou fluxos de trabalho estão com desempenho lento. Solução: Verifique a sua ligação de rede e certifique-se de que a sua conta Shopranos não está a ter problemas de desempenho. Além disso, revise o design do fluxo de trabalho para otimizá-lo para eficiência. Se o problema persistir, considere entrar em contato com o suporte da Shopranos para obter assistência. Esses erros comuns e suas soluções correspondentes devem ajudar os usuários a solucionar e resolver problemas ao usar o Shopranos Power Automate Connector. Se você encontrar outros erros ou problemas específicos, não hesite em entrar em contato com o suporte da Shopranos para obter assistência personalizada.
FAQ
Como posso obter suporte se tiver problemas ou 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 a Shopranos para agilizar seus processos de negócios e aumentar a eficiência.
Quais são os principais benefícios de usar o Shopranos?
Shopranos oferece vários benefícios importantes, incluindo:
Integração sem esforço: conecte perfeitamente seu sistema ERP ao comércio eletrônico B2B, melhorando 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 Automatic: aproveite o poder do Microsoft Power Automate para desbloquear uma ampla gama de possibilidades de automação. Envie mensagens importantes, impulsione fluxos de trabalho de aprovação e simplifique processos complexos.
Instruções de implantação
Como a Shopranos opera como uma plataforma como serviço (PaaS), não é necessário um processo de implantação manual. A plataforma lida com todos os aspetos de implantação e gerenciamento de infraestrutura, permitindo que os usuários se concentrem diretamente na utilização de seus serviços e recursos para seus aplicativos.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API | securestring | A chave de API para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Atributo Obter por código |
Obter atributo por código |
| Atributo Obter por ID |
Obter atributo por id |
| Atualização da coleção |
Atualizar coleção |
| Atualização da etiqueta do produto |
Atualizar rótulo do produto por id |
| Atualização da Lista de Compras |
Atualizar uma lista de compras por alias |
| Atualização da marca |
Atualizar marca |
| Atualização da Unidade |
Atualizar unidade por id |
| Atualização de atributos |
Atributo de atualização |
| Atualização de categoria |
Categoria de atualização |
| Atualização de Checkout |
Atualizar um checkout por token |
| Atualização de disponibilidade de estoque |
Atualizar disponibilidade de estoque por id |
| Atualização de Encomenda |
Atualizar uma encomenda por ID |
| Atualização de localização |
Atualizar um local por ID |
| Atualização de produtos relacionados |
Atualizar produtos relacionados |
| Atualização de sortimento |
Atualizar uma classificação por ID do cliente |
| Atualização de valores de sortimento por ID do cliente e ID de classificação |
Atualizar valores de classificação por ID do cliente e ID de classificação |
| 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 Nível de Inventário |
Atualizar um nível de inventário por Id |
| Atualização do produto |
Atualizar produto por id |
| Carrinho Adicionar Produto |
Adicionar produto ao carrinho |
| Carrinho Obter por Token |
Obter carrinho por token |
| Carrinho Remover Produto |
Remover produto do carrinho |
| Categoria Atualizar Conteúdo Adicional |
Atualizar conteúdo adicional por ID de categoria |
| Categoria Excluir |
Excluir categoria |
| Categoria Excluir conteúdo adicional |
Excluir conteúdo adicional por ID de categoria |
| Categoria Importação |
Categorias de importação |
| 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 |
| Categoria Obter por alias |
Obter categoria por alias |
| Categoria Obter por ID |
Obter categoria por id |
| Checkout Concluído |
Concluir um checkout por token |
| Checkout Iniciar Pagamento |
Iniciar um pagamento para um checkout por token |
| Checkout Obter por Token |
Obter um checkout por token |
| Checkout Pagamento Completo |
Conclua um pagamento para um checkout por token |
| Cliente Get By Id |
Obter um cliente por Id |
| Coleção Atualizar Conteúdo Adicional |
Atualizar conteúdo adicional por ID de coleção |
| Coleção Estendida Get by Alias |
Obter coleção estendida por alias |
| Coleção Estendida Get by Id |
Obter coleção estendida por id |
| Coleção Excluir conteúdo adicional |
Excluir conteúdo adicional por ID de coleção |
| Coleção Get by Id |
Obter coleção por id |
| Coleção Obter conteúdo adicional por ID |
Obter conteúdo adicional por ID de coleção |
| Coleção Obter conteúdo adicional por ID (HTML) |
Obter conteúdo adicional por ID de coleção |
| Combinações de atualização de sortimento |
Atualizar uma combinação de classificação por ID do cliente |
| Conjunto de atributos Obter por ID |
Obter atributo definido por id |
| Consulta ao Grupo de Clientes |
Obter todos os grupos de clientes |
| Consulta de atributos |
Obter atributos por critérios de pesquisa |
| Consulta de categoria |
Obter categorias por critérios de pesquisa |
| Consulta de classificações |
Obtenha todos os sortimentos |
| 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 |
Consultar disponibilidade de estoque |
| Consulta de Encomenda |
Receba todas as encomendas |
| Consulta de etiquetas de produtos |
Consultar rótulos de produtos |
| Consulta de Marca |
Obter marcas por critérios de pesquisa |
| Consulta de Nível de Inventário |
Obtenha todos os níveis de estoque |
| Consulta de unidade |
Unidades de consulta |
| Consulta do Cliente |
Obter todos os clientes |
| Consulta do Grupo de Privacidade |
Consultar grupos de privacidade |
| Consulta do produto |
Consultar produtos |
| Consulta estendida de coleção |
Consultar coleções estendidas |
| Consulta estendida do produto |
Consultar produtos estendidos |
| Conteúdo adicional de atualização de marca |
Atualizar conteúdo adicional por ID de marca |
| Conteúdo adicional de atualizações de produtos |
Atualizar conteúdo adicional por ID do produto |
| Criar carrinho |
Criar carrinho |
| Criar Categoria |
Criar categoria |
| Criar Checkout |
Criar um checkout por token |
| Criar coleção |
Criar coleção |
| Criar conjunto de atributos |
Criar conjunto de atributos |
| Criar Encomenda |
Criar uma encomenda |
| Criar etiqueta de produto |
Criar etiqueta de produto |
| Criar Grupo de Clientes |
Criar um grupo de clientes |
| Criar Grupo de Privacidade |
Criar grupo de privacidade |
| Criar Lista de Compras |
Criar uma lista de compras |
| Criar Nível de Inventário |
Criar um nível de inventário |
| Criar sortimento |
Criar uma classificação |
| Criação de atributos |
Criar atributo |
| Criação de clientes |
Criar um cliente |
| Criação de disponibilidade de estoque |
Criar disponibilidade de stock |
| Criação de Marca |
Criar marca |
| Criação de Produto |
Criar produto |
| Criação de Unidade |
Criar unidade |
| Disponibilidade de estoque de reserva de estoque |
Reservar disponibilidade de stock |
| Disponibilidade de estoque sem reserva |
Disponibilidade de stock sem reservas |
| Disponibilidade de Stock Obter por ID |
Obter disponibilidade de stock por id |
| Encomendar Eliminar |
Excluir um pedido por Id |
| Encomendar Obter por ID |
Obter uma encomenda por Id |
| Etiqueta do produto Obter por ID |
Obter rótulo do produto por id |
| Excluir lista de compras |
Excluir uma lista de compras por alias |
| Exclusão de atributo |
Excluir atributo |
| Exclusão de carrinho |
Excluir carrinho por token |
| Exclusão de cliente |
Excluir um cliente por Id |
| Exclusão de coleção |
Eliminar coleção |
| Exclusão de disponibilidade de estoque |
Excluir disponibilidade de estoque por id |
| Exclusão de grupo de clientes |
Excluir um grupo de clientes por Id |
| Exclusão de local |
Excluir um local por Id |
| Exclusão de marca |
Excluir marca |
| Exclusão de marca de conteúdo adicional |
Excluir conteúdo adicional por ID de marca |
| Exclusão de rótulo do produto |
Excluir rótulo do produto por id |
| Exclusão de sortimento |
Excluir uma classificação por ID do cliente |
| Exclusão de unidade |
Excluir unidade por id |
| Exclusão do conjunto de atributos |
Excluir conjunto de atributos |
| Exclusão do grupo de privacidade |
Excluir grupo de privacidade 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 |
| Grupo de Clientes Obter por ID |
Obter um grupo de clientes por Id |
| Grupo de clientes Obter por ID do cliente |
Obter um grupo de clientes por ID de cliente |
| Grupo de Privacidade Obter por ID |
Obter grupo de privacidade por id |
| Importação de atributos |
Importar atributos |
| Importação de clientes |
Importar clientes |
| Importação de Encomendas |
Ordens de importação |
| Importação de Marca |
Importar marcas |
| Importação de marca por código |
Importar marcas por códigos |
| Importação de Nível de Estoque |
Níveis de estoque de importação |
| Importação de produto de tag de origem |
Importar produtos de tag de origem |
| Importação de Produtos |
Importar produtos |
| Importação de produtos por SKU |
Importar produtos por SKU |
| Importação do conjunto de atributos |
Importar conjuntos de atributos |
| Inventário Verificar disponibilidade de estoque |
Verificar disponibilidade de stock |
| Limpeza de filtros |
Limpar filtros |
| Lista de Compras Obter por Alias |
Obter uma lista de compras por alias |
| Lista de Compras Obter Tudo |
Obter todas as listas de compras |
| Localização Criar |
Criar uma localização |
| Localização Obter por ID |
Obter uma localização por Id |
| Localização Obter Tudo |
Obter todos os locais |
| Marca Get by Alias |
Obter marca por alias |
| Marca Get by Id |
Obter marca por id |
| Marca Obter conteúdo adicional por id |
Obter conteúdo adicional por ID de marca |
| Marca Obter conteúdo adicional por id (HTML) |
Obter conteúdo adicional por ID de marca |
| Nível de Inventário Obter por ID |
Obter um nível de inventário por Id |
| Nível de Inventário Obter por ID de Variante |
Obter um nível de inventário por ID de variante |
| Obtenha todas as variantes de produtos planos |
Obtenha todas as variantes de produtos planos |
| Produto estendido Get By Alias |
Obter produto estendido por alias |
| Produto Excluir conteúdo adicional |
Excluir conteúdo adicional por ID do produto |
| Produto Get By Alias |
Obter produto por alias |
| Produto Get By Id |
Obter produto por id |
| Produto Obter conteúdo adicional por id |
Obter conteúdo adicional por ID do produto |
| Produto Obter conteúdo adicional por id (HTML) |
Obter conteúdo adicional por ID do produto |
| Produtos relacionados Criar |
Criar produtos relacionados |
| Produtos relacionados Excluir |
Excluir produtos relacionados |
| Recalcular Checkout |
Recalcular um checkout por token |
| Sortimento Obter por ID do cliente |
Obtenha uma classificação por ID do cliente |
| Unidade de Importação |
Unidades de importação |
| Unidade Get By Id |
Obter unidade por id |
| Valor de classificação Excluir por ID do cliente e ID de classificação |
Excluir valores de classificação por ID do cliente e ID de classificação |
| Valores de classificação anexados por ID do cliente |
Acrescentar valores de classificação por ID do cliente |
| Valores de classificação excluídos por ID de origem do cliente |
Excluir valores de classificação por ID do cliente e origem |
| Valores de classificação excluídos por ID do cliente |
Excluir valores de classificação por ID do cliente |
| Valores de sortimento obtidos por ID do cliente |
Obter valores de classificação por ID do cliente |
| Valores de sortimento reconstruídos por ID do cliente |
Reconstruir valores de classificação por ID do cliente |
Atributo Obter por código
Obter atributo por código
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Código
|
code | True | string |
Definir o código do atributo |
Devoluções
- Body
- AttributeDTO
Atributo Obter por ID
Obter atributo por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir a id do atributo |
Devoluções
- Body
- AttributeDTO
Atualização da coleção
Atualizar coleção
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da coleção
|
collectionId | True | string |
Definir o id da coleção |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Title
|
title | string | ||
|
Description
|
description | string | ||
|
DescriçãoHtml
|
descriptionHtml | string | ||
|
Link
|
link | string | ||
|
Alias
|
alias | string | ||
|
MediaItem
|
mediaItem | |||
|
Situação
|
status | string | ||
|
Mode
|
mode | string | ||
|
Publicadoem em
|
publishedAt | date-time | ||
|
SortOrder
|
sortOrder | string | ||
|
Contagem de produtos
|
productCount | integer | ||
|
Ids de produto
|
productIds | array of string | ||
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
DescriçãoPlain
|
descriptionPlain | string | ||
|
Link
|
link | string | ||
|
Id
|
id | string | ||
|
GalleryId
|
galleryId | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Link
|
link | string | ||
|
Position
|
position | integer | ||
|
Alt
|
alt | string | ||
|
MediaType
|
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ço unitário
|
unitPrice | double | ||
|
Preço
|
price | double | ||
|
Msrp
|
msrp | double | ||
|
Quantidade
|
quantity | double | ||
|
Preço Inicial
|
initialPrice | double | ||
|
Dimension1ItemId
|
dimension1ItemId | string | ||
|
Dimension2ItemId
|
dimension2ItemId | string | ||
|
Dimension3ItemId
|
dimension3ItemId | string | ||
|
ShippingWeight
|
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 | ||
|
Requer: Envio
|
requiresShipping | boolean | ||
|
Sku
|
sku | string | ||
|
Tradução
|
translation | |||
|
CanOrder
|
canOrder | boolean | ||
|
Características adicionais
|
additionalFeatures | |||
|
Esperado
|
expected | |||
|
MinOrderQuantity
|
minOrderQuantity | double | ||
|
OrderQuantityStep
|
orderQuantityStep | double | ||
|
AttributeId
|
attributeId | string | ||
|
AttributeItemId
|
attributeItemId | string | ||
|
AttributeItemValue
|
attributeItemValue | string | ||
|
Tradução
|
translation | |||
|
Preço Máximo
|
maxPrice | double | ||
|
Preço Mínimo
|
minPrice | double | ||
|
PathCategories
|
pathCategories | array of string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
VariantCount
|
variantCount | integer | ||
|
Características adicionais
|
additionalFeatures | |||
|
Dimensão1
|
dimension1 | |||
|
Dimensão2
|
dimension2 | |||
|
Dimensão3
|
dimension3 | |||
|
Atributos de pesquisa
|
searchAttributes | array of string | ||
|
Código do IVA
|
vatCode | string | ||
|
ReducedVatCode
|
reducedVatCode | string | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Taxa de IVA reduzida
|
reducedVatRate | double | ||
|
Title
|
title | string | ||
|
Subtítulo
|
subTitle | string | ||
|
Description
|
description | string | ||
|
Alias
|
alias | string | ||
|
Situação
|
status | string | ||
|
BrandId
|
brandId | string | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
CategoriaId
|
categoryId | string | ||
|
PriceCategoryId
|
priceCategoryId | string | ||
|
AdditionalCategoryIds
|
additionalCategoryIds | array of string | ||
|
Etiquetas
|
tags | array of string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
AdditionalSearchTags
|
additionalSearchTags | array of string | ||
|
Disponibilidade
|
availability | string | ||
|
Tradução
|
translation | |||
|
Ordem de parada
|
stopOrder | boolean | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
StockAvailabilityModelId
|
stockAvailabilityModelId | string | ||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Tradução
|
translation | |||
|
AttributeSetId
|
attributeSetId | string | ||
|
Data de classificação
|
sortDate | date-time | ||
|
Sortimentos
|
assortments | array of string | ||
|
MasterId
|
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 | ||
|
Identificação da empresa
|
companyId | string | ||
|
Title
|
title | string | ||
|
Description
|
description | string | ||
|
DescriçãoHtml
|
descriptionHtml | string | ||
|
Link
|
link | string | ||
|
Alias
|
alias | string | ||
|
MediaItem
|
mediaItem | |||
|
Situação
|
status | string | ||
|
Mode
|
mode | string | ||
|
Publicadoem em
|
publishedAt | date-time | ||
|
SortOrder
|
sortOrder | string | ||
|
Contagem de produtos
|
productCount | integer | ||
|
Ids de produto
|
productIds | array of string | ||
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
DescriçãoPlain
|
descriptionPlain | string | ||
|
Link
|
link | string | ||
|
Id
|
id | string | ||
|
GalleryId
|
galleryId | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Link
|
link | string | ||
|
Position
|
position | integer | ||
|
Alt
|
alt | string | ||
|
MediaType
|
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ço unitário
|
unitPrice | double | ||
|
Preço
|
price | double | ||
|
Msrp
|
msrp | double | ||
|
Quantidade
|
quantity | double | ||
|
Preço Inicial
|
initialPrice | double | ||
|
Dimension1ItemId
|
dimension1ItemId | string | ||
|
Dimension2ItemId
|
dimension2ItemId | string | ||
|
Dimension3ItemId
|
dimension3ItemId | string | ||
|
ShippingWeight
|
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 | ||
|
Requer: Envio
|
requiresShipping | boolean | ||
|
Sku
|
sku | string | ||
|
Tradução
|
translation | |||
|
CanOrder
|
canOrder | boolean | ||
|
Características adicionais
|
additionalFeatures | |||
|
Esperado
|
expected | |||
|
MinOrderQuantity
|
minOrderQuantity | double | ||
|
OrderQuantityStep
|
orderQuantityStep | double | ||
|
AttributeId
|
attributeId | string | ||
|
AttributeItemId
|
attributeItemId | string | ||
|
AttributeItemValue
|
attributeItemValue | string | ||
|
Tradução
|
translation | |||
|
Preço Máximo
|
maxPrice | double | ||
|
Preço Mínimo
|
minPrice | double | ||
|
PathCategories
|
pathCategories | array of string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
VariantCount
|
variantCount | integer | ||
|
Características adicionais
|
additionalFeatures | |||
|
Dimensão1
|
dimension1 | |||
|
Dimensão2
|
dimension2 | |||
|
Dimensão3
|
dimension3 | |||
|
Atributos de pesquisa
|
searchAttributes | array of string | ||
|
Código do IVA
|
vatCode | string | ||
|
ReducedVatCode
|
reducedVatCode | string | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Taxa de IVA reduzida
|
reducedVatRate | double | ||
|
Title
|
title | string | ||
|
Subtítulo
|
subTitle | string | ||
|
Description
|
description | string | ||
|
Alias
|
alias | string | ||
|
Situação
|
status | string | ||
|
BrandId
|
brandId | string | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
CategoriaId
|
categoryId | string | ||
|
PriceCategoryId
|
priceCategoryId | string | ||
|
AdditionalCategoryIds
|
additionalCategoryIds | array of string | ||
|
Etiquetas
|
tags | array of string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
AdditionalSearchTags
|
additionalSearchTags | array of string | ||
|
Disponibilidade
|
availability | string | ||
|
Tradução
|
translation | |||
|
Ordem de parada
|
stopOrder | boolean | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
StockAvailabilityModelId
|
stockAvailabilityModelId | string | ||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Tradução
|
translation | |||
|
AttributeSetId
|
attributeSetId | string | ||
|
Data de classificação
|
sortDate | date-time | ||
|
Sortimentos
|
assortments | array of string | ||
|
MasterId
|
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 | ||
|
InserirData
|
insertDate | date-time | ||
|
Etiquetas
|
tags | array of string | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
Tradução
|
translation | |||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Etiquetas
|
tags | array of string | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
Tradução
|
translation | |||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string |
Atualização da etiqueta do produto
Atualizar rótulo do produto por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id do rótulo do produto |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Nome
|
name | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Ícone
|
icon | string | ||
|
BackgroundColor
|
backgroundColor | string | ||
|
TextColor
|
textColor | string | ||
|
Ids de produto
|
productIds | array of string | ||
|
RuleEnabled
|
ruleEnabled | boolean | ||
|
DataA partir de
|
dateFrom | date-time | ||
|
DataAté
|
dateTo | date-time | ||
|
Mode
|
mode | string | ||
|
Situação
|
status | string | ||
|
Regra
|
rule | |||
|
Tradução
|
translation |
Atualização da Lista de Compras
Atualizar uma lista de compras por alias
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Alias
|
alias | True | string |
Definir uma lista de compras por alias |
|
Id
|
id | string | ||
|
Title
|
title | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
ID do Cliente
|
customerId | string | ||
|
UserId
|
userId | string | ||
|
Alias
|
alias | string | ||
|
InserirData
|
insertDate | date-time | ||
|
UpdateDate
|
updateDate | date-time | ||
|
ID do Produto
|
productId | string | ||
|
ProductVariantId
|
productVariantId | string |
Atualização da marca
Atualizar marca
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da marca
|
brandId | True | string |
Definir o id da marca |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Código
|
code | True | string | |
|
Nome
|
name | True | string | |
|
Alias
|
alias | string | ||
|
Description
|
description | string | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Situação
|
status | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
MediaItem
|
mediaItem | |||
|
Tradução
|
translation | |||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string |
Atualização da Unidade
Atualizar unidade por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id da unidade |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Código
|
code | True | string | |
|
Nome
|
name | True | string | |
|
Tradução
|
translation | |||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time |
Atualização de atributos
Atributo de atualização
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir a id do atributo |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Nome
|
name | True | string | |
|
Código
|
code | True | string | |
|
Description
|
description | string | ||
|
UsedAsFilter
|
usedAsFilter | boolean | ||
|
DisplayOnProduct
|
displayOnProduct | boolean | ||
|
DisplayOnList
|
displayOnList | boolean | ||
|
DisplayOnCompare
|
displayOnCompare | boolean | ||
|
Tipo
|
type | string | ||
|
Campo Dinâmico
|
slug | string | ||
|
Position
|
position | integer | ||
|
Situação
|
status | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Id
|
id | string | ||
|
Código
|
code | string | ||
|
Código de cores
|
colorCode | string | ||
|
Valor
|
value | string | ||
|
Position
|
position | integer | ||
|
Campo Dinâmico
|
slug | string | ||
|
Tradução
|
translation | |||
|
Tradução
|
translation |
Devoluções
- Body
- AttributeDTO
Atualização de categoria
Categoria de atualização
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id da categoria |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Title
|
title | True | string | |
|
Código
|
code | True | string | |
|
Alias
|
alias | string | ||
|
Description
|
description | string | ||
|
Position
|
position | integer | ||
|
DisplayInMenu
|
displayInMenu | boolean | ||
|
DisplayAsList
|
displayAsList | boolean | ||
|
ParentId
|
parentId | string | ||
|
Caminho
|
path | string | ||
|
MediaItem
|
mediaItem | |||
|
Tradução
|
translation | |||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
TreeIds
|
treeIds | array of string | ||
|
Link
|
link | string | ||
|
Situação
|
status | string |
Devoluções
- Body
- CategoryDTO
Atualização de Checkout
Atualizar um checkout por token
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Atualizar um checkout por token |
|
Observações
|
notes | string | ||
|
Código de referência
|
referenceCode | string | ||
|
Endereço de envio
|
shippingAddress | |||
|
Linha de Envio
|
shippingLine | |||
|
Pagamento
|
payment | |||
|
ClienteBranchId
|
customerBranchId | string | ||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Id
|
id | string | ||
|
Nome
|
name | string | ||
|
Address
|
address | |||
|
Data de entrega
|
deliveryDate | date-time |
Devoluções
- Body
- CheckoutDTO
Atualização de disponibilidade de estoque
Atualizar disponibilidade de estoque por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id da disponibilidade de estoque |
|
Código
|
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 Encomenda
Atualizar uma encomenda por ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Atualizar uma encomenda por ID |
|
Id
|
id | string | ||
|
Código
|
code | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
CheckoutToken
|
checkoutToken | string | ||
|
CartToken
|
cartToken | string | ||
|
Situação
|
status | string | ||
|
ID do Cliente
|
customerId | string | ||
|
ClienteBranchId
|
customerBranchId | string | ||
|
CustomerBranchSourceId
|
customerBranchSourceId | string | ||
|
CustomerTin
|
customerTin | string | ||
|
Nome do Cliente
|
customerName | string | ||
|
Código do Cliente
|
customerCode | string | ||
|
CustomerSourceId
|
customerSourceId | string | ||
|
CustomerBranchName
|
customerBranchName | string | ||
|
Moeda
|
currency | string | ||
|
Cancelado
|
cancelledAt | date-time | ||
|
Data de entrega
|
deliveryDate | date-time | ||
|
CancelamentoMotivo
|
cancellationReason | string | ||
|
Fechado
|
closedAt | date-time | ||
|
Código de referência
|
referenceCode | string | ||
|
DescontoTaxa
|
discountRate | double | ||
|
DescontoValor
|
discountValue | double | ||
|
TotalMontante
|
totalAmount | double | ||
|
Montante líquido
|
netAmount | double | ||
|
Montante do IVA
|
vatAmount | double | ||
|
DespesaMontante
|
expenseAmount | double | ||
|
Situação financeira
|
financialStatus | string | ||
|
Status de Cumprimento
|
fulfillmentStatus | string | ||
|
Endereço de Faturação
|
billingAddress | |||
|
Endereço de envio
|
shippingAddress | |||
|
RequiresCalculation
|
requiresCalculation | boolean | ||
|
Id
|
id | string | ||
|
ID do Produto
|
productId | string | ||
|
ProductVariantId
|
productVariantId | string | ||
|
ProductTitle (Título do produto)
|
productTitle | string | ||
|
UnitId
|
unitId | string | ||
|
SalesUnitId
|
salesUnitId | string | ||
|
Quantidade
|
quantity | double | ||
|
UnitQuantity
|
unitQuantity | double | ||
|
Valor Líquido
|
netValue | double | ||
|
Preço
|
price | double | ||
|
Valor da despesa
|
expenseValue | double | ||
|
PreçoValor1
|
priceValue1 | double | ||
|
PreçoValor2
|
priceValue2 | double | ||
|
PreçoValor3
|
priceValue3 | double | ||
|
Preço unitário
|
unitPrice | double | ||
|
LineValue
|
lineValue | double | ||
|
DescontoValor
|
discountValue | double | ||
|
DescontoTaxa
|
discountRate | double | ||
|
VatValue
|
vatValue | double | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Código do IVA
|
vatCode | string | ||
|
Sku
|
sku | string | ||
|
Dimensão1Legenda
|
dimension1Caption | string | ||
|
Dimensão2Legenda
|
dimension2Caption | string | ||
|
Dimension3Caption
|
dimension3Caption | string | ||
|
Dimensão1Valor
|
dimension1Value | string | ||
|
Dimensão2Valor
|
dimension2Value | string | ||
|
Dimensão3Valor
|
dimension3Value | string | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Montante do IVA
|
vatAmount | double | ||
|
Código do IVA
|
vatCode | string | ||
|
Montante líquido
|
netAmount | double | ||
|
Etiquetas
|
tags | array of string | ||
|
FonteId
|
sourceId | string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
Observações
|
notes | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Favorito
|
favorite | boolean | ||
|
UserId
|
userId | string | ||
|
InvoiceUrl
|
invoiceUrl | string | ||
|
Notificar
|
notify | string | ||
|
Notificado
|
notified | array of string | ||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Linha de Envio
|
shippingLine | |||
|
ID do Produto
|
productId | string | ||
|
ProductVariantId
|
productVariantId | string | ||
|
ProductTitle (Título do produto)
|
productTitle | string | ||
|
Quantidade
|
quantity | double | ||
|
Código do IVA
|
vatCode | string | ||
|
ImagemLink
|
imageLink | string | ||
|
ProductAlias
|
productAlias | string | ||
|
Id
|
id | string | ||
|
Valor Líquido
|
netValue | double | ||
|
VatValue
|
vatValue | double | ||
|
Pagamento
|
payment | |||
|
SeriesId
|
seriesId | string |
Atualização de localização
Atualizar um local por ID
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da localização
|
locationId | True | string |
Atualizar um local por ID |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Nome
|
name | string | ||
|
IsActive
|
isActive | boolean | ||
|
Address
|
address | |||
|
Telemóvel
|
phone | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time |
Atualização de produtos relacionados
Atualizar produtos relacionados
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Produto
|
productId | True | string |
Definir o ID do produto |
|
ID da variante
|
variantId | True | string |
Definir o id da variante |
|
Id
|
id | string | ||
|
ID do Produto
|
productId | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Dimension1ItemIds
|
dimension1ItemIds | array of string | ||
|
Dimension2ItemIds
|
dimension2ItemIds | array of string | ||
|
Dimension3ItemIds
|
dimension3ItemIds | array of string |
Atualização de sortimento
Atualizar uma classificação por ID do cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerId | True | string |
Atualizar uma classificação por ID do cliente |
|
Id
|
id | string | ||
|
Nome
|
name | string | ||
|
Id
|
id | string | ||
|
Nome
|
name | string |
Devoluções
- Body
- AssortmentDTO
Atualização de valores de sortimento por ID do cliente e ID de classificação
Atualizar valores de classificação por ID do cliente e ID de classificação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Atualizar valores de classificação por id |
|
ID do Cliente
|
customerId | True | string |
Atualizar valores de classificação por ID do cliente e ID de classificação |
|
Situação
|
status | string |
Atualização do carrinho
Atualizar carrinho por token
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
token
|
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 |
Devoluções
- Body
- CartDTO
Atualização do cliente
Atualizar um cliente por Id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerId | True | string |
Atualizar um cliente por Id |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Código
|
code | string | ||
|
Nome
|
name | string | ||
|
Estanho
|
tin | string | ||
|
Email
|
string | |||
|
Contato
|
contact | string | ||
|
Telefone de contato
|
contactPhone | string | ||
|
Telemóvel
|
phone | string | ||
|
PriceCategoryId
|
priceCategoryId | string | ||
|
FonteId
|
sourceId | string | ||
|
Etiquetas
|
tags | array of string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
Address
|
address | |||
|
Observações
|
notes | string | ||
|
Situação
|
status | string | ||
|
Id
|
id | string | ||
|
FonteId
|
sourceId | string | ||
|
Código
|
code | string | ||
|
Nome
|
name | string | ||
|
Contato
|
contact | string | ||
|
Telefone de contato
|
contactPhone | string | ||
|
Telemóvel
|
phone | string | ||
|
Address
|
address | |||
|
Situação
|
status | string | ||
|
Características adicionais
|
additionalFeatures | |||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Tradução
|
translation | |||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
SalesmanId
|
salesmanId | string | ||
|
Repartição de Finanças
|
taxOffice | string | ||
|
ContactoLíngua
|
contactLanguage | string | ||
|
Tipo de IVA
|
vatType | string | ||
|
Tipo de Loja
|
shopType | string | ||
|
Nome
|
name | string | ||
|
Address
|
address |
Atualização do conjunto de atributos
Atualizar conjunto de atributos
Parâmetros
| Name | Chave | Necessá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 | ||
|
Position
|
position | integer | ||
|
Id
|
id | string | ||
|
Position
|
position | integer |
Devoluções
- Body
- AttributeSetDTO
Atualização do Grupo de Clientes
Atualizar um grupo de clientes por Id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
Id | True | string |
Atualizar um grupo de clientes por Id |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Title
|
title | True | string | |
|
Situação
|
status | string | ||
|
Regra
|
rule | |||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time |
Atualização do Grupo de Privacidade
Atualizar grupo de privacidade por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir a ID do grupo de privacidade |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Title
|
title | string | ||
|
Situação
|
status | string | ||
|
Mode
|
mode | string | ||
|
Ids de produto
|
productIds | array of string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Regra
|
rule | |||
|
CustomerGroupIds
|
customerGroupIds | array of string | ||
|
Ids do Cliente
|
customerIds | array of string |
Atualização do Nível de Inventário
Atualizar um nível de inventário por Id
Parâmetros
| Name | Chave | Necessá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 | ||
|
Identificação da empresa
|
companyId | string | ||
|
LocalizaçãoId
|
locationId | string | ||
|
Quantidade
|
quantity | double | ||
|
Data de entrega
|
deliveryDate | date-time | ||
|
Quantidade Esperada
|
expectedQuantity | double | ||
|
UpdateDate
|
updateDate | date-time |
Atualização do produto
Atualizar produto por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id do produto |
|
Id
|
id | string | ||
|
Link
|
link | string | ||
|
Position
|
position | integer | ||
|
Alt
|
alt | string | ||
|
MediaType
|
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ço unitário
|
unitPrice | double | ||
|
Preço
|
price | double | ||
|
Msrp
|
msrp | double | ||
|
Preço Inicial
|
initialPrice | double | ||
|
Dimension1ItemId
|
dimension1ItemId | string | ||
|
Dimension2ItemId
|
dimension2ItemId | string | ||
|
Dimension3ItemId
|
dimension3ItemId | string | ||
|
ShippingWeight
|
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 | ||
|
Requer: Envio
|
requiresShipping | boolean | ||
|
Sku
|
sku | string | ||
|
Tradução
|
translation | |||
|
MinOrderQuantity
|
minOrderQuantity | double | ||
|
OrderQuantityStep
|
orderQuantityStep | double | ||
|
MediaItem
|
mediaItem | |||
|
Dimensão1
|
dimension1 | |||
|
Dimensão2
|
dimension2 | |||
|
Dimensão3
|
dimension3 | |||
|
Código do IVA
|
vatCode | string | ||
|
ReducedVatCode
|
reducedVatCode | string | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Taxa de IVA reduzida
|
reducedVatRate | double | ||
|
Title
|
title | string | ||
|
Subtítulo
|
subTitle | string | ||
|
Description
|
description | string | ||
|
Alias
|
alias | string | ||
|
Situação
|
status | string | ||
|
BrandId
|
brandId | string | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
CategoriaId
|
categoryId | string | ||
|
PriceCategoryId
|
priceCategoryId | string | ||
|
AdditionalCategoryIds
|
additionalCategoryIds | array of string | ||
|
Etiquetas
|
tags | array of string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
AdditionalSearchTags
|
additionalSearchTags | array of string | ||
|
PathCategories
|
pathCategories | array of string | ||
|
Disponibilidade
|
availability | string | ||
|
Tradução
|
translation | |||
|
Ordem de parada
|
stopOrder | boolean | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
StockAvailabilityModelId
|
stockAvailabilityModelId | string | ||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Tradução
|
translation | |||
|
AttributeSetId
|
attributeSetId | string | ||
|
Data de classificação
|
sortDate | date-time | ||
|
Sortimentos
|
assortments | array of string | ||
|
MasterId
|
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 |
Carrinho Adicionar Produto
Adicionar produto ao carrinho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
token
|
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 |
Devoluções
- Body
- CartDTO
Carrinho Obter por Token
Obter carrinho por token
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
token
|
token | True | string |
Obter carrinho por token |
Devoluções
- Body
- CartDTO
Carrinho Remover Produto
Remover produto do carrinho
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
token
|
token | True | string |
Obter carrinho por token |
|
productVariantId
|
productVariantId | True | string |
Obter carrinho por token |
Categoria Atualizar Conteúdo Adicional
Atualizar conteúdo adicional por ID de categoria
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da categoria
|
categoryId | True | string |
Definir o id da categoria |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Id
|
id | string | ||
|
Title
|
title | string | ||
|
Description
|
description | string | ||
|
Position
|
position | integer | ||
|
MediaItem
|
mediaItem | |||
|
Tradução
|
translation |
Categoria Excluir
Excluir categoria
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id da categoria |
Categoria Excluir conteúdo adicional
Excluir conteúdo adicional por ID de categoria
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da categoria
|
categoryId | True | string |
Definir o id da categoria |
Categoria Importação
Categorias de importação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Title
|
title | True | string | |
|
Código
|
code | True | string | |
|
Alias
|
alias | string | ||
|
Description
|
description | string | ||
|
Position
|
position | integer | ||
|
DisplayInMenu
|
displayInMenu | boolean | ||
|
DisplayAsList
|
displayAsList | boolean | ||
|
ParentId
|
parentId | string | ||
|
Caminho
|
path | string | ||
|
MediaItem
|
mediaItem | |||
|
Tradução
|
translation | |||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
TreeIds
|
treeIds | array of string | ||
|
Link
|
link | string | ||
|
Situação
|
status | string |
Categoria Obter conteúdo adicional por ID
Obter conteúdo adicional por ID de categoria
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da categoria
|
categoryId | True | string |
Definir o id da categoria |
Devoluções
- Body
- DocumentationDTO
Categoria Obter conteúdo adicional por id (HTML)
Obter conteúdo adicional por ID de categoria
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da categoria
|
categoryId | True | string |
Definir o id da categoria |
Devoluções
- Body
- DocumentationDTO
Categoria Obter por alias
Obter categoria por alias
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Alias
|
alias | True | string |
Definir o alias da categoria |
Devoluções
- Body
- CategoryDTO
Categoria Obter por ID
Obter categoria por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id da categoria |
Devoluções
- Body
- CategoryDTO
Checkout Concluído
Concluir um checkout por token
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Concluir um checkout por token |
|
Observações
|
notes | string | ||
|
Código de referência
|
referenceCode | string | ||
|
Endereço de envio
|
shippingAddress | |||
|
Linha de Envio
|
shippingLine | |||
|
Pagamento
|
payment | |||
|
ClienteBranchId
|
customerBranchId | string | ||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Id
|
id | string | ||
|
Nome
|
name | string | ||
|
Address
|
address | |||
|
Data de entrega
|
deliveryDate | date-time |
Devoluções
- Body
- CheckoutDTO
Checkout Iniciar Pagamento
Iniciar um pagamento para um checkout por token
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Iniciar um pagamento para um checkout por token |
|
ProviderId
|
providerId | True | string |
Definir um provedor de pagamento para um checkout por token |
Devoluções
- Body
- CheckoutDTO
Checkout Obter por Token
Obter um checkout por token
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Obter um checkout por token |
Devoluções
- Body
- CheckoutDTO
Checkout Pagamento Completo
Conclua um pagamento para um checkout por token
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Conclua um pagamento para um checkout por token |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
ID do Cliente
|
customerId | string | ||
|
CheckoutToken
|
checkoutToken | string | ||
|
Montante
|
amount | double | ||
|
Montante da Comissão
|
commissionAmount | double | ||
|
RemessaInformação
|
remittanceInformation | string | ||
|
Provider
|
provider | string | ||
|
Situação
|
status | string | ||
|
Data de Pagamento
|
paymentDate | date-time | ||
|
Data de Criação
|
creationDate | date-time | ||
|
Código de aprovação
|
approvalCode | string | ||
|
Tipo de Cartão
|
cardType | string | ||
|
Número do cartão
|
cardNumber | string | ||
|
Pós-namoro
|
postDating | integer | ||
|
Parcelamento
|
installments | integer | ||
|
BankId
|
bankId | string | ||
|
TransactionId
|
transactionId | string |
Devoluções
- Body
- CheckoutDTO
Cliente Get By Id
Obter um cliente por Id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerId | True | string |
Obter um cliente por Id |
Devoluções
- Body
- CustomerDTO
Coleção Atualizar Conteúdo Adicional
Atualizar conteúdo adicional por ID de coleção
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da coleção
|
collectionId | True | string |
Definir o id da coleção |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Id
|
id | string | ||
|
Title
|
title | string | ||
|
Description
|
description | string | ||
|
Position
|
position | integer | ||
|
MediaItem
|
mediaItem | |||
|
Tradução
|
translation |
Coleção Estendida Get by Alias
Obter coleção estendida por alias
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Linguagem
|
lang | string |
Definir o idioma |
|
|
Alias
|
alias | True | string |
Definir o alias da coleção |
Devoluções
- Body
- CollectionDTO
Coleção Estendida Get by Id
Obter coleção estendida por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Linguagem
|
lang | string |
Definir o idioma |
|
|
Id
|
id | True | string |
Definir o id da coleção |
Devoluções
- Body
- CollectionDTO
Coleção Excluir conteúdo adicional
Excluir conteúdo adicional por ID de coleção
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da coleção
|
collectionId | True | string |
Definir o id da coleção |
Coleção Get by Id
Obter coleção por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da coleção
|
collectionId | True | string |
Definir o id da coleção |
Devoluções
- Body
- CollectionDTO
Coleção Obter conteúdo adicional por ID
Obter conteúdo adicional por ID de coleção
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da coleção
|
collectionId | True | string |
Definir o id da coleção |
Devoluções
- Body
- DocumentationDTO
Coleção Obter conteúdo adicional por ID (HTML)
Obter conteúdo adicional por ID de coleção
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da coleção
|
collectionId | True | string |
Definir o id da coleção |
Devoluções
- Body
- DocumentationDTO
Combinações de atualização de sortimento
Atualizar uma combinação de classificação por ID do cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerId | True | string |
Atualizar uma combinação de classificação por ID do cliente |
|
BranchId
|
branchId | string | ||
|
CategoriaId
|
categoryId | string | ||
|
TypeId
|
typeId | string |
Devoluções
- Body
- AssortmentDTO
Conjunto de atributos Obter por ID
Obter atributo definido por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir a id do conjunto de atributos |
Devoluções
- Body
- AttributeSetDTO
Consulta ao Grupo de Clientes
Obter todos os grupos de clientes
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Situação
|
Status | string |
Obter todos os grupos de clientes por status |
|
|
Title
|
Title | string |
Obtenha 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 |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of CustomerGroupDTO
Consulta de atributos
Obter atributos por critérios de pesquisa
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Situação
|
Status | string |
Definir o status do atributo |
|
|
Tipo
|
Type | string |
Definir o tipo do atributo |
|
|
É filtrável
|
IsFilterable | boolean |
Definir o é filtrável 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 |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- Body
- AttributeDTO
Consulta de categoria
Obter categorias por critérios de pesquisa
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | string |
Definir o título da categoria |
|
|
Id
|
Id | string |
Definir o id da categoria |
|
|
Pesquisa
|
Search | string |
Definir a palavra-chave de pesquisa para a categoria |
|
|
Código
|
Code | string |
Definir o código da categoria |
|
|
ID principal
|
ParentId | string |
Definir o 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 |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of CategoryDTO
Consulta de classificações
Obtenha todos os sortimentos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
CustomerId | string |
Obtenha todas as classificações 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 |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of AssortmentDTO
Consulta de Coleção
Obter coleções por critérios de pesquisa
Parâmetros
| Name | Chave | Necessá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 o 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 |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- Body
- CollectionDTO
Consulta de conjunto de atributos
Obter conjuntos de atributos por critérios de pesquisa
Parâmetros
| Name | Chave | Necessá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 |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of AttributeSetDTO
Consulta de disponibilidade de estoque
Consultar disponibilidade de estoque
Parâmetros
| Name | Chave | Necessá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 |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of StockAvailabilityDTO
Consulta de Encomenda
Receba todas as encomendas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Pesquisa
|
Search | string |
Pesquisar texto |
|
|
Código
|
Code | string |
Receba todas as encomendas por código |
|
|
ID do Cliente
|
CustomerId | string |
Obter todas as encomendas por ID de cliente |
|
|
Estado da Encomenda
|
OrderStatus | string |
Obter todas as encomendas por estado da encomenda |
|
|
Situação
|
Status | string |
Obter todas as encomendas por estado |
|
|
Tag
|
Tag | string |
Obter todas as encomendas por etiqueta |
|
|
Código do Cliente
|
CustomerCode | string |
Obter todas as encomendas por código de cliente |
|
|
Lata do cliente
|
CustomerTin | string |
Receba todas as encomendas por estanho do cliente |
|
|
Inserir data
|
InsertDate | string |
Obter todas as encomendas por inserir data |
|
|
Página
|
Page | integer |
Definir o número da página |
|
|
Tamanho da página
|
PageSize | integer |
Definir o tamanho da página |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of OrderDTO
Consulta de etiquetas de produtos
Consultar rótulos de produtos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome
|
Name | string |
Definir o nome |
|
|
Situação
|
Status | string |
Definir o estado |
|
|
Página
|
Page | integer |
Definir o número da página |
|
|
Tamanho da página
|
PageSize | integer |
Definir o tamanho da página |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of IcoTagDTO
Consulta de Marca
Obter marcas por critérios de pesquisa
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Situação
|
Status | string |
Definir o status da marca |
|
|
Pesquisa
|
Search | string |
Definir a pesquisa da marca |
|
|
Código
|
Code | string |
Definir o código da marca |
|
|
Id
|
Id | string |
Definir o 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 |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of BrandDTO
Consulta de Nível de Inventário
Obtenha todos os níveis de estoque
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Localização
|
Location | string |
Obtenha todos os níveis de inventário por local |
|
|
Ids de variantes
|
VariantIds | string |
Obtenha todos os níveis de estoque por IDs de variante |
|
|
Página
|
Page | integer |
Definir o número da página |
|
|
Tamanho da página
|
PageSize | integer |
Definir o tamanho da página |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of InventoryLevelDTO
Consulta de unidade
Unidades de consulta
Parâmetros
| Name | Chave | Necessá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 |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of UnitDTO
Consulta do Cliente
Obter todos os clientes
Parâmetros
| Name | Chave | Necessá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 |
|
|
Identificação do vendedor
|
SalesmanId | string |
Obter todos os clientes por ID de 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 |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of CustomerDTO
Consulta do Grupo de Privacidade
Consultar grupos de privacidade
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | string |
Definir o título |
|
|
Situação
|
Status | string |
Definir o estado |
|
|
IDs do cliente
|
CustomerIds | string |
Definir os IDs do cliente |
|
|
Ids de 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 |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of PrivacyGroupDTO
Consulta do produto
Consultar produtos
Parâmetros
| Name | Chave | Necessá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 |
Defina a data 1 |
|
|
Data 2
|
Date2 | string |
Defina a data 2 |
|
|
Data 3
|
Date3 | string |
Defina a data 3 |
|
|
Data 1 Intervalo de datas
|
Date1DateRange | string |
Definir o intervalo de datas 1 |
|
|
Data 2 Intervalo de datas
|
Date2DateRange | string |
Definir o intervalo de datas 2 |
|
|
Data 3 Intervalo de datas
|
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 Min
|
MinPrice | double |
Definir o preço mínimo |
|
|
Situação
|
Status | string |
Definir o estado |
|
|
Disponibilidade
|
Availability | string |
Definir a disponibilidade |
|
|
Tag
|
Tag | string |
Definir a etiqueta |
|
|
Tag de origem
|
SourceTag | string |
Definir a tag de origem |
|
|
Regra de Privacidade
|
PrivacyRule | string |
Definir a regra de privacidade |
|
|
Regra
|
Rule | string |
Definir a regra |
|
|
Condition
|
Condition | string |
Definir a condição |
|
|
Ids
|
Ids | string |
Definir os ids |
|
|
Id
|
Id | string |
Definir o id |
|
|
Intervalo de preços
|
PriceRange | string |
Definir o intervalo de preços |
|
|
Código da Marca
|
BrandCode | string |
Definir o código da marca |
|
|
ID da marca
|
BrandId | string |
Definir o ID da marca |
|
|
Attribute
|
Attribute | string |
Definir o atributo |
|
|
Categoria do caminho
|
PathCategory | string |
Definir a categoria do caminho |
|
|
ID da categoria
|
CategoryId | string |
Definir o ID da categoria |
|
|
ID da categoria adicional
|
AdditionalCategoryId | string |
Definir o ID de categoria adicional |
|
|
ID de disponibilidade de estoque
|
StockAvailabilityId | string |
Definir o id de disponibilidade de estoque |
|
|
ID do conjunto de atributos
|
AttributeSetId | string |
Definir o id do conjunto de atributos |
|
|
Identificação da categoria de preço
|
PriceCategoryId | string |
Definir o ID da categoria de preço |
|
|
Tem Mídia
|
HasMedia | boolean |
Definir o tem mídia |
|
|
Id mestre
|
MasterId | string |
Definir o ID mestre |
|
|
Página
|
Page | integer |
Definir o número da página |
|
|
Tamanho da página
|
PageSize | integer |
Definir o tamanho da página |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of ProductDTO
Consulta estendida de coleção
Consultar coleções estendidas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Situação
|
Status | string |
Definir o estado |
|
|
Title
|
Title | string |
Definir o título |
|
|
Id
|
Id | string |
Definir o id |
|
|
Página
|
Page | integer |
Definir o número da página |
|
|
Tamanho da página
|
PageSize | integer |
Definir o tamanho da página |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
|
|
Linguagem
|
lang | string |
Definir o idioma |
Devoluções
- response
- array of CollectionDTO
Consulta estendida do produto
Consultar produtos estendidos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Linguagem
|
lang | string |
Definir o idioma |
|
|
Estender
|
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 |
Defina a data 1 |
|
|
Data 2
|
Date2 | string |
Defina a data 2 |
|
|
Data 3
|
Date3 | string |
Defina a data 3 |
|
|
Data 1 Intervalo de datas
|
Date1DateRange | string |
Definir o intervalo de datas 1 |
|
|
Data 2 Intervalo de datas
|
Date2DateRange | string |
Definir o intervalo de datas 2 |
|
|
Data 3 Intervalo de datas
|
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 Min
|
MinPrice | double |
Definir o preço mínimo |
|
|
Situação
|
Status | string |
Definir o estado |
|
|
Disponibilidade
|
Availability | string |
Definir a disponibilidade |
|
|
Tag
|
Tag | string |
Definir a etiqueta |
|
|
Tag de origem
|
SourceTag | string |
Definir a tag de origem |
|
|
Regra de Privacidade
|
PrivacyRule | string |
Definir a regra de privacidade |
|
|
Regra
|
Rule | string |
Definir a regra |
|
|
Condition
|
Condition | string |
Definir a condição |
|
|
Ids
|
Ids | string |
Definir os ids |
|
|
Id
|
Id | string |
Definir o id |
|
|
Intervalo de preços
|
PriceRange | string |
Definir o intervalo de preços |
|
|
Código da Marca
|
BrandCode | string |
Definir o código da marca |
|
|
ID da marca
|
BrandId | string |
Definir o ID da marca |
|
|
Attribute
|
Attribute | string |
Definir o atributo |
|
|
Categoria do caminho
|
PathCategory | string |
Definir a categoria do caminho |
|
|
ID da categoria
|
CategoryId | string |
Definir o ID da categoria |
|
|
ID da categoria adicional
|
AdditionalCategoryId | string |
Definir o ID de categoria adicional |
|
|
ID de disponibilidade de estoque
|
StockAvailabilityId | string |
Definir o id de disponibilidade de estoque |
|
|
ID do conjunto de atributos
|
AttributeSetId | string |
Definir o id do conjunto de atributos |
|
|
Identificação da categoria de preço
|
PriceCategoryId | string |
Definir o ID da categoria de preço |
|
|
Tem Mídia
|
HasMedia | boolean |
Definir o tem mídia |
|
|
Id mestre
|
MasterId | string |
Definir o ID mestre |
|
|
Página
|
Page | integer |
Definir o número da página |
|
|
Tamanho da página
|
PageSize | integer |
Definir o tamanho da página |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of ExtendedProductDTO
Conteúdo adicional de atualização de marca
Atualizar conteúdo adicional por ID de marca
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da marca
|
brandId | True | string |
Definir o id da marca |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Id
|
id | string | ||
|
Title
|
title | string | ||
|
Description
|
description | string | ||
|
Position
|
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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Produto
|
productId | True | string |
Definir o id do produto |
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Id
|
id | string | ||
|
Title
|
title | string | ||
|
Description
|
description | string | ||
|
Position
|
position | integer | ||
|
MediaItem
|
mediaItem | |||
|
Tradução
|
translation |
Criar carrinho
Criar carrinho
Parâmetros
| Name | Chave | Necessá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 |
Devoluções
- Body
- CartDTO
Criar Categoria
Criar categoria
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Title
|
title | True | string | |
|
Código
|
code | True | string | |
|
Alias
|
alias | string | ||
|
Description
|
description | string | ||
|
Position
|
position | integer | ||
|
DisplayInMenu
|
displayInMenu | boolean | ||
|
DisplayAsList
|
displayAsList | boolean | ||
|
ParentId
|
parentId | string | ||
|
Caminho
|
path | string | ||
|
MediaItem
|
mediaItem | |||
|
Tradução
|
translation | |||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
TreeIds
|
treeIds | array of string | ||
|
Link
|
link | string | ||
|
Situação
|
status | string |
Devoluções
- Body
- CategoryDTO
Criar Checkout
Criar um checkout por token
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Criar um checkout por token |
|
Linguagem
|
lang | string |
Linguagem |
Devoluções
- Body
- CheckoutDTO
Criar coleção
Criar coleção
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Title
|
title | string | ||
|
Description
|
description | string | ||
|
DescriçãoHtml
|
descriptionHtml | string | ||
|
Link
|
link | string | ||
|
Alias
|
alias | string | ||
|
MediaItem
|
mediaItem | |||
|
Situação
|
status | string | ||
|
Mode
|
mode | string | ||
|
Publicadoem em
|
publishedAt | date-time | ||
|
SortOrder
|
sortOrder | string | ||
|
Contagem de produtos
|
productCount | integer | ||
|
Ids de produto
|
productIds | array of string | ||
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
DescriçãoPlain
|
descriptionPlain | string | ||
|
Link
|
link | string | ||
|
Id
|
id | string | ||
|
GalleryId
|
galleryId | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Link
|
link | string | ||
|
Position
|
position | integer | ||
|
Alt
|
alt | string | ||
|
MediaType
|
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ço unitário
|
unitPrice | double | ||
|
Preço
|
price | double | ||
|
Msrp
|
msrp | double | ||
|
Quantidade
|
quantity | double | ||
|
Preço Inicial
|
initialPrice | double | ||
|
Dimension1ItemId
|
dimension1ItemId | string | ||
|
Dimension2ItemId
|
dimension2ItemId | string | ||
|
Dimension3ItemId
|
dimension3ItemId | string | ||
|
ShippingWeight
|
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 | ||
|
Requer: Envio
|
requiresShipping | boolean | ||
|
Sku
|
sku | string | ||
|
Tradução
|
translation | |||
|
CanOrder
|
canOrder | boolean | ||
|
Características adicionais
|
additionalFeatures | |||
|
Esperado
|
expected | |||
|
MinOrderQuantity
|
minOrderQuantity | double | ||
|
OrderQuantityStep
|
orderQuantityStep | double | ||
|
AttributeId
|
attributeId | string | ||
|
AttributeItemId
|
attributeItemId | string | ||
|
AttributeItemValue
|
attributeItemValue | string | ||
|
Tradução
|
translation | |||
|
Preço Máximo
|
maxPrice | double | ||
|
Preço Mínimo
|
minPrice | double | ||
|
PathCategories
|
pathCategories | array of string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
VariantCount
|
variantCount | integer | ||
|
Características adicionais
|
additionalFeatures | |||
|
Dimensão1
|
dimension1 | |||
|
Dimensão2
|
dimension2 | |||
|
Dimensão3
|
dimension3 | |||
|
Atributos de pesquisa
|
searchAttributes | array of string | ||
|
Código do IVA
|
vatCode | string | ||
|
ReducedVatCode
|
reducedVatCode | string | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Taxa de IVA reduzida
|
reducedVatRate | double | ||
|
Title
|
title | string | ||
|
Subtítulo
|
subTitle | string | ||
|
Description
|
description | string | ||
|
Alias
|
alias | string | ||
|
Situação
|
status | string | ||
|
BrandId
|
brandId | string | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
CategoriaId
|
categoryId | string | ||
|
PriceCategoryId
|
priceCategoryId | string | ||
|
AdditionalCategoryIds
|
additionalCategoryIds | array of string | ||
|
Etiquetas
|
tags | array of string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
AdditionalSearchTags
|
additionalSearchTags | array of string | ||
|
Disponibilidade
|
availability | string | ||
|
Tradução
|
translation | |||
|
Ordem de parada
|
stopOrder | boolean | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
StockAvailabilityModelId
|
stockAvailabilityModelId | string | ||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Tradução
|
translation | |||
|
AttributeSetId
|
attributeSetId | string | ||
|
Data de classificação
|
sortDate | date-time | ||
|
Sortimentos
|
assortments | array of string | ||
|
MasterId
|
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 | ||
|
Identificação da empresa
|
companyId | string | ||
|
Title
|
title | string | ||
|
Description
|
description | string | ||
|
DescriçãoHtml
|
descriptionHtml | string | ||
|
Link
|
link | string | ||
|
Alias
|
alias | string | ||
|
MediaItem
|
mediaItem | |||
|
Situação
|
status | string | ||
|
Mode
|
mode | string | ||
|
Publicadoem em
|
publishedAt | date-time | ||
|
SortOrder
|
sortOrder | string | ||
|
Contagem de produtos
|
productCount | integer | ||
|
Ids de produto
|
productIds | array of string | ||
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
DescriçãoPlain
|
descriptionPlain | string | ||
|
Link
|
link | string | ||
|
Id
|
id | string | ||
|
GalleryId
|
galleryId | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Link
|
link | string | ||
|
Position
|
position | integer | ||
|
Alt
|
alt | string | ||
|
MediaType
|
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ço unitário
|
unitPrice | double | ||
|
Preço
|
price | double | ||
|
Msrp
|
msrp | double | ||
|
Quantidade
|
quantity | double | ||
|
Preço Inicial
|
initialPrice | double | ||
|
Dimension1ItemId
|
dimension1ItemId | string | ||
|
Dimension2ItemId
|
dimension2ItemId | string | ||
|
Dimension3ItemId
|
dimension3ItemId | string | ||
|
ShippingWeight
|
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 | ||
|
Requer: Envio
|
requiresShipping | boolean | ||
|
Sku
|
sku | string | ||
|
Tradução
|
translation | |||
|
CanOrder
|
canOrder | boolean | ||
|
Características adicionais
|
additionalFeatures | |||
|
Esperado
|
expected | |||
|
MinOrderQuantity
|
minOrderQuantity | double | ||
|
OrderQuantityStep
|
orderQuantityStep | double | ||
|
AttributeId
|
attributeId | string | ||
|
AttributeItemId
|
attributeItemId | string | ||
|
AttributeItemValue
|
attributeItemValue | string | ||
|
Tradução
|
translation | |||
|
Preço Máximo
|
maxPrice | double | ||
|
Preço Mínimo
|
minPrice | double | ||
|
PathCategories
|
pathCategories | array of string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
VariantCount
|
variantCount | integer | ||
|
Características adicionais
|
additionalFeatures | |||
|
Dimensão1
|
dimension1 | |||
|
Dimensão2
|
dimension2 | |||
|
Dimensão3
|
dimension3 | |||
|
Atributos de pesquisa
|
searchAttributes | array of string | ||
|
Código do IVA
|
vatCode | string | ||
|
ReducedVatCode
|
reducedVatCode | string | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Taxa de IVA reduzida
|
reducedVatRate | double | ||
|
Title
|
title | string | ||
|
Subtítulo
|
subTitle | string | ||
|
Description
|
description | string | ||
|
Alias
|
alias | string | ||
|
Situação
|
status | string | ||
|
BrandId
|
brandId | string | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
CategoriaId
|
categoryId | string | ||
|
PriceCategoryId
|
priceCategoryId | string | ||
|
AdditionalCategoryIds
|
additionalCategoryIds | array of string | ||
|
Etiquetas
|
tags | array of string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
AdditionalSearchTags
|
additionalSearchTags | array of string | ||
|
Disponibilidade
|
availability | string | ||
|
Tradução
|
translation | |||
|
Ordem de parada
|
stopOrder | boolean | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
StockAvailabilityModelId
|
stockAvailabilityModelId | string | ||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Tradução
|
translation | |||
|
AttributeSetId
|
attributeSetId | string | ||
|
Data de classificação
|
sortDate | date-time | ||
|
Sortimentos
|
assortments | array of string | ||
|
MasterId
|
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 | ||
|
InserirData
|
insertDate | date-time | ||
|
Etiquetas
|
tags | array of string | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
Tradução
|
translation | |||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Etiquetas
|
tags | array of string | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
Tradução
|
translation | |||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string |
Criar conjunto de atributos
Criar conjunto de atributos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
title | string | ||
|
Description
|
description | string | ||
|
Title
|
title | string | ||
|
Id
|
id | string | ||
|
Position
|
position | integer | ||
|
Id
|
id | string | ||
|
Position
|
position | integer |
Devoluções
- Body
- AttributeSetDTO
Criar Encomenda
Criar uma encomenda
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Código
|
code | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
CheckoutToken
|
checkoutToken | string | ||
|
CartToken
|
cartToken | string | ||
|
Situação
|
status | string | ||
|
ID do Cliente
|
customerId | string | ||
|
ClienteBranchId
|
customerBranchId | string | ||
|
CustomerBranchSourceId
|
customerBranchSourceId | string | ||
|
CustomerTin
|
customerTin | string | ||
|
Nome do Cliente
|
customerName | string | ||
|
Código do Cliente
|
customerCode | string | ||
|
CustomerSourceId
|
customerSourceId | string | ||
|
CustomerBranchName
|
customerBranchName | string | ||
|
Moeda
|
currency | string | ||
|
Cancelado
|
cancelledAt | date-time | ||
|
Data de entrega
|
deliveryDate | date-time | ||
|
CancelamentoMotivo
|
cancellationReason | string | ||
|
Fechado
|
closedAt | date-time | ||
|
Código de referência
|
referenceCode | string | ||
|
DescontoTaxa
|
discountRate | double | ||
|
DescontoValor
|
discountValue | double | ||
|
TotalMontante
|
totalAmount | double | ||
|
Montante líquido
|
netAmount | double | ||
|
Montante do IVA
|
vatAmount | double | ||
|
DespesaMontante
|
expenseAmount | double | ||
|
Situação financeira
|
financialStatus | string | ||
|
Status de Cumprimento
|
fulfillmentStatus | string | ||
|
Endereço de Faturação
|
billingAddress | |||
|
Endereço de envio
|
shippingAddress | |||
|
RequiresCalculation
|
requiresCalculation | boolean | ||
|
Id
|
id | string | ||
|
ID do Produto
|
productId | string | ||
|
ProductVariantId
|
productVariantId | string | ||
|
ProductTitle (Título do produto)
|
productTitle | string | ||
|
UnitId
|
unitId | string | ||
|
SalesUnitId
|
salesUnitId | string | ||
|
Quantidade
|
quantity | double | ||
|
UnitQuantity
|
unitQuantity | double | ||
|
Valor Líquido
|
netValue | double | ||
|
Preço
|
price | double | ||
|
Valor da despesa
|
expenseValue | double | ||
|
PreçoValor1
|
priceValue1 | double | ||
|
PreçoValor2
|
priceValue2 | double | ||
|
PreçoValor3
|
priceValue3 | double | ||
|
Preço unitário
|
unitPrice | double | ||
|
LineValue
|
lineValue | double | ||
|
DescontoValor
|
discountValue | double | ||
|
DescontoTaxa
|
discountRate | double | ||
|
VatValue
|
vatValue | double | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Código do IVA
|
vatCode | string | ||
|
Sku
|
sku | string | ||
|
Dimensão1Legenda
|
dimension1Caption | string | ||
|
Dimensão2Legenda
|
dimension2Caption | string | ||
|
Dimension3Caption
|
dimension3Caption | string | ||
|
Dimensão1Valor
|
dimension1Value | string | ||
|
Dimensão2Valor
|
dimension2Value | string | ||
|
Dimensão3Valor
|
dimension3Value | string | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Montante do IVA
|
vatAmount | double | ||
|
Código do IVA
|
vatCode | string | ||
|
Montante líquido
|
netAmount | double | ||
|
Etiquetas
|
tags | array of string | ||
|
FonteId
|
sourceId | string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
Observações
|
notes | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Favorito
|
favorite | boolean | ||
|
UserId
|
userId | string | ||
|
InvoiceUrl
|
invoiceUrl | string | ||
|
Notificar
|
notify | string | ||
|
Notificado
|
notified | array of string | ||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Linha de Envio
|
shippingLine | |||
|
ID do Produto
|
productId | string | ||
|
ProductVariantId
|
productVariantId | string | ||
|
ProductTitle (Título do produto)
|
productTitle | string | ||
|
Quantidade
|
quantity | double | ||
|
Código do IVA
|
vatCode | string | ||
|
ImagemLink
|
imageLink | string | ||
|
ProductAlias
|
productAlias | string | ||
|
Id
|
id | string | ||
|
Valor Líquido
|
netValue | double | ||
|
VatValue
|
vatValue | double | ||
|
Pagamento
|
payment | |||
|
SeriesId
|
seriesId | string |
Criar etiqueta de produto
Criar etiqueta de produto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Nome
|
name | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Ícone
|
icon | string | ||
|
BackgroundColor
|
backgroundColor | string | ||
|
TextColor
|
textColor | string | ||
|
Ids de produto
|
productIds | array of string | ||
|
RuleEnabled
|
ruleEnabled | boolean | ||
|
DataA partir de
|
dateFrom | date-time | ||
|
DataAté
|
dateTo | date-time | ||
|
Mode
|
mode | string | ||
|
Situação
|
status | string | ||
|
Regra
|
rule | |||
|
Tradução
|
translation |
Devoluções
- Body
- IcoTagDTO
Criar Grupo de Clientes
Criar um grupo de clientes
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Title
|
title | True | string | |
|
Situação
|
status | string | ||
|
Regra
|
rule | |||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time |
Devoluções
- Body
- CustomerGroupDTO
Criar Grupo de Privacidade
Criar grupo de privacidade
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Title
|
title | string | ||
|
Situação
|
status | string | ||
|
Mode
|
mode | string | ||
|
Ids de produto
|
productIds | array of string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Regra
|
rule | |||
|
CustomerGroupIds
|
customerGroupIds | array of string | ||
|
Ids do Cliente
|
customerIds | array of string |
Devoluções
- Body
- PrivacyGroupDTO
Criar Lista de Compras
Criar uma lista de compras
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Title
|
title | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
ID do Cliente
|
customerId | string | ||
|
UserId
|
userId | string | ||
|
Alias
|
alias | string | ||
|
InserirData
|
insertDate | date-time | ||
|
UpdateDate
|
updateDate | date-time | ||
|
ID do Produto
|
productId | string | ||
|
ProductVariantId
|
productVariantId | string |
Devoluções
- Body
- ShoppingListDTO
Criar Nível de Inventário
Criar um nível de inventário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
ProductVariantId
|
productVariantId | string | ||
|
ID do Produto
|
productId | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
LocalizaçãoId
|
locationId | string | ||
|
Quantidade
|
quantity | double | ||
|
Data de entrega
|
deliveryDate | date-time | ||
|
Quantidade Esperada
|
expectedQuantity | double | ||
|
UpdateDate
|
updateDate | date-time |
Devoluções
- Body
- InventoryLevelDTO
Criar sortimento
Criar uma classificação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerId | string | ||
|
Nome
|
name | string | ||
|
Nome
|
name | string |
Devoluções
- Body
- AssortmentDTO
Criação de atributos
Criar atributo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Nome
|
name | True | string | |
|
Código
|
code | True | string | |
|
Description
|
description | string | ||
|
UsedAsFilter
|
usedAsFilter | boolean | ||
|
DisplayOnProduct
|
displayOnProduct | boolean | ||
|
DisplayOnList
|
displayOnList | boolean | ||
|
DisplayOnCompare
|
displayOnCompare | boolean | ||
|
Tipo
|
type | string | ||
|
Campo Dinâmico
|
slug | string | ||
|
Position
|
position | integer | ||
|
Situação
|
status | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Id
|
id | string | ||
|
Código
|
code | string | ||
|
Código de cores
|
colorCode | string | ||
|
Valor
|
value | string | ||
|
Position
|
position | integer | ||
|
Campo Dinâmico
|
slug | string | ||
|
Tradução
|
translation | |||
|
Tradução
|
translation |
Devoluções
- Body
- AttributeDTO
Criação de clientes
Criar um cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Código
|
code | string | ||
|
Nome
|
name | string | ||
|
Estanho
|
tin | string | ||
|
Email
|
string | |||
|
Contato
|
contact | string | ||
|
Telefone de contato
|
contactPhone | string | ||
|
Telemóvel
|
phone | string | ||
|
PriceCategoryId
|
priceCategoryId | string | ||
|
FonteId
|
sourceId | string | ||
|
Etiquetas
|
tags | array of string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
Address
|
address | |||
|
Observações
|
notes | string | ||
|
Situação
|
status | string | ||
|
Id
|
id | string | ||
|
FonteId
|
sourceId | string | ||
|
Código
|
code | string | ||
|
Nome
|
name | string | ||
|
Contato
|
contact | string | ||
|
Telefone de contato
|
contactPhone | string | ||
|
Telemóvel
|
phone | string | ||
|
Address
|
address | |||
|
Situação
|
status | string | ||
|
Características adicionais
|
additionalFeatures | |||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Tradução
|
translation | |||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
SalesmanId
|
salesmanId | string | ||
|
Repartição de Finanças
|
taxOffice | string | ||
|
ContactoLíngua
|
contactLanguage | string | ||
|
Tipo de IVA
|
vatType | string | ||
|
Tipo de Loja
|
shopType | string | ||
|
Nome
|
name | string | ||
|
Address
|
address |
Devoluções
- Body
- CustomerDTO
Criação de disponibilidade de estoque
Criar disponibilidade de stock
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Código
|
code | string | ||
|
Title
|
title | string | ||
|
Tradução
|
translation | |||
|
MediaItem
|
mediaItem | |||
|
Message
|
message | string | ||
|
Quantidade
|
quantity | integer | ||
|
Cor
|
color | string | ||
|
Tradução
|
translation |
Devoluções
- Body
- StockAvailabilityDTO
Criação de Marca
Criar marca
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Código
|
code | True | string | |
|
Nome
|
name | True | string | |
|
Alias
|
alias | string | ||
|
Description
|
description | string | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Situação
|
status | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
MediaItem
|
mediaItem | |||
|
Tradução
|
translation | |||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string |
Devoluções
- Body
- BrandDTO
Criação de Produto
Criar produto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Link
|
link | string | ||
|
Position
|
position | integer | ||
|
Alt
|
alt | string | ||
|
MediaType
|
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ço unitário
|
unitPrice | double | ||
|
Preço
|
price | double | ||
|
Msrp
|
msrp | double | ||
|
Preço Inicial
|
initialPrice | double | ||
|
Dimension1ItemId
|
dimension1ItemId | string | ||
|
Dimension2ItemId
|
dimension2ItemId | string | ||
|
Dimension3ItemId
|
dimension3ItemId | string | ||
|
ShippingWeight
|
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 | ||
|
Requer: Envio
|
requiresShipping | boolean | ||
|
Sku
|
sku | string | ||
|
Tradução
|
translation | |||
|
MinOrderQuantity
|
minOrderQuantity | double | ||
|
OrderQuantityStep
|
orderQuantityStep | double | ||
|
MediaItem
|
mediaItem | |||
|
Dimensão1
|
dimension1 | |||
|
Dimensão2
|
dimension2 | |||
|
Dimensão3
|
dimension3 | |||
|
Código do IVA
|
vatCode | string | ||
|
ReducedVatCode
|
reducedVatCode | string | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Taxa de IVA reduzida
|
reducedVatRate | double | ||
|
Title
|
title | string | ||
|
Subtítulo
|
subTitle | string | ||
|
Description
|
description | string | ||
|
Alias
|
alias | string | ||
|
Situação
|
status | string | ||
|
BrandId
|
brandId | string | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
CategoriaId
|
categoryId | string | ||
|
PriceCategoryId
|
priceCategoryId | string | ||
|
AdditionalCategoryIds
|
additionalCategoryIds | array of string | ||
|
Etiquetas
|
tags | array of string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
AdditionalSearchTags
|
additionalSearchTags | array of string | ||
|
PathCategories
|
pathCategories | array of string | ||
|
Disponibilidade
|
availability | string | ||
|
Tradução
|
translation | |||
|
Ordem de parada
|
stopOrder | boolean | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
StockAvailabilityModelId
|
stockAvailabilityModelId | string | ||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Tradução
|
translation | |||
|
AttributeSetId
|
attributeSetId | string | ||
|
Data de classificação
|
sortDate | date-time | ||
|
Sortimentos
|
assortments | array of string | ||
|
MasterId
|
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 |
Devoluções
- Body
- ProductDTO
Criação de Unidade
Criar unidade
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Código
|
code | True | string | |
|
Nome
|
name | True | string | |
|
Tradução
|
translation | |||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time |
Devoluções
- Body
- UnitDTO
Disponibilidade de estoque de reserva de estoque
Reservar disponibilidade de stock
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | string | ||
|
ID do Produto
|
productId | string | ||
|
ProductVariantId
|
productVariantId | string | ||
|
Quantidade
|
quantity | double |
Devoluções
Disponibilidade de estoque sem reserva
Disponibilidade de stock sem reservas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Desreserve a disponibilidade de estoque por token |
Devoluções
Disponibilidade de Stock Obter por ID
Obter disponibilidade de stock por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id da disponibilidade de estoque |
Devoluções
- Body
- StockAvailabilityDTO
Encomendar Eliminar
Excluir um pedido por Id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Excluir um pedido por Id |
Encomendar Obter por ID
Obter uma encomenda por Id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Obter uma encomenda por Id |
Devoluções
- Body
- OrderDTO
Etiqueta do produto Obter por ID
Obter rótulo do produto por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id do rótulo do produto |
Devoluções
- Body
- IcoTagDTO
Excluir lista de compras
Excluir uma lista de compras por alias
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Alias
|
alias | True | string |
Obter uma lista de compras por alias |
Exclusão de atributo
Excluir atributo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir a id do atributo |
Exclusão de carrinho
Excluir carrinho por token
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
token
|
token | True | string |
Excluir carrinho por token |
Exclusão de cliente
Excluir um cliente por Id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerId | True | string |
Excluir um cliente por Id |
Exclusão de coleção
Eliminar coleção
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da coleção
|
collectionId | True | string |
Definir o id da coleção |
Exclusão de disponibilidade de estoque
Excluir disponibilidade de estoque por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id da disponibilidade de estoque |
Exclusão de grupo de clientes
Excluir um grupo de clientes por Id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
Id | True | string |
Excluir um grupo de clientes por Id |
Exclusão de local
Excluir um local por Id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da localização
|
locationId | True | string |
Excluir um local por Id |
Exclusão de marca
Excluir marca
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da marca
|
brandId | True | string |
Definir o id da marca |
Exclusão de marca de conteúdo adicional
Excluir conteúdo adicional por ID de marca
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da marca
|
brandId | True | string |
Definir o id da marca |
Exclusão de rótulo do produto
Excluir rótulo do produto por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id do rótulo do produto |
Exclusão de sortimento
Excluir uma classificação por ID do cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerId | True | string |
Excluir uma classificação por ID do cliente |
Exclusão de unidade
Excluir unidade por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id da unidade |
Exclusão do conjunto de atributos
Excluir conjunto de atributos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir a id do conjunto de atributos |
Exclusão do grupo de privacidade
Excluir grupo de privacidade por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir a ID do grupo de privacidade |
Exclusão do nível de inventário
Excluir um nível de inventário por Id
Parâmetros
| Name | Chave | Necessá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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id do produto |
Grupo de Clientes Obter por ID
Obter um grupo de clientes por Id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
Id | True | string |
Obter um grupo de clientes por Id |
Devoluções
- Body
- CustomerGroupDTO
Grupo de clientes Obter por ID do cliente
Obter um grupo de clientes por ID de cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerId | string |
Obter um grupo de clientes por ID de cliente |
Devoluções
- Body
- CustomerGroupDTO
Grupo de Privacidade Obter por ID
Obter grupo de privacidade por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir a ID do grupo de privacidade |
Devoluções
- Body
- PrivacyGroupDTO
Importação de atributos
Importar atributos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Nome
|
name | True | string | |
|
Código
|
code | True | string | |
|
Description
|
description | string | ||
|
UsedAsFilter
|
usedAsFilter | boolean | ||
|
DisplayOnProduct
|
displayOnProduct | boolean | ||
|
DisplayOnList
|
displayOnList | boolean | ||
|
DisplayOnCompare
|
displayOnCompare | boolean | ||
|
Tipo
|
type | string | ||
|
Campo Dinâmico
|
slug | string | ||
|
Position
|
position | integer | ||
|
Situação
|
status | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Id
|
id | string | ||
|
Código
|
code | string | ||
|
Código de cores
|
colorCode | string | ||
|
Valor
|
value | string | ||
|
Position
|
position | integer | ||
|
Campo Dinâmico
|
slug | string | ||
|
Tradução
|
translation | |||
|
Tradução
|
translation |
Importação de clientes
Importar clientes
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Endereço1
|
address1 | string | ||
|
Endereço2
|
address2 | string | ||
|
City
|
city | string | ||
|
Estado
|
state | string | ||
|
Country
|
country | string | ||
|
Código de País
|
countryCode | string | ||
|
Código Postal
|
postalCode | string | ||
|
Id
|
id | string | ||
|
FonteId
|
sourceId | string | ||
|
Código
|
code | string | ||
|
Nome
|
name | string | ||
|
Contato
|
contact | string | ||
|
Telefone de contato
|
contactPhone | string | ||
|
Telemóvel
|
phone | string | ||
|
Address
|
address | |||
|
Tipo de IVA
|
vatType | string | ||
|
Situação
|
status | string | ||
|
ContactoLíngua
|
contactLanguage | string | ||
|
Endereço1
|
address1 | string | ||
|
Endereço2
|
address2 | string | ||
|
City
|
city | string | ||
|
Estado
|
state | string | ||
|
Country
|
country | string | ||
|
Código de País
|
countryCode | string | ||
|
Código Postal
|
postalCode | string | ||
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Código
|
code | string | ||
|
Nome
|
name | string | ||
|
Estanho
|
tin | string | ||
|
Email
|
string | |||
|
Contato
|
contact | string | ||
|
Telefone de contato
|
contactPhone | string | ||
|
Telemóvel
|
phone | string | ||
|
PriceCategoryId
|
priceCategoryId | string | ||
|
FonteId
|
sourceId | string | ||
|
Etiquetas
|
tags | array of string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
Address
|
address | |||
|
Observações
|
notes | string | ||
|
Situação
|
status | string | ||
|
Características adicionais
|
additionalFeatures | |||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Tradução
|
translation | |||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
SalesmanId
|
salesmanId | string | ||
|
Repartição de Finanças
|
taxOffice | string | ||
|
ContactoLíngua
|
contactLanguage | string | ||
|
Tipo de IVA
|
vatType | string | ||
|
Tipo de Loja
|
shopType | string | ||
|
Nome
|
name | string | ||
|
Address
|
address |
Importação de Encomendas
Ordens de importação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Código
|
code | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
CheckoutToken
|
checkoutToken | string | ||
|
CartToken
|
cartToken | string | ||
|
Situação
|
status | string | ||
|
ID do Cliente
|
customerId | string | ||
|
ClienteBranchId
|
customerBranchId | string | ||
|
CustomerBranchSourceId
|
customerBranchSourceId | string | ||
|
CustomerTin
|
customerTin | string | ||
|
Nome do Cliente
|
customerName | string | ||
|
Código do Cliente
|
customerCode | string | ||
|
CustomerSourceId
|
customerSourceId | string | ||
|
CustomerBranchName
|
customerBranchName | string | ||
|
Moeda
|
currency | string | ||
|
Cancelado
|
cancelledAt | date-time | ||
|
Data de entrega
|
deliveryDate | date-time | ||
|
CancelamentoMotivo
|
cancellationReason | string | ||
|
Fechado
|
closedAt | date-time | ||
|
Código de referência
|
referenceCode | string | ||
|
DescontoTaxa
|
discountRate | double | ||
|
DescontoValor
|
discountValue | double | ||
|
TotalMontante
|
totalAmount | double | ||
|
Montante líquido
|
netAmount | double | ||
|
Montante do IVA
|
vatAmount | double | ||
|
DespesaMontante
|
expenseAmount | double | ||
|
Situação financeira
|
financialStatus | string | ||
|
Status de Cumprimento
|
fulfillmentStatus | string | ||
|
Endereço de Faturação
|
billingAddress | |||
|
Endereço de envio
|
shippingAddress | |||
|
RequiresCalculation
|
requiresCalculation | boolean | ||
|
Id
|
id | string | ||
|
ID do Produto
|
productId | string | ||
|
ProductVariantId
|
productVariantId | string | ||
|
ProductTitle (Título do produto)
|
productTitle | string | ||
|
UnitId
|
unitId | string | ||
|
SalesUnitId
|
salesUnitId | string | ||
|
Quantidade
|
quantity | double | ||
|
UnitQuantity
|
unitQuantity | double | ||
|
Valor Líquido
|
netValue | double | ||
|
Preço
|
price | double | ||
|
Valor da despesa
|
expenseValue | double | ||
|
PreçoValor1
|
priceValue1 | double | ||
|
PreçoValor2
|
priceValue2 | double | ||
|
PreçoValor3
|
priceValue3 | double | ||
|
Preço unitário
|
unitPrice | double | ||
|
LineValue
|
lineValue | double | ||
|
DescontoValor
|
discountValue | double | ||
|
DescontoTaxa
|
discountRate | double | ||
|
VatValue
|
vatValue | double | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Código do IVA
|
vatCode | string | ||
|
Sku
|
sku | string | ||
|
Dimensão1Legenda
|
dimension1Caption | string | ||
|
Dimensão2Legenda
|
dimension2Caption | string | ||
|
Dimension3Caption
|
dimension3Caption | string | ||
|
Dimensão1Valor
|
dimension1Value | string | ||
|
Dimensão2Valor
|
dimension2Value | string | ||
|
Dimensão3Valor
|
dimension3Value | string | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Montante do IVA
|
vatAmount | double | ||
|
Código do IVA
|
vatCode | string | ||
|
Montante líquido
|
netAmount | double | ||
|
Etiquetas
|
tags | array of string | ||
|
FonteId
|
sourceId | string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
Observações
|
notes | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
Favorito
|
favorite | boolean | ||
|
UserId
|
userId | string | ||
|
InvoiceUrl
|
invoiceUrl | string | ||
|
Notificar
|
notify | string | ||
|
Notificado
|
notified | array of string | ||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Linha de Envio
|
shippingLine | |||
|
ID do Produto
|
productId | string | ||
|
ProductVariantId
|
productVariantId | string | ||
|
ProductTitle (Título do produto)
|
productTitle | string | ||
|
Quantidade
|
quantity | double | ||
|
Código do IVA
|
vatCode | string | ||
|
ImagemLink
|
imageLink | string | ||
|
ProductAlias
|
productAlias | string | ||
|
Id
|
id | string | ||
|
Valor Líquido
|
netValue | double | ||
|
VatValue
|
vatValue | double | ||
|
Pagamento
|
payment | |||
|
SeriesId
|
seriesId | string |
Importação de Marca
Importar marcas
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Código
|
code | True | string | |
|
Nome
|
name | True | string | |
|
Alias
|
alias | string | ||
|
Description
|
description | string | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Situação
|
status | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
MediaItem
|
mediaItem | |||
|
Tradução
|
translation | |||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string |
Importação de marca por código
Importar marcas por códigos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Código
|
code | True | string | |
|
Nome
|
name | True | string | |
|
Alias
|
alias | string | ||
|
Description
|
description | string | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Situação
|
status | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
MediaItem
|
mediaItem | |||
|
Tradução
|
translation | |||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string |
Importação de Nível de Estoque
Níveis de estoque de importação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
ProductVariantId
|
productVariantId | string | ||
|
ID do Produto
|
productId | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
LocalizaçãoId
|
locationId | string | ||
|
Quantidade
|
quantity | double | ||
|
Data de entrega
|
deliveryDate | date-time | ||
|
Quantidade Esperada
|
expectedQuantity | double | ||
|
UpdateDate
|
updateDate | date-time |
Importação de produto de tag de origem
Importar produtos de tag de origem
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Nome
|
name | string |
Importação de Produtos
Importar produtos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Código da Categoria
|
categoryCode | string | ||
|
Id
|
id | string | ||
|
Link
|
link | string | ||
|
Position
|
position | integer | ||
|
Alt
|
alt | string | ||
|
MediaType
|
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ço unitário
|
unitPrice | double | ||
|
Preço
|
price | double | ||
|
Msrp
|
msrp | double | ||
|
Preço Inicial
|
initialPrice | double | ||
|
Dimension1ItemId
|
dimension1ItemId | string | ||
|
Dimension2ItemId
|
dimension2ItemId | string | ||
|
Dimension3ItemId
|
dimension3ItemId | string | ||
|
ShippingWeight
|
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 | ||
|
Requer: Envio
|
requiresShipping | boolean | ||
|
Sku
|
sku | string | ||
|
Tradução
|
translation | |||
|
MinOrderQuantity
|
minOrderQuantity | double | ||
|
OrderQuantityStep
|
orderQuantityStep | double | ||
|
MediaItem
|
mediaItem | |||
|
Dimensão1
|
dimension1 | |||
|
Dimensão2
|
dimension2 | |||
|
Dimensão3
|
dimension3 | |||
|
Código do IVA
|
vatCode | string | ||
|
ReducedVatCode
|
reducedVatCode | string | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Taxa de IVA reduzida
|
reducedVatRate | double | ||
|
Title
|
title | string | ||
|
Subtítulo
|
subTitle | string | ||
|
Description
|
description | string | ||
|
Alias
|
alias | string | ||
|
Situação
|
status | string | ||
|
BrandId
|
brandId | string | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
CategoriaId
|
categoryId | string | ||
|
PriceCategoryId
|
priceCategoryId | string | ||
|
AdditionalCategoryIds
|
additionalCategoryIds | array of string | ||
|
Etiquetas
|
tags | array of string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
AdditionalSearchTags
|
additionalSearchTags | array of string | ||
|
PathCategories
|
pathCategories | array of string | ||
|
Disponibilidade
|
availability | string | ||
|
Tradução
|
translation | |||
|
Ordem de parada
|
stopOrder | boolean | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
StockAvailabilityModelId
|
stockAvailabilityModelId | string | ||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Tradução
|
translation | |||
|
AttributeSetId
|
attributeSetId | string | ||
|
Data de classificação
|
sortDate | date-time | ||
|
Sortimentos
|
assortments | array of string | ||
|
MasterId
|
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 por SKU
Importar produtos por SKU
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Código da Categoria
|
categoryCode | string | ||
|
Id
|
id | string | ||
|
Link
|
link | string | ||
|
Position
|
position | integer | ||
|
Alt
|
alt | string | ||
|
MediaType
|
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ço unitário
|
unitPrice | double | ||
|
Preço
|
price | double | ||
|
Msrp
|
msrp | double | ||
|
Preço Inicial
|
initialPrice | double | ||
|
Dimension1ItemId
|
dimension1ItemId | string | ||
|
Dimension2ItemId
|
dimension2ItemId | string | ||
|
Dimension3ItemId
|
dimension3ItemId | string | ||
|
ShippingWeight
|
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 | ||
|
Requer: Envio
|
requiresShipping | boolean | ||
|
Sku
|
sku | string | ||
|
Tradução
|
translation | |||
|
MinOrderQuantity
|
minOrderQuantity | double | ||
|
OrderQuantityStep
|
orderQuantityStep | double | ||
|
MediaItem
|
mediaItem | |||
|
Dimensão1
|
dimension1 | |||
|
Dimensão2
|
dimension2 | |||
|
Dimensão3
|
dimension3 | |||
|
Código do IVA
|
vatCode | string | ||
|
ReducedVatCode
|
reducedVatCode | string | ||
|
Taxa de IVA
|
vatRate | double | ||
|
Taxa de IVA reduzida
|
reducedVatRate | double | ||
|
Title
|
title | string | ||
|
Subtítulo
|
subTitle | string | ||
|
Description
|
description | string | ||
|
Alias
|
alias | string | ||
|
Situação
|
status | string | ||
|
BrandId
|
brandId | string | ||
|
SeoTítulo
|
seoTitle | string | ||
|
SeoDescrição
|
seoDescription | string | ||
|
CategoriaId
|
categoryId | string | ||
|
PriceCategoryId
|
priceCategoryId | string | ||
|
AdditionalCategoryIds
|
additionalCategoryIds | array of string | ||
|
Etiquetas
|
tags | array of string | ||
|
Tags de origem
|
sourceTags | array of string | ||
|
AdditionalSearchTags
|
additionalSearchTags | array of string | ||
|
PathCategories
|
pathCategories | array of string | ||
|
Disponibilidade
|
availability | string | ||
|
Tradução
|
translation | |||
|
Ordem de parada
|
stopOrder | boolean | ||
|
MetaTítulo
|
metaTitle | string | ||
|
MetaDescrição
|
metaDescription | string | ||
|
Metapalavras-chave
|
metaKeywords | array of string | ||
|
StockAvailabilityModelId
|
stockAvailabilityModelId | string | ||
|
Nome
|
name | string | ||
|
Valor
|
value | |||
|
Tradução
|
translation | |||
|
AttributeSetId
|
attributeSetId | string | ||
|
Data de classificação
|
sortDate | date-time | ||
|
Sortimentos
|
assortments | array of string | ||
|
MasterId
|
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 do conjunto de atributos
Importar conjuntos de atributos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Title
|
title | string | ||
|
Description
|
description | string | ||
|
Title
|
title | string | ||
|
Id
|
id | string | ||
|
Position
|
position | integer | ||
|
Id
|
id | string | ||
|
Position
|
position | integer | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time |
Inventário Verificar disponibilidade de estoque
Verificar disponibilidade de stock
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Produto
|
productId | string | ||
|
ProductVariantId
|
productVariantId | string | ||
|
Quantidade
|
quantity | double |
Devoluções
Limpeza de filtros
Limpar filtros
Lista de Compras Obter por Alias
Obter uma lista de compras por alias
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Alias
|
alias | True | string |
Alias |
Devoluções
- Body
- ShoppingListDTO
Lista de Compras Obter Tudo
Localização Criar
Criar uma localização
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Nome
|
name | string | ||
|
IsActive
|
isActive | boolean | ||
|
Address
|
address | |||
|
Telemóvel
|
phone | string | ||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time |
Devoluções
- Body
- LocationDTO
Localização Obter por ID
Obter uma localização por Id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da localização
|
locationId | True | string |
Obter uma localização por Id |
Devoluções
- Body
- LocationDTO
Localização Obter Tudo
Marca Get by Alias
Obter marca por alias
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Alias da marca
|
brandAlias | True | string |
Definir o alias da marca |
Devoluções
- Body
- BrandDTO
Marca Get by Id
Obter marca por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da marca
|
brandId | True | string |
Definir o id da marca |
Devoluções
- Body
- BrandDTO
Marca Obter conteúdo adicional por id
Obter conteúdo adicional por ID de marca
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da marca
|
brandId | True | string |
Definir o id da marca |
Devoluções
- Body
- DocumentationDTO
Marca Obter conteúdo adicional por id (HTML)
Obter conteúdo adicional por ID de marca
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da marca
|
brandId | True | string |
Definir o id da marca |
Devoluções
- Body
- DocumentationDTO
Nível de Inventário Obter por ID
Obter um nível de inventário por Id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Obter um nível de inventário por Id |
Devoluções
- Body
- InventoryLevelDTO
Nível de Inventário Obter por ID de Variante
Obter um nível de inventário por ID de variante
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da variante
|
variantId | True | string |
Obter um nível de inventário por ID de variante |
Devoluções
- response
- array of InventoryLevelDTO
Obtenha todas as variantes de produtos planos
Obtenha todas as variantes de produtos planos
Parâmetros
| Name | Chave | Necessá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 |
Defina a data 1 |
|
|
Data 2
|
Date2 | string |
Defina a data 2 |
|
|
Data 3
|
Date3 | string |
Defina a data 3 |
|
|
Data 1 Intervalo de datas
|
Date1DateRange | string |
Definir o intervalo de datas 1 |
|
|
Data 2 Intervalo de datas
|
Date2DateRange | string |
Definir o intervalo de datas 2 |
|
|
Data 3 Intervalo de datas
|
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 Min
|
MinPrice | double |
Definir o preço mínimo |
|
|
Situação
|
Status | string |
Definir o estado |
|
|
Disponibilidade
|
Availability | string |
Definir a disponibilidade |
|
|
Tag
|
Tag | string |
Definir a etiqueta |
|
|
Tag de origem
|
SourceTag | string |
Definir a tag de origem |
|
|
Regra de Privacidade
|
PrivacyRule | string |
Definir a regra de privacidade |
|
|
Regra
|
Rule | string |
Definir a regra |
|
|
Condition
|
Condition | string |
Definir a condição |
|
|
Ids
|
Ids | string |
Definir os ids |
|
|
Id
|
Id | string |
Definir o id |
|
|
Intervalo de preços
|
PriceRange | string |
Definir o intervalo de preços |
|
|
Código da Marca
|
BrandCode | string |
Definir o código da marca |
|
|
ID da marca
|
BrandId | string |
Definir o ID da marca |
|
|
Attribute
|
Attribute | string |
Definir o atributo |
|
|
Categoria do caminho
|
PathCategory | string |
Definir a categoria do caminho |
|
|
ID da categoria
|
CategoryId | string |
Definir o ID da categoria |
|
|
ID da categoria adicional
|
AdditionalCategoryId | string |
Definir o ID de categoria adicional |
|
|
ID de disponibilidade de estoque
|
StockAvailabilityId | string |
Definir o id de disponibilidade de estoque |
|
|
ID do conjunto de atributos
|
AttributeSetId | string |
Definir o id do conjunto de atributos |
|
|
Identificação da categoria de preço
|
PriceCategoryId | string |
Definir o ID da categoria de preço |
|
|
Tem Mídia
|
HasMedia | boolean |
Definir o tem mídia |
|
|
Id mestre
|
MasterId | string |
Definir o ID mestre |
|
|
Página
|
Page | integer |
Definir o número da página |
|
|
Tamanho da página
|
PageSize | integer |
Definir o tamanho da página |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Produto estendido Get By Alias
Obter produto estendido por alias
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Linguagem
|
lang | string |
Definir o idioma |
|
|
Estender
|
extend | string |
Definir os campos a serem estendidos |
|
|
Alias
|
alias | True | string |
Definir o alias do produto |
Devoluções
- Body
- ExtendedProductDTO
Produto Excluir conteúdo adicional
Excluir conteúdo adicional por ID do produto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Produto
|
productId | True | string |
Definir o id do produto |
Produto Get By Alias
Obter produto por alias
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Alias
|
alias | True | string |
Definir o alias do produto |
Devoluções
- Body
- ProductDTO
Produto Get By Id
Obter produto por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id do produto |
Devoluções
- Body
- ProductDTO
Produto Obter conteúdo adicional por id
Obter conteúdo adicional por ID do produto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Produto
|
productId | True | string |
Definir o id do produto |
Devoluções
- Body
- DocumentationDTO
Produto Obter conteúdo adicional por id (HTML)
Obter conteúdo adicional por ID do produto
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Produto
|
productId | True | string |
Definir o id do produto |
Devoluções
- Body
- DocumentationDTO
Produtos relacionados Criar
Criar produtos relacionados
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Produto
|
productId | True | string |
Definir o ID do produto |
|
ID da variante
|
variantId | True | string |
Definir o id da variante |
Devoluções
Produtos relacionados Excluir
Excluir produtos relacionados
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Produto
|
productId | True | string |
Definir o ID do produto |
|
ID da variante
|
variantId | True | string |
Definir o id da variante |
Recalcular Checkout
Recalcular um checkout por token
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Símbolo
|
token | True | string |
Recalcular um checkout por token |
|
Linguagem
|
lang | string |
Linguagem |
Devoluções
- Body
- CheckoutDTO
Sortimento Obter por ID do cliente
Obtenha uma classificação por ID do cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerId | True | string |
Obtenha uma classificação por ID do cliente |
Devoluções
- Body
- AssortmentDTO
Unidade de Importação
Unidades de importação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | string | ||
|
Identificação da empresa
|
companyId | string | ||
|
Código
|
code | True | string | |
|
Nome
|
name | True | string | |
|
Tradução
|
translation | |||
|
UpdateDate
|
updateDate | date-time | ||
|
InserirData
|
insertDate | date-time |
Unidade Get By Id
Obter unidade por id
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Id
|
id | True | string |
Definir o id da unidade |
Devoluções
- Body
- UnitDTO
Valor de classificação Excluir por ID do cliente e ID de classificação
Excluir valores de classificação por ID do cliente e ID de classificação
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerid | True | string |
Excluir valores de classificação por ID do cliente e ID de classificação |
|
Id
|
id | string |
Excluir valores de classificação por id |
Valores de classificação anexados por ID do cliente
Acrescentar valores de classificação por ID do cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerid | True | string |
Acrescentar valores de classificação por ID do cliente |
|
ID do Produto
|
productId | string | ||
|
CategoriaId
|
categoryId | string | ||
|
TypeId
|
typeId | string | ||
|
Situação
|
status | string | ||
|
Fonte
|
source | string |
Devoluções
- response
- array of AssortmentValueDTO
Valores de classificação excluídos por ID de origem do cliente
Excluir valores de classificação por ID do cliente e origem
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerid | True | string |
Excluir valores de classificação por ID do cliente e origem |
|
Fonte
|
source | True | string |
Excluir valores de classificação por origem |
Valores de classificação excluídos por ID do cliente
Excluir valores de classificação por ID do cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerid | True | string |
Excluir valores de classificação por ID do cliente |
Valores de sortimento obtidos por ID do cliente
Obter valores de classificação por ID do cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerid | True | string |
Obter valores de classificação por ID do cliente |
|
Situação
|
Status | string |
Obter valores de classificação por status |
|
|
Fonte
|
Source | string |
Obter valores de classificação por origem |
|
|
Tipo
|
Type | string |
Obter valores de classificação por tipo |
|
|
Categoria
|
Category | string |
Obter valores de classificação por categoria |
|
|
Id
|
Id | string |
Obter valores de classificação por id |
|
|
ID do Produto
|
ProductId | string |
Obter valores de classificação 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 |
|
|
Ordenar
|
Sort | string |
Definir campo de classificação e direção |
Devoluções
- response
- array of AssortmentValueDTO
Valores de sortimento reconstruídos por ID do cliente
Reconstruir valores de classificação por ID do cliente
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do Cliente
|
customerId | True | string |
Reconstruir valores de classificação por ID do cliente |
Acionadores
| Quando um atributo é atualizado |
Esta operação é acionada quando um atributo é atualizado |
| Quando um atributo é criado |
Esta operação é acionada quando um novo atributo é criado |
| Quando um Attibute é excluído |
Esta operação é acionada quando um atributo é excluído |
|
Quando um Attibute |
Esta operação é acionada quando um attributeSet é excluído |
|
Quando um Attribute |
Esta operação é acionada quando um attributeSet é atualizado |
|
Quando um Attribute |
Esta operação é acionada quando um novo attributeSet é criado |
| Quando um checkout é concluído |
Esta operação é acionada quando um produto é atualizado |
| Quando um Checkout é criado |
Esta operação é acionada quando um novo check-out é criado |
| Quando um cliente é atualizado |
Esta operação é acionada quando um cliente é atualizado |
| Quando um cliente é criado |
Esta operação é acionada quando um novo Cliente é criado |
| Quando um cliente é excluído |
Esta operação é acionada quando um Cliente é excluído |
| Quando um nível de estoque é atualizado |
Esta operação é acionada quando um nível de estoque é atualizado |
| Quando um nível de inventário é criado |
Esta operação é acionada quando um novo nível de estoque é criado |
| Quando um nível de inventário é excluído |
Esta operação é acionada quando um nível de inventário é excluído |
| Quando um pagamento é concluído |
Esta operação é acionada quando um pagamento é excluído |
| Quando um pagamento é iniciado |
Esta operação é acionada quando um pagamento é iniciado |
| Quando um produto é atualizado |
Esta operação é acionada quando um produto é atualizado |
| Quando um produto é criado |
Esta operação é acionada quando um novo produto é criado |
| Quando um produto é excluído |
Esta operação é acionada quando um produto é excluído |
| Quando uma categoria é atualizada |
Esta operação é acionada quando uma categoria é atualizada |
| Quando uma categoria é criada |
Esta operação é acionada quando uma nova categoria é criada |
| Quando uma categoria é excluída |
Esta operação é acionada quando um produto é excluído |
| Quando uma encomenda é atualizada |
Esta operação é acionada quando uma ordem é atualizada |
| Quando uma encomenda é criada |
Esta operação é acionada quando uma nova ordem é criada |
| Quando uma encomenda é eliminada |
Esta operação é acionada quando um pedido é excluído |
| Quando uma marca é atualizada |
Esta operação é acionada quando uma marca é atualizada |
| Quando uma marca é criada |
Esta operação é acionada quando uma nova marca é criada |
| Quando uma marca é excluída |
Esta operação é acionada quando uma marca é excluída |
| Quando uma unidade é atualizada |
Esta operação é acionada quando uma unidade é atualizada |
| Quando uma unidade é criada |
Esta operação é acionada quando uma nova unidade é criada |
| Quando uma unidade é excluída |
Esta operação é acionada quando uma unidade é excluída |
Quando um atributo é atualizado
Esta operação é acionada quando um atributo é atualizado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- AttributeDTO
Quando um atributo é criado
Esta operação é acionada quando um novo atributo é criado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- AttributeDTO
Quando um Attibute é excluído
Esta operação é acionada quando um atributo é excluído
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- AttributeDTO
Quando um AttibuteSet é excluído
Esta operação é acionada quando um attributeSet é excluído
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- AttributeSetDTO
Quando um AttributeSet é atualizado
Esta operação é acionada quando um attributeSet é atualizado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- AttributeSetDTO
Quando um AttributeSet é criado
Esta operação é acionada quando um novo attributeSet é criado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- AttributeSetDTO
Quando um checkout é concluído
Esta operação é acionada quando um produto é atualizado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- CheckoutDTO
Quando um Checkout é criado
Esta operação é acionada quando um novo check-out é criado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- CheckoutDTO
Quando um cliente é atualizado
Esta operação é acionada quando um cliente é atualizado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- CustomerDTO
Quando um cliente é criado
Esta operação é acionada quando um novo Cliente é criado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- CustomerDTO
Quando um cliente é excluído
Esta operação é acionada quando um Cliente é excluído
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- CustomerDTO
Quando um nível de estoque é atualizado
Esta operação é acionada quando um nível de estoque é atualizado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- InventoryLevelDTO
Quando um nível de inventário é criado
Esta operação é acionada quando um novo nível de estoque é criado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- InventoryLevelDTO
Quando um nível de inventário é excluído
Esta operação é acionada quando um nível de inventário é excluído
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- InventoryLevelDTO
Quando um pagamento é concluído
Esta operação é acionada quando um pagamento é excluído
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- PaymentDTO
Quando um pagamento é iniciado
Esta operação é acionada quando um pagamento é iniciado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- PaymentDTO
Quando um produto é atualizado
Esta operação é acionada quando um produto é atualizado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- ProductDTO
Quando um produto é criado
Esta operação é acionada quando um novo produto é criado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- ProductDTO
Quando um produto é excluído
Esta operação é acionada quando um produto é excluído
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- ProductDTO
Quando uma categoria é atualizada
Esta operação é acionada quando uma categoria é atualizada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- CategoryDTO
Quando uma categoria é criada
Esta operação é acionada quando uma nova categoria é criada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- CategoryDTO
Quando uma categoria é excluída
Esta operação é acionada quando um produto é excluído
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- CategoryDTO
Quando uma encomenda é atualizada
Esta operação é acionada quando uma ordem é atualizada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- OrderDTO
Quando uma encomenda é criada
Esta operação é acionada quando uma nova ordem é criada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- OrderDTO
Quando uma encomenda é eliminada
Esta operação é acionada quando um pedido é excluído
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- OrderDTO
Quando uma marca é atualizada
Esta operação é acionada quando uma marca é atualizada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- BrandDTO
Quando uma marca é criada
Esta operação é acionada quando uma nova marca é criada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- BrandDTO
Quando uma marca é excluída
Esta operação é acionada quando uma marca é excluída
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- BrandDTO
Quando uma unidade é atualizada
Esta operação é acionada quando uma unidade é atualizada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- UnitDTO
Quando uma unidade é criada
Esta operação é acionada quando uma nova unidade é criada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- UnitDTO
Quando uma unidade é excluída
Esta operação é acionada quando uma unidade é excluída
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Title
|
Title | True | string |
Title |
Devoluções
- Body
- UnitDTO
Definições
AtributoDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
Nome
|
name | string | |
|
Código
|
code | string | |
|
Description
|
description | string | |
|
UsedAsFilter
|
usedAsFilter | boolean | |
|
DisplayOnProduct
|
displayOnProduct | boolean | |
|
DisplayOnList
|
displayOnList | boolean | |
|
DisplayOnCompare
|
displayOnCompare | boolean | |
|
Tipo
|
type | string | |
|
Campo Dinâmico
|
slug | string | |
|
Position
|
position | integer | |
|
Situação
|
status | string | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
Itens
|
items | array of AttributeItemDTO | |
|
Tradução
|
translation |
AttributeItemDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Código
|
code | string | |
|
Código de cores
|
colorCode | string | |
|
Valor
|
value | string | |
|
Position
|
position | integer | |
|
Campo Dinâmico
|
slug | string | |
|
Tradução
|
translation |
AttributeSetDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
Title
|
title | string | |
|
Description
|
description | string | |
|
Groups
|
groups | array of AttributeSetGroupDTO | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time |
AttributeSetGroupDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Title
|
title | string | |
|
Id
|
id | string | |
|
Position
|
position | integer | |
|
Itens
|
items | array of AttributeSetItemDTO |
AttributeSetItemDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Position
|
position | integer |
BrandDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
Código
|
code | string | |
|
Nome
|
name | string | |
|
Alias
|
alias | string | |
|
Description
|
description | string | |
|
MetaTítulo
|
metaTitle | string | |
|
MetaDescrição
|
metaDescription | string | |
|
Situação
|
status | string | |
|
Metapalavras-chave
|
metaKeywords | array of string | |
|
MediaItem
|
mediaItem | ||
|
Tradução
|
translation | ||
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
SeoTítulo
|
seoTitle | string | |
|
SeoDescrição
|
seoDescription | string |
CategoriaDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
Title
|
title | string | |
|
Código
|
code | string | |
|
Alias
|
alias | string | |
|
Description
|
description | string | |
|
Position
|
position | integer | |
|
DisplayInMenu
|
displayInMenu | boolean | |
|
DisplayAsList
|
displayAsList | boolean | |
|
ParentId
|
parentId | string | |
|
Caminho
|
path | string | |
|
MediaItem
|
mediaItem | ||
|
Tradução
|
translation | ||
|
SeoTítulo
|
seoTitle | string | |
|
SeoDescrição
|
seoDescription | string | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
MetaTítulo
|
metaTitle | string | |
|
MetaDescrição
|
metaDescription | string | |
|
Metapalavras-chave
|
metaKeywords | array of string | |
|
TreeIds
|
treeIds | array of string | |
|
Link
|
link | string | |
|
Situação
|
status | string |
CollectionDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
Title
|
title | string | |
|
Description
|
description | string | |
|
DescriçãoHtml
|
descriptionHtml | string | |
|
Link
|
link | string | |
|
Alias
|
alias | string | |
|
MediaItem
|
mediaItem | ||
|
Situação
|
status | string | |
|
Mode
|
mode | string | |
|
Publicadoem em
|
publishedAt | date-time | |
|
SortOrder
|
sortOrder | string | |
|
Contagem de produtos
|
productCount | integer | |
|
Ids de produto
|
productIds | array of string | |
|
Products
|
products | array of ProductDTO | |
|
Subcoleções
|
subCollections | array of CollectionDTO | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
Etiquetas
|
tags | array of string | |
|
SeoTítulo
|
seoTitle | string | |
|
SeoDescrição
|
seoDescription | string | |
|
Tradução
|
translation | ||
|
MetaTítulo
|
metaTitle | string | |
|
MetaDescrição
|
metaDescription | string | |
|
Metapalavras-chave
|
metaKeywords | array of string |
DocumentaçãoDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
Linhas
|
lines | array of DocumentationLineDTO |
DocumentaçãoLineDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Title
|
title | string | |
|
Description
|
description | string | |
|
Position
|
position | integer | |
|
MediaItem
|
mediaItem | ||
|
Tradução
|
translation |
ExtendedProductDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ProductVariants
|
productVariants | array of ProductVariantExtendedDTO | |
|
Attributes
|
attributes | array of ProductAttributeExtendedDTO | |
|
Conjunto de atributos
|
attributeSet | ||
|
IcoTags
|
icoTags | array of ProductIcoTagExtendedDTO | |
|
Campos Extras
|
extraFields | ||
|
Dimensão1
|
dimension1 | ||
|
Dimensão2
|
dimension2 | ||
|
Dimensão3
|
dimension3 | ||
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
DescriçãoPlain
|
descriptionPlain | string | |
|
Link
|
link | string | |
|
MediaItems
|
mediaItems | array of MediaItemDTO | |
|
Preço Máximo
|
maxPrice | double | |
|
Preço Mínimo
|
minPrice | double | |
|
PathCategories
|
pathCategories | array of string | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
VariantCount
|
variantCount | integer | |
|
Características adicionais
|
additionalFeatures | ||
|
Atributos de pesquisa
|
searchAttributes | array of string | |
|
Código do IVA
|
vatCode | string | |
|
ReducedVatCode
|
reducedVatCode | string | |
|
Taxa de IVA
|
vatRate | double | |
|
Taxa de IVA reduzida
|
reducedVatRate | double | |
|
Title
|
title | string | |
|
Subtítulo
|
subTitle | string | |
|
Description
|
description | string | |
|
Alias
|
alias | string | |
|
Situação
|
status | string | |
|
BrandId
|
brandId | string | |
|
SeoTítulo
|
seoTitle | string | |
|
SeoDescrição
|
seoDescription | string | |
|
CategoriaId
|
categoryId | string | |
|
PriceCategoryId
|
priceCategoryId | string | |
|
AdditionalCategoryIds
|
additionalCategoryIds | array of string | |
|
Etiquetas
|
tags | array of string | |
|
Tags de origem
|
sourceTags | array of string | |
|
AdditionalSearchTags
|
additionalSearchTags | array of string | |
|
Disponibilidade
|
availability | string | |
|
Tradução
|
translation | ||
|
Ordem de parada
|
stopOrder | boolean | |
|
MetaTítulo
|
metaTitle | string | |
|
MetaDescrição
|
metaDescription | string | |
|
Metapalavras-chave
|
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 | |
|
MasterId
|
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
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
Nome
|
name | string | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
Ícone
|
icon | string | |
|
BackgroundColor
|
backgroundColor | string | |
|
TextColor
|
textColor | string | |
|
Ids de produto
|
productIds | array of string | |
|
RuleEnabled
|
ruleEnabled | boolean | |
|
DataA partir de
|
dateFrom | date-time | |
|
DataAté
|
dateTo | date-time | |
|
Mode
|
mode | string | |
|
Situação
|
status | string | |
|
Regra
|
rule | ||
|
Tradução
|
translation |
MediaItemDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
GalleryId
|
galleryId | string | |
|
Identificação da empresa
|
companyId | string | |
|
Link
|
link | string | |
|
Position
|
position | integer | |
|
Alt
|
alt | string | |
|
MediaType
|
mediaType | string | |
|
Largura
|
width | integer | |
|
Altura
|
height | integer |
PrivacyGroupDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
Title
|
title | string | |
|
Situação
|
status | string | |
|
Mode
|
mode | string | |
|
Ids de produto
|
productIds | array of string | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
Regra
|
rule | ||
|
CustomerGroupIds
|
customerGroupIds | array of string | |
|
Ids do Cliente
|
customerIds | array of string |
ProductAttributeDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
AttributeId
|
attributeId | string | |
|
AttributeItemId
|
attributeItemId | string | |
|
AttributeItemValue
|
attributeItemValue | string | |
|
Tradução
|
translation |
ProductAttributeExtendedDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string | |
|
Campo Dinâmico
|
slug | string | |
|
Código
|
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
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string | |
|
Valor
|
value | ||
|
Tradução
|
translation |
ProdutoDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
DescriçãoPlain
|
descriptionPlain | string | |
|
Link
|
link | string | |
|
MediaItems
|
mediaItems | array of MediaItemDTO | |
|
ProductVariants
|
productVariants | array of ProductVariantDTO | |
|
Attributes
|
attributes | array of ProductAttributeDTO | |
|
Preço Máximo
|
maxPrice | double | |
|
Preço Mínimo
|
minPrice | double | |
|
PathCategories
|
pathCategories | array of string | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
VariantCount
|
variantCount | integer | |
|
Características adicionais
|
additionalFeatures | ||
|
Dimensão1
|
dimension1 | ||
|
Dimensão2
|
dimension2 | ||
|
Dimensão3
|
dimension3 | ||
|
Atributos de pesquisa
|
searchAttributes | array of string | |
|
Código do IVA
|
vatCode | string | |
|
ReducedVatCode
|
reducedVatCode | string | |
|
Taxa de IVA
|
vatRate | double | |
|
Taxa de IVA reduzida
|
reducedVatRate | double | |
|
Title
|
title | string | |
|
Subtítulo
|
subTitle | string | |
|
Description
|
description | string | |
|
Alias
|
alias | string | |
|
Situação
|
status | string | |
|
BrandId
|
brandId | string | |
|
SeoTítulo
|
seoTitle | string | |
|
SeoDescrição
|
seoDescription | string | |
|
CategoriaId
|
categoryId | string | |
|
PriceCategoryId
|
priceCategoryId | string | |
|
AdditionalCategoryIds
|
additionalCategoryIds | array of string | |
|
Etiquetas
|
tags | array of string | |
|
Tags de origem
|
sourceTags | array of string | |
|
AdditionalSearchTags
|
additionalSearchTags | array of string | |
|
Disponibilidade
|
availability | string | |
|
Tradução
|
translation | ||
|
Ordem de parada
|
stopOrder | boolean | |
|
MetaTítulo
|
metaTitle | string | |
|
MetaDescrição
|
metaDescription | string | |
|
Metapalavras-chave
|
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 | |
|
MasterId
|
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 |
ProdutoIcoTagExtendedDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Nome
|
name | string | |
|
Ícone
|
icon | string | |
|
BackgroundColor
|
backgroundColor | string | |
|
TextColor
|
textColor | string |
ProductVariantDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
ID do Produto
|
productId | string | |
|
MediaItem
|
mediaItem | ||
|
Title
|
title | string | |
|
Gtin
|
gtin | string | |
|
Mpn
|
mpn | string | |
|
Preço unitário
|
unitPrice | double | |
|
Preço
|
price | double | |
|
Msrp
|
msrp | double | |
|
Quantidade
|
quantity | double | |
|
Preço Inicial
|
initialPrice | double | |
|
Dimension1ItemId
|
dimension1ItemId | string | |
|
Dimension2ItemId
|
dimension2ItemId | string | |
|
Dimension3ItemId
|
dimension3ItemId | string | |
|
ShippingWeight
|
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 | |
|
Requer: Envio
|
requiresShipping | boolean | |
|
Sku
|
sku | string | |
|
Tradução
|
translation | ||
|
CanOrder
|
canOrder | boolean | |
|
Características adicionais
|
additionalFeatures | ||
|
Esperado
|
expected | ||
|
MinOrderQuantity
|
minOrderQuantity | double | |
|
OrderQuantityStep
|
orderQuantityStep | double |
ProductVariantExtendedDTO
| Name | 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ço unitário
|
unitPrice | double | |
|
Preço
|
price | double | |
|
Msrp
|
msrp | double | |
|
Quantidade
|
quantity | double | |
|
Preço Inicial
|
initialPrice | double | |
|
Dimension1ItemId
|
dimension1ItemId | string | |
|
Dimension2ItemId
|
dimension2ItemId | string | |
|
Dimension3ItemId
|
dimension3ItemId | string | |
|
ShippingWeight
|
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 | |
|
Requer: Envio
|
requiresShipping | boolean | |
|
Sku
|
sku | string | |
|
Tradução
|
translation | ||
|
CanOrder
|
canOrder | boolean | |
|
Características adicionais
|
additionalFeatures | ||
|
Esperado
|
expected | ||
|
MinOrderQuantity
|
minOrderQuantity | double | |
|
OrderQuantityStep
|
orderQuantityStep | double |
RelacionadoProdutoVariante DTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
ID do Produto
|
productId | string | |
|
Identificação da empresa
|
companyId | string | |
|
Dimension1ItemIds
|
dimension1ItemIds | array of string | |
|
Dimension2ItemIds
|
dimension2ItemIds | array of string | |
|
Dimension3ItemIds
|
dimension3ItemIds | array of string |
StockAvailabilityDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
Código
|
code | string | |
|
Title
|
title | string | |
|
Tradução
|
translation | ||
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
Linhas
|
lines | array of StockAvailabilityLineDTO |
StockAvailabilityLineDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
MediaItem
|
mediaItem | ||
|
Message
|
message | string | |
|
Quantidade
|
quantity | integer | |
|
Cor
|
color | string | |
|
Tradução
|
translation |
UnitDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
Código
|
code | string | |
|
Nome
|
name | string | |
|
Tradução
|
translation | ||
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time |
CartDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
Símbolo
|
token | string | |
|
Moeda
|
currency | string | |
|
TotalMontante
|
totalAmount | double | |
|
Montante líquido
|
netAmount | double | |
|
Montante do IVA
|
vatAmount | double | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
CarrinhoItens
|
cartItems | array of CartItemDTO |
CartItemDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
ID do Produto
|
productId | string | |
|
ProductTitle (Título do produto)
|
productTitle | string | |
|
ProductVariantId
|
productVariantId | string | |
|
Quantidade
|
quantity | double | |
|
ImagemLink
|
imageLink | string | |
|
Valor Líquido
|
netValue | double | |
|
InitialUnitPrice
|
initialUnitPrice | double | |
|
Preço unitário
|
unitPrice | double | |
|
Preço Inicial
|
initialPrice | double | |
|
Preço
|
price | double | |
|
LineValue
|
lineValue | double | |
|
VatValue
|
vatValue | double | |
|
Taxa de IVA
|
vatRate | double | |
|
Código do IVA
|
vatCode | string | |
|
Link
|
link | string | |
|
Sku
|
sku | string | |
|
OrderQuantityStep
|
orderQuantityStep | double | |
|
SalesUnitId
|
salesUnitId | string |
ShoppingListDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Title
|
title | string | |
|
Identificação da empresa
|
companyId | string | |
|
ID do Cliente
|
customerId | string | |
|
UserId
|
userId | string | |
|
Alias
|
alias | string | |
|
InserirData
|
insertDate | date-time | |
|
UpdateDate
|
updateDate | date-time | |
|
Itens
|
items | array of ShoppingListItemDTO |
ShoppingListItemDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Produto
|
productId | string | |
|
ProductVariantId
|
productVariantId | string |
CheckoutEndereçoDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Nome
|
name | string | |
|
Address
|
address |
OrderCustomFieldDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string | |
|
Valor
|
value |
PagamentoDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
ID do Cliente
|
customerId | string | |
|
CheckoutToken
|
checkoutToken | string | |
|
Montante
|
amount | double | |
|
Montante da Comissão
|
commissionAmount | double | |
|
RemessaInformação
|
remittanceInformation | string | |
|
Provider
|
provider | string | |
|
Situação
|
status | string | |
|
Data de Pagamento
|
paymentDate | date-time | |
|
Data de Criação
|
creationDate | date-time | |
|
Código de aprovação
|
approvalCode | string | |
|
Tipo de Cartão
|
cardType | string | |
|
Número do cartão
|
cardNumber | string | |
|
Pós-namoro
|
postDating | integer | |
|
Parcelamento
|
installments | integer | |
|
BankId
|
bankId | string | |
|
TransactionId
|
transactionId | string |
CalculatedShippingDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Transportadora
|
carrier | ||
|
Linha de Envio
|
shippingLine |
Finalizar CompraDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
ID do Cliente
|
customerId | string | |
|
Nome do Cliente
|
customerName | string | |
|
E-mail do usuário
|
userEmail | string | |
|
UserFirstName
|
userFirstName | string | |
|
Sobrenome do usuário
|
userLastName | string | |
|
UserId
|
userId | string | |
|
ClienteBranchId
|
customerBranchId | string | |
|
CartToken
|
cartToken | string | |
|
Símbolo
|
token | string | |
|
Código de referência
|
referenceCode | string | |
|
Observações
|
notes | string | |
|
Situação
|
status | string | |
|
Endereço de Faturação
|
billingAddress | ||
|
Endereço de envio
|
shippingAddress | ||
|
CompradorAceitaComercialização
|
buyerAcceptsMarketing | boolean | |
|
Email
|
string | ||
|
Telemóvel
|
phone | string | |
|
Moeda
|
currency | string | |
|
TotalMontante
|
totalAmount | double | |
|
Montante líquido
|
netAmount | double | |
|
Montante do IVA
|
vatAmount | double | |
|
DespesaMontante
|
expenseAmount | double | |
|
DescontoTaxa
|
discountRate | double | |
|
DescontoValor
|
discountValue | double | |
|
Data de Conclusão
|
completedDate | date-time | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
CarrinhoItens
|
cartItems | array of CheckoutItemDTO | |
|
Linhas de Presente
|
giftLines | array of CheckoutGiftLineDTO | |
|
VatAnalysis
|
vatAnalysis | array of VatAnalysisDTO | |
|
DespesasLinhas
|
expenseLines | array of ExpenseLineDTO | |
|
Linha de Envio
|
shippingLine | ||
|
ID de Pedido
|
orderId | string | |
|
Código de Encomenda
|
orderCode | string | |
|
Pagamento
|
payment | ||
|
Cliente
|
customer | ||
|
Opções de Envio
|
shippingOptions | array of CalculatedShippingDTO | |
|
PaymentMethods
|
paymentMethods | ||
|
Configurações
|
settings | ||
|
Campos Personalizados
|
customFields | array of OrderCustomFieldDTO | |
|
Addresses
|
addresses | array of CheckoutAddressDTO | |
|
Data de entrega
|
deliveryDate | date-time |
CheckoutGiftLineDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Código do IVA
|
vatCode | string | |
|
ImagemLink
|
imageLink | string | |
|
ProductTitle (Título do produto)
|
productTitle | string | |
|
ProductAlias
|
productAlias | string | |
|
ID do Produto
|
productId | string | |
|
ProductVariantId
|
productVariantId | string | |
|
Quantidade
|
quantity | double |
CheckoutItemDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
ID do Produto
|
productId | string | |
|
ProductTitle (Título do produto)
|
productTitle | string | |
|
ProductVariantId
|
productVariantId | string | |
|
Quantidade
|
quantity | double | |
|
Unidade
|
unit | string | |
|
ImagemLink
|
imageLink | string | |
|
Cor
|
color | string | |
|
Materiais
|
material | string | |
|
Padrão
|
pattern | string | |
|
Tamanho
|
size | string | |
|
Valor Líquido
|
netValue | double | |
|
Valor da despesa
|
expenseValue | double | |
|
InitialUnitPrice
|
initialUnitPrice | double | |
|
Preço unitário
|
unitPrice | double | |
|
Preço Inicial
|
initialPrice | double | |
|
Preço
|
price | double | |
|
PreçoValor1
|
priceValue1 | double | |
|
PreçoValor2
|
priceValue2 | double | |
|
PreçoValor3
|
priceValue3 | double | |
|
LineValue
|
lineValue | double | |
|
DescontoValor
|
discountValue | double | |
|
DescontoTaxa
|
discountRate | double | |
|
VatValue
|
vatValue | double | |
|
Taxa de IVA
|
vatRate | double | |
|
Código do IVA
|
vatCode | string | |
|
CustomDim1Value
|
customDim1Value | string | |
|
CustomDim2Value
|
customDim2Value | string | |
|
CustomDim3Value
|
customDim3Value | string | |
|
Link
|
link | string | |
|
Sku
|
sku | string | |
|
SalesUnitId
|
salesUnitId | string |
ClienteBranchDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
FonteId
|
sourceId | string | |
|
Código
|
code | string | |
|
Nome
|
name | string | |
|
Contato
|
contact | string | |
|
Telefone de contato
|
contactPhone | string | |
|
Telemóvel
|
phone | string | |
|
Address
|
address | ||
|
Situação
|
status | string |
CustomerShippingAddressDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string | |
|
Address
|
address |
ExpenseLineDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Valor Líquido
|
netValue | double | |
|
VatValue
|
vatValue | double |
VatAnalysisDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Taxa de IVA
|
vatRate | double | |
|
Montante do IVA
|
vatAmount | double | |
|
Código do IVA
|
vatCode | string | |
|
Montante líquido
|
netAmount | double |
SortimentoCombinaçãoDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
BranchId
|
branchId | string | |
|
CategoriaId
|
categoryId | string | |
|
TypeId
|
typeId | string |
SortimentoDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
ID do Cliente
|
customerId | string | |
|
Categorias
|
categories | array of CustomerCategoryDTO | |
|
Types
|
types | array of CustomerTypeDTO | |
|
Combinações
|
combinations | array of AssortmentCombinationDTO | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time |
SortimentoValueDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
ID do Cliente
|
customerId | string | |
|
ID do Produto
|
productId | string | |
|
CategoriaId
|
categoryId | string | |
|
TypeId
|
typeId | string | |
|
Situação
|
status | string | |
|
Fonte
|
source | string | |
|
InserirData
|
insertDate | date-time | |
|
UpdateDate
|
updateDate | date-time |
ClienteCategoriaDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Nome
|
name | string |
CustomerCustomFieldDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string | |
|
Valor
|
value | ||
|
Tradução
|
translation |
CustomerDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
Código
|
code | string | |
|
Nome
|
name | string | |
|
Estanho
|
tin | string | |
|
Email
|
string | ||
|
Contato
|
contact | string | |
|
Telefone de contato
|
contactPhone | string | |
|
Telemóvel
|
phone | string | |
|
PriceCategoryId
|
priceCategoryId | string | |
|
FonteId
|
sourceId | string | |
|
Etiquetas
|
tags | array of string | |
|
Tags de origem
|
sourceTags | array of string | |
|
Address
|
address | ||
|
Observações
|
notes | string | |
|
Situação
|
status | string | |
|
Ramos
|
branches | array of CustomerBranchDTO | |
|
Características adicionais
|
additionalFeatures | ||
|
Campos Personalizados
|
customFields | array of CustomerCustomFieldDTO | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
SalesmanId
|
salesmanId | string | |
|
Repartição de Finanças
|
taxOffice | string | |
|
ContactoLíngua
|
contactLanguage | string | |
|
Tipo de IVA
|
vatType | string | |
|
Tipo de Loja
|
shopType | string | |
|
Endereços de Envio
|
shippingAddresses | array of CustomerShippingAddressDTO |
CustomerGroupDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
Title
|
title | string | |
|
Situação
|
status | string | |
|
Regra
|
rule | ||
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time |
CustomerTypeDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Nome
|
name | string |
ExpectedInventoryLineDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Data de entrega
|
deliveryDate | date-time | |
|
Quantidade Esperada
|
expectedQuantity | double |
InventárioNívelDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
ProductVariantId
|
productVariantId | string | |
|
ID do Produto
|
productId | string | |
|
Identificação da empresa
|
companyId | string | |
|
LocalizaçãoId
|
locationId | string | |
|
Quantidade
|
quantity | double | |
|
ExpectedInventoryLines
|
expectedInventoryLines | array of ExpectedInventoryLineDTO | |
|
UpdateDate
|
updateDate | date-time |
LocalizaçãoDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Identificação da empresa
|
companyId | string | |
|
Nome
|
name | string | |
|
IsActive
|
isActive | boolean | |
|
Address
|
address | ||
|
Telemóvel
|
phone | string | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time |
InventárioDisponibilidadeDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Símbolo
|
token | string | |
|
Disponível
|
available | boolean | |
|
Linhas
|
lines | array of StockAvailabilityLineDTO |
GiftLineDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do Produto
|
productId | string | |
|
ProductVariantId
|
productVariantId | string | |
|
ProductTitle (Título do produto)
|
productTitle | string | |
|
Quantidade
|
quantity | double | |
|
Código do IVA
|
vatCode | string | |
|
ImagemLink
|
imageLink | string | |
|
ProductAlias
|
productAlias | string |
OrderDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
Código
|
code | string | |
|
Identificação da empresa
|
companyId | string | |
|
CheckoutToken
|
checkoutToken | string | |
|
CartToken
|
cartToken | string | |
|
Situação
|
status | string | |
|
ID do Cliente
|
customerId | string | |
|
ClienteBranchId
|
customerBranchId | string | |
|
CustomerBranchSourceId
|
customerBranchSourceId | string | |
|
CustomerTin
|
customerTin | string | |
|
Nome do Cliente
|
customerName | string | |
|
Código do Cliente
|
customerCode | string | |
|
CustomerSourceId
|
customerSourceId | string | |
|
CustomerBranchName
|
customerBranchName | string | |
|
Moeda
|
currency | string | |
|
Cancelado
|
cancelledAt | date-time | |
|
Data de entrega
|
deliveryDate | date-time | |
|
CancelamentoMotivo
|
cancellationReason | string | |
|
Fechado
|
closedAt | date-time | |
|
Código de referência
|
referenceCode | string | |
|
DescontoTaxa
|
discountRate | double | |
|
DescontoValor
|
discountValue | double | |
|
TotalMontante
|
totalAmount | double | |
|
Montante líquido
|
netAmount | double | |
|
Montante do IVA
|
vatAmount | double | |
|
DespesaMontante
|
expenseAmount | double | |
|
Situação financeira
|
financialStatus | string | |
|
Status de Cumprimento
|
fulfillmentStatus | string | |
|
Endereço de Faturação
|
billingAddress | ||
|
Endereço de envio
|
shippingAddress | ||
|
RequiresCalculation
|
requiresCalculation | boolean | |
|
Linhas
|
lines | array of OrderLineDTO | |
|
VatAnalysis
|
vatAnalysis | array of VatAnalysisDTO | |
|
Etiquetas
|
tags | array of string | |
|
FonteId
|
sourceId | string | |
|
Tags de origem
|
sourceTags | array of string | |
|
Observações
|
notes | string | |
|
UpdateDate
|
updateDate | date-time | |
|
InserirData
|
insertDate | date-time | |
|
Favorito
|
favorite | boolean | |
|
UserId
|
userId | string | |
|
InvoiceUrl
|
invoiceUrl | string | |
|
Notificar
|
notify | string | |
|
Notificado
|
notified | array of string | |
|
Campos Personalizados
|
customFields | array of OrderCustomFieldDTO | |
|
Linha de Envio
|
shippingLine | ||
|
Linhas de Presente
|
giftLines | array of GiftLineDTO | |
|
DespesasLinhas
|
expenseLines | array of ExpenseLineDTO | |
|
Pagamento
|
payment | ||
|
SeriesId
|
seriesId | string |
OrderLineDTO
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Id
|
id | string | |
|
ID do Produto
|
productId | string | |
|
ProductVariantId
|
productVariantId | string | |
|
ProductTitle (Título do produto)
|
productTitle | string | |
|
UnitId
|
unitId | string | |
|
SalesUnitId
|
salesUnitId | string | |
|
Quantidade
|
quantity | double | |
|
UnitQuantity
|
unitQuantity | double | |
|
Valor Líquido
|
netValue | double | |
|
Preço
|
price | double | |
|
Valor da despesa
|
expenseValue | double | |
|
PreçoValor1
|
priceValue1 | double | |
|
PreçoValor2
|
priceValue2 | double | |
|
PreçoValor3
|
priceValue3 | double | |
|
Preço unitário
|
unitPrice | double | |
|
LineValue
|
lineValue | double | |
|
DescontoValor
|
discountValue | double | |
|
DescontoTaxa
|
discountRate | double | |
|
VatValue
|
vatValue | double | |
|
Taxa de IVA
|
vatRate | double | |
|
Código do IVA
|
vatCode | string | |
|
Sku
|
sku | string | |
|
Dimensão1Legenda
|
dimension1Caption | string | |
|
Dimensão2Legenda
|
dimension2Caption | string | |
|
Dimension3Caption
|
dimension3Caption | string | |
|
Dimensão1Valor
|
dimension1Value | string | |
|
Dimensão2Valor
|
dimension2Value | string | |
|
Dimensão3Valor
|
dimension3Value | string |