Início > Pedido mínimo
Versão: 2.0
Pedido mínimo
Última Atualização: 29/01/2025
Este endpoint permite a criação de pedidos mínimos para um grupo de produtos, definindo uma condição mínima de compra para pedidos.
Parâmetros da requisição
por_pagina*: Integer.
Obs: Quantidade de itens por página.
Ex: 100.
pagina*: Integer.
Obs: Página indice da busca.
Ex: 1.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
status
Indentifica os status da requisição de sucesso ou falha.
Tipo: String.
mensagem
Mensagem retornada pelo endpoint.
Tipo: String.
data
Dados da requisição.
Tipo: Array de JSON.
id
Id do grupo de pedidos mínimos.
Tipo: Integer.
condicao_pagamento_id
Id da condição de pagamento.
Tipo: Integer.
grupo_produto_id
Id do grupo de produtos.
Tipo: Integer.
nome_grupo
Nome do grupo de produtos.
Tipo: String.
pedido_minimo
Valor mínimo para o pedido.
Tipo: Double.
created_at
Data de criação do grupo.
Tipo: Datetime.
modified_at
Data da última modificação.
Tipo: Datetime.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
Caso tenham parâmetros incorretos.
GET Pedido mínimo
Última Atualização: 29/01/2025
Retorna os grupos de pedidos mínimos.
Endpoint GET
Sintaxe da Requisição
Para que a requisição do método Post seja bem-sucedida, é necessário que
seja enviado os seguintes valores dentro de um JSON:
Elementos da Requisição
condicao_pagamento_id
Id da condição de pagamento.
Tipo: Integer.
pedido_minimo
Valor do pedido mínimo.
Tipo: Float.
grupo_produto_id
Id do grupo de produtos.
Tipo: Integer.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
detail
Detalhes da requisição.
Tipo: JSON.
success
Identificador booleano de sucesso da requisição.
Tipo: Boolean.
message
Mensagem de sucesso ou falha da requisição.
Tipo: String.
data
Dados de retorno da requisição.
Tipo: JSON.
success
Identificador booleano de sucesso da ação.
Tipo: Boolean.
message
Mensagem retornada pela api.
Tipo: String.
id_grupo
Ids dos grupos atualizados.
Tipo: Array de String.
Para este endpoint existe a opção de sucesso parcial com status code 207:
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
403 Forbidden
Caso o fornecedor não tenha acesso a condição de pagamento informada.
POST Pedido mínimo
Última Atualização: 29/01/2025
Este endpoint adiciona novos pedidos mínimos aos grupos de produtos.
Endpoint POST
Sintaxe da Requisição
Para que a requisição do método Patch seja bem-sucedida, é necessário que
seja enviado os seguintes valores dentro de um JSON:
Elementos da Requisição
grupo_produto_id
Id do grupo de produtos.
Tipo: Integer.
pedido_minimo
Valor do pedido mínimo.
Tipo: Float.
condicao_pagamento_id
Id da condição de pagamento.
Tipo: Integer.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
mensagem
Mensagem de sucesso ou falha da requisição.
Tipo: String.
atualizados
Pedidos mínimos que foram atualizados.
Tipo: JSON.
grupo_produto_id
Id do grupo produto.
Tipo: Integer.
condicao_pagamento_id
Id da condição de pagamentos.
Tipo: Integer.
invalidos
Pedidos mínimos que não puderam ser atualizados.
Tipo: Array.
Para este endpoint existe a opção de sucesso parcial com status code 207:
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
Em caso de envio de ids inválidos:
PATCH Pedido mínimo
Última Atualização: 29/01/2025
Este endpoint edita pedidos mínimos dos grupos de produtos.
Endpoint PATCH
DELETE Pedido minimo
Última Atualização: 29/01/2025
Este endpoint deleta pedidos mínimos dos grupos de produtos.
Endpoint DELETE
Para este endpoint, deve ser enviado o id do pedido mínimo na url, como path param.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Requisição
mensagem
Dados retornados pela API.
Tipo: JSON.
sucesso
Indicador booleano de sucesso ou falha.
Tipo: Boolean.
mesage
Mensagem retornada pela API.
Tipo: String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request