创建订单

生成订单

POST https://rate.trantordata.com/open_v1/order/create

免费API 需要登录者信息，即Cookie内需增加X-JYY-UserId和X-JYY-SecurityHash，否则视为匿名请求，无权限。

X-JYY-UserId和X-JYY-SecurityHash字段在登录时已提供。

收费API 无需传递 X-JYY-UserId 与 X-JYY-SecurityHash cookie

Headers

Name	Type	Description
Api-Key*	String	sk-xkze4N8V...lyUTKY93
Content-Type*	String	application/x-www-form-urlencoded

Cookies

Name	Type	Description
X-JYY-UserId*	String	200...nDc
X-JYY-SecurityHash*	String	dal...3jk

Request Body

Name	Type	Description
is_user_shipper	boolean	创建订单用户是否为发货人，默认为true。 false代表为收货人
service_scopes*	CSV	服务范围，CSV结构，具体详情查看ServiceScope 枚举。当服务范围为INCOTERMS时，仅允许选择EXW, FOB, CFR或DAP中的一个；当服务范围为非INCOTERMS时，可选择多个
plan_id*	String	用于生成订单的方案id，可以是QueryPlanSeparated 或 QueryPlanCombined
shipper_contact_id*	String	发货人信息id
user_appendix	String	订单备注，默认为空
notifier_contact_id	String	通知人信息id，默认为空，当此参数为空时，通知人会默认使用发货人信息
consignee_contact_id*	String	收货人信息id

{
    // 订单id
    "id": "230526074905Xkey",
    // 创建时间，UTC时间戳
    "addedAt": 1685087345409,
    // 最后修改时间，UTC时间戳
    "lastUpdatedAt": 1685087345409,
    // 订单编号，用于展示给用户，带有一定规则的可读性编号
    "displayId": "EZSE260523-05",
    // 订单创建人
    "createdBy": { User },
    // 订单方案，separatedPlan或combinedPlan 其中一个为null，另一个为具体的方案，取决于使用生成订单的plan_id参数
    "separatedPlan": { QuerySeparatedPlan },
    "combinedPlan": null,
    // 订单的原始查价信息
    "query": { QueryHistory },
    // 订单服务范围或INCOTERMS，详情请见 ServiceScope 枚举
    "serviceScopes": [
        "DAP"
    ],
    // 订单创建人是否为发货人
    "isUserShipper": false,
    // 订单取消原因
    "requestCancelReason": null,
    // 订单取消被驳回原因
    "requestCancelDeniedReason": null,
    // 订单取消同意原因
    "requestCancelAgreedReason": null,
    // 订单状态，详情请见 OrderStatus 枚举
    "orderStatus": "Created",
    // 发货人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "shipper": { UserContacts },
    // 收货人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "consignee": { UserContacts },
    // 通知人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "notifier": { UserContacts },
    // 第三方通知人，抹除了id, addedAt, 和 lastUpdatedAt
    // 预留，并未启用
    "thirdPartyNotifier": null,
    // 订单文书卡片信息，map，key为订单状态，value为该订单状态下所涉及的文书卡片
    "statusDocumentsMap": {},
    // 订单管理相关信息，含etd及行程，为刚开始执行订单时的信息
    // 相关内容比方案内的更准确，但并没有追踪信息准确
    "basicFallbackInfo": null,
    // 订单追踪信息
    "trackingInfo": null,
    // 用户备注
    "userAppendix": null
}

获取单个订单信息

GET https://rate.trantordata.com/open_v1/order/{id}

免费API 需要登录者信息，即Cookie内需增加X-JYY-UserId和X-JYY-SecurityHash，否则视为匿名请求，无权限。

X-JYY-UserId和X-JYY-SecurityHash字段在登录时已提供。

收费API 无需传递 X-JYY-UserId 与 X-JYY-SecurityHash cookie

Path Parameters

Name	Type	Description
id*	String	订单id

Headers

Name	Type	Description
Api-Key*	String	sk-xkze4N8V...lyUTKY93

Cookies

