Skip to main content

orderGeneratePdf Mutation

Description​

Generates a PDF invoice for an order and updates the order with the generated PDF URL. The PDF is stored and can be accessed via the order's invoice PDF field.

mutation orderGeneratePdf($orderRef: ID!) {
orderGeneratePdf(orderRef: $orderRef) {
_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": "ebc9a9be72924d4b1504cbef"
}

Response​

{
"orderGeneratePdf": {
"_id": "28851b0e1b5335750e0f9c5b",
"id": "example",
"incId": 42,
"origin": "example",
"created": 1755824630901,
"modified": 1733604676534,
"shipping": {
"status": "Pending",
"fulfilled": true,
"date": 1793621201402,
"method": "example",
"freeShippingThreshold": 1.23,
"tracking": "example",
"shopCollection": true,
"weight": 1.23,
"packingSlip": "example"
},
"billing": {
"status": "example",
"fulfilled": true,
"paymentDate": 1750464539283,
"refundDate": 1761770432793
},
"orderId": "example",
"notes": [
{
"date": 1790348872960,
"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": "c102cdbb8dc192b4c6f67acb",
"quantity": 1,
"unavailable": true,
"added": 1756599417070
}
],
"messages": [
{
"_id": "f3f8c785a4258cfb191892a4",
"created": 1785296614624,
"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": "38a805e886406e8ecc2f6da4",
"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": 1735280355106,
"ip": "example"
}
],
"seller": {
"type": "example",
"name": "example",
"email": "email@example.com",
"ref": "00c9011a7a4d0e45a6f58330"
},
"updated": 1756156441667,
"status": "example",
"discogsStatus": "example",
"buyerWasContacted": true,
"unreadMessagesCount": 42,
"mergeableOrders": [
{
"_id": "679c1b0705748e12aefea21d",
"id": "example",
"created": 1746445117339,
"total": 29.99,
"description": "example"
}
],
"path": "/release/1763553751/release-artist-release-name"
}
}

Arguments​

NameTypeDescription
orderRefID!Reference ID of the order to generate a PDF invoice for.

Returns​

Order!