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)

Will be treating their userCode as consignor code.

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

consignorCode

origin_details.account_id

Yes

string

12

xxxxxxxxxxxxxx

consignorAddress

origin_details.address_line_1+2+3+4

No

string

300

Address of the consignor

consignorPincode

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

weight

weight

Yes

string

6+2

000.00

totalBoxesquantity

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

pieces_detail[].quantity

No

string

4

Total number of boxes

Eg : 20

EwayNo

eway_bill_list.ewb_number else eway_bill

Yes

string

15

xxxxxxxxxxxx

...