Bling - Order

Eventos da família order.* na integracao Bling.

Eventos Disponiveis

Evento	Descricao
order.draft	Rascunho (Em digitacao)
order.open	Aberto (Em aberto)
order.waiting_delivery	Aguardando entrega (Em andamento)
order.completed	Completo (Atendido)
order.canceled	Cancelado
order.custom	Status customizado

[!NOTE] O driver Bling nao gera eventos para order.paid, order.refunded, order.disputed, etc. O Bling nao fornece informacao sobre o status de pagamento.

Estrutura do Payload

{
  "customer": {
    "id": "123456",
    "name": "João Silva",
    "email": "[email protected]",
    "document": "12345678900",
    "phone_numbers": [
      {
        "formatted_phone": "+5511999999999",
        "type": null,
        "raw_number": "999999999",
        "area_code": "11",
        "international_dialing_code": "55"
      }
    ],
    "address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": "Apto 45",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "postal_code": "01000-000"
    }
  },
  "order": {
    "id": "456789",
    "status": "open",
    "raw_status": "2",
    "created_at": 1705319000,
    "paid_at": null,
    "updated_at": null,
    "warranty_until": null,
    "canceled_at": null,
    "refunded_at": null
  },
  "checkout": {
    "id": null,
    "url": null
  },
  "payment": {
    "currency": "BRL",
    "total": 29900,
    "discount_value": 500,
    "shipping_value": 1500,
    "total_products_value": 28900,
    "payment_method": null,
    "coupons": []
  },
  "shipping": {
    "carrier": null,
    "total_value": 1500,
    "tracking_url": null,
    "tracking_code": null,
    "method": null,
    "delivery_address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": "Apto 45",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "country": "BR",
      "postal_code": "01000-000"
    },
    "estimated_delivery_date": null,
    "estimated_delivery_time_in_days": null,
    "status": null,
    "raw_status": null
  },
  "products": [
    {
      "id": "prod_123",
      "name": "Produto Exemplo",
      "type": "product",
      "quantity": 1,
      "unit_value": 28900,
      "total_value": 28900,
      "image_url": null,
      "offer_type": "main"
    }
  ],
  "lead_tracking": {
    "src": null,
    "sck": null,
    "utm_source": null,
    "utm_campaign": null,
    "utm_medium": null,
    "utm_content": null,
    "utm_term": null,
    "utm_id": null,
    "meta_fbp": null,
    "google_ga_id": null,
    "google_gclid": null,
    "google_gclsrc": null,
    "google_dclid": null,
    "google_gbraid": null,
    "google_wbraid": null,
    "tiktok_ttlid": null,
    "ip": null
  }
}

---

Componentes do Payload

Customer

Campo	Tipo	Descricao
id	string | null	ID do cliente
name	string | null	Nome do cliente
email	string | null	E-mail do cliente
document	string | null	Documento (CPF/CNPJ)
phone_numbers	array	Lista de telefones
address	object	Endereco

Phone Numbers

Campo	Tipo	Descricao
formatted_phone	string | null	Telefone formatado em E.164
type	null	Sempre null
raw_number	string | null	Numero sem formatacao
area_code	null	Sempre null
international_dialing_code	null	Sempre null

Address

Campo	Tipo	Descricao
street	string | null	Nome da rua
number	string | null	Numero
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado (sigla)
country	string | null	Nome do pais
postal_code	string | null	CEP

---

Order

Campo	Tipo	Descricao
id	string | null	ID do pedido
status	string | null	Status normalizado
raw_status	string | null	ID do status original do Bling
created_at	integer | null	Timestamp de criacao
paid_at	null	Sempre null
updated_at	null	Sempre null
warranty_until	null	Sempre null
canceled_at	null	Sempre null
refunded_at	null	Sempre null

Status Normalizados (OrderStatus)

A Bling retorna os seguintes valores normalizados para o status do pedido:

Valor	Descricao
draft	Rascunho (Em digitacao)
open	Aberto (Em aberto)
waiting_delivery	Aguardando entrega (Em andamento)
completed	Completo (Atendido)
canceled	Cancelado

---

Checkout

O Checkout do Bling sempre retorna null para todos os campos, pois o Bling não fornece dados de checkout.

Campo	Tipo	Descrição
id	null	Sempre null
url	null	Sempre null

[!NOTE] Essa integração não disponibiliza informações de checkout.

---

Payment

Campo	Tipo	Descricao
currency	BRL	Moeda (sempre BRL)
total	int | null	Valor total do pedido/empresa
discount_value	int | null	Valor do desconto (pode ser null se em %)
shipping_value	int | null	Valor do frete
payment_method	PaymentMethod | null	Metodo de pagamento utilizado
coupons	Collection	Colecao vazia (nao ha suporte a cupons)
total_products_value	int | null	Soma dos valores totais dos produtos

PaymentMethod

O tipo de pagamento é identificado pelo campo tipoPagamento da API Bling e mapeado para as seguintes classes:

tipoPagamento	Enum	Classe
1	cash	Cash
2	cheque	Cheque
3	credit_card	CreditCard
4	debit_card	DebitCard
5	store_card	CreditCard
10-13	vale_*	Voucher
14	duplicata_mercantil	null (não suportado)
15	boleto	Boleto
16	deposit	Deposit
17	pix_dynamic	Pix
18	transfer	Deposit
19	cashback	null (não suportado)
20	pix_static	Pix
21	store_credit	null (não suportado)
22	uninformed_electronic_payment	null (não suportado)
90	no_payment	null (não suportado)
99	others	null (não suportado)

