Árvore de páginas

Versões comparadas

Chave

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

...

Manipulação de Objetos da Interface (Metadata)
Método (API)Endpoint (API)Endpoint (UPC)Evento (UPC)Entrada (UPC)Observação
GETURL_Base/metadata/?type=listgetMetaData

list

Metadados

Estrutura metadados da listagem.

GETURL_Base/metadata/?type=newgetMetaData

new

Metadados

Estrutura metadados da tela de inclusão.

GETURL_Base/metadata/<código do embarque>?type=editgetMetaData

edit

Metadados

Estrutura metadados da tela de edição.

GETURL_Base/metadata/<código do embarque>?type=copygetMetaData

new

Metadados

Estrutura metadados da tela de cópia

GETURL_Base/metadata/<código do embarque>?type=detailgetMetaData

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
GETURL_Base/<código do embarque>findById

findById

Dados do registro

Executado depois de buscar um registro específico.

GETURL_Base?pageSize=20&page=1findAll

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.

POSTURL_Basecreate

afterCreate

Payload*

Executado depois da criação o cabeçalho do embarque.

PUTURL_Base/<código do embarque>update

beforeUpdate

Payload*

Executado antes da alteração o cabeçalho do embarque.

PUTURL_Base/<código do embarque>update

afterUpdate

Payload*

Executado depois da alteração o cabeçalho do embarque.

DELETEURL_Base/<código do embarque>delete

beforeDelete

Vazio

Executado antes da eliminação de um registro.

DELETEURL_Base/<código do embarque>delete

afterDelete

Vazio

Executado depois da eliminação de um registro.

POSTURL_Base/terminate/<código do embarque>terminate

beforeTerminate

Payload*

Executado antes de finalizar o embarque.

POSTURL_Base/terminate/<código do embarque>terminate

afterTerminate

Payload*

Executado depois de finalizar o embarque.

POSTURL_Base/validatevalidateForm

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
GETURL_Pedidos/orders/<código do embarque>findById

findById

Dados do registro

Executado depois de buscar um registro específico.

GETURL_Pedidos/orderDeposits/<chave completa da linha>ordersDeposit

ordersDeposit

Dados do registro

Executado depois de buscar um registro específico.

POSTURL_Pedidos/totalAllocation/<código do embarque>totalAllocation

beforeTotalAllocation

Dados do registro

Executado antes de alocar totalmente o resumo

POSTURL_Pedidos/totalAllocation/<código do embarque>totalAllocation

afterTotalAllocation

Dados do registro

Executado depois de alocar totalmente o resumo

POSTURL_Pedidos/allocatePartial/<código do embarque>partialAllocation

beforePartialAllocation

Dados do registro

Executado antes de alocar parcialmente o resumo

POSTURL_Pedidos/allocatePartial/<código do embarque>partialAllocation

afterPartialAllocation

Dados do registro

Executado depois de alocar parcialmente o resumo

POSTURL_Pedidos/allocateCompound/<código do embarque>allocateCompound

beforeAllocateCompound

Dados do registro

Executado depois de alocar o resumo composto

POSTURL_Pedidos/allocateCompound/<código do embarque>allocateCompound

afterAllocateCompound

Dados do registro

Executado depois de alocar o resumo composto

POSTURL_Pedidos/allocateOrder/<código do embarque>allocateOrder

beforeAllocateOrder

Dados do registro

Executado antes de alocar o pedido completo

POSTURL_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
GETURL_AlocaçõesfindById

findById

Dados do registro

Executado depois de buscar um registro específico.

GETURL_Alocações/allocationsCompound/<chave linha>allocationsCompound

allocationsCompound

Dados do registro

Executado depois de buscar um registro específico.

POSTURL_Alocações/totalDeallocatetotalDeallocation

beforeTotalDeallocation

Dados do registro

Executado antes de desalocar totalmente o resumo

POSTURL_Alocações/totalDeallocatetotalDeallocation

afterTotalDeallocation

Dados do registro

Executado depois de desalocar totalmente o resumo

POSTURL_Alocações/partialDeallocatepartialDeallocation

beforePartialDeallocation

Dados do registro

Executado antes de desalocar parcialmente o resumo

POSTURL_Alocações/partialDeallocatepartialDeallocation

afterPartialDeallocation

Dados do registro

Executado depois de desalocar parcialmente o resumo

POSTURL_Alocações/saveNarrativesaveNarrative

beforeSaveNarrative

Dados do registro

Executado antes de salvar o resumo da linha

POSTURL_Alocações/saveNarrativesaveNarrative

afterSaveNarrative

Dados do registro

Executado depois de salvar o resumo da linha

Bloco de código
titleExemplo de Form (Validate do cabeçalho)
linenumberstrue
collapsetrue
{
    "processed": false,
    "code": ".ex",
    "rejected": false,
    "depositCq": false,
    "name": "DepósitoExterno",
    "recipient": "NCOM",
    "codeName": null,
    "balanceAv": true,
    "finished": true,
    "type": null,
    "allocated": true
}

...