SYSLED DevelopersTodos os métodos
POST

products.get

Busca um SKU ativo da empresa e acrescenta descricao ao objeto de produto.

Grupo: CatálogoRevisão: Escopo recomendado: products.get
Exemplos seguros e fictícios. O domínio example.invalid e a credencial demonstrativa abaixo não funcionam. Use o token real somente no servidor da sua integração e nunca o inclua em páginas públicas.

Parâmetros

Parâmetros aceitos por products.get
CampoTipoObrigatoriedadeDescriçãoExemplo fictício
codigostringum dos dois obrigatórioSKU exato. Informe codigo OU sku; codigo tem precedência quando ambos são preenchidos."DEMO-01"
skustringum dos dois obrigatórioAlternativa a codigo. Ao menos um dos dois deve ser informado."DEMO-01"

Exemplos fictícios

Os exemplos documentam o formato; eles não executam nenhuma operação.

Requisição

cURL demonstrativo
curl --request POST \
  'https://example.invalid/api/v1/CREDENCIAL_FICTICIA_SEM_VALOR/products.get' \
  --header 'Content-Type: application/json' \
  --data '{"codigo":"DEMO-01"}'
Corpo JSON
{
  "codigo": "DEMO-01"
}
Resposta HTTP 200
{
  "ok": true,
  "method": "products.get",
  "result": {
    "product": {
      "id": "11111111-1111-4111-8111-111111111111",
      "nome": "Produto de demonstração",
      "codigo": "DEMO-01",
      "idCatalogo": "100.000001",
      "marca": "Marca exemplo",
      "categoria": "Categoria exemplo",
      "imagemThumb": "https://assets.example.com/produto.png",
      "imagens": [
        "https://assets.example.com/produto.png"
      ],
      "imagensCount": 1,
      "specs": {
        "potencia": "10 W",
        "tensao": "220V"
      },
      "preco_venda": 25,
      "estoque": 12,
      "reservado": 2,
      "disponivel_qtd": 10,
      "disponivel": true,
      "motivo_indisponivel": null,
      "descricao": "Descrição ilustrativa do produto."
    }
  }
}

Erros

Condições de erro específicas de products.get
HTTPCódigoCondição
403TOKEN_NO_COMPANYToken sem empresa associada.
400BAD_REQUESTcodigo/sku não informado.
404NOT_FOUNDProduto ativo não encontrado na empresa.

Consulte também os erros globais e limites.

Observações