Nesta seção é apresentada a consulta do estoque existente para o sortimento Fulfillment
É possível consultar via API o estoque dos itens que estão no CD da Americanas.
Todo o gerenciamento de estoque Fulfillment é realizado pelos times do marketplace responsáveis pelo serviço e as informações via API são apenas consultas dos dados inclusos pelos mesmos. Qualquer dúvida em relação ao estoque encaminhado deverá ser reportada ao marketplace para validação.
GET - Consultando estoque
Para realizar a consulta de estoque dos itens Fulfillment via API é preciso utilizar o método GET, preenchendo os headers padronizados, para o endpoint abaixo:
https://api.skyhub.com.br/fulfillment/b2w/stock
Request headers:
Key
Value
X-User-Email
email_de_usuario
X-Api-Key
token_de_integracao de sua conta SkyHub
X-Accountmanager-Key
token_account único de cada Plataforma/ERP
Accept
application/json
Content-Type
application/json
Example request:
curl --location --request GET 'https://api.skyhub.com.br/fulfillment/b2w/stock' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response esperado:
200 [Success] - OK: Como resposta para a execução do cURL exemplificado acima haverá um body contendo os primeiros 100SKUs. A seguir temos uma visualização resumida do retorno:
{
"stocks": [
{
"sku": "SKU0001F", // SKU parceiro
"remote_code": "SKU0001F", // SKU parceiro
"recipient_document": "776570005909", // CNPJ do CD
"deposit_type": "AG COBERTO EM RECEB.", // Tipo de depósito/restrição em que o produto se encontra dentro do CD
"stock": "0", // Quantidade em estoque
"reserved_stock": "0" // Quantidade de estoque reservado
},
{
"sku": "SKU0001F",
"remote_code": "SKU0001F",
"recipient_document": "776570005909",
"deposit_type": "AG COBERTO NORMAL",
"stock": "0",
"reserved_stock": "0"
},
(...)
{
"sku": "SKU0100F",
"remote_code": "SKU0100F",
"recipient_document": "776570005909",
"deposit_type": "AG COBERTO EM RECEB.",
"stock": "0",
"reserved_stock": "0"
},
{
"sku": "SKU0100F",
"remote_code": "SKU0100F",
"recipient_document": "776570005909",
"deposit_type": "AG COBERTO NORMAL",
"stock": "39",
"reserved_stock": "0"
}
]
}
Filtros para consulta de estoque Fulfillment
É possível limitar a listagem dos itens retornados em uma consulta ao aplicar filtros às buscas.
Paginação da consulta
Ao se tratar de uma conta com muitos itens disponíveis para o serviço Fulfillment pode ser necessário realizar a paginação dos resultados para visualização de todos os registros.
Através do /fulfillment/b2w/stock é possível utilizar os parâmetros page e per_page para paginação da consulta de estoque Fulfillment, sendo:
Key
Value
page
Indica o número da página de registros que será retornada. Caso não seja especificado, sempre será retornada a primeira página (valor padrão 0)
per_page
Indica a quantidade de registros que serão visualizados na página. O valor padrão é de 100 registros. Caso a conta possua mais de 100 itens faz-se necessário acessar a(s) próxima(s) página(s) para visualização dos demais registros
Example request:
curl --location --request GET 'https://api.skyhub.com.br/fulfillment/b2w/stock?page=5&per_page=3' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response esperado:
200 [Success] - OK: Como resposta para a execução do cURL exemplificado acima haverá um body contendo o estoque dos 3 registros presentes na página 5:
curl --location --request GET 'https://api.skyhub.com.br/fulfillment/b2w/stock?sku=SKU0150F' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response esperado:
200 [Success] - OK: Como resposta haverá um response body contendo todo o estoque para o SKU selecionado:
Além da consulta por SKU, via API é possível realizar a listagem de todo o sortimento Fulfillment encaminhado, filtrando pelo CNPJ do Centro de Distribuição (CD).
curl --location --request GET 'https://api.skyhub.com.br/fulfillment/b2w/stock?recipient_document=776570004848' \
--header 'X-User-Email: email_de_usuario' \
--header 'X-Api-Key: token_de_integracao de sua conta SkyHub' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response esperado:
200 [Success] - OK: A consulta trará como retorno os itens e seus estoques para o CNPJ selecionado:
Através da URL de consulta de estoque Fulfillment e dos informados no início deste guia é possível aplicar filtros por:
;
;
.
Os filtros de paginação são aplicados através dos padrões da API em um GET para o endpoint base /fulfillment/b2w/stock. A seguir temos um exemplo prático de aplicação dos parâmetros page e per_page:
Via API há a opção de consultar o estoque para SKUs específicos, sem a necessidade de listar todo o sortimento do Fulfillment. Para tal, basta executar uma requisição contendo o método GET, utilizando os padronizados, para o endpoint base /fulfillment/b2w/stock, aplicando como parâmetro o SKU a ser pesquisado:
Para aplicação do filtro, é necessário executar uma requisição contendo o método GET, utilizando os padronizados, para o endpoint base /fulfillment/b2w/stock e aplicando como parâmetro o CNPJ (definido como recipient_document) a ser consultado:
