OpenAPITodas as operações em OpenAPI (Postman, Insomnia).
Produtos · PedidoVendaAnexos

Anexos do Pedido de Vendas

POSThttps://app.omie.com.br/api/v1/produtos/pedidovendaanexos/WSDL
3consultas
2alterações
Claude · MCPpelos assistentes de IA
JSON · XMLformato

pvaConsultarAnexo

consultaClaudeMCP

Consulta um anexo de um Pedido de Vendas.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 4Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntAnexotexto · até 20Código de integração do anexo, informado na inclusão. Usado na busca quando cNomeArq não é informado.
cCodIntPedtexto · até 60Código de integração do pedido de venda. Informe este ou nCodPed.
cNomeArqtexto · até 100Nome do arquivo anexado. Com cNomeArq preenchido a busca é pelo nome do arquivo e cCodIntAnexo é ignorado.
nCodPednúmero inteiroCódigo interno do pedido de venda. Informe este ou cCodIntPed.
Retorno 6O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodIntAnexotextoCódigo de integração do anexo.
cCodIntPedtextoCódigo de integração do Pedido de Venda.
cNomeArqtextoNome do arquivo anexado.
cTipoArqtextoTipo de Arquivo.
infoobjetoInformações complementares do anexo.
info.cImpAPItextoImportado pela API (S/N).
info.dAlttextoData da Alteração. No formato dd/mm/aaaa.
info.dInctextoData da Inclusão. No formato dd/mm/aaaa.
info.hAlttextoHora da Alteração. No formato hh:mm:ss.
info.hInctextoHora da Inclusão. No formato hh:mm:ss.
info.uAlttextoUsuário da Alteração.
info.uInctextoUsuário da Inclusão.
nCodPednúmero inteiroCódigo do Pedido de Venda.
POST /api/v1/produtos/pedidovendaanexos/
curl -s https://app.omie.com.br/api/v1/produtos/pedidovendaanexos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "pvaConsultarAnexo", "param": [{"nCodPed": 3478512690, "cCodIntAnexo": "ANX-000123"}]}'

pvaExcluirAnexo

altera dadosClaudeMCP

Exclui um anexo de um Pedido de Vendas.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 4Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntAnexotexto · até 20Código de integração do anexo, informado na inclusão. Usado na busca quando cNomeArq não é informado.
cCodIntPedtexto · até 60Código de integração do pedido de venda. Informe este ou nCodPed.
cNomeArqtexto · até 100Nome do arquivo anexado. Com cNomeArq preenchido a busca é pelo nome do arquivo e cCodIntAnexo é ignorado.
nCodPednúmero inteiroCódigo interno do pedido de venda. Informe este ou cCodIntPed.
Retorno 6O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodIntAnexotextoCódigo de integração do anexo.
cCodIntPedtextoCódigo de integração do Pedido de Venda.
cCodStatustextoCódigo do status do processamento. Se o retorno for "0" significa que a solicitação foi executada com sucesso. Se o retorno for maior que "0" ocorreu algum erro duranteo o processamento da solicitação. A tag "cDesStatus" descreve o problema ocorrido.
cDesStatustextoDescrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus".
cNomeArqtextoNome do arquivo anexado.
nCodPednúmero inteiroCódigo do Pedido de Venda.
POST /api/v1/produtos/pedidovendaanexos/
curl -s https://app.omie.com.br/api/v1/produtos/pedidovendaanexos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "pvaExcluirAnexo", "param": [{"nCodPed": 3478512690, "cCodIntAnexo": "ANX-000123"}]}'

pvaIncluirAnexo

altera dadosClaudeMCP

Inclui um anexo no Pedido de Vendas.

Obrigatórios 4

CampoTipoDescrição
cArquivotextoConteúdo do arquivo compactado em zip e convertido em base 64. Obrigatório.
cCodIntAnexotexto · até 20Código de integração do anexo no seu sistema, para achá-lo depois. Obrigatório; use um código único.
cMd5texto · até 32MD5 do texto enviado em cArquivo (o base 64 do zip), em hexadecimal minúsculo. Obrigatório.
cNomeArqtexto · até 100Nome do arquivo dentro do zip enviado em cArquivo, com extensão. Obrigatório. Não pode repetir o nome de outro anexo do pedido.
Opcionais 3Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntPedtexto · até 60Código de integração do pedido de venda. Informe este ou nCodPed.
cTipoArqtexto · até 10Tipo do anexo, que precisa estar cadastrado. "ZPL-LABEL" ou "PDF-LABEL" marcam o arquivo como etiqueta do pedido.
nCodPednúmero inteiroCódigo interno do pedido de venda. Informe este ou cCodIntPed.
Retorno 6O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodIntAnexotextoCódigo de integração do anexo.
cCodIntPedtextoCódigo de integração do Pedido de Venda.
cCodStatustextoCódigo do status do processamento. Se o retorno for "0" significa que a solicitação foi executada com sucesso. Se o retorno for maior que "0" ocorreu algum erro duranteo o processamento da solicitação. A tag "cDesStatus" descreve o problema ocorrido.
cDesStatustextoDescrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus".
cNomeArqtextoNome do arquivo anexado.
nCodPednúmero inteiroCódigo do Pedido de Venda.
POST /api/v1/produtos/pedidovendaanexos/
curl -s https://app.omie.com.br/api/v1/produtos/pedidovendaanexos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "pvaIncluirAnexo", "param": [{"nCodPed": 3478512690, "cCodIntAnexo": "ANX-000123", "cNomeArq": "etiqueta-pedido-1532.pdf", "cTipoArq": "PDF-LABEL", "cArquivo": "UEsDBBQAAAAIA...", "cMd5": "9e107d9d372bb6826bd81d3542a419d6"}]}'

