创建订单

需要 write_orders 权限点。
更多权限点使用信息，请参考：
访问权限。
POST https://{handle}.myshopline.com/admin/openapi/v20260301/orders.json
handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。
创建订单。
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8。
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
请求体
  • orderobject required
    订单信息。
  • billing_addressobject
    用于邮寄账单发票的地址。
  • address1 string
    账单地址的第一行。通常是街道地址或邮政信箱编号等信息。
    最大长度限制：256
    Example: Xiaoguwei Street
  • address2 string
    账单地址的第二行。通常是公寓、套房或单元等信息。
    最大长度限制：256
    Example: Apartment 5
  • area string
    账单地址中的区或县。
    最大长度限制：64
    Example: Panyu District
  • area_code string
    账单地址中区或县的编码。
    Example: 510007
  • city string
    账单地址中的城市。
    最大长度限制：64
    Example: Guangzhou City
  • city_code string
    账单地址中城市的编码。
    Example: 510000
  • company string
    账单收件人的公司名称。
    Example: Company Name
  • country string
    账单地址中的国家或地区。
    最大长度限制：64
    Example: China
  • country_code string
    账单地址中国家或地区的二位国家码，遵循 ISO 3166-1 国际标准。
    Example: US
  • email string
    账单收件人的邮箱。
    Example: test001@Gmail.com
  • first_name string
    账单收件人的名。
    Example: Tom
  • last_name string
    账单收件人的姓。
    Example: Washington
  • phone string
    账单收件人的手机号码。
    Example: 13903004000
  • province string
    账单地址中的省份。
    Example: Guangdong Province
  • province_code string
    账单地址中省份的编码，该编码可以是自定义编号或者为二位的 ISO 3166-1 国际编码。
    Example: 4220006
  • same_as_receiver boolean
    表示账单地址 billing_address 是否与收货地址 shipping_address 是一样的。
  • zip string
    账单地址的邮编信息。
    Example: 510036
  • buyer_note string
    买家留言。
    Example: message
  • company_location_id string
    公司地点 ID，用于创建 B2B 订单。
    Example: 3232423438438
  • currency string
    买家下单币种。该字段值为三位币种码，遵循 ISO 4217 标准。
    Example: USD
  • customerobject
    买家信息。
  • area_code string
    国家或地区的手机区号。
    Example: +86
  • email string
    买家的邮箱地址。
    Example: test001@Gmail.com
  • first_name string
    买家的名。
    Example: Tom
  • id string
    买家 ID。
    最大长度限制：64
    Example: 4201057495
  • last_name string
    买家的姓。
    Example: Washington
  • phone string
    买家手机号。
    Example: 13903004000
  • customer_locale string
    买家语种编码 + 国家或地区码。语种编码遵循 ISO 639 标准。国家或地区码遵循 ISO 3166-1 标准。
    Example: enCA
  • exchange_rate string
    订单货币和店铺货币之间的汇率。
    Example: 7.1245
  • financial_status string
    订单的付款状态。有效枚举值包含：
    • unpaid：未支付
    • partially_paid：部分支付
    • paid：已完成支付
    默认值：unpaid
    注意：传入枚举值的准确性会进行强校验，如果枚举值校验不通过，则订单创建会失败，会报错 financial_status is invalid。
  • fulfillment_status string
    订单的发货状态。有效枚举值包含：
    • unshipped：未发货
    • shipped：已发货
    默认值：unshipped
    注意：传入枚举值的准确性会进行强校验，如果枚举值校验不通过，则订单会创建失败，会报错 fulfillment_status is invalid。
  • inventory_behaviour string
    在订单创建过程中库存的处理方式。有效枚举值包含：
    • bypass：不处理库存。在创建订单时，系统不会对库存进行任何操作，库存数量不会发生变化。
    • decrement_ignoring_policy：扣减库存。不受商家配置的库存策略影响。
    • decrement_obeying_policy：按照商家配置的库存策略扣减库存。
  • line_itemsobject[] required
    订单商品快照信息列表。
  • discount_priceobject
    商品自定义折扣明细。
  • amount string
    折扣金额。数值保留到小数点后两位。
    Example: 1.00
  • title string
    折扣名称。
    Example: Discount name
  • location_id string
    商品库存地点 ID。
    Example: 5445886274929439997
  • price string
    商品售价，数值保留到小数点后两位。
    Example: 3.25
  • product_id string
    款式对应商品的唯一标识 ID。
    Example: 16056761559984840457934011
  • propertiesobject[]
    商品定制信息列表。
  • name string
    自定义属性名称
    Example: attribute name
  • show boolean
    定制信息是否可见：
    • true：可见
    • false：不可见 默认值：false
  • type string
    定制信息类型。有效枚举值包含：
    • text：字符类型
    • picture：图片类型
    • link：链接类型
  • urls array
    URL 资源列表。
    • 如果 type 是 picture，可通过 urls 获取渲染出缩略图。
    • 如果 type 是 link，那么超链接为 urls 的第一个。
    Example: ["[\"https://www.url.com\"]"]
  • value string
    自定义属性值
    Example: attribute value
  • quantity long
    商品数量。
    Example: 1
  • requires_shipping boolean
    表明商品是否需要运输。
    • true：需要运输
    • false：不需要运输
  • shipping_line_title string
    商品行匹配的运费方案标题。在传入shipping_lines情况下，当前字段必传。
  • tax_lineobject
    自定义商品税费信息。
  • price string
    税费金额。商品实际收税以此字段金额为准，传入的 rate 税费仅做展示作用。
    Example: 3.25
  • rate string
    税率，数值保留到小数点后三位。如果税率为 2%，请传入 0.020。该信息只做展示作用。
    Example: 0.020
  • title string
    税费说明标题。该信息只做展示作用。
    Example: Tax name
  • taxable boolean
    该商品是否需要收税。
    • true：需要收税
    • false：不需要收税
    默认值：true
  • title string
    商品标题。
    Example: beautiful skirt
  • variant_id string
    分配给库存中某一特定商品的唯一编码。
    Example: 18056761559987524812644011
  • market_region_country_code string
    订单下单所在市场的国家或区域码。遵循 ISO 4217 标准。
    Example: US
  • name string
    订单编号（和订单 ID 不同，该编号可以在商家后台自定义前缀）。
    Example: D101
  • note string
    订单备注。
    最大长度限制：50
    废弃：该字段自 API 版本 v20210901 起已废弃。
    Example: Notes
  • note_attributesobject[]
    商家备注日志列表。
  • name string
    商家 ID，表明备注来源。
    Example: Note source
  • value string
    备注内容。
    Example: Notes
  • order_note string
    商家订单备注。
    最大长度限制：50
    Example: Notes
  • price_infoobject required
    价格信息。
  • current_extra_total_discounts string
    订单折扣金额，不包含折扣码优惠。数值保留到小数点后两位。
    Example: 8.00
  • taxes_included boolean
    该订单是否包含税费金额。
    • true：包含税费金额
    • false：不包含税费金额
  • total_shipping_price string
    运费，以店铺币种展示。数值保留到小数点后两位。
    Example: 8.00
  • processed_at string
    订单成单时间。格式：ISO 8601。
    Example: 2023-04-12T22:59:52+08:00
  • send_fulfillment_receipt boolean
    是否发送订单发货邮件。
    • true： 发送
    • false：不发送
  • send_receipt boolean
    是否发送订单确认邮件。
    • true： 发送
    • false：不发送
  • shipping_addressobject
    收货地址信息。
  • address1 string
    收货地址的第一行。通常是街道地址或邮政信箱编号等信息。
    最大长度限制：255
    Example: Xiaoguwei Street
  • address2 string
    收货地址的第二行。通常是公寓、套房或单元等信息。
    最大长度限制：255
    Example: Apartment 5
  • area string
    收货地址中的区或县。
    最大长度限制：64
    Example: Panyu District
  • area_code string
    收货地址中区或县的编码。
    Example: 510006
  • city string
    收货地址中的城市。
    最大长度限制：64
    Example: Guangzhou City
  • city_code string
    收货地址中城市的编码。
    Example: 510000
  • company string
    收件人的公司名称。
    Example: Company Name
  • country string
    收货地址中的国家或区域。
    最大长度限制：64
    Example: China
  • country_code string
    收货地址中国家或地区的二位国家码，遵循 ISO 3166-1 国际标准。
    Example: CN
  • email string
    买家的邮箱地址。
    Example: test001@Gmail.com
  • first_name string
    收件人的名。
    最大长度限制：64
    Example: Tom
  • last_name string
    收件人的姓。
    最大长度限制：64
    Example: Washington
  • latitude string
    收货地址所在的纬度。
    Example: 43
  • longitude string
    收货地址所在的经度。
    Example: 34
  • phone string
    收件人的手机号码。
    Example: 13903004000
  • province string
    收货地址中的州或省份。
    Example: Guangdong Province
  • province_code string
    收货地址中省份的编码，该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。
    Example: 4220006
  • zip string
    收货地址的邮编信息。
    Example: 510036
  • shipping_lineobject
    运费信息。
  • code string
    物流编号。
    Example: SF
  • price string
    运费金额，数值保留到小数点后两位。
    Example: 3.25
  • tax_lineobject
    自定义商品税费信息。
  • price string
    税费金额。商品实际收税以此字段金额为准，传入的 rate 税费仅做展示作用。
    Example: 100
  • rate string
    税率，数值保留到小数点后三位。如果税率为 2%，请传入 0.020。该信息只做展示作用。
    Example: 0.020
  • title string
    税费说明标题。该信息只做展示作用。
    Example: Tax name
  • title string
    运费名称。
    Example: Shipping name
  • shipping_linesobject[]
    否 运费方案列表。 最大个数限制：10
  • price string
    运费金额
  • tax_lineobject
    运费税费明细
  • price string
    税费金额
  • rate string
    税率。该信息只做展示作用。
  • title string
    税费说明标题。该信息只做展示作用。
  • title string
    运费名称。
  • transaction_listobject[]
    支付单列表。
  • amount string
    支付单金额。数值保留到小数点后两位。
    Example: 3.25
  • gateways string
    支付渠道。
    Example: PayPal
  • processed_at string
    支付单创建时间。格式：ISO 8601。
    Example: 2023-04-12T22:59:52+08:00
  • status string required
    支付状态。有效枚举值包含：
    • unpaid： 未支付
    • failure：支付失败
    • success：支付成功
    • error：支付出错
    Example: string
  • transactionsobject
    支付单信息。
  • id string
    支付方式 ID。
    Example: 424243
