查询订单
GET https://{handle}.myshopline.com/admin/openapi/v20260901/orders.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。可根据请求条件批量查询订单详细信息,比如根据订单创建时间或者更新时间来查询订单,同步订单数据,也可以指定订单 ID 查询单个订单信息。
查询参数
- location string订单中商品被履约的地点 ID(或是 POS 交易点 ID),支持入参多个地点 ID,用逗号隔开。例子:
5453386037065169090, 5564834083287605454 - since_id string要查询的数据的订单号 ID 的起始位置。例子:
21056199447626881527947685 - sort_condition string设置查询订单结果的排序规则。可按以下字段进行排序:
order_at(订单创建时间)或ID(订单编号)。每个字段可以指定为升序 (asc)或降序 (desc)。如有多个排序条件,请使用逗号隔开。例如,若将该字段设置为order_at:desc, id:asc,则订单结果将首先按照订单创建时间从新到旧的顺序排列,之后按照订单编号从小到大的顺序排列。例子:order_at:desc - buyer_id string下单用户 ID。例子:
4201057495 - created_at_max string指定要查询订单的截止日期和时间,在此时间或此时间之前创建的订单会被返回。格式:ISO 8601。例子:
2021-08-18T23:59:59+08:00 - hidden_order string是否查询已归档订单。
true:查询已归档订单false:查询未归档订单
默认值:false - name string订单编号(和订单 ID 不同,该编号可以在商家后台自定义前缀)。例子:
D2034 - search_content string搜索内容, 例如订单号、支付流水号、快递单号、商品名称、商品 SKU 货号或订单金额等。例子:
D203 - status string指定订单状态,订单状态包含:
open:处理中cancelled:已取消any:包含任何状态,包括已归档
- updated_at_min string指定截止日期和时间,在此时间或此时间之后更新的订单会被返回。格式:ISO 8601。例子:
2021-08-04T23:59:59+08:00 - financial_status string指定订单支付状态,有效枚举值包含:
unpaid:未支付authorized:已授权pending:支付中partially_paid:部分支付paid:已支付partially_refunded:部分退款refunded:已退款
- fulfillment_status string指定订单发货状态,有效枚举值包含:
unshipped:未发货partial:部分发货shipped:已发货
默认值:unshipped注意:传入枚举值的准确性会进行强校验,如果枚举值校验不通过,则订单查询会失败,会报错fulfillment status value is illegal。 - updated_at_max string指定截止日期和时间,在此时间或此时间之前更新的订单会被返回。格式:ISO 8601。例子:
2021-08-18T23:59:59+08:00 - created_at_min string指定要查询订单的截止日期和时间,在此时间或此时间之后创建的订单会被返回。格式:ISO 8601。例子:
2021-08-04T23:59:59+08:00 - email string下单用户的 email。例子:
Washingtontest@gmail.com - limit string查询数量限制,数量不能超过 100。默认值:
50 - page_info string分页查询的唯一标识,用于定位特定页面。该字段值需要在你已经查询完分页信息后,在该接口响应头中的
link字段值中获取。例如,你获取到的link的值为<https://{handle}.myshopline.com/admin/openapi/{version}/orders.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next",那么page_info的值为eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9。关于更多如何使用分页信息,请参考 分页机制。 - contract_ids string订阅合同 ID,多个以逗号分隔。最多支持 50 个 ID。例子:
3005619945158043247856 - fields string指定查询的字段,用逗号分隔,不传则返回所有的字段信息。例子:
id,email,note - ids string订单号,多个以逗号分隔。最多支持 100 个订单号。例子:
21050224312121887324667162, 21050224312121887324667164
请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - Authorization string required资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。例子:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
状态码
- 200
- 401
- 429
更多状态码信息,参考 HTTP 状态码。
响应头
link
提供分页数据的 URL 链接。你可以获取该字段值中的page_info信息用于下一次分页请求中。当你请求的页面存在上一页或下一页的时候,该字段会被返回。关于更多如何使用分页信息,请参考 分页机制。traceId
请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
ordersobject[]
订单数据列表。adjust_price stringPOS 交易场景下因金额四舍五入带来的差额金额,用店铺币种。例子:8.00adjust_price_setobject
POS 交易场景下因金额四舍五入带来的差额金额,分别以买家币种和卖家币种展示。billing_addressobject
用于邮寄账单发票的地址。address1 string账单地址的第一行。通常是街道地址或邮政信箱编号等信息。例子:Address 1address2 string账单地址的第二行。通常是公寓、套房或单元等信息。例子:Address 2city string账单地址中的城市。例子:New Yorkcompany string账单收件人所在的公司名称。例子:New company namecountry string账单地址中的国家或区域。例子:USAfirst_name string账单收件人的名。例子:Tomlast_name string账单收件人的姓。例子:Washingtonname string账单收件人的全名。例子:test1001phone string账单收件人的手机号码。例子:13100000000province string账单地址中的省份。例子:Californiastandard_province_code string账单地址中省份的编码,该编码为二位的 ISO 3166-2 国际编码,区别于province_code返参为自定义编码。zip string账单地址的邮编信息。例子:92503browser_ip string买家下单时的浏览器 IP 地址。例子:157.119.232.35buyer_note string买家留言。例子:messagecancel_reason string卖家取消原因。例子:I don't want to buy it.cart_token string购物车数据的唯一标识。例子:c2c4a58186b9d96395d7e6b5c2969577checkout_id string弃单 ID。例子:2404785166526352972864checkout_token string弃单数据的唯一标识,C 端用户发起结算,会生成弃单 。例子:c2c4a58186b9d96395d7e6b5c2969577client_detailsobject
客户端详细信息。browser_ip string买家下单时的浏览器 IP 地址。例子:157.119.232.35session_hash string会员会话加密信息。例子:c2c4a58186b9d96395d7e6b5c2969577user_agent string客户端代理。例子:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Sacompanyobject
买家下单时买家所在的公司信息。id string公司 ID。例子:1005619945158043247856location_id string地点 ID。例子:3005619945158043247856tax_registration_id string税号信息。例子:213213contract_seq string订阅合同号。例子:3005619945158043247856credit_limitobject
信用支付信息。is_credit_limit boolean订单是否使用了信用支付。true:有使用false:未使用
outstanding_credit_limit string占用的信用额度总和。初始和total_credit_limit相等,如果后续有类似还款操作,占用的额度则相应减少。例子:1.00total_credit_limit string使用的信用额度总和,即该笔订单用了多少信用额度支付。例子:1.00current_subtotal_price string商品金额总和,为商品单价 * 数量,以店铺币种展示。例子:78.0current_subtotal_price_setobject
商品金额总和,为商品单价 * 数量,分别以买家币种和店铺币种展示。current_total_discounts string折扣金额总和,数值保留到小数点后两位,为营销优惠 + 人工折扣,以店铺币种展示。例子:1.00current_total_discounts_setobject
折扣金额总和,数值保留到小数点后两位,为营销优惠 + 人工折扣,分别以买家币种金额和店铺币种金额展示。current_total_duties_setobject
商品总关税,分别以买家币种金额和店铺币种金额展示。current_total_price string订单总额,以店铺币种金额展示。例子:60.0current_total_price_setobject
订单总额,分别以买家币种金额和店铺币种金额展示。current_total_tax string税费金额总和,以店铺币种金额展示。例子:1.00customerobject
买家信息。addressesobject
买家地址信息。address1 string买家地址的第一行。通常是街道地址或邮政信箱编号等信息。例子:Wandaaddress2 string买家地址的第二行。通常是公寓、套房或单元等信息。例子:65788city string买家地址中的城市。例子:Yangquan Citycountry string买家地址中的国家或区域。例子:Chinafirst_name string买家地址中收件人的名。例子:Tomlast_name string买家地址中收件人的姓。例子:Washingtonname string买家地址中收件人的全名。例子:D203phone string买家地址中收件人手机号。例子:13100000000province string买家地址中的省份。例子:Shanxi Provincezip string买家地址的邮编信息。例子:521000area_code string国家或地区的手机区号。例子:+86email string买家的邮箱地址。例子:Washingtontest@gmail.comfirst_name string买家的名。例子:Tomid string买家 ID。例子:4201057495last_name string买家的姓。例子:Washingtonphone string买家的手机号。例子:13100000000deduct_member_point_amount string当前订单会员积分抵扣金额,以店铺币种展示。数值保留到小数点后两位。例子:8.00deduct_member_point_amount_setobject
当前订单会员积分抵扣金额,分别以买家币种金额和店铺币种金额展示。discount_applicationsobject[]
折扣信息列表。activity_type integer商品行享受的活动类型:0:满减满折、免邮1:限时促销2:捆绑组合3:优惠码4:一页商店5:赠品活动6:预售7:加购品8:礼品盒9:商品追售活动
allocation_method string折扣的范围。有效枚举值包含:across:按照购买总数折扣each:按照单个商品分别折扣
示例:如一次购买三个相同的商品,折扣为 10 元。如果allocation_method为across代表三个一起减 10 元;如果allocation_method为each代表每个减 10 元。benefit_type integer商品行享受的优惠类型:-1:无优惠1:减金额2:打折3:免运费4:加价品5:任意N件优惠价6:A+B组合优惠价7:赠品8:固定售价9:最低价商品免费11:第N件打折12:买x送y13:自定义14:N件M元
code string折扣码。例子:82UD6BTPX9L2description string自定义折扣的描述。例子:Custom discount descriptiontarget_selection string折扣分配商品行方式。有效枚举值包含:explicit:折扣分配到明确选择的商品行all:折扣分配到所有商品行entitled:折扣仅分配到其有权使用的商品行
target_type string折扣应用的对象。有效枚举值包含:line_item:作用在商品上的折扣shipping_line:作用在运费上的折扣
title string自动折扣的标题。例子:Automatic discount titletype string折扣类型。有效枚举值包含:manual:手动折扣automatic:自动折扣discount_code:折扣码
value string折扣的具体值,以店铺币种展示。- 当
value_type为fix_amount时,此字段值表示特定的折扣金额。例如,如果值为10,商店币种为人民币,则表示折扣为 10 元。 - 当
value_type为percentage时,此字段值的值表示特定的折扣百分比。例如,10表示订单金额的 10% 折扣。
例子:2.01value_type string折扣值的类型。有效枚举值包含:fix_amount:固定金额折扣。例如,如果value为10,则意味着折扣为 10 元。percentage:百分比折扣。例如,如果value为10,则表示订单金额的 10% 折扣。
discount_codesobject[]
优惠码信息列表。amount string优惠金额,以店铺币种展示,数值保留到小数点后两位。例子:8.00code string优惠码。例子:KIN4GNAB2FRHtype string优惠类型。有效枚举值包含:减金额:全场满 100 元立减 10 元打折:全场满 100 元打 9 折免运费:满 3 件免运费加价品:需要支付额外金额任意N件优惠价:任意买 3 件商品,只需 99 元A+B组合优惠价:同时买 A 商品和 B 商品,两件一起只需 88 元赠品:购买制定商品赠送额外商品固定售价:统一售价 29 元最低价商品免费:买 3 件商品,最便宜的那件免费打包价:多件商品组合以固定总价出售第N件打折:第 2 件打 8 折买x送y:满 2 件送 1 件自定义:自定义折扣
废弃:该字段自 API 版本 v20241201 起已废弃。email string买家邮箱。例子:hok@shoplineapp.comfinancial_status string订单付款状态。有效枚举值包含:unpaid:未支付authorized:已授权pending:处理中partially_paid:部分付款paid:已付款partially_refunded:部分退款refunded:已退款
fulfillment_status string发货状态。有效枚举值包含:fulfilled:已发货partial:部分发货null:未发货
fulfillmentsobject[]
发货单信息列表。id string发货单 ID。例子:22046737798141702810214336line_itemsobject[]
商品列表。attribute string款式规格信息,以款式名称和规格值拼接展示。例子:color - redbundle_parent_variant_id string套装子商品关联的父商品变体ID。fulfillable_quantity integer商品剩余可发货数量。例子:1fulfillment_quantity integer已发货数量。例子:1fulfillment_service string物流商名称。例子:SF Expressfulfillment_status string商品发货状态。有效枚举值包含:fulfilled:已发货partial:部分发货null:未发货
grams double重量,单位:g。例子:100id string商品快照表的 ID,系统生成,与订单号order.id唯一确认一个商品。例子:100image_url string商品图片的 URL 地址。例子:https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969is_bundle boolean是否为套装商品:true:套装商品 false:非套装商品is_bundle_component boolean是否为套装子商品:true:子商品 false:非子商品location_id string取货地点唯一编号。例子:5445886274929439997name stringSKU 标题,该字段值和title一致。例子:Product nameprice string商品售价,以店铺币种展示。 数值保留到小数点后两位。例子:10.00product_id string款式对应商品的唯一标识 ID。例子:16056761559984840457934011quantity integer订单中的商品数量。例子:1requires_shipping boolean商品是否需要发货。true:需要发货false:不需要发货
sku string商品 SKU 序列号。例子:test-002tax_linesobject[]
税费明细列表。price string税费,以店铺币种展示。数值保留到小数点后两位。例子:8.00rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。例子:taxestaxable boolean该商品是否需要收税。true:需要收税false:不需要收税
title string商品标题。例子:Useful productvariant_id string分配给库存中某一特定商品的唯一编码。例子:18056761559987524812644011variant_title string商品款式值,多个以/分割。例子:big/redvendor string供应商。例子:Suppliername string发货单编码。例子:1032-F2order_id string订单号。例子:21056577640603870897253153shipment_status string物流状态。有效枚举值包含:out_for_delivery:正在配送delivered:已送达faliure:配送失败picked_up:已取货
status string物流配送状态。有效枚举值包含:success:已发货cancelled:已取消
tracking_company string物流公司名称。例子:SF Internationaltracking_info_listobject[]
物流追踪信息列表,若指定该入参,则单个入参的tracking_url、tracking_number、tracking_company被拦截。最多传入 10 个追踪信息。tracking_company string物流服务商。tracking_number string物流单号。tracking_url string追踪链接。tracking_number string第三方物流单号。例子:yun0001tracking_url string物流公司的域名。例子:https://www.sf-international.com/hidden_order boolean订单是否为已归档订单。true:已归档订单false:未归档订单
id string订单号,系统自定义编号。例子:21050224312121887324667162landing_site string记录完整的订单归因落地页的链接。例子:https://www.url.comline_itemsobject[]
订单商品快照信息列表。attribute string款式规格信息,以款式名称和规格值拼接展示。例子:color - redbundle_parent_variant_id string套装子商品关联的父商品变体ID。customized_attributesobject[]
商品自定义的属性。key string自定义属性名称。由外部传入,但只有key为businessType时,value为下单时系统主动生成,值为3。value string商品自定义属性值,当key为businessType时,只透出值为3(表示赠品)。discount_allocationsobject[]
营销折扣金额,分别以买家币种金额和店铺币种金额展示。amount string营销折扣金额,数值保留到小数点后两位。例子:8.00discount_application_index integer标明商品行应用的折扣在orders.discount_applications中的位置。例子:1dutiesobject[]
关税信息。harmonized_system_code string海关编码,用于在国际贸易中对产品进行分类。例子:A0023id string关税编号。例子:H2325tax_linesobject[]
税费信息列表。rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。rate_percentage double税率,以百分比数值形式表示,数值保留到小数点后两位。如果税率为2%,该值为2.00。该信息只做展示作用。title string税费标题,该信息只做展示作用。例子:Tax titlefulfillable_quantity integer剩余可发货数量。例子:1fulfillment_service string物流商名称。例子:SF Internationalfulfillment_status string商品发货状态。有效枚举值包含:fulfilled:已发货partial:部分发货null:未发货
gift_card boolean是否为礼品卡商品。true:是礼品卡商品false:不是礼品卡商品
grams double重量,单位:g。例子:100harmonized_system_code string海关编码,用于在国际贸易中对产品进行分类。例子:harmonized system codeid string商品快照表的 ID,系统生成,与订单号order.id唯一确认一个商品。例子:417image_url string商品图片的 URL 地址。例子:https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969is_bundle boolean是否为套装商品:true:套装商品 false:非套装商品is_bundle_component boolean是否为套装子商品:true:子商品 false:非子商品location_id string本地配送地点编号或普通配送地点编号。例子:5327026538935748524name stringSKU 标题,该字段值和title一致。例子:Product titleprice string商品售价,以店铺币种金额展示,数值保留到小数点后两位。例子:8.00product_id string款式对应商品的唯一标识 ID。例子:16056761559984840457934011propertiesobject[]
商品定制信息列表。additional string定制商品附加字段,比如当name为文字,additional可以附加文字的字号、字体、颜色等。例子:Additional fieldsname string自定义属性名称。例子:Attribute namerole_visibility string定制信息可见对象:customer: 仅对买家可见merchant: 仅对商家可见all:同时对买家和商家可见none: 同时对买家和商家不可见
show boolean定制信息是否可见type string定制信息类型。有效枚举值包含:text:字符类型picture:图片类型link:链接类型
urls arrayURL 资源列表。- 如果
type是picture,可通过urls获取渲染出缩略图。 - 如果
type是link,那么超链接为urls的第一个。
例子:["[\"https://www.url.com\"]"]value string自定义属性值。例子:attribute valuequantity integer订单中的商品数量。例子:1requires_shipping boolean商品是否需要发货。true:需要发货false:不需要发货
sku string商品 SKU 序列号。例子:18056761559987524812644011tags string商品标签,多个以逗号隔开。例子:watchtax_linesobject[]
税费明细列表。price string税费,以店铺币种展示。数值保留到小数点后两位。例子:8.00rate double税率,以小数形式表示,数值保留到小数点后四 位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。例子:taxestype string税费用类型,用于区分是商品税还是运费税。product_tax:商品税shipping_tax:运费税
taxable boolean该商品是否需要收税。true:需要收税false:不需要收税
title string商品标题。例子:beautiful skirtvariant_id string分配给库存中某一特定商品的唯一编码。例子:18056761559987524812644011variant_title string商品属性值,多个以/分割。例子:bigvendor string供应商。例子:Supplierlocationsobject[]
到店取货地点地址信息列表。address string地址的第一行。通常包含街道地址或邮政信箱编号等信息。例子:Address 1address_add string地址的第二行。通常是公寓、套房或单元等信息。例子:Address 22city string地址中的城市。例子:Guangzhoucountry string地址中的国家或区域。例子:Chinadistrict string地址中的区或县。例子:Panyu Districtlocation_id string取货地点唯一编号。例子:5327026538935748524name string取货地址名称。例子:Wanda squarephone string电话号码。例子:13100000000province string地址中的省份。例子:Guangdong Provincetown string地址中的乡或镇。例子:towntype string地点类型。有效枚举值包含:posLocation:POS 渠道创建该订单的门店地点。建议使用posLocationId,因为posLocation后续将废弃。pickupLocation:当订单的配送方式为自提时,自提的门店地点。productLocation:订单中商品的库存地点。建议使用商品行中的location信息,因为productLocation后续将废弃。
zip string地址的邮编信息。例子:521000name string商家自定义的订单号,从 1001 开始,可以设置前缀。例子:test1001note string商家备注内容。例子:Notesnote_attributesobject[]
商家备注日志。name string卖家标识,表明备注来源。例子:Note sourcevalue string备注内容。例子:Notesorder_source string订单来源渠道的 handle。handle 为语义化标识符。order_status_url string订单状态页 URL。例子:https://shoptest.myshoplinestg.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509payment_detailsobject[]
支付单信息列表。gateway string支付方式名称。例子:Mypaygiftcard_presentment_moneyobject
展示给买家的礼品卡金额。amount string礼品卡金额,数值保留到小数点后两位。currency_code string三位币种码,遵循 ISO 4217 国际标准。pay_amount double支付金额,以店铺币种金额展示。数值保留到小数点后两位。例子:8pay_channel string支付渠道。例子:Paypalpay_channel_deal_id string外部渠道支付流水号。例子:pi_3MI897Hezv8FxjBO1uGxMPhXpay_merchant_email string支付商户 email 账户。例子:Washingtontest@gmail.compay_merchant_id string支付商户 ID。例子:4201057379pay_merchant_order_id string支付商户订单号。例子:233445354566pay_seq string支付单号。例子:23057287797738260472676128pay_status string支付单状态。有效枚举值包含:unpaid:未支付pending:支付中risking:风控中paid:已支付paid_overtime:支付超时paid_failed:支付失败
payment_method string支付方式settle_pay_amount double支付金额,以结算币种展示。数值保留到小数点后两位。例子:8status_code string支付网关标准状态码。例子:RISK_PENDINGstatus_msg string支付网关状态码信息。例子:PENDING_REVIEWpayment_gateway_names array付款方式列表。有效枚举值包含:SLpaymentsPaypal(PayPal支付)Oceanpay(钱海支付)TwoCheckoutAsiaBillStripePacypayWorldPayCOD(货到付款)CUSTOM(自定义)adjustPay(资金调整)Xendit(xendit 信用卡)XenditOther
例子:["SLpayments"]payment_termsobject
支付条款。due_in_days integer多少天后未付款则到期,当payment_terms_type为NET时提供。例子:2id string唯一识别该支付条款的 ID。例子:6497210673894431747overdue boolean支付是否逾期。true:已逾期false:未逾期
payment_schedulesobject[]
与付款条件相关联的一组时间表。issued_at string付款起始的时间。当payment_terms_type为FIXED或NET时,issue_at表示草稿单或订单保存时间。若草稿单成单,则订单继承草稿单的保存时间。当payment_terms_type为FULFILLMENT或RECEIPT时,为付款起始的时间。格式: ISO 8601。例子:2024-06-05 08:00:00payment_terms_name string用于创建付款条件的付款条件模板的名称。例子:Due on receiptpayment_terms_type string用于创建付款条件的模板名称。有效枚举值包含:FIXED:商家指定日期FULFILLMENT:完成发货日期NET:固定条件日期RECEIPT:发送账单日期UNKNOWN:未知类型
phone string买家的手机号。例子:18978789878po_number stringB2B 场景在订单上记录的采购订单号。pos_location_id stringPOS 交易地点 ID。例子:5327026538935748524processed_user_id string订单创建者的 ID。例子:4201057495referring_site string归因 URL,用于记录买家如何被重定向到在线商店。例子:https://www.referringSite.comrefundsobject[]
退款列表。id string退款 ID。例子:2605659027312156877634note string卖家退款备注。例子:Refund notesorder_adjustmentsobject[]
调整单信息,用于记录两类信息:- 与运费相关的退款信息,调整单类型
kind为shipping_refund。 - 自动计算的退款金额与实际退款金额的差值,调整单类型
kind为refund_discrepancy。
amount string调整单金额,数值保留到小数点后两位。例子:8.00id string调整单 ID。例子:RAP5570565996182771228kind string调整单类型。有效枚举值包含:refund_discrepancy:运费金额调整shipping_refund:支付单金额调整
order_id string订单号。例子:21056577640603870897253153reason string调整原因。例子:Refund discrepancyrefund_id string退款单 ID。例子:2605659027312156877634tax_amount string调整单税费金额,以店铺币种展示。数值保留到小数点后两位。例子:8.00order_id string订单号。例子:21056577640603870897253153refund_line_itemsobject[]
商品行退款详情列表。id string退款单号。例子:2605659027312156877634line_itemobject
发货单商 品行信息。attribute string款式规格信息,以规格名称和规格值拼接展示。例子:color - redfulfillable_quantity integer剩余可发货数量。例子:1fulfillment_service string物流商名称。例子:SF Internationalfulfillment_status string商品发货状态。有效枚举值包含:fulfilled:已发货partial:部分发货null:未发货
grams double重量,单位:g。例子:1id string商品快照表的 ID,系统生成,与订单号order.id唯一确认一个商品。例子:403name stringSKU 标题,该字段值和title一致。例子:18056761559987524812644011price string商品售价,以店铺币种展示。数值保留到小数点后两位。例子:8.00product_id string款式对应商品的唯一标识 ID。例子:16056761559984840457934011quantity integer订单中的商品数量。例子:1requires_shipping boolean商品是否需要发货。true:需要发货false:不需要发货
sku string商品 SKU 序列号。例子:sku nametax_linesobject[]
税费明细列表。price string税费,以店铺币种展示。数值保留到小数点后两位。例子:8.00rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。例子:Headlinetaxable boolean该商品是否需要收税。true:需要收税false:不需要收税
title string商品标题。例子:Product titlevariant_id string分配给库存中某一特定商品的唯一编码。例子:18056761559987524812644011variant_title string商品属性值,多个以/分割。例子:big/redvendor string供应商。例子:Supplierline_item_id string商品快照表的 ID,系统生成,与订单号order.id唯一确认一个商品。例子:406quantity integer退款商品数量。例子:1restock_type string库存返还类型。有效枚举值包含:no_restock:未返还cancel:取消return:返还
subtotal double退款金额合计,以店铺币种金额展示。数值保留到小数点后两位。例子:8total_tax double退款商品的税额,以店铺币种展示。数值保留到小数点后两位。例子:8transactionsobject[]
退款交易信息列表。amount string退款金额,数值保留到小数点后两位。例子:8.00channel_refund_id string渠道退款单号,暂时支持SHOPLINE Payment支付渠道gateway string支付渠道代码例子:Mypayid string退款 ID。例子:2605659027312156877634kind string交易类型,返回值为refund。例子:refundorder_id string订单号。例子:21056577640603870897253153settle_amount string退款金额 (结算币种)。数值保留到小数点后两位。例子:8.00status string处理状态。有效枚举值包含:pending:退款中failure:退款失败success:退款成功error:退款出错
status_update_at string退款单状态变更时间。user_id string买家 ID。例子:4201057495user_id string买家 ID。例子:4201057495service string运输方式类型。有效枚举值包含:Pickup:到店取货null:其他运输方式
shipping_addressobject
收货地址。address1 string地址的第一行。通常是街道地址或邮政信箱编号等信息。例子:Address 1address2 string地址的第二行。通常是公寓、套房或单元等信息。例子:Address 2city string地址中的城市。例子:Citycompany string收件人所在的公司名称。例子:Company Namecountry string地址中的国家或区域。例子:Chinadelivery_store_code string台湾店配配送方式的门店编码。例子:1001delivery_store_name string台湾店配配送方式的门店名称。例子:Store namedistrict string地址中的区。例子:Panyu Districtdistrict_code string地址中的区编码。例子:521000first_name string收件人的名。例子:Tomlast_name string收件人的姓。例子:Washingtonlatitude string地址所在的纬度。例子:15longitude string地址所在的经度。例子:41name string收件人的全名。例子:Tom.Washingtonphone string收件人的手机号码。例子:13100000000province string地址中的省份。例子:Guangdong Provincestandard_province_code string地址中省份的编码,该编码为二位的 ISO 3166-2 国际编码,区别于province_code返参为自定义编码。zip string地址的邮编信息。例子:521000shipping_linesobject[]
运费列表。code string只有本地配送运费方案有值,返回Local delivery。例子:Local deliverydiscount_allocationsobject[]
折扣明细列表。amount string折扣金额,以店铺币种展示。数值保留到小数点后两位。例子:8.00discount_application_index integer标明商品行应用的折扣在orders.discount_applications中的位置。例子:1discounted_price string折扣金额,以店铺币种展示。数值保留到小数点后两位。例子:8.00phone string买家的手机号。例子:13100000000price string运费,以店铺币种展示。数值保留到小数点后两位。例子:8.00requested_fulfillment_service_id string运输服务代号。shipping_price string原运费金额值,非折扣后金额,以店铺币种展示。数值保留到小数点后两位。例子:8.00shipping_strategy_name string运输策略名称,当发货方式为SHIPPING或LOCAL_DELIVERY,才有对应的值。source string物流承运商类型。有效枚举值包含:Shipper:Shipper 物流Oneship:Oneship 物流Api:通过开放能力添加的承运商的物流null:系统物流或自定义物流
tax_linesobject[]
税费信息列表。price string税费,以店铺币种展示。数值保留到小数点后两位。例子:8.00rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。例子:Tax nametitle string物流公司名称。例子:SF Internationalsource_identifier string客户点击链接访问商店时的营销推荐代码。支持以下 URL 参数:ref、resource或r。例如,如果 URL 是myshopline.com/products/slide?ref=22dd9dctg则该值为22dd9dctg。source_name string表示查询订单的行为是由哪个应用触发的。有效枚举值包含:sales_plugin_of:行为来自营销系统的分销插件member_plugin_referral:行为来自会员系统的推荐插件
source_url string归因 URL,用于记录买家如何被重定向到在线商店。status string订单状态。有效枚举值包含:open:订单处理中cancelled:订单已取消
store_id string店铺 ID。例子:1644828244663subtotal_price string商品折后价总和,为商品总价 - 营销优惠 - 自定义折扣,以店铺币种展示。例子:8.00tags string订单标签。例子:Labeltax_description string税费说明。tax_linesobject[]
税费明细列表。name string税费名称。例子:Tax nameprice string税费,以店铺币种展示。数值保留到小数点后两位。例子:8.00rate double税率,以小数形式表示,数值保留到小数点后四位。如果税率为2%,该值为0.0200。该信息只做展示作用。title string税费说明标题。该信息只做展示作用。例子:Tax nametax_number string税号。tax_type string订单的税费类型。有效枚举值包含:product_tax:商品税shipping_tax:运费税
taxes_included boolean该订单是否包含税费金额。true:包含税费金额false:不包含税费金额
total_discounts string订单折扣总和,为营销折扣 + 自定义折扣,数值保留到小数点后两位,以店铺币种金额展示。废弃:该字段自 API 版本 v20210901 起已废弃。例子:3.25total_discounts_setobject
订单折扣总和,为营销折扣 + 自定义折扣,分别以店铺币种金额和买家币种金额展示。废弃:该字段自 API 版本 v20210901 起已废弃。total_line_items_price string商品原价总和,数值保留到小数点后两位,以店铺币种金额展示。例子:8.00total_line_items_price_setobject
商品原价总和,分别以买家币种金额和店铺币种金额展示。total_outstanding string未付款金额总额,数值保留到小数点后两位,以店铺币种金额展示。例子:8.00total_tax string税费总额,数值保留到小数点后两位,以店铺币种金额展示。例子:8.00total_tip_received string小费,数值保留到小数点后两位,以店铺币种金额展示。例子:8.00total_weight double商品总重量,单位:g。例子:1user_id string买家 ID。例子:4201057495utm_parameters string广告业务专用的参数,用于广告的归因计算。
API Explorer
调试台
示例代码
这篇文章对你有帮助吗?