Order Object

Description

Represents a customer order with items, billing, shipping, and payment information.

Declaration

type Order {
    _id: ID!
    id: String!
    incId: Int!
    origin: String!
    created: Date!
    modified: Date!
    shipping: Shipping!
    billing: Billing!
    orderId: String
    notes: [Note!]!
    instructions: String
    totals: Totals!
    items: [LineItem!]!
    messages: [Message!]
    buyer: CheckoutOrOrderBuyer
    logs: [LogEntry!]!
    seller: UserReference
    updated: Date
    status: String!
    discogsStatus: String
    buyerWasContacted: Boolean
    unreadMessagesCount: Int
    mergeableOrders: [OrderMergeable!]
    path: String
}

Fields

Name	Type	Description
_id	ID!	Internal database identifier.
id	String!	Order identifier string (e.g., "123456-789012").
incId	Int!	Incremental numeric identifier assigned to the order.
origin	String!	Origin of the order. Valid values include "Shop" (point-of-sale), "Online" (storefront), "Discogs" (marketplace), or "Bandcamp" (marketplace).
created	Date!	Date when the order was created.
modified	Date!	Date when the order was last modified.
shipping	Shipping!	Shipping information including address, method, status, and tracking.
billing	Billing!	Billing information including payment methods, status, and invoice details.
orderId ⚠️	String	Legacy order identifier. Use the id field instead. ⚠️ Deprecated: No longer supported
notes	[Note!]!	Notes and comments added to the order.
instructions	String	Special instructions for processing or shipping the order.
totals	Totals!	Financial totals including subtotals, taxes, shipping, discounts, and grand total.
items	[LineItem!]!	Line items included in the order.
messages	[Message!]	Messages in the order conversation thread between buyer and seller.
buyer	CheckoutOrOrderBuyer	Buyer information for the order.
logs	[LogEntry!]!	Historical log entries tracking changes and actions on the order.
seller	UserReference	Seller or staff member who processed the order.
updated	Date	Date when the order was last updated (synonym for modified).
status	String!	Current status of the order. Valid values include "New Order", "Buyer Contacted", "Invoice Sent", "Payment Pending", "Payment Received", "Shipped", "Refund Sent", "Cancelled (Non-Paying Buyer)", "Cancelled (Item Unavailable)", "Cancelled (Per Buyer's Request)", "Merged", or "Quote".
discogsStatus	String	Status specific to orders from the marketplace system. Used when origin is "Discogs".
buyerWasContacted	Boolean	Whether the buyer has been contacted regarding this order.
unreadMessagesCount	Int	Number of unread messages in the order conversation thread.
mergeableOrders	[OrderMergeable!]	List of orders that can be merged with this order.
path	String	URL path to the order page.