状态码
更多状态码信息，参考 HTTP 状态码。
响应头
  • traceId
    请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。
响应体
  • orderobject
    订单信息。
  • adjust_price string
    POS 交易场景下因金额四舍五入带来的差额金额，用店铺币种。
    Example: 7.23
  • adjust_price_setobject
    POS 交易场景下因金额四舍五入带来的差额金额，分别以买家币种和卖家币种展示。
  • presentment_moneyobject
    展示给买家的差额金额信息。
  • amount string
    差额金额。数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的差额金额信息。
  • amount string
    差额金额。数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • billing_addressobject
    用于邮寄账单发票的地址。
  • address1 string
    账单地址的第一行。通常是街道地址或邮政信箱编号等信息。
    Example: Xiaoguwei Street,
  • address2 string
    账单地址的第二行。通常是公寓、套房或单元等信息。
    Example: Apartment 5
  • city string
    账单地址中的城市。
    Example: Guangzhou City
  • company string
    账单收件人所在的公司名称。
    Example: new company
  • country string
    账单地址中的国家或区域。
    Example: China
  • country_code string
    账单地址中国家或地区的二位码，遵循 ISO 3166-1 国际标准。
    Example: CN
  • first_name string
    账单收件人的名。
    Example: Tom
  • last_name string
    账单收件人的姓。
    Example: Washington
  • phone string
    账单收件人的手机号码。
    Example: 13100000000
  • province string
    账单地址中的省份。
    Example: Guangdong Province
  • province_code string
    账单地址中省份的编码，该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。
    Example: 4200006
  • standard_province_code string
    账单地址中省份的编码，该编码为二位的 ISO 3166-2 国际编码，区别于province_code返参为自定义编码。
  • zip string
    账单地址的邮编信息。
    Example: 510000
  • created_at string
    订单创建时间。格式：ISO 8601。
    Example: 2021-08-16T08:27:57+00:00
  • currency string
    交易币种，三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • current_subtotal_price string
    商品金额总和，为商品单价 * 数量，以店铺币种展示。
    Example: 7.12
  • current_subtotal_price_setobject
    商品金额总和，为商品单价 * 数量，分别以买家币种和店铺币种展示。
  • presentment_moneyobject
    展示给买家的订单价格信息。
  • amount string
    订单金额。数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的订单价格信息。
  • amount string
    订单金额。数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • current_total_discounts string
    折扣金额总和，数值保留到小数点后两位，为营销优惠 + 人工折扣，以店铺币种展示。
    Example: 0.25
  • current_total_discounts_setobject
    折扣金额总和，数值保留到小数点后两位，为营销优惠 + 人工折扣，分别以买家币种金额和店铺币种金额展示。
  • presentment_moneyobject
    展示给买家的折扣金额信息。
  • amount string
    折扣金额总和，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的折扣金额信息。
  • amount string
    折扣金额总和，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • current_total_duties_setobject
    商品总关税，分别以买家币种金额和店铺币种金额展示。
  • presentment_moneyobject
    展示给买家的商品总关税信息。
  • amount string
    关税金额，数值保留到小数点后两位。
    Example: 8.88
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的商品总关税信息。
  • amount string
    关税金额，数值保留到小数点后两位。
    Example: 8.88
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • current_total_price string
    订单总额，以店铺币种金额展示。
    Example: 1000.25
  • current_total_price_setobject
    订单总额，分别以买家币种金额和店铺币种金额展示。
  • presentment_moneyobject
    展示给买家的订单价格信息。
  • amount string
    订单总额，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的订单价格信息。
  • amount string
    订单总额，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • current_total_tax string
    税费金额总和，以店铺币种金额展示。
    Example: 2.41
  • current_total_tax_setobject
    税费金额总和，分别以买家币种金额和店铺币种金额展示。
  • presentment_moneyobject
    展示给买家的税费信息。
  • amount string
    税费，数值保留到小数点后两位。
    Example: 1.03
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的税费信息。
  • amount string
    税费，数值保留到小数点后两位。
    Example: 1.03
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • customerobject
    买家信息。
  • area_code string
    国家或地区的手机区号。
    Example: +86
  • currency string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • email string
    买家的邮箱地址。
    Example: test001@Gmail.com
  • first_name string
    买家的名。
    Example: Tom
  • id string
    买家 ID。
    Example: 4201057495
  • last_name string
    买家的姓。
    Example: Washington
  • phone string
    买家的手机号。
    Example: 13100000000
  • deduct_member_point_amount string
    当前订单会员积分抵扣金额，以店铺币种展示。数值保留到小数点后两位。
    Example: 3.25
  • deduct_member_point_amount_setobject
    当前订单会员积分抵扣金额，分别以买家币种金额和店铺币种金额展示。
  • presentment_moneyobject
    展示给买家的订单抵扣金额信息。
  • amount string
    抵扣金额，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的订单抵扣金额信息。
  • amount string
    抵扣金额，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • discount_codesobject
    优惠码信息。
  • amount string
    优惠金额，以店铺币种展示，数值保留到小数点后两位。
    Example: 3.25
  • code string
    优惠码。
    Example: 82UD6BTPX9L2
  • type string
    优惠类型。有效枚举值包含：
    • 减金额：全场满 100 元立减 10 元
    • 打折：全场满 100 元打 9 折
    • 免运费：满 3 件免运费
    • 加价品：需要支付额外金额
    • 任意N件优惠价：任意买 3 件商品，只需 99 元
    • A+B组合优惠价：同时买 A 商品和 B 商品，两件一起只需 88 元
    • 赠品：购买制定商品赠送额外商品
    • 固定售价：统一售价 29 元
    • 最低价商品免费：买 3 件商品，最便宜的那件免费
    • 打包价：多件商品组合以固定总价出售
    • 第N件打折：第 2 件打 8 折
    • 买x送y：满 2 件送 1 件
    • 自定义：自定义折扣
    注意：返回的值为中文。
  • email string
    买家邮箱。
    Example: test001@Gmail.com
  • financial_status string
    订单付款状态。有效枚举值包含：
    • unpaid：未支付
    • authorized：已授权
    • pending：处理中
    • partially_paid：部分付款
    • paid：已付款
    • partially_refunded：部分退款
    • refunded：已退款
  • id string
    订单号，系统自定义编号。
    Example: 21050224312121887324667162, 21050224312121887324667164
  • line_itemsobject[]
    订单商品快照信息列表。
  • attribute string
    款式规格信息，以款式名称和规格值拼接展示。
    Example: red
  • country_code_of_origin string
    原产地或发货地的国家或地区代码，用于识别市场所在的国家或地区。遵循 ISO 3166-1 国际标准。
    Example: US
  • dutiesobject[]
    关税信息。
  • country_code_of_origin string
    原产地或发货地的国家或地区代码，用于识别市场所在的国家或地区。遵循 ISO 3166-1 国际标准。
    Example: US
  • harmonized_system_code string
    海关编码，用于在国际贸易中对产品进行分类。
    Example: D2314244
  • id string
    关税编号。
    Example: 3155232
  • priceobject
    关税金额，分别以买家币种金额和店铺币种金额展示。
  • presentment_moneyobject
    展示给买家的关税金额信息。
  • amount string
    关税金额，数值保留到小数点后两位。
    Example: 8.88
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的关税金额信息。
  • amount string
    关税金额，数值保留到小数点后两位。
    Example: 8.88
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • tax_linesobject[]
    税费信息列表。
  • price_setobject
    税费金额，分别以买家币种金额和店铺币种金额展示。
  • presentment_moneyobject
    展示给买家的税费信息。
  • amount string
    税费金额，数值保留到小数点后两位。
    Example: 8.88
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的税费信息。
  • amount string
    税费金额，数值保留到小数点后两位。
    Example: 8.88
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • rate double
    税率，该信息只做展示作用。
    Example: 0.08
  • rate_percentage double
    税率，百分比格式。
  • title string
    税费说明标题。该信息只做展示作用。
    Example: tariff
  • harmonized_system_code string
    海关编码，用于在国际贸易中对产品进行分类。
    Example: harmonized system code
  • id string
    商品快照表的 ID，系统生成，与订单号 order.id 唯一确认一个商品。
    Example: 3452
  • image_url string
    商品图片的 URL 地址。
    Example: https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969
  • name string
    SKU 标题，该字段值和 title 一致。
    Example: skirt
  • price string
    商品售价，以店铺币种金额展示，数值保留到小数点后两位。
    Example: 100
  • price_setobject
    商品售价，分别以店铺币种金额和买家币种金额展示。
  • presentment_moneyobject
    展示给买家的商品售价信息。
  • amount string
    商品售价，数值保留到小数点后两位。
    Example: 1.03
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的商品售价信息。
  • amount string
    商品售价，数值保留到小数点后两位。
    Example: 1.03
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • product_id string
    款式对应商品的唯一标识 ID。
    Example: 16056761559984840457934011
  • propertiesobject[]
    商品定制信息列表。
  • name string
    自定义属性名称。
    Example: attribute name
  • show boolean
    定制信息是否可见：
    • true：可见
    • false：不可见 默认值：false
  • type string
    定制信息类型。有效枚举值包含：
    • text：字符类型
    • picture：图片类型
    • link：链接类型
  • urls array
    URL 资源列表。
    • 如果 type 是 picture，可通过 urls 获取渲染出缩略图。
    • 如果 type 是 link，那么超链接为 urls 的第一个。
    Example: ["[\"https://www.url.com\"]"]
  • value string
    自定义属性值。
    Example: attribute value
  • quantity integer
    订单中的商品数量。
    Example: 1
  • requires_shipping boolean
    商品是否需要发货。
    • true：需要发货
    • false：不需要发货
  • sku string
    商品 SKU 序列号。
    Example: 18056761559987524812644011
  • tags string
    商品标签，多个以逗号隔开。
    Example: watch
  • tax_linesobject[]
    税费明细列表。
  • name string
    税费名称
    Example: taxes
  • price string
    税费，以店铺币种展示。数值保留到小数点后两位。
    Example: 3.25
  • price_setobject
    税费，分别以买家币种和店铺币种展示。
  • presentment_moneyobject
    展示给买家的税费信息。
  • amount string
    税费，数值保留到小数点后两位。
    Example: 1.03
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的税费信息。
  • amount string
    税费，数值保留到小数点后两位。
    Example: 1.03
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • rate double
    税率，该信息只做展示作用。
    Example: 1
  • title string
    税费说明标题。该信息只做展示作用。
    Example: taxes
  • taxable boolean
    该商品是否需要收税。
    • true：需要收税
    • false：不需要收税
  • title string
    商品标题。
    Example: beautiful skirt
  • variant_id string
    分配给库存中某一特定商品的唯一编码。
    Example: 18056761559987524812644011
  • variant_title string
    商品属性值，多个以 / 分割。
    Example: 155 / red / large
  • vendor string
    供应商。
    Example: Supplier
  • locationsobject[]
    到店取货地点地址信息列表。
  • location_id string
    取货地点唯一编号。
    Example: 5327026538935748524
  • name string
    取货地址名称。
    Example: us.street
  • type string
    地点类型。有效枚举值包含：
    • posLocation：POS 渠道创建该订单的门店地点。建议使用 posLocationId，因为 posLocation 后续将废弃。
    • pickupLocation：当订单的配送方式为自提时，自提的门店地点。
    • productLocation：订单中商品的库存地点。建议使用商品行中的 location 信息，因为 productLocation 后续将废弃。
  • name string
    商家自定义的订单号，从 1001 开始，可以设置前缀。
    Example: test1001
  • note string
    商家备注内容。
    Example: Notes
  • note_attributesobject[]
    商家备注日志。
  • name string
    卖家标识，表明备注来源。
    Example: Note source
  • value string
    备注内容。
    Example: Notes
  • 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[]
    支付单信息列表。
  • pay_amount string
    支付金额，以店铺币种金额展示。数值保留到小数点后两位。
    Example: 3.25
  • pay_channel string
    支付渠道。
    Example: Paypal
  • pay_channel_deal_id string
    外部渠道支付流水号。
    Example: pi_3MI897Hezv8FxjBO1uGxMPhX
  • pay_seq string
    支付单号。
    Example: 23057287797738260472676128
  • pay_status string
    支付单状态。有效枚举值包含：
    • unpaid：未支付
    • pending：支付中
    • risking：风控中
    • paid：已支付
    • paid_overtime：支付超时
    • paid_failed：支付失败
  • processed_at string
    支付单创建时间。格式：ISO 8601。
    Example: 2023-04-12T22:59:52+08:00
  • phone string
    买家的手机号。
    Example: 13900000000
  • po_number string
    B2B 场景在订单上记录的采购订单号。
  • pos_location_id string
    POS 交易地点 ID。
    Example: 5327026538935748524
  • presentment_currency string
    买家侧币种，同卖家侧币种。三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • processed_at string
    成单时间。格式：ISO 8601。
    Example: 2023-04-12T22:59:52+08:00
  • shipping_addressobject
    收货地址。
  • address1 string
    地址的第一行。通常是街道地址或邮政信箱编号等信息。
    Example: Address 1
  • address2 string
    地址的第二行。通常是公寓、套房或单元等信息。
    Example: Address 2
  • city string
    地址中的城市。
    Example: New York
  • company string
    收件人所在的公司名称。
    Example: New company name
  • country string
    地址中的国家或区域。
    Example: USA
  • country_code string
    地址中国家或区域的二位码，遵循 ISO 3166-1 国际标准的二位国家或区域码，用于识别市场所在的国家或地区。
    Example: US
  • district string
    地址中的区。
    Example: Manhattan
  • district_code string
    地址中的区编码。
    Example: NY100xx
  • first_name string
    收件人的名。
    Example: Tom
  • last_name string
    收件人的姓。
    Example: Washington
  • latitude string
    地址所在的纬度。
    Example: 40.7831°N
  • longitude string
    地址所在的经度。
    Example: 73.9712°W
  • phone string
    收件人的手机号码。
    Example: 19821119121
  • province string
    地址中的省份。
    Example: New York state
  • province_code string
    地址中省份的编码，该编码可以是自定义编号或者为二位的 ISO 3166-2 国际编码。
    Example: NY
  • standard_province_code string
    账单地址中省份的编码，该编码为二位的 ISO 3166-2 国际编码，区别于province_code返参为自定义编码。
  • zip string
    地址的邮编信息。
    Example: 10007
  • status string
    订单状态。有效枚举值包含：
    • open：订单处理中
    • cancelled：订单已取消
  • subtotal_price string
    商品折后价总和，为商品总价 - 营销优惠 - 自定义折扣，以店铺币种展示。
    Example: 4.12
  • subtotal_price_setobject
    商品折后价总和，分别以买家币种金额和店铺币种金额展示。
  • presentment_moneyobject
    展示给买家的折后价格信息。
  • amount string
    折后价格，数值保留到小数点后两位。
    Example: 4.12
  • currency_code string
    三位币种码，遵循 ISO 4217 标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的折后价格信息。
  • amount string
    折后价格，数值保留到小数点后两位。
    Example: 4.12
  • currency_code string
    三位币种码，遵循 ISO 4217 标准。
    Example: USD
  • tax_linesobject[]
    税费明细列表。
  • name string
    税费名称。
    Example: taxes
  • price string
    税费，以店铺币种展示。数值保留到小数点后两位。
    Example: 3.25
  • price_setobject
    税费，分别以买家币种和店铺币种展示。
  • presentment_moneyobject
    展示给买家的税费信息。
  • amount string
    税费，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的税费信息。
  • amount string
    税费，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • rate double
    税率，该信息只做展示作用。
    Example: 1
  • title string
    税费说明标题。该信息只做展示作用。
    Example: taxes
  • tax_number string
    税号。
    Example: 111111111111
  • tax_type string
    订单的税费类型。有效枚举值包含：
    • product_tax：商品税
    • shipping_tax：运费税
  • taxes_included boolean
    该订单是否包含税费金额。
    • true：包含税费金额
    • false：不包含税费金额
  • total_discounts string
    订单折扣总和，为营销折扣 + 自定义折扣，数值保留到小数点后两位，以店铺币种金额展示。
    废弃：该字段自 API 版本 v20210901 起已废弃。
    Example: 3.25
  • total_discounts_setobject
    订单折扣总和，为营销折扣 + 自定义折扣，分别以店铺币种金额和买家币种金额展示。
    废弃：该字段自 API 版本 v20210901 起已废弃。
  • presentment_moneyobject
    展示给买家的折扣信息。
  • amount string
    折扣金额，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的折扣信息。
  • amount string
    折扣金额，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 标准。
    Example: USD
  • total_line_items_price string
    商品原价总和，数值保留到小数点后两位，以店铺币种金额展示。
    Example: 3.25
  • total_line_items_price_setobject
    商品原价总和，分别以买家币种金额和店铺币种金额展示。
  • presentment_moneyobject
    展示给买家的商品原价信息。
  • amount string
    商品原价，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的商品原价信息。
  • amount string
    商品原价，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • total_outstanding string
    未付款金额总额，数值保留到小数点后两位，以店铺币种金额展示。
    Example: 3.25
  • total_shipping_price_setobject
    订单运费总和，分别以买家币种金额和店铺币种金额展示。
  • presentment_moneyobject
    展示给买家的运费信息。
  • amount string
    运费金额，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的运费信息。
  • amount string
    运费，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • total_tax string
    税费总额，数值保留到小数点后两位，以店铺币种金额展示。
    Example: 3.25
  • total_tax_setobject
    税费总和，分别以买家币种金额和店铺币种金额展示。
  • presentment_moneyobject
    展示给买家的税费信息。
  • amount string
    税费，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • shop_moneyobject
    商家侧记录的税费信息。
  • amount string
    税费，数值保留到小数点后两位。
    Example: 3.25
  • currency_code string
    三位币种码，遵循 ISO 4217 国际标准。
    Example: USD
  • total_tip_received string
    小费，数值保留到小数点后两位，以店铺币种金额展示。
    Example: 3.25
  • total_weight string
    商品总重量，单位：g。
    Example: 1000
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required

