Instâncias geradas de SAC

Nesta seção é apresentada a consulta de instâncias de SAC, ações dos pedidos a serem tomadas de acordo com o apontamento feito pelo cliente

Instâncias são requisições feitas na API de SAC para visualizar as ações dos pedidos que possuem um apontamento realizado diretamente pelo cliente, podendo ser: Cancelamento, devolução e troca.

GET - Consultando uma instância

Compreende-se que não é possível criar uma instância, pois as solicitações de cancelamento, devolução e troca são realizadas pelo cliente final. Desta forma, via API, só é possível consultar a instância gerada pelo marketplace Americanas para o pedido.

A consulta de instâncias será realizada através de um GET para o endpoint a seguir:

https://api.skyhub.com.br/sac/{code}/instances

Nesta consulta será utilizado o código completo do pedido (canal de venda + código numérico).

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/sac/Shoptime-100123456789001/instances' \
--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ão detalhes sobre as ações a serem tomadas para a instância aberta para o pedido:

{
  "id": "64",
  "delivery_id": "100123456789001",
  "status": "FORCED",
  "created_at": "2023-05-29T20:42:24.000Z",
  "updated_at": "2023-05-30T12:13:07.000Z",
  "items": [
    {
      "id": "100123456789001-1",
      "sku_id": "120615464",
      "product_id": "120615456",
      "name": "Product ABC",
      "quantity": 1
    }
  ],
  "action": {
    "id": "CANCEL",
    "name": "cancelamento"
  },
  "causes": [
    {
      "id": "ARP",
      "name": "Arrependimento",
      "reasons": [
        {
          "id": "183",
          "name": "Comprei errado"
        }
      ]
    }
  ],
  "refunds": [
    {
      "id": "CREDIT_ACCOUNT",
      "name": "Crédito em Conta",
      "status": "RELEASE",
      "value": 300
    }
  ],
  "additional_note": "Cancel item 158259995-1"
}

No retorno para a consulta é possível acompanhar o andamento da instância e seus possíveis valores estão listados a seguir:

Status da instância:

Status	Descrição
CANCELLED	A instância foi cancelada. Pode ocorrer, por exemplo, por falta de estoque ou porquê o cliente desistiu de cancelar o pedido
CLOSED	A instância gerada já foi atendida/resolvida
INCLUDED	Depende do último ponto em que a instância se encontrava. Dependerá da ação do seller, do cliente (devolução do produto, como por exemplo) ou do próprio SAC
IN_ANALYSIS	Depende do último ponto em que a instância se encontrava. Dependerá da ação do seller, do cliente (devolução do produto, como por exemplo) ou do próprio SAC
IN_PROGRESS	Depende do último ponto em que a instância se encontrava. Dependerá da ação do seller, do cliente (devolução do produto, como por exemplo) ou do próprio SAC;
WAITING	Cliente comprou via boleto e ainda não realizou o pagamento do mesmo, porém abriu uma instância para reembolso, por exemplo. Neste caso, o pedido está aguardando aprovação para que seja possível dar continuidade na instância aberta
FORCED	A instância já foi atendida/resolvida de forma "forçada", porém não temos detalhes de quais critérios são utilizados pelo SAC para realizar esta finalização

Os status INCLUDED, IN_ANALYSIS e IN_PROGRESS dependem da última atualização da instância.

Nestes casos, para que haja o prosseguimento falta uma ação de alguma das partes, como a devolução do pedido por parte do cliente; aguardo de frete para que haja a devolução ou a análise quanto ao cancelamento solicitado.

Incluindo o ID da instância na consulta

É possível realizar a consulta acrescentando o ID da instância que é encontrado dentro do retorno do GET da instância, conforme endpoint abaixo:

https://api.skyhub.com.br/sac/{code}/instances/{id_instancia}

Example request:

curl --location --request GET 'https://api.skyhub.com.br/sac/Shoptime-100123456789001/instances/64' \
--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 resposta trará as mesmas informações da consulta anterior.