PDVx API Documentation (1.0.0)

Download OpenAPI specification:Download

Documentação para uso das API do sistema PDVx

Financeiro

Apis modulo financeiro

Baixar conta no financeiro

Authorizations:
None
query Parameters
fin_pagamento
required
datetime

Data do pagamento Regra: (Tem que ser após data de emissão)

fin_recebido
required
number

Valor Recebido

fin_multa
required
number

Valor Multa

fin_juros
required
number

Valor Juros

fin_desconto
required
number

Valor Desconto

fin_forma_pagto
required
string

Forma de pagamento

fk_bc_id
required
string

Foreing key encrypt do Banco / Caixa

fin_new_value
number

Novo valor em caso de pagamento parcial

new_vencimento
date

Novo vencimento em caso de pagamento parcial

Responses

Produto

Apis modulo produtos

Listar Produtos

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "collection": {
    }
}

Retornar próximo código de produto

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "codigo": "0046"
}

Detalhes do Produto

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": "296db8f7-ccdb-49b3-ac9e-630822e1872c",
  • "prod_codigo": "0044",
  • "prod_descricao": "VINCULO AUTOMATICO 2",
  • "prod_descricao_original": "VINCULO AUTOMATICO 2",
  • "invalido_fiscal": "0",
  • "prod_gtin": "SEM GTIN",
  • "prod_gtin_trib": "SEM GTIN",
  • "prod_gtin_relacionados": "array",
  • "prod_referencia": "",
  • "prod_referencia1": "",
  • "ck_tipo": "A",
  • "ck_tipo_item": "00",
  • "prod_balanca": "0",
  • "validade": "",
  • "prod_peso_bruto": "0",
  • "prod_est_min": "0",
  • "prod_est_max": "0",
  • "prod_peso_liq": "0",
  • "prod_fator_comp": "1",
  • "prod_fator_trib": "1",
  • "prod_msg_est": "L",
  • "prod_obs": "",
  • "prod_caracteristica": "",
  • "prod_tempo_preparacao": "",
  • "ecommerce_integration": "0",
  • "ecommerce_status": "0",
  • "prod_comissao": "0",
  • "is_composto": "0",
  • "is_totem": "0",
  • "is_cardapio": "",
  • "is_lote": "0",
  • "is_grade": "0",
  • "is_grade_owner": "0",
  • "fk_grade_owner": "",
  • "fk_grupo_id": "ca1cc623985b45aead242d09227959c4",
  • "fk_etapa_id": "",
  • "fk_marca_id": "",
  • "fk_modelo_id": "",
  • "fk_cor_id": "",
  • "fk_tamanho_id": "",
  • "fk_fornecedor_id": "1e730845c79f4740b447c3050d11bc9e",
  • "fk_un_venda": "4617a05e448847f59a81adc0206aeab5",
  • "fk_un_trib": "4617a05e448847f59a81adc0206aeab5",
  • "saldo": "-0.5",
  • "is_disabled": "0",
  • "nivel_estoque": "ABAIXO",
  • "saldo_ecommerce": "0",
  • "saldo_sintegra": "0.5",
  • "fk_emp_id": "b4e06e33822e4dd4b02d6f0b00dd9105",
  • "created_at": "2023-08-28 15:03:35",
  • "updated_at": "2023-12-14 16:31:05",
  • "deleted_at": "",
  • "pes_razao": "MBD INFORMATICA LTDA ME",
  • "fornecedor": {
    },
  • "produto_fiscal": {
    },
  • "produto_preco": {
    },
  • "produto_promocoes": {
    },
  • "produto_atacados": {
    },
  • "produto_fiscal_icms": ""
}

Atualizar Produto

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string
prod_codigo
string
prod_descricao
string
prod_descricao_original
string
invalido_fiscal
integer
prod_gtin
string
prod_gtin_trib
string
prod_gtin_relacionados
Array of strings
prod_referencia
NULL
prod_referencia1
NULL
ck_tipo
string
ck_tipo_item
string
prod_balanca
integer
validade
NULL
prod_peso_bruto
integer
prod_est_min
integer
prod_est_max
integer
prod_peso_liq
integer
prod_fator_comp
integer
prod_fator_trib
integer
prod_msg_est
string
prod_obs
NULL
prod_caracteristica
NULL
prod_tempo_preparacao
NULL
ecommerce_integration
integer
ecommerce_status
integer
prod_imagem
string
prod_comissao
integer
is_composto
integer
is_totem
integer
is_cardapio
NULL
is_lote
integer
is_grade
integer
is_grade_owner
integer
fk_grade_owner
NULL
fk_grupo_id
string
fk_etapa_id
NULL
fk_marca_id
NULL
fk_modelo_id
NULL
fk_cor_id
NULL
fk_tamanho_id
NULL
fk_fornecedor_id
string
fk_un_venda
string
fk_un_trib
string
saldo
integer
is_disabled
integer
nivel_estoque
string
saldo_ecommerce
integer
saldo_sintegra
integer
created_at
string
updated_at
string
deleted_at
NULL
pes_razao
string
object
object
object
object
object
produto_fiscal_icms
NULL
fk_empresa_id
string

