创建草稿单
POST https://{handle}.myshopline.com/admin/openapi/v20260301/orders/draft_orders.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handle 是 open001 。为用户创建一个草稿单。
请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - Authorization string required资源的访问令牌。参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入。例子:
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
请求体
draft_orderobject
草稿单对象。billing_addressobject
用于邮寄账单发票的地址。address1 string账单地址的第一行。通常是街道地址或邮政信箱编号等信息。最大长度限制:256address2 string账单地址的第二行。通常是公寓、套房或单元等信息。最大长度限制:256area string账单地址中的区或县。最大长度限制:64area_code string账单地址中区或县的编码。例子:510007city string账单地址中的城市。最大长度限制:64city_code string账单地址中城市的编码。例子:510000company string账单收件人的公司名称。最大长度限制:64country string账单地址的国家或地区。最大长度限制:64email string账单收件人的邮箱。first_name string账单收件人的名。最大长度限制:64last_name string账单收件人的姓。最大长度限制:64phone string账单收件人的手机号码。postcode string账单地址中的邮编信息。province string账单地址中的省份。same_as_receiver boolean表示账单地址billing_address是否与收货地址shipping_address是一样的。true: 相同false: 不同
默认值:truecalc_sku_stock_mode string required用于标识库存模式,有效枚举值包含:not_limit: 无限库存real: 真实库存reserve_real: 预留库存与真实库存
例子:stringcustomerobject
买家信息。area_code string手机区号。例子:+1email string买家的邮箱地址。first_name string买家的名。最大长度限制:64id string required买家 ID。例子:stringlast_name string买家的姓。最大长度限制:64phone string买家的手机号。最大长度限制:32discount_amount_ext string订单折扣金额。数值保留到小数点后两位。discount_amount_ext_name string订单折扣说明。最大长度限制:64discountable booleanDeprecated该字段自 API 版本 v20251201 起已废弃。language_infoobject required
语种信息。customer_language string买家侧下单语种,优先使用此语种。例子:enmerchant_language string卖家侧下单语种,优先使用买家侧语种。例子:enline_itemsobject[] required
商品信息列表。applied_discountobject
商品折扣信息。description string折扣说明。title stringDeprecated该字段自 API 版本 v20251201 起已废弃。value long required折扣数额。当value_type为percentage时,此值最大默认100,最小为0。value_type string required折扣类型。有效枚举值包含fix_amount:固定金额percentage:百分比
例子:stringdiscountable booleanDeprecated该字段自 API 版本 v20251201 起已废弃。gift_card booleanDeprecated该字段自 API 版本 v20251201 起已废弃。price string商品售价。product_id string required款式对应的商品的唯一标识 ID。例子:16056761559984840457934011product_source string required商品来源。有效枚举值包含:main_site: 在线商店的商品customize: 自定义商品
例子:stringpropertiesobject[]
商品定制信息。name string自定义属性名称。show boolean定制信息是否可见。有效枚举值包含:true: 可见false: 不可见
type string定制信息类型。有效枚举值包含:text:字符类型picture:图片类型link:链接类型
urls arrayURL 列表。- 如果
type是picture,可通过urls获取缩略图。 - 如果
type是link,那么超链接为urls的第一个。
value string自定义属性值。quantity integer required草稿单中的商品数量。取值范围:1-99999requires_shipping boolean商品是否需要发货。true: 需要发货false: 不需要发货
默认值:falsesku string商家定义的商品货号。最大长度限制:255taxable boolean商品是否需要收税。true: 需要收税false: 不需要收税
默认值:truetitle string商品标题。variant_id string required款式的唯一标识 ID。例子:18056761559987524812644011note string草稿单备注。最大长度限制:1024note_attributesobject[]
草稿单附加信息。name string附加属性的名称。value string附加属性的值。outer_id string客户端生成的唯一请求 ID,相同 ID 的请求只会被处理一次。payment_termsobject
付款信息。pay_channel_id string required支付方式的唯一标识符 ID。例子:stringpay_status string付款状态。有效枚举值包含:unpaid: 未支付paid: 已支付
默认:unpaidpayment_channel_name string支付渠道名称。shipping_addressobject
收件人的收货地址信息。address1 string收货地址的第一行。通常是街道地址或邮政信箱编号等信息。最大长度限制:256address2 string收货地址的第二行。通常是公寓、套房或单元等信息。最大长度限制:256city string收货地址中的城市。最大长度限制:64city_code string收货地址中城市的编码。例子:510000company string收件人的公司名称。country string收货地址的国家或地区。最大长度限制:64district string收货地址中的区或县。最大长度限制:64district_code string收货地址中区或县的编码。例子:510007first_name string收件人的名。last_name string收件人的姓。phone string收件人的手机号码。province string收货地址中的省份。zip string收货地址中的邮编信息。例子:510036shipping_linesobject
物流信息。当shipping_type为system时,须传入delivery_id。
当shipping_type为custom时,须传入title和price。
当期望免运费时,shipping_type须传custom, 同时必须传入title和price,且price值须设置为0。delivery_id string运费模板 ID。price string自定义运费金额,数值保留到小数点后两位。shipping_type string required物流类型。有效枚举值包含:system: 系统物流custom:自定义物流
例子:stringtitle string物流承运商名称。stock_reserved boolean required订单维度是否有保留商品标识。true: 有保留商品标识false: 无保留商品标识
stock_reserved_time long订单维度保留商品时间,格式为 13 位毫秒级时间戳。例子:1667638652832tags array订单标签列表,多个用英文逗号分隔。 最大个数限制:99tax_exempt boolean该商品是否需要收税。true: 需要收税false: 不需要收税
状态码
- 200
- 401
- 429
更多状态码信息,参考 HTTP 状态码。
响应头
traceId
请求的全局唯一标识符。用于追踪请求在系统中的流转,以便于问题发生时进行定位和调试。
响应体
draft_orderobject
草稿单对象。billing_addressobject
用于邮寄账单发票的地址。address1 string账单地址的第一行。通常是街道地址或邮政信箱编号等信息。例子:8899 Garfield Streetaddress2 string账单地址的第二行。通常是公寓、套房或单元等信息。例子:Apartment 5area string账单地址中的区或 县。例子:Panyu Districtarea_code string账单地址中区或县的编码。例子:510007city string账单地址中的城市。例子:Guangzhou Citycity_code string账单地址中城市的编码。例子:510000company string账单收件人的公司名称。例子:Company Namecountry string账单地址的国家或地区。例子:United Statesemail string账单收件人的邮箱。例子:test001@Gmail.comfirst_name string账单收件人的名。例子:Tomlast_name string账单收件人的姓。例子:Washingtonphone string账单收件人的手机号码。例子:13903004000province string账单地址中的省份。例子:New York Stateprovince_code string地址中省份的编码,该编码是系统自定义编号。例子:4220006same_as_receiver boolean表示账单地址billing_address是否与收货地址shipping_address是一样的。true: 相同false: 不同
zip string收货地址的邮政编号。create_at long草稿单的创建时间,格式为 13 位毫秒级时间戳。例子:1667638652832customerobject
买家信息。area_code string手机区号。例子:+1email string买家的邮箱地址。例子:test001@Gmail.comfirst_name string买家的名。例子:Tomid string买家ID。例子:4201057495last_name string买家的姓。例子:Washingtonphone string买家的手机号。例子:13903004000discount_amount_ext string订单折扣金额。数值保留到小数点后两位。例子:8.00discount_amount_ext_name string订单折扣名称。id string草稿单的唯一标识符 ID。invoice_url string草稿单账单链接。例子:https://xxx.com/xxxxline_itemsobject[]
商品信息列表。applied_discountobject
商品自定义折扣信息。amount string应用折扣后的金额。例子:8.00before_amount string商品售价。例子:8.00description string折扣说明。title stringDeprecated该字段自 API 版本 v20251201 起已废弃。value long折扣数额。当折扣类型为percentage时,此值最大默认100,最小为0。value_type string折扣类型。fixed_amount: 固定金额percentage: 百分比
gift_card boolean是否为礼品卡商品。true: 是false: 不是
id string商品行 ID,唯一确认一个商品行。image_url string商品图片 URL。例子:https://xxx.com/xxxxname string商品的 SKU 标题。price string商品参加自定义折扣后的金额。数值保留到小数点后两位。例子:2.00product_id string商品的唯一标识符 ID。例子:16056577393789045351043258product_source string商品来源。有效枚举值包含:main_site: 在线商店的商品customize: 自定义商品。
propertiesobject[]
商品定制信息列表。name string自定义属性名称。例子:colorsshow boolean定制信息是否可见。有效枚举值包含:true: 可见false: 不可见
type string定制信息类型。有效枚举值包含:text:字符类型picture:图片类型link:链接类型
urls arrayURL 列表。- 如果
type是picture,可通过urls获取缩略图。 - 如果
type是link,那么超链接为urls的第一个。
value string自定义属性值。例子:redquantity integer商品数量。requires_shipping boolean商品是否需要发货。true: 需要发货false: 不需要发货
sku string商家定义的商品货号。tax_linesobject[]
税费信 息。name string税费名称。price string税费金额。rate double税率。type string税费类型。有效枚举值:product_tax:商品税shipping_tax:运费税duty_tax:关税
例子:shipping_taxtitle string商品款式的标题。variant_id string款式的唯一标识 ID。variant_title string商品 SKU 标题。logistics_price string运费总金额。logistics_tax string运费总税费。market_name string市场名称。note string草稿单备注。note_attributesobject[]
草稿单附加信息。name string附加属性的名称。value string附加属性的值。order_id stringDeprecated该字段自 API 版本 v20251201 起已废弃。payment_termsobject
支付条款和付款信息。due_in_days integer在选定的付款条件模板中定义的发票日期和到期日之间的天数。当payment_terms_type类型为NET时提供。id string支付条款的唯一识别 ID。overdue boolean支付条款是否超时。true: 超时false: 未超时
pay_channel_id string支付渠道的 ID。pay_status string支付状态。有效枚举值包括:unpaid: 未支付paid: 已支付
payment_channel_name string支付渠道名称。payment_schedulesobject[]
与付款条件相关联的一组时间表。completed_at string记录支付完成的日期和时间。due_at string支付条款到期的日期和时间。
当payment_terms_type值为FIXED时,due_at必有值。
当payment_terms_type值为NET时,due_at的值为issued_at加due_in_days。
当payment_terms_type值为FULFILLMENT时,仅在订单发货时有值。issued_at string支付 条款生效的日期和时间。
当payment_terms_type值为FIXED时,如果issued_at为空,则issued_at等于due_at。
当payment_terms_type值为NET时,issued_at一定有值。
当payment_terms_type值为FULFILLMENT时,仅在订单发货时有值。
当payment_terms_type值为RECEIPT时,仅在发送账单时有值。例子:2024-08-31T02:20:26+08:00payment_terms_name string付款条件模板的名称。payment_terms_type string付款条件模板类型。有效枚举值:FIXED: 指定日期前全额付款FULFILLMENT: 订单发货时全额付款RECEIPT: 发送账单时全额付款NET: 净付款
po_number stringB2B场景在订单上记录的采购订单号。presentment_currency_code string市场币种。product_tax string商品总税费。seller_id string商户 ID。shipping_addressobject
收件人的收货地址。address1 string收货地址的第一行。通常是街道地址或邮政信箱编号等信息。例子:8899 Garfield Streetaddress2 string收货地址的第二行。通常是公寓、套房或单元等信息。例子:Apartment 5city string收货地址中的城市。例子:Guangzhou Citycity_code string收货地址中城市的编码。例子:510000company string收件人的公司名称。例子:Company Namecountry string收货地址的国家或地区。例子:Chinadistrict string收货地址中的区或县。例子:Panyu Districtdistrict_code string收货地址中区或县的编码。例子:510007first_name string收件人的名。例子:Tomlast_name string收件人的姓。例子:Washingtonname string收件人的全名。phone string收件人的手机号码。例子:13903004000province string收货地址中的省份。例子:Guangdong Provinceprovince_code string地址中省份的编码,该编码是系统自定义编号。例子:4220006zip string收货地址中的邮编信息。例子:510036shipping_linesobject
物流信息。当shipping_type为system时,须传入delivery_id。
当shipping_type为custom时,须传入title和price。
当期望免运费时,shipping_type须传custom, 同时必须传入title和price,且price值须设置为0。delivery_id string运费模板 ID。price string物流运费。shipping_type string物流类型:system: 系统物流custom: 自定义物流
title string物流名称。status integer草稿单状态。有效枚举值包含:open: 处理中completed: 已完成
stock_reserved boolean订单维度是否有保留商品标识。true: 有保留商品标识false: 无保留商品标识
stock_reserved_time long订单维度保留商品时间,格式为 13 位毫秒级时间戳。例子:1669280400000store_id string店铺的唯一标识符 ID。tags array标签列表,多个标签间用英文逗号分隔。tax_linesobject[]
税费信息。name string税费信息名称。price string金额。rate double税率。type string税费类型。有效枚举值:product_tax:商品税shipping_tax:运费税duty_tax:关税
total_line_items_price string当前草稿单商品总金额。total_line_items_price_setobject
当前草稿单商品总金额信息。total_price string当前草稿单总金额,为商品售价减去折扣,再加上税费与运费的总和。update_at long草稿单的更新时间,格式为 13 位毫秒级时间戳。例子:1667638652832
API Explorer
调试台
示例代码
这篇文章对你有帮助吗?