ShipGlobal – Label Generation API

1. Overview

ShipGlobal provides API-based integration for logistics companies to generate shipping labels through our portal.

2. Authentication API

Login Endpoint

• Content-Type: application/json

Sample Request

{
  "email":    "test@shipglobal.in",
  "password": "123456"
}

Sample Response

{
  "token":      "your_token_here",
  "expires_at": "YYYY-MM-DD HH:MM:SS",
  "customer": {
    "id":    1,
    "name":  "Test Account",
    "email": "test@shipglobal.in"
  }
}

3. Order Creation & Label Generation

• Authorization: Bearer {token}
• Content-Type: application/json

Sample Unified Request (M/O in same arrangement)

M = Mandatory, O = Optional

{
    "invoice_no":        "INV-123456", // M
    "invoice_date":      "2025-08-20", // M
    "order_reference":   "ORDER-9876533", // M
    "service":           "{{SERVICE_CODE}}", // M
    "package_weight":    2.5, // M
    "package_length":    30, // M
    "package_breadth":   20, // M
    "package_height":    15, // M
    "currency_code":     "EUR", // M
    "csb5_status":       1, // M

    "seller_nickname":   "ShipGlobalTest", // M
    "seller_firstname":  "John", // M
    "seller_lastname":   "Doe", // M
    "seller_mobile":     "+491234567890", // M
    "seller_email":      "seller@example.com", // M
    "seller_company":    "ShipGlobal GmbH", // M
    "seller_address":    "Fasanenweg 5", // M
    "seller_address_2":  "Unit 2", // M
    "seller_address_3":  "Building A", // O
    "seller_city":       "Kelsterbach", // M
    "seller_postcode":   "65451", // M
    "seller_country_code": "DE", // M
    "seller_state":      "Hessen", // M
    "seller_tax_id_type": "VAT", // O
    "seller_tax_id":      "DE123456789", // O

    "customer_shipping_firstname":    "Alice", // M
    "customer_shipping_lastname":     "Muller", // M
    "customer_shipping_mobile":       "+12125551234", // M
    "customer_shipping_email":        "alice.mueller@example.com", // M
    "customer_shipping_company":      "Customer LLC", // M
    "customer_shipping_address":      "350 5th Ave", // M
    "customer_shipping_address_2":    "Floor 10", // M
    "customer_shipping_address_3":    "Near Lobby", // O
    "customer_shipping_city":         "New York", // M
    "customer_shipping_postcode":     "10467", // M
    "customer_shipping_country_code": "US", // M
    "customer_shipping_state":        "NY", // M

    "ioss_number": "IM1234567890", // O

  "vendor_order_items": [
    {
            "vendor_order_item_name":       "Bluetooth Headphones", // M
            "vendor_order_item_sku":        "SKU-HEAD-123", // M
            "vendor_order_item_quantity":   1, // M
            "vendor_order_item_unit_price": 59.99, // M
            "vendor_order_item_hsn":        "85183000", // M
            "vendor_order_item_tax_rate":   19 // M
    }
    ], // M

    "tracking": "TESTTRACK123456", // M
    "mailClass": "First", // O (M for VIPPARCEL)
    "deliveryConfirmation": "NO_SIGNATURE", // O (M for VIPPARCEL)
    "retry": false // O
}

Sample Success Response

{
  "success": true,
  "label": "generated",
  "data": {
    "order_number": "ABCD12345678",
    "waybill_number": "UUSXXXXXXXXXXXX",
    "pdf_base64": "BASE64_ENCODED_PDF_STRING"
  }
}

4. Duplicate Order Handling

If order_reference already exists:

• ?download=false (default): Returns 409 with "label already generated"
• ?download=true: Returns saved label (200 Success)

Note: Pass download as a query parameter in the URL

5. Label Handling

pdf_base64 :  Decode the Base64 string and save it as a .pdf file for printing

6. Supported Services

7. Integration Flow Summary

1. Register as a customer
2. Login to obtain Bearer token
3. Call Add Order API
4. Receive waybill and Base64 label
5. Decode and print label

8. Support