Representations
StagedQuote
id ​String​ | The unique ID of the StagedQuote. |
version ​Int​ | Current version of the StagedQuote. |
key ​String​ | User-specific unique identifier of the staged quote. |
stagedQuoteState ​ | Predefined states tracking the status of the Staged Quote. DisplayName:ÂStagedQuoteState ​ |
customer ​ | The Buyer who requested the Quote. |
quoteRequest ​ | Quote Request related to the Staged Quote. |
quotationCart ​ | |
validTo ​DateTime​ | Expiration date for the Quote. Once a Quote expires, it cannot be ordered. |
sellerComment ​String​ | Message from the Seller included in the offer. |
state ​ | State of the Staged Quote.
This reference can point to a State in a custom workflow. |
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. |
businessUnit ​ | The BusinessUnit for the Staged Quote. Only available for B2B-enabled Projects. |
store ​ | The Store to which the Buyer belongs. |
custom ​CustomFields​ | Custom Fields of the Staged Quote. |
createdAt ​DateTime​ | Date and time (UTC) the StagedQuote was initially created. |
createdBy ​BETACreatedBy​ | IDs and references that created the StagedQuote. |
lastModifiedAt ​DateTime​ | Date and time (UTC) the StagedQuote was last updated. |
lastModifiedBy ​BETA | IDs and references that last modified the StagedQuote. |
StagedQuoteDraft
key ​String​ | User-defined unique identifier for the StagedQuote. MinLength:Â2 ​MaxLength: 256 ​Pattern: ^[A-Za-z0-9_-]+$ ​ |
quoteRequest ​ | QuoteRequest from which the StagedQuote is created. |
quoteRequestVersion ​Int​ | Current version of the QuoteRequest. |
quoteRequestStateToAccepted ​Boolean​ | |
state ​ | State of the Staged Quote.
This reference can point to a State in a custom workflow. |
custom ​ | Custom Fields to be added to the StagedQuote.
|
StagedQuotePagedQueryResponse
limit ​Int​ | Number of results requested. Default: 20 ​Minimum: 0 ​Maximum: 500 ​ |
offset ​Int​ | Number of elements skipped. Default: 0 ​Maximum: 10000 ​ |
count ​Int​ | Actual number of results returned. |
total ​Int​ | Total number of results matching the query.
This number is an estimation that is not strongly consistent.
This field is returned by default.
For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false .
When the results are filtered with a Query Predicate, total is subject to a limit. |
results ​Array of StagedQuote​ | Staged Quotes matching the query. |
StagedQuoteReference
id ​String​ | Unique ID of the referenced resource. |
typeId ​ | staged-quote Type of referenced resource. |
obj ​StagedQuote​ | Contains the representation of the expanded StagedQuote.
Only present in responses to requests with Reference Expansion for StagedQuote. |
StagedQuoteResourceIdentifier
id ​String​ | Unique identifier of the referenced resource. Required if key is absent. |
key ​String​ | User-defined unique identifier of the referenced resource. Required if id is absent. |
typeId ​ | staged-quote Type of referenced resource. If given, it must match the expected ReferenceTypeId of the referenced resource. |
StagedQuoteState
Get StagedQuote
Get StagedQuote by ID
view_staged_quotes:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
id String ​ | id of the StagedQuote. |
expand | The parameter can be passed multiple times. |
application/json
curl --get https://api.{region}.commercetools.com/{projectKey}/staged-quotes/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}
Get StagedQuote by Key
view_staged_quotes:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
key String ​ | key of the StagedQuote. |
expand | The parameter can be passed multiple times. |
application/json
curl --get https://api.{region}.commercetools.com/{projectKey}/staged-quotes/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}
Get StagedQuote in Store
Get StagedQuote in Store by ID
view_staged_quotes:{projectKey}
view_staged_quotes:{projectKey}:{storeKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
id String ​ | id of the StagedQuote. |
expand | The parameter can be passed multiple times. |
application/json
curl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/staged-quotes/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}
Get StagedQuote in Store by Key
view_staged_quotes:{projectKey}
view_staged_quotes:{projectKey}:{storeKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
key String ​ | key of the StagedQuote. |
expand | The parameter can be passed multiple times. |
application/json
curl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/staged-quotes/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}
Query StagedQuotes
view_staged_quotes:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
where | The parameter can be passed multiple times. |
sort | The parameter can be passed multiple times. |
expand | The parameter can be passed multiple times. |
limit Int ​ | Number of results requested. Default: 20 ​Minimum: 0 ​Maximum: 500 ​ |
offset Int ​ | Number of elements skipped. Default: 0 ​Maximum: 10000 ​ |
withTotal Boolean ​ | Controls the calculation of the total number of query results. Set to false to improve query performance when the total is not needed.Default: true ​ |
var.<varName> String ​ | Predicate parameter values. The parameter can be passed multiple times. |
application/json
curl --get https://api.{region}.commercetools.com/{projectKey}/staged-quotes -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"limit": 20,
"offset": 0,
"count": 2,
"total": 2,
"results": [
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
},
{
"id": "668e5783-73c8-4f2d-91f4-3c90b872c700",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "768e5783-73c8-3f2d-22f4-3c90b872c700"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "2v3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "82f2a767-bf19-47ab-982c-6720a03a3912"
},
"stagedQuoteState": "Sent"
}
]
}
Query StagedQuotes in Store
view_staged_quotes:{projectKey}
view_staged_quotes:{projectKey}:{storeKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
where | The parameter can be passed multiple times. |
sort | The parameter can be passed multiple times. |
expand | The parameter can be passed multiple times. |
limit Int ​ | Number of results requested. Default: 20 ​Minimum: 0 ​Maximum: 500 ​ |
offset Int ​ | Number of elements skipped. Default: 0 ​Maximum: 10000 ​ |
withTotal Boolean ​ | Controls the calculation of the total number of query results. Set to false to improve query performance when the total is not needed.Default: true ​ |
var.<varName> String ​ | Predicate parameter values. The parameter can be passed multiple times. |
application/json
curl --get https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/staged-quotes -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"limit": 20,
"offset": 0,
"count": 2,
"total": 2,
"results": [
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
},
{
"id": "668e5783-73c8-4f2d-91f4-3c90b872c700",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "768e5783-73c8-3f2d-22f4-3c90b872c700"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "2v3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "82f2a767-bf19-47ab-982c-6720a03a3912"
},
"stagedQuoteState": "Sent"
}
]
}
Check if StagedQuote exists
Check if StagedQuote exists by ID
id
. Returns a 200 OK
status if the StagedQuote exists or a 404 Not Found
otherwise.view_staged_quotes:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
id String ​ | id of the StagedQuote. |
curl --head https://api.{region}.commercetools.com/{projectKey}/staged-quotes/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
Check if StagedQuote exists by Key
key
. Returns a 200 OK
status if the StagedQuote exists or a 404 Not Found
otherwise.view_staged_quotes:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
key String ​ | key of the StagedQuote. |
curl --head https://api.{region}.commercetools.com/{projectKey}/staged-quotes/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
Check if StagedQuote exists by Query Predicate
200 OK
status if any StagedQuotes match the query predicate, or a 404 Not Found
otherwise.view_staged_quotes:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
where | The parameter can be passed multiple times. |
curl --head https://api.{region}.commercetools.com/{projectKey}/staged-quotes -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
Check if StagedQuote exists in Store
Check if StagedQuote exists in Store by ID
id
. Returns a 200 OK
status if the StagedQuote exists or Not Found otherwise.view_staged_quotes:{projectKey}
view_staged_quotes:{projectKey}:{storeKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
id String ​ | id of the StagedQuote. |
curl --head https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/staged-quotes/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
Check if StagedQuote exists in Store by Key
key
. Returns a 200 OK
status if the StagedQuote exists or Not Found otherwise.view_staged_quotes:{projectKey}
view_staged_quotes:{projectKey}:{storeKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
key String ​ | key of the StagedQuote. |
curl --head https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/staged-quotes/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
Check if StagedQuote exists in Store by Query Predicate
200 OK
status if any StagedQuotes match the query predicate, or Not Found otherwise.view_staged_quotes:{projectKey}
view_staged_quotes:{projectKey}:{storeKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
where | The parameter can be passed multiple times. |
curl --head https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/staged-quotes -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
Create StagedQuote
manage_staged_quotes:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
expand | The parameter can be passed multiple times. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/staged-quotes -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"quoteRequest" : {
"typeId" : "quote-request",
"id" : "168e5783-73c8-4f2d-91f4-3c90b872c708"
},
"quoteRequestVersion" : 1
}
DATA
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}
Create StagedQuote in Store
manage_staged_quotes:{projectKey}
manage_staged_quotes:{projectKey}:{storeKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
expand | The parameter can be passed multiple times. |
application/json
application/json
curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/staged-quotes -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"quoteRequest" : {
"typeId" : "quote-request",
"id" : "168e5783-73c8-4f2d-91f4-3c90b872c708"
},
"quoteRequestVersion" : 1
}
DATA
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}
Update StagedQuote
Update StagedQuote by ID
manage_staged_quotes:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
id String ​ | id of the StagedQuote. |
expand | The parameter can be passed multiple times. |
application/json
version ​Int​ | Expected version of the StagedQuote to which the changes should be applied.
If the expected version does not match the actual version, a ConcurrentModification error will be returned. |
actions ​Array of StagedQuoteUpdateAction​ | Update actions to be performed on the StagedQuote. |
application/json
curl https://api.{region}.commercetools.com/{projectKey}/staged-quotes/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 1,
"actions" : [ {
"action" : "changeStagedQuoteState",
"stagedQuoteState" : "Sent"
} ]
}
DATA
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}
Update StagedQuote by Key
manage_staged_quotes:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
key String ​ | key of the StagedQuote. |
expand | The parameter can be passed multiple times. |
application/json
version ​Int​ | Expected version of the StagedQuote to which the changes should be applied.
If the expected version does not match the actual version, a ConcurrentModification error will be returned. |
actions ​Array of StagedQuoteUpdateAction​ | Update actions to be performed on the StagedQuote. |
application/json
curl https://api.{region}.commercetools.com/{projectKey}/staged-quotes/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 1,
"actions" : [ {
"action" : "changeStagedQuoteState",
"stagedQuoteState" : "Sent"
} ]
}
DATA
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}
Update StagedQuote in Store
Update StagedQuote in Store by ID
manage_staged_quotes:{projectKey}
manage_staged_quotes:{projectKey}:{storeKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
id String ​ | id of the StagedQuote. |
expand | The parameter can be passed multiple times. |
application/json
version ​Int​ | Expected version of the StagedQuote to which the changes should be applied.
If the expected version does not match the actual version, a ConcurrentModification error will be returned. |
actions ​Array of StagedQuoteUpdateAction​ | Update actions to be performed on the StagedQuote. |
application/json
curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/staged-quotes/{id} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 1,
"actions" : [ {
"action" : "changeStagedQuoteState",
"stagedQuoteState" : "Sent"
} ]
}
DATA
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}
Update StagedQuote in Store by Key
manage_staged_quotes:{projectKey}
manage_staged_quotes:{projectKey}:{storeKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
key String ​ | key of the StagedQuote. |
expand | The parameter can be passed multiple times. |
application/json
version ​Int​ | Expected version of the StagedQuote to which the changes should be applied.
If the expected version does not match the actual version, a ConcurrentModification error will be returned. |
actions ​Array of StagedQuoteUpdateAction​ | Update actions to be performed on the StagedQuote. |
application/json
curl https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/staged-quotes/key={key} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @- << DATA
{
"version" : 1,
"actions" : [ {
"action" : "changeStagedQuoteState",
"stagedQuoteState" : "Sent"
} ]
}
DATA
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}
Update actions
Change Staged Quote State
action ​String​ | "changeStagedQuoteState" |
stagedQuoteState ​ | New state to be set for the Staged Quote. |
{
"action": "changeStagedQuoteState",
"stagedQuoteState": "Sent"
}
Set Seller Comment
action ​String​ | "setSellerComment" |
sellerComment ​String​ | If sellerComment is absent or null , this field will be removed if it exists. |
{
"action": "setSellerComment",
"sellerComment": "Please let me know if this matches your expectations"
}
Set Valid To
action ​String​ | "setValidTo" |
validTo ​DateTime​ | If validTo is absent or null , this field will be removed if it exists. |
{
"action": "setValidTo",
"validTo": "2022-09-22T15:41:55.816Z"
}
Set Custom Type
action ​String​ | "setCustomType" |
type ​ | Defines the Type that extends the StagedQuote with Custom Fields.
If absent, any existing Type and Custom Fields are removed from the StagedQuote. |
fields ​ | Sets the Custom Fields fields for the StagedQuote. |
{
"action": "setCustomType",
"type": {
"id": "{{type-id}}",
"typeId": "type"
},
"fields": {
"exampleStringField": "TextString"
}
}
Set CustomField
action ​String​ | "setCustomField" |
name ​String​ | Name of the Custom Field. |
value ​ | 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 . |
{
"action": "setCustomField",
"name": "exampleStringField",
"value": "TextString"
}
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.action ​String​ | "transitionState" |
state ​ | Value to set. If there is no State yet, the new State must be an initial State. |
force ​Boolean​ | Switch validations on or off. |
{
"action": "transitionState",
"state": {
"typeId": "state",
"id": "{{state-id}}"
}
}
Delete StagedQuote
Delete StagedQuote by ID
manage_staged_quotes:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
id String ​ | id of the StagedQuote. |
version Int ​ | Last seen version of the resource. |
expand | The parameter can be passed multiple times. |
dataErasure Boolean ​ | To erase all related personal data in compliance with GDPR, set to true .Default: false ​ |
application/json
curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/staged-quotes/{id}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}
Delete StagedQuote by Key
manage_staged_quotes:{projectKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
key String ​ | key of the StagedQuote. |
version Int ​ | Last seen version of the resource. |
expand | The parameter can be passed multiple times. |
dataErasure Boolean ​ | To erase all related personal data in compliance with GDPR, set to true .Default: false ​ |
application/json
curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/staged-quotes/key={key}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}
Delete StagedQuote in Store
Delete StagedQuote in Store by ID
manage_staged_quotes:{projectKey}
manage_staged_quotes:{projectKey}:{storeKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
id String ​ | id of the StagedQuote. |
version Int ​ | Last seen version of the resource. |
expand | The parameter can be passed multiple times. |
dataErasure Boolean ​ | To erase all related personal data in compliance with GDPR, set to true .Default: false ​ |
application/json
curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/staged-quotes/{id}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}
Delete StagedQuote in Store by Key
manage_staged_quotes:{projectKey}
manage_staged_quotes:{projectKey}:{storeKey}
region String ​ | Region in which the Project is hosted. |
projectKey String ​ | key of the Project. |
storeKey String ​ | key of the Store. |
key String ​ | key of the StagedQuote. |
version Int ​ | Last seen version of the resource. |
expand | The parameter can be passed multiple times. |
dataErasure Boolean ​ | To erase all related personal data in compliance with GDPR, set to true .Default: false ​ |
application/json
curl -X DELETE https://api.{region}.commercetools.com/{projectKey}/in-store/key={storeKey}/staged-quotes/key={key}?version={version} -i \
--header "Authorization: Bearer ${BEARER_TOKEN}"
{
"id": "2a3baa00-44fa-4ab8-bec7-933c31e18dcc",
"version": 1,
"createdAt": "2022-09-22T15:36:17.510Z",
"lastModifiedAt": "2022-09-22T15:41:55.816Z",
"quotationCart": {
"typeId": "cart",
"id": "1a3faa00-55fa-4ab8-bee7-933c31e18dcc"
},
"quoteRequest": {
"typeId": "quote-request",
"id": "8a3faa00-33fa-4ab8-bee7-833f31e18dcc"
},
"customer": {
"typeId": "customer",
"id": "92f5a867-bf19-47ab-982c-6720a03a3921"
},
"stagedQuoteState": "InProgress"
}