查询订单

需要 read_orders 权限点。

更多权限点使用信息,请参考:

[]

访问权限

GET https://{handle}.myshopline.com/admin/openapi/v20250601/orders.json

[]

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

[]

根据请求条件批量查询订单详细信息，可以根据订单创建时间或者更新时间来查询订单，同步订单数据。

查询参数

buyer_id string
[]
下单用户id
contract_ids string
[]
订阅合同id,多个以逗号分隔，最大支持50个
created_at_max string
[]
订单创建时间（结束）（格式见ISO 8601）
created_at_min string
[]
订单创建时间（开始）（格式见ISO 8601）
email string
[]
下单用户的email
fields string
[]
要查询的字段，逗号分隔，不传查所有的字段信息，目前全部字段返回
financial_status string
[]
支付状态: unpaid - 未支付； pending-支付中； partially_paid-部分支付； paid-已支付； partially_refunded-部分退款； refunded-已退款；
fulfillment_status string
[]
发货状态， unshipped-未发货； partial-部分发货； shipped-已发货；
hidden_order boolean
[]
是否是归档订单, true=已归档订单， false=未归档订单
ids string
[]
订单号,多个以逗号分隔，最大支持100个
limit integer
[]
查询数量限制，默认50，不能超过100
location string
[]
订单中商品被履约的地点（或是POS交易点），支持入参多个地点，用","隔开
name string
[]
自定义订单编号
page_info string
[]
加密后的请求参数，用于上一页、下一页，直接取该字段解析访问
search_content string
[]
搜索内容，涉及订单号、支付流水号、快递单号、商品名称、商品sku货号、订单金额
since_id string
[]
要查询的数据的订单号id的起始位置
sort_condition string
[]
排序：格式如：order_at
,id
多种排序按逗号分割；排序规则：如 order_at
,id
，先按order_at倒序，再按id正序； order_at, id排序
status string
[]
订单状态，open-处理中，cancelled-已取消，any-包含任何状态，包含已归档；
updated_at_max string
[]
订单更新时间（结束）（格式见ISO 8601）
updated_at_min string
[]
订单更新时间（开始）（格式见ISO 8601）

请求头

Content-Type required
[]
字段值固定为application/json; charset=utf-8
Authorization string required
[]
资源的访问令牌。请参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

响应

[]

更多状态码信息请参考 HTTP 状态码

响应头

link
[]
包含上一页、下一页的请求参数
traceId
[]
traceId

响应体

