Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Body Parameter

Shipsy Field

Mandatory

Data Type

Character Limit

Valid values/examples

userCode

address_hub_code

else

hub_code

(Will be handled via CFM)

Yes

string

6

R00608 (Will be provided by the Speed Trans Team)

Password

address_hub_code

else

hub_code

(Will be handled via CFM)

Yes

string

6

R00608 (Will be provided by the Speed Trans Team)

consigneeCode

destination_details.account_id

Yes

string

12

xxxxxxxxxxxxxx

consigneeAddress

destination_details.address_line_1+2+3+4

No

string

300

Address of the consignee

consigneePinCode

destination_details.pincode

No

string

6

Pincode of the consignee

consigneeEmail

destination_details.email

No

string

200

Email Address of the consignee

consigneePhone

destination_details.phone

No

string

50

Phone number of the consignee

consignorAddress

origin_details.address_line_1+2+3+4

No

string

300

Address of the consignor

toPinCode

destination_details.pincode

No

string

6

Pincode of the consignor

consignorEmail

origin
_details.email

No

string

200

Email Address of the consignor

consignorPhone

origin_details.phone

No

string

25

Phone number of the consignor

tripNo

sap_trip_number

Yes

string

12

1234567890

weight

weight

Yes

string

6+2

000.00

totalBoxes

piece_count()

Yes

string

5

Total number of boxes

invoices.invoiceDate

eway_bill_list.invoice_date else order creation date

Yes

string

NA

YYYY/MM/DD format

invoices.invoiceNo

eway_bill_list.invoice_number else invoice_number

Yes

string

25

Invoice Number

Eg : 2003007915

invoices.invoiceValue

eway_bill_list.invoice_value else invoice_amount

Yes

string

10+2

Invoice Amount

Eg : 15662.25

boxDetails.length

pieces_detail[].length

Yes

string

2+2

Length

Eg : 10.25

boxDetails.breadth

pieces_detail[].breadth

Yes

string

2+2

Breadth

Eg : 10.25

boxDetails.height

pieces_detail[].height

Yes

string

2+2

Height

Eg : 10.25

boxDetails.volume

pieces_detail[].volume

No

string

2+2

Volume

Eg : 67

boxDetails.NoofBoxpieces

_detail[].quantityif separate child CN is on,
quantity to be passed in the pieces_details would be hardcoded to 1
else
it should be mapped to pieces_details.quantity.

No

string

4

Total number of boxes

Eg : 20

...

Code Block
curl --location 'http://speedextransSpeedExTrans.com/api/relencelrdetails/ProcessTracking' \
--header 'Content-Type: application/json' \
--data ' {
    "trackdetail":
[
      {
        "userCode": "R01774",
        "Password": "R01774",
        "lrNo": "601965013086451"
      }
    ]
  }'

Sample Response Success :

Code Block
{
    "lrNotrackingevent": "6019650",[
        {
            "statusCodeeventAt": "42024-11-08T00:00:00.000",
     "booked       "message": " "07/09/2024",Booked",
            "args": [
                "LBRD WH-Branch"
            ],
            "status": "Booking Accepted"
        },
        {
            "eventAt": "2024-11-08T07:26:00.000",
            "message": " ",
            "args": [
                "LBRD WH-Branch"
            ],
            "status": "In Transit"
        },
        {
            "eventAt": "2024-11-09T08:25:00.000",
            "message": "",
            "args": [
                "Hyderabad"
            ],
            "status": "Reached Branch"
        },
        {
            "eventAt": "2024-11-15T11:30:00.000",
            "message": "Po and Da issues",
            "args": [
                "Hyderabad"
            ],
            "status": "Un Delivered"
        },
        {
            "eventAt": "2024-11-15T11:30:00.000",
            "message": " ",
            "args": [
                "Hyderabad"
            ],
            "status": "Out for Delivered"
        },
        {
            "eventAt": "2024-11-08T00:00:00.000",
            "message": "REBOOKED. 3871129",
            "args": [
                "Hyderabad"
            ],
            "status": "Holded"
        },
        {
            "eventAt": "2024-11-09T00:00:00.000",
            "bookedRemarkmessage": "\r\nH00001",
      "outward": "08/09/2024",     "outwardRemarkargs": "\r\n",[
    "reachedatbranch": "08/09/2024",     "reachedatbranchRemark": "",     "outfordeliveryHyderabad":
null,     "outfordeliveryRemark": null,     "delivered": "08/09/2024", ],
     "deliveredRemark": " ",     "undeliveredstatus": null,"Un Delivered"
     "undeliveredReson": null,  }
  "speedmessage": null  ]
}

Sample Response Failure :

...

Status Mapping

3PL Status

Shipsy Status

BookedBooking Accepted

pickup_awaited

Outward

intransittohub

In - Transit

intransittohub

Reached at Branch

reachedathub

Out for DeliveryDelivered

outfordelivery

Delivered

delivered

...