POST /admin/api/{api_version}/draft_orders/{draft_order_id}/send_invoice.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: The custom message displayed in the email.
Servers
- https://{store_name}.myshopify.com
- {store_name}.myshopify.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
api_version |
String | Yes | |
draft_order_id |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
x-shopify-access-token |
String | No |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
draft_order_invoice |
Object | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.