查询草稿单

需要 read_draft_orders 权限点。
更多权限点使用信息,请参考:
GET https://{handle}.myshopline.com/admin/openapi/v20250601/orders/draft_orders.json
handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。
指定条件查询草稿单
查询参数
  • ids string
    草稿单号,多个以逗号分隔，最大支持100个
    Example: 2505749057828590456543, 2505749057828590456543
  • limit integer
    查询数量限制，默认50，不能超过1000
    Example: 10
  • page_info string
    加密后的请求参数，用于上一页、下一页，直接取该字段解析访问
    Example: {}
  • sort_condition string
    排序规则：如 create_at
    ,id
    ，先按create_at倒序，再按id正序
    Example: create_at:desc,id:asc
  • status string
    草稿单状态，open-处理中，completed-已完成
    Example: open
  • updated_at_max string
    草稿单更新时间（结束）（格式见IOS8601）
    Example: 2023-01-05T10:05:45+00:00
  • updated_at_min string
    草稿单更新时间（开始）（格式见IOS8601）
    Example: 2023-01-04T10:05:45+00:00
请求头
  • 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
响应体
  • draft_ordersobject[]
    草稿单列表信息
  • billing_addressobject
    支付账单地址
  • address1 string
    详细地址信息1，用作补充信息
    Example: 8899 Garfield Street
  • address2 string
    详细地址信息2，用作补充信息
    Example: Apartment 5
  • area string
    行政区名称
    Example: 东城区
  • area_code string
    行政区编码，自定义编号
    Example: 4200006
  • city string
    城市名称
    Example: Riverside
  • city_code string
    城市编码，自定义编号
    Example: 4200006
  • company string
    公司名称
    Example: SHOPLINE
  • country string
    国家或是地区名称
    Example: 美国
  • country_code string
    国家或是地区编码，两位的编码缩写（ISO-3166-1）
    Example: US
  • email string
    用户邮箱
    Example: test@shoplineapp.com
  • first_name string
    名
    Example: Tom
  • last_name string
    姓
    Example: Washington
  • phone string
    收货人联系方式
    Example: 13100000000
  • province string
    州或是省名称
    Example: 加利福尼亚州
  • province_code string
    州或是省编码，自定义编号
    Example: 4200006
  • same_as_receiver boolean
    是否与收货信息相同：true、false
    Example: true
  • street_name string
    街道名称
    Example: 大街
  • street_number string
    街道编码，自定义编号
    Example: 4200006
  • zip string
    收货地址邮政编号
    Example: 92503
  • companyobject
    公司信息
  • id string
    公司id
    Example: 1005619945158043247856
  • location_id string
    地点id
    Example: 3005619945158043247856
  • tax_registration_id string
    税号
    Example: 213213
  • create_by string
    创建人账号编码
    Example: 4201057379
  • create_time long
    创建时间，时间戳格式
    Example: 1667638652832
  • currency string
    店铺币种
    Example: USD
  • customerobject
    买家信息
  • area_code string
    联系方式 区号
    Example: 0000
  • email string
    用户邮箱
    Example: xxx@gmail.com
  • first_name string
    用户的名
    Example: Xiaoliu
  • id string
    用户id
    Example: 2200000611
  • last_name string
    用户的姓
    Example: Wang
  • phone string
    用户手机号
    Example: 1888888888888
  • discount_amount_ext string
    订单优惠金额
    Example: 2.00
  • discount_amount_ext_setobject
    订单优惠金额(多币种)
  • presentment_moneyobject
    买家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    卖家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • discountable boolean
    是否叠加营销优惠
    Example: true
  • id string
    草稿单号
    Example: 2505659131831930856670
  • invoice_url string
    invoice链接
    Example: https://xxxxx.myshopline.com/invoices/xxxx?secret=xxxx
  • line_itemsobject[]
    商品信息列表
  • applied_discountobject
    商品自定义折扣信息
  • amount string
    折扣金额，精度2的double类型的字符串，eg："12.41"
    Example: 1.00
  • amount_setobject
    折扣金额(多币种)
  • presentment_moneyobject
    买家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    卖家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • before_amount string
    商品售价，精度2的double类型的字符串，eg："12.41"
    Example: 3.00
  • before_amount_setobject
    商品售价(多币种)
  • presentment_moneyobject
    买家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    卖家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • description string
    折扣描述
    Example: 满两件减5元
  • title string
    折扣名称
    Example: 满减
  • value string
    折扣数额，折扣值，当折扣类型为DISCOUNT_AMOUNT_PERCENTAGE时，此值最大默认100，最小为0
    Example: 1.00
  • value_type string
    折扣类型：fixed_amount（固定金额）、percentage（百分比）
    Example: fixed_amount
  • gift_card boolean
    是否为礼品卡商品：true、false
    Example: true
  • id string
    商品行id, 唯一确认一个商品行
    Example: 100000000
  • image_url string
    图片信息
    Example: http://www.abc.com/123
  • price string
    商品参加自定义折扣后的金额
    Example: 2.00
  • price_setobject
    商品参加自定义折扣后的金额(多币种)
  • presentment_moneyobject
    买家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    卖家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • product_id string
    商品spu序列号
    Example: 16056577393789045351043258
  • product_source string
    商品来源 main_site主站商品、customize自定义商品
    Example: main_site
  • propertiesobject[]
    商品定制信息
  • name string
    value
    Example: value
  • show boolean
    是否要在前端展示
    Example: true
  • type string
    属性类型, text-字符，展示格式为 name: value; picture-图片，展示类型为 name: 通过urls获取渲染出缩略图；link-超链，展示类型为 name: value，支持点击链接跳转 到urls第一个
    Example: text-one
  • urls array
    属性类型, text-字符，展示格式为 name: value; picture-图片，展示类型为 name: 通过urls获取渲染出缩略图；link-超链，展示类型为 name: value，支持点击链接跳转 到urls第一个
    Example: https://image.baidu.com/search/detail?ct=503316480&z=0&ipn=d&word=%E5%9B%BE%E7%89%87&hs=0&pn=0&spn=0
  • value string
    自定义属性值
    Example: value
  • quantity integer
    订单中的商品数量
    Example: 1
  • requires_shipping boolean
    是否需要实物运输发货：true、false
    Example: true
  • tax_linesobject[]
    税费信息
  • name string
    税费名称
    Example: TAX
  • price string
    金额
    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
  • type string
    类型
    Example: shipping_tax
  • taxable boolean
    是否收税：true、false
    Example: true
  • title string
    商品标题
    Example: CustomProducts
  • variant_id string
    商品sku序列号
    Example: 18056577393793239655103258
  • variant_title string
    商品属性值
    Example: RED / L
  • logistics_amount string
    运费总金额
    Example: 2.00
  • logistics_amount_setobject
    运费总金额(多币种)
  • presentment_moneyobject
    买家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    卖家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • logistics_tax string
    运费总税费
    Example: 2.00
  • logistics_tax_setobject
    运费总税费(多币种)
  • presentment_moneyobject
    买家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    卖家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • market_name string
    市场名称
    Example: 美国市场
  • market_region_country_code string
    市场国家
    Example: US
  • note string
    草稿单备注
    Example: 客户想要尽快发货
  • note_attributesobject[]
    附加信息
  • name string
    名称
    Example: xxxx
  • value string
    值
    Example: 2
  • order_id string
    由当前草稿单生成的订单单号
    Example: 21056577640603870897253153
  • 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
  • pay_channel_deal_id string
    外部渠道支付流水号
    Example: 5341701129888599091
  • pay_status string
    支付单状态：未支付unpaid、已支付paid 草稿单生成订单后，该状态不会同步订单的支付状态
    Example: unpaid
  • payment_channel_name string
    支付渠道
    Example: 自定义付款--uploadfile
  • 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
  • po_number string
    B2B场景在订单上记录的采购订单号
  • presentment_currency_code string
    市场币种
    Example: USD
  • product_tax string
    商品总税费
    Example: 2.00
  • product_tax_setobject
    商品总税费(多币种)
  • presentment_moneyobject
    买家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    卖家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • shipping_addressobject
    收货地址信息
  • address1 string
    详细地址信息1，用作补充信息
    Example: 8899 Garfield Street
  • address2 string
    详细地址信息2，用作补充信息
    Example: Apartment 5
  • city string
    城市名称
    Example: Ashland
  • city_code string
    城市编码，自定义编号
    Example: Riverside
  • company string
    公司名称
    Example: 4200006
  • country string
    国家或是地区名称
    Example: 美国
  • country_code string
    国家或是地区编码，两位的编码缩写（ISO-3166-1）
    Example: US
  • delivery_store_code string
    门店编码，自定义编号
    Example: 4200006
  • delivery_store_name string
    门店名称
    Example: xxxx
  • district string
    行政区名称
    Example: xxx
  • district_code string
    行政区编码，自定义编号
    Example: 4200006
  • first_name string
    名
    Example: Tom
  • last_name string
    姓
    Example: Washington
  • name string
    全名
    Example: xxx
  • phone string
    联系电话
    Example: 13100000000
  • province string
    州或是省名称
    Example: 加利福尼亚州
  • province_code string
    州或是省编码，自定义编号
    Example: 4200006
  • street_name string
    街道名称
    Example: 大街
  • street_number string
    街道编码，自定义编号
    Example: 4200006
  • zip string
    收货地址邮政编号
    Example: 92503
  • shipping_linesobject
    订单物流信息
  • delivery_id string
    送货方式ID、运费模板ID
    Example: 109012039908
  • price string
    物流运费，精度2的double类型的字符串
    Example: 12.41
  • price_setobject
    物流运费(多币种)
  • presentment_moneyobject
    买家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    卖家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • shipping_type string
    物流类型 system-系统物流；custom-自定义物流
    Example: system
  • title string
    运费模板名称
    Example: 所有区域 10块
  • status string
    草稿单状态：open 、 complete
    Example: open
  • stock_reserved boolean
    订单维度库存预留标识：true、flase
    Example: true
  • stock_reserved_time long
    订单维度库存预预留时间
    Example: 1667638652832
  • tags array
    草稿单标签,多个标签间用逗号分隔，店铺维度最大支持99个标签
    Example: shine,bili
  • tax_linesobject[]
    税费信息
  • name string
    税费名称
    Example: TAX
  • price string
    金额
    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
  • type string
    类型
    Example: shipping_tax
  • total_duties_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
  • total_line_items_price string
    当前草稿单商品总金额
    Example: 2.00
  • total_line_items_price_setobject
    商品总金额（多币种）
  • presentment_moneyobject
    买家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    卖家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • total_price string
    当前草稿单总金额，商品售价-折扣+税费+运费
    Example: 2.00
  • total_price_setobject
    总金额（多币种）
  • presentment_moneyobject
    买家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • shop_moneyobject
    卖家侧金额
  • amount string
    金额
    Example: 2.00
  • currency_code string
    币种
    Example: USD
  • update_by string
    更新人账号编码
    Example: 4201057379
  • update_time long
    更新时间，时间戳格式
    Example: 1667638652832
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

— header required
— query
— query
— query
— query
— query
— query
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/orders/draft_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
SHOPLINE
SHOPLINE Enterprise
条款协议
隐私
条款
开发者协议
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.