Shipbubble API Documentation
  • Shipbubble API
  • Get started
    • Authentication
    • Request and Responses
    • Errors
    • Rate Limiting
    • Pagination
    • Postman
  • API Reference
    • Wallet
      • Get shipping wallet balance
      • Request wallet fund
    • Addresses
      • Validate address (global)
      • Get validated addresses
      • Edit address details
      • Get single address details
    • Package categories
    • Package dimensions
    • Couriers
    • Rates
      • Request shipping rates
      • Request shipping rates from selected couriers
      • Edit request token details
    • Cash on delivery
    • Insurance
      • Get Insurance Rates
    • Shipments
      • Create shipment
      • Cancel shipment
    • Returns
      • Get rates for a return shipment request
    • Tracking
      • Get shipments
      • Get multiple specific shipments
    • Webhooks
      • Webhook simulator (sandbox)
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. Webhooks

Webhook simulator (sandbox)

Simulate a webhook event using this API for test purposes.

POST https://api.shipbubble.com/v1/shipping/labels/webhooks/:order_id

Path Parameters

Name
Type
Description

order_id*

string

sandbox order id

Request Body

Name
Type
Description

status_code*

string

status code of order which could either be 'pending', 'confirmed', 'picked_up', 'in_transit', 'completed', 'cancelled'.

{
    "status": "success",
    "message": "Webhook sent successfully"
}

Sample webhook payload

{
                "order_id": "SB-244512FE8276",
                "status": "pending",
                "courier": {
                    "name": "Test courier 2",
                    "email": "[email protected]",
                    "phone": "08012345678",
                    "tracking_code": "725478",
                    "tracking_message": "Tracking code: 725478",
                    "rider_info": null
                },
                "ship_from": {
                    "name": "Lebron James",
                    "phone": "+2348057575855",
                    "email": "[email protected]",
                    "address": "F9X6+W9V, Alh. Masha Rd, Surulere 101241, Lagos, Nigeria"
                },
                "ship_to": {
                    "name": "Lebron James",
                    "email": "[email protected]",
                    "phone": "+2348057575855",
                    "address": "F9X6+W9V, Alh. Masha Rd, Surulere 101241, Lagos, Nigeria"
                },
                "to_be_processed": "2022-07-13T21:42:32.000Z",
                "payment": {
                    "shipping_fee": 2250,
                    "currency": "NGN"
                },
                "package_status": [
                    {
                        "status": "Pending",
                        "datetime": "2022-07-13 22:42:32"
                    }
                ],
                "events": [],
                "dropoff_station": null,
                "pickup_station": null,
                "tracking_url": "http://localhost:3000/orders/tracking/SB-244512FE8276",
                "waybill_document": "https://storage.googleapis.com/get-web-app-assets/test-waybills/TEST-WAYBILL-DOCUMENT.pdf",
                "date": "2022-07-13T21:42:32.000Z"
            }
PreviousWebhooks

Last updated 5 months ago

Was this helpful?