Skip to main content

Quote

A sales quotation prepared for a customer: priced line items, a validity date and its own state machine. Becomes an order once the customer accepts it, at which point orderId points at the resulting order.

type Quote implements Node {
  id: ID!
  acceptedAt: DateTime
  amountNet: Float!
  amountTotal: Float
  assignedUserId: ID
  createdAt: DateTime!
  currencyId: ID!
  customerId: ID
  documentComment: String
  effectiveShippingCosts: Float!
  internalComment: String
  number: String!
  orderId: ID
  paymentMethodId: ID
  salesChannelId: ID!
  sentAt: DateTime
  shippingCostsOverrideAmount: Float
  state: String!
  taxStatus: String
  updatedAt: DateTime
  validUntil: DateTime
  currency: Currency
  customer: Customer
  lineItems(
    first: Int = 10
    after: String
    filter: QuoteLineItemFilterInput
  ): QuoteLineItemConnection
  order: Order
  paymentMethod: PaymentMethod
  salesChannel: SalesChannel
}

Fields​

Quote.id ● ID! non-null scalar​

Global identifier for this entity.

Quote.acceptedAt ● DateTime scalar​

Timestamp the customer accepted the quote. Null until then.

Quote.amountNet ● Float! non-null scalar​

Net total in the quote's currency, excluding tax. Equal to amountTotal when taxStatus is tax-free.

Quote.amountTotal ● Float scalar​

Grand total in the quote's currency, including tax.

Quote.assignedUserId ● ID scalar​

ID of the administration user responsible for the quote. Defaults to the user who created the quote and can be reassigned in the administration at any time. Null when the quote was created without a user, for example through an integration, or when the user was deleted.

Quote.createdAt ● DateTime! non-null scalar​

Timestamp the quote row was first persisted.

Quote.currencyId ● ID! non-null scalar​

ID of the currency every monetary field on the quote is denominated in.

Quote.customerId ● ID scalar​

ID of the customer the quote was prepared for. Null for a quote that is not (yet) tied to a customer account.

Quote.documentComment ● String scalar​

Free-form text rendered on the quote document.

Quote.effectiveShippingCosts ● Float! non-null scalar​

Shipping costs actually charged in the quote's currency, after any override. Follows taxStatus, so it is a gross amount on a gross-priced quote.

Quote.internalComment ● String scalar​

Free-form internal note. Not printed on the quote document and not sent in the quote mail.

Quote.number ● String! non-null scalar​

Human-readable quote number, drawn from the quote number range.

Quote.orderId ● ID scalar​

ID of the order the quote was converted into. Null until the conversion happens.

Quote.paymentMethodId ● ID scalar​

ID of the payment method proposed on the quote.

Quote.salesChannelId ● ID! non-null scalar​

ID of the sales channel the quote was created in. Determines tax and price handling.

Quote.sentAt ● DateTime scalar​

Timestamp the quote was first sent to the customer. Null until the quote is sent for the first time; a declined quote that is reopened as a draft keeps it.

Quote.shippingCostsOverrideAmount ● Float scalar​

Manually overridden shipping costs in the quote's currency. Null when the automatically calculated costs apply; the value actually charged is always effectiveShippingCosts.

Quote.state ● String! non-null scalar​

Name of the quote's state (draft, sent, accepted, declined).

Quote.taxStatus ● String scalar​

Tax status of the quote (gross, net, tax-free). Says whether amountTotal and effectiveShippingCosts include tax.

Quote.updatedAt ● DateTime scalar​

Timestamp of the last update to the quote row.

Quote.validUntil ● DateTime scalar​

Day the quote expires. Date-only: the time part is always midnight UTC.

Quote.currency ● Currency object​

Quote.customer ● Customer object​

Quote.lineItems ● QuoteLineItemConnection object​

Quote.lineItems.first ● Int scalar​
Quote.lineItems.after ● String scalar​
Quote.lineItems.filter ● QuoteLineItemFilterInput input​

Quote.order ● Order object​

Quote.paymentMethod ● PaymentMethod object​

Quote.salesChannel ● SalesChannel object​

Interfaces​

Node interface​

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By​

addQuoteCredit mutation ● addQuoteCustomLineItem mutation ● addQuoteProductLineItem mutation ● createQuote mutation ● quote query ● removeQuoteLineItem mutation ● updateQuoteCredit mutation ● updateQuoteLineItem mutation

Member Of​

QuoteEdge object ● QuoteLineItem object