Irroba - Order

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

Eventos Disponíveis

• order.paid
• order.canceled
• order.processing
• order.returned
• order.waiting_payment

Estrutura do Payload

{
  "order_id": "12345",
  "status": "approved",
  "date_added": 1705319000,
  "date_modified": 1705319100,
  "items": [
    {
      "name": "Produto Exemplo",
      "quantity": 1,
      "price": 9970,
      "total": 9970
    }
  ],
  "payment_type": "pix",
  "total": 9970,
  "products_total": 9970,
  "discount_total": 0,
  "shipping_total": 0,
  "billet_url": "https://irroba.com.br/boleto/abc123",
  "billet_line": "00000000000000000000000000000000000000000000000",
  "billet_due_date": "2024-01-15",
  "customer": {
    "name": "João Silva",
    "email": "[email protected]",
    "cellphone": "5511999999999",
    "telephone": null
  },
  "billing": {
    "street": "Rua Principal",
    "number": "123",
    "complement": "Apto 45",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "postcode": "01000-000"
  },
  "shipping": {
    "tracking_code": "AB123456789CD",
    "tracking_url": "https://rastreio.irroba.com.br/AB123456789CD",
    "tracking_method": "PAC",
    "shipping_total": 2000,
    "street": "Rua Principal",
    "number": "123",
    "complement": "Apto 45",
    "neighborhood": "Centro",
    "city": "São Paulo",
    "state": "SP",
    "country": "BR",
    "postcode": "01000-000"
  },
  "store_url": "https://loja.irroba.com.br"
}

---

Componentes do Payload

Customer

Campo	Tipo	Descrição
id	null	Sempre null
name	string | null	Nome do cliente
email	string | null	E-mail do cliente
document	null	Sempre null
phone_numbers	Collection	Coleção de telefones
address	Address	Endereço de cobrança

Telefone

Campo	Tipo	Descrição
formatted_phone	string | null	Telefone formatado
type	null	Sempre null
raw_number	string | null	Número bruto
area_code	null	Sempre null
international_dialing_code	null	Sempre null

Endereço

Campo	Tipo	Descrição
street	string | null	Rua
number	string | null	Número
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado
country	string | null	País
postal_code	string | null	CEP

---

Order

Campo	Tipo	Descrição
id	string | null	ID do pedido
status	string	Status normalizado do pedido
created_at	integer | null	Timestamp de criação
updated_at	integer | null	Timestamp de atualização
paid_at	null	Sempre null
warranty_until	null	Sempre null
canceled_at	null	Sempre null
refunded_at	null	Sempre null
raw_status	string | null	Status original do provider

Status Normalizados (OrderStatus)

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

Valor	Descrição
paid	Pago
refunded	Reembolsado
waiting_payment	Aguardando pagamento
payment_processing	Processando pagamento
canceled	Cancelado

---

Payment

Campo	Tipo	Descrição
currency	string	Sempre BRL
total	integer	Valor total (em centavos)
discount_value	integer | null	Valor do desconto (em centavos)
shipping_value	integer | null	Valor do frete (em centavos)
total_products_value	integer	Valor total dos produtos (em centavos)
payment_method	PaymentMethod	Método de pagamento
coupons	Collection	Coleção de cupons (vazia)

Métodos de Pagamento (PaymentMethod)

A Irroba retorna os seguintes métodos de pagamento:

Valor	Descrição
pix	PIX
boleto	Boleto Bancário
credit_card	Cartão de Crédito
debit_card	Cartão de Débito
deposit	Depósito

---

Product

Campo	Tipo	Descrição
id	null	Sempre null
name	string | null	Nome do produto
quantity	integer	Quantidade
unit_value	integer	Valor unitário (em centavos)
total_value	integer	Valor total (em centavos)
image_url	null	Sempre null
type	string	Sempre product
offer_type	string	Sempre main

---

Checkout

Campo	Tipo	Descrição
id	null	Sempre null
url	string | null	URL da loja

---

Shipping

Campo	Tipo	Descrição
carrier	null	Sempre null
total_value	integer | null	Valor do frete (em centavos)
tracking_url	string | null	URL de rastreamento
tracking_code	string | null	Código de rastreamento
method	string | null	Método de envio
delivery_address	Address	Endereço de entrega
estimated_delivery_date	null	Sempre null
estimated_delivery_time_in_days	null	Sempre null
raw_status	string | null	Status original do provider
status	string | null	Status normalizado do envio

Status Normalizados (ShippingStatus)

A Irroba retorna os seguintes valores normalizados para o status do envio:

Valor	Descrição
delivered	Entregue
in_transit	Em trânsito
fulfilled	Despachado
withdrawal_available	Disponível para retirada
returned	Devolvido

Endereço de Entrega

Campo	Tipo	Descrição
street	string | null	Rua
number	string | null	Número
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado
country	string | null	País
postal_code	string | null	CEP

---

Lead Tracking

Este componente nunca possui dados úteis na Irroba. Todos os campos retornam null.

Campo	Tipo	Descrição
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] Essa integração não disponibiliza informações de lead tracking.

---

Voltar para visão geral da integração