API xkey SAX

produtos

Endpoint:http://dbnew.xkeysti.com.br:8080/sax

listar foto de produto

GET

http://dbnew.xkeysti.com.br:8080/sax

/foto

usado para listar a foto de cada produto. Os parâmetros obrigatórios são

produto_id

listar foto de produto › query Parameters

produto_idinteger · style: form · explode: true
mostra o id do produto
um número usado para a identificaçãod de um produto
Example: 1

listar foto de produto › Responses

A solicitação foi bem-sucedida

dataobject · required

listar grupos

GET

http://dbnew.xkeysti.com.br:8080/sax

/grupo

usado para listar os grupos presentes. Os parâmetros obrigatórios são

token

listar grupos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar grupos › Responses

A solicitação foi bem-sucedida

dataobject · required

criar grupos

POST

http://dbnew.xkeysti.com.br:8080/sax

/grupo

usado para criar um novo grupo. Os parâmetros obrigatórios são

token

criar grupos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

criar grupos › Responses

A requisição foi bem sucedida e um novo recurso foi criado como resultado

dataobject · required

listar marcas

GET

http://dbnew.xkeysti.com.br:8080/sax

/marca

usado para listar as marcas presentes. Os parâmetros obrigatórios são

token

listar marcas › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar marcas › Responses

A solicitação foi bem-sucedida

dataobject · required

criar marcas

POST

http://dbnew.xkeysti.com.br:8080/sax

/marca

usado para criar uma nova marca. Os parâmetros obrigatórios são

token

criar marcas › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

criar marcas › Responses

A requisição foi bem sucedida e um novo recurso foi criado como resultado

dataobject · required

listar preço de produto

GET

http://dbnew.xkeysti.com.br:8080/sax

/preco

usado para listar o preço dos produtos. Os parâmetros obrigatórios são

produto_id
Offset
limit

listar preço de produto › query Parameters

produto_idinteger · style: form · explode: true
mostra o id do produto
um número usado para a identificaçãod de um produto
Example: 1
limitinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
offsetinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
destacarboolean · style: form · explode: true
mostra se está destacado ou não
para true a resposta será S e para false N
Example: true
tabela_preco_idinteger · style: form · explode: true
mostra o id da tabela de preços em que está presente
um número usado para identificação de uma tabela de preços
Example: 1
marca_idinteger · style: form · explode: true
mostra id da marca
um número usado para a identificação de uma marca
Example: 1
grupo_idinteger · style: form · explode: true
mostra id do grupo
um número usado para a identificação de um grupo
Example: 1
subgrupo_idinteger · style: form · explode: true
mostra id do subgrupo
um número usado para a identificação de um subgrupo
Example: 1

listar preço de produto › Responses

A solicitação foi bem-sucedida

dataobject · required

listar produtos

GET

http://dbnew.xkeysti.com.br:8080/sax

/produto

usado para listar os produtos presentes. Os parâmetros obrigatórios são

Offset
limit
token

listar produtos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
offsetinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
limitinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
destacar_siteboolean · style: form · explode: true
mostra se está ou não destacado no site
true indica que está destacado no site ou seja S false indica que não está destacado no site ou seja N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar produtos › Responses

A solicitação foi bem-sucedida

idinteger · required
pesostring · required
tipointeger · required
ativoboolean · required
origemstring · required
no_siteboolean · required
garantiainteger · required
grade_idinteger · required
grupo_idinteger · required
indexadoboolean · required
marca_idinteger · required
aplicacaostring · required
descricaostring · required
informacaostring · required
observacaostring · required
custo_mediostring · required
observacao2string · required
observacao3string · required
referenciasstring · required
subgrupo_idstring · required
categoria_idinteger · required
outro_codigostring · required
ultimo_custostring · required
data_cadastrostring · required
ativo_dropshipboolean · required
codigos_extrasstring · required
custo_dropshipstring · required
estoque_minimostring · required
lote_economicostring · required
tipo_descricaostring · required
caracteristicasobject · required
informacao_htmlstring · required
numero_originalstring · required
produto_sem_gtinboolean · required
numero_fabricantestring · required
situacao_dropshipstring · required
descricao_reduzidastring · required
quantidade_volumesstring · required
descricao_ecommercestring · required
classificacao_fiscalstring · required
ultimo_fornecedor_idinteger · required
data_ultima_alteracaostring · required
percentual_ipi_dropshipstring · required

alterar produtos

PUT

http://dbnew.xkeysti.com.br:8080/sax

/produto

usado para alterar as informações de um produto já existente. Os parâmetros obrigatórios são

Offset
limit
token

alterar produtos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
offsetinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
limitinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
destacar_siteboolean · style: form · explode: true
mostra se está ou não destacado no site
true indica que está destacado no site ou seja S false indica que não está destacado no site ou seja N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

alterar produtos › Responses

