SAX API
API ¶
Autenticação ¶
Obrigatório envio do token no Header de cada requisição.
- Request
- Headers token: {seu_token}
Produtos ¶
Produto ¶
Listar produtosGET/produto?id={id}offset={offset}&limit={limit}&ativo={ativo}&destacar_site={destacar_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
GET http://localhost:8081/sax/produto?id=1offset=2&limit=8&ativo=true&destacar_site=false&data_cadastro=2021-03-03&data_ultima_alteracao=2022-04-16-00:00:00
URI Parameters
- id
number(optional) Example: 1- offset
number(required) Example: 2- limit
number(required) Example: 8- ativo
boolean(optional) Example: true- destacar_site
boolean(optional) Example: false- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2022-04-16-00:00:00
Response
200Headers
Content-Type: application/jsonBody
{
"produtos": [
{
"id": 172,
"descricao": "GUARDA",
"descricao_reduzida": "guarda",
"ativo": true,
"destacar_site": false,
"indexado": false,
"numero_original": 172,
"numero_fabricante": 7899800515257,
"outro_codigo": 4839,
"aplicacao": "GUARDA",
"descricao_ecommerce": "Guarda",
"informacao": "GUARDA",
"informacao_html": "<p>info</p>",
"custo_medio": 1141.09,
"ultimo_custo": 0,
"peso": 206,
"volumes": 0,
"ultimo_fornecedo_id": 26,
"grade_id": 77,
"origem": 0,
"garantia": 6,
"data_cadastro": "2021-03-03",
"data_ultima_alteracao": "2021-03-03 18:45:55",
"estoque_minimo": 0,
"lote_economico": 0,
"tipo": 8,
"categoria_id": 1,
"grupo_id": 52,
"subgrupo_id": 0,
"marca_id": 189,
"classificacao_fiscal": "9403.50.00",
"produto_sem_gtin": false,
"observacao": "obs teste",
"observacao2": "obs teste 2",
"observacao3": "obs teste 3",
"referencias": "[]",
"caracteristicas": "[]",
"ncm": "0000.00.00",
"ativo_dropship": true,
"situacao_dropship": "",
"percentual_ipi_dropship": 0,
"custo_dropship": 0
}
]
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Alterar produtosPUT/produto?id={id}offset={offset}&limit={limit}&ativo={ativo}&destacar_site={destacar_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
PUT http://localhost:8081/sax/produto?id=1offset=2&limit=8&ativo=true&destacar_site=false&data_cadastro=2021-03-03&data_ultima_alteracao=2022-04-16-00:00:00
URI Parameters
- id
number(optional) Example: 1- offset
number(required) Example: 2- limit
number(required) Example: 8- ativo
boolean(optional) Example: true- destacar_site
boolean(optional) Example: false- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2022-04-16-00:00:00
Request
Headers
Content-Type: application/jsonBody
{
"produtos":[
{
"id": "1",
"descricao":"teste nome",
"descricao_reduzida":"teste curto",
"ativo":true,
"outro_codigo":"ref213",
"numero_fabricante":"123123123",
"descricao_ecommerce":"teste nome",
"informacao_html":"desc ",
"aplicacao": "teste",
"categoria_id":"2",
"grupo_id":"2",
"subgrupo_id":"23",
"marca_id":"54",
"classificacao_fiscal_id":"1",
"custo_medio":"123.00",
"ultimo_custo":"123.00",
"data_cadastro":"2022-07-20",
"data_recadastro":"2022-07-21",
"data_lancamento":"2022-07-20",
"ultimo_fornecedor_id":"211",
"indexado": false,
"destacar": false,
"peso":"1.00",
"grade_id": 0,
"estoque_minimo": 1,
"garantia": 3,
"tipo": 8,
"lote_economico": 10,
"observacao": "teste",
"observacao2": "teste 2",
"observacao3": "teste 3",
"origem": "0",
"produto_sem_gtin": "0",
"controla_lote_serie": false,
"genero_id" : 0,
"quantidade_volumes": 1,
"ncm": "0000.00.00",
"ativo_dropship:" true,
"situacao_dropship":"",
"percentual_ipi_dropship:" 5,
"custo_dropship:" 0.00,
"fotos":[
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg",
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg",
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg",
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg"
],
"embalagens":[
{
"caracteristica_id":2,
"valor":"2,00"
},
{
"caracteristica_id":3,
"valor":"3,00"
},
{
"caracteristica_id":4,
"valor":"4,00"
},
{
"caracteristica_id":5,
"valor":"1,00"
}
],
"volumes":[
{
"descricao":"VOL.1",
"altura":"2.00",
"largura":"1.00",
"profundidade":"3.00",
"peso":"4.00",
"empilhamento_maximo":"1"
},
{
"descricao":"VOL.2",
"altura":"2.00",
"largura":"3.00",
"profundidade":"4.00",
"peso":"5.00",
"empilhamento_maximo":"1"
}
]
}
]
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Criar produtosPOST/produto?id={id}offset={offset}&limit={limit}&ativo={ativo}&destacar_site={destacar_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
POST http://localhost:8081/sax/produto?id=1offset=2&limit=8&ativo=true&destacar_site=false&data_cadastro=2021-03-03&data_ultima_alteracao=2022-04-16-00:00:00
URI Parameters
- id
number(optional) Example: 1- offset
number(required) Example: 2- limit
number(required) Example: 8- ativo
boolean(optional) Example: true- destacar_site
boolean(optional) Example: false- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2022-04-16-00:00:00
Request
Headers
Content-Type: application/jsonBody
{
"produtos":[
{
"descricao":"teste nome",
"descricao_reduzida":"teste curto",
"ativo":true,
"outro_codigo":"ref213",
"numero_fabricante":"123123123",
"descricao_ecommerce":"teste nome",
"informacao_html":"desc ",
"aplicacao": "teste",
"categoria_id":"2",
"grupo_id":"2",
"subgrupo_id":"23",
"marca_id":"54",
"classificacao_fiscal_id":"1",
"custo_medio":"123.00",
"ultimo_custo":"123.00",
"data_cadastro":"2022-07-20",
"data_recadastro":"2022-07-21",
"data_lancamento":"2022-07-20",
"ultimo_fornecedor_id":"211",
"indexado": false,
"destacar": false,
"peso":"1.00",
"grade_id": 0,
"estoque_minimo": 1,
"garantia": 3,
"tipo": 8,
"lote_economico": 10,
"observacao": "teste",
"observacao2": "teste 2",
"observacao3": "teste 3",
"origem": "0",
"produto_sem_gtin": "0",
"controla_lote_serie": false,
"genero_id" : 0,
"quantidade_volumes": 1,
"ncm": "0000.00.00",
"ativo_dropship:" true,
"situacao_dropship":"",
"percentual_ipi_dropship:" 5,
"custo_dropship:" 0.00,
"fotos":[
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg",
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg",
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg",
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg"
],
"embalagens":[
{
"caracteristica_id":2,
"valor":"2,00"
},
{
"caracteristica_id":3,
"valor":"3,00"
},
{
"caracteristica_id":4,
"valor":"4,00"
},
{
"caracteristica_id":5,
"valor":"1,00"
}
],
"volumes":[
{
"descricao":"VOL.1",
"altura":"2.00",
"largura":"1.00",
"profundidade":"3.00",
"peso":"4.00",
"empilhamento_maximo":"1"
},
{
"descricao":"VOL.2",
"altura":"2.00",
"largura":"3.00",
"profundidade":"4.00",
"peso":"5.00",
"empilhamento_maximo":"1"
}
]
}
]
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Categorias ¶
Listar categoriasGET/categoria?id={id}&descricao={descricao}&token&ativo={ativo}&no_site{no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao{data_ultima_alteracao}
Example URI
GET http://localhost:8081/sax/categoria?id=1&descricao=Moveis&token&ativo=S&no_siteN&data_cadastro=2021-03-03&data_ultima_alteracao2021-03-03 18:45:55
URI Parameters
- id
number(optional) Example: 1- descricao
string(optional) Example: Moveis- ativo
string(optional) Example: S- no_site
string(optional) Example: N- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2021-03-03 18:45:55
Response
200Headers
Content-Type: application/jsonBody
[
{
"categorias": [
{
"ID": 1,
"DESCRICAO": "Móveis",
"ATIVO": "S",
"NO_SITE": "N",
"DATA_CADASTRO": "2021-03-03",
"DATA_ULTIMA_ALTERACAO": "2021-03-03 18:46:55"
}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Criar categoriasPOST/categoria?id={id}&descricao={descricao}&token&ativo={ativo}&no_site{no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao{data_ultima_alteracao}
Example URI
POST http://localhost:8081/sax/categoria?id=1&descricao=Moveis&token&ativo=S&no_siteN&data_cadastro=2021-03-03&data_ultima_alteracao2021-03-03 18:45:55
URI Parameters
- id
number(optional) Example: 1- descricao
string(optional) Example: Moveis- ativo
string(optional) Example: S- no_site
string(optional) Example: N- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2021-03-03 18:45:55
Request
Headers
Content-Type: application/jsonBody
{
"descricao": "teste categoria 2",
"no_site": false,
"ativo": true
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Grupos ¶
Listar gruposGET/grupo?id={id}&ativo={ativo}&no_site={no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
GET http://localhost:8081/sax/grupo?id=1&ativo=S&no_site=N&data_cadastro=2019-01-30&data_ultima_alteracao=2021-10-29-14:59:56
URI Parameters
- id
number(optional) Example: 1- ativo
boolean(optional) Example: S- no_site
boolean(optional) Example: N- data_cadastro
string(optional) Example: 2019-01-30- data_ultima_alteracao
string(optional) Example: 2021-10-29-14:59:56
Response
200Headers
Content-Type: application/jsonBody
[
{
"grupos": [
{
"id": 1,
"nome": "Adega",
"nome_reduzido": "adega",
"ativo": "S",
"no_site": "N",
"data_cadastro": "2021-03-03",
"data_ultima_alteracao": "2021-10-29 14:59:56"
}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Criar gruposPOST/grupo?id={id}&ativo={ativo}&no_site={no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
POST http://localhost:8081/sax/grupo?id=1&ativo=S&no_site=N&data_cadastro=2019-01-30&data_ultima_alteracao=2021-10-29-14:59:56
URI Parameters
- id
number(optional) Example: 1- ativo
boolean(optional) Example: S- no_site
boolean(optional) Example: N- data_cadastro
string(optional) Example: 2019-01-30- data_ultima_alteracao
string(optional) Example: 2021-10-29-14:59:56
Request
Headers
Content-Type: application/jsonBody
{
"nome": "novo grupo teste X",
"nome_reduzido": "novo grupo reduzido",
"no_site": true,
"ativo": false
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Subgrupos ¶
Listar subgruposGET/subgrupo?id={id}&grupo_id={grupo_id}&codigo={codigo}&ativo={ativo}&no_site={no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
GET http://localhost:8081/sax/subgrupo?id=4&grupo_id=85&codigo=1&ativo=S&no_site=N&data_cadastro=2021-10-29-15:33:11&data_ultima_alteracao=2021-10-29-15:33:11
URI Parameters
- id
number(optional) Example: 4- grupo_id
number(optional) Example: 85- codigo
number(optional) Example: 1- ativo
string(optional) Example: S- no_site
string(optional) Example: N- data_cadastro
string(optional) Example: 2021-10-29-15:33:11- data_ultima_alteracao
string(optional) Example: 2021-10-29-15:33:11
Response
200Headers
Content-Type: application/jsonBody
[
{
"subgrupos": [
{
"id": 4,
"codigo": 1,
"grupo_id": 85,
"descricao": "PONTE SOLTEIRO",
"descricao_reduzida": "ponte",
"ativo": "S",
"no_site": "N",
"data_cadastro": "2021-10-29 15:33:11",
"data_ultima_alteracao": "2021-10-29 15:33:11"
}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Criar subgruposPOST/subgrupo?id={id}&grupo_id={grupo_id}&codigo={codigo}&ativo={ativo}&no_site={no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
POST http://localhost:8081/sax/subgrupo?id=4&grupo_id=85&codigo=1&ativo=S&no_site=N&data_cadastro=2021-10-29-15:33:11&data_ultima_alteracao=2021-10-29-15:33:11
URI Parameters
- id
number(optional) Example: 4- grupo_id
number(optional) Example: 85- codigo
number(optional) Example: 1- ativo
string(optional) Example: S- no_site
string(optional) Example: N- data_cadastro
string(optional) Example: 2021-10-29-15:33:11- data_ultima_alteracao
string(optional) Example: 2021-10-29-15:33:11
Request
Headers
Content-Type: application/jsonBody
{
"descricao": "nova subcategoria T",
"descricao_reduzida": "nova subreduzida T",
"grupo_id": 33,
"no_site": true,
"ativo": true
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Marcas ¶
Listar marcasGET/marca?id={id}&ativo={ativo}&no_site={no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
GET http://localhost:8081/sax/marca?id=1&ativo=S&no_site=S&data_cadastro=2021-03-03&data_ultima_alteracao=2021-10-29-14:46:20
URI Parameters
- id
number(optional) Example: 1- ativo
string(optional) Example: S- no_site
string(optional) Example: S- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2021-10-29-14:46:20
Response
200Headers
Content-Type: application/jsonBody
[
{
"marcas": [
{
"ID": 1,
"DESCRICAO": "CAROLINA BABY",
"ATIVO": "S",
"NO_SITE": "S",
"DATA_CADASTRO": "2021-03-03",
"DATA_ULTIMA_ALTERACAO": "2021-03-03 14:46:20"
}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Criar marcasPOST/marca?id={id}&ativo={ativo}&no_site={no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
POST http://localhost:8081/sax/marca?id=1&ativo=S&no_site=S&data_cadastro=2021-03-03&data_ultima_alteracao=2021-10-29-14:46:20
URI Parameters
- id
number(optional) Example: 1- ativo
string(optional) Example: S- no_site
string(optional) Example: S- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2021-10-29-14:46:20
Request
Headers
Content-Type: application/jsonBody
{
"descricao": "nova marca xxx",
"no_site": true,
"ativo": false
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Referências ¶
Listar referênciasGET/referencia?id={id}&data_cadastro={data_cadastro}&data_alteracao{data_alteracao}
Example URI
GET http://localhost:8081/sax/referencia?id=1&data_cadastro=2021-03-03 18:45:55&data_alteracao2021-03-03 18:45:55
URI Parameters
- id
number(optional) Example: 1- data_cadastro
string(optional) Example: 2021-03-03 18:45:55- data_alteracao
string(optional) Example: 2021-03-03 18:45:55
Response
200Headers
Content-Type: application/jsonBody
[
{
"referencias": [
{}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Criar referênciasPOST/referencia?id={id}&data_cadastro={data_cadastro}&data_alteracao{data_alteracao}
Example URI
POST http://localhost:8081/sax/referencia?id=1&data_cadastro=2021-03-03 18:45:55&data_alteracao2021-03-03 18:45:55
URI Parameters
- id
number(optional) Example: 1- data_cadastro
string(optional) Example: 2021-03-03 18:45:55- data_alteracao
string(optional) Example: 2021-03-03 18:45:55
Request
Headers
Content-Type: application/jsonBody
{
"descricao": "nova ref xxx"
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Estoques ¶
Listar Estoque de produtosGET/estoqueProduto?produto_id={produto_id}&limit={limit}&offset={offset}&produto_id={produto_id}&destacar={destacar}&setor_estoque_id={setor_estoque_id}&marca_id={marca_id}&grupo_id={grupo_id}&subgrupo_id={subgrupo_id}
Example URI
GET http://localhost:8081/sax/estoqueProduto?produto_id=1&limit=12&offset=4&produto_id=1&destacar=boolean; Não Obrigatório&setor_estoque_id=11&marca_id=5&grupo_id=7&subgrupo_id=10
URI Parameters
- produto_id
number(required) Example: 1- limit
number(required) Example: 12- offset
number(required) Example: 4- destacar
string(required) Example: boolean; Não Obrigatório- setor_estoque_id
number(optional) Example: 11- marca_id
number(optional) Example: 5- grupo_id
number(optional) Example: 7- subgrupo_id
number(optional) Example: 10
Response
200Headers
Content-Type: application/jsonBody
[
{
"produto_id": 172,
"setor_estoque_id": 11,
"estoque_setor": 0,
"fator_quantidade": 1,
"local_produto": "local",
"estoque_atual": 0,
"estoque_real": 0,
"quantidade_vendido_pedidos": 0,
"quantidade_vendido_orcamentos": 0,
"quantidade_comprado": 0
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Preços ¶
Listar Preço de produtoGET/precoProduto?produto_id={produto_id}&limit={limit}&offset={offset}&destacar={destacar}&tabela_preco_id={tabela_preco_id}&marca_id={marca_id}&grupo_id={grupo_id}&subgrupo_id={subgrupo_id}
Example URI
GET http://localhost:8081/sax/precoProduto?produto_id=1&limit=1&offset=10&destacar=S&tabela_preco_id=1&marca_id=5&grupo_id=2&subgrupo_id=10
URI Parameters
- produto_id
number(required) Example: 1- limit
number(required) Example: 1- offset
number(required) Example: 10- destacar
string(optional) Example: S- tabela_preco_id
number(optional) Example: 1- marca_id
number(optional) Example: 5- grupo_id
number(optional) Example: 2- subgrupo_id
number(optional) Example: 10
Response
200Headers
Content-Type: application/jsonBody
[
{
"produto_id": 473,
"tabela_preco_id": 1,
"preco_venda": 424.89,
"percentual_desconto_maximo": 15,
"valor_desconto_maximo": 59.98,
"preco_minimo_venda": 424.89,
"preco_venda_promocao": 0,
"percentual_desconto_maximo_promocao": 0,
"valor_desconto_maximo_promocao": 0,
"promocao_ativa": "N",
"validade_promocao": "2021-03-03"
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Fotos ¶
Listar foto de produtoGET/foto?produto_id={produto_id}
Example URI
GET http://localhost:8081/sax/foto?produto_id=12
URI Parameters
- produto_id
number(required) Example: 12
Response
200Headers
Content-Type: application/jsonBody
[
{}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Pedido de compra ¶
Pedido de compra ¶
Listar pedido de compraGET/pedidoCompra?offset={offset}&limit={limit}&fornecedor_id={fornecedor_id}&vendedor_id={vendedor_id}&status_id={status_id}&situacao={situacao}&periodo_lancamento_inicio={periodo_lancamento_inicio}&periodo_lancamento_final={periodo_lancamento_final}&periodo_faturamento_inicio={periodo_faturamento_inicio}&periodo_faturamento_final={periodo_faturamento_final}
Example URI
GET http://localhost:8081/sax/pedidoCompra?offset=1&limit=10&fornecedor_id=15&vendedor_id=3&status_id=0&situacao=FI&periodo_lancamento_inicio=2021-01-02&periodo_lancamento_final=2021-01-02&periodo_faturamento_inicio=2021-01-02&periodo_faturamento_final=2021-01-02
URI Parameters
- offset
number(required) Example: 1- limit
number(required) Example: 10- fornecedor_id
number(optional) Example: 15- vendedor_id
number(optional) Example: 3- status_id
number(optional) Example: 0- situacao
string(optional) Example: FI- periodo_lancamento_inicio
string(optional) Example: 2021-01-02- periodo_lancamento_final
string(optional) Example: 2021-01-02- periodo_faturamento_inicio
string(optional) Example: 2021-01-02- periodo_faturamento_final
string(optional) Example: 2021-01-02
Response
200Headers
Content-Type: application/jsonBody
{
"erro": false,
"pedidos": [
{
"id": 1,
"identificacao_interna": "1234",
"codigo_externo": 0,
"numero_pedido_fornecedor": 2641,
"situacao": "FI",
"tipo": 0,
"faturado": true,
"cancelado": false,
"pedido false": true,
"orcamento": false,
"contato": "nome contato",
"frete": "C",
"quantidade_parcelas": 1,
"intervalo_parcelas": 0,
"quantidade_fiscal": 0,
"destacar": "S",
"situacao_separacao": "N",
"tipo_pedido_id": 0,
"status_id": 0,
"filial_id": {
"id": 2,
"nome_fantasia": "Nome fantasia",
"razao_social": "Razao social",
"cpf_cnpj": "12.300.00/0001-15",
"inscricao": "083.251.47-2",
"cmc": 0,
"suframa": "sigla",
"email": "[email protected]",
"telefone": "(43)00000-3000",
"fax": "(00)00000-0000",
"endereco": {
"logradouro": "RUA GRACIANO",
"cep": "29015",
"numero": 73,
"bairro": "CENTRO",
"cidade": "Cidade",
"estado": "ES",
"complemento": "EDIF 505",
"codigo_ibge_cidade": 3205309,
"codigo_ibge_pais": 1058
}
},
"comprador_id": 2,
"transportadora_id": 0,
"forma_pagamento_id": 0,
"setor_id": 1,
"valor_total_servico": 0,
"valor_descontos_servico": 0,
"valor_total_produto": 70.51,
"valor_descontos_produto": 0,
"valor_frete": 0,
"valor_outra_despesas": 0,
"valor_total_geral": 70.51,
"valor_base_icms": 0,
"valor_total_icms": 0,
"valor_base_icms_st": 0,
"valor_total_icms_st": 0,
"valor_base_ipi": 0,
"valor_total_ipi": 0,
"data_cadastro": "2021-03-03",
"data_pedido": "2021-03-03",
"data_recebimento": "2021-03-03",
"observacoes": "obs teste",
"observacoes2": "obs teste 2",
"fornecedor": {
"id": 15,
"nome_fantasia": "MOVEIS BELO",
"razao_social": "MOVEIS BELO INDUSTRIA E COM LTDA",
"cpf_cnpj": "75.243.220/0001-45",
"inscricao": "6280337810",
"suframa": "s",
"email": "[email protected]",
"telefone": "(43)00002-1600",
"fax": "(00)00000-0000",
"celular": "(00)00000-000",
"enderecofornecedor": {
"logradouro": "RUA GRACIANO",
"cep": "29015",
"numero": 73,
"bairro": "CENTRO",
"cidade": "Cidade",
"estado": "ES",
"complemento": "EDIF 505",
"codigo_ibge_cidade": 3205309,
"codigo_ibge_pais": 1058
},
"setor_estoque_dropship": {
"id": 0,
"descricao": "setor estoque",
"empresa_id": 0,
"ativo": false
}
},
"produto": [
{
"sequencia": 1,
"produto_id": 4753,
"quantidade": 1,
"desconto": 0,
"valor_unitario": 70.51,
"quantidade_separada": 0,
"quantidade_faturada": 1,
"valor_frete": 0,
"valor_outras_despesas": 0,
"unidade": "UND",
"complemento": "complemento",
"valor_custo_medio": 63.54,
"valor_ultimo_custo": 70.51,
"fator_valor": "1.00",
"fator_quantidade": 1,
"aprovado": "A",
"aliquota_valor_ipi": "0.00",
"aliquota_icms": 0,
"aliquota_icms_st": 0,
"aliquota_icms_subtracao": 0,
"creditar_icms": true,
"creditar_icms_st": true,
"creditar_ipi": true,
"cst_icms": "0",
"cst_ipi": "0",
"incidencia_icms": 0,
"incidencia_icms_subtracao": 0,
"incidencia_icms_st": 0,
"incidencia_lei_400_ipi": 0,
"margem_valor_agregado": 0,
"lei_400_ipi": false
}
],
"parcelas": [
{
"parcela": 1,
"valor": 70.51,
"vencimento": "2021-03-03"
}
],
"pedido_venda": [
{
"id": 169301,
"identificacao_interna": 5857,
"nome_cliente": "nome do cliente"
}
],
"total_count": "11364"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"erro": {
"type": "boolean"
},
"pedidos": {
"type": "array"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Pedido de compra ¶
Listar pedido de compraGET/pedidoCompra?id={id}
Example URI
GET http://localhost:8081/sax/pedidoCompra?id=1
URI Parameters
- id
number(required) Example: 1
Response
200Headers
Content-Type: application/jsonBody
{
"erro": false,
"pedidos": [
{
"id": 1,
"identificacao_interna": "1234",
"codigo_externo": 0,
"numero_pedido_fornecedor": 2641,
"situacao": "FI",
"tipo": 0,
"faturado": true,
"cancelado": false,
"pedido false": true,
"orcamento": false,
"contato": "nome contato",
"frete": "C",
"quantidade_parcelas": 1,
"intervalo_parcelas": 0,
"quantidade_fiscal": 0,
"destacar": "S",
"situacao_separacao": "N",
"tipo_pedido_id": 0,
"status_id": 0,
"filial_id": {
"id": 2,
"nome_fantasia": "Nome fantasia",
"razao_social": "Razao social",
"cpf_cnpj": "12.300.00/0001-15",
"inscricao": "083.251.47-2",
"cmc": 0,
"suframa": "sigla",
"email": "[email protected]",
"telefone": "(43)00000-3000",
"fax": "(00)00000-0000",
"endereco": {
"logradouro": "RUA GRACIANO",
"cep": "29015",
"numero": 73,
"bairro": "CENTRO",
"cidade": "Cidade",
"estado": "ES",
"complemento": "EDIF 505",
"codigo_ibge_cidade": 3205309,
"codigo_ibge_pais": 1058
}
},
"comprador_id": 2,
"transportadora_id": 0,
"forma_pagamento_id": 0,
"setor_id": 1,
"valor_total_servico": 0,
"valor_descontos_servico": 0,
"valor_total_produto": 70.51,
"valor_descontos_produto": 0,
"valor_frete": 0,
"valor_outra_despesas": 0,
"valor_total_geral": 70.51,
"valor_base_icms": 0,
"valor_total_icms": 0,
"valor_base_icms_st": 0,
"valor_total_icms_st": 0,
"valor_base_ipi": 0,
"valor_total_ipi": 0,
"data_cadastro": "2021-03-03",
"data_pedido": "2021-03-03",
"data_recebimento": "2021-03-03",
"observacoes": "obs teste",
"observacoes2": "obs teste 2",
"fornecedor": {
"id": 15,
"nome_fantasia": "MOVEIS BELO",
"razao_social": "MOVEIS BELO INDUSTRIA E COM LTDA",
"cpf_cnpj": "75.243.220/0001-45",
"inscricao": "6280337810",
"suframa": "s",
"email": "[email protected]",
"telefone": "(43)00002-1600",
"fax": "(00)00000-0000",
"celular": "(00)00000-000",
"enderecofornecedor": {
"logradouro": "RUA GRACIANO",
"cep": "29015",
"numero": 73,
"bairro": "CENTRO",
"cidade": "Cidade",
"estado": "ES",
"complemento": "EDIF 505",
"codigo_ibge_cidade": 3205309,
"codigo_ibge_pais": 1058
},
"setor_estoque_dropship": {
"id": 0,
"descricao": "setor estoque",
"empresa_id": 0,
"ativo": false
}
},
"produto": [
{
"sequencia": 1,
"produto_id": 4753,
"quantidade": 1,
"desconto": 0,
"valor_unitario": 70.51,
"quantidade_separada": 0,
"quantidade_faturada": 1,
"valor_frete": 0,
"valor_outras_despesas": 0,
"unidade": "UND",
"complemento": "complemento",
"valor_custo_medio": 63.54,
"valor_ultimo_custo": 70.51,
"fator_valor": "1.00",
"fator_quantidade": 1,
"aprovado": "A",
"aliquota_valor_ipi": "0.00",
"aliquota_icms": 0,
"aliquota_icms_st": 0,
"aliquota_icms_subtracao": 0,
"creditar_icms": true,
"creditar_icms_st": true,
"creditar_ipi": true,
"cst_icms": "0",
"cst_ipi": "0",
"incidencia_icms": 0,
"incidencia_icms_subtracao": 0,
"incidencia_icms_st": 0,
"incidencia_lei_400_ipi": 0,
"margem_valor_agregado": 0,
"lei_400_ipi": false
}
],
"parcelas": [
{
"parcela": 1,
"valor": 70.51,
"vencimento": "2021-03-03"
}
],
"pedido_venda": [
{
"id": 169301,
"identificacao_interna": 5857,
"nome_cliente": "nome do cliente"
}
],
"total_count": "11364"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"erro": {
"type": "boolean"
},
"pedidos": {
"type": "array"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Pedido Compra Lido ¶
Criar pedido compra lidoPOST/pedidoCompraLido
Example URI
POST http://localhost:8081/sax/pedidoCompraLido
Request
Headers
Content-Type: application/jsonBody
[
6,
7
]Response
201Headers
Content-Type: application/jsonBody
{
"erro": "false",
"mensagem": "sucesso"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"erro": {
"type": "string"
},
"mensagem": {
"type": "string"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Faturar Pedido de Compra ¶
Criar Faturar Pedido de CompraPOST/faturarpedidocompra
Example URI
POST http://localhost:8081/sax/faturarpedidocompra
Request
Headers
Content-Type: application/jsonBody
[
{
"pedido_compra_id": 1,
"chave_nfe": "21312312",
"xml_nfe": "21312312",
"danfe_pdf_nfe": ""
},
{
"pedido_compra_id": 2,
"chave_nfe": "11111111",
"xml_nfe": "33333333",
"danfe_pdf_nfe": ""
}
]Response
201Headers
Content-Type: application/jsonBody
{
"erro": "false",
"mensagem": "sucesso"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"erro": {
"type": "string"
},
"mensagem": {
"type": "string"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Pedidos ¶
Pedido ¶
Listar PedidosGET/pedido?limit={limit}&offset={offset}&cliente_id={cliente_id}&vendedor_id={vendedor_id}&status_id={status_id}&situacao={situacao}&periodo_lancamento_inicio={periodo_lancamento_inicio}&periodo_lancamento_final={periodo_lancamento_final}&periodo_faturamento_inicio={periodo_faturamento_inicio}&periodo_faturamento_final={periodo_faturamento_final}
Example URI
GET http://localhost:8081/sax/pedido?limit=1&offset=5&cliente_id=560&vendedor_id=0&status_id=0&situacao=FI&periodo_lancamento_inicio=2021-03-03&periodo_lancamento_final=2021-03-03&periodo_faturamento_inicio=2021-03-03&periodo_faturamento_final=2021-03-03
URI Parameters
- limit
number(required) Example: 1- offset
number(required) Example: 5- cliente_id
number(optional) Example: 560- vendedor_id
number(optional) Example: 0- status_id
number(required) Example: 0- situacao
string(optional) Example: FI- periodo_lancamento_inicio
string(optional) Example: 2021-03-03- periodo_lancamento_final
string(optional) Example: 2021-03-03- periodo_faturamento_inicio
string(optional) Example: 2021-03-03- periodo_faturamento_final
string(optional) Example: 2021-03-03
Response
200Headers
Content-Type: application/jsonBody
[
{
"id": 2941,
"identificacao_interna": 21978,
"codigo_externo": 21978,
"situacao": "FI",
"tipo": 1,
"faturado": true,
"cancelado": false,
"mercadolivre_fulfillment": false,
"pedido": false,
"orcamento": false,
"contato": "nome contato",
"frete": "C",
"quantidade_parcelas": 0,
"tabela": 0,
"intervalo_parcelas": 0,
"destacar": "S",
"situacao_separacao": "N",
"tipo_pedido_id": 0,
"status_id": 0,
"filial_id": 0,
"vendedor_id": 2,
"transportadora_id": 10,
"forma_pagamento_id": 4,
"setor_id": 1,
"valor_total_servico": 0,
"valor_descontos_servico": 0,
"valor_total_produto": 302.95,
"valor_descontos_produto": 14.62,
"valor_frete": 60.16,
"valor_outra_despesas": 0,
"valor_total_geral": 302.95,
"valor_total_pis": 0,
"valor_total_cofins": 0,
"valor_total_fcp": 0,
"valor_total_icms_recolhido": 0,
"valor_total_icms_sub": 0,
"valor_base_icms_sub": 0,
"valor_base_fcp": 0,
"peso_bruto": 35,
"peso_liquido": 35,
"quantidade_volumes": 2,
"data_cadastro": "2021-03-03",
"hora_cadastro": "04:27:03",
"data_pedido": "2021-03-03",
"hora_pedido": "16:51:30",
"data_aprovacao": "2021-03-03",
"hora_aprovacao": "16:51:30",
"data_previsao_entrega": "2021-03-03",
"data_prazo_faturamento": "2021-03-03",
"data_ultima_atualizacao": "2021-03-03 14:39:32",
"data_ultima_atualizacao_integracao": "2021-03-03 00:00:00",
"observacoes": "obs teste",
"observacoes2": "obs teste 2",
"servicos": "[]",
"vendedores": "[]",
"endereco": {
"logradouro": "rua 406",
"cep": "88220",
"numero": 411,
"bairro": "morretes",
"cidade": "Itapema",
"estado": "SC",
"complemento": "apt 401 edifio dona maria",
"codigo_ibge_cidade": 0,
"codigo_ibge_pais": 1058
},
"cliente": {
"id": 560,
"nome": "geisa ilana vogt",
"apelido": "lana",
"cpf_cnpj": "098.528.739",
"rg": "ISENTO",
"sexo": "F",
"data_nascimento": "1995",
"estado_civil": "solteiro",
"nome_pai": "Nome pai",
"nome_mae": "Nome mãe",
"suframa": "suframa",
"telefone_comercial": "(44) 0000-0000",
"telefone_residencial": "(44) 0000-0000",
"telefone_celular": "(44) 90000-0000",
"email": "[email protected]",
"email_fiscal": "[email protected]",
"rede_grupo_id": 0,
"data_cadastro": "2021-03-03",
"data_ultima_alteracao": "2021-03-03 00:00:00",
"observacoes": "obs teste",
"exibir_preco_api_ecommerce": false,
"vendedor": {
"id": 0,
"nome": "Nome",
"apelido": "Vend"
},
"endereco": {
"logradouro": "rua 406",
"cep": "88220",
"numero": 411,
"bairro": "morretes",
"cidade": "Itapema",
"estado": "SC",
"complemento": "apt 401 edifio dona maria",
"codigo_ibge_cidade": 0,
"codigo_ibge_pais": 1058
},
"enderecocobranca": {
"logradouro": "rua 406",
"cep": "88220",
"numero": 411,
"bairro": "morretes",
"cidade": "Itapema",
"estado": "SC",
"complemento": "apt 401 edifio dona maria",
"codigo_ibge_cidade": 0,
"codigo_ibge_pais": 1058
},
"enderecoentrega": {
"logradouro": "rua 406",
"cep": "88220",
"numero": 411,
"bairro": "morretes",
"cidade": "Itapema",
"estado": "SC",
"complemento": "apt 401 edifio dona maria",
"codigo_ibge_cidade": 0,
"codigo_ibge_pais": 1058
}
},
"parcelas": [
{
"parcela": 1,
"valor": 302.95,
"vencimento": "2021-03-03",
"tipo_condicao_id": 0,
"tipo_recebimento_id": 0,
"ordem_faturamento_id": 0,
"faturado": "N"
}
],
"produtos": [
{
"sequencia": 1,
"produto_id": 4384,
"referencia_produto_id": 0,
"quantidade": 1,
"desconto": 6.62,
"valor_unitario": 82.8,
"valor_total_liquido": 76.18,
"quantidade_separada": 0,
"valor_frete": 20.09,
"valor_outras_despesas": 0,
"peso": 26,
"tabela_id": 0,
"unidade": "UND",
"valor_preco_tabela": 0,
"valor_unitario_origem": 0,
"valor_custo_medio": 0,
"valor_ultimo_custo": 0,
"fator_valor": 1,
"fator_quantidade": 1,
"valor_total_minimo": 0,
"aprovado": "A",
"tabela_preco_id": 0,
"valor_icms": 0,
"valor_base_icms": 0,
"aliquota_difal": 0,
"aliquota_valor_ipi": 0,
"aliquota_substituicao": 0,
"aliquota_icms": 0,
"aliquota_icms_subtracao": 0,
"aliquota_cofins": 0,
"aliquota_pis": 0,
"aliquota_fcp": 0,
"regra_icms": 0,
"regra_ipi": 0,
"regra_cofins": 0,
"regra_fcp": 0
}
],
"faturamento": {
"filial_id": 3,
"numero": 13984,
"chave": 4.1190427350587e+43,
"valor": 68.45,
"cfop": 6.923,
"data_emissao": "2021-03-03 00:00:00",
"serie_id": 15,
"serie_descricao": "NE",
"rastreio": {
"codigo_rastreio": "SR213910901",
"data_entrega": "2021-03-03",
"data_previsao_entrega": "2021-03-03",
"data_coleta": "2021-03-03",
"observacoes": "teste de obs",
"valor_declarado": 0
}
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Preco de Produto ¶
Listar PedidosGET/pedido?id={id}
Example URI
GET http://localhost:8081/sax/pedido?id=1
URI Parameters
- id
number(required) Example: 1
Response
200Headers
Content-Type: application/jsonBody
[
{
"id": 2941,
"identificacao_interna": 21978,
"codigo_externo": 21978,
"situacao": "FI",
"tipo": 1,
"faturado": true,
"cancelado": false,
"mercadolivre_fulfillment": false,
"pedido": false,
"orcamento": false,
"contato": "nome contato",
"frete": "C",
"quantidade_parcelas": 0,
"tabela": 0,
"intervalo_parcelas": 0,
"destacar": "S",
"situacao_separacao": "N",
"tipo_pedido_id": 0,
"status_id": 0,
"filial_id": 0,
"vendedor_id": 2,
"transportadora_id": 10,
"forma_pagamento_id": 4,
"setor_id": 1,
"valor_total_servico": 0,
"valor_descontos_servico": 0,
"valor_total_produto": 302.95,
"valor_descontos_produto": 14.62,
"valor_frete": 60.16,
"valor_outra_despesas": 0,
"valor_total_geral": 302.95,
"valor_total_pis": 0,
"valor_total_cofins": 0,
"valor_total_fcp": 0,
"valor_total_icms_recolhido": 0,
"valor_total_icms_sub": 0,
"valor_base_icms_sub": 0,
"valor_base_fcp": 0,
"peso_bruto": 35,
"peso_liquido": 35,
"quantidade_volumes": 2,
"data_cadastro": "2021-03-03",
"hora_cadastro": "04:27:03",
"data_pedido": "2021-03-03",
"hora_pedido": "16:51:30",
"data_aprovacao": "2021-03-03",
"hora_aprovacao": "16:51:30",
"data_previsao_entrega": "2021-03-03",
"data_prazo_faturamento": "2021-03-03",
"data_ultima_atualizacao": "2021-03-03 14:39:32",
"data_ultima_atualizacao_integracao": "2021-03-03 00:00:00",
"observacoes": "obs teste",
"observacoes2": "obs teste 2",
"servicos": "[]",
"vendedores": "[]",
"endereco": {
"logradouro": "rua 406",
"cep": "88220",
"numero": 411,
"bairro": "morretes",
"cidade": "Itapema",
"estado": "SC",
"complemento": "apt 401 edifio dona maria",
"codigo_ibge_cidade": 0,
"codigo_ibge_pais": 1058
},
"cliente": {
"id": 560,
"nome": "geisa ilana vogt",
"apelido": "lana",
"cpf_cnpj": "098.528.739",
"rg": "ISENTO",
"sexo": "F",
"data_nascimento": "1995",
"estado_civil": "solteiro",
"nome_pai": "Nome pai",
"nome_mae": "Nome mãe",
"suframa": "suframa",
"telefone_comercial": "(44) 0000-0000",
"telefone_residencial": "(44) 0000-0000",
"telefone_celular": "(44) 90000-0000",
"email": "[email protected]",
"email_fiscal": "[email protected]",
"rede_grupo_id": 0,
"data_cadastro": "2021-03-03",
"data_ultima_alteracao": "2021-03-03 00:00:00",
"observacoes": "obs teste",
"exibir_preco_api_ecommerce": false,
"vendedor": {
"id": 0,
"nome": "Nome",
"apelido": "Vend"
},
"endereco": {
"logradouro": "rua 406",
"cep": "88220",
"numero": 411,
"bairro": "morretes",
"cidade": "Itapema",
"estado": "SC",
"complemento": "apt 401 edifio dona maria",
"codigo_ibge_cidade": 0,
"codigo_ibge_pais": 1058
},
"enderecocobranca": {
"logradouro": "rua 406",
"cep": "88220",
"numero": 411,
"bairro": "morretes",
"cidade": "Itapema",
"estado": "SC",
"complemento": "apt 401 edifio dona maria",
"codigo_ibge_cidade": 0,
"codigo_ibge_pais": 1058
},
"enderecoentrega": {
"logradouro": "rua 406",
"cep": "88220",
"numero": 411,
"bairro": "morretes",
"cidade": "Itapema",
"estado": "SC",
"complemento": "apt 401 edifio dona maria",
"codigo_ibge_cidade": 0,
"codigo_ibge_pais": 1058
}
},
"parcelas": [
{
"parcela": 1,
"valor": 302.95,
"vencimento": "2021-03-03",
"tipo_condicao_id": 0,
"tipo_recebimento_id": 0,
"ordem_faturamento_id": 0,
"faturado": "N"
}
],
"produtos": [
{
"sequencia": 1,
"produto_id": 4384,
"referencia_produto_id": 0,
"quantidade": 1,
"desconto": 6.62,
"valor_unitario": 82.8,
"valor_total_liquido": 76.18,
"quantidade_separada": 0,
"valor_frete": 20.09,
"valor_outras_despesas": 0,
"peso": 26,
"tabela_id": 0,
"unidade": "UND",
"valor_preco_tabela": 0,
"valor_unitario_origem": 0,
"valor_custo_medio": 0,
"valor_ultimo_custo": 0,
"fator_valor": 1,
"fator_quantidade": 1,
"valor_total_minimo": 0,
"aprovado": "A",
"tabela_preco_id": 0,
"valor_icms": 0,
"valor_base_icms": 0,
"aliquota_difal": 0,
"aliquota_valor_ipi": 0,
"aliquota_substituicao": 0,
"aliquota_icms": 0,
"aliquota_icms_subtracao": 0,
"aliquota_cofins": 0,
"aliquota_pis": 0,
"aliquota_fcp": 0,
"regra_icms": 0,
"regra_ipi": 0,
"regra_cofins": 0,
"regra_fcp": 0
}
],
"faturamento": {
"filial_id": 3,
"numero": 13984,
"chave": 4.1190427350587e+43,
"valor": 68.45,
"cfop": 6.923,
"data_emissao": "2021-03-03 00:00:00",
"serie_id": 15,
"serie_descricao": "NE",
"rastreio": {
"codigo_rastreio": "SR213910901",
"data_entrega": "2021-03-03",
"data_previsao_entrega": "2021-03-03",
"data_coleta": "2021-03-03",
"observacoes": "teste de obs",
"valor_declarado": 0
}
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Pedidos ¶
Criar pedidosPOST/pedido
Example URI
POST http://localhost:8081/sax/pedido
Request
Headers
Content-Type: application/jsonBody
{
"pedidos": [
{
"identificacao_interna": "701861XXXXZ",
"codigo_externo": 0,
"situacao": "AI",
"cancelado": false,
"contato": "",
"frete": "S",
"tabela": "",
"destacar": "N",
"situacao_separacao": "N",
"tipo_pedido_id": 0,
"status_id": 26,
"filial_id": 1,
"vendedor_id": 87,
"transportadora_id": 0,
"forma_pagamento_id": 0,
"setor_id": 0,
"valor_total_servico": "0.00",
"valor_descontos_servico": "0.00",
"valor_total_produto": "0.00",
"valor_descontos_produto": "0.00",
"valor_frete": "0.00",
"valor_outra_despesas": "0.00",
"valor_total_geral": "1000.00",
"peso_bruto": "0.00",
"peso_liquido": "0.00",
"quantidade_volumes": "0.00",
"valor_total_pis": "0.00",
"valor_total_cofins": "0.00",
"valor_total_fcp": "0.00",
"valor_total_icms_recolhido": "0.00",
"valor_total_icms_sub": "0.00",
"valor_base_icms_sub": "0.00",
"valor_base_fcp": "0.00",
"tributos": true,
"endereco": {
"logradouro": "TRA QUINTINO BOCAIUVA",
"cep": "66053-240",
"numero": "638",
"bairro": "REDUTO",
"cidade": "BELEM",
"estado": "PA",
"complemento": "",
"codigo_ibge_cidade": "0",
"codigo_ibge_pais": "1058"
},
"cliente": {
"nome": "CIBELLE CRISTINA OLIVEIRA DOS SANTOS",
"apelido": "CIBELLE CRISTINA OLIVEIRA DOS SANTOS",
"cpf_cnpj": "705.687.582-34",
"rg": "ISENTO",
"sexo": "F",
"data_nascimento": "1982-12-05",
"estado_civil": "",
"nome_pai": "",
"nome_mae": "",
"suframa": "",
"telefone_comercial": "(91)03246-4746",
"telefone_residencial": "(91)03246-3746",
"telefone_celular": "(91)99293-5933",
"email": "[email protected]",
"email_fiscal": "[email protected]",
"rede_grupo_id": 0,
"observacoes": "[email protected]",
"vendedor_id": 80,
"endereco": {
"logradouro": "TRA QUINTINO BOCAIUVA",
"cep": "66053-240",
"numero": "638",
"bairro": "REDUTO",
"cidade": "BELEM",
"estado": "PA",
"complemento": "",
"codigo_ibge_cidade": "1501402",
"codigo_ibge_pais": "1058"
},
"endereco_cobranca": {
"logradouro": "TRA QUINTINO BOCAIUVA",
"cep": "66053-240",
"numero": "638",
"bairro": "REDUTO",
"cidade": "BELEM",
"estado": "PA",
"complemento": "",
"codigo_ibge_cidade": "1501402",
"codigo_ibge_pais": "1058"
},
"endereco_entrega": {
"logradouro": "TRA QUINTINO BOCAIUVA",
"cep": "66053-240",
"numero": "638",
"bairro": "REDUTO",
"cidade": "BELEM",
"estado": "PA",
"complemento": "",
"codigo_ibge_cidade": "1501402",
"codigo_ibge_pais": "0"
}
},
"data_cadastro": "2014-01-06",
"hora_cadastro": "00:00:00",
"data_pedido": "1899-12-30",
"hora_pedido": "00:00:00",
"data_aprovacao": "1899-12-30",
"hora_aprovacao": "00:00:00",
"data_previsao_entrega": "1899-12-30",
"data_prazo_faturamento": "1899-12-30",
"data_ultima_atualizacao": "2020-02-10 15:02:21",
"data_ultima_atualizacao_integracao": "1899-12-30 00:00:00",
"observacoes": "",
"observacoes2": "",
"produtos": [
{
"sequencia": 1,
"produto_id": 240,
"referencia_produto_id": 0,
"quantidade": "6.00",
"desconto": "0.00",
"valor_unitario": "73.17",
"valor_total_liquido": "0.00",
"quantidade_separada": "0.00",
"valor_frete": "0.00",
"valor_outras_despesas": "0.00",
"peso": "0.00",
"tabela_id": 0,
"unidade": "UND",
"valor_preco_tabela": "0.00",
"valor_unitario_origem": "0.00",
"valor_custo_medio": "0.00",
"valor_ultimo_custo": "0.00",
"fator_valor": "1.00",
"fator_quantidade": "1.00",
"valor_total_minimo": "0.00",
"tabela_preco_id": 7,
"valor_icms": "0.00",
"valor_base_icms": "0.00",
"aliquota_difal": "0.00",
"aliquota_valor_ipi": "0.00",
"aliquota_substituicao": "0.00",
"aliquota_icms_subtracao": "0.00",
"aliquota_cofins": "0.00",
"aliquota_pis": "0.00",
"aliquota_fcp": "0.00",
"regra_icms": 233,
"regra_ipi": 0,
"regra_cofins": 0,
"regra_fcp": 0,
"aliquota_icms": "12.00",
"incidencia_icms": "100.00",
"incidencia_icmsst": "100.00",
"incidencia_pis": "100.00",
"incidencia_cofins": "100.00",
"incidencia_icms_subtracao": "100.00",
"margem_icmsst": "0",
"pauta_icmsst": "0"
}
],
"parcelas": [
{
"parcela": 1,
"valor": 100,
"vencimento": "2021-07-01",
"tipo_recebimento_id": 1
}
]
}
]
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Cursos ¶
Cursos ¶
Listar cursosGET/curso?id={id}&ativo={ativo}&data_cadastro={data_cadastro}&data_alteracao{data_alteracao}
Example URI
GET http://localhost:8081/sax/curso?id=1&ativo=S&data_cadastro=2021-03-03&data_alteracao2021-03-03 18:45:55
URI Parameters
- id
number(optional) Example: 1- ativo
string(optional) Example: S- data_cadastro
string(optional) Example: 2021-03-03- data_alteracao
string(optional) Example: 2021-03-03 18:45:55
Response
200Headers
Content-Type: application/jsonBody
[
{
"cursos": [
{}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Disciplinas ¶
Listar disciplinasGET/disciplina?id={id}&ativo={ativo}&data_cadastro={data_cadastro}&data_alteracao{data_alteracao}
Example URI
GET http://localhost:8081/sax/disciplina?id=10&ativo=S&data_cadastro=2021-03-03&data_alteracao2021-03-03 18:45:55
URI Parameters
- id
number(optional) Example: 10- ativo
string(optional) Example: S- data_cadastro
string(optional) Example: 2021-03-03- data_alteracao
string(optional) Example: 2021-03-03 18:45:55
Response
200Headers
Content-Type: application/jsonBody
[
{
"disciplinas": [
{}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Turmas ¶
Listar turmasGET/turma?id={id}&ativo={ativo}&data_cadastro={data_cadastro}&data_alteracao{data_alteracao}
Example URI
GET http://localhost:8081/sax/turma?id=1&ativo='S'&data_cadastro=2021-03-03 18:45:55&data_alteracao2021-03-03 18:45:55
URI Parameters
- id
number(optional) Example: 1- ativo
string(optional) Example: 'S'- data_cadastro
string(optional) Example: 2021-03-03 18:45:55- data_alteracao
string(optional) Example: 2021-03-03 18:45:55
Response
200Headers
Content-Type: application/jsonBody
[
{
"turmas": [
{}
]
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Impostos ¶
Impostos ¶
Criar impostosPOST/imposto
Example URI
POST http://localhost:8081/sax/imposto
Request
Headers
Content-Type: application/jsonBody
{
{ "filial_id" : 1,
"cliente_id": 5,
"cliente_cpfcnpj": "000.000.000-00",
"produtos" : [
{
"sequencia" : 1,
"produto_id" : 7773,
"quantidade" : 1,
"valor_unitario" : 629.90,
"valor_frete" : 0,
"desconto" : 0,
"outras_despesas" : 0,
"valor_total_liquido" : 629.90,
"seguro" : 0,
"lei_400_ipi" : false,
"incidencia_lei_400_ipi" : 0,
"fator_quantidade" : 1
}
]
}
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Clientes ¶
Cliente ¶
Listar ClientesGET/cliente?limit={limit}&offset={offset}&id={id}&ativo={ativo}&no_site={no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}&cpf_cnpj={cpf_cnpj}&vendedor_id{vendedor_id}
Example URI
GET http://localhost:8081/sax/cliente?limit=1&offset=5&id=10&ativo=S&no_site=S&data_cadastro=2021&data_ultima_alteracao=2021&cpf_cnpj=705.687.582&vendedor_id12
URI Parameters
- limit
number(required) Example: 1- offset
number(required) Example: 5- id
number(optional) Example: 10- ativo
string(optional) Example: S- no_site
string(optional) Example: S- data_cadastro
string(required) Example: 202103-03 (string, optional)
- data_ultima_alteracao
string(required) Example: 202103-03 (string, optional)
- cpf_cnpj
string(required) Example: 705.687.58234 (string, optional)
- vendedor_id
number(optional) Example: 12
Response
200Headers
Content-Type: application/jsonBody
[
{
"id": 6,
"nome": "Maria Isabel Silva",
"apelido": "Maria Isabel",
"cpf_cnpj": "000.000.000",
"rg": "ISENTO",
"sexo": "F",
"data_nascimento": "2001",
"estado_civil": "S",
"nome_pai": "nome do pai",
"nome_mae": "nome da mae",
"suframa": "suframa",
"telefone_comercial": "(44) 0000-0000",
"telefone_residencial": "(44) 0000-0000",
"telefone_celular": "(44) 0000-0000",
"email": "email",
"email_fiscal": "email",
"rede_grupo_id": 0,
"data_cadastro": "1899",
"data_ultima_alteracao": "1899",
"observacoes": "observcoes",
"exibir_preco_api_ecommerce": false,
"endereco": {
"logradouro": "Domingos perossi",
"cep": "203581",
"numero": 980,
"bairro": "Joao Berbel 3",
"cidade": "CRAVINHOS",
"estado": "SP",
"complemento": "complemente",
"codigo_ibge_cidade": 6270205,
"codigo_ibge_pais": 6087
},
"enderecocobranca": {
"logradouro": "Domingos perossi",
"cep": "203581",
"numero": 980,
"bairro": "Joao Berbel 3",
"cidade": "CRAVINHOS",
"estado": "SP",
"complemento": "complemente",
"codigo_ibge_cidade": 6270205,
"codigo_ibge_pais": 6087
},
"enderecoentrega": {
"logradouro": "Domingos perossi",
"cep": "203581",
"numero": 980,
"bairro": "Joao Berbel 3",
"cidade": "CRAVINHOS",
"estado": "SP",
"complemento": "complemente",
"codigo_ibge_cidade": 6270205,
"codigo_ibge_pais": 6087
}
}
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Clientes ¶
Criar ClientesPOST/cliente
Example URI
POST http://localhost:8081/sax/cliente
Request
Headers
Content-Type: application/jsonBody
{
"nome": "MARIA ISABELA SILVA",
"apelido": "ISABELA",
"cpf_cnpj": "000.000.000-00",
"rg": "ISENTO",
"sexo": "F",
"data_nascimento": "1992-10-30",
"estado_civil": "",
"nome_pai": "",
"nome_mae": "",
"suframa": "",
"telefone_comercial": "(00)00000-0000",
"telefone_residencial": "(00)00000-0000",
"telefone_celular": "(00)00000-0000",
"email": "[email protected]",
"email_fiscal": "[email protected]",
"rede_grupo_id": 0,
"observacoes": "[email protected]",
"vendedor_id": 38,
"endereco": {
"logradouro": "TRA QUINTINO BOCAIUVA",
"cep": "84567-240",
"numero": "970",
"bairro": "REDUTO",
"cidade": "BELEM",
"estado": "PA",
"complemento": "",
"codigo_ibge_cidade": "546972",
"codigo_ibge_pais": "6078"
},
"endereco_cobranca": {
"logradouro": "TRA QUINTINO BOCAIUVA",
"cep": "84567-240",
"numero": "970",
"bairro": "REDUTO",
"cidade": "BELEM",
"estado": "PA",
"complemento": "",
"codigo_ibge_cidade": "546972",
"codigo_ibge_pais": "6078"
},
"endereco_entrega": {
"logradouro": "TRA QUINTINO BOCAIUVA",
"cep": "66053-240",
"numero": "970",
"bairro": "REDUTO",
"cidade": "BELEM",
"estado": "PA",
"complemento": "",
"codigo_ibge_cidade": "5142047",
"codigo_ibge_pais": "0"
}
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}FinalizarProcessoDropship ¶
FinalizarProcessoDropship ¶
Criar finalizarProcessoDropshipPOST/finalizarProcessoDropship
Example URI
POST http://localhost:8081/sax/finalizarProcessoDropship
Request
Headers
Content-Type: application/jsonBody
[
{"pedido_venda_id": "176731"
"xml_nfe": "xxx"
}
]Response
201Headers
Content-Type: application/jsonBody
{
"id": 1,
"erro": false,
"mensagem": "sucesso"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
},
"erro": {
"type": "boolean"
},
"mensagem": {
"type": "string"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Acerto Estoque ¶
AcertoEstoque ¶
Criar acerto estoquePOST/acertoEstoque
Example URI
POST http://localhost:8081/sax/acertoEstoque
Request
Headers
Content-Type: application/jsonBody
{
"acertos": [
{
"setor_estoque_id": "30",
"produto_id": "11147",
"quantidade": "10",
"movimento": "ENTRADA",
"historico": "teste"
}
]
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 6512,
"mensagem": "sucesso"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
},
"mensagem": {
"type": "string"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Padronizado ¶
Padronizados ¶
Listar padronizadoGET/padronizado?id={id}offset={offset}&limit={limit}&ativo={ativo}&destacar_site={destacar_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}&marca_id={marca_id}
Example URI
GET http://localhost:8081/sax/padronizado?id=1offset=2&limit=10&ativo=true&destacar_site=false&data_cadastro=2021-03-03&data_ultima_alteracao=2022-04-16-00:00:00&marca_id=0
URI Parameters
- id
number(optional) Example: 1- offset
number(optional) Example: 2- limit
number(optional) Example: 10- ativo
boolean(optional) Example: true- destacar_site
boolean(optional) Example: false- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2022-04-16-00:00:00- marca_id
number(optional) Example: 0
Response
200Headers
Content-Type: application/jsonBody
{
"padronizados": [
{
"id": 1,
"descricao": "COZINHA MODULADA AMERICANA 5 PEÇAS HENN",
"identificacao": "800000100",
"ativo": true,
"numero_original": "",
"numero_fabricante": "",
"outro_codigo": "",
"descricao_ecommerce": "",
"informacao": "",
"informacao_html": "",
"valor_total": "2635.47",
"peso": "0.00",
"origem": "0",
"garantia": 0,
"data_cadastro": "2022-03-30",
"grupo_id": 0,
"subgrupo_id": 0,
"marca_id": 0,
"classificacao_fiscal": "",
"observacao": "",
"observacao2": "",
"observacao3": "",
"itens": [
{
"item": 1,
"produto_id": 7438,
"quantidade": "1.00",
"valor_unitario": "132.81",
"valor_subtotal": "132.81",
"percentual_desconto": "0.00",
"valor_desconto": "0.00",
"valor_total": "132.81"
},
{
"item": 2,
"produto_id": 6646,
"quantidade": "1.00",
"valor_unitario": "462.83",
"valor_subtotal": "462.83",
"percentual_desconto": "0.00",
"valor_desconto": "0.00",
"valor_total": "462.83"
},
{
"item": 3,
"produto_id": 6647,
"quantidade": "1.00",
"valor_unitario": "644.95",
"valor_subtotal": "644.95",
"percentual_desconto": "0.00",
"valor_desconto": "0.00",
"valor_total": "644.95"
},
{
"item": 4,
"produto_id": 6648,
"quantidade": "1.00",
"valor_unitario": "351.10",
"valor_subtotal": "351.10",
"percentual_desconto": "0.00",
"valor_desconto": "0.00",
"valor_total": "351.10"
},
{
"item": 5,
"produto_id": 6651,
"quantidade": "1.00",
"valor_unitario": "1043.78",
"valor_subtotal": "1043.78",
"percentual_desconto": "0.00",
"valor_desconto": "0.00",
"valor_total": "1043.78"
}
]
}
],
"total_count": 1
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Grades ¶
Grade ¶
Listar gradesGET/grade?id={id}offset={offset}&limit={limit}&ativo={ativo}&destacar_site={destacar_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
GET http://localhost:8081/sax/grade?id=1offset=2&limit=8&ativo=true&destacar_site=false&data_cadastro=2021-03-03&data_ultima_alteracao=2022-04-16-00:00:00
URI Parameters
- id
number(optional) Example: 1- offset
number(required) Example: 2- limit
number(required) Example: 8- ativo
boolean(optional) Example: true- destacar_site
boolean(optional) Example: false- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2022-04-16-00:00:00
Response
200Headers
Content-Type: application/jsonBody
{
"grades": [
{
"id": 172,
"descricao": "GUARDA",
"descricao_reduzida": "guarda",
"ativo": true,
"destacar_site": false,
"indexado": false,
"numero_original": 172,
"numero_fabricante": 7899800515257,
"outro_codigo": 4839,
"aplicacao": "GUARDA",
"descricao_ecommerce": "Guarda",
"informacao": "GUARDA",
"informacao_html": "<p>info</p>",
"custo_medio": 1141.09,
"ultimo_custo": 0,
"peso": 206,
"volumes": 0,
"ultimo_fornecedo_id": 26,
"grade_id": 77,
"origem": 0,
"garantia": 6,
"data_cadastro": "2021-03-03",
"data_ultima_alteracao": "2021-03-03 18:45:55",
"estoque_minimo": 0,
"lote_economico": 0,
"tipo": 8,
"categoria_id": 1,
"grupo_id": 52,
"subgrupo_id": 0,
"marca_id": 189,
"classificacao_fiscal": "9403.50.00",
"produto_sem_gtin": false,
"observacao": "obs teste",
"observacao2": "obs teste 2",
"observacao3": "obs teste 3",
"referencias": "[]",
"caracteristicas": "[]",
"ncm": "0000.00.00",
"ativo_dropship": true,
"situacao_dropship": "",
"percentual_ipi_dropship": 0,
"custo_dropship": 0
"variacoes":[
{
"numero_fabricante":"1",
"peso":"2",
"custo_dropship": 0,
"percentual_ipi_dropship" : 0,
"variacoes":[
{
"caracteristica_id":"1",
"valor_variacao":"Azul"
},
{
"caracteristica_id":"2",
"valor_variacao":"440V"
}
]
}
]
}
]
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Alterar produtosPUT/grade?id={id}offset={offset}&limit={limit}&ativo={ativo}&destacar_site={destacar_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
PUT http://localhost:8081/sax/grade?id=1offset=2&limit=8&ativo=true&destacar_site=false&data_cadastro=2021-03-03&data_ultima_alteracao=2022-04-16-00:00:00
URI Parameters
- id
number(optional) Example: 1- offset
number(required) Example: 2- limit
number(required) Example: 8- ativo
boolean(optional) Example: true- destacar_site
boolean(optional) Example: false- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2022-04-16-00:00:00
Request
Headers
Content-Type: application/jsonBody
{
"grades":[
{
"id": "1",
"descricao":"teste nome",
"descricao_reduzida":"teste curto",
"ativo":true,
"outro_codigo":"ref213",
"numero_fabricante":"123123123",
"descricao_ecommerce":"teste nome",
"informacao_html":"desc ",
"aplicacao": "teste",
"categoria_id":"2",
"grupo_id":"2",
"subgrupo_id":"23",
"marca_id":"54",
"classificacao_fiscal_id":"1",
"custo_medio":"123.00",
"ultimo_custo":"123.00",
"data_cadastro":"2022-07-20",
"data_recadastro":"2022-07-21",
"data_lancamento":"2022-07-20",
"ultimo_fornecedor_id":"211",
"indexado": false,
"destacar": false,
"peso":"1.00",
"grade_id": 0,
"estoque_minimo": 1,
"garantia": 3,
"tipo": 8,
"lote_economico": 10,
"observacao": "teste",
"observacao2": "teste 2",
"observacao3": "teste 3",
"origem": "0",
"produto_sem_gtin": "0",
"controla_lote_serie": false,
"genero_id" : 0,
"quantidade_volumes": 1,
"ncm": "0000.00.00",
"ativo_dropship:" true,
"situacao_dropship":"",
"percentual_ipi_dropship:" 5,
"custo_dropship:" 0.00,
"variacoes":[
{
"numero_fabricante":"1",
"peso":"2",
"custo_dropship": 0,
"percentual_ipi_dropship" : 0,
"variacoes":[
{
"caracteristica_id":"1",
"valor_variacao":"Azul"
},
{
"caracteristica_id":"2",
"valor_variacao":"440V"
}
]
}
]
"fotos":[
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg",
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg",
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg",
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg"
],
"embalagens":[
{
"caracteristica_id":2,
"valor":"2,00"
},
{
"caracteristica_id":3,
"valor":"3,00"
},
{
"caracteristica_id":4,
"valor":"4,00"
},
{
"caracteristica_id":5,
"valor":"1,00"
}
],
"volumes":[
{
"descricao":"VOL.1",
"altura":"2.00",
"largura":"1.00",
"profundidade":"3.00",
"peso":"4.00",
"empilhamento_maximo":"1"
},
{
"descricao":"VOL.2",
"altura":"2.00",
"largura":"3.00",
"profundidade":"4.00",
"peso":"5.00",
"empilhamento_maximo":"1"
}
]
}
]
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Criar gradesPOST/grade?id={id}offset={offset}&limit={limit}&ativo={ativo}&destacar_site={destacar_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
POST http://localhost:8081/sax/grade?id=1offset=2&limit=8&ativo=true&destacar_site=false&data_cadastro=2021-03-03&data_ultima_alteracao=2022-04-16-00:00:00
URI Parameters
- id
number(optional) Example: 1- offset
number(required) Example: 2- limit
number(required) Example: 8- ativo
boolean(optional) Example: true- destacar_site
boolean(optional) Example: false- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2022-04-16-00:00:00
Request
Headers
Content-Type: application/jsonBody
{
"grades":[
{
"descricao":"teste nome",
"descricao_reduzida":"teste curto",
"ativo":true,
"outro_codigo":"ref213",
"numero_fabricante":"123123123",
"descricao_ecommerce":"teste nome",
"informacao_html":"desc ",
"aplicacao": "teste",
"categoria_id":"2",
"grupo_id":"2",
"subgrupo_id":"23",
"marca_id":"54",
"classificacao_fiscal_id":"1",
"custo_medio":"123.00",
"ultimo_custo":"123.00",
"data_cadastro":"2022-07-20",
"data_recadastro":"2022-07-21",
"data_lancamento":"2022-07-20",
"ultimo_fornecedor_id":"211",
"indexado": false,
"destacar": false,
"peso":"1.00",
"grade_id": 0,
"estoque_minimo": 1,
"garantia": 3,
"tipo": 8,
"lote_economico": 10,
"observacao": "teste",
"observacao2": "teste 2",
"observacao3": "teste 3",
"origem": "0",
"produto_sem_gtin": "0",
"controla_lote_serie": false,
"genero_id" : 0,
"quantidade_volumes": 1,
"ncm": "0000.00.00",
"ativo_dropship:" true,
"situacao_dropship":"",
"percentual_ipi_dropship:" 5,
"custo_dropship:" 0.00,
"variacoes":[
{
"numero_fabricante":"1",
"peso":"2",
"custo_dropship": 0,
"percentual_ipi_dropship" : 0,
"variacoes":[
{
"caracteristica_id":"1",
"valor_variacao":"Azul"
},
{
"caracteristica_id":"2",
"valor_variacao":"440V"
}
]
}
]
"fotos":[
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg",
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg",
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg",
"https:\/\/a-static.mlcdn.com.br\/618x463\/camiseta-ssb-brand-masculina-lisa-premium-100-algodao\/theshirtbrazil\/14691728895\/20c5deb979bbf8f38ffe8424ce8c0bd3.jpg"
],
"embalagens":[
{
"caracteristica_id":2,
"valor":"2,00"
},
{
"caracteristica_id":3,
"valor":"3,00"
},
{
"caracteristica_id":4,
"valor":"4,00"
},
{
"caracteristica_id":5,
"valor":"1,00"
}
],
"volumes":[
{
"descricao":"VOL.1",
"altura":"2.00",
"largura":"1.00",
"profundidade":"3.00",
"peso":"4.00",
"empilhamento_maximo":"1"
},
{
"descricao":"VOL.2",
"altura":"2.00",
"largura":"3.00",
"profundidade":"4.00",
"peso":"5.00",
"empilhamento_maximo":"1"
}
]
}
]
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Categoria grade ¶
Listar categorias_gradeGET/categoria_grade?id={id}&descricao={descricao}&token&ativo={ativo}&no_site{no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao{data_ultima_alteracao}
Example URI
GET http://localhost:8081/sax/categoria_grade?id=1&descricao=Moveis&token&ativo=S&no_siteN&data_cadastro=2021-03-03&data_ultima_alteracao2021-03-03 18:45:55
URI Parameters
- id
number(optional) Example: 1- descricao
string(optional) Example: Moveis- ativo
string(optional) Example: S- no_site
string(optional) Example: N- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2021-03-03 18:45:55
Response
200Headers
Content-Type: application/jsonBody
[
null
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Criar categorias_gradePOST/categoria_grade?id={id}&descricao={descricao}&token&ativo={ativo}&no_site{no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao{data_ultima_alteracao}
Example URI
POST http://localhost:8081/sax/categoria_grade?id=1&descricao=Moveis&token&ativo=S&no_siteN&data_cadastro=2021-03-03&data_ultima_alteracao2021-03-03 18:45:55
URI Parameters
- id
number(optional) Example: 1- descricao
string(optional) Example: Moveis- ativo
string(optional) Example: S- no_site
string(optional) Example: N- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2021-03-03 18:45:55
Request
Headers
Content-Type: application/jsonBody
{
"descricao": "teste categoria 2",
"no_site": false,
"ativo": true
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Grupos grade ¶
Listar grupos_gradeGET/grupoGrade?id={id}&ativo={ativo}&no_site={no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
GET http://localhost:8081/sax/grupoGrade?id=1&ativo=S&no_site=N&data_cadastro=2019-01-30&data_ultima_alteracao=2021-10-29-14:59:56
URI Parameters
- id
number(optional) Example: 1- ativo
boolean(optional) Example: S- no_site
boolean(optional) Example: N- data_cadastro
string(optional) Example: 2019-01-30- data_ultima_alteracao
string(optional) Example: 2021-10-29-14:59:56
Response
200Headers
Content-Type: application/jsonBody
[
null
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Criar grupos_gradePOST/grupoGrade?id={id}&ativo={ativo}&no_site={no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
POST http://localhost:8081/sax/grupoGrade?id=1&ativo=S&no_site=N&data_cadastro=2019-01-30&data_ultima_alteracao=2021-10-29-14:59:56
URI Parameters
- id
number(optional) Example: 1- ativo
boolean(optional) Example: S- no_site
boolean(optional) Example: N- data_cadastro
string(optional) Example: 2019-01-30- data_ultima_alteracao
string(optional) Example: 2021-10-29-14:59:56
Request
Headers
Content-Type: application/jsonBody
{
"nome": "novo grupo teste X",
"nome_reduzido": "novo grupo reduzido",
"no_site": true,
"ativo": false
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Subgrupos grade ¶
Listar subgrupos_gradeGET/subgrupoGrade?id={id}&grupo_id={grupo_id}&codigo={codigo}&ativo={ativo}&no_site={no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
GET http://localhost:8081/sax/subgrupoGrade?id=4&grupo_id=85&codigo=1&ativo=S&no_site=N&data_cadastro=2021-10-29-15:33:11&data_ultima_alteracao=2021-10-29-15:33:11
URI Parameters
- id
number(optional) Example: 4- grupo_id
number(optional) Example: 85- codigo
number(optional) Example: 1- ativo
string(optional) Example: S- no_site
string(optional) Example: N- data_cadastro
string(optional) Example: 2021-10-29-15:33:11- data_ultima_alteracao
string(optional) Example: 2021-10-29-15:33:11
Response
200Headers
Content-Type: application/jsonBody
[
null
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Criar subgrupos_gradePOST/subgrupoGrade?id={id}&grupo_id={grupo_id}&codigo={codigo}&ativo={ativo}&no_site={no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
POST http://localhost:8081/sax/subgrupoGrade?id=4&grupo_id=85&codigo=1&ativo=S&no_site=N&data_cadastro=2021-10-29-15:33:11&data_ultima_alteracao=2021-10-29-15:33:11
URI Parameters
- id
number(optional) Example: 4- grupo_id
number(optional) Example: 85- codigo
number(optional) Example: 1- ativo
string(optional) Example: S- no_site
string(optional) Example: N- data_cadastro
string(optional) Example: 2021-10-29-15:33:11- data_ultima_alteracao
string(optional) Example: 2021-10-29-15:33:11
Request
Headers
Content-Type: application/jsonBody
{
"descricao": "nova subcategoria T",
"descricao_reduzida": "nova subreduzida T",
"grupo_id": 33,
"no_site": true,
"ativo": true
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Marcas Grade ¶
Listar marcas_gradeGET/marcaGrade?id={id}&ativo={ativo}&no_site={no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
GET http://localhost:8081/sax/marcaGrade?id=1&ativo=S&no_site=S&data_cadastro=2021-03-03&data_ultima_alteracao=2021-10-29-14:46:20
URI Parameters
- id
number(optional) Example: 1- ativo
string(optional) Example: S- no_site
string(optional) Example: S- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2021-10-29-14:46:20
Response
200Headers
Content-Type: application/jsonBody
[
null
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Criar marcas_gradePOST/marcaGrade?id={id}&ativo={ativo}&no_site={no_site}&data_cadastro={data_cadastro}&data_ultima_alteracao={data_ultima_alteracao}
Example URI
POST http://localhost:8081/sax/marcaGrade?id=1&ativo=S&no_site=S&data_cadastro=2021-03-03&data_ultima_alteracao=2021-10-29-14:46:20
URI Parameters
- id
number(optional) Example: 1- ativo
string(optional) Example: S- no_site
string(optional) Example: S- data_cadastro
string(optional) Example: 2021-03-03- data_ultima_alteracao
string(optional) Example: 2021-10-29-14:46:20
Request
Headers
Content-Type: application/jsonBody
{
"descricao": "nova marca xxx",
"no_site": true,
"ativo": false
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Referências Grade ¶
Listar referências_gradeGET/referenciaGrade?id={id}&data_cadastro={data_cadastro}&data_alteracao{data_alteracao}
Example URI
GET http://localhost:8081/sax/referenciaGrade?id=1&data_cadastro=2021-03-03 18:45:55&data_alteracao2021-03-03 18:45:55
URI Parameters
- id
number(optional) Example: 1- data_cadastro
string(optional) Example: 2021-03-03 18:45:55- data_alteracao
string(optional) Example: 2021-03-03 18:45:55
Response
200Headers
Content-Type: application/jsonBody
[
null
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Criar referências_gradePOST/referenciaGrade?id={id}&data_cadastro={data_cadastro}&data_alteracao{data_alteracao}
Example URI
POST http://localhost:8081/sax/referenciaGrade?id=1&data_cadastro=2021-03-03 18:45:55&data_alteracao2021-03-03 18:45:55
URI Parameters
- id
number(optional) Example: 1- data_cadastro
string(optional) Example: 2021-03-03 18:45:55- data_alteracao
string(optional) Example: 2021-03-03 18:45:55
Request
Headers
Content-Type: application/jsonBody
{
"descricao": "nova ref xxx"
}Response
201Headers
Content-Type: application/jsonBody
{
"id": 1
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number"
}
}
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Estoques Grade ¶
Listar Estoque de produtos gradeGET/estoqueProdutoGrade?produto_id={produto_id}&limit={limit}&offset={offset}&produto_id={produto_id}&destacar={destacar}&setor_estoque_id={setor_estoque_id}&marca_id={marca_id}&grupo_id={grupo_id}&subgrupo_id={subgrupo_id}
Example URI
GET http://localhost:8081/sax/estoqueProdutoGrade?produto_id=1&limit=12&offset=4&produto_id=1&destacar=boolean; Não Obrigatório&setor_estoque_id=11&marca_id=5&grupo_id=7&subgrupo_id=10
URI Parameters
- produto_id
number(required) Example: 1- limit
number(required) Example: 12- offset
number(required) Example: 4- destacar
string(required) Example: boolean; Não Obrigatório- setor_estoque_id
number(optional) Example: 11- marca_id
number(optional) Example: 5- grupo_id
number(optional) Example: 7- subgrupo_id
number(optional) Example: 10
Response
200Headers
Content-Type: application/jsonBody
[
null
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Preços grade ¶
Listar Preço de produto GradeGET/precoProdutoGrade?produto_id={produto_id}&limit={limit}&offset={offset}&destacar={destacar}&tabela_preco_id={tabela_preco_id}&marca_id={marca_id}&grupo_id={grupo_id}&subgrupo_id={subgrupo_id}
Example URI
GET http://localhost:8081/sax/precoProdutoGrade?produto_id=1&limit=1&offset=10&destacar=S&tabela_preco_id=1&marca_id=5&grupo_id=2&subgrupo_id=10
URI Parameters
- produto_id
number(required) Example: 1- limit
number(required) Example: 1- offset
number(required) Example: 10- destacar
string(optional) Example: S- tabela_preco_id
number(optional) Example: 1- marca_id
number(optional) Example: 5- grupo_id
number(optional) Example: 2- subgrupo_id
number(optional) Example: 10
Response
200Headers
Content-Type: application/jsonBody
[
null
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Fotos grade ¶
Listar foto de produtoGET/fotoGrade?produto_id={produto_id}
Example URI
GET http://localhost:8081/sax/fotoGrade?produto_id=12
URI Parameters
- produto_id
number(required) Example: 12
Response
200Headers
Content-Type: application/jsonBody
[
null
]Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}Etiqueta Pedido ¶
Etiqueta Pedidos ¶
Listar etiqueta pedidoGET/etiquetaPedido?pedido_id{pedido_id}
Example URI
GET http://localhost:8081/sax/etiquetaPedido?pedido_id123
URI Parameters
- pedido_id
integer(optional) Example: 123
Response
200Headers
Content-Type: application/jsonBody
{
"erro": false,
"pdf_base64": ""
}Response
404Headers
Content-Type: application/jsonBody
{
"error": true,
"message": "error"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "boolean"
},
"message": {
"type": "string"
}
}
}Usuario ¶
Usuarios ¶
Listar usuarioGET/usuario?id={id}ativo={ativo}&tipo={tipo}&data_cadastro={data_cadastro}&cpd_cnpj={cpf_cnpj}
Example URI
GET http://localhost:8081/sax/usuario?id=1ativo=true&tipo=F&data_cadastro=2021-03-03&cpd_cnpj=000.000.000-00
URI Parameters
- id
number(optional) Example: 1- ativo
boolean(optional) Example: true- tipo
string(optional) Example: F- data_cadastro
string(optional) Example: 2021-03-03- cpf_cnpj
string(optional) Example: 000.000.000-00
Response
200Headers
Content-Type: application/jsonBody
{
"usuarios": [
{
"id": 1,
"nome": "XKEYSTI",
"apelido": "XKEYSTI",
"tipo": "F",
"cpf": "15551588000149",
"rg": "1",
"telefone": "(44)03026-0038",
"celular": "( ) -",
"email": "",
"data_cadastro": "1899-12-30",
"supervisor": true,
"gestor_equipe": false,
"ativo": true
}
],
"total_count": 1
}Response
404Headers
Content-Type: application/jsonBody
{
"code": 404,
"message": "Hello, world!",
"description": "Hello, world!"
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "number",
"description": "Status code"
},
"message": {
"type": "string",
"description": "Mensagem do status"
},
"description": {
"type": "string",
"description": "Descrição do status"
}
}
}