Introduction

Welcome to the Nucleus API documentation

Tracking Waybills

curl "https://portal.clicknship.co.za/api/trackitem"
  -F waybillNo = NUC123456131455516

The above command returns JSON structured like this:

{
    "data": {
        "contactNo": "+27(0)11 783 3290",
        "courier": "Nucleus",
        "courierDetails": "Amrod/Nucleus - 010 88 05405",
        "estDeliveryEndDate": "",
        "estDeliveryStartDate": "",
        "trackingNo": "DWN00130547",
        "signedBy": "JHARQ",
        "podSignature": "JHARQ",
        "podDate": "2018/07/31",
        "podTime": "11:32",
        "podNoParcels": "1",
        "podImage": "<link to the POD image>",
        "events": [
            {
                "StatusDescription": "eWaybill Created",
                "StatusDateTime": "2018-07-30 14:41:52.517",
                "code": "EWBLCRE"
            },
            {
                "StatusDescription": "Delivered - POD Captured",
                "StatusDateTime": "2018-07-31 00:00:00.000",
                "code": "W52"
            },
            {
                "StatusDescription": "Delivered - POD Captured",
                "StatusDateTime": "2018-07-31 00:00:00.000",
                "code": "W60"
            },
            {
                "StatusDescription": "Delivered - POD Captured",
                "StatusDateTime": "2018/07/31 11:32",
                "code": "W52"
            }
        ],
        "edconEvents": [
            {
                "StatusDescription": "Ewaybill Created",
                "StatusDateTime": "2018-07-30 14:41:52.517",
                "code": "EWBLCRE",
                "status": null
            },
            {
                "StatusDescription": "DELIVERY SUCCESSFUL",
                "StatusDateTime": "2018-07-31 00:00:00.000",
                "code": "W52",
                "status": "POD REC"
            },
            {
                "StatusDescription": "POD RECEIVED / DELIVERED",
                "StatusDateTime": "2018-07-31 00:00:00.000",
                "code": "W60",
                "status": "POD REC"
            },
            {
                "StatusDescription": "Delivered awaiting POD",
                "StatusDateTime": "2018-07-31 12:37:00.000",
                "code": "W52",
                "status": ""
            }
        ],
        "status": "Delivered - POD Captured"
    },
    "message": [
        "200",
        "successful tracking data"
    ]
}

This endpoint returns all tracking information for a waybill number.

HTTP Request

POST https://portal.clicknship.co.za/api/trackitem

Query Parameters

Parameter	Type	Description
waybillNo	string	Waybill number of the parcel you would like to track

Bulk Tracking Waybills

curl "https://portal.clicknship.co.za/api/bulktrackitems"
  -F Waybills = ["CIT00064728","CIT00064728"]

The above command returns JSON structured like this:

{
    "data": {
        "DWN00130547": {
            "Events": [
                {
                    "code": "EWBLCRE",
                    "status": "eWaybill Created",
                    "date": "2018-07-30 14:41:52.517"
                },
                {
                    "code": "W52",
                    "status": "Delivered - POD Captured",
                    "date": "2018-07-31 00:00:00.000"
                },
                {
                    "code": "W60",
                    "status": "Delivered - POD Captured",
                    "date": "2018-07-31 00:00:00.000"
                },
                {
                    "code": "W52",
                    "status": "Delivered - POD Captured",
                    "date": "2018-07-31 12:37:00.000"
                }
            ],
            "POD": {
                "waybill": "DWN00130547",
                "Signature": "JHARQ",
                "Date": "2018/07/31",
                "Time": "11:32",
                "NoParcels": "1"
            }
        }
    },
    "message": [
        200,
        "Successful tracking events received"
    ]
}

This endpoint returns all tracking information for all requested waybill numbers.

HTTP Request

POST https://portal.clicknship.co.za/api/bulktrackitems

Query Parameters

