Webhook Types
A list of the available webhook types and their format:
Orders
Order Created
Create / Update Parameter: {"order": {"created": true}}
Example Webhook
{
"customer_id": 537,
"billing_address_id": 2065,
"shipping_address_id": 2065,
"order_id": "AGC-738647-03",
"channel_id": 1629,
"channel_order_id": "CYP-490698-18",
"order_date": "2024-03-10T08:38:19.007284Z",
"ship_by": "2024-03-12T08:38:19.007304Z",
"arrive_by": "2024-03-14T08:38:19.007313Z",
"status": "pending",
"warehouse_notes": "Distinctio autem aspernatur eos adipisci.",
"gift_note": "Cupiditate eaque dolorem molestias quibusdam repudiandae quo.",
"shipping_method_preference": "exercitationem",
"currency": "USD",
"updated_at": "2024-03-11T08:38:19.000000Z",
"created_at": "2024-03-11T08:38:19.000000Z",
"id": 488,
"customer": {
"id": 537,
"created_at": "2024-03-11T08:38:19.000000Z",
"updated_at": "2024-03-11T08:38:19.000000Z",
"name": "Roob, Wehner and Torphy",
"team_id": 551285524,
"channel_id": 1628,
"default_address_id": 2064,
"email": "jerald92@gmail.com",
"phone_number": "458-679-9566",
"email_hash": "7d61f93cbf95ffa48cfaa72ecba5b610f5f582e86722718a94006199662a8628",
"name_address_hash": "e864eebd6dc65ebf4b5052817b2b84bcefcb4bc6ab821be047a1a788b606cc39"
},
"order_items": []
}Order Shipped
Create / Update Parameter: {"order": {"shipped": true}}
Example Webhook
{
"type": "order.shipped",
"data": {
"customer_id": 224,
"billing_address_id": 361,
"shipping_address_id": 361,
"order_id": "AFR-958508-66",
"channel_id": 1,
"channel_order_id": "CNJ-136687-53",
"order_date": "2022-03-26T08:55:05.084682Z",
"ship_by": "2022-03-31T08:55:05.084718Z",
"arrive_by": "2022-04-02T08:55:05.084736Z",
"status": "shipped",
"warehouse_notes": "Quia qui ad amet quis dolorem inventore facere.",
"gift_note": "Sed consequatur quia repellat minus soluta animi voluptas est.",
"shipping_method_preference": "hic",
"updated_at": "2022-03-29T08:55:05.000000Z",
"created_at": "2022-03-29T08:55:05.000000Z",
"id": 135,
"customer": {
"id": 224,
"created_at": "2022-03-29T08:55:05.000000Z",
"updated_at": "2022-03-29T08:55:05.000000Z",
"name": "Maggio-Gerhold",
"team_id": 2,
"channel_id": 1,
"default_address_id": 360,
"email": "jordy.boyle@muller.com",
"phone_number": "1-878-502-0477",
"email_hash": "4af94b3150bccfac988f8b33a2714dad2a1398cc7102ba03dd8cb27b2ab8e474",
"name_address_hash": "6dc4477beef869f8b3c693f9f13ca11a83006ad55ee729e8b146b3fd53b4236c"
},
"packages": [
{
"id": 39,
"created_at": "2022-03-29T08:55:05.000000Z",
"updated_at": "2022-03-29T08:55:05.000000Z",
"order_id": 135,
"shipped_at": "2022-03-26T18:32:03.000000Z",
"arrived_at": null,
"lpn": "1d7fefcb-bc82-3417-9d63-77282d95b829",
"tracking_numbers": [
{
"id": 189,
"created_at": "2022-03-29T08:55:05.000000Z",
"updated_at": "2022-03-29T08:55:05.000000Z",
"trackable_type": "AppModules\\Orders\\Data\\Package\\Package",
"trackable_id": 39,
"number": "1X2143985021669124378",
"carrier": "ups",
"eta": null,
"history": null,
"delivered_at": null,
"url": null
}
]
},
{
"id": 40,
"created_at": "2022-03-29T08:55:05.000000Z",
"updated_at": "2022-03-29T08:55:05.000000Z",
"order_id": 135,
"shipped_at": "2022-03-28T23:01:01.000000Z",
"arrived_at": null,
"lpn": "5c35047e-157b-38e3-98bc-8f459fe6393b",
"tracking_numbers": [
{
"id": 190,
"created_at": "2022-03-29T08:55:05.000000Z",
"updated_at": "2022-03-29T08:55:05.000000Z",
"trackable_type": "AppModules\\Orders\\Data\\Package\\Package",
"trackable_id": 40,
"number": "1X21439850109124378",
"carrier": "ups",
"eta": null,
"history": null,
"delivered_at": null,
"url": null
}
]
}
]
}
}Billing
Invoice Created
Note: The invoice created webhook is currently only available for service providers
Create / Update Parameter: {"invoice": {"created": true}}
Example Webhook
{
"type": "invoice.created",
"data": {
"id": 18,
"created_at": "2022-03-28 06:48:37",
"charger_type": "company",
"charger_id": 1,
"chargee_type": "merchant",
"chargee_id": 2,
"stripe_invoice_id": null,
"stripe_invoice_status": null,
"description": null,
"status": "Draft",
"voided_at": "",
"finalized_at": "",
"currency": "BIF",
"total": 0,
"is_creating_on_stripe": false,
"charges": []
}
}Tracking
Tracking Updated
Tracking will be updated for tracking numbers related to orders and inbound shipments.
Create / Update Parameter: {"transportation_tracking": {"data_updated": true}}
Example Webhook
{
"type": "transportation_tracking.data_updated",
"data": {
"id": 703,
"status": "transit",
"number": "1T5JQIE6RH68U2B5GWT0",
"carrier": "usps",
"service_level": "usps__library_mail",
"eta": "2022-10-01T16:36:01-04:00",
"transit_at": "2022-09-28T16:36:01-04:00",
"delivered_at": null,
"returned_at": null,
"failed_at": null,
"package_identifier": "pkg_9wYJDWyd3R3X1ar",
"tracking_url": "https:\/\/tools.usps.com\/go\/TrackConfirmAction_input?qtc_tLabels1=1T5JQIE6RH68U2B5GWT0"
}
}