Árvore de páginas

Versões comparadas

Chave

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

...

Método que permite consultar os cancelamentos de cargas de recebimento do WMS Centro de Distribuição. 

Esse tipo de exportação ocorre ao realizar o cancelamento da carga de recebimento, quando a Empresa não utiliza o ERP TOTVS Varejo Supermercados.

Chamada

GET api/v1/exportacao/cancelamentorecebimento

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: -seqexportacao.

string

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

nroempresaFiltro para busca de cancelamentos de recebimento de determinada empresa.integerQuando não enviado, retorna de todas as empresas.
nrocargaFiltro para busca do cancelamento de determinada carga.integerOpcional.
status

Filtro para busca de registros com determinados status:

A - Aguardando/Não Integrado 
F - Finalizada/Integrado

stringValor padrão: A
datainicioFiltro para busca de registros a partir de determinada data, no formato 2022-12-01T13:00:00 datetimeQuando não enviado, retorna todos os registros, independente da data.
datafimFiltro para busca de registros até determinada data, no formato 2022-12-01T13:00:00 datetimeQuando não enviado, retorna todos os registros, independente da data.

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/cancelamentorecebimento?page=1&pagesize=10&order=SEQEXPORTACAO&nroempresa=100&nrocarga=500044&status=A&datainicio=2023-01-17T10:26:36&datafim=2023-01-17T10:52:36

Informações para Resposta (Response Information)

...

  • 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 (Cancelamento) da lista, conforme tabela abaixo.


Cancelamento de Carga de Recebimento:

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
SEQEXPORTACAONúmero sequencial correspondente ao registro de exportação.longÉ utilizado para realizar a confirmação de leitura do registro.
NROEMPRESANúmero da empresa logística no WMS Centro de Distribuição.integer
NROCARGANúmero da carga cancelada.long
USUARIOCANCELAMENTO

Nome do usuário responsável pelo cancelamento.

string
DTAHORGERACAOData e hora de geração do registro.datetime

Exemplo de Resposta:

Bloco de código
languageactionscript3
{
    "hasNext": true,
    "items": [
        {
            "SEQEXPORTACAO": 1,
            "NROEMPRESA": 100,
            "NROCARGA": 500044,
            "USUARIOCANCELAMENTO": "CONSINCO",
            "DTAHORGERACAO": "2023-01-17T10:26:36",
        }
    ]
}

...