Chats

Através do chats é possível buscar todas as interações que ocorreram no pedido, seja ela entre loja e marketplace, loja e cliente, e cliente e marketplace.

Além disso, é possível responder chat e verificar o status que se encontra.

Como listar chats de um pedido?

Ao listar chats será possível verificar todas as interações que ocorreram para o pedido informado em {code}.

As possíveis interações serão:

  • CUSTOMER_B2W : interação do cliente com a B2W

  • B2W_SELLER: interação entre a B2W e seller

  • CUSTOMER_SELLER: interação entre cliente e seller

Para listar os chats deve ser utilizado o método GET no endpoint abaixo:

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

Request Headers:

Name

Type

Required

Description

Example

accept

String

Required

O formato que você deseja receber o retorno da requisição

application/json

x-user-email

String

Required

E-mail da loja

MUDAR@SEU_EMAIL.COM

x-api-key

String

Required

Token da loja

SUA API KEY

x-accountmanager-key

String

Required

código identificado da integração

SUAXACCOUNT

Example Request:

curl --location --request GET 'https://api.skyhub.com.br/sac/{code}/chats' \
--header 'x-api-key: YOUR API KEY HERE' \
--header 'x-user-email: MUDAR@SEU_EMAIL.COM' \
--header 'content-type: application/json' \
--header 'accept: application/json' \
--header 'x-accountmanager-key: SUAXACCOUNT'

Responses:

200 - Success

{
"status": "ACTIVE",
"seller_status": "UNREAD",
"parts": "CUSTOMER_SELLER",
"messages": [
{
"replyed_at": "2019-10-03T14:20:41",
"part": {
"role": "CUSTOMER",
"name": "John John",
"email": "john@skyhub.com.br",
"code": 123456
},
"created_at": "2019-10-02T11:39:23",
"content": "Bom dia! Produto não chegou!"
}
],
"last_message": "2019-10-07T18:56:22"
}

404 - Not found

{
"errors": {
"detail": "Error message"
}
}

500 - Internal server error

{
"errors": {
"detail": "Error message"
}
}

Como interagir no chamado?

Para interagir, ou seja, responder um ticket, será necessário utilizar o método POST o endpoint a baixo:

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

Parâmetros obrigatórios:

Name

Type

Required

Description

Example

code

string

Required

será o marketplace + pedido

Lojas Americanas-9999900001

parts

string

Required

possíveis valores

CUSTOMER_SELLER B2W_SELLER

CUSTOMER_SELLER

Example Request:

curl --location --request POST 'https://api.skyhub.com.br/sac/{code}/chats/' \
--header 'x-api-key: YOUR API KEY HERE' \
--header 'x-user-email: MUDAR@SEU_EMAIL.COM' \
--header 'content-type: application/json' \
--header 'accept: application/json' \
--header 'x-accountmanager-key: SUAXACCOUNT' \
--data-raw '{
"deliveryId": "3",
"identityId": "00007604079750",
"messageTo": "TO_CUSTOMER",
"messageType": "TEXT_MESSAGE",
"orderId": "1234567",
"message": "Tralalá trililí"
}'

Example Body:

{
"deliveryId": "3",
"identityId": "00007604079750",
"messageTo": "TO_CUSTOMER",
"messageType": "TEXT_MESSAGE",
"orderId": "1234567",
"message": "Tralalá trililí"
}

Valores:

"deliveryId": numero do entrega

"identityId": "identificador do documento",

"messageTo": "TO_CUSTOMER",

"messageType": "TEXT_MESSAGE"

"orderId": "numero da entrega",

"message": Mensagem a ser enviado

Responses:

200 - Success

500 - Internal server error

{
"errors": {
"detail": "Error message"
}
}

Como atualizar o status do chat?

Para atualizar o status de um chat, será necessário utilizar o método PATCH e a endpoint abaixo:

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

Example Request:

curl --location --request PATCH 'https://api.skyhub.com.br/sac/{code}/chats/' \
--header 'x-api-key: YOUR API KEY HERE' \
--header 'x-user-email: MUDAR@SEU_EMAIL.COM' \
--header 'x-accountmanager-key: SUAXACCOUNT' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data-raw '{
"status": "READ"
}'

Example Body:

{
"status": "READ"
}

Valores que serão informados no body:

  • READ

  • ARCHIVED

  • UNREAD

Parâmetros obrigatórios:

Name

Type

Required

Description

Example

code

string

Required

será o marketplace + pedido

Lojas Americanas-9999900001

parts

string

Required

possíveis valores

CUSTOMER_SELLER B2W_SELLER

CUSTOMER_SELLER

Responses:

204 - No content

500 - Internal server error

{
"errors": {
"detail": "Error message"
}
}