Responses

Request samples

Content type
application/json
{
  • "id": "f28d6e8d-f7bf-404a-ba23-6b298381c784",
  • "prod_codigo": "0048",
  • "prod_descricao": "teste edicão",
  • "prod_descricao_original": "teste edicão",
  • "invalido_fiscal": "0",
  • "prod_gtin": "SEM GTIN",
  • "prod_gtin_trib": "SEM GTIN",
  • "prod_gtin_relacionados": "array",
  • "prod_referencia": "",
  • "prod_referencia1": "",
  • "ck_tipo": "A",
  • "ck_tipo_item": "00",
  • "prod_balanca": "0",
  • "validade": "",
  • "prod_peso_bruto": "0",
  • "prod_est_min": "0",
  • "prod_est_max": "0",
  • "prod_peso_liq": "0",
  • "prod_fator_comp": "1",
  • "prod_fator_trib": "1",
  • "prod_msg_est": "L",
  • "prod_obs": "",
  • "prod_caracteristica": "",
  • "prod_tempo_preparacao": "",
  • "ecommerce_integration": "0",
  • "ecommerce_status": "0",
  • "prod_comissao": "0",
  • "is_composto": "0",
  • "is_totem": "0",
  • "is_cardapio": "",
  • "is_lote": "0",
  • "is_grade": "0",
  • "is_grade_owner": "0",
  • "fk_grade_owner": "",
  • "fk_grupo_id": "ca1cc623985b45aead242d09227959c4",
  • "fk_etapa_id": "",
  • "fk_marca_id": "",
  • "fk_modelo_id": "",
  • "fk_cor_id": "",
  • "fk_tamanho_id": "",
  • "fk_fornecedor_id": "1e730845c79f4740b447c3050d11bc9e",
  • "fk_un_venda": "4617a05e448847f59a81adc0206aeab5",
  • "fk_un_trib": "4617a05e448847f59a81adc0206aeab5",
  • "saldo": "0",
  • "is_disabled": "0",
  • "nivel_estoque": "ABAIXO",
  • "saldo_ecommerce": "0",
  • "saldo_sintegra": "0",
  • "created_at": "2024-02-05 10:36:36",
  • "updated_at": "2024-02-05 10:36:36",
  • "deleted_at": "",
  • "pes_razao": "MBD INFORMATICA LTDA ME",
  • "fornecedor": {
    },
  • "produto_fiscal": {
    },
  • "produto_preco": {
    },
  • "produto_promocoes": {
    },
  • "produto_atacados": {
    },
  • "produto_fiscal_icms": "",
  • "fk_empresa_id": "b4e06e33822e4dd4b02d6f0b00dd9105"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Atualizado com sucesso"
}

Deletar um Produto

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Deletado com sucesso"
}

Cadastrar Produto

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string
prod_codigo
string
prod_descricao
string
prod_descricao_original
string
invalido_fiscal
string
prod_gtin
NULL
prod_gtin_trib
NULL
prod_referencia
NULL
prod_referencia1
NULL
ck_tipo
string
ck_tipo_item
string
prod_balanca
string
validade
NULL
prod_peso_bruto
string
prod_est_min
string
prod_est_max
string
prod_peso_liq
string
prod_fator_comp
string
prod_fator_trib
string
prod_msg_est
string
prod_obs
NULL
prod_caracteristica
NULL
prod_tempo_preparacao
NULL
ecommerce_integration
string
ecommerce_status
string
prod_imagem
NULL
prod_comissao
string
is_composto
string
is_totem
string
is_cardapio
NULL
is_lote
boolean
is_grade
boolean
is_grade_owner
string
fk_grade_owner
NULL
fk_grupo_id
string
fk_etapa_id
NULL
fk_marca_id
NULL
fk_modelo_id
NULL
fk_cor_id
NULL
fk_tamanho_id
NULL
fk_fornecedor_id
string
fk_un_venda
string
fk_un_trib
string
saldo
string
is_disabled
string
nivel_estoque
string
saldo_ecommerce
string
saldo_sintegra
string
created_at
string
updated_at
string
deleted_at
NULL
pes_razao
string
object
object
object
object
object
produto_fiscal_icms
NULL
has_image
string
fk_empresa_id
string

