Árvore de páginas

Versões comparadas

Chave

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

Objetivo

Método que permite consultar os produtos cadastrados no WMS Centro de Distribuição. 

Chamada

GET api/v1/importacao/produto

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

Valor inicial: 1. Valor padrão: 1

pagesize

Número de itens a serem retornados por página.

integerValor limite: 100. Valor padrão: 10.
fields

Nome dos campos a serem retornados. Podem ser enviados múltiplos campos, separando-os por vírgula.

stringQuando não enviado, retorna todos.
order

Nome dos campos utilizados para ordenação da lista. Podem ser enviados múltiplos campos, separando-os por vírgula.
Quando utilizado junto ao parâmetro fields, terá efeito apenas nos campos nele informados. 
Para ordenação decrescente, utilizar o caractere hífen (-) antes do campo. Exemplo: -seqproduto.

string

Quando não enviado, utiliza ordenação padrão da base de dados.

desccompleta

Filtro para busca de produtos através da descrição completa.

stringQuando não enviado, retorna todos.
nroempresaFiltro para busca de produtos de determinada empresa.intQuando não enviado, retorna todos.

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/produto?page=1&pagesize=100&fields=seqproduto,nroempresa,desccompleta&order=seqproduto&desccompleta=caixa&nroempresa=100 

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

...

languageactionscript3

...

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 produtos.

ArrayDetalhamento de cada item (Produto) da lista na tabela abaixo.

Item Produto:

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

Código sequencial do produto.

integer


NROEMPRESA

Número da empresa ou código do depositante (quando utilizado Operador Logístico).

integerValor Máximo: 999
DESCCOMPLETADescrição completa do produto.stringTamanho Máximo: 70
DESCREDUZIDADescrição reduzida do produto.stringTamanho Máximo: 20
CODTIPENDERECO

Código do tipo do endereço(normal, alto, baixo, etc.) previamente cadastrado no ACRUX LOCUS PARÂMETRO / Tipos de Endereços.

Caso esse campo não seja enviado, será considerado o valor padrão "N".

stringTamanho Máximo: 3
STATUSCOMPRAStatus de compra do produto:
A – Ativo
I  – Inativo.
stringTamanho Máximo: 1
STATUSVENDAStatus de venda do produto:
A – Ativo
I  – Inativo.
stringTamanho Máximo: 1
TIPARMAZENAGEM

Tipo de armazenagem do produto, previamente cadastrado no ACRUX LOCUS PARÂMETRO /  Atributo Fixo.

Caso esse campo não seja enviado, será considerado o valor padrão "N".

stringTamanho Máximo: 5
TIPSEPARACAO

Tipo de separação do produto, previamente cadastrado no ACRUX LOCUS PARÂMETRO /  Atributo Fixo.

Caso esse campo não seja enviado, será considerado o valor padrão "N".

stringTamanho Máximo: 1
PZOVALIDADEDIA

Prazo de validade do produto a partir da data da fabricação(em dias).

Caso não utilize este conceito enviar "0".

integerValor Máximo: 9999
PESAVELIndica se o produto é pesável:
S  – Sim
N – Não.
stringTamanho Máximo: 1
EMTETIQUETAIndicador de emissão de etiquetas de códigos de barra:
S  – Sim
N – Não.

Quando "S", emite as etiquetas que vão substituir códigos dos produtos que não possuem código de barras.

Caso esse campo não seja enviado, será considerado o valor padrão "S".

stringTamanho Máximo: 1
INDPROCFABRICACAO

Indica se é um produto de composição:
S – Sem processo de produção
B – Produto base para desmembramento
F – Produto final composto
V – Produto de composição variável
I  – Insumo para produção
C – Composto para separação.

Caso esse campo não seja enviado, será considerado o valor padrão "S".

stringTamanho Máximo: 1
MEDVDIAGERALMédia de venda geral por dia. Valor da média de venda geral do produto.

decimal (12,6)

Valor Máximo: 999999,999999
EXGNROLOTE

Indica se o produto exige que seja informado lote de fabricação:
S  – Sim
N – Não.

