Home TOTVS Varejo Supermercados

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Rodrigo Balaban Zbytkowski

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Rodrigo Balaban Zbytkowski

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Objetivo

Método que permite consultar o estoque atual de produtos do WMS Centro de Distribuição, quando a Empresa não utiliza o ERP TOTVS Varejo Supermercados - Linha Consinco.

Chamada

GET api/v1/exportacao/estoque

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
page

Número da página.

integer

Padrão = 1.

pagesizeNúmero de registros a serem retornados por página.integerPadrão = 10. Limite = 100.
fieldsNome dos campos a serem retornados. Podem ser enviados mais de um separando-os por ",". stringPadrão = retorna todos os campos.
orderNome do campo para ordenação da lista. Podem ser enviados mais de um separando-os por ",". Quando utilizado junto ao parâmetro fields, deve-se informar um dos campos listados. stringPadrão = SEQPRODUTO na ordem crescente. Para alterar para ordem decrescente, utilizar o caractere "-" na frente do campo (exemplo: -seqproduto).
nroempresaFiltro para busca de estoque de determinada empresa.integerPadrão = retorna de todas as empresas. Tamanho Máximo: 6.
seqprodutoFiltro para busca de estoque de determinado produto.longPadrão = retorna de todos os produtos.
coddepositoFiltro para busca de estoque de determinado depósito.stringPadrão = retorna de todos os depósitos.

Parâmetros do Corpo (Body Parameters)

Não há.

Formatos de Request (Request Formats)

Exemplo de requisição:

Bloco de código
languageactionscript3
GET /api/v1/exportacao/estoque?page=1&pagesize=10&order=seqproduto&nroempresa=100&coddeposito=02&seqproduto=150

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • Ok (200)
  • Unauthorized (401)

Formatos de Resposta (Response Formats)

application/json, text/json

Corpo da Resposta (Response Body):

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
hasNext

Indica a existência de uma próxima página.

boolean

true: indica que existe uma próxima página;
false: indica que é a última página.

items

Lista de cancelamentos de cargas de recebimento.

ArrayDetalhamento de cada item (Estoque de Produto) da lista, conforme tabela abaixo.

Estoque de Produto:

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
NROEMPRESANúmero da empresa logística no WMS Centro de Distribuição.integer
CODDEPOSITANTENúmero da empresa ou código do depositante (quando se utiliza Operador Logístico).integer
SEQPRODUTO

Código sequencial do produto.

long
QTDATUALQuantidade atual do estoque do produto. Somente será enviado o valor na quantidade unitária, por exemplo, para 50 CX12, será enviado 600.decimal
PADRAOEMBVENDA

Quantidade de unidades dentro de cada embalagem padrão de venda.

Esta informação somente será enviada caso o parâmetro dinâmico EXP_EMBVENDA estiver com o valor igual a "S".

decimal
CODSTATUSENDERECO

Código do status do endereço.
D = Disponível
O = Ocupado
B = Bloqueado
R = Reservado
I  = Inativo
E = Restrito
Q = Quarentena

Esta informação somente será enviada caso o parâmetro dinâmico EXP_STATUSENDERECO_ESTQ estiver com o valor igual a "S".

string
DESCSTATUSENDERECODescrição completa (vide campo acima) do status do endereço. Esta informação somente será enviada caso o parâmetro dinâmico EXP_STATUSENDERECO_ESTQ estiver com o valor igual a "S".string
DTAVALIDADEData de validade do produto. Esta informação somente será enviada caso o parâmetro dinâmico EXP_DATAVALIDADE_ESTQ estiver com o valor igual a "S".datetime
DTAFABRICACAOData de fabricação do produto. Esta informação somente será enviada caso o parâmetro dinâmico EXP_DATAFABRICACAO_ESTQ estiver com o valor igual a "S".datetime
NROLOTELote de fabricação do produto. Esta informação somente será enviada caso o parâmetro dinâmico EXP_LOTEFABRICACAO_ESTQ estiver com o valor igual a "S".string
AREAARMAZENAGEMÁrea de armazenagem que pertence o estoque do produto. Esta informação somente será enviada caso o parâmetro dinâmico EXP_TIPESPECIE_ESTQ estiver com o valor igual a "S".string
CODDEPOSITOCódigo do depósito do produto. string

Exemplo de Resposta:

Bloco de código
languageactionscript3
{
    "hasNext": false,
    "items": [
        {
            "NROEMPRESA": 100,
            "CODDEPOSITANTE": 100,
            "SEQPRODUTO": 150,
            "QTDATUAL": 120.0,
            "PADRAOEMBVENDA": 1.0,
            "CODSTATUSENDERECO": "O",
            "DESCSTATUSENDERECO": "OCUPADO",
            "DTAVALIDADE": "2022-09-09T00:00:00",
            "DTAFABRICACAO": "2021-12-27T00:00:00",
            "NROLOTE": "7989",
            "AREAARMAZENAGEM": "P",
            "CODDEPOSITO": "02"
        }
	]
}