Responses

Request samples

Content type
application/json
{
  • "id": "296db8f7-ccdb-49b3-ac9e-630822e1872c",
  • "prod_codigo": "0049",
  • "prod_descricao": "coca cola lata 350ml",
  • "prod_descricao_original": "VINCULO AUTOMATICO 2",
  • "invalido_fiscal": "0",
  • "prod_gtin": "",
  • "prod_gtin_trib": "",
  • "prod_referencia": "",
  • "prod_referencia1": "",
  • "ck_tipo": "A",
  • "ck_tipo_item": "00",
  • "prod_balanca": "0",
  • "validade": "",
  • "prod_peso_bruto": "0",
  • "prod_est_min": "0",
  • "prod_est_max": "0",
  • "prod_peso_liq": "0",
  • "prod_fator_comp": "1",
  • "prod_fator_trib": "1",
  • "prod_msg_est": "L",
  • "prod_obs": "",
  • "prod_caracteristica": "",
  • "prod_tempo_preparacao": "",
  • "ecommerce_integration": "0",
  • "ecommerce_status": "0",
  • "prod_imagem": "",
  • "prod_comissao": "0",
  • "is_composto": "0",
  • "is_totem": "0",
  • "is_cardapio": "",
  • "is_lote": "",
  • "is_grade": "",
  • "is_grade_owner": "0",
  • "fk_grade_owner": "",
  • "fk_grupo_id": "ca1cc623985b45aead242d09227959c4",
  • "fk_etapa_id": "",
  • "fk_marca_id": "",
  • "fk_modelo_id": "",
  • "fk_cor_id": "",
  • "fk_tamanho_id": "",
  • "fk_fornecedor_id": "1e730845c79f4740b447c3050d11bc9e",
  • "fk_un_venda": "4617a05e448847f59a81adc0206aeab5",
  • "fk_un_trib": "4617a05e448847f59a81adc0206aeab5",
  • "saldo": "-0.5",
  • "is_disabled": "0",
  • "nivel_estoque": "ABAIXO",
  • "saldo_ecommerce": "0",
  • "saldo_sintegra": "0.5",
  • "created_at": "2023-08-28 15:03:35",
  • "updated_at": "2023-12-14 16:31:05",
  • "deleted_at": "",
  • "pes_razao": "MBD INFORMATICA LTDA ME",
  • "fornecedor": {
    },
  • "produto_fiscal": {
    },
  • "produto_preco": {
    },
  • "produto_promocoes": {
    },
  • "produto_atacados": {
    },
  • "produto_fiscal_icms": "",
  • "has_image": "false",
  • "fk_empresa_id": "b4e06e33822e4dd4b02d6f0b00dd9105"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Cadastrado com sucesso.",
  • "nextCode": "0050",
  • "id": "74600c11-c386-4218-a2e2-678b6004baaa"
}

Cadastrar Produto Simplificado

Endpoint para cadastrar um novo produto de forma simplificada.

Authorizations:
bearerAuth
Request Body schema: application/json
required
grupo_descricao
string
und_sigla
string
prod_codigo
string
prod_descricao
string
prod_descricao_original
string
prod_gtin
NULL
prod_referencia
NULL
prod_referencia1
NULL
prod_obs
NULL
prod_caracteristica
NULL
prod_tempo_preparacao
NULL
is_totem
string
is_cardapio
string
is_disabled
string
object
object
object
object

Responses

Request samples

Content type
application/json
{
  • "grupo_descricao": "Bebidas b4",
  • "und_sigla": "LT",
  • "prod_codigo": "00258",
  • "prod_descricao": "APRESUNTADO8",
  • "prod_descricao_original": "APRESUNTADO8",
  • "prod_gtin": "",
  • "prod_referencia": "",
  • "prod_referencia1": "",
  • "prod_obs": "",
  • "prod_caracteristica": "",
  • "prod_tempo_preparacao": "",
  • "is_totem": "0",
  • "is_cardapio": "0",
  • "is_disabled": "0",
  • "produto_fiscal": {
    },
  • "produto_preco": {
    },
  • "produto_promocoes": {
    },
  • "produto_atacados": {
    }
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Cadastrado com sucesso.",
  • "id": "627e66d4-af60-4fca-a25d-18b334ad4a37"
}

