API Reference
Log In
API Reference

Consultar nível de estoque

Consultar estoque atual de produtos
O objetivo deste gatilho é mostrar para o usuário na hora de coleta o estoque atual daquele produto. Esta requisição é feita via /GET e os parâmetros são passados via query string.

CampoTipoDescrição
storeCodestringDefine qual loja desejamos saber o estoque.
eanstringIdentificador único do produto que desejamos saber o estoque.
skustringIdentificador único do produto para este cliente que desejamos saber o estoque
{
  "ean": "1234567890123",
  "stock": 21
}

Consultar detalhe de produto

Consultar detalhes de um produto.
O objetivo deste gatilho é carregar os dados de um produto a partir do sku ou ean, esse gatilho é utilizado no fluxo de decida do pedido pra que não seja necessário fazer carga do catálogo completo. Esta requisição é feita via /GET e os parâmetros disponíveis para buscar informações de um produto são passados via query string.

CampoTipoDescrição
skustringIdentificador do produto
eanstringCódigo de barras único do produto.
idstringIdentificador único do produto no sistema de origem.
{
  	"productSku": "00000001",
    "productEAN": "2892139001786",
    "productKey": "12345",
    "name": "nome",
    "description": "descrição",
    "type": "resfriado",
    "subType": "iogurte",
    "pictures": [{"url":"https://domain.com.br/images/12345.jpg","subtitle":"name"}],
    "unitMeasure": "un",
    "section": 002,
    "family": "resfriados",
    "width": 20,
    "height": 10,
    "weight": 0.200,
    "url": "url do produto"
}

Buscar produtos por palavra chave

Consultar produtos por palavras chave.
O objetivo deste gatilho é buscar produtos por palavra chave, esse gatilho é usado no processo de substituição de produtos em caso de ruptura. Esta requisição é feita via /GET e os parâmetros disponíveis para buscar informações de um produto são passados via query string.

CampoTipoDescrição
querystringTermos usados para buscar produtos
storestringCódigo único para identificar a loja
{
    "productSku": "00000001",
    "productEAN": "2892139001786",
    "productKey": "12345",
    "name": "nome",
    "description": "descrição",
    "type": "cereais",
    "subType": "matinais",
    "pictures": [{"url":"https://domain.com.br/images/12345.jpg","subtitle":"name"}],
    "unitMeasure": "un",
    "section": 002,
    "family": "grãos",
    "width": 20,
    "height": 10,
    "weight": 0.200,
    "url": "url do produto",
    "price": 4.99,
    "availableQuantity": 120
}