pvaListarAnexos

consultaClaudeMCP

Lista os anexos de um Pedido de Vendas.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 11Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntPedtexto · até 60Código de integração do pedido de venda. Informe este ou nCodPed.
cOrdemDecrescentetexto · até 1"S" para ordem decrescente.
cOrdenarPortexto · até 100Ordem dos resultados. Só aceita ARQUIVO (nome do arquivo), que também é o padrão.
cTipoArqtexto · até 10Filtra pelo tipo de anexo cadastrado (ex.: PDF-LABEL).
dDtAltAtetexto · até 10Data de alteração final, no formato dd/mm/aaaa.
dDtAltDetexto · até 10Data de alteração inicial, no formato dd/mm/aaaa.
dDtIncAtetexto · até 10Data de inclusão final. No formato dd/mm/aaaa.
dDtIncDetexto · até 10Data de inclusão inicial. No formato dd/mm/aaaa.
nCodPednúmero inteiroCódigo interno do pedido de venda. Informe este ou cCodIntPed.
nPaginanúmero inteiroNúmero da página. Padrão 1.
nRegPorPaginanúmero inteiroNúmero de registros por página. Padrão 100, máximo 100 (valor maior volta a 100).
Retorno 5O que volta numa chamada bem-sucedida
CampoTipoDescrição
listaAnexoslista de objetosLista de anexos dos Pedidos de Vendas encontradas.
listaAnexos[].cCodIntAnexotextoCódigo de integração do anexo.
listaAnexos[].cCodIntPedtextoCódigo de integração do pedido de venda. Vem sempre vazio nesta listagem; use nCodPed.
listaAnexos[].cNomeArqtextoNome do arquivo anexado.
listaAnexos[].cTipoArqtextoTipo de Arquivo.
listaAnexos[].infoobjetoInformações complementares do anexo.
listaAnexos[].info.cImpAPItextoImportado pela API (S/N).
listaAnexos[].info.dAlttextoData da Alteração. No formato dd/mm/aaaa.
listaAnexos[].info.dInctextoData da Inclusão. No formato dd/mm/aaaa.
listaAnexos[].info.hAlttextoHora da Alteração. No formato hh:mm:ss.
listaAnexos[].info.hInctextoHora da Inclusão. No formato hh:mm:ss.
listaAnexos[].info.uAlttextoUsuário da Alteração.
listaAnexos[].info.uInctextoUsuário da Inclusão.
listaAnexos[].nCodPednúmero inteiroCódigo do Pedido de Venda.
nPaginanúmero inteiroNúmero da página resgatada.
nRegistrosnúmero inteiroNúmero de registros retornados na página.
nTotPaginasnúmero inteiroNúmero total de páginas encontradas.
nTotRegistrosnúmero inteiroNúmero total de registros encontrados.
POST /api/v1/produtos/pedidovendaanexos/
curl -s https://app.omie.com.br/api/v1/produtos/pedidovendaanexos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "pvaListarAnexos", "param": [{"nPagina": 1, "nRegPorPagina": 50, "nCodPed": 3478512690}]}'

pvaObterAnexo

consultaClaudeMCP

Obtém um anexo de um Pedido de Vendas.

Obrigatórios 0

Nenhum campo obrigatório.

Opcionais 4Campos e estruturas que você pode enviar
CampoTipoDescrição
cCodIntAnexotexto · até 20Código de integração do anexo, informado na inclusão. Usado na busca quando cNomeArq não é informado.
cCodIntPedtexto · até 60Código de integração do pedido de venda. Informe este ou nCodPed.
cNomeArqtexto · até 100Nome do arquivo anexado. Com cNomeArq preenchido a busca é pelo nome do arquivo e cCodIntAnexo é ignorado.
nCodPednúmero inteiroCódigo interno do pedido de venda. Informe este ou cCodIntPed.
Retorno 9O que volta numa chamada bem-sucedida
CampoTipoDescrição
cCodIntAnexotextoCódigo de integração do anexo.
cCodIntPedtextoCódigo de integração do Pedido de Venda.
cCodStatustextoCódigo do status do processamento. Se o retorno for "0" significa que a solicitação foi executada com sucesso. Se o retorno for maior que "0" ocorreu algum erro duranteo o processamento da solicitação. A tag "cDesStatus" descreve o problema ocorrido.
cDesStatustextoDescrição do status do processamento. Essa tag explica o resultado da tag "cCodigoStatus".
cLinkDownloadtextoURL para download do anexo solicitado.
cNomeArqtextoNome do arquivo anexado.
cTipoArqtextoTipo de Arquivo.
dDtExpiracaotextoData de expiração da url disponibilizada. No formato dd/mm/aaaa.
nCodPednúmero inteiroCódigo do Pedido de Venda.
POST /api/v1/produtos/pedidovendaanexos/
curl -s https://app.omie.com.br/api/v1/produtos/pedidovendaanexos/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "pvaObterAnexo", "param": [{"nCodPed": 3478512690, "cCodIntAnexo": "ANX-000123"}]}'