Listar produtos excluídos

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "collection": {
    }
}

Restaurar Produto

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Restaurado com sucesso"
}

Dados basicos de estoque

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "depositos": {
    },
  • "unidades": {
    },
  • "grupos_produto": {
    },
  • "agrupadores": {
    },
  • "impressoras": {
    },
  • "modelos": {
    },
  • "marcas": {
    },
  • "grades": {
    },
  • "tamanhos": {
    },
  • "cores": {
    },
  • "complementos": {},
  • "food_tamanhos": {
    },
  • "food_observacoes": {
    }
}

Fiscal

Apis modulos fiscais

PDV

Apis do relacionados ao PDV

Consultar dados para popular DB do PDV

Authorizations:
None
query Parameters
updated_at
date

Data de ultima atualizacao dos dados

Responses

Consultar dados para popular DB do PDV

Authorizations:
None
query Parameters
updated_at
date

Data de ultima atualizacao dos dados

Responses

Consultar Status do PDV no sistema

Authorizations:
None

Responses

Auth

E-mail recuperar senha

query Parameters
email
required
string

E-mail do usuário

Responses

Atualizar o token do usuário

query Parameters
refresh_token
required
string

Refresh token

Responses

Login do usuário em caso de multi empresa

query Parameters
email
required
string

E-mail do usuário

password
required
string

Senha do usuário

remember
required
boolean

Lembrar sessão ?

companyId
required
string

Id da Empresa

Responses

Logout do sistema

Responses

Resetar senha

query Parameters
email
required
string

E-mail do usuário

password
required
string

Senha do usuário

Responses

detailsCurrent

Responses

Response samples

Content type
application/json
{
  • "id": "c9db04c3702441d6a7f0ccd57d14dab5",
  • "email": "felipe.guimaraes@mbd.com.br",
  • "user_status": "1",
  • "is_validado": "1",
  • "user_last_access": "2024-01-31 16:29:47",
  • "user_language": "pt_BR",
  • "user_skin": "skin-blue",
  • "user_pin": "3815",
  • "pin_updated": " 06/08/2020 às 10:00:24",
  • "user_type": "",
  • "fk_finder_id": "",
  • "fk_emp_id": "fe3c0036c8ef4aa8865b14909c8efcba",
  • "fk_amb_id": "2",
  • "fk_pes_id": "d6157f5d9f20470083e1e1969f548b87",
  • "created_at": "2020-08-06T16:00:24.000000Z",
  • "updated_at": "2024-02-01T18:53:05.000000Z",
  • "array": "array"
}

CTe

Consultar Mdf-e

Authorizations:
None

Responses

Selecionar por ID

Responses

Atualizar Mdf-e

Responses

Recuperar Mdf-e

Responses

XML do documento

Responses

Dacte do documento em formato PDF

Responses

Deletar Mdf-e

Responses

Detalhes do cadastro

Responses

CaixaPDV

Abrir Caixa PDV

query Parameters
id
string

GUUID do caixa

caixa_abertura
datetime

Datetime de abertura

saldo_caixa
required
double

Saldo do caixa

mac_address
required
string

Mac do PDV

Responses

Fechar Caixa PDV

query Parameters
id
required
string

GUUID do caixa caixa Aberto

caixa_fechamento
datetime

Datetime de fechamento

mac_address
required
string

Mac do PDV

Responses

Transferencia Caixa PDV

query Parameters
id
required
string

GUUID do caixa

descricao
string

Descrição da operacao

data_transferencia
datetime

Datetime da transferencia

valor
required
double

Valor da operacao

operacao
required
boolean

Operacão 0 entrada - 1 saida

mac_address
required
string

Mac do PDV

Responses

Feriados

index

Responses

Response samples

Content type
application/json
{
  • "array": "array"
}

store

Request Body schema: application/json
required
fer_dia
integer
fer_mes
integer
fer_ano
NULL
fer_descricao
string

Responses

Request samples

Content type
application/json
{
  • "fer_dia": "7",
  • "fer_mes": "5",
  • "fer_ano": "",
  • "fer_descricao": "teste 7"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Cadastrado com sucesso."
}

