Shipper Details
| Field | Type | Required? | Description |
|---|---|---|---|
| shipper_name | String | Y | Shipper name |
| shipper_company_name | String | Y | Shipper company name |
| shipper_contact_no | String | Y | Shipper contact no, It will be a mobile OR phone number. |
| shipper_email | String | Y | Shipper email address |
| shipper_address_line_1 | String | Y | Shipper address line 1 |
| shipper_address_line_2 | String | Y | Shipper address line 2 |
| shipper_address_line_3 | String | Optional | Shipper address line 3 |
| shipper_city | String | Y | Shipper city |
| shipper_state | String | Y | Shipper state Code OR Name |
| shipper_country | String | Y | 2 letter country code. |
| shipper_zip_code | String | Y | Shipper zip code |
| shipper_gstin_type | String | Y | Aadhaar Number, Authorization Letter, Citizenship Number, Consignee Id, DRIVING LICENCE, EORI, GSTIN (Diplomats), GSTIN (Govt.), GSTIN (Normal), IEC Certificate, National ID Number, NCN, NTN, Others, PAN Number, Passport Number, PNIC NUMBER, TAN Number, TRN NO, VAT, Voter Id |
| shipper_gstin_no | String | Y | Shipper GSTIN number as per shipper_gstin_type |
Consignee Details
| Field | Type | Required? | Description |
|---|---|---|---|
| consignee_name | String | Y | Consignee name |
| consignee_company_name | String | Y | Consignee company name |
| consignee_contact_no | String | Y | Consignee contact no, It will be a mobile OR phone number. |
| consignee_email | String | Y | Consignee email address |
| consignee_address_line_1 | String | Y | Consignee address 1 |
| consignee_address_line_2 | String | Y | Consignee address 2 |
| consignee_address_line_3 | String | Optional | Consignee address 3 |
| consignee_city | String | Y | Consignee city |
| consignee_state | String | Y | Consignee state Code OR Name |
| consignee_country | String | Y | 2 letter country code. |
| consignee_zip_code | String | Y | Consignee zip code |
| consignee_gstin_type | String | Optional | Aadhaar Number, Authorization Letter, Citizenship Number, Consignee Id, DRIVING LICENCE, EORI, GSTIN (Diplomats), GSTIN (Govt.), GSTIN (Normal), IEC Certificate, National ID Number, NCN, NTN, Others, PAN Number, Passport Number, PNIC NUMBER, TAN Number, TRN NO, VAT, Voter Id |
| consignee_gstin_no | String | Optional | Consignee GSTIN number as per consignee_gstin_type |
Pickup Address Details
| Field | Type | Required? | Description |
|---|---|---|---|
| pickup_request | int | Optional | 1 - for pickup YES : 2 - for pickup NO |
| pickup_address_code | String | Optional | Pickup Address code |
| pickup_address_name | String | Optional | Pickup Address name |
| pickup_address_contact_no | String | Optional | Pickup Address contact no, It will be a mobile OR phone number. |
| pickup_address_email | String | Optional | Pickup Address email address |
| pickup_address_address_line_1 | String | Optional | Pickup Address address 1 |
| pickup_address_address_line_2 | String | Optional | Pickup Address address 2 |
| pickup_address_address_line_3 | String | Optional | Pickup Address address 3 |
| pickup_address_city | String | Optional | Pickup Address city |
| pickup_address_state | String | Optional | Pickup Address state Code OR Name |
| pickup_address_country | String | Optional | 2 letter country code. |
| pickup_address_zip_code | String | Optional | Pickup Address zip code |
| pickup_address_gstin_type | String | Optional | Aadhaar Number, Authorization Letter, Citizenship Number, Consignee Id, DRIVING LICENCE, EORI, GSTIN (Diplomats), GSTIN (Govt.), GSTIN (Normal), IEC Certificate, National ID Number, NCN, NTN, Others, PAN Number, Passport Number, PNIC NUMBER, TAN Number, TRN NO, VAT, Voter Id |
| pickup_address_gstin_no | String | Optional | Pickup Address GSTIN number as per pickup_address_gstin_type |
MULTIPLE INVOICE DETAILS
| Field | Type | Required? | Description |
|---|---|---|---|
| mul_invoice_date | date | Y | YYYY-MM-DD format date E.g. 2022-09-02 |
| mul_invoice_no | String | Y | INV2346 |
| mul_order_no | String | Y | ORD234 |
| mul_currency | String | Y | Shipment currency E.g. INR, USD, GBP |
| mul_invoice_amount | String | Y | INVOICE AMOUNT E.g. 10.0 |
| mul_eway_bill | String | Y | EWAY2345 |
Docket Items
| Field | Type | Required? | Description |
|---|---|---|---|
| actual_weight | Decimal | Y | Item actual weight in KG. E.g 5.00 |
| length | Decimal | Y | Item length in CM |
| width | Decimal | Y | Item width in CM |
| height | Decimal | Y | Item height in CM |
| number_of_boxes | Integer | Y | Number of boxes |
shipment invoice Line Items
| Field | Type | Required? | Description |
|---|---|---|---|
| total | Decimal | Y | Total = shipment invoice line item rate x shipment invoice line item no_of_packages |
| no_of_packages | Integer | Y | No. of packages is quantity |
| box_no | String | Y | Box no item |
| rate | Decimal | Y | Rate per line item |
| hscode | String | Y | Valid HS code line item E.g 17049020 |
| description | String | Y | Description of item |
| unit_of_measurement | String | Y | Measurement unit of item E.g PCs |
| unit_weight | Decimal | Y | Weight of item in KG |
| igst_amount | Decimal | Y | IGST amount of item E.g 10.0 |
