通过该接口可以修改存在的订单
更改订单的条件是 CDEK 仓库中没有货物移动(即订单状态为“已创建”)
请求方式 Update-request
请求内容格式为 JSON (Content-Type: application/json) .
需要使用PATCH-请求,请求URL:
测试环境 | https://api.edu.cdek.ru/v2/orders |
---|---|
正式环境 | https://api.cdek.ru/v2/orders |
中国的环境 | https://int.cdek-express.cn/v2/orders |
请求内容
内容包含的属性以下:
属性名称 | 描述 | 类型 | 必填 | ||
---|---|---|---|---|---|
1 | uuid | CDEK订单识别码 | UUID | 是, 如果CDEK number 没有填写 | |
2 | cdek_number | CDEK运单号 | long | 是, 如果uuid 没有填写 | |
3 | tariff_code | 服务代码 - 快递产品代码 (查看服务列表 ) |
integer | 是 | |
4 | comment | 订单备注 | string() | 否 | |
5 | shipment_point1 | 寄件站点代码 不能与 from_location 同时使用 |
string() | 否 | |
6 | delivery_point1 | 收件站点代码 不能与to_location 同时使用 |
string() | 否 | |
7 | delivery_recipient_cost | 运输附加费 - 电商可添加让买家多付运费 货币必须设置为与货到付款货币相匹配 |
money | 否 | |
7.1 | value | 运输附加费 - 金额 | float | 是 | |
7.2 | vat_sum | 运输附加费 - 税额 | float | 否 | |
7.3 | vat_rate | 运输附加费 - 税率(百分之几) (可选 0,10,18,20, null - 不收税) |
integer | 否 | |
8 | delivery_recipient_cost_adv | 根据货件申报价值的运输附加费用 该属性仅 “电商” 类型订单可以使用的 |
threshold[] | 否 | |
8.1 | threshold | 货件申报价值少于等于 | integer | 是 | |
8.2 | sum | 根据货件申报价值 - 附加费用金额 | float | 是 | |
8.3 | vat_sum | 根据货件申报价值- 税额 | float | 否 | |
8.4 | vat_rate | 根据货件申报价值 税率 (可选 0,10,18,20, null - 不收税) |
integer | 否 | |
9 | sender | 寄件方 | contact | 否 | |
9.1 | company | 公司名称 | string(255) | 否 | |
9.2 | name | 姓名 | string(255) | 否 | |
9.3 | 电子邮箱地址 (应该符合RFC 2822) | string(255) | 否 |
||
9.4 | passport_series | 护照序列 | string(4) | 否 | |
9.5 | passport_number | 护照号码 | string(20) | 否 | |
9.6 | passport_date_of_issue | 护照签发日期 | date (yyyy-MM-dd) | 否 | |
9.7 | passport_organization | 护照签发机关 | string(255) | 否 | |
9.8 | tin | 个人税号 包含 10 或 12 个字符 |
string(12) | 否 | |
9.9 | passport_date_of_birth | 生日 | date (yyyy-MM-dd) | 否 | |
9.10 | phones | 电话号码列表 (不超10个) | phone[] | 否 | |
9.10.1 | number | 电话号码,国际格式 比如 +79094768888 |
string(255) | 是 | |
9.10.2 | additional | 分机号码 | string(255) | 否 | |
10 | seller | 实际卖家 | seller | 否 | |
10.1 | name | 卖家名称 | string(255) | 否 | |
10.2 | inn | 卖家税号 | string(12) | 否 | |
10.3 | phone | 卖家电话号码 | string(255) | 否 | |
10.4 | ownership_form | 卖家所有制形式 | integer | 否 | |
11 | recipient | 收件方 | contact | 否 | |
11.1 | company | 公司名称 | string(255) | 否 | |
11.2 | name | 姓名 | string(255) | 否 | |
11.3 | passport_series | 护照序列 | string(4) | 否 | |
11.4 | passport_number | 护照号码 | string(30) | 否 | |
11.5 | passport_date_of_issue | 护照签发日期 | date (yyyy-MM-dd) | 否 | |
11.6 | passport_organization | 护照签发机关 | string(255) | 否 | |
11.7 | tin | 个人税号 包含 10 或 12 个字符 |
string(12) | 否 | |
11.8 | passport_date_of_birth | 生日 | date (yyyy-MM-dd) | 否 | |
11.9 | 电子邮箱 (应该符合RFC 2822) |
string(255) | 否 | ||
11.10 | phones | 电话号码列表 (不超10个) | phone[] | 否 | |
11.10.1 | number | 电话号码,国际格式 比如 +79094768888 | string(255) | 是 | |
11.10.2 | additional | 分机号码 | string(255) | 否 | |
12 | to_location2 | 收件地址 无法跟delivery_point同时使用 |
location | 否 | |
12.1 | code | 地点代码 (根据CDEK数据库) | integer | 否 | |
12.2 | fias_guid | 俄罗斯海关局-新版地址数据库(FIAS)的地址代码 | UUID | 否 | |
12.3 | postal_code | 邮编 | string(255) | 否 | |
12.4 | longitude | 经度 | float | 否 | |
12.5 | latitude | 纬度 | float | 否 | |
12.6 | country_code | 国家编码 ISO_3166-1_alpha-2 格式的 | string(2) | 否 | |
12.7 | region | 州省名称 | string(255) | 否 | |
12.8 | region_code | 州省代码 (根据CDEK数据库) | integer | 否 | |
12.9 | sub_region | 县/区 | string(255) | 否 | |
12.10 | city | 城市名称 | string(255) | 否 | |
12.11 | kladr_code | 俄罗斯海关局-旧版地址数据库的地址代码 | string(255) | 否 | |
12.12 | address | 地址 | string(255) | 是 | |
13 | from_location | 寄件地址 无法跟shipment_pointt同时使用 |
location | 否 | |
13.1 | address | 地址 | string(255) | 是 | |
14 | services2 | 增值服务列表 | service[] | 否 | |
14.1 | code | 增值服务代码 (查看增值服务列表) | integer | 是 | |
14.2 | parameter | 增值服务的参数: - “Packing 1”、“Courier package A2”、“Safe package A2”、“Safe package A3”、“Safe package A4”、“Safe package A5”服务的包裹数量(适用于所有订单类型) - 服务“保险”的订单声明价值(仅适用于“普通”类型的订单) - “气泡膜”、“再生纸”服务的长度 - “订单送达通知”服务的电话号码 |
integer | 否 | |
15 | packages2 | 包装件列表 没有提交的包装就被删除 订单中的位置数 - 1 到255。 |
package[] | 否 | |
15.1 | package_id | CDEK的包装件序号 | string | 否,如果你提交新的包装(有新的number) | |
15.2 | number | 包装件序号 (您可以使用订单包装的序列号或订单号), 订单号之内应该是独特的. 客户的订单 ID | string(20) | 是 | |
15.3 | weight | 包装件总重量 (克数) | integer | 是 | |
15.4 | length | 长度 cm | integer | 要么都填 - 要么都不填 |
|
15.5 | width | 宽度 cm | integer | 要么都填 - 要么都不填 |
| |
| 15.6 | height | 高度 cm | integer | 要么都填 -
要么都不填
| |
| 15.7 | comment | 包装件的备注
为了普通订单使用 | string(255) | 否 | |
| 15.8 | items | 内件列表(产品列表)
该属性仅 “电商” 类型订单可以使用的
一个订单中不超过 126 个唯一行
订单中的商品总数 - 1 到 10000 | item[] | 是 | |
| 15.8.1 | name | 货品名称 | string(255) | 是 | |
| 15.8.2 | warekey | 产品SKU 或其他产品唯一识别码(不能包含汉字)
能包含: [A-z А-я 0-9 ! @ “ # № $ ; % ^ : & ? * () - + = ? < > , .{ } [ ] \ / , 空格] | string(50) | 是 | |
| 15.8.3 | marking | 产品唯一的编号(填该属性的话 数量amout必须等于1),俄罗斯产品标记法(第487-ФЗ号)
为了正确显示收据中的货物标记,需要转移
未组装类型的标记,可能如下所示:
1) 产品代码, GS1格式的
比如: 010468008549838921AAA0005255832GS91EE06GS92VTwGVc7wKCc2tqRncUZ1RU5LeUKSXjWbfNQOpQjKK+A
2) 总长度为 29 个字符的有效字符序列。
比如: 00000046198488X?io+qCABm8wAYa
3) 毛皮制品有其他的格式
比如: RU-430302-AAA7582720 | string() | 否 | |
| 15.8.4 | payment | 单件的代收货款, 收件国家的币种 | money | 是 | |
| 15.8.4.1 | value | 运输附加费 - 金额(预付款情况下=0) | float | 是 | |
| 15.8.4.2 | vat_sum | 运输附加费 - 税额 | float | 否 | |
| 15.8.4.3 | vat_rate | 运输附加费 - 税率(百分之几)
(可选 0,10,18,20, null - 不收税) | integer | 否 | |
| 15.8.5 | cost | 单件申报价值 (单件,用合同的货币, 用于计算保险费) | float | 是 | |
| 15.8.6 | weight | 单件重量(单位:克) | integer | | 是 |
| 15.8.7 | weight_gross | 产品单件毛重 | integer | | 是,如果订单号是国际的 |
| 15.8.8 | amount | 产品数量 (个)
一样的件商品的数量可以从 1 到 999 | integer | 是 | |
| 15.8.9 | name_i18n | 外文名称 | string(255) | 否 | |
| 15.8.10 | brand | 商标名称(英文) | string(255) | 否 | |
| 15.8.11 | country_code | 产品制造国家编码 ISO_3166-1_alpha-2 格式的 | string(2) | 否 | |
| 15.8.12 | material | 材质编码 | string(255) | 否 | |
| 15.8.13 | wifi_gsm | 包含 wifi/gsm | boolean | 否 | |
| 15.8.14 | url | 稍稍平台具体产品链接 | string(255) | 否 | |
1 订单由指定字段标识(优先级 uuid)。
2 在指定字段中传输新值时,可以重新计算订单的成本。
申请返回的数据
内容格式为 JSON
属性名称 | 描述 | 类型 | 必填 | |
---|---|---|---|---|
1 | entity | 订单信息 | entity | 否 |
1.1 | uuid | 被修改的CDEK订单识别码 | UUID | 否 |
2 | requests | 订单对应的请求列表 | request[] | 是 |
2.1 | request_uuid | CDEK数据库的请求ID | UUID | 否 |
2.2 | type | 请求类型,所可能的类型:CREATE, UPDATE, DELETE, AUTH, GET | string() | 是 |
2.3 | date_time | 状态日期 (格式为:yyyy-MM-dd’T’HH:mm:ssZ) | datetime | 是 |
2.4 | state | 目前的状态所可能的状态: ACCEPTED - 预验证通过并请求接受 WAITING - 请求待处理(取决于另一个请求的执行) SUCCESSFUL - 成功 INVALID - 无效-有错误 |
string() | 是 |
2.5 | errors | 进行请求中发生的错误 | error[] | 否 |
2.5.1 | code | 错误编码 | string() | 是 |
2.5.2 | message | 错误描述 | string() | 是 |
2.6 | warnings | 错误描述 | warning[] | 否 |
2.6.1 | code | 警告编码 | string() | 是 |
2.6.2 | message | 警告描述 | string() | 是 |
请求内容的列子 |
---|
{ “uuid”:”72753031-5427-4d1b-b1e4-7c4c26be00a0”, “cdek_number”:”1105660806”, “tariff_code”:”10”, “sender”:{ “company”:”Pogoda”, “name”:”Петров Петр”, “email”:”react@cdek.ru”, “phones”:[ { “number”:”+79134637228”, “additional”:”1234” } ] }, “recipient”:{ “company”:”NUMM”, “name”:”Константинов Константин”, “email”:”pochta@gmail.com”, “phones”:[ { “number”:”+79134635628”, “additional”:”123” } ] }, “to_location”:{ “code”:”137” }, “from_location”:{ “address”:”Новосибирск, Большевистская 101” }, “services”:[ { “code”:”DANGER_CARGO” }, { “code”:”PACKAGE_1”, “parameter”:”1” } ], “packages”:[ { “number”:”bar-666”, “height”:20, “length”:20, “weight”:4000, “width”:20, “items”:[ { “name”:”Товар”, “ware_key”:”00055”, “payment”:{ “value”:3000 }, “cost”:300, “amount”:1, “weight”:700 } ] } ] } |
返回的数据例子 |
---|
{ “entity”: { “uuid”: “72753031-5427-4d1b-b1e4-7c4c26be00a0” }, “requests”: [ { “request_uuid”: “72753031-35cc-4ef6-a353-25a09d3a973a”, “type”: “UPDATE”, “state”: “ACCEPTED”, “date_time”: “2020-01-23T11:48:40Z”, “errors”: [], “warnings”: [ { “code”: “v2_cost_change_by_tariff”, “message”: “New tariff code can trigger change order cost” }, { “code”: “v2_cost_change_by_services”, “message”: “New services can trigger change order cost” }, { “code”: “v2_cost_change_by_parameters”, “message”: “New parameters (weight, dimensions, items cost) can trigger change order cost” } ] } ] } |