update

Request Body schema: application/json
required
id
string
fer_descricao
string
fer_dia
integer
fer_mes
integer
fer_ano
NULL
deleted_at
NULL

Responses

Request samples

Content type
application/json
{
  • "id": "8d826fe8-449c-4a68-b96b-a68255e1363b",
  • "fer_descricao": "TESTE 7",
  • "fer_dia": "2",
  • "fer_mes": "5",
  • "fer_ano": "",
  • "deleted_at": ""
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Atualizado com sucesso"
}

getById

Responses

Response samples

Content type
application/json
{
  • "id": "8d826fe8-449c-4a68-b96b-a68255e1363b",
  • "fer_descricao": "TESTE 7",
  • "fer_dia": "7",
  • "fer_mes": "5",
  • "fer_ano": "",
  • "deleted_at": ""
}

destroy

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Deletado com sucesso"
}

recovery

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Restaurado com sucesso"
}

Grupo Produto

Listar Grupos de Produto

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

update

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string
grupo_descricao
string
is_grade
integer
is_pizza
integer
fk_agp_id
NULL
fk_imp_id
NULL
deleted_at
NULL
tamanho_pivot
Array of strings
observacao_pivot
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "2b2481a8-5725-4fde-9d33-76aaaf980802",
  • "grupo_descricao": "NOVO GRUPO 2",
  • "is_grade": "0",
  • "is_pizza": "0",
  • "fk_agp_id": "",
  • "fk_imp_id": "",
  • "deleted_at": "",
  • "tamanho_pivot": "array",
  • "observacao_pivot": "array"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Atualizado com sucesso"
}

destroy

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Deletado com sucesso"
}

store

Authorizations:
bearerAuth
Request Body schema: application/json
required
grupo_descricao
string
fk_imp_id
NULL
fk_agp_id
NULL
is_grade
boolean
is_pizza
boolean
tamanho_pivot
Array of strings
observacao_pivot
Array of strings

Responses

Request samples

Content type
application/json
{
  • "grupo_descricao": "novo grupo",
  • "fk_imp_id": "",
  • "fk_agp_id": "",
  • "is_grade": "",
  • "is_pizza": "",
  • "tamanho_pivot": "array",
  • "observacao_pivot": "array"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Cadastrado com sucesso.",
  • "id": "2b2481a8-5725-4fde-9d33-76aaaf980802"
}

deleted

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "collection": {
    }
}

recovery

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Restaurado com sucesso"
}

Cupom Fiscal

Consultar Mdf-e

Authorizations:
None

Responses

Selecionar por ID

Responses

Atualizar Mdf-e

Responses

Recuperar Mdf-e

Responses

XML do documento

Responses

Damdfe do documento em formato PDF

Responses

Deletar Mdf-e

Responses

Detalhes do cadastro

Responses

Consultar Nfc-e

Authorizations:
None

Responses

Cadastrar uma NFCE/NFC/Orcamento

Responses

Selecionar por ID

Responses

Atualizar Nfc-e

Responses

Recuperar Nfc-e

Responses

Transmitir Nfc-e

Responses

XML do documento

Responses

XML do documento em formato JSON

Responses

Danfce do documento em formato PDF

Responses

Deletar Nfc-e

Responses

Detalhes do cadastro

Responses

Automated

getEstados

Responses

Response samples

Content type
application/json
{
  • "array": "array"
}

descricao api

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Em operação."
}

descricao api

Responses

Response samples

Content type
application/json
null

Nota Fiscal

Consultar Notas Importadas

Responses

Cadastrar uma NFE/NFC/Orcamento

Responses

Recuperar NF-e

Responses

Atualizar NF-e

Responses

XML do documento

Responses

XML do documento em formato JSON

Responses

Danfe do documento em formato PDF

Responses

Deletar NF-e

Responses

Detalhes do cadastro

Responses

Pedido/Orçamento

Consultar NF-e

Authorizations:
None

Responses

Cadastrar uma PEDIDO/NFC/Orcamento

Responses

Selecionar por ID

Responses

Atualizar NF-e

Responses

Recuperar Pedido

Responses

Orcamento em formato PDF

Responses

Detalhes do cadastro

Responses

Adicionar item ao orçamento

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
required

Adicionar itens ao orçamento

itens
Array of strings

Array de itens

mac_address
string

Endereço MAC do PDV

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Item adicionado com sucesso!"
}

