Queries and mutations for managing Staged Quotes in the platform.
Queries
Query Staged Quotes
| Arguments | |
|---|---|
whereString | |
sortArray of String | |
limitInt | |
offsetInt | |
Get Staged Quote
| Arguments | |
|---|---|
idString | Queries with specified ID |
keyString | Queries with specified key |
Mutations
Create Staged Quote
| 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
| Arguments | |
|---|---|
versionLong | |
actionsArray of StagedQuoteUpdateAction | |
storeKey | The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions. |
idString | Queries with specified ID |
keyString | Queries with specified key |
Delete Staged Quote
| Arguments | |
|---|---|
versionLong | |
personalDataErasureBoolean | Default: false |
storeKey | The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions. |
idString | Queries with specified ID |
keyString | Queries with specified key |
Output types
StagedQuote
keyString | User-specific unique identifier of the staged quote. |
stagedQuoteState | Predefined states tracking the status of the Staged Quote. Can beClosed, 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. |
quotationCartCart | 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. |
sellerCommentString | 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. |
purchaseOrderNumberString | 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. |
idString | The unique ID of the StagedQuote. |
versionLong | 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
ClosedInProgressSent
StagedQuoteQueryResult
offsetInt | |
countInt | |
totalLong | |
existsBoolean | |
resultsArray of StagedQuote |
Input types
StagedQuoteDraft
keyString | User-defined unique identifier for the StagedQuote. |
quoteRequest | QuoteRequest from which the StagedQuote is created. |
quoteRequestStateToAcceptedBoolean | Default: false |
quoteRequestVersionLong | Current version of the QuoteRequest. |
custom | Custom Fields to be added to the StagedQuote.
|
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
ClosedInProgressSent
Set Seller Comment
sellerCommentString | If sellerComment is absent or null, this field will be removed if it exists. |
Set Custom Field
nameString | Name of the Custom Field. |
valueString | 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
fieldsArray of CustomFieldInput | |
type | |
typeKeyString | |
typeIdString |
Set Valid To
validTo | If validTo is absent or null, this field will be removed if it exists. |
Transition State
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.state | Value to set. If there is no State yet, the new State must be an initial State. |
forceBoolean | Switch validations on or off. Default:false |