POST api/Client/CreateShipment
Request Information
URI Parameters
None.
Body Parameters
BookingApiRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Token | string |
None. |
|
| UserID | string |
None. |
|
| OPType | string |
None. |
|
| Password | string |
None. |
|
| AwbNo | string |
None. |
|
| SampleOrderNo | string |
None. |
|
| BookingDate | string |
None. |
|
| ClientCode | string |
None. |
|
| BillingService | string |
None. |
|
| ConsignorName | string |
None. |
|
| ConsignorCompanyName | string |
None. |
|
| ConsignorAddress1 | string |
None. |
|
| ConsignorAddress2 | string |
None. |
|
| ConsignorAddress3 | string |
None. |
|
| ConsignorPinCode | string |
None. |
|
| ConsignorCountry | string |
None. |
|
| ConsignorState | string |
None. |
|
| ConsignorCity | string |
None. |
|
| ConsignorPhoneNo | string |
None. |
|
| ConsignorEmailID | string |
None. |
|
| ConsignorDocType | string |
None. |
|
| ConsignorDocNumber | string |
None. |
|
| ConsigneeName | string |
None. |
|
| ConsigneeCompanyName | string |
None. |
|
| ConsigneeAddress1 | string |
None. |
|
| ConsigneeAddress2 | string |
None. |
|
| ConsigneeAddress3 | string |
None. |
|
| ConsigneePinCode | string |
None. |
|
| ConsigneeCountry | string |
None. |
|
| ConsigneeState | string |
None. |
|
| ConsigneeCity | string |
None. |
|
| ConsigneePhoneNo | string |
None. |
|
| ConsigneeEmailID | string |
None. |
|
| ConsigneeDocType | string |
None. |
|
| ConsigneeDocNumber | string |
None. |
|
| InvoiceDetails | InvoiceDetail |
None. |
|
| PacketType | string |
None. |
|
| PaymentTypeClient | string |
None. |
|
| Amount | string |
None. |
|
| AmountCurrency | string |
None. |
|
| Description | string |
None. |
|
| Divisor | string |
None. |
|
| Pieces | string |
None. |
|
| ActualWt | string |
None. |
|
| Currency | string |
None. |
|
| Volumetric | Collection of Volumetric |
None. |
|
| TotalWeight | string |
None. |
|
| Weight | string |
None. |
|
| WeightUnit | string |
None. |
|
| TotalVolWeight | string |
None. |
|
| TotalChargeWeight | string |
None. |
|
| Vendor | string |
None. |
|
| ServiceType | string |
None. |
|
| Packaging | string |
None. |
|
| CSBSelection | boolean |
None. |
|
| CSBVDetails | CSBVDetail |
None. |
|
| DutyPaid | string |
None. |
|
| ForwardingNo | string |
None. |
|
| AccountNo | string |
None. |
|
| Forwarder | string |
None. |
|
| BillTo | string |
None. |
|
| BillToAccNo | string |
None. |
|
| DutiesTo | string |
None. |
|
| DutiesAccNo | string |
None. |
|
| Remarks | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Token": "sample string 1",
"UserID": "sample string 2",
"OPType": "sample string 3",
"Password": "sample string 4",
"AwbNo": "sample string 5",
"SampleOrderNo": "sample string 6",
"BookingDate": "sample string 7",
"ClientCode": "sample string 8",
"BillingService": "sample string 9",
"ConsignorName": "sample string 10",
"ConsignorCompanyName": "sample string 11",
"ConsignorAddress1": "sample string 12",
"ConsignorAddress2": "sample string 13",
"ConsignorAddress3": "sample string 14",
"ConsignorPinCode": "sample string 15",
"ConsignorCountry": "sample string 16",
"ConsignorState": "sample string 17",
"ConsignorCity": "sample string 18",
"ConsignorPhoneNo": "sample string 19",
"ConsignorEmailID": "sample string 20",
"ConsignorDocType": "sample string 21",
"ConsignorDocNumber": "sample string 22",
"ConsigneeName": "sample string 23",
"ConsigneeCompanyName": "sample string 24",
"ConsigneeAddress1": "sample string 25",
"ConsigneeAddress2": "sample string 26",
"ConsigneeAddress3": "sample string 27",
"ConsigneePinCode": "sample string 28",
"ConsigneeCountry": "sample string 29",
"ConsigneeState": "sample string 30",
"ConsigneeCity": "sample string 31",
"ConsigneePhoneNo": "sample string 32",
"ConsigneeEmailID": "sample string 33",
"ConsigneeDocType": "sample string 34",
"ConsigneeDocNumber": "sample string 35",
"InvoiceDetails": {
"InvoiceNo": "sample string 1",
"InvoiceValue": "sample string 2",
"InvoiceDate": "sample string 3",
"BankADCode": "sample string 4",
"BankAccNo": "sample string 5",
"IFSCCode": "sample string 6",
"DOReceiptNo": "sample string 7",
"BOENo": "sample string 8"
},
"PacketType": "sample string 36",
"PaymentTypeClient": "sample string 37",
"Amount": "sample string 38",
"AmountCurrency": "sample string 39",
"Description": "sample string 40",
"Divisor": "sample string 41",
"Pieces": "sample string 42",
"ActualWt": "sample string 43",
"Currency": "sample string 44",
"Volumetric": [
{
"Weight": "sample string 1",
"Length": "sample string 2",
"Breadth": "sample string 3",
"Height": "sample string 4",
"DescriptionDetails": [
{
"Description": "sample string 1",
"HSNCode": "sample string 2",
"UOM": "sample string 3",
"Unit": "sample string 4",
"UnitValue": "sample string 5",
"Total": "sample string 6"
},
{
"Description": "sample string 1",
"HSNCode": "sample string 2",
"UOM": "sample string 3",
"Unit": "sample string 4",
"UnitValue": "sample string 5",
"Total": "sample string 6"
}
]
},
{
"Weight": "sample string 1",
"Length": "sample string 2",
"Breadth": "sample string 3",
"Height": "sample string 4",
"DescriptionDetails": [
{
"Description": "sample string 1",
"HSNCode": "sample string 2",
"UOM": "sample string 3",
"Unit": "sample string 4",
"UnitValue": "sample string 5",
"Total": "sample string 6"
},
{
"Description": "sample string 1",
"HSNCode": "sample string 2",
"UOM": "sample string 3",
"Unit": "sample string 4",
"UnitValue": "sample string 5",
"Total": "sample string 6"
}
]
}
],
"TotalWeight": "sample string 45",
"Weight": "sample string 46",
"WeightUnit": "sample string 47",
"TotalVolWeight": "sample string 48",
"TotalChargeWeight": "sample string 49",
"Vendor": "sample string 50",
"ServiceType": "sample string 51",
"Packaging": "sample string 52",
"CSBSelection": true,
"CSBVDetails": {
"CSBSelection": "sample string 1",
"TermofInovice": "sample string 2",
"CSBVInvoicNo": "sample string 3",
"CSBVInvoiceDate": "sample string 4",
"ExportUsingEcommerce": true,
"MEISScheme": true,
"NonGSTInvoiceNo": "sample string 7",
"NonGSTInvoiceDate": "sample string 8",
"TotalIGSTPaidIfAny": "sample string 9",
"BondOrLUT": true,
"LUTNumber": "sample string 11",
"LUTIssueDate": "sample string 12",
"LUTTillDate": "sample string 13",
"ADCode": "sample string 14",
"PaymentOFIGSTPlIndicate": true
},
"DutyPaid": "sample string 54",
"ForwardingNo": "sample string 55",
"AccountNo": "sample string 56",
"Forwarder": "sample string 57",
"BillTo": "sample string 58",
"BillToAccNo": "sample string 59",
"DutiesTo": "sample string 60",
"DutiesAccNo": "sample string 61",
"Remarks": "sample string 62"
}
application/xml, text/xml
Sample:
<BookingApiRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExpressIts_API.Models">
<AccountNo>sample string 56</AccountNo>
<ActualWt>sample string 43</ActualWt>
<Amount>sample string 38</Amount>
<AmountCurrency>sample string 39</AmountCurrency>
<AwbNo>sample string 5</AwbNo>
<BillTo>sample string 58</BillTo>
<BillToAccNo>sample string 59</BillToAccNo>
<BillingService>sample string 9</BillingService>
<BookingDate>sample string 7</BookingDate>
<CSBSelection>true</CSBSelection>
<CSBVDetails>
<ADCode>sample string 14</ADCode>
<BondOrLUT>true</BondOrLUT>
<CSBSelection>sample string 1</CSBSelection>
<CSBVInvoicNo>sample string 3</CSBVInvoicNo>
<CSBVInvoiceDate>sample string 4</CSBVInvoiceDate>
<ExportUsingEcommerce>true</ExportUsingEcommerce>
<LUTIssueDate>sample string 12</LUTIssueDate>
<LUTNumber>sample string 11</LUTNumber>
<LUTTillDate>sample string 13</LUTTillDate>
<MEISScheme>true</MEISScheme>
<NonGSTInvoiceDate>sample string 8</NonGSTInvoiceDate>
<NonGSTInvoiceNo>sample string 7</NonGSTInvoiceNo>
<PaymentOFIGSTPlIndicate>true</PaymentOFIGSTPlIndicate>
<TermofInovice>sample string 2</TermofInovice>
<TotalIGSTPaidIfAny>sample string 9</TotalIGSTPaidIfAny>
</CSBVDetails>
<ClientCode>sample string 8</ClientCode>
<ConsigneeAddress1>sample string 25</ConsigneeAddress1>
<ConsigneeAddress2>sample string 26</ConsigneeAddress2>
<ConsigneeAddress3>sample string 27</ConsigneeAddress3>
<ConsigneeCity>sample string 31</ConsigneeCity>
<ConsigneeCompanyName>sample string 24</ConsigneeCompanyName>
<ConsigneeCountry>sample string 29</ConsigneeCountry>
<ConsigneeDocNumber>sample string 35</ConsigneeDocNumber>
<ConsigneeDocType>sample string 34</ConsigneeDocType>
<ConsigneeEmailID>sample string 33</ConsigneeEmailID>
<ConsigneeName>sample string 23</ConsigneeName>
<ConsigneePhoneNo>sample string 32</ConsigneePhoneNo>
<ConsigneePinCode>sample string 28</ConsigneePinCode>
<ConsigneeState>sample string 30</ConsigneeState>
<ConsignorAddress1>sample string 12</ConsignorAddress1>
<ConsignorAddress2>sample string 13</ConsignorAddress2>
<ConsignorAddress3>sample string 14</ConsignorAddress3>
<ConsignorCity>sample string 18</ConsignorCity>
<ConsignorCompanyName>sample string 11</ConsignorCompanyName>
<ConsignorCountry>sample string 16</ConsignorCountry>
<ConsignorDocNumber>sample string 22</ConsignorDocNumber>
<ConsignorDocType>sample string 21</ConsignorDocType>
<ConsignorEmailID>sample string 20</ConsignorEmailID>
<ConsignorName>sample string 10</ConsignorName>
<ConsignorPhoneNo>sample string 19</ConsignorPhoneNo>
<ConsignorPinCode>sample string 15</ConsignorPinCode>
<ConsignorState>sample string 17</ConsignorState>
<Currency>sample string 44</Currency>
<Description>sample string 40</Description>
<Divisor>sample string 41</Divisor>
<DutiesAccNo>sample string 61</DutiesAccNo>
<DutiesTo>sample string 60</DutiesTo>
<DutyPaid>sample string 54</DutyPaid>
<Forwarder>sample string 57</Forwarder>
<ForwardingNo>sample string 55</ForwardingNo>
<InvoiceDetails>
<BOENo>sample string 8</BOENo>
<BankADCode>sample string 4</BankADCode>
<BankAccNo>sample string 5</BankAccNo>
<DOReceiptNo>sample string 7</DOReceiptNo>
<IFSCCode>sample string 6</IFSCCode>
<InvoiceDate>sample string 3</InvoiceDate>
<InvoiceNo>sample string 1</InvoiceNo>
<InvoiceValue>sample string 2</InvoiceValue>
</InvoiceDetails>
<OPType>sample string 3</OPType>
<Packaging>sample string 52</Packaging>
<PacketType>sample string 36</PacketType>
<Password>sample string 4</Password>
<PaymentTypeClient>sample string 37</PaymentTypeClient>
<Pieces>sample string 42</Pieces>
<Remarks>sample string 62</Remarks>
<SampleOrderNo>sample string 6</SampleOrderNo>
<ServiceType>sample string 51</ServiceType>
<Token>sample string 1</Token>
<TotalChargeWeight>sample string 49</TotalChargeWeight>
<TotalVolWeight>sample string 48</TotalVolWeight>
<TotalWeight>sample string 45</TotalWeight>
<UserID>sample string 2</UserID>
<Vendor>sample string 50</Vendor>
<Volumetric>
<Volumetric>
<Breadth>sample string 3</Breadth>
<DescriptionDetails>
<Volumetric.DescriptionDetail>
<Description>sample string 1</Description>
<HSNCode>sample string 2</HSNCode>
<Total>sample string 6</Total>
<UOM>sample string 3</UOM>
<Unit>sample string 4</Unit>
<UnitValue>sample string 5</UnitValue>
</Volumetric.DescriptionDetail>
<Volumetric.DescriptionDetail>
<Description>sample string 1</Description>
<HSNCode>sample string 2</HSNCode>
<Total>sample string 6</Total>
<UOM>sample string 3</UOM>
<Unit>sample string 4</Unit>
<UnitValue>sample string 5</UnitValue>
</Volumetric.DescriptionDetail>
</DescriptionDetails>
<Height>sample string 4</Height>
<Length>sample string 2</Length>
<Weight>sample string 1</Weight>
</Volumetric>
<Volumetric>
<Breadth>sample string 3</Breadth>
<DescriptionDetails>
<Volumetric.DescriptionDetail>
<Description>sample string 1</Description>
<HSNCode>sample string 2</HSNCode>
<Total>sample string 6</Total>
<UOM>sample string 3</UOM>
<Unit>sample string 4</Unit>
<UnitValue>sample string 5</UnitValue>
</Volumetric.DescriptionDetail>
<Volumetric.DescriptionDetail>
<Description>sample string 1</Description>
<HSNCode>sample string 2</HSNCode>
<Total>sample string 6</Total>
<UOM>sample string 3</UOM>
<Unit>sample string 4</Unit>
<UnitValue>sample string 5</UnitValue>
</Volumetric.DescriptionDetail>
</DescriptionDetails>
<Height>sample string 4</Height>
<Length>sample string 2</Length>
<Weight>sample string 1</Weight>
</Volumetric>
</Volumetric>
<Weight>sample string 46</Weight>
<WeightUnit>sample string 47</WeightUnit>
</BookingApiRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BookingApiResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | string |
None. |
|
| Message | string |
None. |
|
| AWBNo | string |
None. |
|
| AWBLabels | Collection of AWBLabels |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": "sample string 1",
"Message": "sample string 2",
"AWBNo": "sample string 3",
"AWBLabels": [
{
"TrackingNo": "sample string 1",
"Label": "sample string 2",
"LabelType": "sample string 3",
"LabelFor": "sample string 4",
"LastmileResponse": "sample string 5"
},
{
"TrackingNo": "sample string 1",
"Label": "sample string 2",
"LabelType": "sample string 3",
"LabelFor": "sample string 4",
"LastmileResponse": "sample string 5"
}
]
}
application/xml, text/xml
Sample:
<BookingApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExpressIts_API.Models">
<AWBLabels>
<AWBLabels>
<Label>sample string 2</Label>
<LabelFor>sample string 4</LabelFor>
<LabelType>sample string 3</LabelType>
<LastmileResponse>sample string 5</LastmileResponse>
<TrackingNo>sample string 1</TrackingNo>
</AWBLabels>
<AWBLabels>
<Label>sample string 2</Label>
<LabelFor>sample string 4</LabelFor>
<LabelType>sample string 3</LabelType>
<LastmileResponse>sample string 5</LastmileResponse>
<TrackingNo>sample string 1</TrackingNo>
</AWBLabels>
</AWBLabels>
<AWBNo>sample string 3</AWBNo>
<Message>sample string 2</Message>
<Status>sample string 1</Status>
</BookingApiResponse>