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

Creds

Yes

string

6

R00608 (Will be provided by the Speed Trans Team)

Password

Creds

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

origin_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.NoofBox

pieces_detail[].quantity

No

string

4

Total number of boxes

Eg : 20

...

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

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"
        }
      ]
    }
  }'

...

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

Booked

pickup_awaited

Outward

intransittohub

In-Transit

intransittohub

Reached at Branch

reachedathub

Out for Delivery

outfordelivery

Delivered

delivered

...