Skip to main content

orderUpdateStatus Mutation

Description

Updates the status of an order (e.g. locking it by moving it to "Invoice Sent").

mutation orderUpdateStatus($orderRef: ID!, $status: String!) {
orderUpdateStatus(orderRef: $orderRef, status: $status) {
_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
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": "60f6aa8e78b63501936b699c",
"status": "status"
}

Response

{
"orderUpdateStatus": {
"_id": "8476c1a39f3f29ee2e5db3e4",
"id": "example",
"incId": 42,
"origin": "example",
"created": 1732472161964,
"modified": 1740778059381,
"shipping": {
"status": "Pending",
"fulfilled": true,
"date": 1781845973357,
"method": "example",
"freeShippingThreshold": 1.23,
"tracking": "example",
"shopCollection": true,
"weight": 1.23,
"packingSlip": "example"
},
"billing": {
"status": "example",
"fulfilled": true,
"paymentDate": 1736960199967,
"refundDate": 1727524466396
},
"orderId": "example",
"notes": [
{
"date": 1772578911996,
"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": "7bcc64cb179410fb936f5492",
"quantity": 1,
"unavailable": true,
"added": 1723029581770
}
],
"messages": [
{
"_id": "bf5a1b19c40d37c81d4a167a",
"created": 1726803222719,
"subject": "example",
"message": "example",
"fromBuyer": true,
"flagged": 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": "82ea2c58788ca0d25a7109fa",
"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": 1763063175368,
"ip": "example"
}
],
"seller": {
"type": "example",
"name": "example",
"email": "email@example.com",
"ref": "53dd2621fea7db3d5a0add0d"
},
"updated": 1732470374816,
"status": "example",
"discogsStatus": "example",
"buyerWasContacted": true,
"unreadMessagesCount": 42,
"mergeableOrders": [
{
"_id": "9389a9267ddfcebd48b06ab0",
"id": "example",
"created": 1742168646174,
"total": 29.99,
"description": "example"
}
],
"path": "/release/1763553751/release-artist-release-name"
}
}

Arguments

NameTypeDescription
orderRefID!Reference ID of the order to update.
statusString!New status to apply to the order.

Returns

Order!