Versions Compared

Version Old Version 4 New Version Current
Changes made by

atharav.1

Khushi Verma

Saved on

Key

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

...

Carrier Partner : Speed Trans

Version :  

...

Logo :

DeveloperImageImage Added

Integrations :

...

Body Parameter

Shipsy Field

Mandatory

Data Type

Character Limit

Valid values/examples

userCodeCreds

address_hub_code

else

hub_code

(Will be handled via CFM)

Yes

string

6

R00608 (Will be provided by the Speed Trans Team)

Will be treating their userCode as consignor code.

Password

Creds

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

consignorCodeconsignorAddress

origin_details.account_id

Yes

string

12

xxxxxxxxxxxxxx

consignorAddress

origin_details.address_line_address_line_1+2+3+4

No

string

300

Address of the consignor

consignorPincodetoPinCode

origindestination_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_amount 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.NoofBoxvolume

pieces_detail[].quantityvolume

No

string

4

Total number of boxes2+2

Volume

Eg : 2067

EwayNo

eway_bill_list.ewb_number else eway_bill

Yes

string

15

xxxxxxxxxxxxboxDetails.NoofBox

if 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

Response Body

Body Parameter

Shipsy Field

LrNo

courier_partner_reference_number

Error Detail

failure_reason
(blank if the booking success)

ErrorStatusCode

failure_reason_code

...

UserCode

...

Password

Warehouse / Plant

R00608

R00608

Y524 Trends Tumkur

R01443

R01443

R975 Trends Chennai

R01774

R01774

SB41 Trends Nilakottai

R01874

R01874

S535 Footprint nelamangala

R01889

R01889

S352 Footprint Dankuni

R01838

R01838

SJ14 Trends Hoskote

R01888

R01888

R741 Trends Dankuni

R01890

R01890

SYAR Trends Dankuni

Info

The masters maintained for this will be dynamic.

Sample cURL :

Code Block
curl --location 'http://speedextrans.com/api/RelenceLrDetails/ProcessCnote' \
--header 'Content-Type: application/json' \
--data '{
    "lrdetail": {
      "userCode": "R01774",
      "Password": "R01774",
      "consigneeCode": "10101",
      "consigneeAddress": "SSSS",
      "consigneePinCode": "540002",
      "consigneeEmail": "consigneeEmail",
      "consigneePhone": "consigneePhone",
      "fromPinCode": "fromPinCode",
      "consignorAddress": "consignorAddress",
      "consignorPinCode": "consignorPinCode",
      "consignorEmail": "consignorEmail",
      "consignorPhone": "consignorPhone",
      "toPinCode": "67002",
      "weight": "4000.00",
      "tripNo": "1234567890",
      "totalBoxes": "500",
      "invoiceDetail": [
        {
          "invoiceDate": "2024-10-01",
          "invoiceNo": "50000",
          "invoiceValue": "70000"
        }
      ],
      "boxNoDetail": [
        {
          "boxNo": "123456"
        }
      ],
      "boxDetail": [
        {
          "breadth": "10",
          "height": "5",
          "length": "6",
          "numberOfBoxes": "20",
          "volume": "67"
        }
      ]
    }
  }'

...

Body Parameter

Shipsy Field

UserCode

Creds

Password

Creds

lrNo

courier_partner_reference_number

InvoicesNoDetails.invoiceno

eway_bill_list.invoice_number else invoice_number

InvoicesNoDetails.ewaybillno

eway_bill_list.ewb_number else eway_bill

Sample cURL

curl --location 'http://speedextrans.com/api/relencelrdetails/ProcessEway' \ --header 'Content-Type: application/json' \ --data '{ "billsdetail":
Code Block
curl --location 'http://speedextrans.com/api/relencelrdetails/ProcessEway' \
--header 'Content-Type: application/json' \
--data '{
    "billsdetail": 
      {
        "userCode": "R01774",
        "Password": "R01774",
        "lrNo": "1",
        "InvoicesNoDetails": [
          {
            "invoiceno": "50000",
            "ewaybillno": "EWB001"
          }
        ]
      }
  }'

Sample Response Success :

Code Block
{
    "speedlrNo": "1",
    "speedstatus": "",
    "speedmessage": ""
}

Sample Response Failure :

Code Block
{
    "message": "An error has occurred."
}

Tracking API

URL :http://speedextrans.com/api/relencelrdetails/ProcessTracking

<Tracking API has <POST>request type>

Info

In case of RTO, you will see "REBOOKED" in the Remarks section, along with the rebooked LR number in the RemarksNote.

Request Body:

Body Parameter

Shipsy Field

userCode

Creds

Password

Creds

lrno

courier_partner_reference_number

Sample cURL :

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

Sample Response Success :

Code Block
{
    "trackingevent": [
        {
            "eventAt": "2024-11-08T00:00:00.000",
            "message": " 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": [
       {         "userCode": "R01774"Hyderabad"
            ],
            "Passwordstatus": "R01774Un Delivered",
        "lrNo": "1", },
        {
"InvoicesNoDetails": [           {"eventAt": "2024-11-15T11:30:00.000",
            "invoicenomessage": "50000 ",
            "ewaybillnoargs": "EWB001" [
                "Hyderabad"
   }         ]
,
     }   }'

Sample Response Success :

Code Block
{     "speedlrNostatus": "1",Out for Delivered"
       "speedstatus": "", },
      "speedmessage": "" }

Sample Response Failure :

Code Block
{{
       "message": "An error has occurred." }

Tracking API

URL :http://speedextrans.com/api/relencelrdetails/ProcessTracking

...

Info

In case of RTO, you will see "REBOOKED" in the Remarks section, along with the rebooked LR number in the RemarksNote.

Request Body:

Body Parameter

Shipsy Field

userCode

Creds

Password

Creds

lrno

courier_partner_reference_number

Sample cURL :

Code Block
curl --location 'http://speedextrans.com/api/relencelrdetails/ProcessTracking' \
--header 'Content-Type: application/json' \
--data '{"eventAt": "2024-11-08T00:00:00.000",
            "message": "REBOOKED. 3871129",
            "trackdetailargs": [
       {         "userCodeHyderabad": "R01774",
           "Password": "R01774" ],
            "lrNostatus": "6019650Holded"
        },
     ]   }'

Sample Response Success :

Code Block
{{
     "lrNo": "6019650",       "statusCodeeventAt": "42024-11-09T00:00:00.000",
      "booked": "07/09/2024",     "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 :

Code Block
{
    "message": "An error has occurred."
}

Status Code

Status

Remarks

0

Booked

1

Outward / In-Transit

2

Reached at Branch

3

Out for Delivery

4

Delivered

5

Undelivered

Can check Remarks in UndeliveredRemarks

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

...