Cancelar item do orçamento

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
required

cancelar item

item_id
string

ID do item a ser cancelado

mac_address
string

Endereço MAC do PDV

fk_user_cancel
string

ID do operador de cancelamento

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Item cancelado com sucesso!"
}

ProdutoPizza

edit

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": "b45c9722-85c5-45a1-ae1c-e8dfdc1e1db7",
  • "prod_codigo": "0094",
  • "prod_descricao": "TESTE PIZZA",
  • "prod_descricao_original": "",
  • "invalido_fiscal": "0",
  • "prod_gtin": "SEM GTIN",
  • "prod_gtin_trib": "SEM GTIN",
  • "prod_gtin_relacionados": "array",
  • "prod_referencia": "",
  • "prod_referencia1": "",
  • "ck_tipo": "P",
  • "ck_tipo_item": "00",
  • "prod_balanca": "0",
  • "validade": "",
  • "prod_peso_bruto": "0",
  • "prod_est_min": "0",
  • "prod_est_max": "0",
  • "prod_peso_liq": "0",
  • "prod_fator_comp": "1",
  • "prod_fator_trib": "1",
  • "prod_msg_est": "B",
  • "prod_obs": "",
  • "prod_caracteristica": "",
  • "prod_tempo_preparacao": "",
  • "ecommerce_integration": "0",
  • "ecommerce_status": "0",
  • "prod_comissao": "0",
  • "is_composto": "1",
  • "is_totem": "0",
  • "is_cardapio": "",
  • "is_lote": "0",
  • "is_grade": "0",
  • "is_grade_owner": "0",
  • "fk_grade_owner": "",
  • "fk_grupo_id": "a64786e2a2bb4584a6392b7882068b15",
  • "fk_etapa_id": "",
  • "fk_marca_id": "",
  • "fk_modelo_id": "",
  • "fk_cor_id": "",
  • "fk_tamanho_id": "",
  • "fk_fornecedor_id": "8ecf5afe79424b7397c26831ce13f65d",
  • "fk_un_venda": "4617a05e448847f59a81adc0206aeab5",
  • "fk_un_trib": "4617a05e448847f59a81adc0206aeab5",
  • "saldo": "0",
  • "is_disabled": "0",
  • "nivel_estoque": "ABAIXO",
  • "saldo_ecommerce": "0",
  • "saldo_sintegra": "0",
  • "fk_emp_id": "fe3c0036c8ef4aa8865b14909c8efcba",
  • "created_at": "2023-09-14 11:22:55",
  • "updated_at": "2024-01-31 16:22:56",
  • "deleted_at": "",
  • "tamanhos_pivot": "array",
  • "grupos_pivot": "array",
  • "pes_razao": "MUSSARELA D'ABADIA LTDA",
  • "fornecedor": {
    },
  • "produto_fiscal": {
    },
  • "produto_preco": {
    },
  • "produto_promocoes": "array",
  • "produto_atacados": "array",
  • "produto_fiscal_icms": "",
  • "produto_listas": {
    },
  • "produto_tamanhos": {
    },
  • "combos": "array"
}

update

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string
prod_codigo
string
prod_descricao
string
prod_descricao_original
string
invalido_fiscal
integer
prod_gtin
string
prod_gtin_trib
string
prod_gtin_relacionados
Array of strings
prod_referencia
NULL
prod_referencia1
NULL
ck_tipo
string
ck_tipo_item
string
prod_balanca
integer
validade
NULL
prod_peso_bruto
integer
prod_est_min
integer
prod_est_max
integer
prod_peso_liq
integer
prod_fator_comp
integer
prod_fator_trib
integer
prod_msg_est
string
prod_obs
NULL
prod_caracteristica
NULL
prod_tempo_preparacao
NULL
ecommerce_integration
integer
ecommerce_status
integer
prod_imagem
string
prod_comissao
integer
is_composto
integer
is_totem
integer
is_cardapio
NULL
is_lote
integer
is_grade
integer
is_grade_owner
integer
fk_grade_owner
NULL
fk_grupo_id
string
fk_etapa_id
NULL
fk_marca_id
NULL
fk_modelo_id
NULL
fk_cor_id
NULL
fk_tamanho_id
NULL
fk_fornecedor_id
string
fk_un_venda
string
fk_un_trib
string
saldo
integer
is_disabled
integer
nivel_estoque
string
saldo_ecommerce
integer
saldo_sintegra
integer
created_at
string
updated_at
string
deleted_at
NULL
object
grupos_pivot
Array of strings
pes_razao
string
object
object
object
produto_promocoes
Array of strings
produto_atacados
Array of strings
produto_fiscal_icms
NULL
object
object
combos
Array of strings
fk_empresa_id
string

