价格文件匹配

通过价格文件匹配接口，可以将外部系统中的订单与oTMS的价格文件匹配并计算价格。

配置说明

oTMS同时在生产环境和测试环境中提供Web Service接口，其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。

注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。

接口说明

公共参数

环境	HTTP请求方法	HTTPS请求地址	请求主体MIME类型	响应主体MIME类型
正式环境	POST	`https://login.otms.cn/ws/tariff/tariffSuggestion/v0/buying`	application/xml	application/xml
沙箱环境	POST	`https://demo.otms.cn/ws/tariff/tariffSuggestion/v0/buying`	application/xml	application/xml

请求参数

字段名	位置	是否必填	描述	Schema
body	body	是	价格文件匹配请求	BuyingTariffSuggestionRequest

错误码解释

全局反馈代码

反馈代码	说明
0	调用者未通过验证。
1	不支持的请求版本。

单个请求反馈代码

反馈代码	说明
4001	无法用客户代码匹配到客户（仅针对SP用户）。
4002	未提供客户代码（仅针对SP用户）。
4005	无法用地区名称匹配到地区。
4010	公司尚未开启自定义字段功能。
4011	某个自定义字段被忽略，因为自定义字段配置中未打开该自定义字段。
4012	自定义枚举字段的选项无法用提供的逻辑名匹配。
4015	提货时间与送货时间未提供。
4020	请求中包含了运输类型“FTL”，因此卡车类型不能为“3”。
4021	请求中包含了运输类型“FTL”，因此车长不能为空。
4022	车长不是oTMS预定义的车长。
4023	请求中提供的车辆核载量信息无法在oTMS预定义的车辆核载量中找到匹配。
4024	请求中提供的车辆核载量信息在oTMS预定义的车辆核载量中匹配到多条。
4030	订单的提货点信息缺少。
4031	订单的提货点无法匹配到oTMS的邮编。
4032	订单的提货点匹配到了多个oTMS的邮编。
4035	订单的送货点信息缺少。
4036	订单的送货点无法匹配到oTMS的邮编。
4037	订单的送货点匹配到了多个oTMS的邮编。
4099	其他错误。

请求参数

Body 参数application/xml

示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<buyingTariffSuggestionRequest version="0.1" login="login" password="password">
    <orders>
        <order>
            <orderId></orderId>
            <origin>
                <province>山东省</province>
                <town>滨州市</town>
                <loading>false</loading>
            </origin>
            <destination>
                <province>河北省</province>
                <town>保定市</town>
                <loading>false</loading>
            </destination>
            <packageType>A</packageType>
            <cargoType>1</cargoType>
            <transportMode>
                <transportTypes>
                    <transportType>LTL</transportType>
                    <transportType>FTL</transportType>
                </transportTypes>
                <truckType>2</truckType>
                <truckDefinition>
                    <truckLength>4.2</truckLength>
                </truckDefinition>
            </transportMode>
            <timeSchedule>
                <pickupDate>2025-04-30T00:00:00</pickupDate>
            </timeSchedule>
            <cargoDetails>
                <quantity>0</quantity>
                <volume>0</volume>
                <weight>65000</weight>
                <insurance>0</insurance>
                <loadingMeter>0</loadingMeter>
            </cargoDetails>
        </order>
    </orders>
    <options>
        <suggestionMode>1</suggestionMode>
        <includeTariffAndVendorInfo>true</includeTariffAndVendorInfo>
        <includeRateDetails>true</includeRateDetails>
        <truckSizeStrictMatching>false</truckSizeStrictMatching>
        <locationStrictMatching>false</locationStrictMatching>
        <matchByCustomFields>true</matchByCustomFields>
        <includeUnitRate>false</includeUnitRate>
    </options>
</buyingTariffSuggestionRequest>

返回响应

🟢200成功

application/xml

successful operation

Body

示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<buyingTariffSuggestionResponse version="0.1">
    <successOrderCount>1</successOrderCount>
    <matchedTariffs>
        <tariff>
            <sequence>0</sequence>
            <tariffName>测试文件3</tariffName>
            <tariffTransportType>LTL</tariffTransportType>
            <vendor>
                <vendorName>test0318.2</vendorName>
                <vendorShortCode>OSINSOCI</vendorShortCode>
            </vendor>
        </tariff>
    </matchedTariffs>
    <buyingSuggestions>
        <buyingSuggestion>
            <orderId></orderId>
            <success>true</success>
            <suggestions>
                <suggestion>
                    <matchingLane>
                        <laneOrigin>
                            <province>山东省</province>
                            <town>滨州市</town>
                        </laneOrigin>
                        <laneDestination>
                            <province>河北省</province>
                            <town>保定市</town>
                        </laneDestination>
                    </matchingLane>
                    <rate>130.00</rate>
                    <leadtime>24</leadtime>
                    <tariffSequence>0</tariffSequence>
                    <rateDetails>
                        <baseRate>130.00</baseRate>
                        <otherRate>0</otherRate>
                        <loadingFee>0</loadingFee>
                        <extraPointFee>0</extraPointFee>
                        <tariffTransportType>LTL</tariffTransportType>
                    </rateDetails>
                    <matchedByCustomFields>false</matchedByCustomFields>
                    <matchedByDefaultLane>false</matchedByDefaultLane>
                </suggestion>
            </suggestions>
            <responseCodes>
                <responseCode>4032</responseCode>
                <responseCode>4037</responseCode>
            </responseCodes>
        </buyingSuggestion>
    </buyingSuggestions>
</buyingTariffSuggestionResponse>

价格文件匹配

价格文件匹配#

配置说明#

接口说明#

公共参数#

请求参数#

错误码解释#

全局反馈代码#

单个请求反馈代码#

请求参数

返回响应

价格文件匹配

配置说明

接口说明

公共参数

请求参数

错误码解释

全局反馈代码

单个请求反馈代码