Realizar Integração PDV utilizando ERP de terceiros via API – POST

Filtros


Atalhos para busca

Objetivo

A finalidade deste método é possibilitar a integração automática, por meio de API, de movimentações de entrada e saída de estoque geradas a partir de PDV (vendas, cancelamento e devoluções), para que ocorra atualização de estoque no SOMMA.

Chamada

POST api/v1/movimentacao/cupom-fiscal

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

MovimentacaoRequisicaoDto

Nome (Name) Descrição (Description) Tipo (Type) Informações Adicionais (Adittional Information)
cnpj CNPJ da Empresa string Tamanho do texto: estar entre 0 e 17
codigoDepositante Código do Depositante integer Intervalo: estar entre 0 e 999
entradaSaida Indica se a movimentação é: (E) entrada em estoque; (S) saída de estoque string Tamanho do texto: estar entre 0 e 1
historico Campo livre, com informações relevantes sobre a movimentação string Tamanho do texto: estar entre 0 e 40
numeroDocumentoFiscal Número do Documento Fiscal integer Intervalo: estar entre 0 e 9999999999
serieDocumentoFiscal Série do Documento Fiscal string Tamanho do texto: estar entre 0 e 3
numeroSerieECF Número de Série do Emissor de Cupom Fiscal (Impressora Fiscal) string Tamanho do texto: estar entre 0 e 40
areaArmazenagem (P) Normal; (V) Avaria; Demais valores que tenham sido cadastrados string Tamanho do texto: estar entre 0 e 5
itens Itens do Cupom Fiscal Coleção de MovimentacaoItemRequisicaoDto Nenhum.
erros Erros na validação do cabeçalho Coleção de string Nenhum.

Formatos da Requisição (Request Formats)

application/json, text/json

Exemplo (Sample):

{
  "cnpj": "sample string 1",
  "codigoDepositante": 1,
  "entradaSaida": "sample string 2",
  "historico": "sample string 3",
  "numeroDocumentoFiscal": 4,
  "serieDocumentoFiscal": "sample string 5",
  "numeroSerieECF": "sample string 6",
  "areaArmazenagem": "sample string 7",
  "itens": [
    {
      "codigoProduto": "sample string 1",
      "quantidade": 2,
      "erros": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "codigoProduto": "sample string 1",
      "quantidade": 2,
      "erros": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "erros": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Exemplo (Sample):

<MovimentacaoRequisicaoDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WMSIntegracaoAPI.Entidades.Dto.Entidades.v1.MovimentacaoDto">
  <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">8</_pageNo>
  <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">9</_pageSize>
  <areaArmazenagem>sample string 7</areaArmazenagem>
  <cnpj>sample string 1</cnpj>
  <codigoDepositante>1</codigoDepositante>
  <entradaSaida>sample string 2</entradaSaida>
  <erros xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </erros>
  <historico>sample string 3</historico>
  <itens>
    <MovimentacaoItemRequisicaoDto>
      <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">3</_pageNo>
      <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">4</_pageSize>
      <codigoProduto>sample string 1</codigoProduto>
      <erros xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </erros>
      <quantidade>2</quantidade>
    </MovimentacaoItemRequisicaoDto>
    <MovimentacaoItemRequisicaoDto>
      <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">3</_pageNo>
      <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">4</_pageSize>
      <codigoProduto>sample string 1</codigoProduto>
      <erros xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </erros>
      <quantidade>2</quantidade>
    </MovimentacaoItemRequisicaoDto>
  </itens>
  <numeroDocumentoFiscal>4</numeroDocumentoFiscal>
  <numeroSerieECF>sample string 6</numeroSerieECF>
  <serieDocumentoFiscal>sample string 5</serieDocumentoFiscal>
</MovimentacaoRequisicaoDto>

application/x-www-form-urlencoded

Exemplo (Sample):

Exemplo não disponível.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

DepositoResponseDto

Coleção de MovimentacaoRespostaDto

Nome (Name) Descrição (Description) Tipo (Type) Informações Adicionais (Adittional Information)
errosCabecalho Erros no cabeçalho do cupom fiscal Coleção de string Nenhum.
errosItens Erros nos itens do cupom fiscal Coleção de MovimentacaoItemRequisicaoDto Nenhum.

 

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "errosCabecalho": [
      "sample string 1",
      "sample string 2"
    ],
    "errosItens": [
      {
        "codigoProduto": "sample string 1",
        "quantidade": 2,
        "erros": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "codigoProduto": "sample string 1",
        "quantidade": 2,
        "erros": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ]
  },
  {
    "errosCabecalho": [
      "sample string 1",
      "sample string 2"
    ],
    "errosItens": [
      {
        "codigoProduto": "sample string 1",
        "quantidade": 2,
        "erros": [
          "sample string 1",
          "sample string 2"
        ]
      },
      {
        "codigoProduto": "sample string 1",
        "quantidade": 2,
        "erros": [
          "sample string 1",
          "sample string 2"
        ]
      }
    ]
  }
]

application/xml, text/xml

Exemplo (Sample):

<ArrayOfMovimentacaoRespostaDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WMSIntegracaoAPI.Entidades.Dto.Entidades.v1.MovimentacaoDto">
  <MovimentacaoRespostaDto>
    <ErrosCabecalho xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ErrosCabecalho>
    <ErrosItens>
      <MovimentacaoItemRequisicaoDto>
        <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">3</_pageNo>
        <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">4</_pageSize>
        <codigoProduto>sample string 1</codigoProduto>
        <erros xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </erros>
        <quantidade>2</quantidade>
      </MovimentacaoItemRequisicaoDto>
      <MovimentacaoItemRequisicaoDto>
        <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">3</_pageNo>
        <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">4</_pageSize>
        <codigoProduto>sample string 1</codigoProduto>
        <erros xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </erros>
        <quantidade>2</quantidade>
      </MovimentacaoItemRequisicaoDto>
    </ErrosItens>
  </MovimentacaoRespostaDto>
  <MovimentacaoRespostaDto>
    <ErrosCabecalho xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ErrosCabecalho>
    <ErrosItens>
      <MovimentacaoItemRequisicaoDto>
        <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">3</_pageNo>
        <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">4</_pageSize>
        <codigoProduto>sample string 1</codigoProduto>
        <erros xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </erros>
        <quantidade>2</quantidade>
      </MovimentacaoItemRequisicaoDto>
      <MovimentacaoItemRequisicaoDto>
        <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">3</_pageNo>
        <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">4</_pageSize>
        <codigoProduto>sample string 1</codigoProduto>
        <erros xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </erros>
        <quantidade>2</quantidade>
      </MovimentacaoItemRequisicaoDto>
    </ErrosItens>
  </MovimentacaoRespostaDto>
</ArrayOfMovimentacaoRespostaDto>
Este artigo foi útil para você?
Sim
Não
Confirmar que o artigo não foi útil