oTMS-openapi
  1. oTMS API
oTMS-openapi
  • oTMS API
    • 订单导入
      PUT
    • 订单导出/追踪
      POST
    • 提送货点导入
      PUT
    • 提送货点删除
      DELETE
    • 卡车和司机导入
      PUT
    • 订单分配司机
      POST
    • 运输单导入
      PUT
    • 运输单删除
      PUT
    • 订单外部追踪
      POST
    • 订单召回
      POST
    • 订单分享链接
      PUT
    • 承运商导出
      POST
    • h5链接
      PUT
    • 订单更新
      PUT
    • 订单费用更新
      POST
    • 订单分配
      POST
    • 车辆信息
      POST
    • 订单撤销
      PUT
    • 运输单分配司机
      PUT
    • 订单评分
      POST
    • 订单交接创建
      PUT
    • 订单自定义文本字段更新
      POST
    • 订单快速交接
      POST
    • 价格文件匹配
      POST
    • 收货方/发货方导出
      POST
    • 运输单导出/追踪
      POST
    • 运输单召回
      PUT
    • 文件上传
      POST
    • 订单事件推送
      PUT
    • 运输单事件推送
      PUT
    • 拒收导出
      POST
    • 收货码查询
      POST
    • 便携式设备导入
      POST
  1. oTMS API

收货方/发货方导出

POST
https://login.otms.cn/ws/shipPointOutbound

收货方/发货方导出#

通过收货方/发货方导出接口，客户系统可以接入 oTMS 系统，查询 oTMS 中的收发货方信息和状态。
版本号文档说明
0.1当前版本文档

配置说明#

oTMS同时在生产环境和测试环境中提供Web Service接口，其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多 [数量缺失] 个请求。（原文中请求限制数量未填写）

接口说明#

公共参数#

环境HTTP请求方法HTTPS请求地址请求主体MIME类型响应主体MIME类型
正式环境POSThttps://login.otms.cn/ws/shipPointOutboundapplication/xmlapplication/xml
沙箱环境POSThttps://demo.otms.cn/ws/shipPointOutboundapplication/xmlapplication/xml

请求参数#

字段名位置是否必填描述Schema
Authorizationheader否Basic Authorization。如果不为空，则优先使用该值作身份认证。否则使用请求报文中的用户名与密码string
bodybody是收发货方查询请求。包含用以筛选收发货方的查询条件ShipPointOutboundRequest

错误码解释#

全局反馈代码#

反馈代码说明
0客户验证失败。
1不支持的请求版本。
2请求中的提送货点数据过多。

请求参数

Body 参数application/xml

示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointOutboundRequest version="0.1" login="login" password="password">
    <queries>
        <query>
            <attribute>updatedOn</attribute>
            <le>2023-11-30</le>
            <ge>2023-11-01</ge>
        </query>
        <query>
            <attribute>externalId</attribute>
            <in>
                <value>XC201</value>
                <value>ZZS301</value>
            </in>
        </query>
        <query>
            <attribute>locationType</attribute>
            <eq>1</eq>
        </query>        
    </queries>
    <start>1</start>
    <count>10</count>
</shipPointOutboundRequest>

返回响应

🟢200成功
application/xml
successful operation
Body

示例
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipPointOutboundResponse>
    <shipPoints>
        <shipPoint>
            <name>赣州</name>
            <externalId>ZZS301</externalId>
            <province>江西省</province>
            <town>赣州市</town>
            <county>于都县</county>
            <address>江西省,赣州市,于都县</address>
            <zipcode>3423**</zipcode>
            <contactName>赣州</contactName>
            <contactMobile>13918580094</contactMobile>
            <contactPhone>null-null</contactPhone>
            <longitude>115.4214992615303</longitude>
            <latitude>25.95789394275063</latitude>
            <locationType>1</locationType>
            <customFields>
                <customText12>安踏</customText12>
            </customFields>
            <id>215253</id>
            <updatedOn>2023-11-29T17:06:58.183+08:00</updatedOn>
        </shipPoint>
        <shipPoint>
            <name>临沂</name>
            <externalId>XC201</externalId>
            <province>山东省</province>
            <town>临沂市</town>
            <address>临沂市</address>
            <zipcode>276***</zipcode>
            <contactName>临沂</contactName>
            <contactMobile>13918580094</contactMobile>
            <contactPhone>-</contactPhone>
            <contactEmail></contactEmail>
            <longitude>118.36353300501388</longitude>
            <latitude>35.11067124236514</latitude>
            <locationType>1</locationType>
            <customFields>
                <customText1>201</customText1>
                <customText2>202</customText2>
                <customText3>203</customText3>
                <customText4>204</customText4>
                <customText5>205</customText5>
                <customText6>206</customText6>
                <customText7>207</customText7>
                <customText8>208</customText8>
                <customText9>209</customText9>
                <customText10>210</customText10>
                <customText11>211</customText11>
                <customText12>212</customText12>
                <customText13>213</customText13>
                <customText14>214</customText14>
                <customText15>215</customText15>
                <customText16>216</customText16>
                <customText17>217</customText17>
                <customText18>218</customText18>
                <customText19>219</customText19>
                <customText20>220</customText20>
                <customText21>221</customText21>
                <customText22>222</customText22>
                <customText23>223</customText23>
                <customText24>224</customText24>
                <customText25>225</customText25>
                <customText26>226</customText26>
                <customText27>227</customText27>
                <customText28>228</customText28>
                <customText29>229</customText29>
                <customText30>230</customText30>
                <customText31>231</customText31>
                <customText32>232</customText32>
                <customText33>233</customText33>
                <customText34>234</customText34>
                <customText35>235</customText35>
                <customText36>236</customText36>
                <customText37>237</customText37>
                <customText38>238</customText38>
                <customText39>239</customText39>
                <customText40>240</customText40>
                <customText41>241</customText41>
                <customText42>242</customText42>
                <customText43>243</customText43>
                <customText44>244</customText44>
                <customText45>245</customText45>
                <customText46>246</customText46>
                <customText47>247</customText47>
                <customText48>248</customText48>
                <customText49>249</customText49>
                <customText50>250</customText50>
                <customText51>251</customText51>
                <customText52>252</customText52>
                <customText53>253</customText53>
                <customText54>254</customText54>
                <customText55>255</customText55>
                <customText56>256</customText56>
                <customText57>257</customText57>
                <customText58>258</customText58>
                <customText59>259</customText59>
                <customText60>260</customText60>
                <customText61>261</customText61>
                <customText62>262</customText62>
                <customText63>263</customText63>
                <customText64>264</customText64>
                <customText65>265</customText65>
                <customText66>266</customText66>
                <customText67>267</customText67>
                <customText68>268</customText68>
                <customText69>269</customText69>
                <customText70>270</customText70>
                <customText71>271</customText71>
                <customText72>272</customText72>
                <customText73>273</customText73>
                <customText74>274</customText74>
                <customText75>275</customText75>
                <customText76>276</customText76>
                <customText77>277</customText77>
                <customText78>278</customText78>
                <customText79>279</customText79>
                <customText80>280</customText80>
            </customFields>
            <id>216052</id>
            <updatedOn>2023-11-29T17:06:47.314+08:00</updatedOn>
        </shipPoint>
    </shipPoints>
    <start>1</start>
    <count>10</count>
    <total>2</total>
</shipPointOutboundResponse>
上一页
价格文件匹配
下一页
运输单导出/追踪
Built with