Bagy - Order

Eventos da família order.* na integração Bagy.

Eventos Disponiveis

Evento	Descricao
order.paid	Pagamento aprovado
order.waiting_payment.pix	Aguardando pagamento PIX
order.waiting_payment.boleto	Aguardando pagamento Boleto
order.waiting_payment.credit_card	Aguardando pagamento Cartão
order.waiting_payment.deposit	Aguardando pagamento Deposito
order.waiting_payment.none	Aguardando pagamento sem metodo
order.manufacturing	Em producao
order.completed	Pedido atendido
order.canceled	Pedido cancelado
order.refunded	Pedido reembolsado
order.disputed	Em disputa (chargeback)
order.failed	Pagamento recusado
order.expired	Pagamento expirado

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": null,
        "international_dialing_code": null
      }
    ],
    "address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": "Apto 45",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "country": null,
      "postal_code": "01000-000"
    }
  },
  "order": {
    "id": "789012",
    "status": "paid",
    "raw_status": "approved",
    "created_at": 1705319000,
    "updated_at": 1705319100,
    "paid_at": 1705319100,
    "warranty_until": null,
    "canceled_at": null,
    "refunded_at": null
  },
  "checkout": {
    "id": null,
    "url": null
  },
  "payment": {
    "currency": "BRL",
    "total": 29900,
    "total_products_value": 27900,
    "discount_value": 0,
    "shipping_value": 2000,
    "payment_method": {
      "type": "pix",
      "qrcode_url": null,
      "qrcode_signature": null,
      "expiration_date": null,
      "pix_key": null,
      "pix_key_type": null
    },
    "coupons": []
  },
  "shipping": {
    "carrier": "Correios",
    "total_value": 2000,
    "tracking_url": "https://rastreio.correios.com.br/...",
    "tracking_code": "AB123456789CD",
    "method": "PAC",
    "delivery_address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": "Apto 45",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "country": null,
      "postal_code": "01000-000"
    },
    "estimated_delivery_date": 1705916400,
    "estimated_delivery_time_in_days": 5,
    "status": null,
    "raw_status": null
  },
  "products": [
    {
      "id": "prod_456",
      "name": "Produto Exemplo",
      "type": "product",
      "quantity": 1,
      "unit_value": 27900,
      "total_value": 27900,
      "image_url": "https://example.com/product.jpg",
      "offer_type": "main"
    }
  ],
  "lead_tracking": {
    "src": null,
    "sck": null,
    "utm_source": "facebook",
    "utm_campaign": "black_friday",
    "utm_medium": "cpc",
    "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": "189.123.45.67"
  }
}

---

Componentes do Payload

Customer

Campo	Tipo	Descricao
id	string | null	ID do cliente
name	string | null	Nome completo
email	string | null	E-mail do cliente
document	string | null	CPF ou CNPJ (busca em doc e cgc)
phone_numbers	Phone[] | null	Colecao de telefones do cliente
address	Address	Endereco do cliente

Address

Campo	Tipo	Descricao
street	string | null	Logradouro
number	string | null	Numero
complement	string | null	Complemento (detail)
neighborhood	string | null	Bairro (district)
city	string | null	Cidade
state	string | null	Estado/UF
country	null	Sempre null
postal_code	string | null	CEP (zipcode)

Phone

Telefone do cliente.

Campo	Tipo	Descrição
formatted_phone	string | null	Telefone formatado em E.164
type	null	Sempre null
raw_number	string | null	Número sem formatação
area_code	null	Sempre null
international_dialing_code	null	Sempre null

---

Order

Campo	Tipo	Descrição
id	string | null	ID do pedido
status	string | null	Status normalizado do pedido
raw_status	string | null	Status de pagamento original
created_at	Carbon | null	Data de criação
updated_at	Carbon | null	Data de última atualização
paid_at	Carbon | null	Data de pagamento processado
warranty_until	null	Sempre null
canceled_at	Carbon | null	Data de cancelamento
refunded_at	null	Sempre null

Status Normalizados (OrderStatus)

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

Valor	Descrição
paid	Pagamento aprovado
completed	Pedido completado
canceled	Pedido cancelado
waiting_payment	Aguardando pagamento
refunded	Pedido reembolsado
disputed	Em disputa (chargeback)
failed	Pagamento recusado
expired	Pagamento expirado
abandoned	Checkout abandonado

---

Checkout

Campo	Tipo	Descricao
id	null	Sempre null - Bagy nao fornece ID
url	string | null	URL do checkout

---

Payment

Campo	Tipo	Descrição
currency	BRL	Moeda (sempre BRL)
total	int | null	Valor total do pedido
total_products_value	int | null	Valor total dos produtos
discount_value	int | null	Valor do desconto
shipping_value	int | null	Valor do frete
payment_method	PaymentMethod | null	Método de pagamento utilizado
coupons	Collection	Coleção de cupons aplicados

PaymentMethod

O tipo de pagamento é identificado pelo campo data.payment.method:

method	Classe
pix	Pix
billet	Boleto
credit_card	CreditCard
manual (PIX)	Pix
manual (CC)	CreditCard
manual (Boleto)	Boleto
manual (Deposito)	Deposit

Pix

import Pix from ”../../../../events/components/subcomponents/payment-methods/pix.md”;

Boleto

import Boleto from ”../../../../events/components/subcomponents/payment-methods/boleto.md”;

CreditCard

import CreditCard from ”../../../../events/components/subcomponents/payment-methods/credit-card.md”;

Deposit

Campo	Tipo	Descricao
type	string	Sempre deposit

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

---

Shipping

Campo	Tipo	Descricao
carrier	string | null	Nome da transportadora
total_value	int | null	Valor do frete
tracking_url	string | null	URL de rastreamento
tracking_code	string | null	Codigo de rastreamento
method	string | null	Nome do servico de entrega
delivery_address	Address	Endereco de entrega
estimated_delivery_date	Carbon | null	Data estimada de entrega
estimated_delivery_time_in_days	int | null	Tempo estimado de entrega em dias
status	string | null	Status normalizado do envio
raw_status	string | null	Status original do envio

DeliveryAddress

Campo	Tipo	Descricao
street	string | null	Logradouro
number	string | null	Numero
complement	string | null	Complemento (detail)
neighborhood	string | null	Bairro (district)
city	string | null	Cidade
state	string | null	Estado/UF
country	null	Sempre null
postal_code	string | null	CEP (zipcode)

---

Product

Campo	Tipo	Descricao
id	string | null	ID do produto
name	string | null	Nome do produto
quantity	int	Quantidade
unit_value	int | null	Valor unitario
total_value	int | null	Valor total
image_url	string | null	URL da imagem do produto
type	string	Sempre product
offer_type	string	Sempre main

---

LeadTracking

Campo	Tipo	Descricao
src	null	Sempre null
sck	null	Sempre null
utm_source	string | null	UTM source (data.extra.utm.utm_source)
utm_campaign	string | null	UTM campaign (data.extra.utm.utm_campaign)
utm_medium	string | null	UTM medium (data.extra.utm.utm_medium)
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	string | null	IP do cliente (data.extra.customer_ip)

---

Voltar para visão geral da integração