Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Informações
Este método é responsável pela criação da reserva de estoque online

...

  • Endpoint: /api/pdvsyncserver/retaguarda/v2/ProcessoOnlineEstoqueSaldo/{idInquilino}/{idProdutoRetaguarda}/{idLojaOrigemRetaguarda}/{idLojasConsultaEstoqueRetaguarda}/{idProdutoEmbalagemRetaguarda}ProcessoOnlineReservaEstoque
  • Método: GETPOST
  • Autenticação: Bearer token
  • Permissão: Retaguarda

Para esse endpoint, alguns parâmetro precisam ser enviados na requisição. Estes parâmetros são:

...

  • Client

Body da requisição

Deck of Cards
idcredito_consulta_get
Card
labelDefinição das propriedades

Campo

Tipo

Descrição

Obrigatório

IdInquilinoString

...

Identificador do inquilino

...

Sim

...

IdRetaguardaLoja

...

StringIdentificador

...

da loja na retaguarda

...

Sim

...

IdReservaEstoque

...

StringIdentificador da

...

Pode ser passar mais de um valor separando-os por vírgula (,)

...

N

...

reserva de estoqueSim
Reserva

Retornos

Deck of Cards
idProcessoOnlineEstoqueSaldoDC
data
Card
label200 - OK

Campo

Tipo

Descrição

successBooleanoIndica se a requisição retornou sucesso
messageStringCampo com as mensagens de erro
Lista de Objetos
Conteúdo
Reserva de
retornodata.
data.estoque.armazemObjetoObjeto armazem
data.estoque.armazem.idStringIdentificador do armazem
data.estoque.armazem.descricaoStringdescrição do armazem
data.estoque.lojaObjetoObjeto loja
data.estoque.loja.enderecoStringEndereço da loja
data.estoque.loja.idRetaguardaStringIdentificador da loja na retaguarda
data.estoque.loja.descricaoStringDescrição da loja
data.estoque.quantidadeDecimalQuantidade em estoque
data.idRetaguardaProduto
estoque
Lista de ObjetosLista de estoques
Sim
Reserva.IdRetaguardaLojaEstoqueStringIdentificador da loja estoque na retaguardaSim
Reserva.IdRetaguardaProduto
StringIdentificador do produto na retaguarda
errors
Sim
NuloLista com errostotalTimeInteiroTempo de requisiçãonumberOfRecordsInteiroNúmero de linhas retornadas
Reserva.QuantidadeReservaInteiroQuantidade reservaSim
Card
labelBody

{
    "successidInquilino": true"string",
    "messageidLojaRetaguarda": "string",
    "data": [
        {
            "estoque": [
                {
                    "armazem": {
                        "ididOperadorRetaguarda": "string",
    "cpfCnpj": "string",
                        "descricao"nome": "string"
                    },
                    "loja": {
                        "endereco": ""idClienteRetaguarda": "string",
                        "idRetaguarda"dataInicio": "string2024-06-17T22:41:07.140Z",
                        "descricaodataFim": "string"
                    },
                    "quantidade": 0.0
                }
            ],
            "idRetaguardaProduto": "string"
        }
    ],
    2024-06-17T22:41:07.140Z"
}

Retornos

Deck of Cards
idcredito_consulta_get
Card
label200 - OK

Campo

Tipo

Descrição

SuccessboolIndica se a requisição foi feita com sucesso
MessageStringMensagem de retorno de erros
DataLista de ObjetosMensagem de retorno
ErrorsLista de objetosLista de erros
TotalTimeIntTempo da requisição
NumberOfRecordsIntNúmero de registros

{
    "success": true,
    "message": "String",
    "data": ""
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}

Card
label400 - Bad Request

Campo

Tipo

Descrição

ObeservaçãoObservação

SuccessboolIndica se a requisição foi feita com sucesso
MessagestringMensagem de retorno de erros
DataObjetoObjeto de retorno
ErrorsLista de objetosLista de errosSomente é retornado na V3
TotalTimeIntTempo total da requisição
NumberOfRecordsIntNúmero de registros


{
    "success": false,
    "message": "string",
    "data": null,
    "errors": null,
    "totalTime": 0,
    "numberOfRecords": 0
}