Resultado das Ações de Produto

Nesta seção será apresentada a consulta de resultados das ações de produto

No guia Rehub - Ações de Produto vemos que após realizar uma ação de conexão, desconexão ou sincronização de estoque/preço é retornado um ID de carga em resposta, como mostra o exemplo abaixo:

// Response 201 - Created:

{
    "id": "1672853787"
}

A partir do ID informado é possível visualizar um resumo da operação realizada e logo a seguir temos maiores detalhes sobre esta consulta.

GET - Consultando o resultado da ação

Consultando o resultado da ação por categoria

O endpoint /product_actions é responsável pelas ações da rota rehub que automatizam os processos de conexão, desconexão e sincronização de estoque/preço. A ação a ser executada é definida no body da requisição através do campo "type" que poderá conter os valores link (conexão), unlink (desconexão) e price_entry (sincronização de estoque/preço).

Os valores do campo type serão utilizados para filtrar a consulta de resultados das ações. Para a consulta, deverá ser executada uma requisição com o método GET para o endpoint descrito a seguir:

https://api.skyhub.com.br/rehub/product_actions

Parâmetros a serem adicionados na busca:

Key	Value
?type=	link
?type=	unlink
?type=	price_entry

Para a consulta é necessário informar um tipo de ação conforme indicado acima (link, unlink ou price_entry).

Caso não seja definido um valor para o parâmetro da busca, será retornado status de erro para a requisição.

Request headers:

Key	Value
Accept	application/json
Content-Type	application/json
X-Accountmanager-Key	token_account único de cada Plataforma/ERP
Authorization	Bearer [token JWT]

A página Rehub - Ações de Produto traz os detalhes sobre a solicitação do Bearer JTW.

Example request:

curl --location --request GET 'https://api.skyhub.com.br/rehub/product_actions?type=link' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Authorization: Bearer eyJhbGci...........TyPs' \

Response esperado:

200 [Success] - OK: Haverá um response body contendo um resumo com os resultados da ação realizada.

No caso do exemplo utilizado, serão apresentados os resultados da conexão (?type=link) de itens via API:

{
    "product_actions": [
        {
            "error_count": 0,
            "id": "1672933116",
            "requested_by": "email_de_usuario",
            "sale_system": "Submarino", // O sale system 'Submarino' representa todo o marketplace Americanas
            "started_at": "2023-01-05T15:38:36Z",
            "status": "finished",
            "success_count": 5,
            "type": "link",
            "updated_at": "2023-01-05T15:38:37.880Z",
            "warning_count": 0
        },
        {
            "error_count": 1,
            "id": "1670513203",
            "requested_by": "email_de_usuario",
            "sale_system": "Submarino",
            "started_at": "2022-12-08T15:26:43Z",
            "status": "finished",
            "success_count": 0,
            "type": "link",
            "updated_at": "2022-12-08T15:26:43.282Z",
            "warning_count": 0
        }
        (...)
    ],
    "total": 12

Consultando o resultado da ação pelo ID da carga

Toda ação de produto realizada via rehub gera um ID de resposta. Este código pode ser utilizado para listar os SKUs que foram impactados pela ação realizada.

Quando se tratarem de itens que apresentaram alguma reprova, haverá um resumo do motivo da recusa no payload da consulta.

Para realizar a listagem pelo ID de carga serão utilizados os mesmos headers e método (GET) apresentados acima (ver Consultando o resultado da ação por categoria) no endpoint:

https://api.skyhub.com.br/rehub/product_actions/{id}/results

Example request:

// Para exemplificar foi utilizado o ID 1670513203, 
// visualizado no retorno da listagem de resultados da ação por categoria

curl --location --request GET 'https://api.skyhub.com.br/rehub/product_actions/1670513203/results' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-Accountmanager-Key: token_account único de cada Plataforma/ERP' \
--header 'Authorization: Bearer eyJhbGci...........TyPs' \

Response esperado:

200 [Success] - OK: Haverá um response body contendo a listagem de SKUs relacionados ao ID de carga referenciado. Na carga utilizada como exemplo (ID 1670513203) temos um SKU que foi recusado pelo marketplace. Neste caso, vemos o array details trazendo um resumo do motivo da recusa:

{
    "results": [
        {
            "id": "nvNY8o.........TmPm4",
            "sku": "2022001",
            "created_at": "2022-12-08T15:26:43+00:00",
            "specification": {},
            "previous_specification": {},
            "details": [
                {
                    "key": "mensagem",
                    "value": "An error occurred while trying to fetch partner_id"
                }
            ]
        }
    ],
    "next": null
}

A consulta dos resultados das ações de produtos traz apenas a visualização resumida dos SKUs que foram conectados/desconectados ou tiveram seu estoque/preço atualizado via rehub.

Para visualizar todos os produtos que apresentaram reprovas é importante seguir os passos da nossa seção de erros.