Name	Type	Description
X-JYY-UserId*	String	200...nDc
X-JYY-SecurityHash*	String	dal...3jk

{
    // 订单id
    "id": "230526074905Xkey",
    // 创建时间，UTC时间戳
    "addedAt": 1685087345409,
    // 最后修改时间，UTC时间戳
    "lastUpdatedAt": 1685087345409,
    // 订单编号，用于展示给用户，带有一定规则的可读性编号
    "displayId": "EZSE260523-05",
    // 订单创建人
    "createdBy": { User },
    // 订单方案，separatedPlan或combinedPlan 其中一个为null，另一个为具体的方案，取决于使用生成订单的plan_id参数
    "separatedPlan": { QuerySeparatedPlan },
    "combinedPlan": null,
    // 订单的原始查价信息
    "query": { QueryHistory },
    // 订单服务范围或INCOTERMS，详情请见 ServiceScope 枚举
    "serviceScopes": [
        "DAP"
    ],
    // 订单创建人是否为发货人
    "isUserShipper": false,
    // 订单取消原因
    "requestCancelReason": null,
    // 订单取消被驳回原因
    "requestCancelDeniedReason": null,
    // 订单取消同意原因
    "requestCancelAgreedReason": null,
    // 订单状态，详情请见 OrderStatus 枚举
    "orderStatus": "Created",
    // 发货人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "shipper": { UserContacts },
    // 收货人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "consignee": { UserContacts },
    // 通知人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "notifier": { UserContacts },
    // 第三方通知人，抹除了id, addedAt, 和 lastUpdatedAt
    // 预留，并未启用
    "thirdPartyNotifier": null,
    // 订单文书卡片信息，map，key为订单状态，value为该订单状态下所涉及的文书卡片
    "statusDocumentsMap": {},
    // 订单管理相关信息，含etd及行程，为刚开始执行订单时的信息
    // 相关内容比方案内的更准确，但并没有追踪信息准确
    "basicFallbackInfo": null,
    // 订单追踪信息
    "trackingInfo": null,
    // 用户备注
    "userAppendix": null
}

获取用户订单列表

GET https://rate.trantordata.com/open_v1/order/query

免费API 需要登录者信息，即Cookie内需增加X-JYY-UserId和X-JYY-SecurityHash，否则视为匿名请求，无权限。

X-JYY-UserId和X-JYY-SecurityHash字段在登录时已提供。

收费API 无需传递 X-JYY-UserId 与 X-JYY-SecurityHash cookie

Query Parameters

Name	Type	Description
statuses	CSV	订单物理状态，CSV结构，详见 OrderStatus枚举默认为null
page	int	页号，默认为0，第0页
display_ids	CSV	订单编号，CSV结构默认为null
transport_types	CSV	运输方式，CSV结构，非法值会被忽略默认为null
cods	CSV	目的国，CSV结构，需符合国家二字码，若不符合，会被忽略默认为null
cols	CSV	起运国，CSV结构，需符合国家二字码，若不符合，会被忽略默认为null
size	int	分页大小，默认为20。最大值为200，若size超过200，会强制设置为200

Headers

Name	Type	Description
Api-Key*	String	sk-xkze4N8V...lyUTKY93

Cookies

Name	Type	Description
X-JYY-UserId	String	200...nDc
X-JYY-SecurityHash	String	dal...3jk

{
    // 是否有下一页，布尔型
    "hasNext": true,
    // 总共记录的数量
    "totalElements": 95,
    // 分页数量
    "totalPages": 5,
    // 订单信息，数组
    "orders": [
        { Order },
        ...
    ]
}

申请取消订单

POST https://rate.trantordata.com/open_v1/order/cancel

免费API 需要登录者信息，即Cookie内需增加X-JYY-UserId和X-JYY-SecurityHash，否则视为匿名请求，无权限。

X-JYY-UserId和X-JYY-SecurityHash字段在登录时已提供。

收费API 无需传递 X-JYY-UserId 与 X-JYY-SecurityHash cookie

Headers

