GET v1/order/{number}?_id={_id}
查询订单详情
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| number |
运单号 |
string |
Required |
| _id |
API ID |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
查询订单详情
ApiOrderResult| Name | Description | Type | Additional information |
|---|---|---|---|
| code |
API执行状态码 |
ApiStatusCode |
None. |
| msg |
返回消息 |
string |
None. |
| total_count |
总记录条数 |
integer |
None. |
| page_size |
页大小 |
integer |
None. |
| total_page |
总页数 |
integer |
None. |
| current_page |
当前页数,当前页数小于总页数时,表示还有更多页 |
integer |
None. |
| orders |
订单列表 |
Collection of OrderInfo |
None. |
Response Formats
application/json, text/json
Sample:
{
"code": 0,
"msg": "sample string 1",
"total_count": 2,
"page_size": 3,
"total_page": 4,
"current_page": 5,
"orders": [
{
"id": 1,
"number": "sample string 2",
"name": "sample string 3",
"customer_number": "sample string 4",
"first_mile_number": "sample string 5",
"customer_code": "sample string 6",
"customer_name": "sample string 7",
"ttk": "sample string 8",
"channel_code": "sample string 9",
"channel_name": "sample string 10",
"type": "sample string 11",
"state": 1,
"packs": 1,
"weight": 1.0,
"length": 1.0,
"width": 1.0,
"height": 1.0,
"cbm": 1.0,
"clear": "sample string 12",
"insurance": 1.0,
"price": 1.0,
"label_state": "sample string 13",
"currency": "sample string 14",
"receiver": {
"name": "sample string 1",
"address": "sample string 2",
"country": "sample string 3",
"state": "sample string 4",
"city": "sample string 5",
"suburb": "sample string 6",
"postcode": "sample string 7",
"phone": "sample string 8",
"email": "sample string 9",
"tax_id": "sample string 10"
},
"sender": {
"name": "sample string 1",
"address": "sample string 2",
"country": "sample string 3",
"state": "sample string 4",
"city": "sample string 5",
"suburb": "sample string 6",
"postcode": "sample string 7",
"phone": "sample string 8",
"email": "sample string 9",
"tax_id": "sample string 10"
},
"return_of_address": {
"name": "sample string 1",
"address": "sample string 2",
"country": "sample string 3",
"state": "sample string 4",
"city": "sample string 5",
"suburb": "sample string 6",
"postcode": "sample string 7",
"phone": "sample string 8",
"email": "sample string 9",
"tax_id": "sample string 10"
},
"notes": "sample string 15",
"contract_no": "sample string 16",
"items": [
{
"type": "sample string 1",
"name": "sample string 2",
"cname": "sample string 3",
"brand": "sample string 4",
"model": "sample string 5",
"quantity": 6,
"unit_value": 7.0,
"hs_code": "sample string 8",
"material": "sample string 9",
"purpose": "sample string 10",
"sku": "sample string 11",
"url": "sample string 12",
"ean": "sample string 13",
"serial_no": "sample string 14"
},
{
"type": "sample string 1",
"name": "sample string 2",
"cname": "sample string 3",
"brand": "sample string 4",
"model": "sample string 5",
"quantity": 6,
"unit_value": 7.0,
"hs_code": "sample string 8",
"material": "sample string 9",
"purpose": "sample string 10",
"sku": "sample string 11",
"url": "sample string 12",
"ean": "sample string 13",
"serial_no": "sample string 14"
}
]
},
{
"id": 1,
"number": "sample string 2",
"name": "sample string 3",
"customer_number": "sample string 4",
"first_mile_number": "sample string 5",
"customer_code": "sample string 6",
"customer_name": "sample string 7",
"ttk": "sample string 8",
"channel_code": "sample string 9",
"channel_name": "sample string 10",
"type": "sample string 11",
"state": 1,
"packs": 1,
"weight": 1.0,
"length": 1.0,
"width": 1.0,
"height": 1.0,
"cbm": 1.0,
"clear": "sample string 12",
"insurance": 1.0,
"price": 1.0,
"label_state": "sample string 13",
"currency": "sample string 14",
"receiver": {
"name": "sample string 1",
"address": "sample string 2",
"country": "sample string 3",
"state": "sample string 4",
"city": "sample string 5",
"suburb": "sample string 6",
"postcode": "sample string 7",
"phone": "sample string 8",
"email": "sample string 9",
"tax_id": "sample string 10"
},
"sender": {
"name": "sample string 1",
"address": "sample string 2",
"country": "sample string 3",
"state": "sample string 4",
"city": "sample string 5",
"suburb": "sample string 6",
"postcode": "sample string 7",
"phone": "sample string 8",
"email": "sample string 9",
"tax_id": "sample string 10"
},
"return_of_address": {
"name": "sample string 1",
"address": "sample string 2",
"country": "sample string 3",
"state": "sample string 4",
"city": "sample string 5",
"suburb": "sample string 6",
"postcode": "sample string 7",
"phone": "sample string 8",
"email": "sample string 9",
"tax_id": "sample string 10"
},
"notes": "sample string 15",
"contract_no": "sample string 16",
"items": [
{
"type": "sample string 1",
"name": "sample string 2",
"cname": "sample string 3",
"brand": "sample string 4",
"model": "sample string 5",
"quantity": 6,
"unit_value": 7.0,
"hs_code": "sample string 8",
"material": "sample string 9",
"purpose": "sample string 10",
"sku": "sample string 11",
"url": "sample string 12",
"ean": "sample string 13",
"serial_no": "sample string 14"
},
{
"type": "sample string 1",
"name": "sample string 2",
"cname": "sample string 3",
"brand": "sample string 4",
"model": "sample string 5",
"quantity": 6,
"unit_value": 7.0,
"hs_code": "sample string 8",
"material": "sample string 9",
"purpose": "sample string 10",
"sku": "sample string 11",
"url": "sample string 12",
"ean": "sample string 13",
"serial_no": "sample string 14"
}
]
}
]
}
multipart/form-data
Sample:
{"code":0,"msg":"sample string 1","total_count":2,"page_size":3,"total_page":4,"current_page":5,"orders":[{"id":1,"number":"sample string 2","name":"sample string 3","customer_number":"sample string 4","first_mile_number":"sample string 5","customer_code":"sample string 6","customer_name":"sample string 7","ttk":"sample string 8","channel_code":"sample string 9","channel_name":"sample string 10","type":"sample string 11","state":1,"packs":1,"weight":1.0,"length":1.0,"width":1.0,"height":1.0,"cbm":1.0,"clear":"sample string 12","insurance":1.0,"price":1.0,"label_state":"sample string 13","currency":"sample string 14","receiver":{"name":"sample string 1","address":"sample string 2","country":"sample string 3","state":"sample string 4","city":"sample string 5","suburb":"sample string 6","postcode":"sample string 7","phone":"sample string 8","email":"sample string 9","tax_id":"sample string 10"},"sender":{"name":"sample string 1","address":"sample string 2","country":"sample string 3","state":"sample string 4","city":"sample string 5","suburb":"sample string 6","postcode":"sample string 7","phone":"sample string 8","email":"sample string 9","tax_id":"sample string 10"},"return_of_address":{"name":"sample string 1","address":"sample string 2","country":"sample string 3","state":"sample string 4","city":"sample string 5","suburb":"sample string 6","postcode":"sample string 7","phone":"sample string 8","email":"sample string 9","tax_id":"sample string 10"},"notes":"sample string 15","contract_no":"sample string 16","items":[{"type":"sample string 1","name":"sample string 2","cname":"sample string 3","brand":"sample string 4","model":"sample string 5","quantity":6,"unit_value":7.0,"hs_code":"sample string 8","material":"sample string 9","purpose":"sample string 10","sku":"sample string 11","url":"sample string 12","ean":"sample string 13","serial_no":"sample string 14"},{"type":"sample string 1","name":"sample string 2","cname":"sample string 3","brand":"sample string 4","model":"sample string 5","quantity":6,"unit_value":7.0,"hs_code":"sample string 8","material":"sample string 9","purpose":"sample string 10","sku":"sample string 11","url":"sample string 12","ean":"sample string 13","serial_no":"sample string 14"}]},{"id":1,"number":"sample string 2","name":"sample string 3","customer_number":"sample string 4","first_mile_number":"sample string 5","customer_code":"sample string 6","customer_name":"sample string 7","ttk":"sample string 8","channel_code":"sample string 9","channel_name":"sample string 10","type":"sample string 11","state":1,"packs":1,"weight":1.0,"length":1.0,"width":1.0,"height":1.0,"cbm":1.0,"clear":"sample string 12","insurance":1.0,"price":1.0,"label_state":"sample string 13","currency":"sample string 14","receiver":{"name":"sample string 1","address":"sample string 2","country":"sample string 3","state":"sample string 4","city":"sample string 5","suburb":"sample string 6","postcode":"sample string 7","phone":"sample string 8","email":"sample string 9","tax_id":"sample string 10"},"sender":{"name":"sample string 1","address":"sample string 2","country":"sample string 3","state":"sample string 4","city":"sample string 5","suburb":"sample string 6","postcode":"sample string 7","phone":"sample string 8","email":"sample string 9","tax_id":"sample string 10"},"return_of_address":{"name":"sample string 1","address":"sample string 2","country":"sample string 3","state":"sample string 4","city":"sample string 5","suburb":"sample string 6","postcode":"sample string 7","phone":"sample string 8","email":"sample string 9","tax_id":"sample string 10"},"notes":"sample string 15","contract_no":"sample string 16","items":[{"type":"sample string 1","name":"sample string 2","cname":"sample string 3","brand":"sample string 4","model":"sample string 5","quantity":6,"unit_value":7.0,"hs_code":"sample string 8","material":"sample string 9","purpose":"sample string 10","sku":"sample string 11","url":"sample string 12","ean":"sample string 13","serial_no":"sample string 14"},{"type":"sample string 1","name":"sample string 2","cname":"sample string 3","brand":"sample string 4","model":"sample string 5","quantity":6,"unit_value":7.0,"hs_code":"sample string 8","material":"sample string 9","purpose":"sample string 10","sku":"sample string 11","url":"sample string 12","ean":"sample string 13","serial_no":"sample string 14"}]}]}
application/xml, text/xml
Sample:
<ApiOrderResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SumX.Web.Models">
<code>API_SUCCESS</code>
<current_page>5</current_page>
<msg>sample string 1</msg>
<orders>
<OrderInfo>
<cbm>1</cbm>
<channel_code>sample string 9</channel_code>
<channel_name>sample string 10</channel_name>
<clear>sample string 12</clear>
<contract_no>sample string 16</contract_no>
<currency>sample string 14</currency>
<customer_code>sample string 6</customer_code>
<customer_name>sample string 7</customer_name>
<customer_number>sample string 4</customer_number>
<first_mile_number>sample string 5</first_mile_number>
<height>1</height>
<id>1</id>
<insurance>1</insurance>
<items>
<OrderItem>
<brand>sample string 4</brand>
<cname>sample string 3</cname>
<ean>sample string 13</ean>
<hs_code>sample string 8</hs_code>
<material>sample string 9</material>
<model>sample string 5</model>
<name>sample string 2</name>
<purpose>sample string 10</purpose>
<quantity>6</quantity>
<serial_no>sample string 14</serial_no>
<sku>sample string 11</sku>
<type>sample string 1</type>
<unit_value>7</unit_value>
<url>sample string 12</url>
</OrderItem>
<OrderItem>
<brand>sample string 4</brand>
<cname>sample string 3</cname>
<ean>sample string 13</ean>
<hs_code>sample string 8</hs_code>
<material>sample string 9</material>
<model>sample string 5</model>
<name>sample string 2</name>
<purpose>sample string 10</purpose>
<quantity>6</quantity>
<serial_no>sample string 14</serial_no>
<sku>sample string 11</sku>
<type>sample string 1</type>
<unit_value>7</unit_value>
<url>sample string 12</url>
</OrderItem>
</items>
<label_state>sample string 13</label_state>
<length>1</length>
<name>sample string 3</name>
<notes>sample string 15</notes>
<number>sample string 2</number>
<packs>1</packs>
<price>1</price>
<receiver>
<address>sample string 2</address>
<city>sample string 5</city>
<country>sample string 3</country>
<email>sample string 9</email>
<name>sample string 1</name>
<phone>sample string 8</phone>
<postcode>sample string 7</postcode>
<state>sample string 4</state>
<suburb>sample string 6</suburb>
<tax_id>sample string 10</tax_id>
</receiver>
<return_of_address>
<address>sample string 2</address>
<city>sample string 5</city>
<country>sample string 3</country>
<email>sample string 9</email>
<name>sample string 1</name>
<phone>sample string 8</phone>
<postcode>sample string 7</postcode>
<state>sample string 4</state>
<suburb>sample string 6</suburb>
<tax_id>sample string 10</tax_id>
</return_of_address>
<sender>
<address>sample string 2</address>
<city>sample string 5</city>
<country>sample string 3</country>
<email>sample string 9</email>
<name>sample string 1</name>
<phone>sample string 8</phone>
<postcode>sample string 7</postcode>
<state>sample string 4</state>
<suburb>sample string 6</suburb>
<tax_id>sample string 10</tax_id>
</sender>
<state>1</state>
<ttk>sample string 8</ttk>
<type>sample string 11</type>
<weight>1</weight>
<width>1</width>
</OrderInfo>
<OrderInfo>
<cbm>1</cbm>
<channel_code>sample string 9</channel_code>
<channel_name>sample string 10</channel_name>
<clear>sample string 12</clear>
<contract_no>sample string 16</contract_no>
<currency>sample string 14</currency>
<customer_code>sample string 6</customer_code>
<customer_name>sample string 7</customer_name>
<customer_number>sample string 4</customer_number>
<first_mile_number>sample string 5</first_mile_number>
<height>1</height>
<id>1</id>
<insurance>1</insurance>
<items>
<OrderItem>
<brand>sample string 4</brand>
<cname>sample string 3</cname>
<ean>sample string 13</ean>
<hs_code>sample string 8</hs_code>
<material>sample string 9</material>
<model>sample string 5</model>
<name>sample string 2</name>
<purpose>sample string 10</purpose>
<quantity>6</quantity>
<serial_no>sample string 14</serial_no>
<sku>sample string 11</sku>
<type>sample string 1</type>
<unit_value>7</unit_value>
<url>sample string 12</url>
</OrderItem>
<OrderItem>
<brand>sample string 4</brand>
<cname>sample string 3</cname>
<ean>sample string 13</ean>
<hs_code>sample string 8</hs_code>
<material>sample string 9</material>
<model>sample string 5</model>
<name>sample string 2</name>
<purpose>sample string 10</purpose>
<quantity>6</quantity>
<serial_no>sample string 14</serial_no>
<sku>sample string 11</sku>
<type>sample string 1</type>
<unit_value>7</unit_value>
<url>sample string 12</url>
</OrderItem>
</items>
<label_state>sample string 13</label_state>
<length>1</length>
<name>sample string 3</name>
<notes>sample string 15</notes>
<number>sample string 2</number>
<packs>1</packs>
<price>1</price>
<receiver>
<address>sample string 2</address>
<city>sample string 5</city>
<country>sample string 3</country>
<email>sample string 9</email>
<name>sample string 1</name>
<phone>sample string 8</phone>
<postcode>sample string 7</postcode>
<state>sample string 4</state>
<suburb>sample string 6</suburb>
<tax_id>sample string 10</tax_id>
</receiver>
<return_of_address>
<address>sample string 2</address>
<city>sample string 5</city>
<country>sample string 3</country>
<email>sample string 9</email>
<name>sample string 1</name>
<phone>sample string 8</phone>
<postcode>sample string 7</postcode>
<state>sample string 4</state>
<suburb>sample string 6</suburb>
<tax_id>sample string 10</tax_id>
</return_of_address>
<sender>
<address>sample string 2</address>
<city>sample string 5</city>
<country>sample string 3</country>
<email>sample string 9</email>
<name>sample string 1</name>
<phone>sample string 8</phone>
<postcode>sample string 7</postcode>
<state>sample string 4</state>
<suburb>sample string 6</suburb>
<tax_id>sample string 10</tax_id>
</sender>
<state>1</state>
<ttk>sample string 8</ttk>
<type>sample string 11</type>
<weight>1</weight>
<width>1</width>
</OrderInfo>
</orders>
<page_size>3</page_size>
<total_count>2</total_count>
<total_page>4</total_page>
</ApiOrderResult>