查询指定客户订单
GET https://{handle}.myshopline.com/admin/openapi/v20250601/customers/:id/orders.json
handle
:店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com
的店铺,其 handle
是 open001
。支持通过该接口查询指定客户下的全部订单信息
路径参数
- id string required客户idExample:
2002697754
查询参数
- fields string要查询的字段,逗号分隔,不传查所有的字段信息,目前全部字段返回Example:
id
- limit integer查询数量限制,默认50,不能超过100Example:
10
- page_info string加密后的请求参数,用于上一页、下一页,直接取该字段解析访问Example:
eyJxdWVyeVBhcmFtU3RyaW5nIjoie1wic2l6ZVwiOjEsXCJzb3J0XCI6W1widWlkOmRlc2NcIl0sXCJzdG9yZUlkXCI6XCIxNjM5NjQwNTgxMzQ2XCIsXCJ1aWRcIjpcIjBcIixcImNyZWF0ZVRpbWVcIjpcIjw9MTY0OTg1NTYwMDAwMFwiLFwidXBkYXRlVGltZVwiOlwiXCJ9Iiwic2luY2VJZExpc3QiOlsiNDIwMTY4MDE5NSJdLCJwYWdlIjoyLCJzaXplIjoxLCJpbml0U29ydCI6WyJ1aWQ6ZGVzYyJdLCJzb3J0IjpbInVpZDpkZXNjIl0sImRpcmVjdGlvbiI6Im5leHQifQ
- since_id string要查询的数据的订单号id的起始位置Example:
21050224312121887324667162
- status string required订单状态,open-处理中,cancelled-已取消,any-包含任何状态,包含已归档Example:
any
请求头
- Content-Type required字段值固定为
application/json; charset=utf-8
- Authorization string required资源的访问令牌。请参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入Example:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
响应
- 200
- 401
- 422
- 429
更多状态码信息请参考 HTTP 状态码
响应头
link
包含上一页、下一页的请求参数traceId
traceId
响应体
listobject[]
订单信息列表adjust_price string调整金额Example:34
adjust_price_setobject
调整金额presentment_moneyobject
买家侧金额amount string金额,精度2Example:45
currency_code string币种信息Example:CNY
shop_moneyobject
卖家侧金额amount string金额,精度2Example:45
currency_code string币种信息Example:CNY
billing_addressobject
账单地址信息address1 string详细地址1Example:department1
address2 string详细地址2,备选Example:department2
city string城市Example:guangzhoushi
city_code string城市码Example:414000
company string公司名称Example:joyy
country string国家Example:china
country_code string国家码Example:CN
first_name string名Example:Bob
last_name string姓Example:James
name string全名Example:Bob James
phone string手机号Example:008613987675643
province string省份Example:guangdong
province_code string省份码Example:440000
zip string邮编Example:539002
browser_ip string客户端ipExample:157.119.232.35
buyer_note string买家留言Example:is good
cancel_reason string卖家取消原因Example:no reason
cancelled_at string订单取消时间(结束)(格式见IOS8601)Example:2012-05-01T14:22:25-04:00
client_detailsobject
客户端详细信息browser_ip stringip地址Example:157.119.232.35
session_hash stringsessionIdExample:42343243253543
user_agent string客户端代理Example:157.119.232.35
created_at string订单创建时间(格式见IOS8601)Example:2021-08-16T08:27:57+00:00
currency string交易币种Example:CNY
current_subtotal_price string当前商品总和,商品总价*数量Example:78.0
current_subtotal_price_setobject
当前商品总和多币种信息, 买卖家币种和金额一致presentment_moneyobject
买家侧金额amount string金额,精度2Example:43
currency_code string币种信息Example:CNY
shop_moneyobject
卖家侧金额amount string金额,精度2Example:543
currency_code string币种信息Example:CNY
current_total_discounts string折扣总和,精度2,营销优惠+人工折扣Example:0.0
current_total_discounts_setobject
折扣总和多币种信息,没有多币种,所以买卖家币种和金额一致presentment_moneyobject
买家侧金额amount string金额,精度2Example:43
currency_code string币种信息Example:CNY
shop_moneyobject
卖家侧金额amount string金额,精度2Example:565435
currency_code string币种信息Example:CNY
current_total_price string当前订单总额,取值逻辑:商品总额 - 优惠总额 + 运费 + 税费Example:60.0
current_total_price_setobject
当前订单总额多币种信息,买卖家币种和金额一致presentment_moneyobject
买家侧金额amount string金额,精度2Example:443
currency_code string币种信息Example:CNY
shop_moneyobject
卖家侧金额amount string金额,精度2Example:644
currency_code string币种信息Example:CNY
current_total_tax string税费总和,商品税 + 运费税Example:0.0
current_total_tax_setobject
税费总和多币种信息, 买卖家币种和金额一致presentment_moneyobject
买家侧金额amount string金额,精度2Example:453424
currency_code string币种信息Example:CNY
shop_moneyobject
卖家侧金额amount string金额,精度2Example:4353
currency_code string币种信息Example:CNY
customerobject
买家信息addressesobject
买家地址信息address1 string详细地址1Example:department1
address2 string详细地址2,备选Example:department2
city string城市Example:guangzhoushi
city_code string城市码Example:440113
country string国家Example:china
country_code string国家码Example:CN
first_name string名Example:Bob
last_name string姓Example:James
name string全名Example:Bob James
phone string电话Example:008613877763452
province string省份Example:guangdong
province_code string省份码Example:440000
zip string邮编Example:523424
area_code string手机区号Example:0086
created_at string买家创建时间Example:2021-08-16T08:27:57+00:00
currency string币种Example:CNY
email string用户邮箱Example:267347264@163.com
first_name string名Example:Bob
id string用户idExample:223234928
last_name string姓Example:James
phone string用户手机号Example:008615087675643
updated_at string买家更新时间Example:2021-08-16T08:27:57+00:00
customer_locale string买家国家,语种编码+国家名称缩写Example:enCN
discount_codesobject[]
优惠码信息amount string优惠金额,精度2Example:32
code string优惠码Example:43563
type string优惠类型,减金额;打折;免运费;固定售价;最低价商品免费;打包价;第N件打折;Example:1
email string买家邮箱Example:hok@shoplineapp.com
financial_status string支付状态,unpaid,authorized, pending,partially_paid,paid,partially_refunded,refundedExample:paid
fulfillment_status string发货状态, unshipped-未发货; partial-部分发货; shipped-已发货;Example:unshipped
fulfillmentsobject[]
包裹信息created_at string创建时间Example:2021-08-16T08:27:57+00:00
id string包裹编号Example:4323245325235435
line_itemsobject[]
商品列表attribute string商品属性:名称 - 属性值 多个以逗号", "分割 如:颜色 - 红色, 尺寸 - XExample:big
fulfillable_quantity integer可发货数量Example:3
fulfillment_service string物流商名称Example:EMS
fulfillment_status string商品的发货状态, 发货状态, fulfilled-已发货; partial-部分发货; null-未发货;Example:fulfilled
gift_card boolean礼品卡信息grams double重量(克)Example:23
id string商品快照表的id, 系统生成,与订单号唯一确认一个商品Example:4322424124214
image_url string商品图片Example:https://imageaaa.com
name stringsku标题,同titleExample:air
price string商品售价,精度2Example:43
product_id stringspu序列号Example:23424242143214
quantity integer订单中的商品数量Example:2
requires_shipping boolean是否需要发货Example:true
sku string商品码,barCodeExample:e2erwrwrwr
tax_linesobject[]
税费信息price string税费,精度2Example:33
price_setobject
税费多币种信息presentment_moneyobject
买家侧金额amount string金额Example:34
currency_code string币种Example:CNY
shop_moneyobject
卖家侧金额信息amount string金额Example:533
currency_code string币种Example:CNY
rate double税率title string税费名称Example:gateway
taxable boolean是否收税title string商品标题Example:good
variant_id string商品sku序列号Example:dsfsfsdffsdf
variant_title string商品属性值, 多个以" / "分割, 如: “155 / 红色 / 大"Example:red
vendor string供应商Example:alibaba
order_id string订单号Example:543543654654657
shipment_status string包裹状态Example:sended
status string物流配送状态, success-已发货; cancelled-已取消;Example:success
tracking_company string物流公司名称Example:EMS
tracking_number string第三方物流单号Example:43324523532535
tracking_url string物流公司urlExample:https//ems.hsh.com
updated_at string更新时间Example:2021-08-16T08:27:57+00:00
hidden_order boolean是否是归档订单, true=已归档订单, false=未归档订单Example:true
id string系统订单号Example:21050224312121887324667162
line_itemsobject[]
订单商品快照信息attribute string商品属性:名称 - 属性值 多个以逗号", "分割 如:颜色 - 红色, 尺寸 - XExample:red
fulfillable_quantity integer可发货数量Example:2
fulfillment_service string物流商名称Example:EMS
fulfillment_status string商品的发货状态, 发货状态, fulfilled-已发货; partial-部分发货; null-未发货;Example:fulfilled
gift_card boolean是否为礼品卡商品grams double重量(克)Example:324
id string商品快照表的id, 系统生成,与订单号唯一确认一个商品Example:4324234535
image_url string商品图片Example:https://aaa.com
name stringsku标题,同titleExample:good
price string商品售价,精度2Example:32
product_id stringspu序列号Example:24344523543254325
propertiesobject[]
商品定制信息name string自定义属性名称Example:size
type string属性类型, text-字符,展示格式为 name: value; picture-图片,展示类型为 name: 通过urls获取渲染出缩略图;link-超链,展示类型为 name: value,支持点击链接跳转 到urls第一个Example:picture
urls arrayurl资源列表Example:https://dsadasd.com
value string自定义属性值Example:big
quantity integer订单中的商品数量Example:3
requires_shipping boolean是否需要发货sku string商品码,barCodeExample:4324325325345
tags string商品标签(多个逗号隔开)Example:good
tax_linesobject[]
税费信息price string税费,精度2Example:0
price_setobject
税费多币种信息presentment_moneyobject
卖家侧币种amount string金额Example:43
currency_code string币种Example:CNY
shop_moneyobject
卖家侧币种amount string金额Example:34534
currency_code string币种Example:CNY
rate double税率title string税费名称Example:goods
taxable boolean是否收税title string商品标题Example:air
variant_id string商品sku序列号Example:432424324
variant_title string商品属性值, 多个以" / "分割, 如: “155 / 红色 / 大"Example:red
vendor string供应商Example:alibaba
locationsobject[]
到店取货地点地址信息address string详细地址1Example:department1
address_add string详细地址2Example:department2
city string城市Example:guangzhoushi
country string国家Example:china
country_code string国家码Example:CN
district string区/县Example:panyu
location_seq string地址序列号Example:234423424234
name string地址名称Example:wandaguangchang
phone string电话Example:008615089765743
province string省份Example:guangdong
town string乡/镇Example:dashi
zip_code string邮编Example:430302
name string自定义订单号Example:1037
note string商家备注内容Example:good customer
note_attributesobject[]
商家备注日志,日期内容create_time string备注创建时间(格式见IOS8601)Example:2021-08-16T08:27:57+00:00
name string备注来源(卖家标识)Example:none
value string备注内容Example:hello
order_from string订单来源Example:admin
order_status_url string订单状态页urlExample:https//hhdghs.com
payment_detailsobject[]
支付单信息create_time string支付单创建时间Example:2021-08-16T08:27:57+00:00
pay_amount double支付金额Example:45
pay_channel_deal_id string外部渠道支付流水号Example:2344325435235235
pay_seq string支付单号Example:56464645466
pay_status string支付单状态, unpaid-未支付;pending-支付中;risking-风控中;paid-已支付;paid_overtime-支付失败;paid_failed-支付失败;Example:paid
payment_channel string支付渠道Example:online
payment_merchant_id string支付商户idExample:4234242e32e
payment_merchant_order_id string支付商户订单号Example:42323432424
payment_gateway_names array付款方式列表,该订单所用到的付款方式列表, SLpayments ,Paypal(PayPal支付), Oceanpay(钱海支付), TwoCheckout,AsiaBill, Stripe,Pacypay, WorldPay, COD(货到付款), CUSTOM(自定义), adjustPay(资金调整), Xendit(xendit信用卡), XenditOtherExample:Paypal
phone string电话号码Example:(555)555-5555
presentment_currency string买家侧币种,同卖家侧币种Example:USD
refundsobject[]
退款列表created_at string退款单创建时间 (格式见IOS8601)Example:2021-08-16T08:27:57+00:00
id string退款idExample:2342353425235
note string退款备注Example:none
order_adjustmentsobject[]
调整单信息amount string调整单金额Example:34
amount_setobject
调整单金额presentment_moneyobject
店铺调整展示金额amount double店铺调整展示金额Example:44
currency_code string店铺调整展示金额币种Example:CNy
shop_moneyobject
店铺调整金额amount double店铺调整金额Example:34
currency_code string店铺调整金额币种Example:CNY
id string退款调整单idExample:werwqrwqrqwr
kind string调整单类型Example:none
order_id string订单号Example:423343254235
reason string调整原因Example:no reason
refund_id string退款单idExample:43254325325325
tax_amount string调整单税费金额Example:44
tax_amount_setobject
调整单税费金额presentment_moneyobject
店铺调整单展示税费金额amount double店铺调整单展示税费金额Example:43
currency_code string店铺调整单展示税费金额Example:CNY
shop_moneyobject
店铺调整单税费金额amount double店铺调整单税费金额Example:434
currency_code string店铺调整单税费币种Example:CNy
order_id string订单号Example:54325235235442354
processed_at string更新时间 (格式见IOS8601)Example:2021-08-16T08:27:57+00:00
refund_line_itemsobject[]
退款详细信息id string退款单号Example:42323524353
line_itemobject
描述attribute string商品属性:名称 - 属性值 多个以逗号", "分割 如:颜色 - 红色, 尺寸 - XExample:red
fulfillable_quantity integer可发货数量Example:3
fulfillment_service string物流商名称Example:EMS
fulfillment_status string商品的发货状态, 发货状态, fulfilled-已发货; partial-部分发货; null-未发货;Example:fullfilled
gift_card boolean是否为礼品卡商品grams double重量(克)Example:33
id string商品快照表的id, 系统生成,与订单号唯一确认一个商品Example:432434325
image_url string商品图片Example:https://dsfaf.com
name stringsku标题,同titleExample:good
price string商品售价,精度2Example:23
product_id stringspu序列号Example:42342352435325
propertiesobject[]
商品定制信息name string自定义属性名称Example:size
type string属性类型, text-字符,展示格式为 name: value; picture-图片,展示类型为 name: 通过urls获取渲染出缩略图;link-超链,展示类型为 name: value,支持点击链接跳转 到urls第一个Example:picture
urls arrayurl资源列表Example:https://asdfasfsaf.com
value string自定义属性值Example:big size
quantity integer订单中的商品数量Example:2
requires_shipping boolean是否需要发货Example:true
sku string商品码,barCodeExample:32424324
tags string商品标签(多个逗号隔开)Example:big,red
tax_linesobject[]
税费信息price string税费,精度2Example:8
price_setobject
税费多币种信息presentment_moneyobject
买家侧币种amount string金额Example:4234
currency_code string币种Example:CNY
shop_moneyobject
卖家侧币种amount string金额Example:3546
currency_code string币种Example:CNy
rate double税率Example:4
title string税费名称Example:googs
taxable boolean是否收税Example:true
title string标题Example:air
variant_id string商品sku序列号Example:23424235235
variant_title string商品属性值, 多个以" / "分割, 如: “155 / 红色 / 大"Example:red
vendor string供应商Example:alibaba
line_item_id string商品快照表的id, 系统生成,与订单号唯一确认一个商品Example:2343535325
quantity integer数量,商品数量Example:2
restock_type string库存返还类型,no_restock-未返还,cancel-取消, return-返还 只有未返还Example:cancel
subtotal double退款金额合计,精度2Example:23
subtotal_setobject
退款金额合计,多币种信息,卖家和买家侧相同presentment_moneyobject
买家侧币种amount string金额,精度2Example:34
currency_code string币种Example:CNy
shop_moneyobject
卖家侧金额信息amount string金额,精度2Example:544
currency_code string币种Example:CNY
total_tax double退款商品的税额,精度2Example:33
total_tax_setobject
总税额,多币种信息presentment_moneyobject
买家侧币种amount string金额,精度2Example:43
currency_code string币种Example:CNY
shop_moneyobject
卖家侧金额信息amount string金额,精度2Example:243
currency_code string币种Example:CNY
transactionsobject[]
退款交易信息amount string退款金额,精度2Example:34
created_at string创建时间Example:2021-08-16T08:27:57+00:00
currency string币种Example:CNy
id string退款idExample:123424252435
kind string交易类型(authorization, capture, sale, void, refund)Example:sale
order_id string订单号Example:234535235325
processed_at string更新时间Example:2021-08-16T08:27:57+00:00
status string处理状态, pending, failure, success, and errorExample:success
user_id string用户idExample:22032949
user_id string用户idExample:22034092
service string发货方式类型, pickUp表示到店取货.Example:pickUp
shipping_addressobject
收货地址address1 string详细地址1Example:department1
address2 string详细地址2,备选Example:department2
city string城市Example:guangzhoushi
city_code string城市码Example:440100
company string公司名称Example:joyy
country string国家Example:china
country_code string国家码Example:CN
delivery_store_code string门店编码Example:341e32
delivery_store_name string门店名称Example:hello
district string区Example:panyuqu
district_code string区编码Example:440372
first_name string名Example:Bob
last_name string姓Example:James
name string全名Example:Bob James
phone string手机号Example:008615098987462
province string省份Example:guangdong
province_code string省份码Example:440000
zip string邮编Example:423443
shipping_linesobject[]
物流信息code string物流编号Example:e2342542354325
discounted_price string折扣金额,精度2Example:2
phone string电话Example:00861897657463
price string物流运费,精度2Example:2
price_setobject
物流运费多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2Example:34
currency_code string币种Example:CNY
shop_moneyobject
店铺侧金额信息amount string金额,精度2Example:34
currency_code string币种Example:CNY
requested_fulfillment_service_id string运输服务代号Example:324242424
tax_linesobject[]
物流征税列表price string税费Example:44
price_setobject
税费多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2Example:54
currency_code string币种Example:CNY
shop_moneyobject
店铺侧金额信息amount string金额,精度2Example:65
currency_code string币种Example:CNY
rate double税率title string税费名称Example:goods
title string物流名称Example:EMS
status string订单状态,open-处理中,cancelled-已取消,any-包含任何状态,包含已归档;Example:open
subtotal_price string商品折后价总和, 商品总价 - 营销优惠 - 人工折扣Example:43
subtotal_price_setobject
商品折后价总和多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2Example:34
currency_code string币种Example:CNY
shop_moneyobject
店铺侧金额信息amount string金额,精度2Example:23
currency_code string币种Example:CNY
tags string订单标签Example:return
tax_linesobject[]
税费信息price string税费Example:34
price_setobject
税费多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2Example:45
currency_code string币种Example:CNY
shop_moneyobject
卖家侧金额信息amount string金额,精度2Example:56
currency_code string币种Example:CNY
rate double税率Example:9
title string税费名称Example:goods
tax_number string税号Example:12342421412
tax_type string税号类型Example:1
taxes_included boolean总计额是否包含税额token_infoobject
订单关联的购物车或结算页token信息cart_token string购物车tokenExample:423e23e2323e
checkout_token string结算页tokenExample:e3e232e32e
total_discounts string折扣总额,营销优惠+人工折扣Example:34
total_discounts_setobject
折扣总额多币种信息presentment_moneyobject
买家侧折扣信息amount string金额,精度2Example:45
currency_code string币种Example:CNY
shop_moneyobject
卖家侧折扣信息amount string金额,精度2Example:4353245
currency_code string币种Example:CNY
total_line_items_price string商品原价总和,精度2Example:3432532532
total_line_items_price_setobject
商品原价总和,多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2Example:44
currency_code string币种Example:CNY
shop_moneyobject
卖家侧金额信息amount string金额,精度2Example:12
currency_code string币种Example:CNY
total_outstanding string未付款金额总和,精度2Example:3422
total_shipping_price_setobject
订单运费总和,多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2Example:234
currency_code string币种Example:CNY
shop_moneyobject
卖家侧金额信息amount string金额,精度2Example:2342
currency_code string币种Example:CNY
total_tax string税费总和,精度2, 商品税 + 运费税Example:234
total_tax_setobject
税费总和,多币种信息presentment_moneyobject
买家侧金额信息amount string金额,精度2Example:67
currency_code string币种Example:CNY
shop_moneyobject
卖家侧金额信息amount string金额,精度2Example:75
currency_code string币种Example:CNY
total_tip_received string小费,精度2Example:234
total_weight double商品总重量(g)Example:45
updated_at string订单更新时间,(格式见IOS8601)Example:2012-05-01T14:22:25-04:00
user_id string买家idExample:2002697754
API Explorer
调试台
示例代码
这篇文章对你有帮助吗?
Error loading component.