Name	Type	Description
Api-Key*	String	sk-xkze4N8V...lyUTKY93
Content-Type*	String	application/x-www-form-urlencoded

Cookies

Name	Type	Description
X-JYY-UserId*	String	200...nDc
X-JYY-SecurityHash*	String	dal...3jk

Request Body

Name	Type	Description
order_id*	String	订单id
reason*	String	取消理由

{
    // 订单id
    "id": "230526074905Xkey",
    // 创建时间，UTC时间戳
    "addedAt": 1685087345409,
    // 最后修改时间，UTC时间戳
    "lastUpdatedAt": 1685087345409,
    // 订单编号，用于展示给用户，带有一定规则的可读性编号
    "displayId": "EZSE260523-05",
    // 订单创建人
    "createdBy": { User },
    // 订单方案，separatedPlan或combinedPlan 其中一个为null，另一个为具体的方案，取决于使用生成订单的plan_id参数
    "separatedPlan": { QuerySeparatedPlan },
    "combinedPlan": null,
    // 订单的原始查价信息
    "query": { QueryHistory },
    // 订单服务范围或INCOTERMS，详情请见 ServiceScope 枚举
    "serviceScopes": [
        "DAP"
    ],
    // 订单创建人是否为发货人
    "isUserShipper": false,
    // 订单取消原因
    "requestCancelReason": "下单信息错误",
    // 订单取消被驳回原因
    "requestCancelDeniedReason": null,
    // 订单取消同意原因
    "requestCancelAgreedReason": null,
    // 订单取消同意原因
    "requestCancelAgreedReason": null,
    // 订单状态，详情请见 OrderStatus 枚举
    "orderStatus": "RequestCancel",
    // 发货人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "shipper": { UserContacts },
    // 收货人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "consignee": { UserContacts },
    // 通知人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "notifier": { UserContacts },
    // 第三方通知人，抹除了id, addedAt, 和 lastUpdatedAt
    // 预留，并未启用
    "thirdPartyNotifier": null,
    // 订单文书卡片信息，map，key为订单状态，value为该订单状态下所涉及的文书卡片
    "statusDocumentsMap": {},
    // 订单管理相关信息，含etd及行程，为刚开始执行订单时的信息
    // 相关内容比方案内的更准确，但并没有追踪信息准确
    "basicFallbackInfo": {
        // etd
        "etd": 1686619740000,
        // 行程
        "transitTime": 13
    },
    // 订单追踪信息
    "trackingInfo": { OrderTrackingInfo },
    // 用户备注
    "userAppendix": null
}

向订单上传相关文件

POST https://rate.trantordata.com/open_v1/order/upload_doc

免费API 需要登录者信息，即Cookie内需增加X-JYY-UserId和X-JYY-SecurityHash，否则视为匿名请求，无权限。

X-JYY-UserId和X-JYY-SecurityHash字段在登录时已提供。

收费API 无需传递 X-JYY-UserId 与 X-JYY-SecurityHash cookie

Headers

Name	Type	Description
Api-Key*	String	sk-xkze4N8V...lyUTKY93
Content-Type*	String	multipart/form-data

Cookies

Name	Type	Description
X-JYY-UserId*	String	200...nDc
X-JYY-SecurityHash*	String	dal...3jk

Request Body

Name	Type	Description
order_id*	String	订单id
file_obj*	MultipartFile	文件
file_name*	String	上传文件的文件名，含文件扩展名
doc_id*	String	文书卡片id

