Pular para o conteúdo principal

Atualizar estoque

Método#

/updateProductStock

POST https://e-vendi.com.br/api/updateProductStock


Conceituação#

Atualizar estoque de um produto.

Este método serve para atualizar apenas um produto d eum estoque.


Atributos#

note

organizationExternalId é o id do seu cliente na sua base de dados, sempre que você for criar um e-commerce para seu cliente, você precisa informar o ID do seu cliente na sua base de dados.

por exemplo, você tem 2 clientes na sua base de dados Cliente 01 : ID: 1001 Cliente 02 : ID: 1002, nesse caso o organizationExternalId será 1001 para o cliente 01 e 1002 para o cliente 02.

Atributos que contém external em seu nome são para identificar que os ID's passados serão da sua base de dados, isso facilita futuras buscas, pois você poderá fazer consultas através do seu ID uma vez que este está sob seu controle.

note

productExternalId é o id do seu produto na sua base de dados.

itemExternalId é o id do item (quando existe variação no produto).

Atributos obrigatórios

São obrigatórios todos atributos marcados com * (asterisco).

AtributosTipoDescrição
env*stringTipo de envio que será feito. Os tipos de envio são: dev (Para quando for enviado para um ambiente de desenvolvimento) ou prod (Para quando for enviado para um ambiente de produção). ATENÇÃO, caso seja enviado para um ambiente de produção todas as transações serão debitadas ou creditadas
integrationToken*stringPara se conectar com o e-vendi é necessário um token integrador, ele será passado como parâmetro para todos os requisitos
organizationExternalId*stringSeu código de identificação no e-vendi
productExternalId*stringID do grupo do produto
itens*itensItens contidos no produto

Itens#

AtributosTipoDescrição
itemExternalIdstringId do produto dentro do grupo
stockintegerQuantia do estoque

Request body#

{
"integrationToken": "seu token",
"env": "dev",
"externalId": "seu id",
"productExternalId": "5000",
"itens": [
{
"itemExternalId": "005000P001",
"stock": 20
}
]
}

Response#

200#

AtributosTipoDescrição
messagestringString de retorno para saber se o estoque foi atualizado

Exemplo

{
"message": "Stock update success"
}

400#

Essa resposta significa que o servidor não entendeu a requisição pois está com uma sintaxe inválida.

405#

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja, verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

415#

Caso você receba um erro 415, certifique-se de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"


Code#