Webhooks

Os webhooks permitem que você obtenha notificações programáticas em tempo real sobre alterações em seus dados à medida que elas acontecem. Em vez de extrair informações por meio de nossa API, os webhooks enviarão informações ao seu endpoint.

Pedidos

Resposta:

{
  "data": {
    "domain": "order.order",
    "status": "approved",
    "delivery_type": "eu_preciso_entregas",
    "order_id": "6712a764c37c38e9039093e4",
    "created_at": "2024-11-15T14:25:37Z",
    "delivery_id": "6712a312c37c38e9038fd9b6"
  }
}

{
  "data": {
    "domain": "order.order",
    "status": "finished",
    "order_id": "6712a764c37c38e9039093e4",
    "finished_at": "2024-11-19T14:25:37Z"
  }
}

Entregas (Eu Preciso Entregas)

Resposta:

{
  "data": {
    "domain": "order.delivery",
    "status": "created",
    "order_id": "6712a764c37c38e9039093e4",
    "delivery_id": "6712a312c37c38e9038fd9b6",
    "label_id": "f7b3b2b4-4b7d-4b7d-8b7d-4b7d8b7d8b7d",
    "created_at": "2024-11-15T14:25:37Z",
    "url": "https://www.eupreciso.com.br/minhasvendas/pedido/6712a764c37c38e9039093e4/imprimir",
    "invoice": {
      "key": "35191012345678000155550010000000012345678903",
      "issued_at": "2024-07-22T15:23:17.000Z",
      "xml": "<xml>...</xml>",
      "status": "approved"
    },
    "pickup_company": {
      "id": 1529,
      "name": "[DROPIT] - MaxTools Ferramentas - Ponto de Coleta",
      "initials": "SP",
      "address": {
        "street": "Rua dos Bolos",
        "number": "0",
        "complement": "Sala 101",
        "neighborhood": "Centro",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR",
        "zip_code": "01005-000",
        "latitude": -23.5505199,
        "longitude": -46.6333094
      }
    },
    "files": {
      "pdf": "https://example-bucket.s3.amazonaws.com/pdf/example-pdf-1.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLECREDENTIAL%2F20241027%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20241027T161017Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=example-signature-1",
      "zpl": "https://example-bucket.s3.amazonaws.com/zpl/example-zpl-1.zpl?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLECREDENTIAL%2F20241027%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20241027T161017Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=example-signature-2",
      "jpeg": "https://example-bucket.s3.amazonaws.com/example-jpeg-1.jpeg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=EXAMPLECREDENTIAL%2F20241027%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20241027T161017Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=example-signature-3"
    },
    "tracking_number": "1234567890",
    "melhor_envio_tracking": "ME1234567890"
  }
}

{
  "data": {
    "domain": "order.delivery",
    "status": "received",
    "order_id": "6712a764c37c38e9039093e4",
    "delivery_id": "6712a312c37c38e9038fd9b6",
    "received_at": "2024-11-15T14:25:37Z"
  }
}

{
  "data": {
    "domain": "order.delivery",
    "status": "posted",
    "order_id": "6712a764c37c38e9039093e4",
    "delivery_id": "6712a312c37c38e9038fd9b6",
    "posted_at": "2024-11-16T14:25:37Z"
  }
}

{
  "data": {
    "domain": "order.delivery",
    "status": "delivered",
    "order_id": "6712a764c37c38e9039093e4",
    "delivery_id": "6712a312c37c38e9038fd9b6",
    "delivered_at": "2024-11-17T14:25:37Z"
  }
}

Envios (Entrega a combinar)

{
  "data": {
    "domain": "order.shipping",
    "status": "shipped",
    "order_id": "6712a764c37c38e9039093e4",
    "delivery_id": "6712a312c37c38e9038fd9b6",
    "tracking_url": "http://url.de.acompanhamento.da.entrega/",
    "protocol": "000111222",
    "label": "000111222",
    "dates": {
      "estimated_delivery": "2024-12-22T13:06:28.000Z",
      "shipped": "2024-12-18T13:06:28.000Z"
    },
    "carrier": {
      "name": "Nome da transportadora"
    }
  }
}

{
  "data": {
    "domain": "order.shipping",
    "status": "delivered",
    "order_id": "6712a764c37c38e9039093e4",
    "delivery_id": "6712a312c37c38e9038fd9b6",
    "delivered_at": "2024-12-22T13:06:28.000Z"
  }
}

Marcar um pedido como entregue Introdução