Parameter	Type	Description
Waybills	string	JSON array of Waybill Numbers

Create Waybill

curl "https://portal.clicknship.co.za/api/createwaybill"
  -F WaybillNo = 123456131455517
  -F AccountNo = NUC001
  -F Carrier = DW
  -F ServiceCode = ONX
  -F ReferenceNumber = ReferenceNumber
  -F Comments = Comments
  -F 'Detail = [
      {
        "ItemID": 15, 
        "ItemLength": 3, 
        "ItemWidth": 2, 
        "ItemHeight": 6, 
        "ItemWeight": 5, 
        "ItemCount": 1
      },
      {
        "ItemID": 16, 
        "ItemLength": 3, 
        "ItemWidth": 2, 
        "ItemHeight": 6, 
        "ItemWeight": 5, 
        "ItemCount":1
      }
    ]'
  -F 'FromDetails = {
      "accountNo": "",
      "name": "Lightswitch",
      "contact": "Aidan",
      "telephone": "0609851006",
      "email": "aidan@lightswitch.solutions"
    }'
  -F 'FromAddress = {
      "address1": "9 The Crescent",
      "address2": "",
      "address3": "",
      "suburb": "Pinelands",
      "city": "Cape Town",
      "province": "",
      "postCode": "7405",
      "country": "South Africa"
    }'
  -F 'ToDetails = {
      "accountNo": "",
      "name": "Lightswitch",
      "contact": "Aidan",
      "telephone": "0609851006",
      "email": "aidan@lightswitch.solutions"
      "clientName": "Joe Fish",
      "clientNumber": "0617861234"
    }'
  -F 'ToAddress = {
      "address1": "9 The Crescent",
      "address2": "",
      "address3": "",
      "suburb": "Pinelands",
      "city": "Cape Town",
      "province": "",
      "postCode": "7405",
      "country": "South Africa"
    }'

The above command returns JSON structured like this:

{
    "data": [
        {
            "waybillNo": "NUC123456131455517"
        },
        {
            "data": [
                {
                    "SuccessMessage": "OK - Dimensions/Parcels have been created successfully!"
                }
            ],
            "message": "successful parcel creation to waybill: NUC123456131455517",
            "code": "200"
        }
    ],
    "message": [
        "201",
        "Waybill created succesfully, Parcel added succesfully, "
    ]
}

This endpoint creates a waybill from the information provided.

HTTP Request

POST https://portal.clicknship.co.za/api/createwaybill

Query Parameters

Parameter	Type	Description
WaybillNo	string	Waybill number of the parcel you would like to create
AccountNo	string	Your Company Account Number
Carrier	string	Carrier
ReferenceNumber	string	Reference Number
Comments	string	Comments
ServiceCode	string	Service Code, for example: ONX, ECO
Detail	string	JSON array of objects containing the following fields: ItemID, ItemLength, ItemWidth, ItemHeight, ItemWeight, ItemCount
FromDetails	string	JSON object containing the following fields: accountNo, name, contact, telephone, email
FromAddress	string	JSON object containing the following fields: address1, address2, address3, suburb, city, province, postCode, country
ToDetails	string	JSON object containing the following fields: accountNo, name, contact, telephone, email, clientName, clientNumber
ToAddress	string	JSON object containing the following fields: address1, address2, address3, suburb, city, province, postCode, country

Delete Waybill

curl "https://portal.clicknship.co.za/api/deletewaybill"
  -F waybillNo = NUC2345123123123123

The above command returns JSON structured like this:

{
    "data": "",
    "message": [
        "200",
        [
            {
                "SuccessMessage": "OK - Waybill No NUC2345123123123123, has been deleted successfully!"
            }
        ]
    ]
}

This endpoint deletes the waybill.

HTTP Request

POST https://portal.clicknship.co.za/api/deletewaybill

Query Parameters

Parameter	Type	Description
waybillNo	string	Waybill number of the parcel you would like to delete

