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. Shipments

Create shipment

The Shipping Label API enables you to route your order to your selected courier service.

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

Request Body

Name
Type
Description

request_token*

String

request token gotten from Rates API, each request token is tied to a particular rate request

service_code*

String

service code of selected courier rate

courier_id*

String

courier_id of selected courier rate

insurance_code

String

To be included if insurance wants to be purchased with shipment. Insurance code can be gotten from Get Insurance Rates API.

is_cod_label

Boolean

To be included if request is meant to be a cash on delivery shipment.

{
    "status": "success",
    "message": "Order successfully routed to Darum NG",
    "data": {
        "order_id": "SB-2CF48224272",
        "courier": {
            "name": "Darum NG",
            "email": "[email protected]",
            "phone": "010000038198"
        },
        "status": "pending",
        "ship_from": {
            "name": "Lebron James",
            "phone": "+2348057575855",
            "email": "[email protected]",
            "address": "Obafemi Awolowo Way, Alausa 101233, Ojodu, Nigeria",
            "latitude": 6.6143564,
            "longitude": 3.3581327
        },
        "ship_to": {
            "name": "Lebron James",
            "phone": "+2348057575855",
            "email": "[email protected]",
            "address": "Phase 1, 4 Michael Olawale-Cole Dr, Lekki Phase I 106104, Lagos, Nigeria",
            "latitude": 6.459056599999999,
            "longitude": 3.4769383
        },
        "payment": {
            "shipping_fee": 2785,
            "type": "wallet",
            "status": "completed",
            "currency": "NGN"
        },
        "items": [
            {
                "name": "Jameson",
                "description": "The drink dey shak die",
                "weight": 0.004,
                "amount": "5000",
                "quantity": "2",
                "total": 10000
            },
            {
                "name": "Hennesy",
                "description": "Bad boys flow",
                "weight": 2,
                "amount": "150000",
                "quantity": "10",
                "total": 1500000
            }
        ],
        "tracking_url": "https://localhost:5000/orders/tracking/GET-2CF48272",
        "date": "2021-12-19 01:23:19"
    }
}

PreviousShipmentsNextCancel shipment

Last updated 1 month ago

Was this helpful?