Responses

Request samples

Content type
application/json
{
  • "id": "b45c9722-85c5-45a1-ae1c-e8dfdc1e1db7",
  • "prod_codigo": "0094",
  • "prod_descricao": "TESTE PIZZA edicao",
  • "prod_descricao_original": "TESTE PIZZA edicao",
  • "invalido_fiscal": "0",
  • "prod_gtin": "SEM GTIN",
  • "prod_gtin_trib": "SEM GTIN",
  • "prod_gtin_relacionados": "array",
  • "prod_referencia": "",
  • "prod_referencia1": "",
  • "ck_tipo": "P",
  • "ck_tipo_item": "00",
  • "prod_balanca": "0",
  • "validade": "",
  • "prod_peso_bruto": "0",
  • "prod_est_min": "0",
  • "prod_est_max": "0",
  • "prod_peso_liq": "0",
  • "prod_fator_comp": "1",
  • "prod_fator_trib": "1",
  • "prod_msg_est": "B",
  • "prod_obs": "",
  • "prod_caracteristica": "",
  • "prod_tempo_preparacao": "",
  • "ecommerce_integration": "0",
  • "ecommerce_status": "0",
  • "prod_comissao": "0",
  • "is_composto": "1",
  • "is_totem": "0",
  • "is_cardapio": "",
  • "is_lote": "0",
  • "is_grade": "0",
  • "is_grade_owner": "0",
  • "fk_grade_owner": "",
  • "fk_grupo_id": "a64786e2a2bb4584a6392b7882068b15",
  • "fk_etapa_id": "",
  • "fk_marca_id": "",
  • "fk_modelo_id": "",
  • "fk_cor_id": "",
  • "fk_tamanho_id": "",
  • "fk_fornecedor_id": "8ecf5afe79424b7397c26831ce13f65d",
  • "fk_un_venda": "4617a05e448847f59a81adc0206aeab5",
  • "fk_un_trib": "4617a05e448847f59a81adc0206aeab5",
  • "saldo": "0",
  • "is_disabled": "0",
  • "nivel_estoque": "ABAIXO",
  • "saldo_ecommerce": "0",
  • "saldo_sintegra": "0",
  • "created_at": "2023-09-14 11:22:55",
  • "updated_at": "2024-01-31 16:22:56",
  • "deleted_at": "",
  • "tamanhos_pivot": {
    },
  • "grupos_pivot": "array",
  • "pes_razao": "MUSSARELA D'ABADIA LTDA",
  • "fornecedor": {
    },
  • "produto_fiscal": {
    },
  • "produto_preco": {
    },
  • "produto_promocoes": "array",
  • "produto_atacados": "array",
  • "produto_fiscal_icms": "",
  • "produto_listas": {
    },
  • "produto_tamanhos": {
    },
  • "combos": "array",
  • "fk_empresa_id": "fe3c0036c8ef4aa8865b14909c8efcba"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Atualizado com sucesso"
}

store

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string
prod_codigo
string
prod_descricao
string
prod_descricao_original
string
invalido_fiscal
string
prod_gtin
NULL
prod_gtin_trib
NULL
prod_referencia
NULL
prod_referencia1
NULL
ck_tipo
string
ck_tipo_item
string
prod_balanca
string
validade
NULL
prod_peso_bruto
string
prod_est_min
string
prod_est_max
string
prod_peso_liq
string
prod_fator_comp
string
prod_fator_trib
string
prod_msg_est
string
prod_obs
NULL
prod_caracteristica
NULL
prod_tempo_preparacao
NULL
ecommerce_integration
string
ecommerce_status
string
prod_imagem
NULL
prod_comissao
string
is_composto
string
is_totem
string
is_cardapio
NULL
is_lote
boolean
is_grade
boolean
is_grade_owner
string
fk_grade_owner
NULL
fk_grupo_id
string
fk_etapa_id
NULL
fk_marca_id
NULL
fk_modelo_id
NULL
fk_cor_id
NULL
fk_tamanho_id
NULL
fk_fornecedor_id
string
fk_un_venda
string
fk_un_trib
string
saldo
string
is_disabled
string
nivel_estoque
string
saldo_ecommerce
string
saldo_sintegra
string
created_at
string
updated_at
string
deleted_at
NULL
object
pes_razao
string
object
object
object
produto_fiscal_icms
NULL
object
has_image
string
fk_empresa_id
string