Update Waybill

curl "https://portal.clicknship.co.za/api/createwaybill"
  -F WaybillNo = 123456131455517
  -F AccountNo = NUC001
  -F ServiceCode = ONX
  -F ReferenceNumber = ReferenceNumber
  -F Comments = Comments
  -F 'Detail = [
      {
        "ItemID": 15, 
        "ItemLength": 3, 
        "ItemWidth": 2, 
        "ItemHeight": 6, 
        "ItemWeight": 5, 
        "ItemCount": 1
      },
      {
        "ItemID": 16, 
        "ItemLength": 3, 
        "ItemWidth": 2, 
        "ItemHeight": 6, 
        "ItemWeight": 5, 
        "ItemCount":1
      }
    ]'
  -F 'ToDetails = {
      "accountNo": "",
      "name": "Lightswitch",
      "contact": "Aidan",
      "telephone": "0609851006",
      "email": "aidan@lightswitch.solutions",
      "clientName": "Joe's shop",
      "clientName": "0617861234"
    }'
  -F 'ToAddress = {
      "address1": "9 The Crescent",
      "address2": "",
      "address3": "",
      "suburb": "Pinelands",
      "city": "Cape Town",
      "province": "",
      "postCode": "7405",
      "country": "South Africa"
    }'

The above command returns JSON structured like this:

{
    "data": [
        "OK - Waybill No NUC2345123123123123, has been updated successfully!",
        {
            "data": [
                {
                    "SuccessMessage": "OK - Dimensions/Parcels have been created successfully!"
                }
            ],
            "message": "successful parcel creation to waybill: NUC2345123123123123",
            "code": "200"
        }
    ],
    "message": [
        "201",
        "Waybill updated succesfully, Parcel updated succesfully, "
    ]
}

This endpoint creates a waybill from the information provided.

HTTP Request

POST https://portal.clicknship.co.za/api/updatewaybill

Query Parameters

Parameter	Type	Description
WaybillNo	string	Waybill number of the parcel you would like to create
AccountNo	string	Your Company Account Number
ReferenceNumber	string	Reference Number
Comments	string	Comments
ServiceCode	string	Service Code, for example: ONX, ECO
Detail	string	JSON array of objects containing the following fields: ItemID, ItemLength, ItemWidth, ItemHeight, ItemWeight, ItemCount
ToDetails	string	JSON object containing the following fields: accountNo, name, contact, telephone, email
ToAddress	string	JSON object containing the following fields: address1, address2, address3, suburb, city, province, postCode, country

Quote

curl "https://portal.clicknship.co.za/api/quote"
  -F AccountNo = NUC001
  -F From = 7925
  -F To = 8000
  -F ServiceCode = ONX
  -F Weight = 1
  -F Comments = Comments
  -F 'Dimensions = [
      {
        "ItemLength": 3, 
        "ItemWidth": 2, 
        "ItemHeight": 6, 
        "ItemWeight": 5, 
        "ItemCount": 1
      },
      {
        "ItemLength": 3, 
        "ItemWidth": 2, 
        "ItemHeight": 6, 
        "ItemWeight": 5, 
        "ItemCount":1
      }
    ]'

The above command returns JSON structured like this:

{
    "data": {
        "rate": "64.35"
    },
    "message": [
        200,
        "Quote successful"
    ]
}

This endpoint creates a waybill from the information provided.

HTTP Request

POST https://portal.clicknship.co.za/api/updatewaybill

Query Parameters

Parameter	Type	Description
AccountNo	string	Your Company Account Number
From	string	From postal code
To	string	To postal code
ServiceCode	string	Service Code, for example: ONX, ECO
Weight	string	Total weight
Dimensions	string	JSON array of objects containing the following fields: ItemLength, ItemWidth, ItemHeight, ItemWeight, ItemCount

Errors

The Clicknship API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Missing information
500	Request failed, further information in response.