orderSendInvoice Mutation
Description
Sends an invoice email to the buyer. The email includes the invoice PDF and uses the provided subject and message. Optionally sends a copy to the current user.
mutation orderSendInvoice(
$orderRef: ID!
$orderInvoiceInput: OrderInvoiceInput!
) {
orderSendInvoice(orderRef: $orderRef, orderInvoiceInput: $orderInvoiceInput) {
_id
id
incId
origin
created
modified
shipping {
status
fulfilled
date
method
freeShippingThreshold
tracking
shopCollection
weight
packingSlip
}
billing {
status
fulfilled
paymentDate
refundDate
}
orderId
notes {
date
content
}
instructions
totals {
subtotal
subtotalBeforeTaxes
tax
grand
leftToPay
itemQuantity
discount
shipping
creditNote
balance
}
items {
_id
quantity
unavailable
added
}
messages {
_id
created
subject
message
fromBuyer
flagged
archived
isSystem
content
read
orderId
orderIncId
uri
via
}
buyer {
_id
firstName
lastName
email
name
path
telephone
organisation
taxNumber
}
logs {
action
description
date
ip
}
seller {
type
name
email
ref
}
updated
status
discogsStatus
buyerWasContacted
unreadMessagesCount
mergeableOrders {
_id
id
created
total
description
}
path
}
}
Variables
{
"orderRef": "ac5fe18f39b6b112796a592b",
"orderInvoiceInput": {
"recipient": "recipient",
"message": "message",
"subject": "subject",
"ccMe": true
}
}
Response
{
"orderSendInvoice": {
"_id": "bdfac21cdaa86785f0f64519",
"id": "example",
"incId": 42,
"origin": "example",
"created": 1740236991795,
"modified": 1767413779644,
"shipping": {
"status": "Pending",
"fulfilled": true,
"date": 1760591818925,
"method": "example",
"freeShippingThreshold": 1.23,
"tracking": "example",
"shopCollection": true,
"weight": 1.23,
"packingSlip": "example"
},
"billing": {
"status": "example",
"fulfilled": true,
"paymentDate": 1741544040169,
"refundDate": 1756356153389
},
"orderId": "example",
"notes": [
{
"date": 1790119577232,
"content": "example"
}
],
"instructions": "example",
"totals": {
"subtotal": 1.23,
"subtotalBeforeTaxes": 1.23,
"tax": 1.23,
"grand": 1.23,
"leftToPay": 1.23,
"itemQuantity": 1.23,
"discount": 0.1,
"shipping": 1.23,
"creditNote": 1.23,
"balance": 1.23
},
"items": [
{
"_id": "a287fef4253d672048b95295",
"quantity": 1,
"unavailable": true,
"added": 1746453450541
}
],
"messages": [
{
"_id": "599955d867a1c28e388975cb",
"created": 1772491922622,
"subject": "example",
"message": "example",
"fromBuyer": true,
"flagged": true,
"archived": true,
"isSystem": true,
"content": "example",
"read": true,
"orderId": "example",
"orderIncId": 42,
"uri": "https://www.my-common-ground-store.com/release/1763553751/release-artist-release-name",
"via": "example"
}
],
"buyer": {
"_id": "c70c78aaf96b183faee1f85c",
"firstName": "example",
"lastName": "example",
"email": "email@example.com",
"name": "example",
"path": "/release/1763553751/release-artist-release-name",
"telephone": "example",
"organisation": "example",
"taxNumber": "example"
},
"logs": [
{
"action": "example",
"description": "example",
"date": 1787651666579,
"ip": "example"
}
],
"seller": {
"type": "example",
"name": "example",
"email": "email@example.com",
"ref": "1fe1ef63a88d35b0b1655a62"
},
"updated": 1789134847823,
"status": "example",
"discogsStatus": "example",
"buyerWasContacted": true,
"unreadMessagesCount": 42,
"mergeableOrders": [
{
"_id": "f10e179fc71b6b2c9ae319fb",
"id": "example",
"created": 1745301061297,
"total": 29.99,
"description": "example"
}
],
"path": "/release/1763553751/release-artist-release-name"
}
}
Arguments
| Name | Type | Description |
|---|---|---|
orderRef | ID! | Reference ID of the order to send an invoice for. |
orderInvoiceInput | OrderInvoiceInput! | Invoice email details including recipient, subject, message, and whether to CC the sender. |