启动编辑
POST https://{handle}.myshopline.com/admin/openapi/v20250601/orders/:id/order_edit_begin.json
handle
:店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com
的店铺,其 handle
是 open001
。订单编辑-开始编辑接口,编辑订单为一组组合接口(开始编辑,修改商品数量,增加普通商品行,增加自定义商品行,增加商品行折扣,移除商品行折扣,订单编辑提交),需要调用编辑订单-开始接口,开启一次编辑,如果该接口调用有错误,会在返回值user_errors字段中拿到错误,调用方可以根据是否有错误进行编辑重试(注意:重试需要从order_edit_begin.json订单编辑开始接口开始进行整套编辑订单接口重新调用,重试需要控制次数)
路径参数
- id string required订单idExample:
21060502039313593543444149
请求头
- Content-Type required字段值固定为
application/json; charset=utf-8
- Authorization string required资源的访问令牌。请参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入Example:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
响应
- 200
- 401
- 429
更多状态码信息请参考 HTTP 状态码
响应头
traceId
traceId
响应体
calculated_orderobject
开始动作返回的编辑订单的草稿信息committed boolean是否已经提交保存到订单id string订单编辑草稿单id,用于后续订单编辑相关接口的入参(编辑设置商品数量,增加普通商品,增加自定义商品,增加商品行折扣,移除商品行折扣)Example:2106050203931359354344414929098923
user_errorsobject[]
编辑订单的错误提示信息, 如果该接口执行有错,执行结果错误码会在此字段上返回code string错误码,具体的执行结果码在此字段透出Example:PARAM_ILLEGAL
field array导致错误的输入字段的路径Example: ``message string错误提示信息Example:参数有误
API Explorer
调试台
这篇文章对你有帮助吗?
Error loading component.