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": "1d3a8d12700cf7bd202bf52c",
    "status": "status"
}

Response

{
    "orderUpdateStatus": {
        "_id": "dbd2b6a09ef139b4b23c00af",
        "id": "example",
        "incId": 42,
        "origin": "example",
        "created": 1725765980771,
        "modified": 1730626733033,
        "shipping": {
            "status": "Pending",
            "fulfilled": true,
            "date": 1770574258241,
            "method": "example",
            "freeShippingThreshold": 1.23,
            "tracking": "example",
            "shopCollection": true,
            "weight": 1.23,
            "packingSlip": "example"
        },
        "billing": {
            "status": "example",
            "fulfilled": true,
            "paymentDate": 1751892551956,
            "refundDate": 1731336193669
        },
        "orderId": "example",
        "notes": [
            {
                "date": 1772714434541,
                "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": "1506878ee512e4960aa862cf",
                "quantity": 1,
                "unavailable": true,
                "added": 1763520192338
            }
        ],
        "messages": [
            {
                "_id": "a1ac12ecb15480bee435c82a",
                "created": 1781350702737,
                "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": "eac7bfb0a3b3d4a2e5be6745",
            "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": 1766253174999,
                "ip": "example"
            }
        ],
        "seller": {
            "type": "example",
            "name": "example",
            "email": "email@example.com",
            "ref": "57e5b9f388215610dbd42e26"
        },
        "updated": 1750978948780,
        "status": "example",
        "discogsStatus": "example",
        "buyerWasContacted": true,
        "unreadMessagesCount": 42,
        "mergeableOrders": [
            {
                "_id": "44249696992a91ecfb3af170",
                "id": "example",
                "created": 1738598450127,
                "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.
status	String!	New status to apply to the order.

Returns

Order!