Reserva de Estoque - Versão 1.1

Especificação para exposição de recurso Restful para gerenciamento de reserva de estoque no lojista.

Notas da versão

Inclusão do campo availableQuantity no retorno da operação "Reservar Estoque".

Reserva de Estoque

Recurso que deverá agrupar todas as operações de reserva de produtos no lojista.

Reservar Estoque

Através dessa operação o Marketplace irá informar ao lojista que houve uma compra de determinado produto, para que ele possa controlar do lado do e-commerce dele a disponibilidade do produto.

URI

/stockReserve/ (@POST)

Exemplo de Chamada

POST https://<dominio_lojista>/<uri_opcional>/stockReserve/?orderId=999999&skuIdList=98302,1|92837,2&zipCode=04296001

Dados de Entrada

Campo Tipo Descrição Exemplo Obrigatório
orderId Texto ID master do pedido, que é o ID passado para o cliente. Corresponde ao campo orderMasterId de um pedido. 999999 Sim
skuIdList Texto Lista de SKU ID do produto do lojista e quantidade separados por vírgula 98302,1|92837,2 Sim
zipCode Texto CEP de entrega (1) 01228000 Sim

1. Lembrando que um CEP pode iniciar com o dígito zero (“0”) pois se trata da região de São Paulo. Para maior definição da estrutura do CEP consulte http://www.correios.com.br/servicos/cep/cep_estrutura.cfm

Dados de Saída

Campo Tipo Descrição Exemplo Obrigatório
skuReserveds Tipo Complexo Lista de entidades skuReserveds   Sim
skuReserveds[].skuIdOrigin Texto SKU ID do produto do lojista 29912 Sim
skuReserveds[].quantityReserved Numérico Inteiro Quantidade reservada no lojista 3 Sim
skuReserveds[].availableQuantity Numérico Inteiro Quantidade de produto ainda disponível no lojista 3 Sim
skuReserveds[].idStockReservation Texto Identificador da reserva 100029 Sim
skuReserveds[].errorMessage Texto Mensagem de erro caso não ocorra a reserva Não foi possível realizar a reserva de estoque. Não
sellerMpToken Texto Token de identificação do lojista no parceiro. Para garantir origem da informação. Deve ser utilizado o mesmo Auth-Token das chamadas à API. ncPJ8iS9A028JsnA92Hsnla21 Sim

Retorno da Operação

Adicionar o seguinte cabeçalho na resposta da operação:

Content-Type: application/json

Exemplo de Resposta


		
{
    "sellerMpToken" : "ncPJ8iS9A028JsnA92Hsnla21",
    "skuReserveds" : [{
        "skuIdOrigin" : "28812",
        "quantityReserved" : "3",
        "availableQuantity" : "97",
        "idStockReservation" : "100029",
        "errorMessage" : null
        }, {
        "skuIdOrigin" : "28812",
        "quantityReserved" : "0",
        "availableQuantity" : "2",
        "idStockReservation" : null,
        "errorMessage" : "Não foi possível reservar o sku solicitado."
        } ]
}
Confirmar Reserva

Através dessa operação o Marketplace irá confirmar a reserva de um produto que foi comprado ao lojista.

URI

/stockReserve/confirmation/{idStockReservation} (@POST)

Exemplo de Chamada

POST https://<dominio_lojista>/<uri_opcional>/stockReserve/confirmation/CP92832

Dados de Entrada

Campo Tipo Descrição Exemplo Obrigatório
idStockReservation Texto Identificação da reserva retornada pelo parceiro. CP92832 Sim

Dados de Saída

Retornar apenas HTTP Status 200.

Cancelar Reserva

Através dessa operação o Marketplace irá cancelar uma reserva quando a reserva feita anteriormente não tiver o pedido gerado por algum motivo.

URI

/stockReserve/cancelation/{idStockReservation} (@POST)

Exemplo de Chamada

POST https://<dominio_lojista>/<uri_opcional>/stockReserve/cancelation/CP92832

Dados de Entrada

Campo Tipo Descrição Exemplo Obrigatório
idStockReservation Texto Identificação da reserva retornada pelo parceiro. CP92832 Sim

Dados de Saída

Retornar apenas HTTP Status 200.

Português, Brasil