Webhook - API Lojaz Delivery

POST

Criar Webhook

PATH

{{BASE_URL}}/stores/:storeId/webhooks/create

Path Params

storeId: Id da loja

Headers

Authorization: Bearer Token

Body

{
  "events": [
    "ORDER_ACCEPTED",
    "ORDER_UPDATED",
    "ORDER_CANCELED",
    "ORDER_DELIVERY_PICKEDUP",
    "ORDER_WAITING_CODE",
    "ORDER_COMPLETED"
  ],
  "payload": {
    "url": "SUA URL",
    "method": "MÉTODO DA SUA URL",
    "headers": {}
  }
}

Content-Type: application/json

Nota: Headers pode ser um objeto vazio, mas recomendamos que você insira uma chave de segurança para validar a autenticidade

Você pode ver todos os eventos na aba Schemas - Eventos do Webhook

Dados enviados pelo Webhook

{
  "event": "EVENTO",
  "data": {
    "vehicle": {},
    "client": {
      "name": "Weslley",
      "phoneNumber": "2323213"
    },
    "store": {
      "id": "66f2a7db0456e0cd32d76c86",
      "name": "Lojaz"
    },
    "delivery": {
      "id": "669825c680174b306975b81c",
      "name": "Weslley 2",
      "phoneNumber": "21965442033",
      "picture": "file-1721248252335-782737516.jpg"
    },
    "address": {
      "store": {
        "street": "Rua Teste42421",
        "number": "24",
        "postalCode": "21320050",
        "lat": "-22.89795089546706",
        "long": "-43.34423633554419"
      },
      "customer": {
        "street": "Rua Teste 455",
        "number": "24",
        "postalCode": "21320050",
        "lat": "-22.89795089546706",
        "long": "-43.34423633554419"
      }
    },
    "_id": "66f317750fe6a05125ee802b",
    "referenceId": null,
    "code": "122683",
    "storeId": "66f2a7db0456e0cd32d76c86",
    "storeName": "Lojaz",
    "uuid": "762680e8-8f5a-42eb-aa7f-ee7637d38dca",
    "trackCode": "LOJAZ21724540BR8895",
    "observation": "TEste",
    "cancellationType": null,
    "items": [
      {
        "name": "Camisa",
        "quantity": 1,
        "price": {
          "$numberDecimal": "1.59"
        },
        "weight": 100,
        "_id": "66f317750fe6a05125ee802c"
      }
    ],
    "attempts": 39,
    "type": "default",
    "status": "PENDING <- 1 Anterior (Leve em consideração apenas o EVENTO ao invés deste campo )",
    "lastMovimentationAt": "2024-09-24T19:48:01.139Z",
    "createdAt": "2024-09-24T19:48:01.139Z",
    "updatedAt": "2024-09-24T19:48:01.139Z",
    "__v": 0
  }
}

Content-Type: application/json

Response - OK (200)

{
  "status": true,
  "message": "Webhook criado com sucesso",
  "data": {
    "storeId": "66f2a7db0456e0cd32d76c86",
    "events": [
      "ORDER_CREATED"
    ],
    "payload": {
      "url": "WEBHOOK TEST SITE",
      "method": "POST",
      "headers": {}
    },
    "_id": "66f3087889f0948e00fca07a",
    "__v": 0
  }
}

Content-Type: application/json