Árvore de páginas

Versões comparadas

Chave

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

...

Layout de requisição para criação

Requisição para criação

Path: http://

localhost:8099

10.172.215.57:8087/public-client-view/public-client-view/create

,

Método: POST

CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
restClientViewsRestClientView[]Sim
Lista de RestClientView.
Exemplos

Âncora
RestClientView
RestClientView
RestClientView

CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
orderCodeStringSim255Código do pedido.Deve ser único.Exemplos
orderItensString[] Sim255 para cada itemLista de itens do pedido.Texto Livre.Exemplos
locationRestClientViewLocationSim
Localidade de origem e destino do pedido.RestClientViewLocation válido.Exemplos
statusStringSim
Status atual do pedido.PREPARING_TO_SHIP, ON_THE_WAY, DELIVERED.Exemplos
estimatedTimestampDateTimeSim
Data estimada de entrega.Formato ISO8601.

Exemplos

...

Exemplo de requisição JSON

[{

Âncora
exemplosJson
exemplosJson

    "orderCode": "pedidoExemplo",
    "orderItens": [
        "ItemExemplo"
    ],
    "location": {
        "origin": "origemExemplo",
        "destination": "destinoExemplo",
        "contacts": [
            {
                "email": "noreply@totvs.com.br",
                "phone": "(xx)xxxxx-xxxx"
            }
        ]
    },
    "status": "PREPARING_TO_SHIP",
    "estimatedTimestamp": "2022-05-16T17:12:39,909"
}]

Layout de Resposta

RestClientViewResponse


CampoTipoDescrição
successMessageRestClientMessageMensagem de criação com sucesso.
errorMessagesRestClientViewMessage[]Lista de mensagens com os erros na criação.

RestClientViewMessage

Âncora
RestClientViewMessage
RestClientViewMessage

CampoTipoDescrição
messageCodeStringCódigo da mensagem.
messageStringMensagem.


Layout de requisição para atualização de status

Path:

localhost:8099

http://10.172.215.57:8087/public-client-view/public-client-view/update/status/on-the-way/

Método: POST

ParâmetroKeyTipoObrigatórioDescriçãoValidaçõesRetorno
Código do pedidoorderCodeStringSimAtualiza o status para a caminho ( ON_THE_WAY ).Valida se o pedido existe.vazio
Exemplo
localhost:8099
http://10.172.215.57:8087/public-client-view/public-client-view/update/status/on-the-way/?orderCode=pedidoExemplo

Path:

localhost:8099

http://10.172.215.57:8087/public-client-view/public-client-view/update/status/finish/

Método: POST

ParâmetroKeyTipoObrigatórioDescriçãoValidaçõesRetorno
Código do pedidoorderCodeStringSimAtualiza o status para entregue ( DELIVERED ).Valida se o pedido existe.vazio
Exemplo
localhost:8099
http://10.172.215.57:8087/public-client-view/public-client-view/update/status/finish/?orderCode=pedidoExemplo


Catálogo de mensagens

CódigoMensagemDescrição
PCV000SucessoInforma que a requisição é válida.
PCV001O código do pedido não pode ser nulo.

Ao enviar uma requisição com o código de pedido nulo.

PCV002

O campo código do pedido [CÓDIGO_DO_PEDIDO] é superior à 255 caracteres.

Ao enviar uma requisição com o código de pedido com mais de 255 caracteres.
PCV003O código [CÓDIGO_DO_PEDIDO]  já está em uso.

Ao enviar uma requisição com código de pedido que já está em uso.

PCV004A lista de itens do pedido [CÓDIGO_DO_PEDIDO] não pode ser nula nem vazia.Ao enviar uma requisição com uma lista de itens nula ou vazia.
PCV005A lista de itens do pedido [CÓDIGO_DO_PEDIDO] possui itens de pedido nulos ou vazios.Ao enviar uma lista de itens com um ou mais itens nulos ou vazios.
PCV006

Os campos dos itens de pedido [ITENS_INVÁLIDOS] têm tamanho superior à 255 caracteres.

Ao enviar uma lista de itens com um ou mais itens que possuam mais de 255 caracteres.
PCV007

O local do pedido [CÓDIGO_DO_PEDIDO] não pode ser nulo.

Ao enviar uma requisição com o local do pedido nulo.
PCV008

A origem do pedido [CÓDIGO_DO_PEDIDO] não pode ser nula ou vazia.

Ao enviar uma requisição com a origem nula ou vazia.

PCV009

O campo origem [ORIGEM] é superior à 255 caracteres.

Ao enviar com uma requisição com a origem que possua mais de 255 caracteres.
PCV010O destino do pedido [CÓDIGO_DO_PEDIDO] não pode ser nulo ou vazio.

Ao enviar com uma requisição com o destino nulo ou vazio.

PCV011

O campo destino [DESTINO] é superior à 255 caracteres.

Ao enviar uma requisição com o destino que possua mais de 255 caracteres.
PCV012

A lista de contatos referente ao pedido [CÓDIGO_DO_PEDIDO] não pode ser nula ou vazia.

Ao enviar uma lista de contatos nula ou vazia.
PCV013O contato referente ao pedido [CÓDIGO_DO_PEDIDO] deve ter um email ou um telefone.

Ao enviar um contato sem telefone e sem email. Ou seja é obrigatório o envio de um dos dois.

PCV014O email [EMAIL] do contato referente ao pedido: [CÓDIGO_DO_PEDIDO]  não pode ser superior à 255 caracteres.Ao enviar um contato com email que tenha mais de 255 caracteres.
PCV015

O email [EMAIL] do contato referente ao pedido: [CÓDIGO_DO_PEDIDO] deve ter um formato válido: [email protected]

Ao enviar um contato com email em um formato inválido.
PCV016

O telefone [PHONE] do contato referente ao pedido [CÓDIGO_DO_PEDIDO] deve ter um formato válido: (xx)xxxxx-xxxx

Ao enviar um contato com telefone em um formato inválido.
PCV017O status referente ao pedido [CÓDIGO_DO_PEDIDO] não deve ser nulo.Ao enviar uma requisição com o status nulo.
PCV018

Status [STATUS] não existe. Os status disponíveis são: [PREPARING_TO_SHIP, ON_THE_WAY, DELIVERED]

Ao enviar uma requisição com um status inexistente, além disso a mensagem mostra os disponíveis.
PCV019

A data estimada da entrega do pedido [CÓDIGO_DO_PEDIDO] não deve ser nula

Ao enviar uma requisição com a data de entrega estimada nula.