DraftOrder

您可以使用DraftOrder资源来允许商家代表客户创建订单。这对于通过外部渠道接收订单的Shopify商家很有用，并启用了多种用例，其中包括：

• 通过电话，面对面，通过聊天或其他方式创建新的销售订单。随后可以在Shopify管理员中输入这些订单的信用卡付款。
• 将发票发送给客户以使用安全的结帐链接进行付款。
• 使用自定义项目表示商店库存中未显示的其他费用或产品。
• 重新创建错误的订单。
• 以折扣价或批发价出售产品。
• 接受预订。

笔记

草稿订单资源不会公开储备库存信息。

你可以用DraftOrder做什么

Shopify API使您可以对DraftOrder资源执行以下操作。这些常规操作的更详细的版本可能可用：

• POST /admin/api/2021-01/draft_orders.json创建一个新的DraftOrder
• PUT /admin/api/2021-01/draft_orders/{draft_order_id}.json修改现有的DraftOrder
• GET /admin/api/2021-01/draft_orders.json检索订单草稿清单
• GET /admin/api/2021-01/draft_orders/{draft_order_id}.json收到一个草稿单
• GET /admin/api/2021-01/draft_orders/count.json收到所有草稿订单的计数
• POST /admin/api/2021-01/draft_orders/{draft_order_id}/send_invoice.json发送发票
• 删除/admin/api/2021-01/draft_orders/{draft_order_id}.json删除现有的DraftOrder
• PUT /admin/api/2021-01/draft_orders/{draft_order_id}/complete.json完成草稿订单

DraftOrder属性

终点

创建草稿订单。

使用DraftOrder资源，您可以使用产品变体订单项或自定义订单项以草稿状态创建订单。要创建产品变型顺序草案，提供variant_id，quantity和discount属性。要创建自定义行项目，提供title，price，taxable和quantity属性。

笔记

如果将此端点与合作伙伴开发商店或试用商店一起使用，则每分钟只能创建五个草稿订单。

轮询

创建和更新草稿订单时，某些计算是异步进行的，例如计算运费和税金。有时可能会创建草稿订单，但这些计算尚未完成。在这些情况下，您需要轮询订单草稿，直到计算完成。

当草稿订单需要轮询时，将202 accepted返回响应代码以及location和retry-after响应标头。所述location报头是指为轮询的URL，和retry-after表示时间间隔（秒），在该轮询请求应当被发送。准备好草稿订单后，200 OK将返回一个响应代码。

关于定制运输线

您可以使用DraftOrder资源发送带有自定义运输路线的订单。定制运输线包括title和price，其handle 设置为Nil。带有承运人提供的运费（当前通过Shopify管理员设置）的运送线包括运费手柄。

申请折扣

订单草稿及其订单项可以分别享有一个折扣。折扣的计算基于value_type属性的设置，可以将其设置为fixed_amount或percentage。例如，您可以对草稿订单应用固定金额的折扣，以通过指定的value属性降低价格。使用百分比折扣时，折扣amount属性是价格乘以value属性。对于订单项折扣，该value属性将基于订单项的数量按项目的每个单独单位应用。

计算订单项折扣金额

对于fixed_amount折扣，总计amount对应于订单项数量乘以折扣值。对于百分比折扣，总额对应于以下内容：

amount = floor(price * quantity * value) / 100，floor()通常的舍入功能在哪里。

对于非小数货币，此公式需要使用round（）而不是floor（），并且在四舍五入内部进行除以100，从而得到非小数的值。否则，将返回错误。

amount = round(price * quantity * value / 100)

订单项示例

固定金额折扣

对于数量为2且折扣为$ 5的订单项为$ 19.99，折扣金额为$ 10（$ 5 * 2）：

applied_discount: { "value_type": "fixed_amount", "value": 5, "amount": 10 }

有关固定金额的示例，请参阅创建带有折扣的草稿订单。

百分比折扣

对于数量为2且折扣15％的$ 19.99订单项，折扣金额为$ 5.99（底价（$ 19.99 2 15）/ 100）：

applied_discount: { "value_type": "percentage", "value": 15, "amount": 5.99 }

有关百分比示例，请参见在订单项上创建百分比折扣。

加载和删除客户

您可以通过发送customer_id作为草稿订单对象的一部分将客户加载到草稿订单中。建议从草稿订单中删除客户的方法是在POST请求中将Customer对象设置为null，而不指定电子邮件，送货地址或帐单地址。顾客还可以通过设置去除customer，email，shipping_address，和billing_address到null。

Create a simple draft order with only a product variant ID.

POST /admin/api/2021-01/draft_orders.json

