orderCarrierBoxUpdate Mutation
Description
Selects the box preset for an order (snapshot from the carrier settings) and re-mirrors the order on the carrier aggregator so the new dimensions apply to quotes and labels.
mutation orderCarrierBoxUpdate($orderRef: ID!, $boxRef: ID!) {
orderCarrierBoxUpdate(orderRef: $orderRef, boxRef: $boxRef) {
_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": "8e412a4176fa26754032de14",
"boxRef": "0a2a57ccf65cdf058924259e"
}
Response
{
"orderCarrierBoxUpdate": {
"_id": "cd1eb342cbcab7090dbd8176",
"id": "example",
"incId": 42,
"origin": "example",
"created": 1782997717782,
"modified": 1777863424559,
"shipping": {
"status": "Pending",
"fulfilled": true,
"date": 1748316596328,
"method": "example",
"freeShippingThreshold": 1.23,
"tracking": "example",
"shopCollection": true,
"weight": 1.23,
"packingSlip": "example"
},
"billing": {
"status": "example",
"fulfilled": true,
"paymentDate": 1732282464420,
"refundDate": 1772449090387
},
"orderId": "example",
"notes": [
{
"date": 1766676518083,
"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": "c29c8789f0dfd30a84495549",
"quantity": 1,
"unavailable": true,
"added": 1776436109761
}
],
"messages": [
{
"_id": "9a4dbb36aebc9e11a058da24",
"created": 1756609595719,
"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": "3eaf9df9a93313a0e54202d4",
"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": 1775881200004,
"ip": "example"
}
],
"seller": {
"type": "example",
"name": "example",
"email": "email@example.com",
"ref": "4bdd493c18980c37123209b1"
},
"updated": 1779414329595,
"status": "example",
"discogsStatus": "example",
"buyerWasContacted": true,
"unreadMessagesCount": 42,
"mergeableOrders": [
{
"_id": "034ee1e34b941304913e49d7",
"id": "example",
"created": 1748473958754,
"total": 29.99,
"description": "example"
}
],
"path": "/release/1763553751/release-artist-release-name"
}
}
Arguments
| Name | Type | Description |
|---|---|---|
orderRef | ID! | Reference ID of the order to update. |
boxRef | ID! | Identifier of the box on the carrier settings (config.carriers.boxes). |