ordersobject[]
[]
数据列表
adjust_price string
[]
调整金额(店铺币种金额)，在pos场景下因金额四舍五入带来的平衡金额
[]
Example: 8.00
adjust_price_setobject
[]
按照店铺币种和交易币种计价的调整金额信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: US D
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
billing_addressobject
[]
账单地址信息
address1 string
[]
详细地址1
[]
Example: 地址1
address2 string
[]
详细地址2，备选
[]
Example: 地址2
city string
[]
城市
[]
Example: 纽约
company string
[]
公司名称
[]
Example: 新公司名
country string
[]
国家
[]
Example: 美国
country_code string
[]
国家码
[]
Example: US
first_name string
[]
姓
[]
Example: Tom
last_name string
[]
名
[]
Example: Washington
name string
[]
全名
[]
Example: test1001
phone string
[]
电话
[]
Example: 13100000000
province string
[]
省份
[]
Example: 加利福尼亚州
province_code string
[]
省份码
[]
Example: 4200006
zip string
[]
邮编
[]
Example: 92503
browser_ip string
[]
客户端ip
[]
Example: 157.119.232.35
buyer_note string
[]
买家留言
[]
Example: 留言
cancel_reason string
[]
卖家取消原因
[]
Example: "不想买了"
cancelled_at string
[]
订单取消时间（结束）（格式见ISO 8601）,2012-05-01T14:22:25-04:00
[]
Example: 2012-05-01T14:22:25-04:00
cart_token string
[]
购物车token
[]
Example: c2c4a58186b9d96395d7e6b5c2969577
checkout_id string
[]
弃单id
[]
Example: 2404785166526352972864
checkout_token string
[]
结算页token
[]
Example: c2c4a58186b9d96395d7e6b5c2969577
client_detailsobject
[]
客户端详细信息
browser_ip string
[]
浏览器地址
[]
Example: 157.119.232.35
session_hash string
[]
会员会话加密信息
[]
Example: c2c4a58186b9d96395d7e6b5c2969577
user_agent string
[]
客户端代理
[]
Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Sa
companyobject
[]
公司信息
id string
[]
公司id
[]
Example: 1005619945158043247856
location_id string
[]
地点id
[]
Example: 3005619945158043247856
tax_registration_id string
[]
税号信息
[]
Example: 213213
contract_seq string
[]
订阅合同号
[]
Example: 3005619945158043247856
created_at string
[]
订单创建时间，系统记录（格式见ISO 8601）
[]
Example: 2021-08-16T08:27:57+00:00
credit_limitobject
[]
信用支付
credit_limit_currency string
[]
信用额度币种，目前是店铺币种
[]
Example: USD
is_credit_limit boolean
[]
订单是否使用了信用支付 true：使用 false：未使用
[]
Example: true
outstanding_credit_limit string
[]
订单占用的信用额度总额
[]
Example: 1.00
total_credit_limit string
[]
订单使用的信用额度总额
[]
Example: 1.00
currency string
[]
交易币种
[]
Example: “USD”
current_subtotal_price string
[]
当前商品总和(店铺币种金额)，商品总价*数量
[]
Example: “78.0”
current_subtotal_price_setobject
[]
当前商品总和多币种信息，买卖家币种和金额一致
presentment_moneyobject
[]
买家侧币种
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧币种
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
current_total_discounts string
[]
折扣总和(店铺币种金额)，精度2，营销优惠+人工折扣
[]
Example: “0.0”
current_total_discounts_setobject
presentment_moneyobject
[]
买家侧金额
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种信息
[]
Example: USD
shop_moneyobject
[]
卖家侧金额
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种code
[]
Example: USD
current_total_duties_setobject
[]
当前商品总关税
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额
[]
Example: 8.88
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额
[]
Example: 8.88
currency_code string
[]
币种
[]
Example: USD
current_total_price string
[]
当前订单总额(店铺币种金额)，取值逻辑：商品总额 - 优惠总额 + 运费 + 税费
[]
Example: “60.0”
current_total_price_setobject
[]
当前订单总额多币种信息，买卖家币种和金额一致
presentment_moneyobject
[]
买家侧金额
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
current_total_tax string
[]
税费总和(店铺币种金额)，商品税 + 运费税
[]
Example: ”0.0“
current_total_tax_setobject
[]
税费总和多币种信息，买卖家币种和金额一致
presentment_moneyobject
[]
买家侧币种
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧币种
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
customerobject
[]
买家信息
addressesobject
[]
买家地址信息
address1 string
[]
详细地址1
[]
Example: 万达
address2 string
[]
详细地址2，备选
[]
Example: 65788
city string
[]
城市
[]
Example: 阳泉市
country string
[]
国家
[]
Example: 中国
country_code string
[]
国家码
[]
Example: CN
first_name string
[]
姓
[]
Example: Tom
last_name string
[]
名
[]
Example: Washington
name string
[]
全名
[]
Example: D203
phone string
[]
电话
[]
Example: 13100000000
province string
[]
省份
[]
Example: 山西省
province_code string
[]
省份码
[]
Example: asd
zip string
[]
邮编
[]
Example: 521000
area_code string
[]
手机区号
[]
Example: +86
created_at string
[]
买家创建时间（格式见ISO 8601）
[]
Example: 2022-11-04T10:18:46+00:00
currency string
[]
币种
[]
Example: USD
email string
[]
用户邮箱
[]
Example: Washingtontest@gmail.com
first_name string
[]
名
[]
Example: Tom
id string
[]
用户id
[]
Example: 4201057495
last_name string
[]
姓
[]
Example: Washington
phone string
[]
用户手机号
[]
Example: 13100000000
updated_at string
[]
买家更新时间
[]
Example: 2022-11-04T10:18:46+00:00
customer_locale string
[]
买家国家，语种编码+国家名称缩写
[]
Example: ”enCN“
deduct_member_point_amount string
[]
当前订单会员积分抵扣金额(店铺币种金额)
[]
Example: 8.00
deduct_member_point_amount_setobject
[]
当前订单会员积分抵扣金额, 多币种金额信息
presentment_moneyobject
[]
当前订单会员积分抵扣金额, 市场金额信息
amount string
[]
当前订单会员积分抵扣市场金额
[]
Example: 8.00
currency_code string
[]
市场币种
[]
Example: CNY
shop_moneyobject
[]
当前订单会员积分抵扣金额, 店铺金额信息
amount string
[]
当前订单会员积分抵扣店铺金额
[]
Example: 1.00
currency_code string
[]
店铺币种
[]
Example: USD
discount_applicationsobject[]
[]
折扣信息
allocation_method string
[]
分布授权的范围 1）across（该值分布在所有授权行中） 2）each（该值应用于每个授权行） allocation_method
[]
Example: across
code string
[]
折扣码
[]
Example: 82UD6BTPX9L2
description string
[]
自定义折扣的描述
[]
Example: 自定义折扣的描述
target_selection string
[]
1）explicit（折扣分配到明确选择的行） 2）all（折扣分配到所有行） 3）ENTITLED（折扣仅分配到其有权使用的行）
[]
Example: explicit
target_type string
[]
1）line_item、shipping_line
[]
Example: line_item
title string
[]
自动折扣的标题
[]
Example: 自动折扣的标题
type string
[]
折扣类型,1）manual 2）automatic 3）discount_code
[]
Example: manual
value string
[]
折扣的具体值（可以是 N折，也可以是具体的金额值,店铺币种金额）
[]
Example: 2.01
value_type string
[]
解释value的类型
[]
Example: fixed_amount
discount_codesobject[]
[]
优惠码信息
amount string
[]
优惠金额(店铺币种金额),精度2
[]
Example: 8.00
amount_setobject
[]
优惠市场金额信息
presentment_moneyobject
[]
市场金额信息
amount string
[]
优惠金额，市场金额
[]
Example: 70.00
currency_code string
[]
市场币种
[]
Example: CNY
shop_moneyobject
[]
店铺金额信息
amount string
[]
优惠金额
[]
Example: 10.00
currency_code string
[]
店铺币种
[]
Example: USD
code string
[]
优惠码
[]
Example: KIN4GNAB2FRH
type string
[]
优惠类型，减金额；打折；免运费；固定售价；最低价商品免费；打包价；第N件打折；
[]
Example: 减金额
email string
[]
买家邮箱,二者必有其一
[]
Example: hok@shoplineapp.com
financial_status string
[]
支付状态，unpaid，authorized, pending，partially_paid，paid，partially_refunded，refunded
[]
Example: "paid"
fulfillment_status string
[]
发货状态， fulfilled-已发货; partial-部分发货； null-未发货; 注：返回的枚举值与入参的查询枚举值不一样
[]
Example: "fulfilled"
fulfillmentsobject[]
[]
包裹信息
created_at string
[]
创建时间（格式见ISO 8601）
[]
Example: 2022-11-04T10:18:46+00:00
id string
[]
包裹编号
[]
Example: 22046737798141702810214336
line_itemsobject[]
[]
商品列表
attribute string
[]
商品属性：名称 - 属性值多个以逗号", "分割如：颜色 - 红色, 尺寸 - X
[]
Example: 红色
fulfillable_quantity integer
[]
可发货数量
[]
Example: 1
fulfillment_quantity integer
[]
发货数量
[]
Example: 1
fulfillment_service string
[]
物流商名称
[]
Example: 顺丰
fulfillment_status string
[]
商品的发货状态，发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
[]
Example: 未发货
grams double
[]
重量（克）
[]
Example: 100
id string
[]
商品快照表的id, 系统生成，与订单号唯一确认一个商品
[]
Example: 100
image_url string
[]
商品图片
[]
Example: https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969
location_id string
[]
取货地点唯一编号
[]
Example: 5445886274929439997
name string
[]
sku标题,同title
[]
Example: 商品名称
price string
[]
商品售价，精度2
[]
Example: 10.00
price_setobject
[]
商品售价, 多币种金额信息
presentment_moneyobject
[]
市场金额信息
amount string
[]
商品售价，市场币种价
[]
Example: 70.0
currency_code string
[]
市场币种
[]
Example: CNY
shop_moneyobject
[]
店铺金额信息
amount string
[]
商品售价，店铺币种价
[]
Example: 10.00
currency_code string
[]
币种
[]
Example: USD
product_id string
[]
spu序列号
[]
Example: 16056761559984840457934011
quantity integer
[]
订单中的商品数量
[]
Example: 1
requires_shipping boolean
[]
是否需要发货
[]
Example: true
sku string
[]
商品码，barCode
[]
Example: 测试-002
tax_linesobject[]
[]
税费信息
price string
[]
税费，精度2
[]
Example: 8.00
price_setobject
[]
税费多币种信息
presentment_moneyobject
[]
买家侧金额
amount string
[]
描金额述
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
rate double
[]
税率
[]
Example: 1
title string
[]
税费名称
[]
Example: 税费
taxable boolean
[]
是否收税
title string
[]
商品标题
[]
Example: 好用的商品
variant_id string
[]
商品sku序列号
[]
Example: 18056761559987524812644011
variant_title string
[]
商品属性值, 多个以" / "分割, 如： “155 / 红色 / 大"
[]
Example: 大
vendor string
[]
供应商
[]
Example: 供应商
name string
[]
发货单短号
[]
Example: 1032-F2
order_id string
[]
订单号
[]
Example: 21056577640603870897253153
shipment_status string
[]
包裹状态
[]
Example: fulfilled
status string
[]
物流配送状态， success-已发货； cancelled-已取消；
[]
Example: cancelled
tracking_company string
[]
物流公司名称
[]
Example: 顺丰国际
tracking_number string
[]
第三方物流单号
[]
Example: yun0001
tracking_url string
[]
物流公司url
[]
Example: https://www.sf-international.com/
updated_at string
[]
更新时间（格式见ISO 8601）
[]
Example: 2022-11-04T10:18:46+00:00
hidden_order boolean
[]
是否是归档订单, true=已归档订单， false=未归档订单
id string
[]
订单号，系统自定义编号
[]
Example: 21050224312121887324667162
landing_site string
[]
记录完整的后缀信息的链接
[]
Example: https://www.url.com
line_itemsobject[]
[]
订单商品快照信息
attribute string
[]
商品属性：名称 - 属性值多个以逗号", "分割如：颜色 - 红色, 尺寸 - X
[]
Example: 红色
country_code_of_origin string
[]
原产地国家
[]
Example: 原产地国家
customized_attributesobject[]
[]
商品自定义的属性
key string
[]
自定义属性名称key
[]
Example: "businessType"
value string
[]
商品自定义属性value, 如：当key为businessType时，value为3(表示赠品)
[]
Example: "3"
discount_allocationsobject[]
[]
营销折扣明细金额多币种
amount string
[]
折扣明细金额(店铺币种金额)
[]
Example: 8.00
amount_setobject
[]
折扣明细金额多币种
presentment_moneyobject
[]
支付币种
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
店铺币种
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
discount_application_index integer
[]
标明在折扣明细中的位置
[]
Example: 1
dutiesobject[]
[]
关税信息
country_code_of_origin string
[]
原产地/发货地的国家代码
[]
Example: USD
harmonized_system_code string
[]
海关编码
[]
Example: A0023
id string
[]
关税编号
[]
Example: H2325
priceobject
[]
关税多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额
[]
Example: 8.88
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额
[]
Example: 8.88
currency_code string
[]
币种
[]
Example: USD
tax_linesobject[]
[]
税费明细列表
price_setobject
[]
税费多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额
[]
Example: 8.88
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额
[]
Example: 8.88
currency_code string
[]
币种
[]
Example: USD
rate double
[]
税率
[]
Example: 1
rate_percentage double
[]
税率(百份比的值，即rate * 100)
[]
Example: 100
title string
[]
税费标题
[]
Example: Tax title
fulfillable_quantity integer
[]
可发货数量
[]
Example: 1
fulfillment_service string
[]
物流商名称
[]
Example: 顺丰国际
fulfillment_status string
[]
商品的发货状态，发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
[]
Example: fulfilled
gift_card boolean
[]
是否为礼品卡商品
[]
Example: true
grams double
[]
重量（克）
[]
Example: 100
harmonized_system_code string
[]
协调制度代码
[]
Example: 协调制度代码
id string
[]
商品快照表的id, 系统生成，与订单号唯一确认一个商品
[]
Example: 417
image_url string
[]
商品图片
[]
Example: https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969
location_id string
[]
取货地点唯一编号
[]
Example: 5327026538935748524
name string
[]
sku标题,同title
[]
Example: 商品标题
price string
[]
商品售价(店铺币种金额)，精度2
[]
Example: 8.00
price_setobject
[]
商品售价，精度2
presentment_moneyobject
[]
商品售价，市场币种
amount string
[]
商品售价，市场币种金额
[]
Example: 80.00
currency_code string
[]
市场币种
[]
Example: CNY
shop_moneyobject
[]
商品售价，店铺币种
amount string
[]
商品售价，店铺币种
[]
Example: 10
currency_code string
[]
市场币种
[]
Example: USD
product_id string
[]
spu序列号
[]
Example: 16056761559984840457934011
propertiesobject[]
[]
商品定制信息
additional string
[]
定制商品附加字段
[]
Example: 附加字段
name string
[]
自定义属性名称
[]
Example: 属性名称
role_visibility string
[]
定制信息可见对象： ● customer：仅对买家可见 ● merchant：仅对商家可见 ● all：对买家、商家都可见 ● none：对买家、商家都不可见
show boolean
[]
定制信息是否可见。
type string
[]
属性类型, text-字符，展示格式为 name: value; picture-图片，展示类型为 name: 通过urls获取渲染出缩略图；link-超链，展示类型为 name: value，支持点击链接跳转到urls第一个
[]
Example: text
urls array
[]
url资源列表
[]
Example: https://www.url.com
value string
[]
自定义属性值
[]
Example: 属性值
quantity integer
[]
订单中的商品数量
[]
Example: 1
requires_shipping boolean
[]
是否需要发货
[]
Example: true
sku string
[]
商品码，barCode
[]
Example: 18056761559987524812644011
tags string
[]
商品标签（多个逗号隔开）
[]
Example: 手表
tax_linesobject[]
[]
税费信息
price string
[]
税费(店铺币种金额)，精度2
[]
Example: 8.00
price_setobject
[]
税费多币种信息
presentment_moneyobject
[]
买家侧币种
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧币种
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
rate double
[]
税率
[]
Example: 1
title string
[]
税费名称
[]
Example: 税费
type string
[]
税费用类型，用于区分是商品税还是运费税，枚举值如下 product_tax：商品税 shipping_tax：运费税
[]
Example: shipping_tax
taxable boolean
[]
是否收税
[]
Example: true
title string
[]
商品标题
[]
Example: 漂亮的裙子
variant_id string
[]
商品sku序列号
[]
Example: 18056761559987524812644011
variant_title string
[]
商品属性值, 多个以" / "分割, 如： “155 / 红色 / 大"
[]
Example: 大
vendor string
[]
供应商
[]
Example: 供应商
locationsobject[]
[]
到店取货地点地址信息
address string
[]
详细地址1
[]
Example: 地址1
address_add string
[]
详细地址2
[]
Example: 地址22
city string
[]
城市
[]
Example: 广州
country string
[]
国家
[]
Example: 中国
country_code string
[]
国家码
[]
Example: CN
district string
[]
区/县
[]
Example: 番禺区
location_id string
[]
取货地点唯一编号
[]
Example: 5327026538935748524
name string
[]
地址名称
[]
Example: 万达广场
phone string
[]
电话号码，如(555)555-5555
[]
Example: 13100000000
province string
[]
省份
[]
Example: 广东省
town string
[]
乡/镇
[]
Example: 镇
type string
[]
地点类型。 1.posLocation: POS渠道创建该订单的门店地点（建议使用posLocationId，后续将废弃） 2.pickupLocation: 当订单的配送方式为自提时，自提的门店地点 3.productLocation: 订单中商品的库存地点（建议使用商品行中的location信息，后续将废弃）
[]
Example: posLocation
zip string
[]
邮编
[]
Example: 521000
name string
[]
店铺自定义订单号，从1001开始，可以设置前缀
[]
Example: test1001
note string
[]
商家备注内容
[]
Example: 备注
note_attributesobject[]
[]
商家备注日志，日期内容
create_time string
[]
备注创建时间（格式见ISO 8601）
[]
Example: 2022-11-04T10:18:46+00:00
name string
[]
备注来源（卖家标识）
[]
Example: 备注来源
value string
[]
备注内容
[]
Example: 备注内容
order_at string
[]
订单成单时间（格式见ISO 8601）
[]
Example: 2021-08-16T08:27:57+00:00
order_source string
[]
订单来源渠道，目前只有pos渠道该字段才有值，其他渠道该值为空
[]
Example: pos
order_status_url string
[]
订单状态页url
[]
Example: https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509
payment_detailsobject[]
[]
支付单信息
create_time string
[]
支付单创建时间
[]
Example: 2021-08-16T08:27:57+00:00
gateway string
[]
支付方式名称
[]
Example: Mypay
pay_amount double
[]
支付金额(店铺币种金额)
[]
Example: 8
pay_channel string
[]
支付渠道
[]
Example: Paypal
pay_channel_deal_id string
[]
外部渠道支付流水号
[]
Example: pi_3MI897Hezv8FxjBO1uGxMPhX
pay_merchant_email string
[]
支付商户email账户
[]
Example: Washingtontest@gmail.com
pay_merchant_id string
[]
支付商户id
[]
Example: 4201057379
pay_merchant_order_id string
[]
支付商户订单号
[]
Example: 233445354566
pay_seq string
[]
支付单号
[]
Example: 23057287797738260472676128
pay_status string
[]
支付单状态, unpaid-未支付；pending-支付中；risking-风控中；paid-已支付；paid_overtime-支付失败；paid_failed-支付失败；
[]
Example: unpaid
processed_at string
[]
processed_at 支付创建时间,格式：2023-04-12T22:59:52+08:00
[]
Example: 2023-04-12T22:59:52+08:00
settle_currency string
[]
结算币种
[]
Example: USD
settle_pay_amount double
[]
支付金额(结算币种金额)
[]
Example: 8
status_code string
[]
支付状态码
[]
Example: RISK_PENDING
status_msg string
[]
支付单状态码描述
[]
Example: PENDING_REVIEW
payment_gateway_names array
[]
付款方式列表,该订单所用到的付款方式列表, SLpayments �,Paypal(PayPal支付�), Oceanpay(钱海支付�), TwoCheckout,AsiaBill, Stripe,Pacypay, WorldPay, COD（货到付款), CUSTOM(自定义), adjustPay（资金调整）, Xendit(xendit信用卡�), XenditOther
[]
Example: Paypal
payment_termsobject
[]
支付条款
created_at string
[]
创建时间
[]
Example: 2024-06-05 08:00:00
due_in_days integer
[]
当条款类型为NET时提供，多少天后未付款则到期
[]
Example: 2
id string
[]
唯一识别该支付条款的id
[]
Example: 6497210673894431747
overdue boolean
[]
支付条款是否超时：true/false
[]
Example: true
payment_schedulesobject[]
[]
与付款条件相关联的一组时间表
completed_at string
[]
付款完成时间
[]
Example: 2024-06-05 08:00:00
due_at string
[]
预计付款时间
[]
Example: 2024-06-05 08:00:00
issued_at string
[]
付款条件启动的时间。当为FIXED时，为保存时间（若草稿单成单，则订单继承草稿单时间）；当为FULFILLMENT/RECEIPT时，为条件生效时间；当为NET时，则为保存时间（若草稿单成单，则订单继承草稿单时间）
[]
Example: 2024-06-05 08:00:00
payment_terms_name string
[]
用于创建付款条件的付款条件模板的名称
[]
Example: Due on receipt
payment_terms_type string
[]
用于创建付款条件的付款条件模板类型： FIXED：商家指定日期 FULFILLMENT：完成发货日期 NET：固定条件日期 RECEIPT：发送账单日期 UNKNOWN：未知类型
[]
Example: RECEIPT
updated_at string
[]
更新时间
[]
Example: 2024-06-05 08:00:00
phone string
[]
买家联系方式，二者必有其一
[]
Example: 18978789878
po_number string
[]
B2B场景在订单上记录的采购订单号
pos_location_id string
[]
地点ID
[]
Example: 5327026538935748524
presentment_currency string
[]
买家侧币种,同卖家侧币种
[]
Example: USD
processed_at string
[]
成单时间,格式：2023-04-12T22:59:52+08:00
[]
Example: 2023-04-12T22:59:52+08:00
processed_user_id string
[]
订单创建者
[]
Example: 4201057495
referring_site string
[]
外部链接
[]
Example: https://www.referringSite.com
refundsobject[]
[]
退款列表
created_at string
[]
退款单创建时间（格式见ISO 8601）
[]
Example: 2021-08-16T08:27:57+00:00
id string
[]
退款id
[]
Example: 2605659027312156877634
note string
[]
退款备注
[]
Example: 退款备注
order_adjustmentsobject[]
[]
调整单信息，用于记录两类信息： 1）与运费相关的退款信息(type类型为shipping_refund) 2）自动计算的退款金额与实际退款金额的差值(type类型为refund_discrepancy)
amount string
[]
调整单金额(店铺币种金额)
[]
Example: 8.00
amount_setobject
[]
调整单金额
presentment_moneyobject
[]
店铺调整单展示金额
amount double
[]
店铺调整展示金额
[]
Example: 8
currency_code string
[]
店铺调整展示金额币种
[]
Example: USD
shop_moneyobject
[]
店铺调整金额
amount double
[]
店铺调整金额
[]
Example: 8
currency_code string
[]
店铺调整金额币种
[]
Example: USD
id string
[]
退款调整单id
[]
Example: RAP5570565996182771228
kind string
[]
调整单类型：refund_discrepancy、shipping_refund
[]
Example: refund_discrepancy
order_id string
[]
订单号
[]
Example: 21056577640603870897253153
reason string
[]
调整原因：Refund discrepancy、shipping_refund
[]
Example: Refund discrepancy
refund_id string
[]
退款单id
[]
Example: 2605659027312156877634
tax_amount string
[]
调整单税费金额(店铺币种金额)
[]
Example: 8.00
tax_amount_setobject
[]
调整单税费金额(多币种金额)
presentment_moneyobject
[]
店铺调整单展示税费金额
amount double
[]
店铺调整单展示税费金额
[]
Example: 8
currency_code string
[]
店铺调整单展示税费币种
[]
Example: USD
shop_moneyobject
[]
店铺调整单税费金额
amount double
[]
店铺调整单税费金额
[]
Example: 8
currency_code string
[]
店铺调整单税费币种
[]
Example: USD
order_id string
[]
订单号
[]
Example: 21056577640603870897253153
processed_at string
[]
更新时间（格式见ISO 8601）
[]
Example: 2021-08-16T08:27:57+00:00
refund_line_itemsobject[]
[]
退款详细信息
id string
[]
退款单号
[]
Example: 2605659027312156877634
line_itemobject
[]
描述
attribute string
[]
商品属性：名称 - 属性值多个以逗号", "分割如：颜色 - 红色, 尺寸 - X
[]
Example: 红色
fulfillable_quantity integer
[]
可发货数量
[]
Example: 1
fulfillment_service string
[]
物流商名称
[]
Example: 顺丰国际
fulfillment_status string
[]
商品的发货状态，发货状态， fulfilled-已发货; partial-部分发货； null-未发货;
[]
Example: fulfilled
grams double
[]
重量（克）
[]
Example: 1
id string
[]
商品快照表的id, 系统生成，与订单号唯一确认一个商品
[]
Example: 403
name string
[]
sku标题,同title
[]
Example: 18056761559987524812644011
price string
[]
商品售价(店铺币种金额)，精度2的金额字符串
[]
Example: 8.00
price_setobject
[]
商品售价，市场币种信息
presentment_moneyobject
[]
商品售价，市场币种信息
amount string
[]
商品售价，市场币种金额
[]
Example: 10.00
currency_code string
[]
市场币种
[]
Example: USD
shop_moneyobject
[]
当前订单会员积分抵扣金额，店铺币种信息
amount string
[]
商品售价，店铺币种金额
[]
Example: 70.00
currency_code string
[]
店铺币种
[]
Example: CNY
product_id string
[]
spu序列号
[]
Example: 16056761559984840457934011
quantity integer
[]
订单中的商品数量
[]
Example: 1
requires_shipping boolean
[]
是否需要发货
[]
Example: true
sku string
[]
商品码，barCode
[]
Example: sku名称
tax_linesobject[]
[]
税费信息
price string
[]
税费(店铺币种金额)，精度2
[]
Example: 8.00
price_setobject
[]
税费多币种信息
presentment_moneyobject
[]
买家侧币种
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
rate double
[]
税率
[]
Example: 1
title string
[]
标题
[]
Example: 标题
taxable boolean
[]
是否收税
[]
Example: true
title string
[]
商品标题
[]
Example: 商品标题
variant_id string
[]
商品sku序列号
[]
Example: 18056761559987524812644011
variant_title string
[]
商品属性值, 多个以" / "分割, 如： “155 / 红色 / 大"
[]
Example: 大
vendor string
[]
供应商
[]
Example: 供应商
line_item_id string
[]
商品快照表的id, 系统生成，与订单号唯一确认一个商品
[]
Example: 406
quantity integer
[]
数量,商品数量
[]
Example: 1
restock_type string
[]
库存返还类型,no_restock-未返还，cancel-取消， return-返还
[]
Example: cancel
subtotal double
[]
退款金额合计(店铺币种金额)，精度2
[]
Example: 8
subtotal_setobject
[]
退款金额合计，多币种信息，卖家和买家侧相同
presentment_moneyobject
[]
买家侧币种
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
total_tax double
[]
退款商品的税额(店铺币种金额)，精度2
[]
Example: 8
total_tax_setobject
[]
总税额，多币种信息
presentment_moneyobject
[]
买家侧币种
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧币种
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
transactionsobject[]
[]
退款交易信息
amount string
[]
退款金额，精度2
[]
Example: 8.00
created_at string
[]
创建时间
[]
Example: 2021-08-16T08:27:57+00:00
currency string
[]
币种
[]
Example: USD
id string
[]
退款id
[]
Example: 2605659027312156877634
kind string
[]
交易类型（authorization， capture， sale， void， refund）
[]
Example: void
order_id string
[]
订单号
[]
Example: 21056577640603870897253153
processed_at string
[]
退款单更新时间
[]
Example: 2021-08-16T08:27:57+00:00
settle_amount string
[]
退款金额(结算币种)，精度2
[]
Example: 8.00
settle_currency string
[]
结算币种
[]
Example: USD
status string
[]
处理状态, pending, failure, success, and error
[]
Example: success
user_id string
[]
买家id
[]
Example: 4201057495
user_id string
[]
用户id
[]
Example: 4201057495
service string
[]
发货方式类型, pickUp表示到店取货.
[]
Example: pickUp
shipping_addressobject
[]
收货地址
address1 string
[]
address1
[]
Example: 地址1
address2 string
[]
详细地址2，备选
[]
Example: 地址2
city string
[]
城市
[]
Example: 城市
company string
[]
公司名称
[]
Example: 公司名称
country string
[]
国家
[]
Example: 中国
country_code string
[]
国家码
[]
Example: CN
delivery_store_code string
[]
门店编码
[]
Example: 1001
delivery_store_name string
[]
门店名称
[]
Example: 门店名称
district string
[]
区
[]
Example: 番禺区
district_code string
[]
区编码
[]
Example: 521000
first_name string
[]
姓
[]
Example: Tom
last_name string
[]
名
[]
Example: Washington
latitude string
[]
纬度
[]
Example: 15
longitude string
[]
经度
[]
Example: 41
name string
[]
全名
[]
Example: Tom.Washington
phone string
[]
电话
[]
Example: 13100000000
province string
[]
省份
[]
Example: 广东省
province_code string
[]
省份码
[]
Example: 510000
zip string
[]
邮编
[]
Example: 521000
shipping_linesobject[]
[]
物流信息
code string
[]
物流编号
[]
Example: SF
discount_allocationsobject[]
[]
折扣明细
amount string
[]
折扣金额(店铺币种金额)，精度2
[]
Example: 8.00
amount_setobject
[]
折扣多币种金额
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
店铺侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
discount_application_index integer
[]
在折扣明细中的位置
[]
Example: 1
discounted_price string
[]
折扣金额(店铺币种金额)，精度2
[]
Example: 8.00
discounted_price_setobject
[]
折扣多币种金额
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
店铺侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
phone string
[]
电话
[]
Example: 13100000000
price string
[]
物流运费(店铺币种金额),精度2
[]
Example: 8.00
price_setobject
[]
物流运费多资源信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
店铺侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
requested_fulfillment_service_id string
[]
运输服务代号
[]
Example: -
shipping_price string
[]
原运费金额值（非折扣后金额，店铺币种金额）
[]
Example: 8.00
shipping_price_setobject
[]
原运费金额值（非折扣后金额）,多币种金额信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
amount，精度2
[]
Example: 8.00
currency_code string
[]
市场币种
[]
Example: CNY
shop_moneyobject
[]
店铺侧金额信息
amount string
[]
amount，精度2
[]
Example: 1.00
currency_code string
[]
店铺币种
[]
Example: USD
source string
[]
运费来源
[]
Example: 来源
tax_linesobject[]
[]
物流征税列表
price string
[]
税费(店铺币种金额)
[]
Example: 8.00
price_setobject
[]
税费多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
rate double
[]
税率
[]
Example: 1
title string
[]
税费名称
[]
Example: 税费名称
title string
[]
物流名称
[]
Example: 顺丰国际
source_identifier string
[]
用于识别业务处理的id标识
[]
Example: -
source_name string
[]
用于识别业务处理的类型筛选
[]
Example: -
source_url string
[]
跳转到店铺的链接的html格式信息
[]
Example: -
status string
[]
订单状态 open=处理中，cancelled-已取消
[]
Example: open
store_id string
[]
店铺id
[]
Example: 1644828244663
subtotal_price string
[]
商品折后价总和(店铺币种金额), 商品总价 - 营销优惠 - 人工折扣
[]
Example: 8.00
subtotal_price_setobject
[]
商品折后价总和多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
[]
Example: 1.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
tags string
[]
订单标签
[]
Example: 标签
tax_description string
[]
税费说明。
tax_linesobject[]
[]
税费信息
name string
[]
税费名称
[]
Example: 税费名称
price string
[]
税费(店铺币种金额)，精度2
[]
Example: 8.00
price_setobject
[]
税费多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
rate double
[]
税率
[]
Example: 1
title string
[]
税费名称
[]
Example: 税费名称
tax_number string
[]
税号
[]
Example: -
tax_type string
[]
税号类型
[]
Example: -
taxes_included boolean
[]
总计额是否包含税额
[]
Example: true
total_discounts string
[]
折扣总额(店铺币种金额)，营销优惠+人工折扣
[]
Example: 8.00
total_discounts_setobject
[]
折扣总额多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
total_line_items_price string
[]
商品原价总和(店铺币种金额)，精度2
[]
Example: 8.00
total_line_items_price_setobject
[]
商品原价总和，多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
total_outstanding string
[]
未付款金额总和(店铺币种金额)，精度2
[]
Example: 8.00
total_shipping_price_setobject
[]
订单运费总和，多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
total_tax string
[]
税费总和(店铺币种金额)，精度2, 商品税 + 运费税
[]
Example: 8.00
total_tax_setobject
[]
税费总和，多币种信息
presentment_moneyobject
[]
买家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
shop_moneyobject
[]
卖家侧金额信息
amount string
[]
金额，精度2
[]
Example: 8.00
currency_code string
[]
币种
[]
Example: USD
total_tip_received string
[]
小费(店铺币种金额)，精度2
[]
Example: 8.00
total_tip_received_setobject
[]
当前订单会员积分抵扣金额, 多币种金额信息
presentment_moneyobject
[]
当前订单会员积分抵扣金额，市场币种信息
amount string
[]
当前订单会员积分抵扣金额，市场币种
[]
Example: 10.00
currency_code string
[]
市场币种
[]
Example: USD
shop_moneyobject
[]
当前订单会员积分抵扣金额，店铺币种信息
amount string
[]
当前订单会员积分抵扣金额，店铺币种金额
[]
Example: 70.00
currency_code string
[]
店铺币种
[]
Example: CNY
total_weight double
[]
商品总重量（g）
[]
Example: 1
updated_at string
[]
订单更新时间，（格式见ISO 8601）
[]
Example: 2021-08-16T08:27:57+00:00
user_id string
[]
买家id
[]
Example: 4201057495
utm_parameters string
[]
广告业务专用的参数，用于广告的归因计算
[]
Example: -

API Explorer

调试台

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

buyer_id — query

contract_ids — query

created_at_max — query

created_at_min — query

email — query

fields — query

financial_status — query

fulfillment_status — query

hidden_order — query

ids — query

limit — query

location — query

name — query

page_info — query

search_content — query

since_id — query

sort_condition — query

status — query

updated_at_max — query

updated_at_min — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/orders.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

这篇文章对你有帮助吗？

SHOPLINE

条款协议