{

“draft_order”: {

"line_items": [
  {
    "variant_id": 447654529,
    "quantity": 1
  }
]

}

}

View Response

创建具有折扣的草稿订单

POST /admin/api/2021-01/draft_orders.json

{

“ draft_order” ： {

“ line_items” ： [
  {
    “ title” ：“ Custom Tee”，
    “价格” ：“ 20.00”，
    “数量” ：2
  }
]，
“ applied_discount” ： {
  “ description” ：“自定义折扣”，
  “ value_type” ：“ fixed_amount”，
  “值” ：“ 10.0”，
  “ amount” ：“ 10.00”，
  “ title” ：“自定义”
}，
“客户” ： {
  “ id” ：207119551
}，
“ use_customer_default_address” ：true

}

}

查看回应

创建带有折扣订单项的草稿订单

POST /admin/api/2021-01/draft_orders.json

{

“ draft_order” ： {

“ line_items” ： [
  {
    “ title” ：“ Custom Tee”，
    “价格” ：“ 20.00”，
    “数量” ：1，
    “ applied_discount” ： {
      “ description” ：“自定义折扣”，
      “ value_type” ：“ fixed_amount”，
      “值” ：“ 10.0”，
      “ amount” ：“ 10.0”，
      “ title” ：“自定义”
    }
  }
]

}

}

查看回应

创建具有订单项折扣百分比的草稿订单

POST /admin/api/2021-01/draft_orders.json

{

“ draft_order” ： {

“ line_items” ： [
  {
    “ title” ：“ Custom Tee”，
    “价格” ：“ 20.00”，
    “数量” ：1，
    “ applied_discount” ： {
      “ description” ：“自定义折扣”，
      “ value_type” ：“百分比”，
      “值” ：“ 10.0”，
      “数量” ：“ 2.0”，
      “ title” ：“自定义”
    }
  }
]

}

}

查看回应

创建自定义草稿订单

POST /admin/api/2021-01/draft_orders.json

{

“ draft_order” ： {

“ line_items” ： [
  {
    “ title” ：“ Custom Tee”，
    “价格” ：“ 20.00”，
    “数量” ：2
  }
]，
“客户” ： {
  “ id” ：207119551
}，
“ use_customer_default_address” ：true

}

}

查看回应

Add a note to a draft order

PUT /admin/api/2021-01/draft_orders/994118539.json

{

“draft_order”: {

"id": 994118539,
"note": "Customer contacted us about a custom engraving on this iPod"

}

}

View Response

Set a discount on a draft order

PUT /admin/api/2021-01/draft_orders/994118539.json

{

“draft_order”: {

"id": 994118539,
"applied_discount": {
  "description": "Custom discount",
  "value_type": "percentage",
  "value": "10.0",
  "amount": "19.90",
  "title": "Custom"
}

}

}

View Response

列出所有订单草稿

GET /admin/api/2021-01/draft_orders.json

查看回应

获取单个草稿订单的表示

GET /admin/api/2021-01/draft_orders/994118539.json

查看回应

计算所有草稿订单

GET /admin/api/2021-01/draft_orders/count.json

查看回应

Sends an invoice for the draft order.

You can include the following parameters in the body of the request:

• draft_order_invoice: The object to send in the body of the request.
  • to: The email address that will populate the to field of the email.
  • from: The email address that will populate the from field of the email.
  • bcc: The list of email addresses to include in the bcc field of the email. Emails must be associated with staff accounts on the shop.
  • subject: The email subject.
  • custom_message：电子邮件中显示的自定义消息。

发送自定义发票

POST /admin/api/2021-01/draft_orders/994118539/send_invoice.json

{

“ draft_order_invoice” ： {

“至” ：“ first@example.com”，
“来自” ：“ steve@apple.com”，
“密件抄送” ： [
   “ steve@apple.com”
]，
“ subject” ：“ Apple Computer Invoice”，
“ custom_message” ：“谢谢您的订购！

}

}

查看回应

发送默认发票

POST /admin/api/2021-01/draft_orders/994118539/send_invoice.json

{

“ draft_order_invoice” ： {}

}

查看回应

永久删除草稿订单

删除/admin/api/2021-01/draft_orders/994118539.json

查看回应

使用DraftOrder资源，您可以创建草稿订单并将其转换为订单。

支持以下流程：

• 创建一个计算税额和总额但要接受Shopify外部客户付款的订单草稿。
• 创建订单草稿并将发票发送给客户。

完成订单草稿，将其标记为已付款

PUT /admin/api/2021-01/draft_orders/994118539/complete.json

查看回应

完成订单草稿，将其标记为待处理

PUT /admin/api/2021-01/draft_orders/994118539/complete.json?payment_pending=true

查看回应