Body

required
{
  "order": {
    "billing_address": {
      "address1": "Xiaoguwei Street",
      "address2": "Apartment 5",
      "area": "Panyu District",
      "area_code": "510007",
      "city": "Guangzhou City",
      "city_code": "510000",
      "company": "Company Name",
      "country": "China",
      "country_code": "US",
      "email": "test001@Gmail.com",
      "first_name": "Tom",
      "last_name": "Washington",
      "phone": "13903004000",
      "province": "Guangdong Province",
      "province_code": "4220006",
      "same_as_receiver": null,
      "zip": "510036"
    },
    "buyer_note": "message",
    "company_location_id": "3232423438438",
    "currency": "USD",
    "customer": {
      "area_code": "+86",
      "email": "test001@Gmail.com",
      "first_name": "Tom",
      "id": "4201057495",
      "last_name": "Washington",
      "phone": "13903004000"
    },
    "customer_locale": "enCA",
    "exchange_rate": "7.1245",
    "financial_status": null,
    "fulfillment_status": null,
    "inventory_behaviour": null,
    "line_items": [
      {
        "discount_price": {
          "amount": "1.00",
          "title": "Discount name"
        },
        "location_id": "5445886274929439997",
        "price": "3.25",
        "product_id": "16056761559984840457934011",
        "properties": [
          {
            "name": "attribute name",
            "show": null,
            "type": null,
            "urls": [
              "[\"https://www.url.com\"]"
            ],
            "value": "attribute value"
          }
        ],
        "quantity": 1,
        "requires_shipping": null,
        "shipping_line_title": null,
        "tax_line": {
          "price": "3.25",
          "rate": "0.020",
          "title": "Tax name"
        },
        "taxable": null,
        "title": "beautiful skirt",
        "variant_id": "18056761559987524812644011"
      }
    ],
    "market_region_country_code": "US",
    "name": "D101",
    "note": "Notes",
    "note_attributes": [
      {
        "name": "Note source",
        "value": "Notes"
      }
    ],
    "order_note": "Notes",
    "price_info": {
      "current_extra_total_discounts": "8.00",
      "taxes_included": null,
      "total_shipping_price": "8.00"
    },
    "processed_at": "2023-04-12T22:59:52+08:00",
    "send_fulfillment_receipt": null,
    "send_receipt": null,
    "shipping_address": {
      "address1": "Xiaoguwei Street",
      "address2": "Apartment 5",
      "area": "Panyu District",
      "area_code": "510006",
      "city": "Guangzhou City",
      "city_code": "510000",
      "company": "Company Name",
      "country": "China",
      "country_code": "CN",
      "email": "test001@Gmail.com",
      "first_name": "Tom",
      "last_name": "Washington",
      "latitude": "43",
      "longitude": "34",
      "phone": "13903004000",
      "province": "Guangdong Province",
      "province_code": "4220006",
      "zip": "510036"
    },
    "shipping_line": {
      "code": "SF",
      "price": "3.25",
      "tax_line": {
        "price": "100",
        "rate": "0.020",
        "title": "Tax name"
      },
      "title": "Shipping name"
    },
    "shipping_lines": [
      {
        "price": null,
        "tax_line": {
          "price": null,
          "rate": null,
          "title": null
        },
        "title": null
      }
    ],
    "transaction_list": [
      {
        "amount": "3.25",
        "gateways": "PayPal",
        "processed_at": "2023-04-12T22:59:52+08:00",
        "status": "string"
      }
    ],
    "transactions": {
      "id": "424243"
    }
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/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.