eTower Developers
页面树结构
转至元数据结尾
转至元数据起始

Table of Contents

Description

Rate Inquiry API allows Shipper to query the estimated order Rate information before placing an order.

Please notice:

  • The prerequisite for using this API is that the related services of the Shipper have already been configured with financial information such as Rate Card in eTower. For details, please contact the integrator.
  • Whether the optional fields need to be filled is different from each service, please contact the integrator for details.
  • The rate returned in this API is for reference only, the final rate is subject to the actual bill.

Path

HTTP Verb URL
Post/services/shipper/rate-inquiry

Request Fields

1Field (API)Data Type

Length

MandatoryDetails
2serviceCodeString64MService code, provided by logistics provider
3serviceOptionString64OService Option, provided by logistics provider
4weightDouble　Mweight(>=0.000001)
5weightUnitString3OWeight unit, enumeration value：G, KG,LB
Default value：KG
6lengthDouble　OLength of the Shipment
7widthDouble　OWidth of the Shipment
8heightDouble　OHeight of the Shipment
9dimensionUnitString3OLength unit, enumeration value：M, CM
Default value：CM
10batteryPackingString64OBattery packaging，enumerator values：
  • No Battery
  • Inside Equipment
  • Packaged with Equipment
  • Battery Only
  • Other
Default value：No Battery
11facilityString20OShipper shipping facility, provided by logistics provider
12cityString80ORecipient City
13stateString80ORecipient State

Limit English / French characters / non pure numbers
Automatic removal of special characters
14postcodeString16ORecipient Zip code
15countryString2MRecipient Country two character code
16piecesArray
M
17
weight
O
18
length


19
width


20
height


Request Sample

Response
{
    "serviceCode": "example",
    "serviceOption": "",
    "weight": "6",
    "weightUnit": "KG",
    "length": "10.00",
    "width": "10.00",
    "height": "10.00",
    "dimensionUnit": "CM",
    "batteryPacking": "",
    "facility": "",
    "city": "Carpi",
    "state": "Modena",
    "postcode": "41012",
    "country": "IT",
    "pieces": [
        {
            "weight": "6",
            "length": "10",
            "width": "10",
            "height": "10"
        },
        {
            "weight": "6",
            "length": "10",
            "width": "10",
            "height": "10"
        }
    ]
}

Response Fields

1Field (API)Data TypeDetails
2status
Failure/ Success
3errors

4
codeDoubleError Code
5
messageStringError Message
6billingItem

7

destination

StringRecipient Country
8

currency

StringCurrency
9

amount

DoubleBasic Rate
10

batteryCharge

DoubleBattery Surcharge
11

surcharge

DoubleOther Surcharge
12

totalAmount

DoubleTotal Rate
13

taxRate

DoubleTariff Rates 
14

tax

DoubleTariff
15

weight

DoubleCharged weight
16

vat

DoubleValue-added Tax
17

vatRate

DoubleValue-added Tax Rates
18

totalTax

DoubleTotal Tax
19

fuelSurcharge

DoubleFuel Surcharge
20

totalSurcharge

DoubleTotal Surcharge
21

remoteAreaSurcharge

DoubleRemote Area Surcharge
22
billDetailSpecialDTOListArraySpecial Surcharge (totally independent from all the other surcharges)
23

billDetailUuidStringUnique ID of Entry
24

feeIdStringFee ID
25

feeNameCnStringFee Name
26

feeNameStringEN Fee Name
27

feeDisplayNameStringDisplay Name (Abandoned)
28

amountDoubleAmount
29

currencyStringCurrency


Response Sample

Response
{
    "status": "Success",
    "errors": null,
    "data": [
        {
            "amount": 5.6,
            "battery": false,
            "counterAmount": null,
            "counterWeight": null,
            "currency": "USD",
            "description": null,
            "dropOff": true,
            "remarks": "计费分区 徐丽丽专属测试",
            "status": 1,
            "tax": 0.0,
            "taxRate": 0.0,
            "totalAmount": 49.6,
            "trackingNo": "",
            "weight": 6.0,
            "billingLineItemUuid": null,
            "billingFrom": 100,
            "billingTo": 100,
            "batteryCharge": 0.0,
            "surcharge": 0.0,
            "freightRateId": "wwoZMY5gE4N4RBBANNk5Uw",
            "insuranceAmount": null,
            "surchargeRateId": "ncsWsKAxEKmpQWDIPi7R9g",
            "insuranceExchangeRate": null,
            "discount": 0.2,
            "serviceOption": "*",
            "unit": "KG",
            "fuelSurcharge": 0.0,
            "totalSurcharge": 44.0,
            "remoteAreaSurcharge": 14.0,
            "totalTax": 0.0,
            "vat": 0.0,
            "vatRate": 0.0,
            "volumeRatio": "",
            "serviceName": null,
            "service": 377,
            "bulkyCargoFlag": null,
            "parcelUuid": null,
            "refNo": null,
            "billDetailSpecialDTOList": [
                {
                    "billDetailUuid": null,
                    "feeId": "2305161551231000001",
                    "feeNameCn": "清关服务费",
                    "feeName": "Clearance",
                    "feeDisplayName": null,
                    "amount": 30.0,
                    "currency": "USD"
                }
            ]
        }
    ],
    "warnings": null
}


Error Message

CodeMessage
950002Parameter is null.
100124Service Code is invalid.
990000All parcel calculate rate is null.





  • 无标签