Subcomponentes de PaymentMethod

Pix

Campo	Tipo	Descrição
type	string	Sempre pix
qrcode_url	null	Sempre null
qrcode_signature	null	Sempre null
expiration_date	null	Sempre null
pix_key	null	Sempre null
pix_key_type	null	Sempre null

[!NOTE] O driver Bling nao captura dados do Pix. Todos os campos sao sempre null.

Boleto

Campo	Tipo	Descrição
type	string	Sempre boleto
digitable_line	null	Sempre null
url	null	Sempre null
expiration_date	null	Sempre null

[!NOTE] O driver Bling nao captura dados do boleto. Todos os campos sao sempre null.

CreditCard

Campo	Tipo	Descrição
type	string	Sempre credit_card
brand	null	Sempre null
last_digits	null	Sempre null
expiration_month	null	Sempre null
expiration_year	null	Sempre null

[!NOTE] O driver Bling nao captura dados do cartao de credito. Todos os campos sao sempre null.

DebitCard

Campo	Tipo	Descrição
type	string	Sempre debit_card
brand	null	Sempre null
last_digits	null	Sempre null
expiration_month	null	Sempre null
expiration_year	null	Sempre null

[!NOTE] O driver Bling nao captura dados do cartao de debito. Todos os campos sao sempre null.

Deposit

Campo	Tipo	Descrição
type	string	Sempre deposit

[!NOTE] O driver Bling nao captura dados adicionais do deposito. Este componente nao possui campos alem do schema base.

Cash

Campo	Tipo	Descrição
type	string	Sempre cash

[!NOTE] O driver Bling nao captura dados adicionais de dinheiro. Este componente nao possui campos alem do schema base.

Cheque

Campo	Tipo	Descrição
type	string	Sempre cheque

[!NOTE] O driver Bling nao captura dados adicionais de cheque. Este componente nao possui campos alem do schema base.

Voucher

Campo	Tipo	Descrição
type	string	Sempre voucher

[!NOTE] O driver Bling nao captura dados adicionais de voucher. Este componente nao possui campos alem do schema base.

O voucher é utilizado para os seguintes tipos de pagamento:

• Vale Alimentação
• Vale Refeição
• Vale Presente
• Vale Combustível

---

Shipping

Campo	Tipo	Descricao
carrier	string | null	Nome da transportadora
total_value	integer | null	Valor do frete em centavos
tracking_url	string | null	URL de rastreamento
tracking_code	string | null	Codigo de rastreamento
method	string | null	Metodo de envio
delivery_address	object	Endereco de entrega
estimated_delivery_date	null	Sempre null
estimated_delivery_time_in_days	integer | null	Tempo estimado em dias
status	string | null	Status normalizado
raw_status	string | null	ID do status de rastreamento do Bling

Delivery Address

Campo	Tipo	Descricao
street	string | null	Nome da rua
number	string | null	Numero
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado (sigla)
country	string | null	Nome do pais
postal_code	string | null	CEP

Status Normalizados (ShippingStatus)

A Bling retorna os seguintes valores normalizados para o status de rastreamento:

Valor	Descricao
waiting_postage	Aguardando postagem (Postado/Etiqueta comprada/Vinculado)
in_transit	Em transito (Em andamento)
delivered	Entregue
withdrawal_available	Disponivel para retirada (Aguardando retirada)
delayed	Atrasado
not_delivered	Não entregue
canceled	Cancelado (Entrega suspensa)

---

Product

Campo	Tipo	Descricao
id	string | null	ID do produto (busca em produto.id, id, codigo)
name	string | null	Nome (busca em descricao, descricaoDetalhada)
quantity	int | null	Quantidade no pedido
unit_value	int | null	Valor unitario em centavos
total_value	int | null	Valor total (quantidade x valor unitario)
image_url	null	Sempre null
type	string	Sempre product
offer_type	string	Sempre main

Mapeamento de IDs

O campo id e buscado na seguinte ordem de precedencia:

1. produto.id
2. id
3. codigo

Calculo de Valor Total

O total_value e calculado da seguinte forma:

• Se valorTotal estiver disponivel, usa diretamente
• Caso contrario: unit_value x max(1, quantity)

Schema

{
  "codigo": ["string", "null"],
  "id": ["number", "string", "null"],
  "quantidade": ["integer", "number", "string", "null"],
  "valor": ["number", "string", "null"],
  "descricao": ["string", "null"],
  "descricaoDetalhada": ["string", "null"],
  "valorTotal": ["number", "string", "null"],
  "produto": {
    "id": ["number", "string", "null"]
  }
}

---

LeadTracking

Campo	Tipo	Descricao
src	null	Sempre null
sck	null	Sempre null
utm_source	null	Sempre null
utm_campaign	null	Sempre null
utm_medium	null	Sempre null
utm_content	null	Sempre null
utm_term	null	Sempre null
utm_id	null	Sempre null
meta_fbp	null	Sempre null
google_ga_id	null	Sempre null
google_gclid	null	Sempre null
google_gclsrc	null	Sempre null
google_dclid	null	Sempre null
google_gbraid	null	Sempre null
google_wbraid	null	Sempre null
tiktok_ttlid	null	Sempre null
ip	null	Sempre null

[!NOTE] O driver Bling nao captura dados de rastreamento de marketing. Todos os campos sao sempre null.

---

Voltar para visão geral da integração