# API通用说明

### 获取 API Key(apiName) 和 API Token(apiToken)

*   在客户中心注册用户——>登录系统——>账户管理——>API信息对接信息：
    ![image](https://f.sendatek.com/settings/api_guide.png)

# 尾程派送API

> #### \*说明
>
> 所有请求都需要添加请求头：Content-Type\:application/json

## 一、查询客户的产品列表

*   以https 请求使用JSON 的格式传入如下参数来进行在线查询客户的产品列表
*   请求链接：<https://open.sendatek.com/openapi/api-order/requestCustomerProducts>
*   请求类型：POST

#### 1. 传入参数

```json
{
	"apiName": "YS21094",
	"apiToken": "73fd527d0d91dbd2e243ddb61dbff157",
	"destinationNo": ""
}
```

#### 2. 传入参数说明

*   apiName:（字符串类型 必填） 认证的API 的名称。
*   apiToken: （字符串类型 必填） 认证的API 的名称对应的token。
*   destinationNo:（字符串类型 非必填） 目的地二字编码。

#### 3. 响应结果集

```json
{
  "flag": true,
  "rows": [
    {
      "code": "GGCP",
      "id": "a7505646a43a4f528dc60d7a4be6298c",
      "name": "公共产品测试"
    },
    {
      "code": "SWBG",
      "id": "0baeb728ca464f3eac045f8d2b6ba053",
      "name": "商务包裹"
    },
    {
      "code": "GZ4",
      "id": "4537d76dafe0445ca8c5c33aebcc1ec5",
      "name": "规则4"
    },
    {
      "code": "MPZX1",
      "id": "46deccb61c1341a5b024ab1bb76c79a5",
      "name": "免泡专线"
    }
  ],
  "total": 4
}
```

#### 4. 响应参数说明

*   flag:请求结果标识。true 表示返回成功. false 表示请求失败。
*   rows: 返回获取的产品信息对象数组。
    *   code：产品或规则编码。
    *   id：产品或规则id。
    *   name：产品或规则名称。
*   total:查询到的产品或规则的数量。

## 二、下单（包括修改）

*   以https 请求使用JSON 的格式传入如下参数来进行在线下单
*   请求链接：<https://open.sendatek.com/openapi/api-order/order>
*   请求类型：POST

> #### \*修改说明
>
> 根据参考号（referenceNo）是否相同自动启用修改逻辑，参考号所创建的订单处于预录单状态并且未出贴才能进行修改

#### 1. 传入参数

且供参考（详细字段见参数说明）

```json
{
    "apiName": "YS211151",
    "apiToken": "d47bcfd45790fe3ab4c833867bfb5ec8",
    "order": {
        "destinationNo": "US",
        "productCode": "ZHUIZONG",
        "referenceNo": "test11108",
        "boxList": [
            {
                "goodsList": [
                    {
                        "name": "苹果",
                        "nameEn": "apple",
                        "quantity": 1,
                        "reportPrice": 1.23,
                        "weight": 1.345
                    }
                ],
                "height": 3,
                "length": 2,
                "weight": 1,
                "width": 1,
				"referenceNo": "BOX00000001"
            }
        ],
        "deliveryAddress": {
            "consignee": "Valérie Roxo",
            "cellphoneNo": "13352414568",
            "email": "53062555@qq.com",
            "province": "789",
            "city": "Andelnans",
            "address": "23 rue des orchidées",
            "postcode": "90400"
        },
        "senderAddress": {
            "sender": "123",
            "cellphoneNo": "+8618610415717",
            "province": "789",
            "countryCode": "CN",
            "city": "wuhan",
            "address": "address",
            "postcode": "441100"
        }
    }
}
```

#### 2. 传入参数说明

*   apiName:（字符串类型 必填） 认证的API 的名称。
*   apiToken: （字符串类型 必填） 认证的API 的名称对应的token。
*   order:（对象 必填） 订单对象。
    *   destinationNo：（字符串类型 必填）目的地二字编码。
    *   productCode：（字符串类型 必填）产品或规则编码。
    *   referenceNo：（字符串类型。 必填）参考号（当参考号相同时表示修改订单货物信息）（如果你们当前存在系统，那么通常表示你们系统的业务号）。
    *   boxList：（数组类型 必填）箱子列表，包裹列表。
        *   goodsList：（数组类型 必填）物品列表。
            *   name：（字符串 必填）商品中文名。
            *   nameEn：（字符串 必填）商品英文名。
            *   quantity:（数字整形 必填>0） 商品数量。
            *   reportPrice:（数字浮点型 必填）单个商品申报价值 (单位：美元) 。
            *   weight:（数字浮点型 必填）单个商品的重量(单位：kg)。
            *   brand:（字符串类型 非必填）品牌。
            *   elements:（字符串类型 非必填）申报要素。
            *   hsCode:（字符串类型 非必填）hsCode码。
            *   material:（字符串类型 非必填）材质。
            *   purpose:（字符串类型 非必填）用途。
            *   sku:（字符串类型 非必填）sku客户商品配货信息。
            *   url:（字符串类型 非必填）url产品链接(或ASIN码)。
        *   height: （数字整形 必填） 箱子的高 单位厘米(cm)。
        *   length: （数字整形 必填） 箱子的长 单位厘米(cm)。
        *   weight: （数字浮点型 必填）箱子的重量(单位：kg)。
        *   width: （数字整形 必填） 箱子的宽 单位厘米(cm)。
        *   referenceNo：（字符串类型 非必填）箱子参考号。
    *   deliveryAddress：（对象类型 必填）收件人地址信息。
        *   consignee:（字符串 必填）派送地址中的收货人不能为空。
        *   cellphoneNo:（字符串 必填）派送地址中的电话。
        *   province:（字符串 必填）派送地址中的(地区/省/州)不能为空。
        *   city:（字符串 必填）,派送地址中的城市不能为空。
        *   address:（字符串 必填）派送地址中的地址不能为空。
        *   postcode:（字符串 必填）派送地址中的邮编。
        *   district:（字符串 非必填）区。
        *   address2:（字符串 非必填）地址2。
        *   houseNo:（字符串 非必填-德国必填）门牌号。
        *   companyName:（字符串 非必填）公司名称。
        *   phoneNo:（字符串 非必填）座机号码。
        *   customsClearanceNo:（字符串 非必填-韩国必填）通关号（韩国）。
        *   email:（字符串 非必填-依据不同产品）派送地址中的邮箱。
    *   senderAddress:（对象类型 必填）寄件中的发件人信息。
        *   sender:（字符串 必填）寄件地址中的寄件人不能为空。
        *   cellphoneNo:（字符串 必填）寄件地址中的(联系电话)不能为空,
        *   countryCode:（字符串 必填）寄件地址中的(出发地二字编码)不能为空。
        *   province:（字符串 必填）寄件地址中的(地区/省/州)不能为空。
        *   city:（字符串 必填）寄件地址中的(城市)不能为空。
        *   address:（字符串 必填）寄件地址中的(地址必填)不能为空。
        *   postcode:（字符串 必填）寄件地址中的(邮编)不能为空。
        *   address2:（字符串 非必填）地址2。
        *   companyName:（字符串 非必填）公司名称。
        *   phoneNo:（字符串 非必填）座机号码。
        *   email:（字符串 非必填）派送地址中的邮箱。
    *   codPrice:（字符串 非必填）cod金额。
    *   eoriNo:（字符串 非必填）eoriNo号。
    *   hmrcNo:（字符串 非必填）hmrcNo号。
    *   ioss:（字符串 非必填）ioss号。
    *   vatNo:（字符串 非必填）vat号。

#### 3. 响应结果集

```json
{
  "flag": true,
  "obj": {
    "id": "1d9e746a3d0a4ca78d02d675bc22d9ae",
    "insideNumber": "FEIYQ0000017603YQ",
    "referenceNo": "340669",
    "labelStatus": "REQUEST_OK",
    "deliveryNumber": "6b93f015a3034f21826d6fe14c6b5984"
    "labelPdfUrl": "https://open.sendatek.com/api/label/internal/order/1d9e746a3d0a4ca78d02d675bc22d9ae/pdf"
  },
  "total": 0
}

```

#### 4. 响应参数说明

*   flag:请求结果标识。true 表示下单成功. false 表示下单失败。
*   obj: 下单成功时返回的详情对象
    *   id：订单id。
    *   insideNumber：订单号。
    *   referenceNo：客户下单是的参考号。
    *   labelStatus：获取标签状态：当值为‘REQUEST\_OK’时deliveryNumber与labelPdfUrl字段有值，当不为‘REQUEST\_OK’时labelErrorMsg字段有值。
    *   deliveryNumber：派送单号。
    *   labelPdfUrl：pdf标签的路径。
    *   labelErrorMsg：获取标签异常描述。
*   msg: 请求失败时异常错误提示语。

## 三、取消订单接口

*   以https 请求使用JSON 的格式传入如下参数来进行在取消订单接口
*   请求链接：<https://open.sendatek.com/openapi/api-order/cancelOrder>
*   请求类型：POST

> #### \*可取消前提
>
> 1.  自有订单状态：不可发货、可发货及未上网
> 2.  签约订单状态：不可发货

#### 1. 传入参数

```json
{
	"apiName": "YS21094",
	"apiToken": "24759d96b6afdf132df9486367f93705",
	"orderNo": "FEIYQ0000298059YQ",
	"reason": "test"
}
```

#### 2. 传入参数说明

*   apiName:（字符串类型 必填） 认证的API 的名称。
*   apiToken: （字符串类型 必填） 认证的API 的名称对应的token。
*   orderNo:（字符串类型 必填） 系统订单号。
*   reason:（字符串类型 必填） 取消原因说明。

#### 3. 响应结果集

```json
{
  "flag": true,
  "rows": [],
  "total": 0
}
```

#### 4. 响应参数说明

*   flag:请求结果标识。true 表示返回成功. false 表示请求失败。
*   msg: 当请求flag为false时，对失败的描述。

## 四、查询派送标签接口

*   以https 请求使用JSON 的格式传入如下参数来进行在线查询派送标签接口
*   请求链接：<https://open.sendatek.com/openapi/api-order/requestPdfUrl>
*   请求类型：POST

#### 1. 传入参数

```json
{
	"apiName": "YS21095",
	"apiToken": "1684ae8837d356fe61bf6df02801c21a",
	"orderNumbers": ["FEIYQ0000015989YQ"]
}
```

#### 2. 传入参数说明

*   apiName:（字符串类型 必填） 认证的API 的名称。
*   apiToken: （字符串类型 必填） 认证的API 的名称对应的token。
*   orderNumbers:（数组类型 必填最多40个） 系统订单号集合。

#### 3. 响应结果集

```json
{
  "flag": true,
  "pdfUrls": [
    {
      "orderNumber": "FEIYQ0000015989YQ",
      "deliveryNumber": "12312326892884990",
      "url": "https://open.sendatek.com/api/label/internal/order/c3cd45c6226544158bdbc7ff5064df20/pdf"
    }
  ]
}
```

#### 4. 响应参数说明

*   flag:请求结果标识。true 表示返回成功. false 表示请求失败。
*   msg: 当请求flag为false时，对失败的描述。
*   pdfUrls: 对请求成功的信息描述对象。
    *   orderNumber：系统订单号。
    *   deliveryNumber：末端派送单号。
    *   url：返回的 PDF 地址。
    *   deliveryNumbers：（字符串 非必填）一票多件返回的多个末端派送单号‘,’拼接。

## 五、查询订单追踪信息

*   以https 请求使用JSON 的格式传入如下参数来进行在线查询订单追踪信息
*   请求链接：<https://open.sendatek.com/openapi/api-order/requestTrackInfo>
*   请求类型：POST

#### 1. 传入参数

```json
{
	"apiName": "YS21095",
	"apiToken": "1684ae8837d356fe61bf6df02801c21a",
	"orderNumbers": ["FEIYQ0000015989YQ"]
}
```

#### 2. 传入参数说明

*   apiName:（字符串类型 必填） 认证的API 的名称。
*   apiToken: （字符串类型 必填） 认证的API 的名称对应的token。
*   orderNumbers:（数组类型 必填最多10个） 系统订单号集合。

#### 3. 响应结果集

```json
{
  "flag": true,
  "trackingInformations": [
    {
      "insideNumber": "FEIYQ0000015989YQ",
      "deliveryCompany": "美国-dpd",
      "deliveryNumber": "12312326892884990",
      "trackingInfoDetails": [
        {
          "createTime": "2021-09-15 17:15:39",
          "description": "Item information received.",
          "location": "",
          "statusDesc": "",
          "trackingStatus": ""
        }
      ]
    }
  ]
}
```

#### 4. 响应参数说明

*   flag:请求结果标识。true 表示返回成功. false 表示请求失败。
*   msg: 当请求flag为false时，对失败的描述。
*   trackingInformations: 对请求成功的信息描述对象列表。
    *   deliveryNumber：末端派送单号。
    *   deliveryCompany：派送公司。
    *   insideNumber：系统订单号。
    *   trackingInfoDetails：追踪信息详情列表。
        *   createTime：创建时间。
        *   description：描述。
        *   location：位置信息。
        *   trackingStatus：追踪状态：NOT\_ONLINE("未上网"),ONLINE("已上网"),NO\_RESULT("查询不到"),TAKE\_DELIVERY("仓库收货"),IN\_TRANSIT("运输中"),WAIT\_TO\_PICKUP("到达待取"),DELIVERY\_FAILED("投递失败"),POSSIBLE\_ABNORMALITY("可能异常"),SIGNING\_SUCCESS("已签收"),LONG\_TRANSPORT("运输过久"),FOREIGN\_RETURN("国外退件"),LOST("包裹丢失"),TRACKING\_ENDED("跟踪结束"),OTHER("其他")。
        *   statusDesc：状态描述。

***

***

# 海外清关API

## 一、清关提单下单模版下载
*   请求链接：<https://open.sendatek.com/openapi/clearance/downloadTemplate>
*   请求类型：GET

#### 1.下载调用示例

简易模板: <https://open.sendatek.com/openapi/clearance/downloadTemplate?apiName=YS2204203&apiToken=ca70f587a055a40a223c3e84045fb449&isSimple=true>

通用模板: <https://open.sendatek.com/openapi/clearance/downloadTemplate?apiName=YS2204203&apiToken=ca70f587a055a40a223c3e84045fb449&isSimple=false>

#### 2. 传入参数说明

*   **apiName**:（字符串类型 必填） 认证的API 的名称。
*   **apiToken**: （字符串类型 必填） 认证的API 的名称对应的token。
*   **isSimple**:（字符串类型 必填） 是否是简易模版，true:简易模版,false:通用模板。


## 二、清关提单下单

*   请求链接：<https://open.sendatek.com/openapi/clearance/aviation>
*   请求类型：POST
*   Content-Type类型：multipart/form-data

#### 1. 参数及调用示例

![image](https://f.sendatek.com/settings/api_aviOrder.png)

#### 2. 传入参数说明

*   **apiName**:（字符串类型 必填） 认证的API 的名称。
*   **apiToken**: （字符串类型 必填） 认证的API 的名称对应的token。
*   **productCode**:（字符串类型 必填） 清关产品code。
*   **orderType**:（字符串类型 必填）下单类型：1：自有订单，2：采购订单。
*   **file**:（excel类型 必填） 上传提单excel（先下载模板，按模板要求填写数据即可）。

#### 3. 错误结果示例

示例1

```json
{
    "flag": false,
    "msg": "产品不可用，详情咨询人工服务",
    "rows": [],
    "total": 0
}
```

示例2

```json
{
    "flag": false,
    "msg": "导入失败,请查看详情列表",
    "rows": [
        {
            "errorInfo": "订单不属于当前用户,袋子号已存在",
            "location": "第6行 订单号为FYYQ0002700733YQ 袋子号为BAG001"
        },
        {
            "errorInfo": "订单不属于当前用户,袋子号已存在",
            "location": "第7行 订单号为FYYQ0002700732YQ 袋子号为BAG002"
        }
    ],
    "total": 0
}
```

#### 4. 响应参数说明

*   flag:请求结果标识。true 表示返回成功. false 表示请求失败。
*   msg: 调用状态描述
*   rows: excel处理过程异常描述列表（当msg为“导入失败,请查看详情列表”时存在）
    *   errorInfo：异常信息。
    *   location：异常信息所在excel位置的附加信息。

## 三、清关取消提单

*   请求链接：<https://open.sendatek.com/openapi/clearance/aviation/cancel>
*   请求类型：POST
*   Content-Type类型：application/json

> #### \*可取消前提： 未上传清关数据及大包未出贴可取消

#### 1. 传入参数

```json
{
    "apiName": "YS2204203",
    "apiToken": "ca70f587a055a40a223c3e84045fb449",
    "aivaOrderNo": "GT100000000008"
}
```

#### 2. 传入参数说明

*   **apiName**:（字符串类型 必填） 认证的API 的名称。
*   **apiToken**: （字符串类型 必填） 认证的API 的名称对应的token。
*   **aivaOrderNo**:（字符串类型 必填） 清关主单号。

#### 3. 响应结果集

```json
{
    "flag": true,
    "rows": [],
    "total": 0
}
```

#### 4. 响应参数说明

*   flag:请求结果标识。true 表示返回成功. false 表示请求失败。
*   msg: 当请求flag为false时，对失败的描述。

## 四、大包出贴

*   请求链接：<https://open.sendatek.com/openapi/clearance/aviation/label>
*   请求类型：POST
*   Content-Type类型：application/json

#### 1. 传入参数

```json
{
    "apiName": "YS2204203",
    "apiToken": "ca70f587a055a40a223c3e84045fb449",
    "bagNo": "BAG0B000030",
    "logisticsName": "fef",
    "destinationNo": "CN",
    "customName": "eee"
}
```

#### 2. 传入参数说明

*   **apiName**:（字符串类型 必填） 认证的API 的名称。
*   **apiToken**: （字符串类型 必填） 认证的API 的名称对应的token。
*   **bagNo**:（字符串类型 必填） 袋子号。
*   logisticsName:（字符串类型 非必填） 仓库代码。
*   destinationNo:（字符串类型 非必填） 目的地（二字码）。
*   customName:（字符串类型 非必填） 自定义名称。

#### 3. 响应结果集

```json
{
    "flag": true,
    "obj": {
        "aviationOrderId": "63aeb64b2d1a1f36db505ad1",
        "aviationOrderNo": "JY00000000002",
        "bigShipId": "BAG0B000030",
        "destinationNo": "你们",
        "errorMessage": "",
        "pbContainerId": "2023YOULUXAB12346",
        "pdfUrl": "http://static.sendatek.com/ex-label/2023/01/04/2023YOULUXAB12346.pdf",
        "productCode": "",
        "productName": "5u卢森堡",
        "quantity": 1,
        "status": "true",
        "weight": 1.0
    },
    "rows": [],
    "total": 0
}
```

#### 4. 响应参数说明

*   flag:请求结果标识。true 表示返回成功. false 表示请求失败。
*   msg: 当请求flag为false时，对失败的描述。
*   obj: 当请求flag为true时存在，出贴相关信息。
    *   aviationOrderNo: 清关主单号。
    *   bigShipId: 大包号。
    *   pdfUrl：标签pdf格式下载地址。

## 五、清关订单更新

*   请求链接：<https://open.sendatek.com/openapi/clearance/order/update>
*   请求类型：POST
*   Content-Type类型：application/json

#### 1. 传入参数

```json
{
    "apiName": "YS2204203",
    "apiToken": "ca70f587a055a40a223c3e84045fb449",
    "avaitionOrderNo": "GT200000000001",
    "insideNumber": "CLE000000192915CO",
    "sender": "Zhang San",
    "sendAddress": "minggu kejiyuan",
    "sendAddress2": "222222",
    "sendCellphoneNo": "1689546263",
    "sendCity": "Shanghai",
    "sendCountryCode": "CN",
    "sendPostcode": "56984",
    "sendProvince": "Shanghai",
    "consignee": "Peter",
    "deliAddress": "Road 253111112",
    "deliAddress2": "111111",
    "deliCellphoneNo": "98466126162",
    "deliCity": "Los Angeles",
    "deliCountryCode": "US",
    "deliPostcode": "25962",
    "deliProvince": "CA",
    "clearanceBoxList": [
        {
            "boxInsideNumber": "CLE000000192915CO-1",
            "boxReportPrice": 12,
            "clearanceGoodsList": [
                {
                    "originalGoodsNameEn": "fence",
                    "goodsCount": 28,
                    "goodsName": "围栏",
                    "goodsNameEn": "fence",
                    "hsCode": "5608192090",
                    "reportPrice": 0.43
                }
            ],
            "deliveryNumber": "SZ17083585",
            "height": 1,
            "length": 1,
            "weight": 13.45,
            "width": 1
        }
    ]
}
```

#### 2. 传入参数说明

*   **apiName**:（字符串类型 必填） 认证的API 的名称。
*   **apiToken**: （字符串类型 必填） 认证的API 的名称对应的token。
*   **avaitionOrderNo**:（字符串类型 必填） 清关主单号。
*   **insideNumber**:（字符串类型 必填） 清关订单号（**更新标识**）。
*   sender:（字符串类型 非必填） 发件人。
*   sendAddress:（字符串类型 非必填） 发件人地址。
*   sendAddress2:（字符串类型 非必填） 发件人地址2。
*   sendCellphoneNo:（字符串类型 非必填） 发件人电话号码。
*   sendCity:（字符串类型 非必填） 发件人城市。
*   sendCountryCode:（字符串类型 非必填） 发件人出发地（出发地二字码）。
*   sendPostcode:（字符串类型 非必填） 发件人邮编。
*   sendProvince:（字符串类型 非必填） 发件人地区/省/州。
*   consignee:（字符串类型 非必填） 收件人。
*   deliAddress:（字符串类型 非必填） 收件人地址。
*   deliAddress2:（字符串类型 非必填） 收件人地址2。
*   deliCellphoneNo:（字符串类型 非必填） 收件人电话号码。
*   deliCity:（字符串类型 非必填） 收件人城市。
*   deliCountryCode:（字符串类型 非必填） 收件人目的地（目的地二字码）。
*   deliPostcode:（字符串类型 非必填） 收件人邮编。
*   deliProvince:（字符串类型 非必填） 收件人地区/省/州。
*   clearanceBoxList:（数组类型 非必填） 清关箱子列表。
    *   **boxInsideNumber**:（字符串类型 必填） 清关箱子号（**更新标识**）。
    *   boxReportPrice:（字符串类型 非必填） 单箱申报价值。
    *   clearanceGoodsList:（数组类型 非必填） 物品列表。
        *   **originalGoodsNameEn**:（字符串类型 必填） 原始英文品名（**更新goods标识**）。
        *   goodsCount:（整型类型 非必填） 商品数量。
        *   goodsName:（字符串类型 非必填） 中文品名。
        *   goodsNameEn:（字符串类型 非必填） 英文品名。
        *   hsCode:（字符串类型 非必填） hsCode码。
        *   reportPrice:（浮点型类型 非必填） 单件申报价值。
    *   deliveryNumber:（数组类型 非必填） 派送单号。
    *   length:（数组类型 非必填） 箱子长。
    *   width:（数组类型 非必填） 箱子宽。
    *   height:（数组类型 非必填） 箱子高。
    *   weight:（浮点型类型 非必填） 箱子重量。

#### 3. 响应结果集

```json
{
    "flag": true,
    "rows": [],
    "total": 0
}
```

#### 4. 响应参数说明

*   flag:请求结果标识。true 表示返回成功. false 表示请求失败。
*   msg: 当请求flag为false时，对失败的描述。

## 六、提交预报

*   请求链接：<https://open.sendatek.com/openapi/clearance/aviation/forecast>
*   请求类型：POST
*   Content-Type类型：application/json

#### 1. 传入参数

```json
{
    "apiName": "YS2204203",
    "apiToken": "ca70f587a055a40a223c3e84045fb449",
    "aivaOrderNo": "GW1231230011"
}
```

#### 2. 传入参数说明

*   **apiName**:（字符串类型 必填） 认证的API 的名称。
*   **apiToken**: （字符串类型 必填） 认证的API 的名称对应的token。
*   **aivaOrderNo**:（字符串类型 必填） 清关主单号。

#### 3. 响应结果集

```json
{
    "flag": true,
    "rows": [],
    "total": 0
}
```

#### 4. 响应参数说明

*   flag:请求结果标识。true 表示返回成功. false 表示请求失败。
*   msg: 当请求flag为false时，对失败的描述。