Payload Example

This document shows example of our webhooks payload for various events.

The following is the examples of the content of data field in a webhook event.

order.created, order.epayment_created, order.spam_created, order.updated

{
  "order_id": "250130JQHFZG",
  "secret_slug": "WjCc_Jk-EK2F8xLCseNKfjFIaESbm9-W2RZvRaas",
  "status": "pending",
  "is_probably_spam": true,
  "mark_as_spam_by": "ai",
  "draft_time": "2025-01-29T20:28:08Z",
  "pending_time": "2025-01-29T20:28:08Z",
  "confirmed_time": null,
  "in_process_time": null,
  "ready_time": null,
  "shipped_time": null,
  "completed_time": null,
  "rts_time": null,
  "canceled_time": null,
  "closed_time": null,
  "payment_status": "unpaid",
  "unpaid_time": "2025-01-29T20:28:08Z",
  "paid_time": null,
  "conflict_time": null,
  "settled_time": null,
  "business": {
    "username": "username",
    "client_id": "41750fd8-e7e2-4887-b348-04c01a547ae0"
  },
  "store": {
    "name": "Example Store"
  },
  "epayment_provider": null,
  "payment_method": "bank_transfer",
  "sub_payment_method": null,
  "financial_entity": {
    "code": "bni",
    "name": "Bank Negara Indonesia"
  },
  "payment_account_holder": "Unreal Person",
  "payment_account_number": "1234567812345678",
  "transferproof_url": "https://cdn.scalev.id/Image/dGONXQPPK_hDCrEL3lfEnOQoPOBwuRUZUUyjxreQCzQ/1738182480347-milkbox.webp",
  "transfer_time": null,
  "final_variants": {
    "Amazing Product": 1
  },
  "total_quantity": 1,
  "gross_revenue": "168724.00",
  "unique_code_discount": "276.00",
  "discount_code_discount": "0.00",
  "net_revenue": "149724.00",
  "product_price": "150000.00",
  "product_discount": "0.00",
  "other_income_name": "Biaya Lainnya",
  "other_income": "0.00",
  "discount_rate": "0.00",
  "cogs": "45095.00",
  "shipping_cost": "19000.00",
  "shipping_discount": "0.00",
  "payment_fee": "0.00",
  "customer_id": 28024,
  "destination_address": {
    "name": "Example Person",
    "phone": "628112345678",
    "email": "[email protected]",
    "address": "This is not a real address.",
    "subdistrict": "Gayungan",
    "city": "Kota Surabaya",
    "province": "Jawa Timur",
    "postal_code": null,
    "notes": ""
  },
  "origin_address": {
    "address": "This is not a real address.",
    "subdistrict": "Gunung Jati (Cirebon Utara)",
    "city": "Kabupaten Cirebon",
    "province": "Jawa Barat",
    "postal_code": "45151"
  },
  "warehouse": {
    "name": "Example Warehouse",
    "unique_id": "warehouse_FN9odhpi1VOF7FLxMhtiWdJo"
  },
  "product_weight": 500,
  "weight_bump": 0,
  "total_weight": 500,
  "courier_service": {
    "courier": {
      "name": "Ninja Xpress",
      "code": "ninja"
    },
    "name": "Standard",
    "code": "STANDARD"
  },
  "courier_aggregator_code": null,
  "rtsproof_url": null,
  "shipment_receipt": null,
  "shipment_status": null,
  "awb_status": "unavailable",
  "awb_ca_status": "unavailable",
  "notes": "Example notes.",
  "tags": [],
  "orderlines": [
    {
      "quantity": 1,
      "is_inventory": false,
      "weight": 500,
      "product_name": "Amazing Product",
      "variant_unique_id": "variant_Wifko5BIJbnQoo9LPAiJ63Kv",
      "variant_sku": "BCF009",
      "variant_price": "150000.00",
      "variant_cogs": "45095.00",
      "product_price": "150000.00",
      "discount": "0.00",
      "discount_code_discount": "0.00",
      "cogs": "45095.00"
    }
  ],
  "created_at": "2025-01-29T20:28:08Z",
  "last_updated_at": "2025-01-29T20:28:08Z"
}

order.deleted

{
  "order_id": "250128GGVOWU",
  "created_at": "2025-01-28T16:24:44Z",
  "last_updated_at": "2025-01-28T16:28:06Z"
}

order.payment_status_changed

{
  "id": 1,
  "order_id": "250128GGVOWU",
  "business": {},
  "is_probably_spam": false,
  "mark_as_spam_by": null,
  "created_at": "2025-01-28T16:24:44Z",
  "last_updated_at": "2025-01-28T16:27:46Z",
  "payment_status": "paid",
  "payment_account_id": 1,
  "epayment_provider": null,
  "payment_method": "bank_transfer",
  "sub_payment_method": null,
  "financial_entity": {
    "code": "bni",
    "name": "Bank Negara Indonesia"
  },
  "payment_account_holder": "Test Account",
  "payment_account_number": "12345",
  "transferproof_url": "",
  "pg_payment_info": null,
  "pg_reference_id": null,
	"pg_paid_info": null,
  "unpaid_time": "2025-01-28T16:27:46Z",
  "paid_time": "2025-01-28T16:27:14Z",
  "conflict_time": null,
  "settled_time": null,
  "transfer_time": "2025-01-27T17:00:00Z",
  "payment_status_history": [
    {
      "at": "2025-01-28T16:27:46Z",
      "by": {
        "avatar": "",
        "email": "[email protected]",
        "name": "User Testing"
      },
      "status": "unpaid"
    },
    {
      "at": "2025-01-28T16:27:14Z",
      "by": {
        "avatar": "",
        "email": "[email protected]",
        "name": "User Testing"
      },
      "status": "paid"
    }
  ]
}

order.status_changed

{
  "order_id": "250128GGVOWU",
  "status": "canceled",
  "draft_time": "2025-01-28T16:24:44Z",
  "pending_time": "2025-01-28T16:27:51Z",
  "confirmed_time": "2025-01-28T16:26:44Z",
  "in_process_time": null,
  "ready_time": null,
  "shipped_time": null,
  "completed_time": null,
  "rts_time": null,
  "canceled_time": "2025-01-28T16:27:54Z",
  "closed_time": null,
  "created_at": "2025-01-28T16:24:44Z",
  "last_updated_at": "2025-01-28T16:27:54Z"
}