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": "16e4a1a5b188128a5a2171f8",
    "boxRef": "3f9874d2484fa55c1050dfc4"
}

Response

{
    "orderCarrierBoxUpdate": {
        "_id": "3e6780c37203754908212c40",
        "id": "example",
        "incId": 42,
        "origin": "example",
        "created": 1773940679822,
        "modified": 1737595605062,
        "shipping": {
            "status": "Pending",
            "fulfilled": true,
            "date": 1731352553500,
            "method": "example",
            "freeShippingThreshold": 1.23,
            "tracking": "example",
            "shopCollection": true,
            "weight": 1.23,
            "packingSlip": "example"
        },
        "billing": {
            "status": "example",
            "fulfilled": true,
            "paymentDate": 1762058188730,
            "refundDate": 1737215546699
        },
        "orderId": "example",
        "notes": [
            {
                "date": 1755183426446,
                "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": "005c347015a50b0a807e6b45",
                "quantity": 1,
                "unavailable": true,
                "added": 1750005698354
            }
        ],
        "messages": [
            {
                "_id": "25591a36868bb2b08ddcefe8",
                "created": 1737878218393,
                "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": "04a06f5b0515e47abe616a84",
            "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": 1761711232510,
                "ip": "example"
            }
        ],
        "seller": {
            "type": "example",
            "name": "example",
            "email": "email@example.com",
            "ref": "c7c2ad9c51870b9d0f35b533"
        },
        "updated": 1728956363179,
        "status": "example",
        "discogsStatus": "example",
        "buyerWasContacted": true,
        "unreadMessagesCount": 42,
        "mergeableOrders": [
            {
                "_id": "bf4b5056ae7a2d09d6294db8",
                "id": "example",
                "created": 1740944971710,
                "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).

Returns

Order!