stringTamanho Máximo: 1
SEQPRODUTOBASECódigo sequencial do produto base.integer
ADVARMAZENAGEMAdvertência de Armazenagem. Mensagem que será mostrada no momento da armazenagem do produto.stringTamanho Máximo: 80
REFFABRICANTEDescrição da referência do produto enviada pelo fabricante.stringTamanho Máximo: 20
EXGNROSERIEIndica se o produto exige que seja informado o número da série na conferência:
S  – Sim
N – Não.
stringTamanho Máximo: 1
QTDTOLARMAZPRODQuantidade para tolerância na armazenagem.integerValor Máximo: 999999999
UTZESTRUTDRIVEINIndica se o produto utiliza estrutura Drive-In:
S  – Sim
N – Não.
stringTamanho Máximo: 1
EXGCERTIFICADOIndica se o produto exige certificado:
S  – Sim
N – Não.
stringTamanho Máximo: 1
INDALTORISCOIndica se o produto é de alto risco:
S  – Sim
N – Não.

Parâmetro vinculado ao processo de Sorter.

stringTamanho Máximo: 1
INDEXGVALIDACAOMONTAGEMPALETEIndica se o produto exige validação na montagem do palete:
S  – Sim
N – Não.

Parâmetro vinculado ao processo de Sorter.

stringTamanho Máximo: 1
QTDVOLGERAETQMASTER

Quantidade de volumes para que seja gerada etiqueta master automaticamente, para que não passe pelo processo de montagem.

Parâmetro vinculado ao processo de Sorter.

integerValor Máximo: 999
SEQFAMILIACódigo sequencial da família do produto.integer
INDCONTROLATEMPERATURAIndica se o produto controla temperatura:
S  – Sim
N – Não.

Parâmetro vinculado ao processo de conferência de recebimento.

stringTamanho Máximo: 1
INDCONTROLARASTREABILIDADEIndica se o produto controla rastreabilidade:
S  – Sim
N – Não.

Parâmetro vinculado ao processo de rastreabilidade.

stringTamanho Máximo: 1
QTDDIASCONTROLEQUARENTENA

Quantidade de dias para controle de rastreabilidade. Parâmetro vinculado ao processo de rastreabilidade. 

Obrigatório caso o campo INDCONTROLARASTREABILIDADE esteja marcado como "S".

integerValor Máximo: 999
USUARIOALTERACAOUsuário que realizou a última alteração no cadastro do produto.stringTamanho Máximo: 12

Exemplo de Resposta:

Bloco de código
languageactionscript3
{
    "hasNext": true,
    "items": [
        {
            "SEQPRODUTO": 2,
            "NROEMPRESA": 100,
            "DESCCOMPLETA": "CAIXA EXEMPLO",
            "DESCREDUZIDA": "CAIXA",
            "CODTIPENDERECO": "N",
            "STATUSCOMPRA": "A",
            "STATUSVENDA": "A",
            "TIPARMAZENAGEM": "N",
            "TIPSEPARACAO": "N",
            "PZOVALIDADEDIA": 100,
            "PESAVEL": "N",
            "EMTETIQUETA": "N",
            "INDPROCFABRICACAO": "S",
            "MEDVDIAGERAL": 1500.0,
            "EXGNROLOTE": "N",
            "SEQPRODUTOBASE": 1,
            "ADVARMAZENAGEM": "EXEMPLO ADVERTENCIA",
            "REFFABRICANTE": "EXEMPLO REF. FABRICANTE",
            "EXGNROSERIE": "N",
            "QTDTOLARMAZPROD": 1,
            "UTZESTRUTDRIVEIN": "N",
            "EXGCERTIFICADO": "N",
            "INDALTORISCO": "N",
            "INDEXGVALIDACAOMONTAGEMPALETE": "N",
            "QTDVOLGERAETQMASTER": 5,
            "SEQFAMILIA": 1,
            "INDCONTROLATEMPERATURA": "N",
            "INDCONTROLARASTREABILIDADE": "S",
            "QTDDIASCONTROLEQUARENTENA": 1,
            "USUARIOALTERACAO": "TOTVS"
        }
    ]
}