A solicitação foi bem-sucedida

dataobject · required

criar produtos

POST

http://dbnew.xkeysti.com.br:8080/sax

/produto

usado para criar um novo produto. Os parâmetros obrigatórios são

Offset
limit
token

criar produtos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
offsetinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
limitinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
destacar_siteboolean · style: form · explode: true
mostra se está ou não destacado no site
true indica que está destacado no site ou seja S false indica que não está destacado no site ou seja N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

criar produtos › Request Body

criar produtos › Responses

A requisição foi bem sucedida e um novo recurso foi criado como resultado

dataobject · required

listar subgrupos

GET

http://dbnew.xkeysti.com.br:8080/sax

/subgrupo

usado para listar os subgrupos presentes. Os parâmetros obrigatórios são

token

listar subgrupos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
grupo_idinteger · style: form · explode: true
mostra id do grupo
um número usado para a identificação de um grupo
Example: 1
codigointeger · style: form · explode: true
codigo do objeto sendo mostrado
um número usado para identificação
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar subgrupos › Responses

A solicitação foi bem-sucedida

dataobject · required

criar subgrupos

POST

http://dbnew.xkeysti.com.br:8080/sax

/subgrupo

usado para criar novos subgrupos. Os parâmetros obrigatórios são

token

criar subgrupos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
grupo_idinteger · style: form · explode: true
mostra id do grupo
um número usado para a identificação de um grupo
Example: 1
codigointeger · style: form · explode: true
codigo do objeto sendo mostrado
um número usado para identificação
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

criar subgrupos › Responses

A requisição foi bem sucedida e um novo recurso foi criado como resultado

dataobject · required

listar categorias

GET

http://dbnew.xkeysti.com.br:8080/sax

/categoria

usado para listar as categorias presentes. Os parâmetros obrigatórios são

token

listar categorias › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
descricaostring · style: form · explode: true
mostra a descrição atribuída a este objeto
o formato é de ano, mês, dia
Example: 2021-03-20
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar categorias › Responses

A solicitação foi bem-sucedida

dataobject · required

criar categorias

POST

http://dbnew.xkeysti.com.br:8080/sax

/categoria

usado para criar uma nova categoria. Os parâmetros obrigatórios são

token

criar categorias › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
descricaostring · style: form · explode: true
mostra a descrição atribuída a este objeto
o formato é de ano, mês, dia
Example: 2021-03-20
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

criar categorias › Responses

Não há conteúdo para enviar para esta solicitação

dataobject · required

listar referências

GET

http://dbnew.xkeysti.com.br:8080/sax

/referencia

usado para listar as referências presentes. Os parâmetros obrigatórios são

token

listar referências › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_alteracaostring · style: form · explode: true
mostra as datas em que foi alterado
o formato é de ano, mês, dia, hora, minuto, segundo
Example: 2025-03-25-16:29:50
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar referências › Responses

A solicitação foi bem-sucedida

dataobject · required

criar referências

POST

http://dbnew.xkeysti.com.br:8080/sax

/referencia

usado para criar uma nova referência. Os parâmetros obrigatórios são

token

criar referências › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_alteracaostring · style: form · explode: true
mostra as datas em que foi alterado
o formato é de ano, mês, dia, hora, minuto, segundo
Example: 2025-03-25-16:29:50
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

criar referências › Responses

A requisição foi bem sucedida e um novo recurso foi criado como resultado

dataobject · required

listar estoque de produtos

GET

http://dbnew.xkeysti.com.br:8080/sax

/estoqueproduto

usado para listar o estoque de produtos. Os parâmetros obrigatórios são

Offset
limit
destacar
token

listar estoque de produtos › query Parameters

produto_idinteger · style: form · explode: true
mostra o id do produto
um número usado para a identificaçãod de um produto
Example: 1
limitinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
offsetinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
destacarboolean · style: form · explode: true
mostra se está destacado ou não
para true a resposta será S e para false N
Example: true
setor_estoque_idinteger · style: form · explode: true
id de setor do estoque
um número usado para identificação do setor estoque
Example: 1
marca_idinteger · style: form · explode: true
mostra id da marca
um número usado para a identificação de uma marca
Example: 1
grupo_idinteger · style: form · explode: true
mostra id do grupo
um número usado para a identificação de um grupo
Example: 1
subgrupo_idinteger · style: form · explode: true
mostra id do subgrupo
um número usado para a identificação de um subgrupo
Example: 1
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar estoque de produtos › Responses

A solicitação foi bem-sucedida

dataobject · required

pedido de compra

API xkey SAX

produtos

Endpoint:http://dbnew.xkeysti.com.br:8080/sax

listar foto de produto

GET

http://dbnew.xkeysti.com.br:8080/sax

/foto

usado para listar a foto de cada produto. Os parâmetros obrigatórios são

