Registrar endpoint do webhook

Este é o recurso responsável por registrar o webhook do usuário. É através desse endereço que serão enviadas as informações quando um pedido for efetuado.

Iniciando a sessão

Altere o método da requisição para o tipo POST.

Configurando a URL da requisição

Nesse caso, devemos configurar a URL no endpoint /integrator/api/v1/orders/register-webhook/

Configurando a aba Authorization

Na aba Authorization altere o Type para Bearer Token.

Inserindo o token de autorização

Insira seu token de autorização (obtido aqui) e clique em Send.

Inserção dos campos de registro do webhook

Insira os dados de registro do webhook na aba Body>raw e clique em Send para registrar sua chave webhook.

Modelo de envio dos dados:

{
    "url":"https://google.com.br",
    "token": "minha-chave-webhook",
    "label": "authtoken"
}

Observação de cada campo e os tipos de dados aceitos em cada um:

CAMPO	TIPO	OBSERVAÇÃO
url	string
token	string	Chave cadastrada pelo usuário para garantir a autenticidade dos dados retornados
label	string

Retorno de dados via Webhook

Header do retorno via webhook

{"content-type": "application/json", "authtoken": "minha-chave-webhook"}

Corpo do retorno recebido via webhook

{
   "order_id":"1492114",
   "distributor_cnpj":"23.460.076/0001-03",
   "trade_representative_code":"None",
   "order_status_code":"1",
   "created_at":"2022-02-07T14:04:49.218451-03:00",
   "payment":{
      "description":"Garantia CotaBest",
      "method_id":100,
      "method_name":"Garantia CotaBest",
      "payment_terms":30
   },
   "customer":{
      "user":{
         "id":"6075978",
         "name":"Cliente Teste",
         "email":"teste@email.com",
         "cpf":"000.000.000-00",
         "contact":{
            "email":"teste@email.com",
            "phone":"(19) 99999-9999",
            "phone_alternative":"None"
         },
         "address":{
            "street":"Rua 1",
            "number":"123",
            "complement":"None",
            "district":"Parque Mambucaba (Mambucaba)",
            "complementary_info":"",
            "delivery_preferences":{
               "evening":"False",
               "morning":"True",
               "time_end":"",
               "afternoon":"False",
               "time_start":""
            },
            "cep":"68905-810",
            "city":"Oiapoque",
            "state":"AP"
         }
      }
   },
   "order_detail":{
      "products":[
         {
            "sequence":1,
            "product_id":"xpto",
            "name":"Pirulito de princesa (caixa com 10)",
            "brand":"Kiss",
            "stock_unit":"caixa",
            "count":"2.00",
            "price":"10.00",
            "total":"20.00"
         }
      ],
      "delivery_tax":"0.00",
      "total":"20.00",
      "base_total":"0.00"
   },
   "messages":[
      {
         "sent_on":"2022-02-07T14:04:49.215332-03:00",
         "content":"Pedido enviado, aguardando confirmação de pagamento."
      }
   ]
}

Erros que podem ser retornados

STATUS	CONTEÚDO	DESCRIÇÃO
403	{"error": true, "detail": "Webhook already exists."}	Usuário já possui um webhook cadastrado