Histórico da Página

...

API REST: eqp/api/v1/shipping.p, eqp/api/v1/shippingOrder.p, eqp/api/v1/shippingAllocation.p
URL base para embarques: https://<servidor>:<porta>/api/eqp/v1/shipping
URL base para aba de pedidos: https://<servidor>:<porta>/api/eqp/v1/shippingOrder
URL base para aba de alocações: https://<servidor>:<porta>/api/eqp/v1/shippingAllocation

Manipulação de Objetos da Interface (Metadata)
Método (API)	Endpoint (API)	Endpoint (UPC)	Evento (UPC)	Entrada (UPC)	Observação
GET	*URL_Base*/metadata/?type=list	getMetaData	list	Metadados	Estrutura metadados da listagem.
GET	*URL_Base*/metadata/?type=new	getMetaData	new	Metadados	Estrutura metadados da tela de inclusão.
GET	*URL_Base*/metadata/<código do embarque>?type=edit	getMetaData	edit	Metadados	Estrutura metadados da tela de edição.
GET	*URL_Base*/metadata/<código do embarque>?type=copy	getMetaData	new	Metadados	Estrutura metadados da tela de cópia
GET	*URL_Base*/metadata/<código do embarque>?type=detail	getMetaData	detail	Metadados	Estrutura metadados da tela de detalhes.

Manipulação de Dados - Embarques
Método (API)	Endpoint (API)	Endpoint (UPC)	Evento (UPC)	Entrada (UPC)	Observação
GET	*URL_Base*/<código do embarque>	findById	findById	Dados do registro	Executado depois de buscar um registro específico.
GET	*URL_Base*?pageSize=20&page=1	findAll	findAll	Dados dos registros	Executado depois de buscar os registros.
POST	*URL_Base*	create	beforeCreate	Payload*	Executado antes de criar o cabeçalho do embarque.
POST	*URL_Base*	create	afterCreate	Payload*	Executado depois da criação o cabeçalho do embarque.
PUT	*URL_Base*/<código do embarque>	update	beforeUpdate	Payload*	Executado antes da alteração o cabeçalho do embarque.
PUT	*URL_Base*/<código do embarque>	update	afterUpdate	Payload*	Executado depois da alteração o cabeçalho do embarque.
DELETE	*URL_Base*/<código do embarque>	delete	beforeDelete	Vazio	Executado antes da eliminação de um registro.
DELETE	*URL_Base*/<código do embarque>	delete	afterDelete	Vazio	Executado depois da eliminação de um registro.
POST	*URL_Base*/terminate/<código do embarque>	terminate	beforeTerminate	Payload*	Executado antes de finalizar o embarque.
POST	*URL_Base*/terminate/<código do embarque>	terminate	afterTerminate	Payload*	Executado depois de finalizar o embarque.
POST	*URL_Base*/validate	validateForm	validateForm	Form*	Executa ao sair de algum campo que possui validação, por exemplo o depósito externo (cabeçalho do embarque, aba de informações complementares)
Manipulação de Dados - Aba pedidos
Método (API)	Endpoint (API)	Endpoint (UPC)	Evento (UPC)	Entrada (UPC)	Observação
GET	*URL_Pedidos*/orders/<código do embarque>	findById	findById	Dados do registro	Executado depois de buscar um registro específico.
GET	*URL_Pedidos*/orderDeposits/<chave completa da linha>	ordersDeposit	ordersDeposit	Dados do registro	Executado depois de buscar um registro específico.
POST	*URL_Pedidos*/totalAllocation/<código do embarque>	totalAllocation	beforeTotalAllocation	Dados do registro	Executado antes de alocar totalmente o resumo
POST	*URL_Pedidos*/totalAllocation/<código do embarque>	totalAllocation	afterTotalAllocation	Dados do registro	Executado depois de alocar totalmente o resumo
POST	*URL_Pedidos*/allocatePartial/<código do embarque>	partialAllocation	beforePartialAllocation	Dados do registro	Executado antes de alocar parcialmente o resumo
POST	*URL_Pedidos*/allocatePartial/<código do embarque>	partialAllocation	afterPartialAllocation	Dados do registro	Executado depois de alocar parcialmente o resumo
POST	*URL_Pedidos*/allocateCompound/<código do embarque>	allocateCompound	beforeAllocateCompound	Dados do registro	Executado depois de alocar o resumo composto
POST	*URL_Pedidos*/allocateCompound/<código do embarque>	allocateCompound	afterAllocateCompound	Dados do registro	Executado depois de alocar o resumo composto
POST	*URL_Pedidos*/allocateOrder/<código do embarque>	allocateOrder	beforeAllocateOrder	Dados do registro	Executado antes de alocar o pedido completo
POST	*URL_Pedidos*/allocateOrder/<código do embarque>	allocateOrder	afterAllocateOrder	Dados do registro	Executado antes de alocar o pedido completo
Manipulação de Dados - Aba alocações
Método (API)	Endpoint (API)	Endpoint (UPC)	Evento (UPC)	Entrada (UPC)	Observação
GET	*URL_Aloc*/<código do embarque>	findById	findById	Dados do registro	Executado depois de buscar um registro específico.

Bloco de código

title	Exemplo de Form (Validate do cabeçalho)
linenumbers	true
collapse	true

{
    "processed": false,
    "code": ".ex",
    "rejected": false,
    "depositCq": false,
    "name": "DepósitoExterno",
    "recipient": "NCOM",
    "codeName": null,
    "balanceAv": true,
    "finished": true,
    "type": null,
    "allocated": true
}

...

Árvore de páginas

Versões comparadas

Versão antiga 52

Nova versão 53

Chave

API REST: eqp/api/v1/shipping.p, eqp/api/v1/shippingOrder.p, eqp/api/v1/shippingAllocation.p

URL base para embarques: https://<servidor>:<porta>/api/eqp/v1/shipping