produto_id

listar foto de produto › query Parameters

produto_idinteger · style: form · explode: true
mostra o id do produto
um número usado para a identificaçãod de um produto
Example: 1

listar foto de produto › Responses

A solicitação foi bem-sucedida

dataobject · required

listar grupos

GET

http://dbnew.xkeysti.com.br:8080/sax

/grupo

usado para listar os grupos presentes. Os parâmetros obrigatórios são

token

listar grupos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar grupos › Responses

A solicitação foi bem-sucedida

dataobject · required

criar grupos

POST

http://dbnew.xkeysti.com.br:8080/sax

/grupo

usado para criar um novo grupo. Os parâmetros obrigatórios são

token

criar grupos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

criar grupos › Responses

A requisição foi bem sucedida e um novo recurso foi criado como resultado

dataobject · required

listar marcas

GET

http://dbnew.xkeysti.com.br:8080/sax

/marca

usado para listar as marcas presentes. Os parâmetros obrigatórios são

token

listar marcas › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar marcas › Responses

A solicitação foi bem-sucedida

dataobject · required

criar marcas

POST

http://dbnew.xkeysti.com.br:8080/sax

/marca

usado para criar uma nova marca. Os parâmetros obrigatórios são

token

criar marcas › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

criar marcas › Responses

A requisição foi bem sucedida e um novo recurso foi criado como resultado

dataobject · required

listar preço de produto

GET

http://dbnew.xkeysti.com.br:8080/sax

/preco

usado para listar o preço dos produtos. Os parâmetros obrigatórios são

produto_id
Offset
limit

listar preço de produto › query Parameters

produto_idinteger · style: form · explode: true
mostra o id do produto
um número usado para a identificaçãod de um produto
Example: 1
limitinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
offsetinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
destacarboolean · style: form · explode: true
mostra se está destacado ou não
para true a resposta será S e para false N
Example: true
tabela_preco_idinteger · style: form · explode: true
mostra o id da tabela de preços em que está presente
um número usado para identificação de uma tabela de preços
Example: 1
marca_idinteger · style: form · explode: true
mostra id da marca
um número usado para a identificação de uma marca
Example: 1
grupo_idinteger · style: form · explode: true
mostra id do grupo
um número usado para a identificação de um grupo
Example: 1
subgrupo_idinteger · style: form · explode: true
mostra id do subgrupo
um número usado para a identificação de um subgrupo
Example: 1

listar preço de produto › Responses

A solicitação foi bem-sucedida

dataobject · required

listar produtos

GET

http://dbnew.xkeysti.com.br:8080/sax

/produto

usado para listar os produtos presentes. Os parâmetros obrigatórios são

Offset
limit
token

listar produtos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
offsetinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
limitinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
destacar_siteboolean · style: form · explode: true
mostra se está ou não destacado no site
true indica que está destacado no site ou seja S false indica que não está destacado no site ou seja N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar produtos › Responses

A solicitação foi bem-sucedida

idinteger · required
pesostring · required
tipointeger · required
ativoboolean · required
origemstring · required
no_siteboolean · required
garantiainteger · required
grade_idinteger · required
grupo_idinteger · required
indexadoboolean · required
marca_idinteger · required
aplicacaostring · required
descricaostring · required
informacaostring · required
observacaostring · required
custo_mediostring · required
observacao2string · required
observacao3string · required
referenciasstring · required
subgrupo_idstring · required
categoria_idinteger · required
outro_codigostring · required
ultimo_custostring · required
data_cadastrostring · required
ativo_dropshipboolean · required
codigos_extrasstring · required
custo_dropshipstring · required
estoque_minimostring · required
lote_economicostring · required
tipo_descricaostring · required
caracteristicasobject · required
informacao_htmlstring · required
numero_originalstring · required
produto_sem_gtinboolean · required
numero_fabricantestring · required
situacao_dropshipstring · required
descricao_reduzidastring · required
quantidade_volumesstring · required
descricao_ecommercestring · required
classificacao_fiscalstring · required
ultimo_fornecedor_idinteger · required
data_ultima_alteracaostring · required
percentual_ipi_dropshipstring · required

alterar produtos

PUT

http://dbnew.xkeysti.com.br:8080/sax

/produto

usado para alterar as informações de um produto já existente. Os parâmetros obrigatórios são

Offset
limit
token

alterar produtos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
offsetinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
limitinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
destacar_siteboolean · style: form · explode: true
mostra se está ou não destacado no site
true indica que está destacado no site ou seja S false indica que não está destacado no site ou seja N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

alterar produtos › Responses

A solicitação foi bem-sucedida

dataobject · required

criar produtos

POST

http://dbnew.xkeysti.com.br:8080/sax

/produto

usado para criar um novo produto. Os parâmetros obrigatórios são

Offset
limit
token