Responses

Request samples

Content type
application/json
{
  • "id": "b45c9722-85c5-45a1-ae1c-e8dfdc1e1db7",
  • "prod_codigo": "0149",
  • "prod_descricao": "teste cadastro produto pizza",
  • "prod_descricao_original": "TESTE PIZZA EDICAO",
  • "invalido_fiscal": "0",
  • "prod_gtin": "",
  • "prod_gtin_trib": "",
  • "prod_referencia": "",
  • "prod_referencia1": "",
  • "ck_tipo": "P",
  • "ck_tipo_item": "00",
  • "prod_balanca": "0",
  • "validade": "",
  • "prod_peso_bruto": "0",
  • "prod_est_min": "0",
  • "prod_est_max": "0",
  • "prod_peso_liq": "0",
  • "prod_fator_comp": "1",
  • "prod_fator_trib": "1",
  • "prod_msg_est": "B",
  • "prod_obs": "",
  • "prod_caracteristica": "",
  • "prod_tempo_preparacao": "",
  • "ecommerce_integration": "0",
  • "ecommerce_status": "0",
  • "prod_imagem": "",
  • "prod_comissao": "0",
  • "is_composto": "1",
  • "is_totem": "0",
  • "is_cardapio": "",
  • "is_lote": "",
  • "is_grade": "",
  • "is_grade_owner": "0",
  • "fk_grade_owner": "",
  • "fk_grupo_id": "a64786e2a2bb4584a6392b7882068b15",
  • "fk_etapa_id": "",
  • "fk_marca_id": "",
  • "fk_modelo_id": "",
  • "fk_cor_id": "",
  • "fk_tamanho_id": "",
  • "fk_fornecedor_id": "8ecf5afe79424b7397c26831ce13f65d",
  • "fk_un_venda": "4617a05e448847f59a81adc0206aeab5",
  • "fk_un_trib": "4617a05e448847f59a81adc0206aeab5",
  • "saldo": "0",
  • "is_disabled": "0",
  • "nivel_estoque": "ABAIXO",
  • "saldo_ecommerce": "0",
  • "saldo_sintegra": "0",
  • "created_at": "2023-09-14 11:22:55",
  • "updated_at": "2024-02-05 16:27:17",
  • "deleted_at": "",
  • "tamanhos_pivot": {
    },
  • "pes_razao": "MUSSARELA D'ABADIA LTDA",
  • "fornecedor": {
    },
  • "produto_fiscal": {
    },
  • "produto_preco": {
    },
  • "produto_fiscal_icms": "",
  • "produto_tamanhos": {
    },
  • "has_image": "false",
  • "fk_empresa_id": "fe3c0036c8ef4aa8865b14909c8efcba"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Cadastrado com sucesso.",
  • "nextCode": "0150",
  • "id": "9c44a8bd-bd52-40be-97ac-c9a2916502b6"
}

Veiculo

index

Responses

Response samples

Content type
application/json
{
  • "array": "array"
}

store

Request Body schema: application/json
required
vec_placa
string
vec_terceiro
boolean
vec_tipo_carroceria
NULL
vec_tipo_proprietario
NULL
vec_uf
string
vec_uf_proprietario
NULL
vec_tipo_rodado
string
vec_renavam
string
vec_tara
string
vec_descricao
string
vec_capacidade
string
vec_capacidade_m3
string
vec_rntrc
NULL
vec_documento_proprietario
NULL
vec_proprietario
NULL
vec_ie_proprietario
NULL

Responses

Request samples

Content type
application/json
{
  • "vec_placa": "cye3314",
  • "vec_terceiro": "",
  • "vec_tipo_carroceria": "",
  • "vec_tipo_proprietario": "",
  • "vec_uf": "MA",
  • "vec_uf_proprietario": "",
  • "vec_tipo_rodado": "01",
  • "vec_renavam": "3232",
  • "vec_tara": "2",
  • "vec_descricao": "teste",
  • "vec_capacidade": "32",
  • "vec_capacidade_m3": "22",
  • "vec_rntrc": "",
  • "vec_documento_proprietario": "",
  • "vec_proprietario": "",
  • "vec_ie_proprietario": ""
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "message": "Cadastrado com sucesso."
}