Ecomplus - Order

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

Eventos Disponíveis

• order.waiting_payment
• order.waiting_payment.boleto
• order.waiting_payment.credit_card
• order.waiting_payment.pix
• order.waiting_payment.deposit
• order.paid
• order.processing
• order.handling
• order.manufacturing
• order.waiting_postage
• order.out_for_delivery
• order.delivered
• order.canceled
• order.refunded
• order.disputed
• order.failed
• order.finalized

Estrutura do Payload

{
  "customer": {
    "id": "CUST-123",
    "name": "João Silva",
    "email": "[email protected]",
    "document": "12345678900",
    "phone_numbers": [
      {
        "formatted_phone": "+5511999999999",
        "type": null,
        "raw_number": "5511999999999",
        "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": "BR",
      "postal_code": "01000-000"
    }
  },
  "order": {
    "id": "ORD-789",
    "status": "paid",
    "raw_status": "paid",
    "created_at": 1705319000,
    "updated_at": 1705319100,
    "paid_at": null,
    "warranty_until": null,
    "canceled_at": null,
    "refunded_at": null
  },
  "checkout": {
    "id": "CART-123",
    "url": "https://loja.ecomplus.com/checkout/abc123"
  },
  "payment": {
    "currency": "BRL",
    "total": 29990,
    "discount_value": 1000,
    "shipping_value": 1500,
    "total_products_value": 29490,
    "payment_method": {
      "type": "credit_card",
      "brand": null,
      "last_digits": null
    },
    "coupons": []
  },
  "shipping": {
    "carrier": "Correios",
    "total_value": 1500,
    "tracking_url": "https://rastreamento.correios.com.br/abc123",
    "tracking_code": "ABC123456789",
    "method": "PAC",
    "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": 5,
    "status": "in_transit",
    "raw_status": "shipped"
  },
  "products": [
    {
      "id": "PROD-456",
      "name": "Produto Exemplo",
      "quantity": 2,
      "unit_value": 14745,
      "total_value": 29490,
      "image_url": "https://cdn.ecomplus.com/img/produto.jpg",
      "type": "product",
      "offer_type": "main"
    }
  ],
  "lead_tracking": {
    "src": null,
    "sck": null,
    "utm_source": "google",
    "utm_campaign": "campanha_verao",
    "utm_medium": "cpc",
    "utm_content": "banner_principal",
    "utm_term": "produto_barato",
    "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	Descrição
id	string | null	ID do cliente
name	string | null	Nome completo do cliente
email	string | null	E-mail do cliente
document	string | null	CPF ou CNPJ do cliente
phone_numbers	Phone[] | null	Coleção de telefones do cliente
address	[CustomerAddress]	Endereço do cliente

CustomerAddress

Endereço do cliente.

Campo	Tipo	Descrição
street	string | null	Nome da rua
number	string | null	Número
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado (sigla)
country	string	Código ISO (sempre BR)
postal_code	string | null	CEP

Phone

Telefone do cliente.

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

---

Order

Campo	Tipo	Descrição
id	string | null	ID do pedido
status	string | null	Status normalizado do pedido
raw_status	string | null	Status original do provider
created_at	integer | null	Timestamp de criação do pedido
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

Status Normalizados (OrderStatus)

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

Valor	Descrição
waiting_payment	Aguardando pagamento
paid	Pago
payment_processing	Processando pagamento
handling	Em preparação
waiting_fulfillment	Aguardando fulfillment
shipped	Enviado
delivered	Entregue
canceled	Cancelado
refunded	Reembolsado
disputed	Em disputa
failed	Falhou
open	Aberto
draft	Rascunho

---

Checkout

Campo	Tipo	Descrição
id	string | null	ID do checkout/carrinho
url	string | null	URL do checkout

---

Payment

Campo	Tipo	Descrição
currency	string | null	Moeda em formato ISO 4217
total	integer | null	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 | null	Valor total dos produtos em centavos
payment_method	object | null	Método de pagamento
coupons	array	Array de cupons (suportado pela Ecomplus)

Métodos de Pagamento

A Ecomplus suporta os seguintes métodos de pagamento. O método retornado depende do tipo de transação no payload.

Credit Card

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] Essa integração não disponibiliza informações de pagamento Cartão de Crédito.

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] Essa integração não disponibiliza informações de pagamento PIX.

Boleto

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

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

Deposit

Campo	Tipo	Descrição
type	string	Sempre deposit

[!NOTE] Essa integração não disponibiliza informações de pagamento Depósito.

Coupon

Campo	Tipo	Descrição
id	null	Sempre null
code	null	Sempre null
value	null	Sempre null
percentage	null	Sempre null
incidence	null	Sempre null
incidence_type	null	Sempre null
expiration_date	null	Sempre null

[!NOTE] A Ecomplus não expõe informações detalhadas de cupons nos webhooks.

---

Shipping

Campo	Tipo	Descrição
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	Código de rastreamento
method	string | null	Nome do método de envio
delivery_address	[DeliveryAddress]	Endereço de entrega
estimated_delivery_date	null	Sempre null
estimated_delivery_time_in_days	integer | null	Tempo estimado de entrega em dias
status	string | null	Status normalizado do envio
raw_status	string | null	Status original do provider

DeliveryAddress

Campo	Tipo	Descrição
street	string | null	Nome da rua
number	string | null	Número
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado (sigla)
country	string	Código ISO (sempre BR)
postal_code	string | null	CEP

Status Normalizados (ShippingStatus)

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

Valor	Descrição
delivered	Entregue
in_transit	Em trânsito
out_for_delivery	Saiu para entrega
returned	Devolvido
canceled	Cancelado
waiting_postage	Aguardando postagem

---

Product

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

---

LeadTracking

Campo	Tipo	Descrição
src	null	Sempre null
sck	null	Sempre null
utm_source	string | null	Fonte da campanha
utm_campaign	string | null	Nome da campanha
utm_medium	string | null	Meio da campanha
utm_content	string | null	Conteúdo da campanha
utm_term	string | null	Termo da campanha
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

---

Voltar para visão geral da integração