criar produtos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
offsetinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
limitinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
destacar_siteboolean · style: form · explode: true
mostra se está ou não destacado no site
true indica que está destacado no site ou seja S false indica que não está destacado no site ou seja N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

criar produtos › Request Body

criar produtos › Responses

A requisição foi bem sucedida e um novo recurso foi criado como resultado

dataobject · required

listar subgrupos

GET

http://dbnew.xkeysti.com.br:8080/sax

/subgrupo

usado para listar os subgrupos presentes. Os parâmetros obrigatórios são

token

listar subgrupos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
grupo_idinteger · style: form · explode: true
mostra id do grupo
um número usado para a identificação de um grupo
Example: 1
codigointeger · style: form · explode: true
codigo do objeto sendo mostrado
um número usado para identificação
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar subgrupos › Responses

A solicitação foi bem-sucedida

dataobject · required

criar subgrupos

POST

http://dbnew.xkeysti.com.br:8080/sax

/subgrupo

usado para criar novos subgrupos. Os parâmetros obrigatórios são

token

criar subgrupos › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
grupo_idinteger · style: form · explode: true
mostra id do grupo
um número usado para a identificação de um grupo
Example: 1
codigointeger · style: form · explode: true
codigo do objeto sendo mostrado
um número usado para identificação
Example: 1
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

criar subgrupos › Responses

A requisição foi bem sucedida e um novo recurso foi criado como resultado

dataobject · required

listar categorias

GET

http://dbnew.xkeysti.com.br:8080/sax

/categoria

usado para listar as categorias presentes. Os parâmetros obrigatórios são

token

listar categorias › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
descricaostring · style: form · explode: true
mostra a descrição atribuída a este objeto
o formato é de ano, mês, dia
Example: 2021-03-20
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar categorias › Responses

A solicitação foi bem-sucedida

dataobject · required

criar categorias

POST

http://dbnew.xkeysti.com.br:8080/sax

/categoria

usado para criar uma nova categoria. Os parâmetros obrigatórios são

token

criar categorias › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
descricaostring · style: form · explode: true
mostra a descrição atribuída a este objeto
o formato é de ano, mês, dia
Example: 2021-03-20
ativoboolean · style: form · explode: true
mostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: true
no_siteboolean · enum · date-time · style: form · explode: true
mostra se está no site ou não
para true ele irá responder S e para false N
Enum values:
S
N
Example: true
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_ultima_alteracaostring · style: form · explode: true
mostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

criar categorias › Responses

Não há conteúdo para enviar para esta solicitação

dataobject · required

listar referências

GET

http://dbnew.xkeysti.com.br:8080/sax

/referencia

usado para listar as referências presentes. Os parâmetros obrigatórios são

token

listar referências › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_alteracaostring · style: form · explode: true
mostra as datas em que foi alterado
o formato é de ano, mês, dia, hora, minuto, segundo
Example: 2025-03-25-16:29:50
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar referências › Responses

A solicitação foi bem-sucedida

dataobject · required

criar referências

POST

http://dbnew.xkeysti.com.br:8080/sax

/referencia

usado para criar uma nova referência. Os parâmetros obrigatórios são

token

criar referências › query Parameters

idinteger · style: form · explode: true
mostra o id
Um número usado para identificação
Example: 1
data_cadastrostring · style: form · explode: true
mostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20
data_alteracaostring · style: form · explode: true
mostra as datas em que foi alterado
o formato é de ano, mês, dia, hora, minuto, segundo
Example: 2025-03-25-16:29:50
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

criar referências › Responses

A requisição foi bem sucedida e um novo recurso foi criado como resultado

dataobject · required

listar estoque de produtos

GET

http://dbnew.xkeysti.com.br:8080/sax

/estoqueproduto

usado para listar o estoque de produtos. Os parâmetros obrigatórios são

Offset
limit
destacar
token

listar estoque de produtos › query Parameters

produto_idinteger · style: form · explode: true
mostra o id do produto
um número usado para a identificaçãod de um produto
Example: 1
limitinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
offsetinteger · style: form · explode: true
por exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1
destacarboolean · style: form · explode: true
mostra se está destacado ou não
para true a resposta será S e para false N
Example: true
setor_estoque_idinteger · style: form · explode: true
id de setor do estoque
um número usado para identificação do setor estoque
Example: 1
marca_idinteger · style: form · explode: true
mostra id da marca
um número usado para a identificação de uma marca
Example: 1
grupo_idinteger · style: form · explode: true
mostra id do grupo
um número usado para a identificação de um grupo
Example: 1
subgrupo_idinteger · style: form · explode: true
mostra id do subgrupo
um número usado para a identificação de um subgrupo
Example: 1
tokenstring · style: form · explode: true
O seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX

listar estoque de produtos › Responses

A solicitação foi bem-sucedida

dataobject · required

pedido de compra