{
	// 订单id
    "id": "230526074905Xkey",
    // 创建时间，UTC时间戳
    "addedAt": 1685087345409,
    // 最后修改时间，UTC时间戳
    "lastUpdatedAt": 1685323724000,
    // 订单编号，用于展示给用户，带有一定规则的可读性编号
    "displayId": "EZSE260523-05",
    // 订单创建人
    "createdBy": { User },
    // 订单方案，separatedPlan或combinedPlan 其中一个为null，另一个为具体的方案，取决于使用生成订单的plan_id参数
    "separatedPlan": { QuerySeparatedPlan },
    "combinedPlan": null,
    // 订单的原始查价信息
    "query": { QueryHistory },
    // 订单服务范围或INCOTERMS，详情请见 ServiceScope 枚举
    "serviceScopes": [
        "DAP"
    ],
    // 订单创建人是否为发货人
    "isUserShipper": false,
    // 订单取消原因
    "requestCancelReason": "下单信息错误",
    // 订单取消被驳回原因
    "requestCancelDeniedReason": null,
    // 订单取消同意原因
    "requestCancelAgreedReason": null,
    // 订单取消同意原因
    "requestCancelAgreedReason": null,
    // 订单状态，详情请见 OrderStatus 枚举
    "orderStatus": "RequestCancel",
    // 发货人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "shipper": { UserContacts },
    // 收货人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "consignee": { UserContacts },
    // 通知人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "notifier": { UserContacts },
    // 第三方通知人，抹除了id, addedAt, 和 lastUpdatedAt
    // 预留，并未启用
    "thirdPartyNotifier": null,
    // 订单文书卡片信息，map，key为订单状态，value为该订单状态下所涉及的文书卡片
    "statusDocumentsMap": {
        "Delivery": [
            { OrderStatusDoc },
            ...
        ],
        "ProductUnloading": [
            { OrderStatusDoc },
            ...
        ]
    },
    // 订单管理相关信息，含etd及行程，为刚开始执行订单时的信息
    // 相关内容比方案内的更准确，但并没有追踪信息准确
    "basicFallbackInfo": {
        // etd
        "etd": 1686619740000,
        // 行程
        "transitTime": 13
    },
    // 订单追踪信息
    "trackingInfo": { OrderTrackingInfo },
    // 用户备注
    "userAppendix": null
}

删除订单中的文件

删除订单内上传的文件

POST https://rate.trantordata.com/open_v1/order/delete_doc

免费API 需要登录者信息，即Cookie内需增加X-JYY-UserId和X-JYY-SecurityHash，否则视为匿名请求，无权限。

X-JYY-UserId和X-JYY-SecurityHash字段在登录时已提供。

收费API 无需传递 X-JYY-UserId 与 X-JYY-SecurityHash cookie

此接口仅允许删除用户上传的文件，不允许删除模板文件

Headers

Name	Type	Description
Api-Key*	String	sk-xkze4N8V...lyUTKY93

Cookies

Name	Type	Description
X-JYY-UserId*	String	200...nDc
X-JYY-SecurityHash*	String	dal...3jk

Request Body

Name	Type	Description
order_id	String	订单id
file_url	String	文件url
doc_id	String	文书卡片id

{
    // 订单id
    "id": "230526074905Xkey",
    // 创建时间，UTC时间戳
    "addedAt": 1685087345409,
    // 最后修改时间，UTC时间戳
    "lastUpdatedAt": 1685323724000,
    // 订单编号，用于展示给用户，带有一定规则的可读性编号
    "displayId": "EZSE260523-05",
    // 订单创建人
    "createdBy": { User },
    // 订单方案，separatedPlan或combinedPlan 其中一个为null，另一个为具体的方案，取决于使用生成订单的plan_id参数
    "separatedPlan": { QuerySeparatedPlan },
    "combinedPlan": null,
    // 订单的原始查价信息
    "query": { QueryHistory },
    // 订单服务范围或INCOTERMS，详情请见 ServiceScope 枚举
    "serviceScopes": [
        "DAP"
    ],
    // 订单创建人是否为发货人
    "isUserShipper": false,
    // 订单取消原因
    "requestCancelReason": "下单信息错误",
    // 订单取消被驳回原因
    "requestCancelDeniedReason": null,
    // 订单取消同意原因
    "requestCancelAgreedReason": null,
    // 订单取消同意原因
    "requestCancelAgreedReason": null,
    // 订单状态，详情请见 OrderStatus 枚举
    "orderStatus": "RequestCancel",
    // 发货人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "shipper": { UserContacts },
    // 收货人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "consignee": { UserContacts },
    // 通知人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "notifier": { UserContacts },
    // 第三方通知人，抹除了id, addedAt, 和 lastUpdatedAt
    // 预留，并未启用
    "thirdPartyNotifier": null,
    // 订单文书卡片信息，map，key为订单状态，value为该订单状态下所涉及的文书卡片
    "statusDocumentsMap": {
        "Delivery": [
            { OrderStatusDoc },
            ...
        ],
        "ProductUnloading": [
            { OrderStatusDoc },
            ...
        ]
    },
    // 订单管理相关信息，含etd及行程，为刚开始执行订单时的信息
    // 相关内容比方案内的更准确，但并没有追踪信息准确
    "basicFallbackInfo": {
        // etd
        "etd": 1686619740000,
        // 行程
        "transitTime": 13
    },
    // 订单追踪信息
    "trackingInfo": { OrderTrackingInfo },
    // 用户备注
    "userAppendix": null
}

