review branch #1
Conversation
| description: array of staff account e-mail addresses. | ||
| subject: | ||
| type: string | ||
| description: subject of custom message injected into the template. |
There was a problem hiding this comment.
Subject more accurately represents the subject of the email rather than that of custom message
There was a problem hiding this comment.
The subject of the email that will be sent. When not provided, defaults to the Draft Order Invoice template's subject, as specified in the shop's Notification settings.
(See https://help.shopify.com/manual/sell-online/notifications for details on notification templates.)
There was a problem hiding this comment.
thnx will be changed in latest master.
| value if parameter not set. If email is blank everywhere, error out. | ||
| from: | ||
| type: string | ||
| description: One of the staff accoun e-mail addresses. |
There was a problem hiding this comment.
This email address that the email will appear to be sent from. This defaults to the shop's customer email, and if none exists, simply the shop's account email. When provided, this email address must correspond to the email address of one of the staff accounts.
|
|
||
|
|
||
| responses: | ||
| '200': |
There was a problem hiding this comment.
Response to POST will be 201 instead of 200
dominiquesr
left a comment
dominiquesr
left a comment
There was a problem hiding this comment.
Some changes for send_invoice, the rest still needs to be reviewed.
| type: string | ||
| description: >- | ||
| Use parameter value, but default to draft order email or customer | ||
| value if parameter not set. If email is blank everywhere, error out. |
There was a problem hiding this comment.
"customer value" is unclear.
The way it works is that it defaults to draft_order.email, or draft_order.customer.email if the draft doesn't have a unique email address, so maybe just customer email instead of customer value would make it clearer?
There was a problem hiding this comment.
thnx will be changed in latest master
| value if parameter not set. If email is blank everywhere, error out. | ||
| from: | ||
| type: string | ||
| description: One of the staff accoun e-mail addresses. |
There was a problem hiding this comment.
This email address that the email will appear to be sent from. This defaults to the shop's customer email, and if none exists, simply the shop's account email. When provided, this email address must correspond to the email address of one of the staff accounts.
| description: array of staff account e-mail addresses. | ||
| subject: | ||
| type: string | ||
| description: subject of custom message injected into the template. |
There was a problem hiding this comment.
The subject of the email that will be sent. When not provided, defaults to the Draft Order Invoice template's subject, as specified in the shop's Notification settings.
(See https://help.shopify.com/manual/sell-online/notifications for details on notification templates.)
| description: subject of custom message injected into the template. | ||
| custom_message: | ||
| type: string | ||
| description: Custom message that will be injected into the invoice template. |
There was a problem hiding this comment.
Is injected a word that we use in public documentation?
Alternatively, an optional custom message which will be inserted in the email's body.
Side note, the Draft Order Invoice has to have a {{ custom_message }} liquid tag in its template for this to work, but it's an exception for it not to have one so probably not worth mentioning in the docs.
| description: One of the staff accoun e-mail addresses. | ||
| bcc: | ||
| type: string | ||
| description: array of staff account e-mail addresses. |
There was a problem hiding this comment.
Optional array of email addresses to bcc. These must correspond to valid staff account email addresses.
branch for swagger spec reviews