A requisição retorna a disponibilidade do item considerando 1 unidade.
[GET] /ecommerce/availabilities/{type}
Onde:
{type}
é o tipo do objeto a ter a disponibilidade consultada, sendo os seguintes valores possíveis:items
quando o objeto for um item vendável do tipo produto ou serviço;plans
quando o objeto for um plano de assinatura. Nesse caso todos os itens do ciclo vigente deverão estar disponíveis para que o plano de assinatura esteja disponível;
Os parâmetros a seguir podem ser passados para a requisição como parte do endpoint (query string):
ids
array com 1 ou N números contendo os IDs do(s) item(ns) ou plano(s) que serão consultados para saber a disponibilidade. Se no query string a opção de usaraliasId
for informada, será considerado o alias (ID que aparece no front do ERP), caso contrário será considerado o id real.useAliasId
boolean que determinará se a busca dos ids será usando o id que está no ERP (alias) ou o id real que está no banco de dados. Se omitido, o padrão éfalse
, já que por padrão usamos o id real.
Exemplo de requisição e de resposta
[GET] /ecommerce/availabilities/items?ids[]=1&ids[]=2
Resposta da API:
{
"data": [
{
"id": 1,
"availability": true
},
{
"id": 2,
"availability": false
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.