Queries and mutations for managing Staged Quotes in the platform.

Queries

Query Staged Quotes

QUERYstagedQuotes
Arguments
where​
String​
sort​
Array of String​
limit​
Int​
offset​
Int​

Get Staged Quote

QUERYstagedQuote
Arguments
id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Mutations

Create Staged Quote

MUTATIONcreateStagedQuote
Arguments
draft​
storeKey​

The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions.

Update Staged Quote

MUTATIONupdateStagedQuote
Arguments
version​
Long​
actions​
storeKey​

The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions.

id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Delete Staged Quote

MUTATIONdeleteStagedQuote
Arguments
version​
Long​
personalDataErasure​
Boolean​
Default: false​
storeKey​

The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions.

id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Output types

StagedQuote

key​
String​

User-specific unique identifier of the staged quote.

stagedQuoteState​

Predefined states tracking the status of the Staged Quote.

Can be Closed, InProgress, or Sent​
quoteRequestRef​

Quote Request related to the Staged Quote.

quoteRequest​

Quote Request related to the Staged Quote.

quotationCartRef​
Cart containing the offered items.
quotationCart​
Cart​
Cart containing the offered items.
customerRef​
The Buyer who requested the Quote.
customer​
The Buyer who requested the Quote.
validTo​

Expiration date for the Quote. Once a Quote expires, it cannot be ordered.

custom​

Custom Fields of the Staged Quote.

stateRef​
State of the Staged Quote. This reference can point to a State in a custom workflow.
state​
State of the Staged Quote. This reference can point to a State in a custom workflow.
sellerComment​
String​
Message from the Seller included in the offer.
businessUnit​
The BusinessUnit for the Staged Quote. Only available for B2B-enabled Projects.
businessUnitRef​
The BusinessUnit for the Staged Quote. Only available for B2B-enabled Projects.
purchaseOrderNumber​
String​
The purchase order number is typically set by the Buyer on a QuoteRequest to track the purchase order during the quote and order flow.
storeRef​
The Store to which the Buyer belongs.
store​
The Store to which the Buyer belongs.
id​
String​

The unique ID of the StagedQuote.

version​
Long​

Current version of the StagedQuote.

createdAt​

Date and time (UTC) the StagedQuote was initially created.

lastModifiedAt​

Date and time (UTC) the StagedQuote was last updated.

createdBy​

IDs and references that created the StagedQuote.

lastModifiedBy​

IDs and references that last modified the StagedQuote.

StagedQuoteState

Closed
InProgress
Sent

StagedQuoteQueryResult

offset​
Int​
count​
Int​
total​
Long​
exists​
Boolean​
results​
Array of StagedQuote​

Input types

StagedQuoteDraft

key​
String​

User-defined unique identifier for the StagedQuote.

quoteRequest​

QuoteRequest from which the StagedQuote is created.

quoteRequestStateToAccepted​
Boolean​
Whether the quoteRequestState of the referenced QuoteRequest will be set to Accepted.
Default: false​
quoteRequestVersion​
Long​

Current version of the QuoteRequest.

custom​
Custom Fields to be added to the StagedQuote.
  • If specified, the Custom Fields are merged with the Custom Fields on the referenced QuoteRequest and added to the StagedQuote.
  • If empty, the Custom Fields on the referenced QuoteRequest are added to the StagedQuote automatically.
state​
State of the Staged Quote. This reference can point to a State in a custom workflow.

StagedQuoteUpdateAction

changeStagedQuoteState​
setSellerComment​
setCustomField​
setCustomType​
setValidTo​
transitionState​

Update actions

Change Staged Quote State

stagedQuoteState​
Can be Closed, InProgress, or Sent​

StagedQuoteState

Closed
InProgress
Sent

Set Seller Comment

sellerComment​
String​
If sellerComment is absent or null, this field will be removed if it exists.

Set Custom Field

name​
String​
Name of the Custom Field.
value​
String​
If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

Set Custom Type

fields​
Array of CustomFieldInput​
typeKey​
String​
typeId​
String​

Set Valid To

validTo​
If validTo is absent or null, this field will be removed if it exists.

Transition State

If the existing State has set transitions, there must be a direct transition to the new State. If transitions is not set, no validation is performed. This update action produces the Staged Quote State Transition Message.

Value to set. If there is no State yet, the new State must be an initial State.

force​
Boolean​

Switch validations on or off.

Default: false​