已读订单追踪相关通知

用于标记用户已读过订单的追踪信息及通知

POST https://rate.trantordata.com/open_v1/order/read_tracking_data

免费API 需要登录者信息，即Cookie内需增加X-JYY-UserId和X-JYY-SecurityHash，否则视为匿名请求，无权限。

X-JYY-UserId和X-JYY-SecurityHash字段在登录时已提供。

收费API 无需传递 X-JYY-UserId 与 X-JYY-SecurityHash cookie

Headers

Name	Type	Description
Api-Key*	String	sk-xkze4N8V...lyUTKY93
Content-Type*	String	application/x-www-form-urlencoded

Cookies

Name	Type	Description
X-JYY-UserId*	String	200...nDc
X-JYY-SecurityHash*	String	dal...3jk

Request Body

Name	Type	Description
order_id*	String	订单id

{
    // 订单id
    "id": "230404030724EgGo",
    // 创建时间，UTC时间戳
    "addedAt": 1680577645000,
    // 最后修改时间，UTC时间戳
    "lastUpdatedAt": 1684108093000,
    // 订单编号，用于展示给用户，带有一定规则的可读性编号
    "displayId": "EZSE040423-06",
    // 订单创建人
    "createdBy": { User },
    // 订单方案，separatedPlan或combinedPlan 其中一个为null，另一个为具体的方案，取决于使用生成订单的plan_id参数
    "separatedPlan": { QuerySeparatedPlan },
    "combinedPlan": null,
    // 订单的原始查价信息
    "query": { QueryHistory },
    // 订单服务范围或INCOTERMS，详情请见 ServiceScope 枚举
    "serviceScopes": [
        "onPol",
        "PolToPod",
        "onPod"
    ],
    // 订单创建人是否为发货人
    "isUserShipper": true,
    // 订单取消原因
    "requestCancelReason": null,
    // 订单取消被驳回原因
    "requestCancelDeniedReason": null,
    // 订单取消同意原因
    "requestCancelAgreedReason": null,
    // 订单状态，详情请见 OrderStatus 枚举
    "orderStatus": "ProductUnloading",
    // 发货人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "shipper": { UserContacts },
    // 收货人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "consignee": { UserContacts },
    // 通知人信息，抹除了id, addedAt, 和 lastUpdatedAt
    "notifier": { UserContacts },
    // 第三方通知人，抹除了id, addedAt, 和 lastUpdatedAt
    // 预留，并未启用
    "thirdPartyNotifier": null,
    // 订单文书卡片信息，map，key为订单状态，value为该订单状态下所涉及的文书卡片
    "statusDocumentsMap": {
        "Delivery": [
            { OrderStatusDoc },
            ...
        ],
        "ProductUnloading": [
            { OrderStatusDoc },
            ...
        ]
    },
    // 订单管理相关信息，含etd及行程，为刚开始执行订单时的信息
    // 相关内容比方案内的更准确，但并没有追踪信息准确
    "basicFallbackInfo": {
        // etd
        "etd": 1686619740000,
        // 行程
        "transitTime": 13
    },
    // 订单追踪信息
    "trackingInfo": { OrderTrackingInfo },
    // 用户备注
    "userAppendix": null
}