Preview

Quote is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

Quote

Sales quote representing a potential purchase transaction. Quotes track the complete lifecycle from initial inquiry through finalization, including items, pricing, discounts, and customer information.

This page contains

    Fields

    id: ID!

    Unique identifier for the quote. This ID remains constant throughout the quote lifecycle and is used for all references and external integrations.

    name: String

    Human-readable quote name (maximum 255 characters)

    status: QuoteStatus! PREVIEW

    Current status of the quote

    creationStatus: QuoteCreationStatus! PREVIEW

    Status of quote to indicate whether all quote data has been fully populated and is available for client consumption

    ownerType: QuoteOwnerType! PREVIEW

    Type of quote owner (partner or platform)

    ownerUser: User! PREVIEW

    Sales agent responsible for the quote

    customerUser: User PREVIEW

    End customer for the quote (null for anonymous quotes)

    payerUser: User PREVIEW

    User responsible for payment (may differ from customer)

    createdByUser: User PREVIEW

    User who originally created the quote

    currency: Currency!

    Currency for all pricing in this quote (ISO-4217 format)

    createdOn: DateTime!

    When the quote was created (RFC-3339 format)

    purchaseEffectiveDate: DateTime

    When the purchase should take effect (RFC-3339 format)

    purchaseId: ID

    Purchase ID assigned after finalization

    purchaseNumber: String

    Numeric purchase identifier for display

    partner: String

    Partner code of the marketplace

    items: [QuoteItem!] PREVIEW

    Items included in this quote

    availableActions: [QuoteAction!]! PREVIEW

    Actions currently available for this quote based on status and permissions

    actionRestrictions: QuoteActionRestrictions PREVIEW

    Action restrictions that prevent certain operations

    summary: QuoteSummary! PREVIEW

    Summary of costs, taxes, and totals

    shipping: QuoteShipping PREVIEW

    Shipping information if applicable for physical products

    purchaseCustomAttributes: CustomAttributeMap

    Custom attributes for purchase flexibility and partner-specific data

    validation(enforce: Boolean): QuoteValidation!

    Latest validation results for the quote

    Implements

    Parent objects of Quote

    QuoteCloneProcess PREVIEW

    Quote clone process for async operations

    QuoteConnection PREVIEW

    Relay-compliant connection for quotes

    QuoteFinalizationProcess PREVIEW

    Quote finalization process for async status polling

    ResellerQuoteConnection PREVIEW

    Connection type for reseller-scoped quotes

    Mutations for Quote

    assignQuoteCustomer PREVIEW

    Assign customer to anonymous quote

    changeQuoteOwner PREVIEW

    Change quote owner

    createQuote PREVIEW

    Create a new quote

    removeQuoteItem PREVIEW

    Remove an item from a quote

    requestQuoteManagerApproval PREVIEW

    Request manager approval for quote

    setQuoteShippingAddress PREVIEW

    Create or update the shipping address of a quote

    updateQuote PREVIEW

    Update existing quote

    updateQuoteItemsRequiredFields PREVIEW

    Update required fields for multiple items

    Queries for Quote

    quote PREVIEW

    Retrieve a single quote by ID

    quoteFinalizationStatus PREVIEW

    Get the current finalization status of a quote. Use this to poll for completion after calling triggerQuoteFinalizationProcess mutation. Poll until status is COMPLETED or FAILED.

    quotes PREVIEW

    Retrieve paginated list of quotes with filtering