API docs by Redocly

API 文档 (1.0.0)

Download OpenAPI specification:

本文档包含所有 API 接口说明。

相关文档：

WMS商品订单管理

WMS系统中的商品订单相关接口

创建运单

创建运单接口。接口地址：/api/json.php?Service=SDC&Operation=CreateOrder

Request Body schema: application/json
required
customer_id
required
string

客户ID

secret_key
required
string

密钥

required
object

Responses

Request samples

Content type
application/json
{
  • "customer_id": "string",
  • "secret_key": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

入库预报单创建

入库预报单创建接口。接口地址：/api/json.php?Service=SDC&Operation=CreateInputOrder

Request Body schema: application/json
required
customer_id
required
string

客户ID

secret_key
required
string

密钥

required
object

Responses

Request samples

Content type
application/json
{
  • "customer_id": "string",
  • "secret_key": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

商品出入库履历查询

商品出入库履历查询接口。接口地址：/api/json.php?Service=SDC&Operation=SearchProductStockLog

Request Body schema: application/json
required
customer_id
required
string

客户ID

secret_key
required
string

密钥

required
object

Responses

Request samples

Content type
application/json
{
  • "customer_id": "string",
  • "secret_key": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

入库预报单查询

入库预报单查询接口。接口地址：/api/json.php?Service=SDC&Operation=SearchInputOrder

Request Body schema: application/json
required
customer_id
required
string

客户ID

secret_key
required
string

密钥

required
object

Responses

Request samples

Content type
application/json
{
  • "customer_id": "string",
  • "secret_key": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

运单信息查询

运单信息查询接口。接口地址：/api/json.php?Service=SDC&Operation=GetOrderInfo

Request Body schema: application/json
required
customer_id
required
string

客户ID

secret_key
required
string

密钥

required
object

必须有一个查询参数

Responses

Request samples

Content type
application/json
{
  • "customer_id": "string",
  • "secret_key": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

送仓完成

送仓完成接口。接口地址：/api/json.php?Service=SDC&Operation=FinishOutOrder

Request Body schema: application/json
required
customer_id
required
string

客户ID

secret_key
required
string

密钥

required
object

Responses

Request samples

Content type
application/json
{
  • "customer_id": "string",
  • "secret_key": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

运单送仓完成

运单已经出库接口。接口地址：/api/json.php?Service=SDC&Operation=OrderDepartured

Request Body schema: application/json
required
customer_id
required
string

客户ID

secret_key
required
string

密钥

required
object

Responses

Request samples

Content type
application/json
{
  • "customer_id": "string",
  • "secret_key": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

更新身份信息数据

更新身份信息数据接口。接口地址：/api/json.php?Service=SDC&Operation=UpdateIdcardDeclare

Request Body schema: multipart/form-data
required
customer_id
required
string

客户ID

secret_key
required
string

密钥

customer_order_id
string <= 50 characters

客户运单号 客户运单号、物流单号任意选择1个 只接受90天内上传到云仓的运单数据

logis_num
string <= 13 characters

物流单号

idcard_front_image
required
string <binary>

身份证正面(个人面)，120kb

idcard_back_image
required
string <binary>

身份证背面(国徽面)，120kb

Responses

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

包裹中转管理

包裹中转、入库、出库等相关接口

包裹运单

包裹运单接口。接口地址：/api/json.php?Service=SDC&Operation=TCreateOrder

Request Body schema: application/json
required
login_email
required
string

邮件

login_password
required
string

密码

encryption
string

加密方式 当数据为空时，不做任何处理 不为空时，按约定解密，加密 比如：AES 加密字段：紫色数据

required
object

Responses

Request samples

Content type
application/json
{
  • "login_email": "string",
  • "login_password": "string",
  • "encryption": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

运单信息查询

运单信息查询接口。接口地址：/api/json.php?Service=SDC&Operation=TSearchOrders

Request Body schema: application/json
required
login_email
required
string

邮件

login_password
required
string

密码

encryption
string

加密方式 当数据为空时，不做任何处理 不为空时，按约定解密，加密 比如：AES 加密字段：同《创建运单》

required
object

必须有一个查询参数

Responses

Request samples

Content type
application/json
{
  • "login_email": "string",
  • "login_password": "string",
  • "encryption": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

取消订单

取消订单接口。接口地址：/api/json.php?Service=SDC&Operation=TDeleteOrder

Request Body schema: application/json
required
login_email
required
string

邮件

login_password
required
string

密码

required
object

Responses

Request samples

Content type
application/json
{
  • "login_email": "string",
  • "login_password": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

确定发货

确定发货接口。接口地址：/api/json.php?Service=SDC&Operation=TCommitOrder

Request Body schema: application/json
required
login_email
required
string

邮件

login_password
required
string

密码

required
object

Responses

Request samples

Content type
application/json
{
  • "login_email": "string",
  • "login_password": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

更新运单

更新运单接口。接口地址：/api/json.php?Service=SDC&Operation=TUpdateOrder

Request Body schema: application/json
required
login_email
required
string

邮件

login_password
required
string

密码

required
object

Responses

Request samples

Content type
application/json
{
  • "login_email": "string",
  • "login_password": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

包裹信息查询

包裹信息查询接口。接口地址：/api/json.php?Service=SDC&Operation=TSearchPackages

Request Body schema: application/json
required
login_email
required
string

邮件

login_password
required
string

密码

required
object

Responses

Request samples

Content type
application/json
{
  • "login_email": "string",
  • "login_password": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

预报包裹

预报包裹接口。接口地址：/api/json.php?Service=SDC&Operation=TForecastPackage

Request Body schema: application/json
required
login_email
required
string

邮件

login_password
required
string

密码

required
object

Responses

Request samples

Content type
application/json
{
  • "login_email": "string",
  • "login_password": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "OperationResult": {
    },
  • "response_name": "string"
}

SGX订单跟踪管理

SGX系统订单跟踪与状态更新相关接口

获取快递追踪信息

获取快递追踪信息接口。接口地址：/api/json.php?Service=SDC&Operation=GetTrackLog

编码说明：

动作编码速查：

  • 201: 【日本-東京】包裹已經送達東京海外倉
  • 202: 【日本-東京】包裹已經從東京海外倉出發等待幹綫運輸
  • 205: 【日本-東京】出口清關完成，等待國際航班分撥
  • 204: 【日本-東京】包裹航班分撥成功，等待飛機起飛
  • 15: 跨境作業中
  • 16: 進口清關完成
  • 50: 落地派送中
  • 99: 签收完成

区域编码速查：

  • 1: 日本
  • 2: 韩国
  • 3: 中国
  • 4: 香港
Request Body schema: application/json
required
login_email
required
string

邮件

login_password
required
string

密码

logis_num
required
string

快递单号

Responses

Request samples

Content type
application/json
{
  • "login_email": "string",
  • "login_password": "string",
  • "logis_num": "string"
}

Response samples

Content type
application/json
{
  • "SGXpress": {
    },
  • "response_name": "string"
}